feat: Add fetchers dictionary by tag (#45)

* Add fetchers dictionary by tag

Signed-off-by: Alexis Rico <[email protected]>

* Add snapshot test

Signed-off-by: Alexis Rico <[email protected]>

* Conditionally build operations by tag

Signed-off-by: Alexis Rico <[email protected]>

* Refactor

* Add @SferaDev as contributor

Co-authored-by: Fabien BERNARD <[email protected]>

Author: SferaDev

.all-contributorsrc

@@ -29,6 +29,16 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "SferaDev",
+      "name": "Alexis Rico",
+      "avatar_url": "https://avatars.githubusercontent.com/u/2181866?v=4",
+      "profile": "https://github.com/SferaDev",
+      "contributions": [
+        "code",
+        "ideas"
+      ]
     }
   ],
   "contributorsPerLine": 7

README.md

@@ -166,6 +166,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   <tr>
     <td align="center"><a href="https://github.com/mpotomin"><img src="https://avatars.githubusercontent.com/u/639406?v=4?s=100" width="100px;" alt=""/><br /><sub><b>mpotomin</b></sub></a><br /><a href="https://github.com/fabien0102/openapi-codegen/commits?author=mpotomin" title="Code">💻</a> <a href="#ideas-mpotomin" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/fabien0102/openapi-codegen/pulls?q=is%3Apr+reviewed-by%3Ampotomin" title="Reviewed Pull Requests">👀</a></td>
     <td align="center"><a href="https://github.com/micha-f"><img src="https://avatars.githubusercontent.com/u/200647?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Michael Franzkowiak</b></sub></a><br /><a href="https://github.com/fabien0102/openapi-codegen/commits?author=micha-f" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/SferaDev"><img src="https://avatars.githubusercontent.com/u/2181866?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alexis Rico</b></sub></a><br /><a href="https://github.com/fabien0102/openapi-codegen/commits?author=SferaDev" title="Code">💻</a> <a href="#ideas-SferaDev" title="Ideas, Planning, & Feedback">🤔</a></td>
   </tr>
 </table>
 

plugins/typescript/src/generators/generateFetchers.test.ts

@@ -1,3 +1,4 @@
+import { set } from "lodash";
 import { OpenAPIObject } from "openapi3-ts";
 import { Config, generateFetchers } from "./generateFetchers";
 
@@ -117,4 +118,45 @@ describe("generateFetchers", () => {
       "
     `);
   });
+
+  it("should generate fetcher with operations by tag", async () => {
+    const writeFile = jest.fn();
+
+    const openAPIDocumentWithTags = set(
+      openAPIDocument,
+      "paths./pets.get.tags",
+      ["pets"]
+    );
+
+    await generateFetchers(
+      {
+        openAPIDocument: openAPIDocumentWithTags,
+        writeFile,
+        readFile: async () => "",
+        existsFile: () => true,
+      },
+      config
+    );
+
+    expect(writeFile.mock.calls[0][0]).toBe("petstoreComponents.ts");
+    expect(writeFile.mock.calls[0][1]).toMatchInlineSnapshot(`
+      "/**
+       * Generated by @openapi-codegen
+       * 
+       * @version 1.0.0
+       */
+      import { petstoreFetch } from \\"./petstoreFetcher\\";
+      import type * as Schemas from \\"./petstoreSchemas\\";
+
+      export type ListPetsResponse = Schemas.Pet[];
+
+      /**
+       * Get all the pets
+       */
+      export const listPets = () => petstoreFetch<ListPetsResponse, undefined, {}, {}, {}>({ url: \\"/pets\\", method: \\"get\\" });
+
+      export const operationsByTag = { \\"pets\\": { listPets } };
+      "
+    `);
+  });
 });

plugins/typescript/src/generators/generateFetchers.ts

@@ -115,6 +115,7 @@ export const generateFetchers = async (context: Context, config: Config) => {
   }
 
   const operationIds: string[] = [];
+  const operationByTags: Record<string, string[]> = {};
 
   Object.entries(context.openAPIDocument.paths).forEach(
     ([route, verbs]: [string, PathItemObject]) => {
@@ -126,7 +127,12 @@ export const generateFetchers = async (context: Context, config: Config) => {
             `The operationId "${operation.operationId}" is duplicated in your schema definition!`
           );
         }
+
         operationIds.push(operationId);
+        operation.tags?.forEach((tag) => {
+          if (!operationByTags[tag]) operationByTags[tag] = [];
+          operationByTags[tag].push(operationId);
+        });
 
         const {
           dataType,
@@ -166,6 +172,36 @@ export const generateFetchers = async (context: Context, config: Config) => {
     }
   );
 
+  if (Object.keys(operationByTags).length > 0) {
+    nodes.push(
+      f.createVariableStatement(
+        [f.createModifier(ts.SyntaxKind.ExportKeyword)],
+        f.createVariableDeclarationList(
+          [
+            f.createVariableDeclaration(
+              f.createIdentifier("operationsByTag"),
+              undefined,
+              undefined,
+              f.createObjectLiteralExpression(
+                Object.entries(operationByTags).map(([tag, operationIds]) => {
+                  return f.createPropertyAssignment(
+                    f.createStringLiteral(c.camel(tag)),
+                    f.createObjectLiteralExpression(
+                      operationIds.map((operationId) =>
+                        f.createShorthandPropertyAssignment(operationId)
+                      )
+                    )
+                  );
+                })
+              )
+            ),
+          ],
+          ts.NodeFlags.Const
+        )
+      )
+    );
+  }
+
   await context.writeFile(
     filename + ".ts",
     printNodes([