@metamask-previews/react-data-query 1.0.0-preview-8bfa290fb → 2.0.0-preview-0a30e47

package/dist/hydrateMutations.d.cts

@@ -1,35 +0,0 @@
-import { QueryClient, DehydratedState } from "@tanstack/query-core";
-/**
- * Get the `globalId` of a mutation by reading its `meta` data.
- *
- * Each mutation that is routed from the UI query client to a data service is
- * assigned a `globalId` through the mutation's `meta` property. However, the
- * `meta` property is optional and untyped, so reading this property back
- * requires some validation.
- *
- * @param meta - The mutation `meta`, if any.
- * @returns The `globalId` if present and a string, otherwise undefined.
- */
-export declare function readGlobalId(meta: Record<string, unknown> | undefined): string | undefined;
-/**
- * Load dehydrated mutations into the given query client.
- *
- * TanStack Query's `hydrate` function works well for queries: it ensures that
- * incoming queries remain deduplicated as it hydrates them (using the query key
- * hash as a filter). But mutations don't need to be deduplicated, and so
- * `hydrate` follows a different process, opting to load incoming mutations as
- * new entries each time it is called.
- *
- * This does not well for what we want to achieve, which is to be able to
- * synchronize queries and mutations between a data service query client service
- * and a UI query client. To accomplish this, we assume that mutations which
- * originated on the UI side have been tagged with a custom UUID (stored as
- * `globalId` in its `meta`). This allows us to keep mutations with the same
- * UUID on both sides and thus sychronize them effectively.
- *
- * @param client - The UI query client whose mutation cache should be hydrated.
- * @param dehydratedState - The dehydrated state emitted by a data service's
- * `:cacheUpdated` event.
- */
-export declare function hydrateMutations(client: QueryClient, dehydratedState: DehydratedState): void;
-//# sourceMappingURL=hydrateMutations.d.cts.map

package/dist/hydrateMutations.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hydrateMutations.d.cts","sourceRoot":"","sources":["../src/hydrateMutations.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,eAAe,EAEhB,6BAA6B;AAE9B;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GACxC,MAAM,GAAG,SAAS,CAGpB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,WAAW,EACnB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAkCN"}

package/dist/hydrateMutations.d.mts

@@ -1,35 +0,0 @@
-import { QueryClient, DehydratedState } from "@tanstack/query-core";
-/**
- * Get the `globalId` of a mutation by reading its `meta` data.
- *
- * Each mutation that is routed from the UI query client to a data service is
- * assigned a `globalId` through the mutation's `meta` property. However, the
- * `meta` property is optional and untyped, so reading this property back
- * requires some validation.
- *
- * @param meta - The mutation `meta`, if any.
- * @returns The `globalId` if present and a string, otherwise undefined.
- */
-export declare function readGlobalId(meta: Record<string, unknown> | undefined): string | undefined;
-/**
- * Load dehydrated mutations into the given query client.
- *
- * TanStack Query's `hydrate` function works well for queries: it ensures that
- * incoming queries remain deduplicated as it hydrates them (using the query key
- * hash as a filter). But mutations don't need to be deduplicated, and so
- * `hydrate` follows a different process, opting to load incoming mutations as
- * new entries each time it is called.
- *
- * This does not well for what we want to achieve, which is to be able to
- * synchronize queries and mutations between a data service query client service
- * and a UI query client. To accomplish this, we assume that mutations which
- * originated on the UI side have been tagged with a custom UUID (stored as
- * `globalId` in its `meta`). This allows us to keep mutations with the same
- * UUID on both sides and thus sychronize them effectively.
- *
- * @param client - The UI query client whose mutation cache should be hydrated.
- * @param dehydratedState - The dehydrated state emitted by a data service's
- * `:cacheUpdated` event.
- */
-export declare function hydrateMutations(client: QueryClient, dehydratedState: DehydratedState): void;
-//# sourceMappingURL=hydrateMutations.d.mts.map

package/dist/hydrateMutations.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hydrateMutations.d.mts","sourceRoot":"","sources":["../src/hydrateMutations.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,eAAe,EAEhB,6BAA6B;AAE9B;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GACxC,MAAM,GAAG,SAAS,CAGpB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,WAAW,EACnB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAkCN"}

package/dist/hydrateMutations.mjs

@@ -1,95 +0,0 @@
-import { QueryClient } from "@tanstack/query-core";
-/**
- * Get the `globalId` of a mutation by reading its `meta` data.
- *
- * Each mutation that is routed from the UI query client to a data service is
- * assigned a `globalId` through the mutation's `meta` property. However, the
- * `meta` property is optional and untyped, so reading this property back
- * requires some validation.
- *
- * @param meta - The mutation `meta`, if any.
- * @returns The `globalId` if present and a string, otherwise undefined.
- */
-export function readGlobalId(meta) {
-    const globalId = meta?.globalId;
-    return typeof globalId === 'string' ? globalId : undefined;
-}
-/**
- * Load dehydrated mutations into the given query client.
- *
- * TanStack Query's `hydrate` function works well for queries: it ensures that
- * incoming queries remain deduplicated as it hydrates them (using the query key
- * hash as a filter). But mutations don't need to be deduplicated, and so
- * `hydrate` follows a different process, opting to load incoming mutations as
- * new entries each time it is called.
- *
- * This does not well for what we want to achieve, which is to be able to
- * synchronize queries and mutations between a data service query client service
- * and a UI query client. To accomplish this, we assume that mutations which
- * originated on the UI side have been tagged with a custom UUID (stored as
- * `globalId` in its `meta`). This allows us to keep mutations with the same
- * UUID on both sides and thus sychronize them effectively.
- *
- * @param client - The UI query client whose mutation cache should be hydrated.
- * @param dehydratedState - The dehydrated state emitted by a data service's
- * `:cacheUpdated` event.
- */
-export function hydrateMutations(client, dehydratedState) {
-    const mutationCache = client.getMutationCache();
-    for (const dehydratedMutation of dehydratedState.mutations) {
-        const { mutationKey, state, meta } = dehydratedMutation;
-        const globalId = readGlobalId(meta);
-        // Although TanStack Query does not require mutations to have mutation keys,
-        // all mutations created through data services or the UI query client *must*
-        // have one. They must also have a global ID.
-        if (!mutationKey || !globalId) {
-            continue;
-        }
-        const existingMutation = mutationCache.find({
-            mutationKey,
-            predicate: (mutation) => readGlobalId(mutation.meta) === globalId,
-        });
-        // A UI query client only subscribes to a mutation key's cache updates after
-        // it has built a mutation for that key, so there is always a matching
-        // mutation to update in place, and we can disregard the case in which there
-        // is not.
-        // istanbul ignore else
-        if (existingMutation) {
-            existingMutation.state = state;
-            mutationCache.notify({
-                type: 'updated',
-                mutation: existingMutation,
-                action: deriveMutationAction(state),
-            });
-        }
-    }
-}
-/**
- * When publishing an `update` event through the mutation cache we must supply
- * an action. This function derives an appropriate action from a dehydrated
- * mutation's state.
- *
- * @param state - The state of a dehydrated mutation.
- * @returns The mutation cache action describing the state.
- */
-function deriveMutationAction(state) {
-    switch (state.status) {
-        case 'success':
-            return { type: 'success', data: state.data };
-        case 'error':
-            // A mutation in the `error` state always carries a non-null `error`.
-            return { type: 'error', error: state.error };
-        case 'pending':
-            return {
-                type: 'pending',
-                variables: state.variables,
-                context: state.context,
-                isPaused: state.isPaused,
-            };
-        // The `idle` status carries no data, error, or variables, so a neutral
-        // `continue` action refreshes subscribers without implying a result.
-        default:
-            return { type: 'continue' };
-    }
-}
-//# sourceMappingURL=hydrateMutations.mjs.map

package/dist/hydrateMutations.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"hydrateMutations.mjs","sourceRoot":"","sources":["../src/hydrateMutations.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EAGZ,6BAA6B;AAE9B;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAyC;IAEzC,MAAM,QAAQ,GAAG,IAAI,EAAE,QAAQ,CAAC;IAChC,OAAO,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7D,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAAmB,EACnB,eAAgC;IAEhC,MAAM,aAAa,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC;IAEhD,KAAK,MAAM,kBAAkB,IAAI,eAAe,CAAC,SAAS,EAAE,CAAC;QAC3D,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC;QAExD,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAEpC,4EAA4E;QAC5E,4EAA4E;QAC5E,6CAA6C;QAC7C,IAAI,CAAC,WAAW,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC9B,SAAS;QACX,CAAC;QAED,MAAM,gBAAgB,GAAG,aAAa,CAAC,IAAI,CAAC;YAC1C,WAAW;YACX,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,QAAQ;SAClE,CAAC,CAAC;QAEH,4EAA4E;QAC5E,sEAAsE;QACtE,4EAA4E;QAC5E,UAAU;QACV,uBAAuB;QACvB,IAAI,gBAAgB,EAAE,CAAC;YACrB,gBAAgB,CAAC,KAAK,GAAG,KAAK,CAAC;YAC/B,aAAa,CAAC,MAAM,CAAC;gBACnB,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,gBAAgB;gBAC1B,MAAM,EAAE,oBAAoB,CAAC,KAAK,CAAC;aACpC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,oBAAoB,CAC3B,KAAoB;IAMpB,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;QACrB,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QAC/C,KAAK,OAAO;YACV,qEAAqE;YACrE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;QAC/C,KAAK,SAAS;YACZ,OAAO;gBACL,IAAI,EAAE,SAAS;gBACf,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;aACzB,CAAC;QACJ,uEAAuE;QACvE,qEAAqE;QACrE;YACE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;IAChC,CAAC;AACH,CAAC","sourcesContent":["import {\n  QueryClient,\n  DehydratedState,\n  MutationState,\n} from '@tanstack/query-core';\n\n/**\n * Get the `globalId` of a mutation by reading its `meta` data.\n *\n * Each mutation that is routed from the UI query client to a data service is\n * assigned a `globalId` through the mutation's `meta` property. However, the\n * `meta` property is optional and untyped, so reading this property back\n * requires some validation.\n *\n * @param meta - The mutation `meta`, if any.\n * @returns The `globalId` if present and a string, otherwise undefined.\n */\nexport function readGlobalId(\n  meta: Record<string, unknown> | undefined,\n): string | undefined {\n  const globalId = meta?.globalId;\n  return typeof globalId === 'string' ? globalId : undefined;\n}\n\n/**\n * Load dehydrated mutations into the given query client.\n *\n * TanStack Query's `hydrate` function works well for queries: it ensures that\n * incoming queries remain deduplicated as it hydrates them (using the query key\n * hash as a filter). But mutations don't need to be deduplicated, and so\n * `hydrate` follows a different process, opting to load incoming mutations as\n * new entries each time it is called.\n *\n * This does not well for what we want to achieve, which is to be able to\n * synchronize queries and mutations between a data service query client service\n * and a UI query client. To accomplish this, we assume that mutations which\n * originated on the UI side have been tagged with a custom UUID (stored as\n * `globalId` in its `meta`). This allows us to keep mutations with the same\n * UUID on both sides and thus sychronize them effectively.\n *\n * @param client - The UI query client whose mutation cache should be hydrated.\n * @param dehydratedState - The dehydrated state emitted by a data service's\n * `:cacheUpdated` event.\n */\nexport function hydrateMutations(\n  client: QueryClient,\n  dehydratedState: DehydratedState,\n): void {\n  const mutationCache = client.getMutationCache();\n\n  for (const dehydratedMutation of dehydratedState.mutations) {\n    const { mutationKey, state, meta } = dehydratedMutation;\n\n    const globalId = readGlobalId(meta);\n\n    // Although TanStack Query does not require mutations to have mutation keys,\n    // all mutations created through data services or the UI query client *must*\n    // have one. They must also have a global ID.\n    if (!mutationKey || !globalId) {\n      continue;\n    }\n\n    const existingMutation = mutationCache.find({\n      mutationKey,\n      predicate: (mutation) => readGlobalId(mutation.meta) === globalId,\n    });\n\n    // A UI query client only subscribes to a mutation key's cache updates after\n    // it has built a mutation for that key, so there is always a matching\n    // mutation to update in place, and we can disregard the case in which there\n    // is not.\n    // istanbul ignore else\n    if (existingMutation) {\n      existingMutation.state = state;\n      mutationCache.notify({\n        type: 'updated',\n        mutation: existingMutation,\n        action: deriveMutationAction(state),\n      });\n    }\n  }\n}\n\n/**\n * When publishing an `update` event through the mutation cache we must supply\n * an action. This function derives an appropriate action from a dehydrated\n * mutation's state.\n *\n * @param state - The state of a dehydrated mutation.\n * @returns The mutation cache action describing the state.\n */\nfunction deriveMutationAction(\n  state: MutationState,\n):\n  | { type: 'success'; data: unknown }\n  | { type: 'error'; error: unknown }\n  | { type: 'pending'; variables: unknown; context: unknown; isPaused: boolean }\n  | { type: 'continue' } {\n  switch (state.status) {\n    case 'success':\n      return { type: 'success', data: state.data };\n    case 'error':\n      // A mutation in the `error` state always carries a non-null `error`.\n      return { type: 'error', error: state.error };\n    case 'pending':\n      return {\n        type: 'pending',\n        variables: state.variables,\n        context: state.context,\n        isPaused: state.isPaused,\n      };\n    // The `idle` status carries no data, error, or variables, so a neutral\n    // `continue` action refreshes subscribers without implying a result.\n    default:\n      return { type: 'continue' };\n  }\n}\n"]}

package/dist/index.cjs

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useMutation = exports.useInfiniteQuery = exports.useQuery = exports.createUIQueryClient = void 0;
-var createUIQueryClient_js_1 = require("./createUIQueryClient.cjs");
-Object.defineProperty(exports, "createUIQueryClient", { enumerable: true, get: function () { return createUIQueryClient_js_1.createUIQueryClient; } });
-var hooks_js_1 = require("./hooks.cjs");
-Object.defineProperty(exports, "useQuery", { enumerable: true, get: function () { return hooks_js_1.useQuery; } });
-Object.defineProperty(exports, "useInfiniteQuery", { enumerable: true, get: function () { return hooks_js_1.useInfiniteQuery; } });
-Object.defineProperty(exports, "useMutation", { enumerable: true, get: function () { return hooks_js_1.useMutation; } });
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,oEAA+D;AAAtD,6HAAA,mBAAmB,OAAA;AAC5B,wCAAqE;AAA5D,oGAAA,QAAQ,OAAA;AAAE,4GAAA,gBAAgB,OAAA;AAAE,uGAAA,WAAW,OAAA","sourcesContent":["export { createUIQueryClient } from './createUIQueryClient.js';\nexport { useQuery, useInfiniteQuery, useMutation } from './hooks.js';\n"]}

package/dist/index.d.cts

@@ -1,3 +0,0 @@
-export { createUIQueryClient } from "./createUIQueryClient.cjs";
-export { useQuery, useInfiniteQuery, useMutation } from "./hooks.cjs";
-//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kCAAiC;AAC/D,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,WAAW,EAAE,oBAAmB"}

package/dist/index.d.mts

@@ -1,3 +0,0 @@
-export { createUIQueryClient } from "./createUIQueryClient.mjs";
-export { useQuery, useInfiniteQuery, useMutation } from "./hooks.mjs";
-//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kCAAiC;AAC/D,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,WAAW,EAAE,oBAAmB"}

package/dist/index.mjs

@@ -1,3 +0,0 @@
-export { createUIQueryClient } from "./createUIQueryClient.mjs";
-export { useQuery, useInfiniteQuery, useMutation } from "./hooks.mjs";
-//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kCAAiC;AAC/D,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,WAAW,EAAE,oBAAmB","sourcesContent":["export { createUIQueryClient } from './createUIQueryClient.js';\nexport { useQuery, useInfiniteQuery, useMutation } from './hooks.js';\n"]}

package/dist/loggers.cjs

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createModuleLogger = exports.projectLogger = void 0;
-const utils_1 = require("@metamask/utils");
-Object.defineProperty(exports, "createModuleLogger", { enumerable: true, get: function () { return utils_1.createModuleLogger; } });
-exports.projectLogger = (0, utils_1.createProjectLogger)('react-data-query');
-//# sourceMappingURL=loggers.cjs.map

package/dist/loggers.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"loggers.cjs","sourceRoot":"","sources":["../src/loggers.ts"],"names":[],"mappings":";;;AAAA,2CAA0E;AAIjE,mGAJqB,0BAAkB,OAIrB;AAFd,QAAA,aAAa,GAAG,IAAA,2BAAmB,EAAC,kBAAkB,CAAC,CAAC","sourcesContent":["import { createProjectLogger, createModuleLogger } from '@metamask/utils';\n\nexport const projectLogger = createProjectLogger('react-data-query');\n\nexport { createModuleLogger };\n"]}

package/dist/loggers.d.cts

@@ -1,5 +0,0 @@
-/// <reference types="debug" />
-import { createModuleLogger } from "@metamask/utils";
-export declare const projectLogger: import("debug").Debugger;
-export { createModuleLogger };
-//# sourceMappingURL=loggers.d.cts.map

package/dist/loggers.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"loggers.d.cts","sourceRoot":"","sources":["../src/loggers.ts"],"names":[],"mappings":";AAAA,OAAO,EAAuB,kBAAkB,EAAE,wBAAwB;AAE1E,eAAO,MAAM,aAAa,0BAA0C,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/loggers.d.mts

@@ -1,5 +0,0 @@
-/// <reference types="debug" />
-import { createModuleLogger } from "@metamask/utils";
-export declare const projectLogger: import("debug").Debugger;
-export { createModuleLogger };
-//# sourceMappingURL=loggers.d.mts.map

package/dist/loggers.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"loggers.d.mts","sourceRoot":"","sources":["../src/loggers.ts"],"names":[],"mappings":";AAAA,OAAO,EAAuB,kBAAkB,EAAE,wBAAwB;AAE1E,eAAO,MAAM,aAAa,0BAA0C,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/loggers.mjs

@@ -1,4 +0,0 @@
-import { createProjectLogger, createModuleLogger } from "@metamask/utils";
-export const projectLogger = createProjectLogger('react-data-query');
-export { createModuleLogger };
-//# sourceMappingURL=loggers.mjs.map

package/dist/loggers.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"loggers.mjs","sourceRoot":"","sources":["../src/loggers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,wBAAwB;AAE1E,MAAM,CAAC,MAAM,aAAa,GAAG,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,CAAC","sourcesContent":["import { createProjectLogger, createModuleLogger } from '@metamask/utils';\n\nexport const projectLogger = createProjectLogger('react-data-query');\n\nexport { createModuleLogger };\n"]}