@fitzzero/quickdraw-core 5.1.1 → 5.1.3

package/dist/chunk-IIQ3WMJK.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client/keys.ts","../src/client/members.ts"],"sourcesContent":["// TanStack Query keys (RFC 0003 section 11.5): a method call's result is\n// cached under `[\"qd\", service, \"m\", method, input]`, a live entity under\n// `[\"qd\", service, \"e\", id]` and a live collection scope under\n// `[\"qd\", service, \"c\", collection, scope]`, with the service's wire name\n// (the contract's `name`) and the input as the caller passed it. TanStack\n// hashes a key with sorted object keys, so two inputs with the same fields\n// share one cache entry whatever their key order. 4.1 put\n// `JSON.stringify(payload)` in the key\n// (4.1 `src/client/useServiceQuery.ts:88-91`), which made the cache depend\n// on key order and hid the input from `queryKey` filters.\n//\n// React-free: the hooks, the server-side caller and non-React code build the\n// same keys from here, so a query prefetched on the server is the one the\n// hook reads.\n\n/** The first element of every key the client caches under. */\nexport const KEY_ROOT = \"qd\";\n\n/** The key of one method call's result: `[\"qd\", service, \"m\", method, input]`. */\nexport type MethodQueryKey<Input = unknown> = readonly [\n  root: typeof KEY_ROOT,\n  service: string,\n  kind: \"m\",\n  method: string,\n  input: Input,\n];\n\n/** The prefix of every key of one method: matches all its inputs in a `queryKey` filter. */\nexport type MethodKeyPrefix = readonly [\n  root: typeof KEY_ROOT,\n  service: string,\n  kind: \"m\",\n  method: string,\n];\n\n/** The prefix of every key of one service: its method calls, and later its entities and collections. */\nexport type ServiceKeyPrefix = readonly [root: typeof KEY_ROOT, service: string];\n\n/** The key a call of `service.method` with `input` is cached under. */\nexport function methodKey<Input>(\n  service: string,\n  method: string,\n  input: Input,\n): MethodQueryKey<Input> {\n  return [KEY_ROOT, service, \"m\", method, input];\n}\n\n/** The prefix of the keys of every call of `service.method`, for `invalidateQueries` and the like. */\nexport function methodKeyPrefix(service: string, method: string): MethodKeyPrefix {\n  return [KEY_ROOT, service, \"m\", method];\n}\n\n/** The prefix of every key of `service`. */\nexport function serviceKeyPrefix(service: string): ServiceKeyPrefix {\n  return [KEY_ROOT, service];\n}\n\n/** The key a live entity is cached under: `[\"qd\", service, \"e\", id]`. */\nexport type EntityQueryKey = readonly [\n  root: typeof KEY_ROOT,\n  service: string,\n  kind: \"e\",\n  id: string,\n];\n\n/** The key a live collection scope is cached under: `[\"qd\", service, \"c\", collection, scope]`. */\nexport type CollectionQueryKey = readonly [\n  root: typeof KEY_ROOT,\n  service: string,\n  kind: \"c\",\n  collection: string,\n  scope: string,\n];\n\n/** The key row `id` of `service` is cached under while `useEntity` or `useEntities` holds it. */\nexport function entityKey(service: string, id: string): EntityQueryKey {\n  return [KEY_ROOT, service, \"e\", id];\n}\n\n/** The key one scope of a collection is cached under while `useCollection` holds it. */\nexport function collectionKey(\n  service: string,\n  collection: string,\n  scope: string,\n): CollectionQueryKey {\n  return [KEY_ROOT, service, \"c\", collection, scope];\n}\n","// Builds a caller object from a map of contracts at runtime, with no code\n// generation: `client[key][method]` for every contract in the map and every\n// method of its contract. The typed client (`createClient.ts`) and the HTTP\n// server caller (`serverCaller.ts`) are both built here.\n//\n// Every member object is made once, when the caller is created, and frozen,\n// so a member's functions (hooks among them) are the same on every render;\n// the caller freezes the object of services once it has added its own keys.\n// No member is named `then`, so `await` never takes a caller or a service\n// for a promise: contracts reserve `then` and `$`-names for their methods\n// (`contract/validateContract.ts`), and the map's keys are checked here.\n// Building from own enumerable entries into fresh objects means a key such\n// as `__proto__` becomes an ordinary member, never a prototype. Each\n// method's target carries what its members need of the contract, such as\n// the `staleTime: 0` the admin kit's reads of rows give `useQuery`.\n//\n// React-free.\n\nimport type { CollectionDef } from \"../contract/collections\";\nimport type { AnyContract } from \"../contract/defineContract\";\nimport { adminSpecOf, type AdminMethodName } from \"../contract/kits/admin\";\nimport type { MethodDef, MethodKind, MethodOutput, ServiceWatch, Watch } from \"../contract/methods\";\nimport type { ContractMap } from \"../contract/infer\";\n\n/** What a query's `useQuery` starts from, the caller's options spread over it. */\nexport interface QueryDefaults {\n  readonly staleTime: number;\n}\n\n/** One method of one service, as a member is built for it. */\nexport interface MethodTarget {\n  /** The service's name on the wire: the contract's `name`. */\n  readonly service: string;\n  readonly method: string;\n  readonly kind: MethodKind;\n  /** The contract's `output`: a schema, or a projection reference such as `\"entity\"` or `listOf(\"card\")`. */\n  readonly output?: MethodOutput;\n  /** The query's `watch` declaration, when it has one. */\n  readonly watch?: Watch<string> | ServiceWatch | undefined;\n  /** The collections of the method's contract, for a mutation's `addEntity`. */\n  readonly collections?: Readonly<Record<string, CollectionDef>>;\n  /**\n   * What the query's `useQuery` starts from, the caller's options spread\n   * over it: `staleTime: 0` for the admin kit's reads of rows, which are\n   * not live, so a screen reads them again whenever it mounts rather than\n   * keeping the provider's five minutes. `call` and `prefetch` take none of it.\n   */\n  readonly queryDefaults?: QueryDefaults;\n}\n\n/** The admin kit's reads of rows; not `adminMeta`, whose fields change only with a deploy. */\nconst ADMIN_ROW_READS: readonly AdminMethodName[] = [\"adminList\", \"adminGet\", \"adminSubscribers\"];\n\nconst ROW_READ_DEFAULTS: QueryDefaults = Object.freeze({ staleTime: 0 });\n\n/** `definition`'s `queryDefaults`, found by what the admin kit made it for, never by its name. */\nfunction queryDefaultsOf(definition: MethodDef): Pick<MethodTarget, \"queryDefaults\"> {\n  const spec = adminSpecOf(definition);\n  return spec !== undefined && ADMIN_ROW_READS.includes(spec.method)\n    ? { queryDefaults: ROW_READ_DEFAULTS }\n    : {};\n}\n\nfunction isContract(value: unknown): value is AnyContract {\n  if (typeof value !== \"object\" || value === null) {\n    return false;\n  }\n  const { name, methods } = value as { readonly name?: unknown; readonly methods?: unknown };\n  return typeof name === \"string\" && typeof methods === \"object\" && methods !== null;\n}\n\nfunction checkEntry(\n  owner: string,\n  key: string,\n  contract: unknown,\n  reserved: readonly string[],\n): AnyContract {\n  if (key === \"then\" || key.startsWith(\"$\")) {\n    throw new TypeError(\n      `${owner}: \"${key}\" cannot name a service; \"then\" and $-names are reserved`,\n    );\n  }\n  if (reserved.includes(key)) {\n    throw new TypeError(`${owner}: \"${key}\" cannot name a service; the client uses it`);\n  }\n  if (!isContract(contract)) {\n    throw new TypeError(`${owner}: \"${key}\" is not a contract from defineContract`);\n  }\n  return contract;\n}\n\n/**\n * Builds `{ [key]: { [method]: member(target, definition, contract) } }`\n * from `contracts`, frozen. `member` gets the method's declaration and its\n * contract too, for what a kit made (the search kit's `useSearch`). `owner`\n * names the function that builds it, in error messages; `reserved` are keys\n * the caller object uses itself, which no service may take. `live`, when\n * given, adds members of its own to each service (the typed client's\n * `useEntity`, `useEntities` and one member per collection); a contract\n * keeps them apart from its methods, since methods, collections and the\n * reserved names share one namespace. It gets the service's method members\n * too, for members that group them (the admin kit's `admin`).\n */\nexport function buildCaller(\n  owner: string,\n  contracts: ContractMap,\n  member: (target: MethodTarget, definition: MethodDef, contract: AnyContract) => object,\n  reserved: readonly string[] = [],\n  live?: (\n    contract: AnyContract,\n    methods: Readonly<Record<string, object>>,\n  ) => Readonly<Record<string, object>>,\n): Record<string, object> {\n  if (typeof contracts !== \"object\" || contracts === null) {\n    throw new TypeError(`${owner}: pass the contracts as an object, { task, project }`);\n  }\n  const services = Object.entries(contracts).map(([key, value]) => {\n    const contract = checkEntry(owner, key, value, reserved);\n    const methods = Object.entries(contract.methods).map(([method, definition]) => [\n      method,\n      member(\n        {\n          service: contract.name,\n          method,\n          kind: definition.kind,\n          output: definition.output,\n          watch: definition.watch,\n          collections: contract.collections,\n          ...queryDefaultsOf(definition),\n        },\n        definition,\n        contract,\n      ),\n    ]);\n    const extra = Object.entries(live?.(contract, Object.fromEntries(methods)) ?? {});\n    return [key, Object.freeze(Object.fromEntries([...methods, ...extra]))];\n  });\n  return Object.fromEntries(services) as Record<string, object>;\n}\n"],"mappings":";;;;;AAgBO,IAAM,WAAW;AAuBjB,SAAS,UACd,SACA,QACA,OACuB;AACvB,SAAO,CAAC,UAAU,SAAS,KAAK,QAAQ,KAAK;AAC/C;AAGO,SAAS,gBAAgB,SAAiB,QAAiC;AAChF,SAAO,CAAC,UAAU,SAAS,KAAK,MAAM;AACxC;AAGO,SAAS,iBAAiB,SAAmC;AAClE,SAAO,CAAC,UAAU,OAAO;AAC3B;AAoBO,SAAS,UAAU,SAAiB,IAA4B;AACrE,SAAO,CAAC,UAAU,SAAS,KAAK,EAAE;AACpC;AAGO,SAAS,cACd,SACA,YACA,OACoB;AACpB,SAAO,CAAC,UAAU,SAAS,KAAK,YAAY,KAAK;AACnD;;;ACnCA,IAAM,kBAA8C,CAAC,aAAa,YAAY,kBAAkB;AAEhG,IAAM,oBAAmC,OAAO,OAAO,EAAE,WAAW,EAAE,CAAC;AAGvE,SAAS,gBAAgB,YAA4D;AACnF,QAAM,OAAO,YAAY,UAAU;AACnC,SAAO,SAAS,UAAa,gBAAgB,SAAS,KAAK,MAAM,IAC7D,EAAE,eAAe,kBAAkB,IACnC,CAAC;AACP;AAEA,SAAS,WAAW,OAAsC;AACxD,MAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAC/C,WAAO;AAAA,EACT;AACA,QAAM,EAAE,MAAM,QAAQ,IAAI;AAC1B,SAAO,OAAO,SAAS,YAAY,OAAO,YAAY,YAAY,YAAY;AAChF;AAEA,SAAS,WACP,OACA,KACA,UACA,UACa;AACb,MAAI,QAAQ,UAAU,IAAI,WAAW,GAAG,GAAG;AACzC,UAAM,IAAI;AAAA,MACR,GAAG,KAAK,MAAM,GAAG;AAAA,IACnB;AAAA,EACF;AACA,MAAI,SAAS,SAAS,GAAG,GAAG;AAC1B,UAAM,IAAI,UAAU,GAAG,KAAK,MAAM,GAAG,6CAA6C;AAAA,EACpF;AACA,MAAI,CAAC,WAAW,QAAQ,GAAG;AACzB,UAAM,IAAI,UAAU,GAAG,KAAK,MAAM,GAAG,yCAAyC;AAAA,EAChF;AACA,SAAO;AACT;AAcO,SAAS,YACd,OACA,WACA,QACA,WAA8B,CAAC,GAC/B,MAIwB;AACxB,MAAI,OAAO,cAAc,YAAY,cAAc,MAAM;AACvD,UAAM,IAAI,UAAU,GAAG,KAAK,sDAAsD;AAAA,EACpF;AACA,QAAM,WAAW,OAAO,QAAQ,SAAS,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM;AAC/D,UAAM,WAAW,WAAW,OAAO,KAAK,OAAO,QAAQ;AACvD,UAAM,UAAU,OAAO,QAAQ,SAAS,OAAO,EAAE,IAAI,CAAC,CAAC,QAAQ,UAAU,MAAM;AAAA,MAC7E;AAAA,MACA;AAAA,QACE;AAAA,UACE,SAAS,SAAS;AAAA,UAClB;AAAA,UACA,MAAM,WAAW;AAAA,UACjB,QAAQ,WAAW;AAAA,UACnB,OAAO,WAAW;AAAA,UAClB,aAAa,SAAS;AAAA,UACtB,GAAG,gBAAgB,UAAU;AAAA,QAC/B;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF,CAAC;AACD,UAAM,QAAQ,OAAO,QAAQ,OAAO,UAAU,OAAO,YAAY,OAAO,CAAC,KAAK,CAAC,CAAC;AAChF,WAAO,CAAC,KAAK,OAAO,OAAO,OAAO,YAAY,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC;AAAA,EACxE,CAAC;AACD,SAAO,OAAO,YAAY,QAAQ;AACpC;","names":[]}