Adding types to declaration merge for route transact option in typesc… (#142)

* Adding types to declaration merge for route transact option in typescript

* added typescript definition tests, added string as transact option type

* adding examples with transact route, minor test fix

* fixing quote styles

* Update index.d.ts

Co-authored-by: Uzlopak <[email protected]>

Co-authored-by: Matteo Collina <[email protected]>
Co-authored-by: Uzlopak <[email protected]>

Author: 3 people

examples/typescript/transactions/app.ts

@@ -48,4 +48,32 @@ app.post('/init-cb', (_req, reply) => {
   );
 });
 
+app.post('/transact-route', { pg: { transact: true } }, async (req, _reply) => {
+  const createTableQuery = `
+    CREATE TABLE routes (
+      id bigserial primary key,
+      name varchar(80) NOT NULL,
+      created_at timestamp default NULL
+    );
+  `;
+
+  return req.pg?.query(createTableQuery);
+});
+
+app.post(
+  '/transact-route-alternate',
+  { pg: { transact: 'primary' } },
+  async (req, _reply) => {
+    const createTableQuery = `
+    CREATE TABLE routes (
+      id bigserial primary key,
+      name varchar(80) NOT NULL,
+      created_at timestamp default NULL
+    );
+  `;
+
+    return req.pg?.query(createTableQuery);
+  }
+);
+
 export { app };

index.d.ts

@@ -18,6 +18,10 @@ type PostgresDb = {
   transact: typeof transact;
 };
 
+type FastifyPostgresRouteOptions = {
+  transact: boolean | string;
+};
+
 type PostgresPluginOptions = {
   /**
    * Custom pg
@@ -41,6 +45,14 @@ declare module 'fastify' {
   export interface FastifyInstance {
     pg: PostgresDb & Record<string, PostgresDb>;
   }
+
+  export interface FastifyRequest {
+    pg?: Pg.PoolClient;
+  }
+
+  export interface RouteShorthandOptions {
+    pg?: FastifyPostgresRouteOptions;
+  }
 }
 
 export { fastifyPostgres, PostgresDb, PostgresPluginOptions };

test/types/transaction.test-d.ts

@@ -54,3 +54,27 @@ app.post('/insert-cb', (_req, reply) => {
     }
   );
 });
+
+app.post('/transact-route', { pg: { transact: true } }, async (req, _reply) => {
+  const insertQuery = `
+    INSERT INTO routes(name)
+    VALUES ('ochakovo')
+    RETURNING 1 + 1 as sum;
+  `;
+
+  return req.pg?.query(insertQuery);
+});
+
+app.post(
+  '/transact-route-alternate',
+  { pg: { transact: 'primary' } },
+  async (req, _reply) => {
+    const insertQuery = `
+    INSERT INTO routes(name)
+    VALUES ('ochakovo')
+    RETURNING 1 + 1 as sum;
+  `;
+
+    return req.pg?.query(insertQuery);
+  }
+);