@povio/openapi-codegen-cli 0.10.8 → 0.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "0.10.8",
+  "version": "0.11.0",
   "main": "./dist/index.js",
   "bin": {
     "openapi-codegen": "./dist/sh.js"
@@ -18,7 +18,8 @@
     "lint": "eslint --fix",
     "format:check": "prettier --check .",
     "format:fix": "prettier --write .",
-    "push": "yarn exec ./scripts/publish.sh"
+    "push": "yarn exec ./scripts/publish.sh",
+    "dev:generate": "rm -rf ./output && yarn start generate --input http://localhost:4000/docs-json"
   },
   "files": [
     "dist/*",

package/src/assets/queryConfig.context.tsx

@@ -0,0 +1,22 @@
+import { createContext, use, useMemo } from "react";
+
+export namespace QueryConfig {
+  interface Type {
+    preferUpdate?: boolean;
+  }
+
+  const Context = createContext<Type>({});
+
+  type ProviderProps = Type;
+
+  export const Provider = ({ preferUpdate, children }: React.PropsWithChildren<ProviderProps>) => {
+    const value = useMemo(() => ({ preferUpdate }), [preferUpdate]);
+
+    return <Context.Provider value={value}>{children}</Context.Provider>;
+  };
+
+  export const useConfig = () => {
+    const context = use(Context);
+    return context ?? {};
+  };
+}

package/src/assets/useMutationEffects.ts

@@ -0,0 +1,52 @@
+import { QueryKey, useQueryClient } from "@tanstack/react-query";
+import { useCallback } from "react";
+
+import { QueryConfig } from "./queryConfig.context";
+import { QueryModule } from "./queryModules";
+
+export interface MutationEffectsOptions {
+  invalidateCurrentModule?: boolean;
+  invalidateModules?: QueryModule[];
+  invalidateKeys?: QueryKey[];
+  preferUpdate?: boolean;
+}
+
+export interface UseMutationEffectsOptions {
+  currentModule: QueryModule;
+}
+
+export function useMutationEffects({ currentModule }: UseMutationEffectsOptions) {
+  const queryClient = useQueryClient();
+  const config = QueryConfig.useConfig();
+
+  const runMutationEffects = useCallback(
+    async <TData>(data: TData, options: MutationEffectsOptions = {}, updateKeys?: QueryKey[]) => {
+      const { invalidateCurrentModule, invalidateModules, invalidateKeys, preferUpdate } = options;
+      const shouldUpdate = preferUpdate || (preferUpdate === undefined && config.preferUpdate);
+
+      const isQueryKeyEqual = (keyA: QueryKey, keyB: QueryKey) =>
+        keyA.length === keyB.length && keyA.every((item, index) => item === keyB[index]);
+
+      queryClient.invalidateQueries({
+        predicate: ({ queryKey }) => {
+          const isUpdateKey = updateKeys?.some((key) => isQueryKeyEqual(queryKey, key));
+          if (shouldUpdate && isUpdateKey) {
+            return false;
+          }
+
+          const isCurrentModule = invalidateCurrentModule && queryKey[0] === currentModule;
+          const isInvalidateModule = !!invalidateModules && invalidateModules.some((module) => queryKey[0] === module);
+          const isInvalidateKey = !!invalidateKeys && invalidateKeys.some((key) => isQueryKeyEqual(queryKey, key));
+          return isCurrentModule || isInvalidateModule || isInvalidateKey;
+        },
+      });
+
+      if (shouldUpdate && updateKeys) {
+        updateKeys.map((queryKey) => queryClient.setQueryData(queryKey, data));
+      }
+    },
+    [queryClient, currentModule, config.preferUpdate],
+  );
+
+  return { runMutationEffects };
+}

package/src/generators/templates/partials/query-js-docs.hbs

@@ -4,7 +4,7 @@
  * @summary {{addAsteriskAfterNewLine endpoint.summary}}{{/if}}{{#if endpoint.description}} 
  * @description {{addAsteriskAfterNewLine endpoint.description}}{{/if}}{{#if endpoint.acl}}
  * @permission Requires `{{abilityFunctionName endpoint}}` ability {{/if}}
-{{#if (endpointParams endpoint)}}{{#each (endpointParams endpoint infiniteQuery removePageParam=true) as | endpointParam |}} * @param { {{endpointParam.type}} } object.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
+{{#if (endpointParams endpoint)}}{{#each (endpointParams endpoint infiniteQuery excludePageParam=true) as | endpointParam |}} * @param { {{endpointParam.type}} } object.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
 {{/each}}{{/if}} * @param { AppInfiniteQueryOptions } options Infinite query options
  * @returns { UseInfiniteQueryResult<{{{importedZodSchemaInferedType endpoint.response}}}> } {{endpoint.responseDescription}}
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
@@ -25,7 +25,7 @@
  * @description {{addAsteriskAfterNewLine endpoint.description}}{{/if}}{{#if endpoint.acl}}
  * @permission Requires `{{abilityFunctionName endpoint}}` ability {{/if}}
 {{#if (endpointParams endpoint includeFileParam=true)}}{{#each (endpointParams endpoint includeFileParam=true) as | endpointParam |}} * @param { {{endpointParam.type}} } mutation.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
-{{/each}}{{/if}} * @param { AppMutationOptions{{#if hasInvalidateQueryOptions}} & {{invalidateQueryOptionsType}}{{/if}} } options Mutation options
+{{/each}}{{/if}} * @param { AppMutationOptions{{#if hasMutationEffects}} & {{mutationEffectsType}}{{/if}} } options Mutation options
  * @returns { UseMutationResult<{{#if endpoint.mediaDownload}}AxiosResponse<{{/if}}{{{importedZodSchemaInferedType endpoint.response}}}{{#if endpoint.mediaDownload}}>{{/if}}> } {{endpoint.responseDescription}}
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
  */{{/if}}

package/src/generators/templates/partials/query-keys.hbs

@@ -4,7 +4,7 @@ export const keys = {
     {{endpointName endpoint}}: ({{{genEndpointParams endpoint}}}) => [...keys.all, "{{endpoint.path}}", {{{endpointArgs endpoint}}}] as const,
     {{#if ../generateInfiniteQueries}}
     {{#if (isInfiniteQuery endpoint)}}
-    {{endpointName endpoint}}Infinite: ({{{genEndpointParams endpoint removePageParam=true}}}) => [...keys.all, "{{endpoint.path}}", "infinite", {{{endpointArgs endpoint removePageParam=true}}}] as const,
+    {{endpointName endpoint}}Infinite: ({{{genEndpointParams endpoint excludePageParam=true}}}) => [...keys.all, "{{endpoint.path}}", "infinite", {{{endpointArgs endpoint excludePageParam=true}}}] as const,
     {{/if}}
     {{/if}}
     {{/each}}

package/src/generators/templates/partials/query-use-infinite-query.hbs

@@ -1,9 +1,9 @@
 {{! Js docs }}
 {{{genQueryJsDocs endpoint infiniteQuery=true}}}
 {{! Infinite query definition}}
-export const {{infiniteQueryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint removePageParam=true}}} }: { {{{genEndpointParams endpoint removePageParam=true}}} }, {{/if}}options?: AppInfiniteQueryOptions<typeof {{importedEndpointName endpoint}}, TData>{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
+export const {{infiniteQueryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint excludePageParam=true}}} }: { {{{genEndpointParams endpoint excludePageParam=true}}} }, {{/if}}options?: AppInfiniteQueryOptions<typeof {{importedEndpointName endpoint}}, TData>{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
   return {{infiniteQueryHook}}({
-    queryKey: keys.{{endpointName endpoint}}Infinite({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint removePageParam=true}}}{{/if}}),
+    queryKey: keys.{{endpointName endpoint}}Infinite({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint excludePageParam=true}}}{{/if}}),
     queryFn: ({ pageParam }) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint replacePageParam=true}}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}{{/if}}),
     initialPageParam: 1,
     getNextPageParam: ({ {{pageParamName}}, {{totalItemsName}}, {{limitParamName}}: limitParam }) => {

package/src/generators/templates/partials/query-use-mutation.hbs

@@ -1,8 +1,9 @@
 {{! Js docs }}
 {{{genQueryJsDocs endpoint mutation=true}}}
 {{! Mutation definition}}
-export const {{queryName endpoint mutation=true}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint includeFileParam=true}}} }>{{#if hasInvalidateQueryOptions}} & {{invalidateQueryOptionsType}}{{/if}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
-  {{#if hasInvalidateQueryOptions}} const queryClient = useQueryClient();{{/if}}
+export const {{queryName endpoint mutation=true}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint includeFileParam=true}}} }>{{#if hasMutationEffects}} & {{mutationEffectsType}}{{/if}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
+  {{! Use mutation effects }}
+  {{#if hasMutationEffects}}const { runMutationEffects } = useMutationEffects({ currentModule: {{queriesModuleName}} });{{/if}}
 
   return {{queryHook}}({
     mutationFn: {{#if endpoint.mediaUpload}}async {{/if}}({{#if (endpointParams endpoint includeFileParam=true)}} { {{{endpointArgs endpoint includeFileParam=true}}} } {{/if}}) => {{#if endpoint.mediaUpload}} {
@@ -18,11 +19,15 @@ export const {{queryName endpoint mutation=true}} = (options?: AppMutationOption
 
       return uploadInstructions;
     }{{/if}},
-    ...options, {{#if hasInvalidateQueryOptions}}
-    onSuccess: (...args) => {
-      {{! Invalidation }}
-      invalidateQueries(queryClient, {{queriesModuleName}}, options);
-      options?.onSuccess?.(...args);
+    ...options, {{#if hasMutationEffects}}
+    onSuccess: async (resData, variables, context) => {
+      {{! Mutation effects }}
+      {{#if updateQueryEndpoints}}
+      const { {{endpointArgs endpoint includeOnlyRequiredParams=true excludeBodyParam=true}} } = variables;
+      const updateKeys = [{{#each updateQueryEndpoints as | endpoint |}}keys.{{endpointName endpoint}}({{{endpointArgs endpoint includeOnlyRequiredParams=true}}}), {{/each}}];
+      {{/if}}
+      await runMutationEffects(resData, options{{#if updateQueryEndpoints}}, updateKeys{{/if}});
+      options?.onSuccess?.(resData, variables, context);
     },{{/if}}
   });
 };

package/src/generators/templates/queries.hbs

@@ -4,9 +4,13 @@
 {{/if}}
 {{! React query import }}
 {{{genImport queryImport}}}
-{{! Invalidate queries import }}
-{{#if hasInvalidateQueryOptions}}
-{{{genImport invalidateQueriesImport}}}
+{{! Query modules import }}
+{{#if hasMutationEffects}}
+{{{genImport queryModulesImport}}}
+{{/if}}
+{{! Mutation effects import }}
+{{#if hasMutationEffectsImport}}
+{{{genImport mutationEffectsImport}}}
 {{/if}}
 {{! React query types import }}
 {{{genImport queryTypesImport}}}
@@ -23,7 +27,7 @@
 export namespace {{namespace}} {
 {{/if}}
 
-export const {{queriesModuleName}} = {{#if hasInvalidateQueryOptions}}{{queryModuleEnum}}.{{tag}}{{else}}"{{namespace}}"{{/if}};
+export const {{queriesModuleName}} = {{#if hasMutationEffects}}{{queryModuleEnum}}.{{tag}}{{else}}"{{namespace}}"{{/if}};
 
 {{! Query keys export}}
 {{{genQueryKeys queryEndpoints}}}
@@ -32,7 +36,7 @@ export const {{queriesModuleName}} = {{#if hasInvalidateQueryOptions}}{{queryMod
 {{#each endpoints as | endpoint |}}
 {{{genQuery endpoint}}}
 
-{{{genMutation endpoint}}}
+{{{genMutation endpoint ../queryEndpoints}}}
 
 {{{genInfiniteQuery endpoint}}}
 

package/src/generators/templates/query-modules.hbs

@@ -0,0 +1,5 @@
+export const enum QueryModule {
+   {{#each modules as | module |}}
+   {{module.tag}} = "{{module.namespace}}",
+   {{/each}}
+}

package/dist/generators/generate/generateInvalidateQueries.d.ts

@@ -1,2 +0,0 @@
-import { GenerateTypeParams } from "../types/generate";
-export declare function generateInvalidateQueries({ resolver, data }: Omit<GenerateTypeParams, "tag">): string;

package/src/generators/templates/invalidate-queries.hbs

@@ -1,34 +0,0 @@
-import { QueryClient, QueryKey } from "@tanstack/react-query";
-
-export const enum QueryModule {
-   {{#each modules as | module |}}
-   {{module.tag}} = "{{module.namespace}}",
-   {{/each}}
-}
-
-export interface InvalidateQueryOptions {
-  invalidateCurrentModule?: boolean;
-  invalidateModules?: QueryModule[];
-  invalidateKeys?: QueryKey[];
-}
-
-export async function invalidateQueries(
-  queryClient: QueryClient,
-  currentModule: QueryModule,
-  options: InvalidateQueryOptions = {},
-) {
-  const { invalidateCurrentModule, invalidateModules, invalidateKeys } = options;
-
-  if (invalidateCurrentModule) {
-    await queryClient.invalidateQueries({ queryKey: [currentModule] });
-  }
-
-  if (invalidateModules) {
-    await Promise.all([...invalidateModules.map((module) => queryClient.invalidateQueries({ queryKey: [module] }))]);
-  }
-
-  if (invalidateKeys) {
-    await Promise.all([...invalidateKeys.map((queryKey) => queryClient.invalidateQueries({ queryKey }))]);
-  }
-}
-