@povio/openapi-codegen-cli 2.0.7 → 2.0.8-rc.10

package/src/assets/useCrossTabQueryInvalidation.ts

@@ -0,0 +1,40 @@
+import type { QueryClient, QueryKey } from "@tanstack/react-query";
+
+const CROSS_TAB_INVALIDATE_KEY = "__rq_invalidate__";
+
+/**
+ * Broadcasts a query invalidation event to all other open tabs via localStorage.
+ *
+ * @param queryKeys - An array of query keys to invalidate (array of arrays).
+ *
+ * NOTE: The `storage` event only fires in *other* tabs — the calling tab
+ * must invalidate its own queryClient separately if needed.
+ */
+export const broadcastQueryInvalidation = (queryKeys: QueryKey[]) => {
+  localStorage.setItem(CROSS_TAB_INVALIDATE_KEY, JSON.stringify({ keys: queryKeys, timestamp: Date.now() }));
+};
+
+/**
+ * Registers a one-time global `storage` event listener that reacts to
+ * cross-tab invalidation broadcasts. Safe to call from multiple hooks —
+ * only the first call sets up the listener.
+ */
+let isListenerSetUp = false;
+
+export const setupCrossTabListener = (queryClient: QueryClient) => {
+  if (isListenerSetUp) return;
+  isListenerSetUp = true;
+
+  window.addEventListener("storage", (e: StorageEvent) => {
+    if (e.key !== CROSS_TAB_INVALIDATE_KEY || !e.newValue) return;
+
+    try {
+      const { keys } = JSON.parse(e.newValue) as { keys: QueryKey[] };
+      for (const queryKey of keys) {
+        queryClient.invalidateQueries({ queryKey });
+      }
+    } catch {
+      // Ignore malformed payloads
+    }
+  });
+};

package/src/assets/useMutationEffects.ts

@@ -1,12 +1,13 @@
-import { useCallback } from "react";
+import { useCallback, useEffect } from "react";
 
-import { OpenApiQueryConfig } from "@povio/openapi-codegen-cli";
 import { QueryKey, useQueryClient } from "@tanstack/react-query";
-
-import { QueryModule } from "./queryModules";
+import { OpenApiQueryConfig, QueryModule, InvalidationMap } from "../lib/config/queryConfig.context";
+import { broadcastQueryInvalidation, setupCrossTabListener } from "./useCrossTabQueryInvalidation";
 
 export interface MutationEffectsOptions {
   invalidateCurrentModule?: boolean;
+  crossTabInvalidation?: boolean;
+  invalidationMap?: InvalidationMap;
   invalidateModules?: QueryModule[];
   invalidateKeys?: QueryKey[];
   preferUpdate?: boolean;
@@ -20,35 +21,73 @@ export function useMutationEffects({ currentModule }: UseMutationEffectsProps) {
   const queryClient = useQueryClient();
   const config = OpenApiQueryConfig.useConfig();
 
+  useEffect(() => {
+    if (!config.crossTabInvalidation) return;
+    setupCrossTabListener(queryClient);
+  }, [queryClient, config.crossTabInvalidation]);
+
   const runMutationEffects = useCallback(
-    async <TData>(data: TData, options: MutationEffectsOptions = {}, updateKeys?: QueryKey[]) => {
-      const { invalidateCurrentModule = true, invalidateModules, invalidateKeys, preferUpdate } = options;
-      const shouldUpdate = preferUpdate || (preferUpdate === undefined && config.preferUpdate);
-      const shouldInvalidateCurrentModule =
-        invalidateCurrentModule || (invalidateCurrentModule === undefined && config.invalidateCurrentModule);
+    async <TData, TVariables>(
+      data: TData,
+      variables: TVariables,
+      options: MutationEffectsOptions = {},
+      updateKeys?: QueryKey[],
+    ) => {
+      const { invalidateCurrentModule, invalidateModules, invalidateKeys, preferUpdate } = options;
+      const shouldUpdate = preferUpdate ?? config.preferUpdate ?? false;
+      const shouldInvalidateCurrentModule = invalidateCurrentModule ?? config.invalidateCurrentModule ?? true;
 
       const isQueryKeyEqual = (keyA: QueryKey, keyB: QueryKey) =>
         keyA.length === keyB.length && keyA.every((item, index) => item === keyB[index]);
+      const isQueryKeyPrefix = (queryKey: QueryKey, prefixKey: QueryKey) =>
+        prefixKey.length <= queryKey.length && prefixKey.every((item, index) => item === queryKey[index]);
+      const mappedInvalidationKeys = config.invalidationMap?.[currentModule]?.(data, variables);
+
+      const shouldInvalidateQuery = (queryKey: QueryKey) => {
+        const isUpdateKey = updateKeys?.some((key) => isQueryKeyEqual(queryKey, key));
+        if (shouldUpdate && isUpdateKey) {
+          return false;
+        }
+
+        const isCurrentModule = shouldInvalidateCurrentModule && queryKey[0] === currentModule;
+        const isInvalidateModule = !!invalidateModules && invalidateModules.some((module) => queryKey[0] === module);
+        const isInvalidateKey = !!invalidateKeys && invalidateKeys.some((key) => isQueryKeyPrefix(queryKey, key));
+        const isMappedKey =
+          !!mappedInvalidationKeys && mappedInvalidationKeys.some((key) => isQueryKeyPrefix(queryKey, key));
+
+        return isCurrentModule || isInvalidateModule || isInvalidateKey || isMappedKey;
+      };
+
+      const invalidatedQueryKeys: QueryKey[] = [];
 
       queryClient.invalidateQueries({
         predicate: ({ queryKey }) => {
-          const isUpdateKey = updateKeys?.some((key) => isQueryKeyEqual(queryKey, key));
-          if (shouldUpdate && isUpdateKey) {
-            return false;
+          const shouldInvalidate = shouldInvalidateQuery(queryKey);
+
+          if (shouldInvalidate && config.crossTabInvalidation) {
+            invalidatedQueryKeys.push([...queryKey]);
           }
 
-          const isCurrentModule = shouldInvalidateCurrentModule && 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;
+          return shouldInvalidate;
         },
       });
 
+      if (config.crossTabInvalidation && invalidatedQueryKeys.length > 0) {
+        broadcastQueryInvalidation(invalidatedQueryKeys);
+      }
+
       if (shouldUpdate && updateKeys) {
         updateKeys.map((queryKey) => queryClient.setQueryData(queryKey, data));
       }
     },
-    [queryClient, currentModule, config.preferUpdate],
+    [
+      queryClient,
+      currentModule,
+      config.preferUpdate,
+      config.invalidateCurrentModule,
+      config.invalidationMap,
+      config.crossTabInvalidation,
+    ],
   );
 
   return { runMutationEffects };

package/src/generators/templates/endpoints.hbs

@@ -37,7 +37,6 @@ export const {{endpointName endpoint}} = ({{{genEndpointParams endpoint}}}{{#if
         {{/if}}{{{genEndpointConfig endpoint}}}
     )
 };
-
 {{/each}}
 {{#if includeNamespace}}
 }

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

@@ -47,7 +47,7 @@ export const {{queryName endpoint mutation=true}} = (options?: AppMutationOption
       {{#if destructuredVariables}}const { {{commaSeparated destructuredVariables }} } = variables;{{/if}}
       const updateKeys = [{{#each updateQueryEndpoints as | endpoint |}}keys.{{endpointName endpoint}}({{{endpointArgs endpoint includeOnlyRequiredParams=true}}}), {{/each}}];
       {{/if}}
-      await runMutationEffects(resData, options{{#if updateQueryEndpoints}}, updateKeys{{/if}});
+      await runMutationEffects(resData, variables, options{{#if updateQueryEndpoints}}, updateKeys{{/if}});
       options?.onSuccess?.(resData, variables, onMutateResult, context);
     },{{/if}}
   });

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

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

package/dist/acl.d.ts

@@ -1,4 +0,0 @@
-export { AbilityContext } from './lib/acl/ability.context';
-export { createAclGuard } from './lib/acl/AclGuard';
-export { Can } from './lib/acl/Can';
-export type { AppAbilities, AppAbility } from './lib/acl/appAbility.types';

package/dist/commands/check.command.d.ts

@@ -1,2 +0,0 @@
-import { default as yargs } from 'yargs';
-export declare const command: yargs.CommandModule;

package/dist/commands/check.d.ts

@@ -1,7 +0,0 @@
-import { GenerateOptions } from '../generators/types/options';
-export type CheckParams = {
-    config?: string;
-    excludeTags?: string;
-    verbose?: boolean;
-} & Partial<Pick<GenerateOptions, "input" | "splitByTags" | "defaultTag">>;
-export declare function check({ verbose, config: configParam, excludeTags: _excludeTagsParam, ...params }: CheckParams): Promise<void>;

package/dist/commands/generate.command.d.ts

@@ -1,2 +0,0 @@
-import { default as yargs } from 'yargs';
-export declare const command: yargs.CommandModule;

package/dist/commands/generate.d.ts

@@ -1,8 +0,0 @@
-import { GenerateOptions } from '../generators/types/options';
-export type GenerateParams = {
-    config?: string;
-    excludeTags?: string;
-    format?: boolean;
-    verbose?: boolean;
-} & Partial<Pick<GenerateOptions, "input" | "output" | "tsNamespaces" | "tsPath" | "splitByTags" | "defaultTag" | "removeOperationPrefixEndingWith" | "importPath" | "extractEnums" | "acl" | "checkAcl" | "baseUrl" | "replaceOptionalWithNullish" | "infiniteQueries" | "axiosRequestConfig" | "mutationEffects" | "parseRequestParams" | "builderConfigs">>;
-export declare function generate({ format, verbose, config: configParam, ...params }: GenerateParams): Promise<void>;

package/dist/generator.d.ts

@@ -1,3 +0,0 @@
-import { GenerateParams } from './generators/types/metadata';
-export declare function getGenerateMetadata({ input, options: genOptions }: GenerateParams): Promise<import('./generators/types/metadata').GenerateMetadata>;
-export declare function getGenerateFilesData({ input, options: genOptions }: GenerateParams): Promise<import('./generators/types/generate').GenerateFileData[]>;