svelte-ag 1.0.58 → 1.0.59

package/dist/lib/api/query/query.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query.svelte.d.ts","sourceRoot":"","sources":["../../../../src/lib/api/query/query.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAGnH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGxD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AAenE,qBAAa,KAAK,CAChB,GAAG,SAAS,YAAY,EACxB,IAAI,SAAS,GAAG,CAAC,MAAM,CAAC,EACxB,MAAM,SAAS,OAAO,CAAC,GAAG,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC,QAAQ,CAAC;;gBAyBzC,EACV,IAAI,EACJ,MAAM,EACN,KAAK,EACL,SAAS,EACT,KAAK,EACL,IAAI,EACL,EAAE;QACD,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,SAAS,EAAE,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,KAAK,EAAE,KAAK,CAAC;QACb,IAAI,CAAC,EAAE;YACL,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1C,CAAC;KACH;IAgBK,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAyCxD,IAAI,QAAQ,WAEX;IACD,IAAI,QAAQ,YAEX;IACD,UAAU;IAMV,IAAI,MAAM,gBAET;IACD,IAAI,IAAI,IAAI,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,CAEnD;IACD,IAAI,SAAS,IAAI,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,CAEtD;CACF;AAED,qBAAa,SAAS,CACpB,GAAG,SAAS,YAAY,EACxB,IAAI,SAAS,GAAG,CAAC,MAAM,CAAC,EACxB,MAAM,SAAS,OAAO,CAAC,GAAG,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC,QAAQ,CAAC;;gBA6BnD,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,kBAAkB,CAAC,GAAG,CAAC,EAChC,MAAM,EAAE,KAAK,EACb,YAAY,CAAC,EAAE,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC;YAelC,KAAK;IAOnB;;;OAGG;YACW,eAAe;IA2BvB,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;CAmB3F"}
+{"version":3,"file":"query.svelte.d.ts","sourceRoot":"","sources":["../../../../src/lib/api/query/query.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAGnH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGxD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AA2BnE,qBAAa,KAAK,CAChB,GAAG,SAAS,YAAY,EACxB,IAAI,SAAS,GAAG,CAAC,MAAM,CAAC,EACxB,MAAM,SAAS,OAAO,CAAC,GAAG,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC,QAAQ,CAAC;;gBAyBzC,EACV,IAAI,EACJ,MAAM,EACN,KAAK,EACL,SAAS,EACT,KAAK,EACL,IAAI,EACL,EAAE;QACD,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,SAAS,EAAE,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,KAAK,EAAE,KAAK,CAAC;QACb,IAAI,CAAC,EAAE;YACL,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1C,CAAC;KACH;IAgBK,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAyCxD,IAAI,QAAQ,WAEX;IACD,IAAI,QAAQ,YAEX;IACD,UAAU;IAMV,IAAI,MAAM,gBAET;IACD,IAAI,IAAI,IAAI,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,CAEnD;IACD,IAAI,SAAS,IAAI,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,CAEtD;CACF;AAED,qBAAa,SAAS,CACpB,GAAG,SAAS,YAAY,EACxB,IAAI,SAAS,GAAG,CAAC,MAAM,CAAC,EACxB,MAAM,SAAS,OAAO,CAAC,GAAG,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC,QAAQ,CAAC;;gBA6BnD,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,kBAAkB,CAAC,GAAG,CAAC,EAChC,MAAM,EAAE,KAAK,EACb,YAAY,CAAC,EAAE,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC;YAelC,KAAK;IAOnB;;;OAGG;YACW,eAAe;IA2BvB,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;CAmB3F"}

package/dist/lib/api/query/query.svelte.js

@@ -1,12 +1,22 @@
 import { stringify } from 'devalue';
 import { cacheKey } from './utils.svelte.js';
 import { RateLimiter } from './rate.svelte';
+function copyOwnOverrides(source, target) {
+    for (const key of Reflect.ownKeys(source)) {
+        const descriptor = Object.getOwnPropertyDescriptor(source, key);
+        if (!descriptor)
+            continue;
+        Object.defineProperty(target, key, descriptor);
+    }
+    return target;
+}
 function cloneResponse(response) {
     if (response !== null &&
         typeof response === 'object' &&
         'clone' in response &&
         typeof response.clone === 'function') {
-        return response.clone();
+        const source = response;
+        return copyOwnOverrides(source, response.clone());
     }
     return response;
 }

package/dist/lib/api/query/query.unit.test.js

@@ -1,6 +1,9 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { createApiRequest } from 'ts-ag';
 import { Cache } from './cache.svelte.js';
 import { Query, Requestor } from './query.svelte.js';
+import { stringify } from 'devalue';
+import * as v from 'valibot';
 function getSingleId(input) {
     return 'id' in input ? input.id : input.ids[0];
 }
@@ -10,6 +13,23 @@ function jsonResponse(body, status = 200) {
         headers: { 'content-type': 'application/json' }
     });
 }
+function devalueFetchResponse(body, status = 200) {
+    return new Response(stringify(body), {
+        status,
+        headers: { 'content-type': 'application/devalue' }
+    });
+}
+function withResponseOverrides(response) {
+    Object.defineProperty(response, 'extra', {
+        configurable: true,
+        value: () => 'copied'
+    });
+    Object.defineProperty(response, 'meta', {
+        configurable: true,
+        value: { source: 'custom' }
+    });
+    return response;
+}
 function deferred() {
     let resolve;
     let reject;
@@ -27,6 +47,7 @@ describe('Requestor', () => {
     afterEach(() => {
         vi.useRealTimers();
         vi.restoreAllMocks();
+        vi.unstubAllGlobals();
     });
     it('passes through non-batched requests', async () => {
         const requestMock = vi.fn(async () => jsonResponse({ id: 1 }));
@@ -37,6 +58,23 @@ describe('Requestor', () => {
         expect(requestMock).toHaveBeenCalledWith('/users', 'GET', { id: 1 });
         await expect(response.json()).resolves.toEqual({ id: 1 });
     });
+    it('devalue response', async () => {
+        const fetchMock = vi.fn(async () => devalueFetchResponse({ id: 1 }));
+        vi.stubGlobal('fetch', fetchMock);
+        const request = createApiRequest({
+            '/users': {
+                GET: v.object({ id: v.number() })
+            }
+        }, 'https://api.example.test', 'test');
+        const requestor = new Requestor('/users', 'GET', request, new Cache());
+        const response = await requestor.request({ id: 1 });
+        expect(fetchMock).toHaveBeenCalledTimes(1);
+        expect(fetchMock).toHaveBeenCalledWith('https://api.example.test//users?id=1', expect.objectContaining({
+            method: 'GET',
+            credentials: 'include'
+        }));
+        await expect(response.json()).resolves.toEqual({ id: 1 });
+    });
     it('batches requests with the same batch id and preserves response order', async () => {
         const requestMock = vi.fn(async () => jsonResponse({ ok: true }));
         const request = requestMock;
@@ -164,6 +202,58 @@ describe('Query', () => {
         await expect(first.json()).resolves.toEqual({ id: 1, name: 'Ada' });
         await expect(second.json()).resolves.toEqual({ id: 1, name: 'Ada' });
     });
+    it('preserves devalue parsing for query state, returned responses, and cache hits', async () => {
+        const fetchMock = vi.fn(async () => devalueFetchResponse({ id: 1, createdAt: new Date('2024-01-01T00:00:00.000Z') }));
+        vi.stubGlobal('fetch', fetchMock);
+        const request = createApiRequest({
+            '/users': {
+                GET: v.object({ id: v.number() })
+            }
+        }, 'https://api.example.test', 'test');
+        const requestor = new Requestor('/users', 'GET', request, new Cache());
+        const query = new Query({
+            path: '/users',
+            method: 'GET',
+            input: { id: 1 },
+            requestor,
+            cache: new Cache()
+        });
+        const firstResponse = await query.request();
+        expect(fetchMock).toHaveBeenCalledTimes(1);
+        expect(query.status).toBe('success');
+        expect(query.data).toEqual({ id: 1, createdAt: new Date('2024-01-01T00:00:00.000Z') });
+        await expect(firstResponse.json()).resolves.toEqual({
+            id: 1,
+            createdAt: new Date('2024-01-01T00:00:00.000Z')
+        });
+        const cachedResponse = await query.request();
+        expect(fetchMock).toHaveBeenCalledTimes(1);
+        await expect(cachedResponse.json()).resolves.toEqual({
+            id: 1,
+            createdAt: new Date('2024-01-01T00:00:00.000Z')
+        });
+    });
+    it('preserves arbitrary response overrides across query clones and cache hits', async () => {
+        const customResponse = withResponseOverrides(jsonResponse({ id: 1 }));
+        const requestMock = vi.fn().mockResolvedValue(customResponse);
+        const requestor = {
+            request: requestMock
+        };
+        const query = new Query({
+            path: '/users',
+            method: 'GET',
+            input: { id: 1 },
+            requestor,
+            cache: new Cache()
+        });
+        const first = (await query.request());
+        const second = (await query.request());
+        expect(requestMock).toHaveBeenCalledTimes(1);
+        expect(first.extra()).toBe('copied');
+        expect(first.meta).toEqual({ source: 'custom' });
+        expect(second.extra()).toBe('copied');
+        expect(second.meta).toEqual({ source: 'custom' });
+    });
     it('updates success state from successful responses', async () => {
         const requestMock = vi.fn().mockResolvedValue(jsonResponse({ id: 1, active: true }));
         const requestor = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-ag",
-  "version": "1.0.58",
+  "version": "1.0.59",
   "description": "Useful svelte components",
   "bugs": "https://github.com/ageorgeh/svelte-ag/issues",
   "repository": {

package/src/lib/api/query/query.svelte.ts

@@ -9,6 +9,17 @@ import { RateLimiter } from './rate.svelte';
 
 export type QueryStatus = 'idle' | 'loading' | 'success' | 'error';
 
+function copyOwnOverrides<T extends object>(source: T, target: T): T {
+  for (const key of Reflect.ownKeys(source)) {
+    const descriptor = Object.getOwnPropertyDescriptor(source, key);
+    if (!descriptor) continue;
+
+    Object.defineProperty(target, key, descriptor);
+  }
+
+  return target;
+}
+
 function cloneResponse<T>(response: T): T {
   if (
     response !== null &&
@@ -16,7 +27,8 @@ function cloneResponse<T>(response: T): T {
     'clone' in response &&
     typeof response.clone === 'function'
   ) {
-    return response.clone();
+    const source = response as T & object;
+    return copyOwnOverrides(source, response.clone() as T & object) as T;
   }
 
   return response;
@@ -240,8 +252,8 @@ export class Requestor<
     if (batchId !== false) {
       return new Promise((resolve, reject) => {
         if (!this.#batchQueue[batchId]) this.#batchQueue[batchId] = [];
-
         this.#batchQueue[batchId].push({ input, resolve, reject });
+
         if (!this.#batchTimers[batchId]) {
           this.#batchTimers[batchId] = setTimeout(() => {
             void this.flushBatchQueue(batchId).finally(() => {

package/src/lib/api/query/query.unit.test.ts

@@ -1,7 +1,9 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import type { ApiEndpoints, ApiRequestFunction } from 'ts-ag';
+import { createApiRequest, type ApiEndpoints, type ApiRequestFunction } from 'ts-ag';
 import { Cache } from './cache.svelte.js';
 import { Query, Requestor } from './query.svelte.js';
+import { stringify } from 'devalue';
+import * as v from 'valibot';
 
 type PlainUserInput = { id: number };
 type BatchedUserInput = { id: number; group?: string };
@@ -40,6 +42,34 @@ function jsonResponse(body: unknown, status = 200): TestResponse {
   }) as TestResponse;
 }
 
+function devalueFetchResponse(body: unknown, status = 200): Response {
+  return new Response(stringify(body), {
+    status,
+    headers: { 'content-type': 'application/devalue' }
+  });
+}
+
+function withResponseOverrides<T extends Response>(
+  response: T
+): T & {
+  extra: () => string;
+  meta: { source: string };
+} {
+  Object.defineProperty(response, 'extra', {
+    configurable: true,
+    value: () => 'copied'
+  });
+  Object.defineProperty(response, 'meta', {
+    configurable: true,
+    value: { source: 'custom' }
+  });
+
+  return response as T & {
+    extra: () => string;
+    meta: { source: string };
+  };
+}
+
 function deferred<T>() {
   let resolve!: (value: T | PromiseLike<T>) => void;
   let reject!: (reason?: unknown) => void;
@@ -60,6 +90,7 @@ describe('Requestor', () => {
   afterEach(() => {
     vi.useRealTimers();
     vi.restoreAllMocks();
+    vi.unstubAllGlobals();
   });
 
   it('passes through non-batched requests', async () => {
@@ -74,6 +105,34 @@ describe('Requestor', () => {
     await expect(response.json()).resolves.toEqual({ id: 1 });
   });
 
+  it('devalue response', async () => {
+    const fetchMock = vi.fn(async () => devalueFetchResponse({ id: 1 }));
+    vi.stubGlobal('fetch', fetchMock);
+
+    const request = createApiRequest<PlainUsersApi>(
+      {
+        '/users': {
+          GET: v.object({ id: v.number() })
+        }
+      },
+      'https://api.example.test',
+      'test'
+    );
+    const requestor = new Requestor<PlainUsersApi, '/users', 'GET'>('/users', 'GET', request, new Cache());
+
+    const response = await requestor.request({ id: 1 });
+
+    expect(fetchMock).toHaveBeenCalledTimes(1);
+    expect(fetchMock).toHaveBeenCalledWith(
+      'https://api.example.test//users?id=1',
+      expect.objectContaining({
+        method: 'GET',
+        credentials: 'include'
+      })
+    );
+    await expect(response.json()).resolves.toEqual({ id: 1 });
+  });
+
   it('batches requests with the same batch id and preserves response order', async () => {
     const requestMock = vi.fn(async () => jsonResponse({ ok: true }));
     const request = requestMock as unknown as BatchedUsersRequest;
@@ -235,6 +294,80 @@ describe('Query', () => {
     await expect(second.json()).resolves.toEqual({ id: 1, name: 'Ada' });
   });
 
+  it('preserves devalue parsing for query state, returned responses, and cache hits', async () => {
+    const fetchMock = vi.fn(async () =>
+      devalueFetchResponse({ id: 1, createdAt: new Date('2024-01-01T00:00:00.000Z') })
+    );
+    vi.stubGlobal('fetch', fetchMock);
+
+    const request = createApiRequest<PlainUsersApi>(
+      {
+        '/users': {
+          GET: v.object({ id: v.number() })
+        }
+      },
+      'https://api.example.test',
+      'test'
+    );
+    const requestor = new Requestor<PlainUsersApi, '/users', 'GET'>('/users', 'GET', request, new Cache());
+    const query = new Query<PlainUsersApi, '/users', 'GET'>({
+      path: '/users',
+      method: 'GET',
+      input: { id: 1 },
+      requestor,
+      cache: new Cache()
+    });
+
+    const firstResponse = await query.request();
+
+    expect(fetchMock).toHaveBeenCalledTimes(1);
+    expect(query.status).toBe('success');
+    expect(query.data).toEqual({ id: 1, createdAt: new Date('2024-01-01T00:00:00.000Z') });
+    await expect(firstResponse.json()).resolves.toEqual({
+      id: 1,
+      createdAt: new Date('2024-01-01T00:00:00.000Z')
+    });
+
+    const cachedResponse = await query.request();
+
+    expect(fetchMock).toHaveBeenCalledTimes(1);
+    await expect(cachedResponse.json()).resolves.toEqual({
+      id: 1,
+      createdAt: new Date('2024-01-01T00:00:00.000Z')
+    });
+  });
+
+  it('preserves arbitrary response overrides across query clones and cache hits', async () => {
+    const customResponse = withResponseOverrides(jsonResponse({ id: 1 }) as Response);
+    const requestMock = vi.fn().mockResolvedValue(customResponse);
+    const requestor = {
+      request: requestMock as PlainUsersRequest
+    } as unknown as PlainUsersRequestor;
+
+    const query = new Query<PlainUsersApi, '/users', 'GET'>({
+      path: '/users',
+      method: 'GET',
+      input: { id: 1 },
+      requestor,
+      cache: new Cache()
+    });
+
+    const first = (await query.request()) as Response & {
+      extra: () => string;
+      meta: { source: string };
+    };
+    const second = (await query.request()) as Response & {
+      extra: () => string;
+      meta: { source: string };
+    };
+
+    expect(requestMock).toHaveBeenCalledTimes(1);
+    expect(first.extra()).toBe('copied');
+    expect(first.meta).toEqual({ source: 'custom' });
+    expect(second.extra()).toBe('copied');
+    expect(second.meta).toEqual({ source: 'custom' });
+  });
+
   it('updates success state from successful responses', async () => {
     const requestMock = vi.fn().mockResolvedValue(jsonResponse({ id: 1, active: true }));
     const requestor = {