@veams/status-quo-query 0.9.0 → 0.10.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './mutation.js';
 export * from './query.js';
 export * from './provider.js';
+export * from './query-registry.js';
 export type { TrackedDependencyRecord, TrackedDependencyValue, TrackedInvalidateOn, TrackedMatchMode, TrackedQueryKey, TrackedQueryKeySegment, } from './tracking.js';

package/dist/index.js

@@ -4,4 +4,6 @@ export * from './mutation.js';
 export * from './query.js';
 // Re-export all provider-related types and functions for cache management.
 export * from './provider.js';
+// Re-export query registry helpers for memoizing query services by key.
+export * from './query-registry.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,cAAc,eAAe,CAAC;AAC9B,mDAAmD;AACnD,cAAc,YAAY,CAAC;AAC3B,2EAA2E;AAC3E,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,cAAc,eAAe,CAAC;AAC9B,mDAAmD;AACnD,cAAc,YAAY,CAAC;AAC3B,2EAA2E;AAC3E,cAAc,eAAe,CAAC;AAC9B,wEAAwE;AACxE,cAAc,qBAAqB,CAAC"}

package/dist/query-registry.d.ts

@@ -0,0 +1,9 @@
+import type { QueryService } from './query.js';
+export interface QueryRegistry<TParams, TKey extends readonly unknown[]> {
+    clear: () => void;
+    getKey: (params: TParams) => TKey;
+    name: string;
+    resolve: <TData, TError = Error>(params: TParams, create: (queryKey: TKey) => QueryService<TData, TError>) => QueryService<TData, TError>;
+}
+export declare function createQueryRegistry<TParams, TKey extends readonly unknown[]>(name: string, createKey: (params: TParams) => TKey): QueryRegistry<TParams, TKey>;
+export declare function serializeQueryKey(queryKey: readonly unknown[]): string;

package/dist/query-registry.js

@@ -0,0 +1,28 @@
+import { hashKey } from '@tanstack/query-core';
+export function createQueryRegistry(name, createKey) {
+    const entries = new Map();
+    return {
+        name,
+        clear() {
+            entries.clear();
+        },
+        getKey(params) {
+            return createKey(params);
+        },
+        resolve(params, create) {
+            const queryKey = createKey(params);
+            const cacheKey = serializeQueryKey(queryKey);
+            const existingEntry = entries.get(cacheKey);
+            if (existingEntry) {
+                return existingEntry;
+            }
+            const nextEntry = create(queryKey);
+            entries.set(cacheKey, nextEntry);
+            return nextEntry;
+        },
+    };
+}
+export function serializeQueryKey(queryKey) {
+    return hashKey(queryKey);
+}
+//# sourceMappingURL=query-registry.js.map

package/dist/query-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-registry.js","sourceRoot":"","sources":["../src/query-registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAc/C,MAAM,UAAU,mBAAmB,CACjC,IAAY,EACZ,SAAoC;IAEpC,MAAM,OAAO,GAAG,IAAI,GAAG,EAA0C,CAAC;IAElE,OAAO;QACL,IAAI;QACJ,KAAK;YACH,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,CAAC;QACD,MAAM,CAAC,MAAM;YACX,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,CACL,MAAe,EACf,MAAuD;YAEvD,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;YACnC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YAC7C,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAA4C,CAAC;YAEvF,IAAI,aAAa,EAAE,CAAC;gBAClB,OAAO,aAAa,CAAC;YACvB,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEnC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,SAA2C,CAAC,CAAC;YAEnE,OAAO,SAAS,CAAC;QACnB,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAA4B;IAC5D,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC3B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veams/status-quo-query",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "TanStack Query service layer for the VEAMS StatusQuo ecosystem.",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -32,6 +32,13 @@
         "default": "./dist/provider.js"
       },
       "require": "./dist/provider.js"
+    },
+    "./query-registry": {
+      "import": {
+        "types": "./dist/query-registry.d.ts",
+        "default": "./dist/query-registry.js"
+      },
+      "require": "./dist/query-registry.js"
     }
   },
   "types": "dist/index.d.ts",

package/src/__tests__/query-registry.spec.ts

@@ -0,0 +1,101 @@
+import type { QueryService } from '../query';
+import { createQueryRegistry, serializeQueryKey } from '../query-registry';
+
+describe('createQueryRegistry', () => {
+  it('reuses the same entry for identical params', () => {
+    const registry = createQueryRegistry('branches', (params: { branchId: string }) => [
+      'branch',
+      {
+        deps: {
+          branchId: params.branchId,
+        },
+      },
+    ] as const);
+    const createEntry = jest.fn((queryKey) => ({ queryKey }));
+
+    const firstEntry = registry.resolve({ branchId: 'branch-1' }, createEntry as never);
+    const secondEntry = registry.resolve({ branchId: 'branch-1' }, createEntry as never);
+
+    expect(firstEntry).toBe(secondEntry);
+    expect(createEntry).toHaveBeenCalledTimes(1);
+  });
+
+  it('creates separate entries for different params', () => {
+    const registry = createQueryRegistry('branches', (params: { branchId: string }) => [
+      'branch',
+      {
+        deps: {
+          branchId: params.branchId,
+        },
+      },
+    ] as const);
+    const createEntry = jest.fn((queryKey) => ({ queryKey }));
+
+    const firstEntry = registry.resolve({ branchId: 'branch-1' }, createEntry as never);
+    const secondEntry = registry.resolve({ branchId: 'branch-2' }, createEntry as never);
+
+    expect(firstEntry).not.toBe(secondEntry);
+    expect(createEntry).toHaveBeenCalledTimes(2);
+  });
+
+  it('exposes the generated query key', () => {
+    const registry = createQueryRegistry('branches', (params: { branchId: string }) => [
+      'branch',
+      {
+        deps: {
+          branchId: params.branchId,
+        },
+      },
+    ] as const);
+
+    expect(registry.getKey({ branchId: 'branch-1' })).toEqual([
+      'branch',
+      {
+        deps: {
+          branchId: 'branch-1',
+        },
+      },
+    ]);
+  });
+
+  it('uses TanStack-compatible stable hashing for object keys', () => {
+    const firstKey = ['branch', { deps: { branchId: 'branch-1', companyId: 'company-1' } }] as const;
+    const secondKey = ['branch', { deps: { companyId: 'company-1', branchId: 'branch-1' } }] as const;
+
+    expect(serializeQueryKey(firstKey)).toBe(serializeQueryKey(secondKey));
+  });
+
+  it('infers the query service type from the creator callback', () => {
+    const registry = createQueryRegistry('branches', (params: { branchId: string }) => [
+      'branch',
+      {
+        deps: {
+          branchId: params.branchId,
+        },
+      },
+    ] as const);
+
+    const query = registry.resolve({ branchId: 'branch-1' }, () => {
+      return {
+        getSnapshot: () => ({
+          data: { id: 'branch-1' },
+          error: null,
+          fetchStatus: 'idle',
+          isError: false,
+          isFetching: false,
+          isPending: false,
+          isSuccess: true,
+          status: 'success',
+        }),
+        invalidate: jest.fn(),
+        refetch: jest.fn(),
+        subscribe: jest.fn(),
+        unsafe_getResult: jest.fn(),
+      } as unknown as QueryService<{ id: string }, Error>;
+    });
+
+    const typedQuery: QueryService<{ id: string }, Error> = query;
+
+    expect(typedQuery).toBe(query);
+  });
+});

package/src/index.ts

@@ -4,6 +4,8 @@ export * from './mutation.js';
 export * from './query.js';
 // Re-export all provider-related types and functions for cache management.
 export * from './provider.js';
+// Re-export query registry helpers for memoizing query services by key.
+export * from './query-registry.js';
 // Re-export tracked dependency types used by the additive tracked facade.
 export type {
   TrackedDependencyRecord,

package/src/query-registry.ts

@@ -0,0 +1,52 @@
+import { hashKey } from '@tanstack/query-core';
+
+import type { QueryService } from './query.js';
+
+export interface QueryRegistry<TParams, TKey extends readonly unknown[]> {
+  clear: () => void;
+  getKey: (params: TParams) => TKey;
+  name: string;
+  resolve: <TData, TError = Error>(
+    params: TParams,
+    create: (queryKey: TKey) => QueryService<TData, TError>
+  ) => QueryService<TData, TError>;
+}
+
+export function createQueryRegistry<TParams, TKey extends readonly unknown[]>(
+  name: string,
+  createKey: (params: TParams) => TKey
+): QueryRegistry<TParams, TKey> {
+  const entries = new Map<string, QueryService<unknown, unknown>>();
+
+  return {
+    name,
+    clear() {
+      entries.clear();
+    },
+    getKey(params) {
+      return createKey(params);
+    },
+    resolve<TData, TError = Error>(
+      params: TParams,
+      create: (queryKey: TKey) => QueryService<TData, TError>
+    ) {
+      const queryKey = createKey(params);
+      const cacheKey = serializeQueryKey(queryKey);
+      const existingEntry = entries.get(cacheKey) as QueryService<TData, TError> | undefined;
+
+      if (existingEntry) {
+        return existingEntry;
+      }
+
+      const nextEntry = create(queryKey);
+
+      entries.set(cacheKey, nextEntry as QueryService<unknown, unknown>);
+
+      return nextEntry;
+    },
+  };
+}
+
+export function serializeQueryKey(queryKey: readonly unknown[]): string {
+  return hashKey(queryKey);
+}