svelte-ag 1.2.7 → 1.3.0

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

@@ -1,5 +1,13 @@
 import { stringify } from 'devalue';
-import type { ApiEndpoints, ApiInput, ApiRequestFunction, ApiSuccessBody, ApiErrorBody, ApiResponse } from 'ts-ag';
+import type {
+  ApiEndpointContract,
+  ApiEndpoints,
+  ApiInput,
+  ApiRequestFunction,
+  ApiSuccessBody,
+  ApiErrorBody,
+  ApiResponse
+} from 'ts-ag';
 
 import type { Cache } from './cache.svelte';
 import type { BatchDetails } from './entrypoint.svelte';
@@ -17,8 +25,7 @@ export class Query<
   #TIMEOUT = 1000 * 60 * 5; // 5 minutes
 
   // -------- Set in constructor --------
-  #path: Path;
-  #method: Method;
+  #endpoint: ApiEndpointContract<API, Path, Method>;
   #input: ApiInput<API, Path, Method>;
   #inputString: string;
   #cacheKey: string;
@@ -37,15 +44,13 @@ export class Query<
 
   // -------- Functions --------
   constructor({
-    path,
-    method,
+    endpoint,
     input,
     requestor,
     cache,
     opts
   }: {
-    path: Path;
-    method: Method;
+    endpoint: ApiEndpointContract<API, Path, Method>;
     input: ApiInput<API, Path, Method>;
     requestor: Requestor<API, Path, Method>;
     cache: Cache;
@@ -56,14 +61,13 @@ export class Query<
     this.#requestor = requestor;
     this.#cache = cache;
 
-    this.#path = path;
-    this.#method = method;
+    this.#endpoint = endpoint;
 
     // if (this.#cachekey) this.#cache.deregister(this.#cachekey);
 
     this.#input = input;
     this.#inputString = stringify(input);
-    this.#cacheKey = cacheKey(path, method, input);
+    this.#cacheKey = cacheKey(endpoint, input);
 
     this.#cache.register(this.#cacheKey, opts?.cache ?? { timeout: this.#TIMEOUT });
   }
@@ -141,8 +145,7 @@ export class Requestor<
   #batchDelay = 100;
 
   // -------- Set in constructor --------
-  #path: Path;
-  #method: Method;
+  #endpoint: ApiEndpointContract<API, Path, Method>;
   #request: ApiRequestFunction<API>;
 
   #canBatch: BatchDetails<API, Path, Method>['canBatch'];
@@ -164,14 +167,12 @@ export class Requestor<
   #batchTimers: Record<string, NodeJS.Timeout | null> = {};
 
   constructor(
-    path: Path,
-    method: Method,
+    endpoint: ApiEndpointContract<API, Path, Method>,
     request: ApiRequestFunction<API>,
     _cache: Cache,
     batchDetails?: BatchDetails<API, Path, Method>
   ) {
-    this.#path = path;
-    this.#method = method;
+    this.#endpoint = endpoint;
     this.#request = request;
     this.#limiter = new RateLimiter();
     // this.#cache = cache;
@@ -187,7 +188,7 @@ export class Requestor<
     // if ('PUBLIC_ENVIRONMENT' in env && env.PUBLIC_ENVIRONMENT === 'development') {
     //   await sleep(1000);
     // }
-    return await this.#limiter.add(() => this.#request(this.#path, this.#method, input));
+    return await this.#limiter.add(() => this.#request(this.#endpoint, input));
   }
 
   /**

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

@@ -1,5 +1,5 @@
 import { stringify } from 'devalue';
-import { createApiRequest, type ApiEndpoints } from 'ts-ag';
+import { createApiRequest, type ApiEndpointContract, type ApiEndpoints } from 'ts-ag';
 import * as v from 'valibot';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 
@@ -30,17 +30,17 @@ type BatchedUsersApi = {
 
 const API_URL = 'https://api.example.test';
 
-const plainSchemas = {
-  '/users': {
-    GET: v.object({ id: v.number() })
-  }
-};
+const plainUsers_GET = {
+  path: '/users',
+  method: 'GET',
+  schema: v.object({ id: v.number() })
+} satisfies ApiEndpointContract<PlainUsersApi, '/users', 'GET'>;
 
-const batchedSchemas = {
-  '/users': {
-    POST: v.union([v.object({ id: v.number(), group: v.optional(v.string()) }), v.object({ ids: v.array(v.number()) })])
-  }
-};
+const batchedUsers_POST = {
+  path: '/users',
+  method: 'POST',
+  schema: v.union([v.object({ id: v.number(), group: v.optional(v.string()) }), v.object({ ids: v.array(v.number()) })])
+} satisfies ApiEndpointContract<BatchedUsersApi, '/users', 'POST'>;
 
 function getSingleId(input: BatchedUsersApi['requestInput']): number {
   return 'id' in input ? input.id : input.ids[0]!;
@@ -97,23 +97,22 @@ function deferred<T>() {
 }
 
 function createPlainRequest() {
-  return createApiRequest<PlainUsersApi>(plainSchemas, API_URL, 'test');
+  return createApiRequest<PlainUsersApi>(API_URL, 'test');
 }
 
 function createBatchedRequest() {
-  return createApiRequest<BatchedUsersApi>(batchedSchemas, API_URL, 'test');
+  return createApiRequest<BatchedUsersApi>(API_URL, 'test');
 }
 
 function createPlainRequestor() {
-  return new Requestor<PlainUsersApi, '/users', 'GET'>('/users', 'GET', createPlainRequest(), new Cache());
+  return new Requestor<PlainUsersApi, '/users', 'GET'>(plainUsers_GET, createPlainRequest(), new Cache());
 }
 
 function createBatchedRequestor(
-  batchDetails?: ConstructorParameters<typeof Requestor<BatchedUsersApi, '/users', 'POST'>>[4]
+  batchDetails?: ConstructorParameters<typeof Requestor<BatchedUsersApi, '/users', 'POST'>>[3]
 ) {
   return new Requestor<BatchedUsersApi, '/users', 'POST'>(
-    '/users',
-    'POST',
+    batchedUsers_POST,
     createBatchedRequest(),
     new Cache(),
     batchDetails
@@ -355,8 +354,7 @@ describe('Query', () => {
     const fetchMock = vi.fn().mockReturnValue(pending.promise);
     vi.stubGlobal('fetch', fetchMock);
     const query = new Query<PlainUsersApi, '/users', 'GET'>({
-      path: '/users',
-      method: 'GET',
+      endpoint: plainUsers_GET,
       input: { id: 1 },
       requestor: createPlainRequestor(),
       cache: new Cache()
@@ -378,8 +376,7 @@ describe('Query', () => {
     const fetchMock = vi.fn(async () => jsonFetchResponse({ id: 1, name: 'Ada' }));
     vi.stubGlobal('fetch', fetchMock);
     const query = new Query<PlainUsersApi, '/users', 'GET'>({
-      path: '/users',
-      method: 'GET',
+      endpoint: plainUsers_GET,
       input: { id: 1 },
       requestor: createPlainRequestor(),
       cache: new Cache()
@@ -400,8 +397,7 @@ describe('Query', () => {
     );
     vi.stubGlobal('fetch', fetchMock);
     const query = new Query<PlainUsersApi, '/users', 'GET'>({
-      path: '/users',
-      method: 'GET',
+      endpoint: plainUsers_GET,
       input: { id: 1 },
       requestor: createPlainRequestor(),
       cache: new Cache()
@@ -430,8 +426,7 @@ describe('Query', () => {
     const fetchMock = vi.fn(async () => withResponseOverrides(jsonFetchResponse({ id: 1 })));
     vi.stubGlobal('fetch', fetchMock);
     const query = new Query<PlainUsersApi, '/users', 'GET'>({
-      path: '/users',
-      method: 'GET',
+      endpoint: plainUsers_GET,
       input: { id: 1 },
       requestor: createPlainRequestor(),
       cache: new Cache()
@@ -457,8 +452,7 @@ describe('Query', () => {
     const fetchMock = vi.fn(async () => jsonFetchResponse({ id: 1, active: true }));
     vi.stubGlobal('fetch', fetchMock);
     const query = new Query<PlainUsersApi, '/users', 'GET'>({
-      path: '/users',
-      method: 'GET',
+      endpoint: plainUsers_GET,
       input: { id: 1 },
       requestor: createPlainRequestor(),
       cache: new Cache()
@@ -476,8 +470,7 @@ describe('Query', () => {
     const fetchMock = vi.fn(async () => jsonFetchResponse({ message: 'missing' }, 404));
     vi.stubGlobal('fetch', fetchMock);
     const query = new Query<PlainUsersApi, '/users', 'GET'>({
-      path: '/users',
-      method: 'GET',
+      endpoint: plainUsers_GET,
       input: { id: 99 },
       requestor: createPlainRequestor(),
       cache: new Cache()
@@ -505,8 +498,7 @@ describe('Query', () => {
     });
     vi.stubGlobal('fetch', fetchMock);
     const query = new Query<PlainUsersApi, '/users', 'GET'>({
-      path: '/users',
-      method: 'GET',
+      endpoint: plainUsers_GET,
       input: { id: 1 },
       requestor: createPlainRequestor(),
       cache: new Cache()
@@ -532,8 +524,7 @@ describe('Query', () => {
     });
     vi.stubGlobal('fetch', fetchMock);
     const query = new Query<PlainUsersApi, '/users', 'GET'>({
-      path: '/users',
-      method: 'GET',
+      endpoint: plainUsers_GET,
       input: { id: 1 },
       requestor: createPlainRequestor(),
       cache: new Cache()
@@ -558,8 +549,7 @@ describe('Query', () => {
     });
     vi.stubGlobal('fetch', fetchMock);
     const query = new Query<PlainUsersApi, '/users', 'GET'>({
-      path: '/users',
-      method: 'GET',
+      endpoint: plainUsers_GET,
       input: { id: 1 },
       requestor: createPlainRequestor(),
       cache: new Cache(),

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

@@ -1,9 +1,10 @@
 import { stringify } from 'devalue';
+import { endpointKey } from 'ts-ag';
 
-export function batchQueryKey(path: string, method: string) {
-  return `${path}_${method}`;
+export function batchQueryKey(endpoint: { path: string; method: string }) {
+  return endpointKey(endpoint);
 }
 
-export function cacheKey(path: string, method: string, input: any) {
-  return `${path}_${method}_${stringify(input)}`;
+export function cacheKey(endpoint: { path: string; method: string }, input: any) {
+  return `${endpointKey(endpoint)} ${stringify(input)}`;
 }