@zenstackhq/tanstack-query 3.0.0 → 3.1.1

package/dist/common/client.d.ts

@@ -0,0 +1,4 @@
+import type { QueryClient } from '@tanstack/query-core';
+import type { InvalidationPredicate, QueryInfo } from '@zenstackhq/client-helpers';
+export declare function invalidateQueriesMatchingPredicate(queryClient: QueryClient, predicate: InvalidationPredicate): Promise<void>;
+export declare function getAllQueries(queryClient: QueryClient): readonly QueryInfo[];

package/dist/common/client.js

@@ -0,0 +1,38 @@
+import { parseQueryKey } from './query-key';
+export function invalidateQueriesMatchingPredicate(queryClient, predicate) {
+    return queryClient.invalidateQueries({
+        predicate: ({ queryKey }) => {
+            const parsed = parseQueryKey(queryKey);
+            if (!parsed) {
+                return false;
+            }
+            return predicate({ model: parsed.model, args: parsed.args });
+        },
+    });
+}
+export function getAllQueries(queryClient) {
+    return queryClient
+        .getQueryCache()
+        .getAll()
+        .map(({ queryKey, state }) => {
+        const parsed = parseQueryKey(queryKey);
+        if (!parsed) {
+            return undefined;
+        }
+        return {
+            model: parsed?.model,
+            operation: parsed?.operation,
+            args: parsed?.args,
+            data: state.data,
+            optimisticUpdate: !!parsed.flags.optimisticUpdate,
+            updateData: (data, cancelOnTheFlyQueries) => {
+                queryClient.setQueryData(queryKey, data);
+                if (cancelOnTheFlyQueries) {
+                    queryClient.cancelQueries({ queryKey }, { revert: false, silent: true });
+                }
+            },
+        };
+    })
+        .filter((entry) => !!entry);
+}
+//# sourceMappingURL=client.js.map

package/dist/common/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/common/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,UAAU,kCAAkC,CAAC,WAAwB,EAAE,SAAgC;IACzG,OAAO,WAAW,CAAC,iBAAiB,CAAC;QACjC,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;YACxB,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;YACvC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACV,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,OAAO,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAe,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3E,CAAC;KACJ,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,WAAwB;IAClD,OAAO,WAAW;SACb,aAAa,EAAE;SACf,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE;QACzB,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO;YACH,KAAK,EAAE,MAAM,EAAE,KAAK;YACpB,SAAS,EAAE,MAAM,EAAE,SAAS;YAC5B,IAAI,EAAE,MAAM,EAAE,IAAI;YAClB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,gBAAgB,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB;YACjD,UAAU,EAAE,CAAC,IAAa,EAAE,qBAA8B,EAAE,EAAE;gBAC1D,WAAW,CAAC,YAAY,CAAU,QAAQ,EAAE,IAAI,CAAC,CAAC;gBAClD,IAAI,qBAAqB,EAAE,CAAC;oBACxB,WAAW,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC7E,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC"}

package/dist/common/query-key.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Prefix for react-query keys.
+ */
+export declare const QUERY_KEY_PREFIX = "zenstack";
+export type QueryKey = [
+    string,
+    string,
+    string,
+    unknown,
+    {
+        infinite: boolean;
+        optimisticUpdate: boolean;
+    }
+];
+/**
+ * Computes query key for the given model, operation and query args.
+ * @param model Model name.
+ * @param operation Query operation (e.g, `findMany`) or request URL. If it's a URL, the last path segment will be used as the operation name.
+ * @param args Query arguments.
+ * @param options Query options, including `infinite` indicating if it's an infinite query (defaults to false), and `optimisticUpdate` indicating if optimistic updates are enabled (defaults to true).
+ * @returns Query key
+ */
+export declare function getQueryKey(model: string, operation: string, args: unknown, options?: {
+    infinite: boolean;
+    optimisticUpdate: boolean;
+}): QueryKey;
+/**
+ * Parses the given query key into its components.
+ */
+export declare function parseQueryKey(queryKey: readonly unknown[]): {
+    model: string;
+    operation: string;
+    args: unknown;
+    flags: {
+        infinite: boolean;
+        optimisticUpdate: boolean;
+    };
+} | undefined;
+export declare function isZenStackQueryKey(queryKey: readonly unknown[]): queryKey is QueryKey;

package/dist/common/query-key.js

@@ -0,0 +1,38 @@
+/**
+ * Prefix for react-query keys.
+ */
+export const QUERY_KEY_PREFIX = 'zenstack';
+/**
+ * Computes query key for the given model, operation and query args.
+ * @param model Model name.
+ * @param operation Query operation (e.g, `findMany`) or request URL. If it's a URL, the last path segment will be used as the operation name.
+ * @param args Query arguments.
+ * @param options Query options, including `infinite` indicating if it's an infinite query (defaults to false), and `optimisticUpdate` indicating if optimistic updates are enabled (defaults to true).
+ * @returns Query key
+ */
+export function getQueryKey(model, operation, args, options = { infinite: false, optimisticUpdate: true }) {
+    const infinite = options.infinite;
+    // infinite query doesn't support optimistic updates
+    const optimisticUpdate = options.infinite ? false : options.optimisticUpdate;
+    return [QUERY_KEY_PREFIX, model, operation, args, { infinite, optimisticUpdate }];
+}
+/**
+ * Parses the given query key into its components.
+ */
+export function parseQueryKey(queryKey) {
+    const [prefix, model, operation, args, flags] = queryKey;
+    if (prefix !== QUERY_KEY_PREFIX) {
+        return undefined;
+    }
+    return { model, operation, args, flags };
+}
+export function isZenStackQueryKey(queryKey) {
+    if (queryKey.length < 5) {
+        return false;
+    }
+    if (queryKey[0] !== QUERY_KEY_PREFIX) {
+        return false;
+    }
+    return true;
+}
+//# sourceMappingURL=query-key.js.map

package/dist/common/query-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-key.js","sourceRoot":"","sources":["../../src/common/query-key.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CAAC;AAa3C;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CACvB,KAAa,EACb,SAAiB,EACjB,IAAa,EACb,UAA4D,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE;IAEvG,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,oDAAoD;IACpD,MAAM,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;IAC7E,OAAO,CAAC,gBAAgB,EAAE,KAAK,EAAE,SAAU,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC;AACvF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,QAA4B;IACtD,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,QAAoB,CAAC;IACrE,IAAI,MAAM,KAAK,gBAAgB,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,QAA4B;IAC3D,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,gBAAgB,EAAE,CAAC;QACnC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/common/types.d.ts

@@ -0,0 +1,60 @@
+import type { Logger, OptimisticDataProvider } from '@zenstackhq/client-helpers';
+import type { FetchFn } from '@zenstackhq/client-helpers/fetch';
+import type { OperationsIneligibleForDelegateModels } from '@zenstackhq/orm';
+import type { GetModels, IsDelegateModel, SchemaDef } from '@zenstackhq/schema';
+/**
+ * Context type for configuring the hooks.
+ */
+export type QueryContext = {
+    /**
+     * The endpoint to use for the queries.
+     */
+    endpoint?: string;
+    /**
+     * A custom fetch function for sending the HTTP requests.
+     */
+    fetch?: FetchFn;
+    /**
+     * If logging is enabled.
+     */
+    logging?: Logger;
+};
+/**
+ * Extra query options.
+ */
+export type ExtraQueryOptions = {
+    /**
+     * Whether to opt-in to optimistic updates for this query. Defaults to `true`.
+     */
+    optimisticUpdate?: boolean;
+} & QueryContext;
+/**
+ * Extra mutation options.
+ */
+export type ExtraMutationOptions = {
+    /**
+     * Whether to automatically invalidate queries potentially affected by the mutation. Defaults to `true`.
+     */
+    invalidateQueries?: boolean;
+    /**
+     * Whether to optimistically update queries potentially affected by the mutation. Defaults to `false`.
+     */
+    optimisticUpdate?: boolean;
+    /**
+     * A callback for computing optimistic update data for each query cache entry.
+     */
+    optimisticDataProvider?: OptimisticDataProvider;
+} & QueryContext;
+type HooksOperationsIneligibleForDelegateModels = OperationsIneligibleForDelegateModels extends any ? `use${Capitalize<OperationsIneligibleForDelegateModels>}` : never;
+/**
+ * Trim operations that are ineligible for delegate models from the given model operations type.
+ */
+export type TrimDelegateModelOperations<Schema extends SchemaDef, Model extends GetModels<Schema>, T extends Record<string, unknown>> = IsDelegateModel<Schema, Model> extends true ? Omit<T, HooksOperationsIneligibleForDelegateModels> : T;
+type WithOptimisticFlag<T> = T extends object ? T & {
+    /**
+     * Indicates if the item is in an optimistic update state
+     */
+    $optimistic?: boolean;
+} : T;
+export type WithOptimistic<T> = T extends Array<infer U> ? Array<WithOptimisticFlag<U>> : WithOptimisticFlag<T>;
+export {};

package/dist/common/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/common/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":""}