add cache options for next.js

Author: omermecitoglu

src/core/renderers/declaration.ts

@@ -9,10 +9,10 @@ type DeclarationTemplate = {
   operations: DeclaredOperation[],
 };
 
-export default function generateDeclaration(paths: OpenAPI["paths"]) {
+export default function generateDeclaration(paths: OpenAPI["paths"], framework: string | null) {
   const template = getTemplate<DeclarationTemplate>(declarationTemplate);
   return template({
     importedSchemas: resolveSchemas(paths),
-    operations: resolveDeclaredOperations(paths),
+    operations: resolveDeclaredOperations(paths, framework),
   });
 }

src/core/resolvers/declared-operation.ts

@@ -17,10 +17,10 @@ function resolveOperationResult(responses: Operation["responses"]) {
   return schemas.find(s => typeof s === "string") ?? "unknown";
 }
 
-export function resolveDeclaredOperations(paths: OpenAPI["paths"]) {
-  return resolveEndpoints(paths).map<DeclaredOperation>(({ operation }) => ({
+export function resolveDeclaredOperations(paths: OpenAPI["paths"], framework: string | null) {
+  return resolveEndpoints(paths).map<DeclaredOperation>(({ method, operation }) => ({
     name: operation.operationId,
-    parameters: resolveOperationParams(operation, true).join(", "),
+    parameters: resolveOperationParams(operation, method, true, framework).join(", "),
     result: resolveOperationResult(operation.responses),
   }));
 }

src/core/resolvers/operation-param.ts

@@ -23,7 +23,7 @@ function sortRequiredParamsFirst(paramA: OperationParameter, paramB: OperationPa
   return paramA.required ? -1 : 1;
 }
 
-export function resolveOperationParams(operation: Operation, typescript: boolean) {
+export function resolveOperationParams(operation: Operation, method: string, typescript: boolean, framework: string | null) {
   const resolvedParams = (operation.parameters ?? [])
     .filter(param => param.in === "path" || param.in === "query")
     .toSorted(sortRequiredParamsFirst)
@@ -39,5 +39,8 @@ export function resolveOperationParams(operation: Operation, typescript: boolean
       collection.push(resolveRequestBody(operation.requestBody, typescript));
     }
   }
+  if (framework === "next" && method.toUpperCase() === "GET") {
+    collection.unshift(typescript ? "cacheTag: string | null" : "cacheTag");
+  }
   return collection;
 }

src/core/resolvers/operation.ts

@@ -12,6 +12,7 @@ export type OperationTemplate = {
   searchParams: OperationParameter[],
   hasFormData: boolean,
   responses: string[],
+  isCacheable: boolean,
 };
 
 function quotePathName(pathName: string, parameters: OperationParameter[]) {
@@ -24,14 +25,15 @@ function getSearchParams(parameters: OperationParameter[]) {
   return parameters.filter(param => param.in === "query");
 }
 
-export default function resolveOperations(paths: OpenAPI["paths"]) {
+export default function resolveOperations(paths: OpenAPI["paths"], framework: string | null) {
   return resolveEndpoints(paths).map<OperationTemplate>(({ method, path, operation }) => ({
     name: operation.operationId,
     method: method.toUpperCase(),
     path: quotePathName(path, operation.parameters ?? []),
-    parameters: resolveOperationParams(operation, false).join(", "),
+    parameters: resolveOperationParams(operation, method, false, framework).join(", "),
     searchParams: getSearchParams(operation.parameters ?? []),
     hasFormData: hasFormData(operation),
     responses: resolveResponses(operation.responses),
+    isCacheable: framework === "next" && method.toUpperCase() === "GET",
   }));
 }

src/index.ts

@@ -41,12 +41,12 @@ import generateSwaggerJson from "./core/swagger";
   const serviceName = capitalize(appName.replace(/-/g, " "));
   const envName = `${appName.replace(/-/g, "_").toUpperCase()}_BASE_URL`;
 
-  const resolvedPaths = resolveOperations(data.paths);
+  const resolvedPaths = resolveOperations(data.paths, framework);
 
   const content = generateInterface(envName, resolvedPaths);
   await createFile(content, "index.js", outputDir, "dist");
 
-  const declaration = generateDeclaration(data.paths);
+  const declaration = generateDeclaration(data.paths, framework);
   await createFile(declaration, "index.d.ts", outputDir, "dist");
 
   const doc = generateDocumentation(serviceName, packageName, envName, data.paths);

src/templates/operation-with-form-data.hbs

@@ -10,6 +10,12 @@ export async function {{name}}({{parameters}}) {
   const response = await fetch(url, {
     method: "{{method}}",
     body: formData,
+  {{#if isCacheable}}
+    cache: cacheTag ? "force-cache" : "no-store",
+    next: {
+      tags: cacheTag ? [cacheTag] : undefined,
+    }
+  {{/if}}
   });
   switch (response.status) {
   {{#each responses}}

src/templates/operation.hbs

@@ -8,6 +8,12 @@ export async function {{name}}({{parameters}}) {
   {{#if (hasRequestBody parameters)}}
     body: JSON.stringify(requestBody),
   {{/if}}
+  {{#if isCacheable}}
+    cache: cacheTag ? "force-cache" : "no-store",
+    next: {
+      tags: cacheTag ? [cacheTag] : undefined,
+    }
+  {{/if}}
   });
   switch (response.status) {
   {{#each responses}}