@warp-drive/utilities 5.10.0-alpha.12 → 5.10.0-alpha.13

package/dist/unpkg/dev-deprecated/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["getOrSetGlobal","CONFIG","host","namespace","setBuildURLConfig","config","test","Error","endsWith","startsWith","OPERATIONS_WITH_PRIMARY_RECORDS","Set","isOperationWithPrimaryRecord","options","has","op","hasResourcePath","resourcePath","length","resourcePathForType","identifiers","type","identifier","buildBaseURL","urlOptions","Object","assign","Array","isArray","every","i","id","idPath","encodeURIComponent","fieldPath","String","join","includes","hasHost","url","filter","Boolean","DEFAULT_QUERY_PARAMS_SERIALIZATION_OPTIONS","arrayFormat","handleInclude","include","split","filterEmpty","source","result","key","value","undefined","sortQueryParams","params","opts","paramsIsObject","URLSearchParams","urlParams","dictionaryParams","forEach","hasExisting","existingValue","push","sortedKeys","keys","sort","sortedValue","toSorted","v","append","buildQueryParams","toString"],"sources":["../../../src/index.ts"],"sourcesContent":["/**\n * @module\n * @mergeModuleWith <project>\n */\n\nimport { assert } from '@warp-drive/core/build-config/macros';\nimport { getOrSetGlobal } from '@warp-drive/core/types/-private';\nimport type { QueryParamsSerializationOptions, QueryParamsSource, Serializable } from '@warp-drive/core/types/params';\n\n// prevents the final constructed object from needing to add\n// host and namespace which are provided by the final consuming\n// class to the prototype which can result in overwrite errors\n\n/**\n * The global configuration used by {@link buildBaseURL} when a call does\n * not provide its own `host`/`namespace`. Set via {@link setBuildURLConfig}.\n *\n * @public\n */\nexport interface BuildURLConfig {\n  /**\n   * The scheme, domain and port (if any) to prefix built URLs with, e.g. `'https://api.example.com'`.\n   */\n  host: string | null;\n  /**\n   * The path segment to insert between `host` and the resource path, e.g. `'api/v1'`.\n   */\n  namespace: string | null;\n}\n\nconst CONFIG: BuildURLConfig = getOrSetGlobal('CONFIG', {\n  host: '',\n  namespace: '',\n});\n\n/**\n * Sets the global configuration for `buildBaseURL`\n * for host and namespace values for the application.\n *\n * These values may still be overridden by passing\n * them to buildBaseURL directly.\n *\n * This method may be called as many times as needed.\n * host values of `''` or `'/'` are equivalent.\n *\n * Except for the value of `/` as host, host should not\n * end with `/`.\n *\n * namespace should not start or end with a `/`.\n *\n * ```ts\n * type BuildURLConfig = {\n *   host: string;\n *   namespace: string'\n * }\n * ```\n *\n * Example:\n *\n * ```ts\n * import { setBuildURLConfig } from '@warp-drive/utilities';\n *\n * setBuildURLConfig({\n *   host: 'https://api.example.com',\n *   namespace: 'api/v1'\n * });\n * ```\n *\n * @public\n */\nexport function setBuildURLConfig(config: BuildURLConfig): void {\n  assert(`setBuildURLConfig: You must pass a config object`, config);\n  assert(\n    `setBuildURLConfig: You must pass a config object with a 'host' or 'namespace' property`,\n    'host' in config || 'namespace' in config\n  );\n\n  CONFIG.host = config.host || '';\n  CONFIG.namespace = config.namespace || '';\n\n  assert(\n    `buildBaseURL: host must NOT end with '/', received '${CONFIG.host}'`,\n    CONFIG.host === '/' || !CONFIG.host.endsWith('/')\n  );\n  assert(\n    `buildBaseURL: namespace must NOT start with '/', received '${CONFIG.namespace}'`,\n    !CONFIG.namespace.startsWith('/')\n  );\n  assert(\n    `buildBaseURL: namespace must NOT end with '/', received '${CONFIG.namespace}'`,\n    !CONFIG.namespace.endsWith('/')\n  );\n}\n\n/**\n * {@link buildBaseURL} options for a `findRecord` request.\n *\n * @public\n */\nexport interface FindRecordUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'findRecord';\n  /**\n   * The type and id of the record to find.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  };\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for a `query` request.\n *\n * @public\n */\nexport interface QueryUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'query';\n  /**\n   * The type of the records to query.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n  };\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for a `findMany` request.\n *\n * @public\n */\nexport interface FindManyUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'findMany';\n  /**\n   * The type and id of each record to find.\n   */\n  identifiers: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  }[];\n  /**\n   * The path segment for the resource, defaults to the first identifier's `type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n/**\n * {@link buildBaseURL} options for a `findRelatedCollection` request.\n *\n * @public\n */\nexport interface FindRelatedCollectionUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'findRelatedCollection';\n  /**\n   * The type and id of the record whose relationship is being fetched.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  };\n  /**\n   * The relationship field name, appended to the resource path.\n   */\n  fieldPath: string;\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for a `findRelatedRecord` request.\n *\n * @public\n */\nexport interface FindRelatedResourceUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'findRelatedRecord';\n  /**\n   * The type and id of the record whose relationship is being fetched.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  };\n  /**\n   * The relationship field name, appended to the resource path.\n   */\n  fieldPath: string;\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for a `createRecord` request.\n *\n * @public\n */\nexport interface CreateRecordUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'createRecord';\n  /**\n   * The type of the record being created.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n  };\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for an `updateRecord` request.\n *\n * @public\n */\nexport interface UpdateRecordUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'updateRecord';\n  /**\n   * The type and id of the record being updated.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  };\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for a `deleteRecord` request.\n *\n * @public\n */\nexport interface DeleteRecordUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'deleteRecord';\n  /**\n   * The type and id of the record being deleted.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  };\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for building a URL directly from a `resourcePath`\n * without an associated request operation.\n *\n * @public\n */\nexport interface GenericUrlOptions {\n  /**\n   * The path segment for the resource.\n   */\n  resourcePath: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * The union of all `op`-specific option shapes accepted by {@link buildBaseURL}, one of:\n *\n * - {@link FindRecordUrlOptions}\n * - {@link QueryUrlOptions}\n * - {@link FindManyUrlOptions}\n * - {@link FindRelatedCollectionUrlOptions}\n * - {@link FindRelatedResourceUrlOptions}\n * - {@link CreateRecordUrlOptions}\n * - {@link UpdateRecordUrlOptions}\n * - {@link DeleteRecordUrlOptions}\n * - {@link GenericUrlOptions}\n *\n * @public\n */\nexport type UrlOptions =\n  | FindRecordUrlOptions\n  | QueryUrlOptions\n  | FindManyUrlOptions\n  | FindRelatedCollectionUrlOptions\n  | FindRelatedResourceUrlOptions\n  | CreateRecordUrlOptions\n  | UpdateRecordUrlOptions\n  | DeleteRecordUrlOptions\n  | GenericUrlOptions;\n\nconst OPERATIONS_WITH_PRIMARY_RECORDS = new Set([\n  'findRecord',\n  'findRelatedRecord',\n  'findRelatedCollection',\n  'updateRecord',\n  'deleteRecord',\n]);\n\nfunction isOperationWithPrimaryRecord(\n  options: UrlOptions\n): options is\n  | FindRecordUrlOptions\n  | FindRelatedCollectionUrlOptions\n  | FindRelatedResourceUrlOptions\n  | UpdateRecordUrlOptions\n  | DeleteRecordUrlOptions {\n  return 'op' in options && OPERATIONS_WITH_PRIMARY_RECORDS.has(options.op);\n}\n\nfunction hasResourcePath(options: UrlOptions): options is GenericUrlOptions {\n  return 'resourcePath' in options && typeof options.resourcePath === 'string' && options.resourcePath.length > 0;\n}\n\nfunction resourcePathForType(options: UrlOptions): string {\n  assert(\n    `resourcePathForType: You must pass a valid op as part of options`,\n    'op' in options && typeof options.op === 'string'\n  );\n  return options.op === 'findMany' ? options.identifiers[0].type : options.identifier.type;\n}\n\n/**\n * Builds a URL for a request based on the provided options.\n * Does not include support for building query params (see `buildQueryParams`)\n * so that it may be composed cleanly with other query-params strategies.\n *\n * Usage:\n *\n * ```ts\n * import { buildBaseURL } from '@warp-drive/utilities';\n *\n * const url = buildBaseURL({\n *   host: 'https://api.example.com',\n *   namespace: 'api/v1',\n *   resourcePath: 'emberDevelopers',\n *   op: 'query',\n *   identifier: { type: 'ember-developer' }\n * });\n *\n * // => 'https://api.example.com/api/v1/emberDevelopers'\n * ```\n *\n * On the surface this may seem like a lot of work to do something simple, but\n * it is designed to be composable with other utilities and interfaces that the\n * average product engineer will never need to see or use.\n *\n * A few notes:\n *\n * - `resourcePath` is optional, but if it is not provided, `identifier.type` will be used.\n * - `host` and `namespace` are optional, but if they are not provided, the values globally\n *    configured via `setBuildURLConfig` will be used.\n * - `op` is required and must be one of the following:\n *   - 'findRecord' 'query' 'findMany' 'findRelatedCollection' 'findRelatedRecord'` 'createRecord' 'updateRecord' 'deleteRecord'\n * - Depending on the value of `op`, `identifier` or `identifiers` will be required.\n *\n * @public\n */\nexport function buildBaseURL(urlOptions: UrlOptions): string {\n  const options = Object.assign(\n    {\n      host: CONFIG.host,\n      namespace: CONFIG.namespace,\n    },\n    urlOptions\n  );\n  assert(\n    `buildBaseURL: You must pass \\`op\\` as part of options`,\n    hasResourcePath(options) || (typeof options.op === 'string' && options.op.length > 0)\n  );\n  assert(\n    `buildBaseURL: You must pass \\`identifier\\` as part of options`,\n    hasResourcePath(options) ||\n      options.op === 'findMany' ||\n      (options.identifier && typeof options.identifier === 'object')\n  );\n  assert(\n    `buildBaseURL: You must pass \\`identifiers\\` as part of options`,\n    hasResourcePath(options) ||\n      options.op !== 'findMany' ||\n      (options.identifiers &&\n        Array.isArray(options.identifiers) &&\n        options.identifiers.length > 0 &&\n        options.identifiers.every((i) => i && typeof i === 'object'))\n  );\n  assert(\n    `buildBaseURL: You must pass valid \\`identifier\\` as part of options, expected 'id'`,\n    hasResourcePath(options) ||\n      !isOperationWithPrimaryRecord(options) ||\n      (typeof options.identifier.id === 'string' && options.identifier.id.length > 0)\n  );\n  assert(\n    `buildBaseURL: You must pass \\`identifiers\\` as part of options`,\n    hasResourcePath(options) ||\n      options.op !== 'findMany' ||\n      options.identifiers.every((i) => typeof i.id === 'string' && i.id.length > 0)\n  );\n  assert(\n    `buildBaseURL: You must pass valid \\`identifier\\` as part of options, expected 'type'`,\n    hasResourcePath(options) ||\n      options.op === 'findMany' ||\n      (typeof options.identifier.type === 'string' && options.identifier.type.length > 0)\n  );\n  assert(\n    `buildBaseURL: You must pass valid \\`identifiers\\` as part of options, expected 'type'`,\n    hasResourcePath(options) ||\n      options.op !== 'findMany' ||\n      (typeof options.identifiers[0].type === 'string' && options.identifiers[0].type.length > 0)\n  );\n\n  // prettier-ignore\n  const idPath: string =\n      isOperationWithPrimaryRecord(options) ? encodeURIComponent(options.identifier.id)\n      : '';\n  const resourcePath = options.resourcePath || resourcePathForType(options);\n  const { host, namespace } = options;\n  const fieldPath = 'fieldPath' in options ? options.fieldPath : '';\n\n  assert(\n    `buildBaseURL: You tried to build a url for a ${String(\n      'op' in options ? options.op + ' ' : ''\n    )}request to ${resourcePath} but resourcePath must be set or op must be one of \"${[\n      'findRecord',\n      'findRelatedRecord',\n      'findRelatedCollection',\n      'updateRecord',\n      'deleteRecord',\n      'createRecord',\n      'query',\n      'findMany',\n    ].join('\",\"')}\".`,\n    hasResourcePath(options) ||\n      [\n        'findRecord',\n        'query',\n        'findMany',\n        'findRelatedCollection',\n        'findRelatedRecord',\n        'createRecord',\n        'updateRecord',\n        'deleteRecord',\n      ].includes(options.op)\n  );\n\n  assert(`buildBaseURL: host must NOT end with '/', received '${host}'`, host === '/' || !host.endsWith('/'));\n  assert(`buildBaseURL: namespace must NOT start with '/', received '${namespace}'`, !namespace.startsWith('/'));\n  assert(`buildBaseURL: namespace must NOT end with '/', received '${namespace}'`, !namespace.endsWith('/'));\n  assert(\n    `buildBaseURL: resourcePath must NOT start with '/', received '${resourcePath}'`,\n    !resourcePath.startsWith('/')\n  );\n  assert(`buildBaseURL: resourcePath must NOT end with '/', received '${resourcePath}'`, !resourcePath.endsWith('/'));\n  assert(`buildBaseURL: fieldPath must NOT start with '/', received '${fieldPath}'`, !fieldPath.startsWith('/'));\n  assert(`buildBaseURL: fieldPath must NOT end with '/', received '${fieldPath}'`, !fieldPath.endsWith('/'));\n  assert(`buildBaseURL: idPath must NOT start with '/', received '${idPath}'`, !idPath.startsWith('/'));\n  assert(`buildBaseURL: idPath must NOT end with '/', received '${idPath}'`, !idPath.endsWith('/'));\n\n  const hasHost = host !== '' && host !== '/';\n  const url = [hasHost ? host : '', namespace, resourcePath, idPath, fieldPath].filter(Boolean).join('/');\n  return hasHost ? url : `/${url}`;\n}\n\nconst DEFAULT_QUERY_PARAMS_SERIALIZATION_OPTIONS: QueryParamsSerializationOptions = {\n  arrayFormat: 'comma',\n};\n\nfunction handleInclude(include: string | string[]): string[] {\n  assert(\n    `Expected include to be a string or array, got ${typeof include}`,\n    typeof include === 'string' || Array.isArray(include)\n  );\n  return typeof include === 'string' ? include.split(',') : include;\n}\n\n/**\n * filter out keys of an object that have falsy values or point to empty arrays\n * returning a new object with only those keys that have truthy values / non-empty arrays\n *\n * @public\n * @param source object to filter keys with empty values from\n * @return A new object with the keys that contained empty values removed\n */\nexport function filterEmpty(source: Record<string, Serializable>): Record<string, Serializable> {\n  const result: Record<string, Serializable> = {};\n  for (const key in source) {\n    const value = source[key];\n    // Allow `0` and `false` but filter falsy values that indicate \"empty\"\n    if (value !== undefined && value !== null && value !== '') {\n      if (!Array.isArray(value) || value.length > 0) {\n        result[key] = source[key];\n      }\n    }\n  }\n  return result;\n}\n\n/**\n * Sorts query params by both key and value returning a new URLSearchParams\n * object with the keys inserted in sorted order.\n *\n * Treats `included` specially, splicing it into an array if it is a string and sorting the array.\n *\n * The `params` given are never mutated: neither the object itself nor any array\n * value it holds is reordered or replaced, so passing state that is also\n * rendered (a tracked array of filter values, for instance) is safe.\n *\n * Options:\n * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'\n *\n * 'bracket': appends [] to the key for every value e.g. `&ids[]=1&ids[]=2`\n * 'indices': appends [i] to the key for every value e.g. `&ids[0]=1&ids[1]=2`\n * 'repeat': appends the key for every value e.g. `&ids=1&ids=2`\n * 'comma' (default): appends the key once with a comma separated list of values e.g. `&ids=1,2`\n *\n * @public\n * @return A {@link URLSearchParams} with keys inserted in sorted order\n */\nexport function sortQueryParams(params: QueryParamsSource, options?: QueryParamsSerializationOptions): URLSearchParams {\n  const opts = Object.assign({}, DEFAULT_QUERY_PARAMS_SERIALIZATION_OPTIONS, options);\n  const paramsIsObject = !(params instanceof URLSearchParams);\n  const urlParams = new URLSearchParams();\n  // shallow copy so that normalizing `include` below does not write back onto\n  // the caller's object. Array values are still shared with the caller, so\n  // everything downstream must sort copies rather than sorting in place.\n  const dictionaryParams: Record<string, Serializable> = paramsIsObject ? Object.assign({}, params) : {};\n\n  if (!paramsIsObject) {\n    params.forEach((value, key) => {\n      const hasExisting = key in dictionaryParams;\n      if (!hasExisting) {\n        dictionaryParams[key] = value;\n      } else {\n        const existingValue = dictionaryParams[key];\n        if (Array.isArray(existingValue)) {\n          existingValue.push(value);\n        } else {\n          dictionaryParams[key] = [existingValue, value];\n        }\n      }\n    });\n  }\n\n  if ('include' in dictionaryParams) {\n    dictionaryParams.include = handleInclude(dictionaryParams.include as string | string[]);\n  }\n\n  const sortedKeys = Object.keys(dictionaryParams).sort();\n  sortedKeys.forEach((key) => {\n    const value = dictionaryParams[key];\n    if (Array.isArray(value)) {\n      const sortedValue = value.toSorted();\n      switch (opts.arrayFormat) {\n        case 'indices':\n          sortedValue.forEach((v, i) => {\n            urlParams.append(`${key}[${i}]`, String(v));\n          });\n          return;\n        case 'bracket':\n          sortedValue.forEach((v) => {\n            urlParams.append(`${key}[]`, String(v));\n          });\n          return;\n        case 'repeat':\n          sortedValue.forEach((v) => {\n            urlParams.append(key, String(v));\n          });\n          return;\n        case 'comma':\n        default:\n          urlParams.append(key, sortedValue.join(','));\n          return;\n      }\n    } else {\n      urlParams.append(key, String(value));\n    }\n  });\n\n  return urlParams;\n}\n\n/**\n * Sorts query params by both key and value, returning a query params string\n *\n * Treats `included` specially, splicing it into an array if it is a string and sorting the array.\n *\n * The `params` given are never mutated: neither the object itself nor any array\n * value it holds is reordered or replaced, so passing state that is also\n * rendered (a tracked array of filter values, for instance) is safe.\n *\n * Options:\n * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'\n *\n * 'bracket': appends [] to the key for every value e.g. `ids[]=1&ids[]=2`\n * 'indices': appends [i] to the key for every value e.g. `ids[0]=1&ids[1]=2`\n * 'repeat': appends the key for every value e.g. `ids=1&ids=2`\n * 'comma' (default): appends the key once with a comma separated list of values e.g. `ids=1,2`\n *\n * @public\n * @return A sorted query params string without the leading `?`\n */\nexport function buildQueryParams(params: QueryParamsSource, options?: QueryParamsSerializationOptions): string {\n  return sortQueryParams(params, options).toString();\n}\n"],"mappings":";;;;;;;;;;;;;AA8BA,MAAMC,SAAyBD,eAAe,UAAU;CACtDE,MAAM;CACNC,WAAW;AACb,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCD,SAAgBC,kBAAkBC,QAA8B;CAC9D,EAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,kDAAkD;CAAA,EAAA,CAAEF,MAAM;CACjE,EAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,wFAAwF;CAAA,EAAA,CACxF,UAAUF,UAAU,eAAeA,MAAM;CAG3CJ,OAAOC,OAAOG,OAAOH,QAAQ;CAC7BD,OAAOE,YAAYE,OAAOF,aAAa;CAEvC,EAAAG,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,uDAAuDN,OAAOC,KAAI,EAAG;CAAA,EAAA,CACrED,OAAOC,SAAS,OAAO,CAACD,OAAOC,KAAKM,SAAS,GAAG,CAAC;CAEnD,EAAAF,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,8DAA8DN,OAAOE,UAAS,EAAG;CAAA,EAAA,CACjF,CAACF,OAAOE,UAAUM,WAAW,GAAG,CAAC;CAEnC,EAAAH,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,4DAA4DN,OAAOE,UAAS,EAAG;CAAA,EAAA,CAC/E,CAACF,OAAOE,UAAUK,SAAS,GAAG,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwVA,MAAME,kDAAkC,IAAIC,IAAI;CAC9C;CACA;CACA;CACA;CACA;AAAc,CACf;AAED,SAASC,6BACPC,SAMyB;CACzB,OAAO,QAAQA,WAAWH,gCAAgCI,IAAID,QAAQE,EAAE;AAC1E;AAEA,SAASC,gBAAgBH,SAAmD;CAC1E,OAAO,kBAAkBA,WAAW,OAAOA,QAAQI,iBAAiB,YAAYJ,QAAQI,aAAaC,SAAS;AAChH;AAEA,SAASC,oBAAoBN,SAA6B;CACxD,EAAAP,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,kEAAkE;CAAA,EAAA,CAClE,QAAQM,WAAW,OAAOA,QAAQE,OAAO,QAAQ;CAEnD,OAAOF,QAAQE,OAAO,aAAaF,QAAQO,YAAY,EAAE,CAACC,OAAOR,QAAQS,WAAWD;AACtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,SAAgBE,aAAaC,YAAgC;CAC3D,MAAMX,UAAUY,OAAOC,OACrB;EACExB,MAAMD,OAAOC;EACbC,WAAWF,OAAOE;CACpB,GACAqB,UACF;CACA,EAAAlB,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,uDAAuD;CAAA,EAAA,CACvDS,gBAAgBH,OAAO,KAAM,OAAOA,QAAQE,OAAO,YAAYF,QAAQE,GAAGG,SAAS,CAAE;CAEvF,EAAAZ,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,+DAA+D;CAAA,EAAA,CAC/DS,gBAAgBH,OAAO,KACrBA,QAAQE,OAAO,cACdF,QAAQS,cAAc,OAAOT,QAAQS,eAAe,QAAS;CAElE,EAAAhB,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,gEAAgE;CAAA,EAAA,CAChES,gBAAgBH,OAAO,KACrBA,QAAQE,OAAO,cACdF,QAAQO,eACPO,MAAMC,QAAQf,QAAQO,WAAW,KACjCP,QAAQO,YAAYF,SAAS,KAC7BL,QAAQO,YAAYS,OAAOC,MAAMA,KAAK,OAAOA,MAAM,QAAQ,CAAE;CAEnE,EAAAxB,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,oFAAoF;CAAA,EAAA,CACpFS,gBAAgBH,OAAO,KACrB,CAACD,6BAA6BC,OAAO,KACpC,OAAOA,QAAQS,WAAWS,OAAO,YAAYlB,QAAQS,WAAWS,GAAGb,SAAS,CAAE;CAEnF,EAAAZ,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,gEAAgE;CAAA,EAAA,CAChES,gBAAgBH,OAAO,KACrBA,QAAQE,OAAO,cACfF,QAAQO,YAAYS,OAAOC,MAAM,OAAOA,EAAEC,OAAO,YAAYD,EAAEC,GAAGb,SAAS,CAAC,CAAC;CAEjF,EAAAZ,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,sFAAsF;CAAA,EAAA,CACtFS,gBAAgBH,OAAO,KACrBA,QAAQE,OAAO,cACd,OAAOF,QAAQS,WAAWD,SAAS,YAAYR,QAAQS,WAAWD,KAAKH,SAAS,CAAE;CAEvF,EAAAZ,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,uFAAuF;CAAA,EAAA,CACvFS,gBAAgBH,OAAO,KACrBA,QAAQE,OAAO,cACd,OAAOF,QAAQO,YAAY,EAAE,CAACC,SAAS,YAAYR,QAAQO,YAAY,EAAE,CAACC,KAAKH,SAAS,CAAE;CAI/F,MAAMc,SACFpB,6BAA6BC,OAAO,IAAIoB,mBAAmBpB,QAAQS,WAAWS,EAAE,IAC9E;CACN,MAAMd,eAAeJ,QAAQI,gBAAgBE,oBAAoBN,OAAO;CACxE,MAAM,EAAEX,MAAMC,cAAcU;CAC5B,MAAMqB,YAAY,eAAerB,UAAUA,QAAQqB,YAAY;CAE/D,EAAA5B,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,gDAAgD4B,OAC9C,QAAQtB,UAAUA,QAAQE,KAAK,MAAM,EACvC,EAAC,aAAcE,aAAY,sDAAuD;GAChF;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EAAU,CACX,CAACmB,KAAK,OAAK,EAAC,GAAI;CAAA,EAAA,CACjBpB,gBAAgBH,OAAO,KACrB;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CAAc,CACf,CAACwB,SAASxB,QAAQE,EAAE,CAAC;CAG1B,EAAAT,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,uDAAuDL,KAAI,EAAG;CAAA,EAAA,CAAEA,SAAS,OAAO,CAACA,KAAKM,SAAS,GAAG,CAAC;CAC1G,EAAAF,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,8DAA8DJ,UAAS,EAAG;CAAA,EAAA,CAAE,CAACA,UAAUM,WAAW,GAAG,CAAC;CAC7G,EAAAH,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,4DAA4DJ,UAAS,EAAG;CAAA,EAAA,CAAE,CAACA,UAAUK,SAAS,GAAG,CAAC;CACzG,EAAAF,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,iEAAiEU,aAAY,EAAG;CAAA,EAAA,CAChF,CAACA,aAAaR,WAAW,GAAG,CAAC;CAE/B,EAAAH,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,+DAA+DU,aAAY,EAAG;CAAA,EAAA,CAAE,CAACA,aAAaT,SAAS,GAAG,CAAC;CAClH,EAAAF,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,8DAA8D2B,UAAS,EAAG;CAAA,EAAA,CAAE,CAACA,UAAUzB,WAAW,GAAG,CAAC;CAC7G,EAAAH,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,4DAA4D2B,UAAS,EAAG;CAAA,EAAA,CAAE,CAACA,UAAU1B,SAAS,GAAG,CAAC;CACzG,EAAAF,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,2DAA2DyB,OAAM,EAAG;CAAA,EAAA,CAAE,CAACA,OAAOvB,WAAW,GAAG,CAAC;CACpG,EAAAH,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,yDAAyDyB,OAAM,EAAG;CAAA,EAAA,CAAE,CAACA,OAAOxB,SAAS,GAAG,CAAC;CAEhG,MAAM8B,UAAUpC,SAAS,MAAMA,SAAS;CACxC,MAAMqC,MAAM;EAACD,UAAUpC,OAAO;EAAIC;EAAWc;EAAce;EAAQE;CAAS,CAAC,CAACM,OAAOC,OAAO,CAAC,CAACL,KAAK,GAAG;CACtG,OAAOE,UAAUC,MAAM,IAAIA;AAC7B;AAEA,MAAMG,6CAA8E,EAClFC,aAAa,QACf;AAEA,SAASC,cAAcC,SAAsC;CAC3D,EAAAvC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,iDAAiD,OAAOsC,SAAS;CAAA,EAAA,CACjE,OAAOA,YAAY,YAAYlB,MAAMC,QAAQiB,OAAO,CAAC;CAEvD,OAAO,OAAOA,YAAY,WAAWA,QAAQC,MAAM,GAAG,IAAID;AAC5D;;;;;;;;;AAUA,SAAgBE,YAAYC,QAAoE;CAC9F,MAAMC,SAAuC,CAAC;CAC9C,KAAK,MAAMC,OAAOF,QAAQ;EACxB,MAAMG,QAAQH,OAAOE;EAErB,IAAIC,UAAUC,UAAaD,UAAU,QAAQA,UAAU,IACrD;OAAI,CAACxB,MAAMC,QAAQuB,KAAK,KAAKA,MAAMjC,SAAS,GAC1C+B,OAAOC,OAAOF,OAAOE;EACvB;CAEJ;CACA,OAAOD;AACT;;;;;;;;;;;;;;;;;;;;;;AAuBA,SAAgBI,gBAAgBC,QAA2BzC,SAA4D;CACrH,MAAM0C,OAAO9B,OAAOC,OAAO,CAAC,GAAGgB,4CAA4C7B,OAAO;CAClF,MAAM2C,iBAAiB,EAAEF,kBAAkBG;CAC3C,MAAMC,YAAY,IAAID,gBAAgB;CAItC,MAAME,mBAAiDH,iBAAiB/B,OAAOC,OAAO,CAAC,GAAG4B,MAAM,IAAI,CAAC;CAErG,IAAI,CAACE,gBACHF,OAAOM,SAAST,OAAOD,QAAQ;EAE7B,IAAI,EADgBA,OAAOS,mBAEzBA,iBAAiBT,OAAOC;OACnB;GACL,MAAMW,gBAAgBH,iBAAiBT;GACvC,IAAIvB,MAAMC,QAAQkC,aAAa,GAC7BA,cAAcC,KAAKZ,KAAK;QAExBQ,iBAAiBT,OAAO,CAACY,eAAeX,KAAK;EAEjD;CACF,CAAC;CAGH,IAAI,aAAaQ,kBACfA,iBAAiBd,UAAUD,cAAce,iBAAiBd,OAA4B;CAIxFmB,AADmBvC,OAAOwC,KAAKN,gBAAgB,CAAC,CAACO,KACjDF,CAAU,CAACJ,SAASV,QAAQ;EAC1B,MAAMC,QAAQQ,iBAAiBT;EAC/B,IAAIvB,MAAMC,QAAQuB,KAAK,GAAG;GACxB,MAAMgB,cAAchB,MAAMiB,SAAS;GACnC,QAAQb,KAAKZ,aAAb;IACE,KAAK;KACHwB,YAAYP,SAASS,GAAGvC,MAAM;MAC5B4B,UAAUY,OAAO,GAAGpB,IAAG,GAAIpB,EAAC,IAAKK,OAAOkC,CAAC,CAAC;KAC5C,CAAC;KACD;IACF,KAAK;KACHF,YAAYP,SAASS,MAAM;MACzBX,UAAUY,OAAO,GAAGpB,IAAG,KAAMf,OAAOkC,CAAC,CAAC;KACxC,CAAC;KACD;IACF,KAAK;KACHF,YAAYP,SAASS,MAAM;MACzBX,UAAUY,OAAOpB,KAAKf,OAAOkC,CAAC,CAAC;KACjC,CAAC;KACD;IAEF;KACEX,UAAUY,OAAOpB,KAAKiB,YAAY/B,KAAK,GAAG,CAAC;KAC3C;GACJ;EACF,OACEsB,UAAUY,OAAOpB,KAAKf,OAAOgB,KAAK,CAAC;CAEvC,CAAC;CAED,OAAOO;AACT;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgBa,iBAAiBjB,QAA2BzC,SAAmD;CAC7G,OAAOwC,gBAAgBC,QAAQzC,OAAO,CAAC,CAAC2D,SAAS;AACnD"}
+{"version":3,"file":"index.js","names":["getOrSetGlobal","CONFIG","host","namespace","setBuildURLConfig","config","test","Error","endsWith","startsWith","OPERATIONS_WITH_PRIMARY_RECORDS","Set","isOperationWithPrimaryRecord","options","has","op","hasResourcePath","resourcePath","length","resourcePathForType","identifiers","type","identifier","buildBaseURL","urlOptions","Object","assign","Array","isArray","every","i","id","idPath","encodeURIComponent","fieldPath","String","join","includes","hasHost","url","filter","Boolean","DEFAULT_QUERY_PARAMS_SERIALIZATION_OPTIONS","arrayFormat","handleInclude","include","split","filterEmpty","source","result","key","value","undefined","sortQueryParams","params","opts","paramsIsObject","URLSearchParams","urlParams","dictionaryParams","forEach","hasExisting","existingValue","push","sortedKeys","keys","sort","sortedValue","toSorted","v","append","buildQueryParams","toString"],"sources":["../../../src/index.ts"],"sourcesContent":["/**\n * @summary Helpers for building request URLs and sorted query strings, with a configurable global host and namespace.\n * @module\n * @mergeModuleWith <project>\n */\n\nimport { assert } from '@warp-drive/core/build-config/macros';\nimport { getOrSetGlobal } from '@warp-drive/core/types/-private';\nimport type { QueryParamsSerializationOptions, QueryParamsSource, Serializable } from '@warp-drive/core/types/params';\n\n// prevents the final constructed object from needing to add\n// host and namespace which are provided by the final consuming\n// class to the prototype which can result in overwrite errors\n\n/**\n * The global configuration used by {@link buildBaseURL} when a call does\n * not provide its own `host`/`namespace`. Set via {@link setBuildURLConfig}.\n *\n * @summary The global `host` and `namespace` that `buildBaseURL` prefixes onto URLs when a call does not pass its own.\n * @public\n */\nexport interface BuildURLConfig {\n  /**\n   * The scheme, domain and port (if any) to prefix built URLs with, e.g. `'https://api.example.com'`.\n   */\n  host: string | null;\n  /**\n   * The path segment to insert between `host` and the resource path, e.g. `'api/v1'`.\n   */\n  namespace: string | null;\n}\n\nconst CONFIG: BuildURLConfig = getOrSetGlobal('CONFIG', {\n  host: '',\n  namespace: '',\n});\n\n/**\n * Sets the global configuration for `buildBaseURL`\n * for host and namespace values for the application.\n *\n * These values may still be overridden by passing\n * them to buildBaseURL directly.\n *\n * The [Basic Usage](/guides/the-manual/cookbook/basic-usage#step-2-configure-some-request-defaults)\n * guide sets these defaults through the `@warp-drive/utilities/json-api` version of this function,\n * which also sets this global configuration.\n *\n * This method may be called as many times as needed.\n * host values of `''` or `'/'` are equivalent.\n *\n * Except for the value of `/` as host, host should not\n * end with `/`.\n *\n * namespace should not start or end with a `/`.\n *\n * ```ts\n * type BuildURLConfig = {\n *   host: string;\n *   namespace: string'\n * }\n * ```\n *\n * Example:\n *\n * ```ts\n * import { setBuildURLConfig } from '@warp-drive/utilities';\n *\n * setBuildURLConfig({\n *   host: 'https://api.example.com',\n *   namespace: 'api/v1'\n * });\n * ```\n *\n * @summary Sets the app-wide default `host` and `namespace` used by `buildBaseURL` and the request builders.\n * @public\n */\nexport function setBuildURLConfig(config: BuildURLConfig): void {\n  assert(`setBuildURLConfig: You must pass a config object`, config);\n  assert(\n    `setBuildURLConfig: You must pass a config object with a 'host' or 'namespace' property`,\n    'host' in config || 'namespace' in config\n  );\n\n  CONFIG.host = config.host || '';\n  CONFIG.namespace = config.namespace || '';\n\n  assert(\n    `buildBaseURL: host must NOT end with '/', received '${CONFIG.host}'`,\n    CONFIG.host === '/' || !CONFIG.host.endsWith('/')\n  );\n  assert(\n    `buildBaseURL: namespace must NOT start with '/', received '${CONFIG.namespace}'`,\n    !CONFIG.namespace.startsWith('/')\n  );\n  assert(\n    `buildBaseURL: namespace must NOT end with '/', received '${CONFIG.namespace}'`,\n    !CONFIG.namespace.endsWith('/')\n  );\n}\n\n/**\n * {@link buildBaseURL} options for a `findRecord` request.\n *\n * @summary Options passed to `buildBaseURL` to build the URL for fetching one resource by type and id.\n * @public\n */\nexport interface FindRecordUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'findRecord';\n  /**\n   * The type and id of the record to find.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  };\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for a `query` request.\n *\n * @summary Options passed to `buildBaseURL` to build the URL for querying a collection of one resource type.\n * @public\n */\nexport interface QueryUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'query';\n  /**\n   * The type of the records to query.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n  };\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for a `findMany` request.\n *\n * @summary Options passed to `buildBaseURL` to build the URL for fetching several resources, pathed by the first\n * identifier's type.\n * @public\n */\nexport interface FindManyUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'findMany';\n  /**\n   * The type and id of each record to find.\n   */\n  identifiers: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  }[];\n  /**\n   * The path segment for the resource, defaults to the first identifier's `type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n/**\n * {@link buildBaseURL} options for a `findRelatedCollection` request.\n *\n * @summary Options passed to `buildBaseURL` to build the URL for a record's has-many relationship, ending in the\n * field name.\n * @public\n */\nexport interface FindRelatedCollectionUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'findRelatedCollection';\n  /**\n   * The type and id of the record whose relationship is being fetched.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  };\n  /**\n   * The relationship field name, appended to the resource path.\n   */\n  fieldPath: string;\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for a `findRelatedRecord` request.\n *\n * @summary Options passed to `buildBaseURL` to build the URL for a record's belongs-to relationship, ending in the\n * field name.\n * @public\n */\nexport interface FindRelatedResourceUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'findRelatedRecord';\n  /**\n   * The type and id of the record whose relationship is being fetched.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  };\n  /**\n   * The relationship field name, appended to the resource path.\n   */\n  fieldPath: string;\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for a `createRecord` request.\n *\n * @summary Options passed to `buildBaseURL` to build the collection URL a new record of a given type is saved to.\n * @public\n */\nexport interface CreateRecordUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'createRecord';\n  /**\n   * The type of the record being created.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n  };\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for an `updateRecord` request.\n *\n * @summary Options passed to `buildBaseURL` to build the URL for saving changes to an existing record by type and id.\n * @public\n */\nexport interface UpdateRecordUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'updateRecord';\n  /**\n   * The type and id of the record being updated.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  };\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for a `deleteRecord` request.\n *\n * @summary Options passed to `buildBaseURL` to build the URL for deleting an existing record by type and id.\n * @public\n */\nexport interface DeleteRecordUrlOptions {\n  /**\n   * The request operation this URL is for.\n   */\n  op: 'deleteRecord';\n  /**\n   * The type and id of the record being deleted.\n   */\n  identifier: {\n    /**\n     * The resource type.\n     */\n    type: string;\n    /**\n     * The resource id.\n     */\n    id: string;\n  };\n  /**\n   * The path segment for the resource, defaults to `identifier.type` if not provided.\n   */\n  resourcePath?: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * {@link buildBaseURL} options for building a URL directly from a `resourcePath`\n * without an associated request operation.\n *\n * @summary Options passed to `buildBaseURL` to build a URL from an explicit `resourcePath` with no request `op`.\n * @public\n */\nexport interface GenericUrlOptions {\n  /**\n   * The path segment for the resource.\n   */\n  resourcePath: string;\n  /**\n   * Overrides the globally configured host for this call only.\n   */\n  host?: string;\n  /**\n   * Overrides the globally configured namespace for this call only.\n   */\n  namespace?: string;\n}\n\n/**\n * The union of all `op`-specific option shapes accepted by {@link buildBaseURL}, one of:\n *\n * - {@link FindRecordUrlOptions}\n * - {@link QueryUrlOptions}\n * - {@link FindManyUrlOptions}\n * - {@link FindRelatedCollectionUrlOptions}\n * - {@link FindRelatedResourceUrlOptions}\n * - {@link CreateRecordUrlOptions}\n * - {@link UpdateRecordUrlOptions}\n * - {@link DeleteRecordUrlOptions}\n * - {@link GenericUrlOptions}\n *\n * @summary Any of the option shapes `buildBaseURL` accepts, one per request `op` plus a generic `resourcePath` form.\n * @public\n */\nexport type UrlOptions =\n  | FindRecordUrlOptions\n  | QueryUrlOptions\n  | FindManyUrlOptions\n  | FindRelatedCollectionUrlOptions\n  | FindRelatedResourceUrlOptions\n  | CreateRecordUrlOptions\n  | UpdateRecordUrlOptions\n  | DeleteRecordUrlOptions\n  | GenericUrlOptions;\n\nconst OPERATIONS_WITH_PRIMARY_RECORDS = new Set([\n  'findRecord',\n  'findRelatedRecord',\n  'findRelatedCollection',\n  'updateRecord',\n  'deleteRecord',\n]);\n\nfunction isOperationWithPrimaryRecord(\n  options: UrlOptions\n): options is\n  | FindRecordUrlOptions\n  | FindRelatedCollectionUrlOptions\n  | FindRelatedResourceUrlOptions\n  | UpdateRecordUrlOptions\n  | DeleteRecordUrlOptions {\n  return 'op' in options && OPERATIONS_WITH_PRIMARY_RECORDS.has(options.op);\n}\n\nfunction hasResourcePath(options: UrlOptions): options is GenericUrlOptions {\n  return 'resourcePath' in options && typeof options.resourcePath === 'string' && options.resourcePath.length > 0;\n}\n\nfunction resourcePathForType(options: UrlOptions): string {\n  assert(\n    `resourcePathForType: You must pass a valid op as part of options`,\n    'op' in options && typeof options.op === 'string'\n  );\n  return options.op === 'findMany' ? options.identifiers[0].type : options.identifier.type;\n}\n\n/**\n * Builds a URL for a request based on the provided options.\n * Does not include support for building query params (see `buildQueryParams`)\n * so that it may be composed cleanly with other query-params strategies.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for writing your own request\n * builders.\n *\n * Usage:\n *\n * ```ts\n * import { buildBaseURL } from '@warp-drive/utilities';\n *\n * const url = buildBaseURL({\n *   host: 'https://api.example.com',\n *   namespace: 'api/v1',\n *   resourcePath: 'emberDevelopers',\n *   op: 'query',\n *   identifier: { type: 'ember-developer' }\n * });\n *\n * // => 'https://api.example.com/api/v1/emberDevelopers'\n * ```\n *\n * On the surface this may seem like a lot of work to do something simple, but\n * it is designed to be composable with other utilities and interfaces that the\n * average product engineer will never need to see or use.\n *\n * A few notes:\n *\n * - `resourcePath` is optional, but if it is not provided, `identifier.type` will be used.\n * - `host` and `namespace` are optional, but if they are not provided, the values globally\n *    configured via `setBuildURLConfig` will be used.\n * - `op` is required and must be one of the following:\n *   - 'findRecord' 'query' 'findMany' 'findRelatedCollection' 'findRelatedRecord'` 'createRecord' 'updateRecord' 'deleteRecord'\n * - Depending on the value of `op`, `identifier` or `identifiers` will be required.\n *\n * @summary Joins host, namespace, resource path, id, and relationship field into a request URL without query params.\n * @public\n */\nexport function buildBaseURL(urlOptions: UrlOptions): string {\n  const options = Object.assign(\n    {\n      host: CONFIG.host,\n      namespace: CONFIG.namespace,\n    },\n    urlOptions\n  );\n  assert(\n    `buildBaseURL: You must pass \\`op\\` as part of options`,\n    hasResourcePath(options) || (typeof options.op === 'string' && options.op.length > 0)\n  );\n  assert(\n    `buildBaseURL: You must pass \\`identifier\\` as part of options`,\n    hasResourcePath(options) ||\n      options.op === 'findMany' ||\n      (options.identifier && typeof options.identifier === 'object')\n  );\n  assert(\n    `buildBaseURL: You must pass \\`identifiers\\` as part of options`,\n    hasResourcePath(options) ||\n      options.op !== 'findMany' ||\n      (options.identifiers &&\n        Array.isArray(options.identifiers) &&\n        options.identifiers.length > 0 &&\n        options.identifiers.every((i) => i && typeof i === 'object'))\n  );\n  assert(\n    `buildBaseURL: You must pass valid \\`identifier\\` as part of options, expected 'id'`,\n    hasResourcePath(options) ||\n      !isOperationWithPrimaryRecord(options) ||\n      (typeof options.identifier.id === 'string' && options.identifier.id.length > 0)\n  );\n  assert(\n    `buildBaseURL: You must pass \\`identifiers\\` as part of options`,\n    hasResourcePath(options) ||\n      options.op !== 'findMany' ||\n      options.identifiers.every((i) => typeof i.id === 'string' && i.id.length > 0)\n  );\n  assert(\n    `buildBaseURL: You must pass valid \\`identifier\\` as part of options, expected 'type'`,\n    hasResourcePath(options) ||\n      options.op === 'findMany' ||\n      (typeof options.identifier.type === 'string' && options.identifier.type.length > 0)\n  );\n  assert(\n    `buildBaseURL: You must pass valid \\`identifiers\\` as part of options, expected 'type'`,\n    hasResourcePath(options) ||\n      options.op !== 'findMany' ||\n      (typeof options.identifiers[0].type === 'string' && options.identifiers[0].type.length > 0)\n  );\n\n  // prettier-ignore\n  const idPath: string =\n      isOperationWithPrimaryRecord(options) ? encodeURIComponent(options.identifier.id)\n      : '';\n  const resourcePath = options.resourcePath || resourcePathForType(options);\n  const { host, namespace } = options;\n  const fieldPath = 'fieldPath' in options ? options.fieldPath : '';\n\n  assert(\n    `buildBaseURL: You tried to build a url for a ${String(\n      'op' in options ? options.op + ' ' : ''\n    )}request to ${resourcePath} but resourcePath must be set or op must be one of \"${[\n      'findRecord',\n      'findRelatedRecord',\n      'findRelatedCollection',\n      'updateRecord',\n      'deleteRecord',\n      'createRecord',\n      'query',\n      'findMany',\n    ].join('\",\"')}\".`,\n    hasResourcePath(options) ||\n      [\n        'findRecord',\n        'query',\n        'findMany',\n        'findRelatedCollection',\n        'findRelatedRecord',\n        'createRecord',\n        'updateRecord',\n        'deleteRecord',\n      ].includes(options.op)\n  );\n\n  assert(`buildBaseURL: host must NOT end with '/', received '${host}'`, host === '/' || !host.endsWith('/'));\n  assert(`buildBaseURL: namespace must NOT start with '/', received '${namespace}'`, !namespace.startsWith('/'));\n  assert(`buildBaseURL: namespace must NOT end with '/', received '${namespace}'`, !namespace.endsWith('/'));\n  assert(\n    `buildBaseURL: resourcePath must NOT start with '/', received '${resourcePath}'`,\n    !resourcePath.startsWith('/')\n  );\n  assert(`buildBaseURL: resourcePath must NOT end with '/', received '${resourcePath}'`, !resourcePath.endsWith('/'));\n  assert(`buildBaseURL: fieldPath must NOT start with '/', received '${fieldPath}'`, !fieldPath.startsWith('/'));\n  assert(`buildBaseURL: fieldPath must NOT end with '/', received '${fieldPath}'`, !fieldPath.endsWith('/'));\n  assert(`buildBaseURL: idPath must NOT start with '/', received '${idPath}'`, !idPath.startsWith('/'));\n  assert(`buildBaseURL: idPath must NOT end with '/', received '${idPath}'`, !idPath.endsWith('/'));\n\n  const hasHost = host !== '' && host !== '/';\n  const url = [hasHost ? host : '', namespace, resourcePath, idPath, fieldPath].filter(Boolean).join('/');\n  return hasHost ? url : `/${url}`;\n}\n\nconst DEFAULT_QUERY_PARAMS_SERIALIZATION_OPTIONS: QueryParamsSerializationOptions = {\n  arrayFormat: 'comma',\n};\n\nfunction handleInclude(include: string | string[]): string[] {\n  assert(\n    `Expected include to be a string or array, got ${typeof include}`,\n    typeof include === 'string' || Array.isArray(include)\n  );\n  return typeof include === 'string' ? include.split(',') : include;\n}\n\n/**\n * filter out keys of an object that have falsy values or point to empty arrays\n * returning a new object with only those keys that have truthy values / non-empty arrays\n *\n * See [Cache Keys for Requests](/guides/the-manual/requests/builders#cache-keys-for-requests) for\n * why builders need stable query params.\n *\n * @summary Returns a copy of an object without keys whose values are `undefined`, `null`, empty strings, or empty\n * arrays.\n * @public\n * @param source object to filter keys with empty values from\n * @return A new object with the keys that contained empty values removed\n */\nexport function filterEmpty(source: Record<string, Serializable>): Record<string, Serializable> {\n  const result: Record<string, Serializable> = {};\n  for (const key in source) {\n    const value = source[key];\n    // Allow `0` and `false` but filter falsy values that indicate \"empty\"\n    if (value !== undefined && value !== null && value !== '') {\n      if (!Array.isArray(value) || value.length > 0) {\n        result[key] = source[key];\n      }\n    }\n  }\n  return result;\n}\n\n/**\n * Sorts query params by both key and value returning a new URLSearchParams\n * object with the keys inserted in sorted order.\n *\n * See [Cache Keys for Requests](/guides/the-manual/requests/builders#cache-keys-for-requests) for\n * why builders need stable query params.\n *\n * Treats `included` specially, splicing it into an array if it is a string and sorting the array.\n *\n * The `params` given are never mutated: neither the object itself nor any array\n * value it holds is reordered or replaced, so passing state that is also\n * rendered (a tracked array of filter values, for instance) is safe.\n *\n * Options:\n * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'\n *\n * 'bracket': appends [] to the key for every value e.g. `&ids[]=1&ids[]=2`\n * 'indices': appends [i] to the key for every value e.g. `&ids[0]=1&ids[1]=2`\n * 'repeat': appends the key for every value e.g. `&ids=1&ids=2`\n * 'comma' (default): appends the key once with a comma separated list of values e.g. `&ids=1,2`\n *\n * @summary Builds a `URLSearchParams` with keys and array values sorted, so equivalent queries produce identical\n * params.\n * @public\n * @return A {@link URLSearchParams} with keys inserted in sorted order\n */\nexport function sortQueryParams(params: QueryParamsSource, options?: QueryParamsSerializationOptions): URLSearchParams {\n  const opts = Object.assign({}, DEFAULT_QUERY_PARAMS_SERIALIZATION_OPTIONS, options);\n  const paramsIsObject = !(params instanceof URLSearchParams);\n  const urlParams = new URLSearchParams();\n  // shallow copy so that normalizing `include` below does not write back onto\n  // the caller's object. Array values are still shared with the caller, so\n  // everything downstream must sort copies rather than sorting in place.\n  const dictionaryParams: Record<string, Serializable> = paramsIsObject ? Object.assign({}, params) : {};\n\n  if (!paramsIsObject) {\n    params.forEach((value, key) => {\n      const hasExisting = key in dictionaryParams;\n      if (!hasExisting) {\n        dictionaryParams[key] = value;\n      } else {\n        const existingValue = dictionaryParams[key];\n        if (Array.isArray(existingValue)) {\n          existingValue.push(value);\n        } else {\n          dictionaryParams[key] = [existingValue, value];\n        }\n      }\n    });\n  }\n\n  if ('include' in dictionaryParams) {\n    dictionaryParams.include = handleInclude(dictionaryParams.include as string | string[]);\n  }\n\n  const sortedKeys = Object.keys(dictionaryParams).sort();\n  sortedKeys.forEach((key) => {\n    const value = dictionaryParams[key];\n    if (Array.isArray(value)) {\n      const sortedValue = value.toSorted();\n      switch (opts.arrayFormat) {\n        case 'indices':\n          sortedValue.forEach((v, i) => {\n            urlParams.append(`${key}[${i}]`, String(v));\n          });\n          return;\n        case 'bracket':\n          sortedValue.forEach((v) => {\n            urlParams.append(`${key}[]`, String(v));\n          });\n          return;\n        case 'repeat':\n          sortedValue.forEach((v) => {\n            urlParams.append(key, String(v));\n          });\n          return;\n        case 'comma':\n        default:\n          urlParams.append(key, sortedValue.join(','));\n          return;\n      }\n    } else {\n      urlParams.append(key, String(value));\n    }\n  });\n\n  return urlParams;\n}\n\n/**\n * Sorts query params by both key and value, returning a query params string\n *\n * See [Cache Keys for Requests](/guides/the-manual/requests/builders#cache-keys-for-requests) for\n * why builders need stable query params.\n *\n * Treats `included` specially, splicing it into an array if it is a string and sorting the array.\n *\n * The `params` given are never mutated: neither the object itself nor any array\n * value it holds is reordered or replaced, so passing state that is also\n * rendered (a tracked array of filter values, for instance) is safe.\n *\n * Options:\n * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'\n *\n * 'bracket': appends [] to the key for every value e.g. `ids[]=1&ids[]=2`\n * 'indices': appends [i] to the key for every value e.g. `ids[0]=1&ids[1]=2`\n * 'repeat': appends the key for every value e.g. `ids=1&ids=2`\n * 'comma' (default): appends the key once with a comma separated list of values e.g. `ids=1,2`\n *\n * @summary Serializes query params into a string with keys and array values sorted, so equivalent queries share one\n * URL.\n * @public\n * @return A sorted query params string without the leading `?`\n */\nexport function buildQueryParams(params: QueryParamsSource, options?: QueryParamsSerializationOptions): string {\n  return sortQueryParams(params, options).toString();\n}\n"],"mappings":";;;;;;;;;;;;;;;AAgCA,MAAMC,SAAyBD,eAAe,UAAU;CACtDE,MAAM;CACNC,WAAW;AACb,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CD,SAAgBC,kBAAkBC,QAA8B;CAC9D,EAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,kDAAkD;CAAA,EAAA,CAAEF,MAAM;CACjE,EAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,wFAAwF;CAAA,EAAA,CACxF,UAAUF,UAAU,eAAeA,MAAM;CAG3CJ,OAAOC,OAAOG,OAAOH,QAAQ;CAC7BD,OAAOE,YAAYE,OAAOF,aAAa;CAEvC,EAAAG,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,uDAAuDN,OAAOC,KAAI,EAAG;CAAA,EAAA,CACrED,OAAOC,SAAS,OAAO,CAACD,OAAOC,KAAKM,SAAS,GAAG,CAAC;CAEnD,EAAAF,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,8DAA8DN,OAAOE,UAAS,EAAG;CAAA,EAAA,CACjF,CAACF,OAAOE,UAAUM,WAAW,GAAG,CAAC;CAEnC,EAAAH,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,4DAA4DN,OAAOE,UAAS,EAAG;CAAA,EAAA,CAC/E,CAACF,OAAOE,UAAUK,SAAS,GAAG,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqWA,MAAME,kDAAkC,IAAIC,IAAI;CAC9C;CACA;CACA;CACA;CACA;AAAc,CACf;AAED,SAASC,6BACPC,SAMyB;CACzB,OAAO,QAAQA,WAAWH,gCAAgCI,IAAID,QAAQE,EAAE;AAC1E;AAEA,SAASC,gBAAgBH,SAAmD;CAC1E,OAAO,kBAAkBA,WAAW,OAAOA,QAAQI,iBAAiB,YAAYJ,QAAQI,aAAaC,SAAS;AAChH;AAEA,SAASC,oBAAoBN,SAA6B;CACxD,EAAAP,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,kEAAkE;CAAA,EAAA,CAClE,QAAQM,WAAW,OAAOA,QAAQE,OAAO,QAAQ;CAEnD,OAAOF,QAAQE,OAAO,aAAaF,QAAQO,YAAY,EAAE,CAACC,OAAOR,QAAQS,WAAWD;AACtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,SAAgBE,aAAaC,YAAgC;CAC3D,MAAMX,UAAUY,OAAOC,OACrB;EACExB,MAAMD,OAAOC;EACbC,WAAWF,OAAOE;CACpB,GACAqB,UACF;CACA,EAAAlB,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,uDAAuD;CAAA,EAAA,CACvDS,gBAAgBH,OAAO,KAAM,OAAOA,QAAQE,OAAO,YAAYF,QAAQE,GAAGG,SAAS,CAAE;CAEvF,EAAAZ,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,+DAA+D;CAAA,EAAA,CAC/DS,gBAAgBH,OAAO,KACrBA,QAAQE,OAAO,cACdF,QAAQS,cAAc,OAAOT,QAAQS,eAAe,QAAS;CAElE,EAAAhB,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,gEAAgE;CAAA,EAAA,CAChES,gBAAgBH,OAAO,KACrBA,QAAQE,OAAO,cACdF,QAAQO,eACPO,MAAMC,QAAQf,QAAQO,WAAW,KACjCP,QAAQO,YAAYF,SAAS,KAC7BL,QAAQO,YAAYS,OAAOC,MAAMA,KAAK,OAAOA,MAAM,QAAQ,CAAE;CAEnE,EAAAxB,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,oFAAoF;CAAA,EAAA,CACpFS,gBAAgBH,OAAO,KACrB,CAACD,6BAA6BC,OAAO,KACpC,OAAOA,QAAQS,WAAWS,OAAO,YAAYlB,QAAQS,WAAWS,GAAGb,SAAS,CAAE;CAEnF,EAAAZ,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,gEAAgE;CAAA,EAAA,CAChES,gBAAgBH,OAAO,KACrBA,QAAQE,OAAO,cACfF,QAAQO,YAAYS,OAAOC,MAAM,OAAOA,EAAEC,OAAO,YAAYD,EAAEC,GAAGb,SAAS,CAAC,CAAC;CAEjF,EAAAZ,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,sFAAsF;CAAA,EAAA,CACtFS,gBAAgBH,OAAO,KACrBA,QAAQE,OAAO,cACd,OAAOF,QAAQS,WAAWD,SAAS,YAAYR,QAAQS,WAAWD,KAAKH,SAAS,CAAE;CAEvF,EAAAZ,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,uFAAuF;CAAA,EAAA,CACvFS,gBAAgBH,OAAO,KACrBA,QAAQE,OAAO,cACd,OAAOF,QAAQO,YAAY,EAAE,CAACC,SAAS,YAAYR,QAAQO,YAAY,EAAE,CAACC,KAAKH,SAAS,CAAE;CAI/F,MAAMc,SACFpB,6BAA6BC,OAAO,IAAIoB,mBAAmBpB,QAAQS,WAAWS,EAAE,IAC9E;CACN,MAAMd,eAAeJ,QAAQI,gBAAgBE,oBAAoBN,OAAO;CACxE,MAAM,EAAEX,MAAMC,cAAcU;CAC5B,MAAMqB,YAAY,eAAerB,UAAUA,QAAQqB,YAAY;CAE/D,EAAA5B,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,gDAAgD4B,OAC9C,QAAQtB,UAAUA,QAAQE,KAAK,MAAM,EACvC,EAAC,aAAcE,aAAY,sDAAuD;GAChF;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EAAU,CACX,CAACmB,KAAK,OAAK,EAAC,GAAI;CAAA,EAAA,CACjBpB,gBAAgBH,OAAO,KACrB;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CAAc,CACf,CAACwB,SAASxB,QAAQE,EAAE,CAAC;CAG1B,EAAAT,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,uDAAuDL,KAAI,EAAG;CAAA,EAAA,CAAEA,SAAS,OAAO,CAACA,KAAKM,SAAS,GAAG,CAAC;CAC1G,EAAAF,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,8DAA8DJ,UAAS,EAAG;CAAA,EAAA,CAAE,CAACA,UAAUM,WAAW,GAAG,CAAC;CAC7G,EAAAH,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,4DAA4DJ,UAAS,EAAG;CAAA,EAAA,CAAE,CAACA,UAAUK,SAAS,GAAG,CAAC;CACzG,EAAAF,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,iEAAiEU,aAAY,EAAG;CAAA,EAAA,CAChF,CAACA,aAAaR,WAAW,GAAG,CAAC;CAE/B,EAAAH,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,+DAA+DU,aAAY,EAAG;CAAA,EAAA,CAAE,CAACA,aAAaT,SAAS,GAAG,CAAC;CAClH,EAAAF,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,8DAA8D2B,UAAS,EAAG;CAAA,EAAA,CAAE,CAACA,UAAUzB,WAAW,GAAG,CAAC;CAC7G,EAAAH,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,4DAA4D2B,UAAS,EAAG;CAAA,EAAA,CAAE,CAACA,UAAU1B,SAAS,GAAG,CAAC;CACzG,EAAAF,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,2DAA2DyB,OAAM,EAAG;CAAA,EAAA,CAAE,CAACA,OAAOvB,WAAW,GAAG,CAAC;CACpG,EAAAH,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,yDAAyDyB,OAAM,EAAG;CAAA,EAAA,CAAE,CAACA,OAAOxB,SAAS,GAAG,CAAC;CAEhG,MAAM8B,UAAUpC,SAAS,MAAMA,SAAS;CACxC,MAAMqC,MAAM;EAACD,UAAUpC,OAAO;EAAIC;EAAWc;EAAce;EAAQE;CAAS,CAAC,CAACM,OAAOC,OAAO,CAAC,CAACL,KAAK,GAAG;CACtG,OAAOE,UAAUC,MAAM,IAAIA;AAC7B;AAEA,MAAMG,6CAA8E,EAClFC,aAAa,QACf;AAEA,SAASC,cAAcC,SAAsC;CAC3D,EAAAvC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,iDAAiD,OAAOsC,SAAS;CAAA,EAAA,CACjE,OAAOA,YAAY,YAAYlB,MAAMC,QAAQiB,OAAO,CAAC;CAEvD,OAAO,OAAOA,YAAY,WAAWA,QAAQC,MAAM,GAAG,IAAID;AAC5D;;;;;;;;;;;;;;AAeA,SAAgBE,YAAYC,QAAoE;CAC9F,MAAMC,SAAuC,CAAC;CAC9C,KAAK,MAAMC,OAAOF,QAAQ;EACxB,MAAMG,QAAQH,OAAOE;EAErB,IAAIC,UAAUC,UAAaD,UAAU,QAAQA,UAAU,IACrD;OAAI,CAACxB,MAAMC,QAAQuB,KAAK,KAAKA,MAAMjC,SAAS,GAC1C+B,OAAOC,OAAOF,OAAOE;EACvB;CAEJ;CACA,OAAOD;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,SAAgBI,gBAAgBC,QAA2BzC,SAA4D;CACrH,MAAM0C,OAAO9B,OAAOC,OAAO,CAAC,GAAGgB,4CAA4C7B,OAAO;CAClF,MAAM2C,iBAAiB,EAAEF,kBAAkBG;CAC3C,MAAMC,YAAY,IAAID,gBAAgB;CAItC,MAAME,mBAAiDH,iBAAiB/B,OAAOC,OAAO,CAAC,GAAG4B,MAAM,IAAI,CAAC;CAErG,IAAI,CAACE,gBACHF,OAAOM,SAAST,OAAOD,QAAQ;EAE7B,IAAI,EADgBA,OAAOS,mBAEzBA,iBAAiBT,OAAOC;OACnB;GACL,MAAMW,gBAAgBH,iBAAiBT;GACvC,IAAIvB,MAAMC,QAAQkC,aAAa,GAC7BA,cAAcC,KAAKZ,KAAK;QAExBQ,iBAAiBT,OAAO,CAACY,eAAeX,KAAK;EAEjD;CACF,CAAC;CAGH,IAAI,aAAaQ,kBACfA,iBAAiBd,UAAUD,cAAce,iBAAiBd,OAA4B;CAIxFmB,AADmBvC,OAAOwC,KAAKN,gBAAgB,CAAC,CAACO,KACjDF,CAAU,CAACJ,SAASV,QAAQ;EAC1B,MAAMC,QAAQQ,iBAAiBT;EAC/B,IAAIvB,MAAMC,QAAQuB,KAAK,GAAG;GACxB,MAAMgB,cAAchB,MAAMiB,SAAS;GACnC,QAAQb,KAAKZ,aAAb;IACE,KAAK;KACHwB,YAAYP,SAASS,GAAGvC,MAAM;MAC5B4B,UAAUY,OAAO,GAAGpB,IAAG,GAAIpB,EAAC,IAAKK,OAAOkC,CAAC,CAAC;KAC5C,CAAC;KACD;IACF,KAAK;KACHF,YAAYP,SAASS,MAAM;MACzBX,UAAUY,OAAO,GAAGpB,IAAG,KAAMf,OAAOkC,CAAC,CAAC;KACxC,CAAC;KACD;IACF,KAAK;KACHF,YAAYP,SAASS,MAAM;MACzBX,UAAUY,OAAOpB,KAAKf,OAAOkC,CAAC,CAAC;KACjC,CAAC;KACD;IAEF;KACEX,UAAUY,OAAOpB,KAAKiB,YAAY/B,KAAK,GAAG,CAAC;KAC3C;GACJ;EACF,OACEsB,UAAUY,OAAOpB,KAAKf,OAAOgB,KAAK,CAAC;CAEvC,CAAC;CAED,OAAOO;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,SAAgBa,iBAAiBjB,QAA2BzC,SAAmD;CAC7G,OAAOwC,gBAAgBC,QAAQzC,OAAO,CAAC,CAAC2D,SAAS;AACnD"}

package/dist/unpkg/dev-deprecated/json-api.js

@@ -1,5 +1,5 @@
 import { buildBaseURL, buildQueryParams, setBuildURLConfig as setBuildURLConfig$1 } from "./index.js";
-import { s as pluralize } from "./string-j4ur-TDs.js";
+import { s as pluralize } from "./string-I8KHJXV7.js";
 import { n as extractCacheOptions, t as copyForwardUrlOptions } from "./builder-utils-BkXwUT0x.js";
 import { recordIdentifierFor } from "@warp-drive/core";
 
@@ -17,6 +17,9 @@ let ACCEPT_HEADER_VALUE = "application/vnd.api+json";
 * Extensions and profiles are keyed by their namespace with the value being
 * their URI.
 *
+* The [Basic Usage](/guides/the-manual/cookbook/basic-usage#step-2-configure-some-request-defaults)
+* guide uses it to configure a host, a namespace and a pagination profile.
+*
 * Example:
 *
 * ```ts
@@ -46,6 +49,8 @@ let ACCEPT_HEADER_VALUE = "application/vnd.api+json";
 * }
 * ```
 *
+* @summary Sets the JSON:API extensions and profiles sent in the `Accept` header, plus the global URL host and
+* namespace.
 * @public
 * @param {BuildURLConfig} config
 * @return {void}
@@ -154,6 +159,9 @@ function isExisting(identifier) {
 * Builds request options to delete record for resources,
 * configured for the url, method and header expectations of most JSON:API APIs.
 *
+* See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+* when to use one.
+*
 * **Basic Usage**
 *
 * ```ts
@@ -195,6 +203,7 @@ function isExisting(identifier) {
 * const data = await store.request(options);
 * ```
 *
+* @summary Builds a JSON:API `DELETE` request that persists deletion of an existing record.
 * @public
 * @param record
 * @param options
@@ -234,6 +243,9 @@ function deleteRecord(record, options = {}) {
 * Builds request options to create new record for resources,
 * configured for the url, method and header expectations of most JSON:API APIs.
 *
+* See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+* when to use one.
+*
 * **Basic Usage**
 *
 * ```ts
@@ -275,6 +287,7 @@ function deleteRecord(record, options = {}) {
 * const data = await store.request(options);
 * ```
 *
+* @summary Builds a JSON:API `POST` request for saving a new record; the app must set the request body itself.
 * @public
 * @param record
 * @param options
@@ -311,6 +324,9 @@ function createRecord(record, options = {}) {
 * Builds request options to update existing record for resources,
 * configured for the url, method and header expectations of most JSON:API APIs.
 *
+* See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+* when to use one.
+*
 * **Example Usage**
 *
 * ```ts
@@ -355,6 +371,8 @@ function createRecord(record, options = {}) {
 * const data = await store.request(options);
 * ```
 *
+* @summary Builds a JSON:API `PUT` (or `PATCH`) request for saving an existing record; the app must set the request
+* body itself.
 * @public
 * @param record
 * @param options
@@ -398,6 +416,8 @@ function updateRecord(record, options = {}) {
 *
 * Serializes the current state of a resource or array of resources for use with POST or PUT requests.
 *
+* @summary Copies the cached state of one or more resources into a JSON:API-style `{ data }` object, a starting point
+* for request bodies.
 * @public
 * @param cache - the cache to serialize the resource(s) from
 * @param identifiers - the resource(s) to serialize
@@ -460,6 +480,8 @@ function _serializeResource(cache, identifier) {
 * const relationshipDiffMap = cache.changedRelationships(identifier);
 * ```
 *
+* @summary Serializes only a resource's changed attributes and relationships from the cache into a JSON:API-style
+* `{ data }` patch.
 * @public
 * @param cache - the cache to serialize the resource's changes from
 * @param identifier - the resource whose changes should be serialized

package/dist/unpkg/dev-deprecated/json-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"json-api.js","names":["recordIdentifierFor","buildBaseURL","pluralize","copyForwardUrlOptions","ACCEPT_HEADER_VALUE","isExisting","identifier","id","type","deleteRecord","record","options","test","Error","urlOptions","op","resourcePath","url","headers","Headers","append","method","data","records","createRecord","updateRecord","patch","patchRecord","opts","serializeResources","cache","identifiers","data","Array","isArray","map","identifier","_serializeResource","fixRef","id","lid","type","fixRelData","rel","ref","record","structuredClone","peek","test","Error","String","relationships","key","Object","keys","relationship","length","serializePatch","hasChangedAttrs","attrsChanges","changedAttrs","attributes","forEach","change","newVal","undefined","changedRelationships","size","diff","localState"],"sources":["../../../src/-private/json-api/-utils.ts","../../../src/-private/json-api/find-record.ts","../../../src/-private/json-api/query.ts","../../../src/-private/json-api/save-record.ts","../../../src/-private/json-api/serialize.ts"],"sourcesContent":["import type { QueryParamsSource } from '@warp-drive/core/types/params';\n\nimport type { BuildURLConfig } from '../../index.ts';\nimport { buildQueryParams as buildParams, setBuildURLConfig as setConfig } from '../../index.ts';\n\nexport interface JSONAPIConfig extends BuildURLConfig {\n  profiles?: {\n    pagination?: string;\n    [key: string]: string | undefined;\n  };\n  extensions?: {\n    atomic?: string;\n    [key: string]: string | undefined;\n  };\n}\n\nconst JsonApiAccept = 'application/vnd.api+json';\nconst DEFAULT_CONFIG: JSONAPIConfig = { host: '', namespace: '' };\nexport let CONFIG: JSONAPIConfig = DEFAULT_CONFIG;\nexport let ACCEPT_HEADER_VALUE = 'application/vnd.api+json';\n\n/**\n * Allows setting extensions and profiles to be used in the `Accept` header.\n *\n * Extensions and profiles are keyed by their namespace with the value being\n * their URI.\n *\n * Example:\n *\n * ```ts\n * setBuildURLConfig({\n *   extensions: {\n *     atomic: 'https://jsonapi.org/ext/atomic'\n *   },\n *   profiles: {\n *     pagination: 'https://jsonapi.org/profiles/ethanresnick/cursor-pagination'\n *   }\n * });\n * ```\n *\n * This also sets the global configuration for `buildBaseURL`\n * for host and namespace values for the global coniguration\n * done via `import { setBuildURLConfig } from '@warp-drive/utilities';`\n *\n * These values may still be overridden by passing\n * them to buildBaseURL directly.\n *\n * This method may be called as many times as needed\n *\n * ```ts\n * type BuildURLConfig = {\n *   host: string;\n *   namespace: string'\n * }\n * ```\n *\n * @public\n * @param {BuildURLConfig} config\n * @return {void}\n */\nexport function setBuildURLConfig(config: JSONAPIConfig): void {\n  CONFIG = Object.assign({}, DEFAULT_CONFIG, config);\n\n  if (config.profiles || config.extensions) {\n    let accept = JsonApiAccept;\n    if (config.profiles) {\n      const profiles = Object.values(config.profiles);\n      if (profiles.length) {\n        accept += ';profile=\"' + profiles.join(' ') + '\"';\n      }\n    }\n    if (config.extensions) {\n      const extensions = Object.values(config.extensions);\n      if (extensions.length) {\n        accept += ';ext=' + extensions.join(' ');\n      }\n    }\n    ACCEPT_HEADER_VALUE = accept;\n  }\n\n  setConfig(config);\n}\n\ninterface RelatedObject {\n  [key: string]: string | string[] | RelatedObject;\n}\n\nexport type JsonApiQuery = {\n  include?: string | string[] | RelatedObject;\n  fields?: Record<string, string | string[]>;\n  page?: {\n    size?: number;\n    after?: string;\n    before?: string;\n  };\n};\n\nfunction isJsonApiQuery(query: JsonApiQuery | QueryParamsSource): query is JsonApiQuery {\n  if ('include' in query && query.include && typeof query.include === 'object') {\n    return true;\n  }\n  if ('fields' in query || 'page' in query) {\n    return true;\n  }\n  return false;\n}\n\nfunction collapseIncludePaths(basePath: string, include: RelatedObject, paths: string[]) {\n  const keys = Object.keys(include);\n  for (let i = 0; i < keys.length; i++) {\n    // the key is always included too\n    paths.push(`${basePath}.${keys[i]}`);\n    const key = keys[i];\n    const value = include[key];\n\n    // include: { 'company': 'field1,field2' }\n    if (typeof value === 'string') {\n      value.split(',').forEach((field) => {\n        paths.push(`${basePath}.${key}.${field}`);\n      });\n\n      // include: { 'company': ['field1', 'field2'] }\n    } else if (Array.isArray(value)) {\n      value.forEach((field) => {\n        paths.push(`${basePath}.${key}.${field}`);\n      });\n\n      // include: { 'company': { 'nested': 'field1,field2' } }\n    } else {\n      collapseIncludePaths(`${basePath}.${key}`, value, paths);\n    }\n  }\n}\n\n/**\n * Sorts query params by both key and value, returning a query params string\n *\n * Treats `included` specially, splicing it into an array if it is a string and sorting the array.\n *   - If `included` is an object we build paths dynamically for you\n * Treats `fields` specially, building JSON:API partial fields params from an object\n * Treats `page` specially, building cursor-pagination profile page params from an object\n *\n * ```ts\n * const params = buildQueryParams({\n *  include: {\n *    company: {\n *      locations: 'address'\n *    }\n *  },\n *   fields: {\n *     company: ['name', 'ticker'],\n *     person: 'name'\n *   },\n *   page: {\n *     size: 10,\n *     after: 'abc',\n *   }\n * });\n *\n * // => 'fields[company]=name,ticker&fields[person]=name&include=company.locations,company.locations.address&page[after]=abc&page[size]=10'\n * ```\n *\n * Options:\n * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'\n *\n * 'bracket': appends [] to the key for every value e.g. `ids[]=1&ids[]=2`\n * 'indices': appends [i] to the key for every value e.g. `ids[0]=1&ids[1]=2`\n * 'repeat': appends the key for every value e.g. `ids=1&ids=2`\n * 'comma' (default): appends the key once with a comma separated list of values e.g. `ids=1,2`\n *\n * @public\n * @param {URLSearchParams | Object} params\n * @param {Object} [options]\n * @return {String} A sorted query params string without the leading `?`\n */\nexport function buildQueryParams(query: JsonApiQuery | QueryParamsSource): string {\n  if (query instanceof URLSearchParams) {\n    return buildParams(query);\n  }\n\n  if (!isJsonApiQuery(query)) {\n    return buildParams(query);\n  }\n\n  const { include, fields, page, ...rest } = query;\n  const finalQuery: QueryParamsSource = {\n    ...rest,\n  };\n\n  if ('include' in query) {\n    // include: { 'company': 'field1,field2' }\n    // include: { 'company': ['field1', 'field2'] }\n    // include: { 'company': { 'nested': 'field1,field2' } }\n    // include: { 'company': { 'nested': ['field1', 'field2'] } }\n    if (include && !Array.isArray(include) && typeof include === 'object') {\n      const includePaths: string[] = [];\n      collapseIncludePaths('', include, includePaths);\n      finalQuery.include = includePaths.sort();\n\n      // include: 'field1,field2'\n      // include: ['field1', 'field2']\n    } else {\n      finalQuery.include = include;\n    }\n  }\n\n  if (fields) {\n    const keys = Object.keys(fields).sort();\n    for (let i = 0; i < keys.length; i++) {\n      const resourceType = keys[i];\n      const value = fields[resourceType];\n\n      // fields: { 'company': ['field1', 'field2'] }\n      if (Array.isArray(value)) {\n        // toSorted: `value` belongs to the caller, sorting it in place would\n        // reorder whatever else they are doing with it\n        finalQuery[`fields[${resourceType}]`] = value.toSorted().join(',');\n\n        // fields: { 'company': 'field1' }\n        // fields: { 'company': 'field1,field2' }\n      } else {\n        finalQuery[`fields[${resourceType}]`] = value.split(',').sort().join(',');\n      }\n    }\n  }\n\n  if (page) {\n    const keys = Object.keys(page).sort() as Array<'size' | 'after' | 'before'>;\n    keys.forEach((key) => {\n      const value = page[key];\n      finalQuery[`page[${key}]`] = value!;\n    });\n  }\n\n  return buildParams(finalQuery);\n}\n","import type { ReactiveDataDocument } from '@warp-drive/core/reactive';\nimport type { TypeFromInstance } from '@warp-drive/core/types/record';\nimport type {\n  FindRecordOptions,\n  FindRecordRequestOptions,\n  RemotelyAccessibleIdentifier,\n} from '@warp-drive/core/types/request';\nimport type { ApiError } from '@warp-drive/core/types/spec/error';\nimport type { Meta } from '@warp-drive/core/types/spec/json-api-raw';\n\nimport { buildBaseURL, buildQueryParams, type FindRecordUrlOptions } from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions, extractCacheOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n\n/**\n * Builds request options to fetch a single resource by a known id or identifier\n * configured for the url and header expectations of most JSON:API APIs.\n *\n * :::tabs\n *\n * == Basic Usage\n *\n * ```ts\n * import { findRecord } from '@warp-drive/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const result = await store.request(\n *   findRecord<Person>('person', '1')\n * );\n * ```\n *\n * == With Options\n *\n * ```ts\n * import { findRecord } from '@warp-drive/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const data = await store.request(\n *   findRecord<Person>(\n *     'person', '1',\n *     { include: ['pets', 'friends'] }\n *   )\n * );\n * ```\n *\n * == With an Identifier\n *\n * ```ts\n * import { findRecord } from '@warp-drive/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const data = await store.request(\n *   findRecord<Person>(\n *     { type: 'person', id: '1' },\n *     { include: ['pets', 'friends'] }\n *   )\n * );\n * ```\n *\n * :::\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { findRecord } from '@warp-drive/utilities/json-api';\n *\n * const data = await store.request(\n *   findRecord(\n *     'person', '1',\n *     { include: ['pets', 'friends'] },\n *     { namespace: 'api/v2' }\n *   )\n * );\n * ```\n *\n * @public\n */\nexport function findRecord<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>,\n  options?: FindRecordOptions\n): FindRecordRequestOptions<ReactiveDataDocument<T, M, E>, T>;\nexport function findRecord(\n  identifier: RemotelyAccessibleIdentifier,\n  options?: FindRecordOptions\n): FindRecordRequestOptions;\nexport function findRecord<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  type: TypeFromInstance<T>,\n  id: string,\n  options?: FindRecordOptions\n): FindRecordRequestOptions<ReactiveDataDocument<T, M, E>, T>;\nexport function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;\nexport function findRecord(\n  arg1: string | RemotelyAccessibleIdentifier,\n  arg2: string | FindRecordOptions | undefined,\n  arg3?: FindRecordOptions\n): FindRecordRequestOptions {\n  const identifier: RemotelyAccessibleIdentifier = typeof arg1 === 'string' ? { type: arg1, id: arg2 as string } : arg1;\n  const options = ((typeof arg1 === 'string' ? arg3 : arg2) || {}) as FindRecordOptions;\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: FindRecordUrlOptions = {\n    identifier,\n    op: 'findRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url: options.include?.length\n      ? `${url}?${buildQueryParams({ include: options.include }, options.urlParamsSettings)}`\n      : url,\n    method: 'GET',\n    headers,\n    cacheOptions,\n    op: 'findRecord',\n    records: [identifier],\n  };\n}\n\n/** @deprecated use {@link ReactiveDataDocument} */\nexport type FindRecordResultDocument<\n  T,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n> = ReactiveDataDocument<T, M, E>;\n","import type { ReactiveDataDocument } from '@warp-drive/core/reactive';\nimport type { QueryParamsSource } from '@warp-drive/core/types/params';\nimport type { TypedRecordInstance, TypeFromInstance } from '@warp-drive/core/types/record';\nimport type {\n  CacheOptions,\n  ConstrainedRequestOptions,\n  PostQueryRequestOptions,\n  QueryRequestOptions,\n} from '@warp-drive/core/types/request';\nimport type { ApiError } from '@warp-drive/core/types/spec/error';\nimport type { Meta } from '@warp-drive/core/types/spec/json-api-raw';\n\nimport { buildBaseURL, buildQueryParams, type QueryUrlOptions } from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions, extractCacheOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n/**\n * Builds request options to query for resources, usually by a primary\n * type, configured for the url and header expectations of most JSON:API APIs.\n *\n * The key difference between this and `postQuery` is that this method will send the query\n * as query params in the url of a \"GET\" request instead of as the JSON body of a \"POST\"\n * request.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { query } from '@warp-drive/utilities/json-api';\n *\n * const data = await store.request(query('person'));\n * ```\n *\n * **With Query Params**\n *\n * ```ts\n * import { query } from '@warp-drive/utilities/json-api';\n *\n * const options = query('person', { include: ['pets', 'friends'] });\n * const data = await store.request(options);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { query } from '@warp-drive/utilities/json-api';\n *\n * const options = query('person', { include: ['pets', 'friends'] }, { reload: true });\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @badge Builder\n */\nexport function query<\n  T extends TypedRecordInstance,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n>(\n  type: TypeFromInstance<T>,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): QueryRequestOptions<ReactiveDataDocument<T[], M, E>>;\nexport function query(\n  type: string,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): QueryRequestOptions;\nexport function query(\n  type: string,\n  // oxlint-disable-next-line no-shadow\n  query: QueryParamsSource = {},\n  options: ConstrainedRequestOptions = {}\n): QueryRequestOptions {\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: QueryUrlOptions = {\n    identifier: { type },\n    op: 'query',\n    resourcePath: pluralize(type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n  const queryString = buildQueryParams(query, options.urlParamsSettings);\n\n  return {\n    url: queryString ? `${url}?${queryString}` : url,\n    method: 'GET',\n    headers,\n    cacheOptions,\n    op: 'query',\n  };\n}\n\n/**\n * Builds request options to query for resources, usually by a primary\n * type, configured for the url and header expectations of most JSON:API APIs.\n *\n * The key difference between this and `query` is that this method will send the query\n * as the JSON body of a \"POST\" request instead of as query params in the url of a \"GET\"\n * request.\n *\n * A CacheKey is generated from the url and query params, and used to cache the response\n * in the store.\n *\n * ```ts\n * import { postQuery } from '@warp-drive/utilities/json-api';\n *\n * const options = postQuery('person', { include: ['pets', 'friends'] });\n * const data = await store.request(options);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { postQuery } from '@warp-drive/utilities/json-api';\n *\n * const options = postQuery('person', { include: ['pets', 'friends'] }, { reload: true });\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param type - the name of the resource type to query\n * @param query - the query params to send with the request\n * @param options - options to modify the request behavior\n */\nexport function postQuery<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  type: TypeFromInstance<T>,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): PostQueryRequestOptions<ReactiveDataDocument<T[], M, E>>;\nexport function postQuery(\n  type: string,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): PostQueryRequestOptions;\nexport function postQuery(\n  type: string,\n  // oxlint-disable-next-line no-shadow\n  query: QueryParamsSource = {},\n  options: ConstrainedRequestOptions = {}\n): PostQueryRequestOptions {\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: QueryUrlOptions = {\n    identifier: { type },\n    op: 'query',\n    resourcePath: options.resourcePath ?? pluralize(type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  const queryData = structuredClone(query);\n  cacheOptions.key = cacheOptions.key ?? `${url}?${buildQueryParams(queryData, options.urlParamsSettings)}`;\n\n  return {\n    url,\n    method: 'POST',\n    body: JSON.stringify(query),\n    headers,\n    cacheOptions: cacheOptions as CacheOptions & { key: string },\n    op: 'query',\n  };\n}\n","import { recordIdentifierFor } from '@warp-drive/core';\nimport { assert } from '@warp-drive/core/build-config/macros';\nimport type { ReactiveDataDocument } from '@warp-drive/core/reactive';\nimport type { PersistedResourceKey, ResourceKey } from '@warp-drive/core/types/identifier';\nimport type { TypedRecordInstance } from '@warp-drive/core/types/record';\nimport type {\n  ConstrainedRequestOptions,\n  CreateRequestOptions,\n  DeleteRequestOptions,\n  UpdateRequestOptions,\n} from '@warp-drive/core/types/request';\nimport type { ApiError } from '@warp-drive/core/types/spec/error';\nimport type { Meta } from '@warp-drive/core/types/spec/json-api-raw';\n\nimport {\n  buildBaseURL,\n  type CreateRecordUrlOptions,\n  type DeleteRecordUrlOptions,\n  type UpdateRecordUrlOptions,\n} from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n\nfunction isExisting(identifier: ResourceKey): identifier is PersistedResourceKey {\n  return 'id' in identifier && identifier.id !== null && 'type' in identifier && identifier.type !== null;\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to delete record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { deleteRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n *\n * // mark record as deleted\n * store.deleteRecord(person);\n *\n * // persist deletion\n * const data = await store.request(deleteRecord(person));\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { deleteRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n *\n * // mark record as deleted\n * store.deleteRecord(person);\n *\n * // persist deletion\n * const options = deleteRecord(person, { namespace: 'api/v1' });\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param record\n * @param options\n */\nexport function deleteRecord<T>(record: T, options?: ConstrainedRequestOptions): DeleteRequestOptions<T>;\nexport function deleteRecord(record: unknown, options?: ConstrainedRequestOptions): DeleteRequestOptions;\nexport function deleteRecord(record: unknown, options: ConstrainedRequestOptions = {}): DeleteRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n  assert(`Cannot delete a record that does not have an associated type and id.`, isExisting(identifier));\n\n  const urlOptions: DeleteRecordUrlOptions = {\n    identifier: identifier,\n    op: 'deleteRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: 'DELETE',\n    headers,\n    op: 'deleteRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Necessary Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to create new record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { cacheKeyFor } from '@warp-drive/core';\n * import { createRecord } from '@warp-drive/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const person = store.createRecord<Person>('person', { name: 'Ted' });\n * const init = createRecord(person);\n * init.body = JSON.stringify(\n *  {\n *    // it's likely you will want to transform this data\n *    // somewhat\n *    data: store.cache.peek(cacheKeyFor(person))\n *  }\n * );\n * const data = await store.request(init);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { createRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.createRecord('person', { name: 'Ted' });\n * const options = createRecord(person, { namespace: 'api/v1' });\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param record\n * @param options\n */\nexport function createRecord<T>(record: T, options?: ConstrainedRequestOptions): CreateRequestOptions<T>;\nexport function createRecord(record: unknown, options?: ConstrainedRequestOptions): CreateRequestOptions;\nexport function createRecord(record: unknown, options: ConstrainedRequestOptions = {}): CreateRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n\n  const urlOptions: CreateRecordUrlOptions = {\n    identifier: identifier,\n    op: 'createRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: 'POST',\n    headers,\n    op: 'createRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Necessary Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to update existing record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * **Example Usage**\n *\n * ```ts\n * import { cacheKeyFor } from '@warp-drive/core';\n * import { updateRecord } from '@warp-drive/utilities/json-api';\n * import type { EditablePerson } from '#/data/types';\n *\n * const mutable = await checkout<EditablePerson>(person);\n * mutable.name = 'Chris';\n * const init = updateRecord(mutable);\n *\n * init.body = JSON.stringify(\n *  // it's likely you will want to transform this data\n *  // somewhat, or serialize only specific properties instead\n *  serializePatch(store.cache, cacheKeyFor(mutable))\n * );\n * const data = await store.request(init);\n * ```\n *\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `patch` - Allows caller to specify whether to use a PATCH request instead of a PUT request, defaults to `false`.\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { updateRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const options = updateRecord(person, { patch: true });\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param record\n * @param options\n */\nexport function updateRecord<\n  T extends TypedRecordInstance,\n  RT extends TypedRecordInstance = T,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n>(\n  record: T,\n  options?: ConstrainedRequestOptions & { patch?: boolean }\n): UpdateRequestOptions<ReactiveDataDocument<RT, M, E>, T>;\nexport function updateRecord(\n  record: unknown,\n  options?: ConstrainedRequestOptions & { patch?: boolean }\n): UpdateRequestOptions;\nexport function updateRecord(\n  record: unknown,\n  options: ConstrainedRequestOptions & { patch?: boolean } = {}\n): UpdateRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n  assert(`Cannot update a record that does not have an associated type and id.`, isExisting(identifier));\n\n  const urlOptions: UpdateRecordUrlOptions = {\n    identifier: identifier,\n    op: 'updateRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: options.patch ? 'PATCH' : 'PUT',\n    headers,\n    op: 'updateRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * Builds request options to update existing record for resources,\n * configured for the url and header expectations of most JSON:API APIs\n * for a PATCH request.\n *\n * Note: This is a convenience method that calls `updateRecord` with the\n * supplied request with the `patch` option set to `true`.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { patchRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const data = await store.request(patchRecord(person));\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { patchRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const options = patchRecord(person);\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param record\n * @param options\n */\nexport function patchRecord<T>(record: T, options?: ConstrainedRequestOptions): UpdateRequestOptions<T>;\nexport function patchRecord(record: unknown, options?: ConstrainedRequestOptions): UpdateRequestOptions;\nexport function patchRecord(record: unknown, options: ConstrainedRequestOptions = {}): UpdateRequestOptions {\n  const opts = options as ConstrainedRequestOptions & { patch: true };\n  opts.patch = true;\n  return updateRecord(record, opts);\n}\n","import { assert } from '@warp-drive/core/build-config/macros';\nimport type { Cache } from '@warp-drive/core/types/cache';\nimport type { Relationship } from '@warp-drive/core/types/cache/relationship';\nimport type { ResourceKey } from '@warp-drive/core/types/identifier';\nimport type { Value } from '@warp-drive/core/types/json/raw';\nimport type { InnerRelationshipDocument, ResourceObject } from '@warp-drive/core/types/spec/json-api-raw';\n\ntype ChangedRelationshipData = InnerRelationshipDocument;\n\nexport type JsonApiResourcePatch =\n  | {\n      type: string;\n      id: string;\n      attributes?: Record<string, Value>;\n      relationships?: Record<string, ChangedRelationshipData>;\n    }\n  | {\n      type: string;\n      id: null;\n      lid: string;\n      attributes?: Record<string, Value>;\n      relationships?: Record<string, ChangedRelationshipData>;\n    };\n\n/**\n * :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**\n *\n * While this may come as a surprise, they are intended to serialize cache state for more\n * generalized usage. {json:api} has a large variance in acceptable shapes, and only your\n * app can ensure that the body is correctly formatted and contains all necessary data.\n * :::\n *\n * Serializes the current state of a resource or array of resources for use with POST or PUT requests.\n *\n * @public\n * @param cache - the cache to serialize the resource(s) from\n * @param identifiers - the resource(s) to serialize\n * @return an object with a `data` property containing the serialized resource(s)\n */\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey\n): {\n  /**\n   * The serialized resource.\n   */\n  data: ResourceObject;\n};\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey[]\n): {\n  /**\n   * The serialized resources.\n   */\n  data: ResourceObject[];\n};\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey | ResourceKey[]\n): { data: ResourceObject | ResourceObject[] } {\n  return {\n    data: Array.isArray(identifiers)\n      ? identifiers.map((identifier) => _serializeResource(cache, identifier))\n      : _serializeResource(cache, identifiers),\n  };\n}\n\ntype SerializedRef =\n  | {\n      id: string;\n      type: string;\n    }\n  | { id: null; lid: string; type: string };\n\nfunction fixRef({\n  id,\n  lid,\n  type,\n}: { id: string; lid?: string; type: string } | { id: null; lid: string; type: string }): SerializedRef {\n  if (id !== null) {\n    return { id, type };\n  }\n  return { id, lid, type };\n}\n\nfunction fixRelData(\n  rel: Relationship['data'] | InnerRelationshipDocument['data']\n): SerializedRef | SerializedRef[] | null {\n  if (Array.isArray(rel)) {\n    return rel.map((ref) => fixRef(ref));\n  } else if (typeof rel === 'object' && rel !== null) {\n    return fixRef(rel);\n  }\n  return null;\n}\n\nfunction _serializeResource(cache: Cache, identifier: ResourceKey): ResourceObject {\n  const { id, lid, type } = identifier;\n  // peek gives us everything we want, but since its referentially the same data\n  // as is in the cache we clone it to avoid any accidental mutations\n  const record = structuredClone(cache.peek(identifier)) as ResourceObject;\n  assert(\n    `A record with id ${String(id)} and type ${type} for lid ${lid} was not found not in the supplied Cache.`,\n    record\n  );\n\n  // remove lid from anything that has an ID and slice any relationship arrays\n  if (record.id !== null) {\n    delete record.lid;\n  }\n\n  if (record.relationships) {\n    for (const key of Object.keys(record.relationships)) {\n      const relationship = record.relationships[key];\n      if (Array.isArray(relationship.data)) {\n        relationship.data = relationship.data.map((ref) => fixRef(ref));\n      } else if (typeof relationship.data === 'object' && relationship.data !== null) {\n        relationship.data = fixRef(relationship.data);\n      } else if (Object.keys(relationship ?? {}).length === 0) {\n        delete record.relationships[key];\n      }\n    }\n  }\n\n  return record;\n}\n\n/**\n * :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**\n *\n * While this may come as a surprise, they are intended to serialize cache state for more\n * generalized usage. {json:api} has a large variance in acceptable shapes, and only your\n * app can ensure that the body is correctly formatted and contains all necessary data.\n * :::\n *\n * Serializes changes to a resource. Useful for use with building bodies for PATCH requests.\n *\n * Only attributes which are changed are serialized.\n * Only relationships which are changed are serialized.\n *\n * Collection relationships serialize the collection as a whole.\n *\n * If you would like to serialize updates to a collection more granularly\n * (for instance, as operations) request the diff from the store and\n * serialize as desired:\n *\n * ```ts\n * const relationshipDiffMap = cache.changedRelationships(identifier);\n * ```\n *\n * @public\n * @param cache - the cache to serialize the resource's changes from\n * @param identifier - the resource whose changes should be serialized\n * @return an object with a `data` property containing the serialized resource patch\n */\nexport function serializePatch(\n  cache: Cache,\n  identifier: ResourceKey\n  // options: { include?: string[] } = {}\n): {\n  /**\n   * The serialized resource patch.\n   */\n  data: JsonApiResourcePatch;\n} {\n  const { id, lid, type } = identifier;\n  assert(\n    `A record with id ${String(id)} and type ${type} for lid ${lid} was not found not in the supplied Cache.`,\n    cache.peek(identifier)\n  );\n\n  const data: JsonApiResourcePatch =\n    id === null\n      ? { type, lid, id }\n      : {\n          type,\n          id,\n        };\n\n  if (cache.hasChangedAttrs(identifier)) {\n    const attrsChanges = cache.changedAttrs(identifier);\n    const attributes: ResourceObject['attributes'] = {};\n\n    Object.keys(attrsChanges).forEach((key) => {\n      const change = attrsChanges[key];\n      const newVal = change[1];\n      attributes[key] = newVal === undefined ? null : structuredClone(newVal);\n    });\n\n    data.attributes = attributes;\n  }\n\n  const changedRelationships = cache.changedRelationships(identifier);\n  if (changedRelationships.size) {\n    const relationships: Record<string, ChangedRelationshipData> = {};\n    changedRelationships.forEach((diff, key) => {\n      relationships[key] = { data: fixRelData(diff.localState) } as ChangedRelationshipData;\n    });\n\n    data.relationships = relationships;\n  }\n\n  return { data };\n}\n"],"mappings":";;;;;;AAgBA,MAAM,gBAAgB;AACtB,MAAM,iBAAgC;CAAE,MAAM;CAAI,WAAW;AAAG;AAChE,IAAW,SAAwB;AACnC,IAAW,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCjC,SAAgB,kBAAkB,QAA6B;CAC7D,SAAS,OAAO,OAAO,CAAC,GAAG,gBAAgB,MAAM;CAEjD,IAAI,OAAO,YAAY,OAAO,YAAY;EACxC,IAAI,SAAS;EACb,IAAI,OAAO,UAAU;GACnB,MAAM,WAAW,OAAO,OAAO,OAAO,QAAQ;GAC9C,IAAI,SAAS,QACX,UAAU,gBAAe,SAAS,KAAK,GAAG,IAAI;EAElD;EACA,IAAI,OAAO,YAAY;GACrB,MAAM,aAAa,OAAO,OAAO,OAAO,UAAU;GAClD,IAAI,WAAW,QACb,UAAU,UAAU,WAAW,KAAK,GAAG;EAE3C;EACA,sBAAsB;CACxB;CAEA,oBAAU,MAAM;AAClB;;;;ACuBA,SAAgB,WACd,MACA,MACA,MAC0B;CAC1B,MAAM,aAA2C,OAAO,SAAS,WAAW;EAAE,MAAM;EAAM,IAAI;CAAe,IAAI;CACjH,MAAM,WAAY,OAAO,SAAS,WAAW,OAAO,SAAS,CAAC;CAC9D,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAAmC;EACvC;EACA,IAAI;EACJ,cAAc,UAAU,WAAW,IAAI;CACzC;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAE5C,OAAO;EACL,KAAK,QAAQ,SAAS,SAClB,GAAG,IAAI,GAAG,iBAAiB,EAAE,SAAS,QAAQ,QAAQ,GAAG,QAAQ,iBAAiB,MAClF;EACJ,QAAQ;EACR;EACA;EACA,IAAI;EACJ,SAAS,CAAC,UAAU;CACtB;AACF;;;;ACvDA,SAAgB,MACd,MAEA,QAA2B,CAAC,GAC5B,UAAqC,CAAC,GACjB;CACrB,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAA8B;EAClC,YAAY,EAAE,KAAK;EACnB,IAAI;EACJ,cAAc,UAAU,IAAI;CAC9B;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAC5C,MAAM,cAAc,iBAAiB,OAAO,QAAQ,iBAAiB;CAErE,OAAO;EACL,KAAK,cAAc,GAAG,IAAI,GAAG,gBAAgB;EAC7C,QAAQ;EACR;EACA;EACA,IAAI;CACN;AACF;AAwDA,SAAgB,UACd,MAEA,QAA2B,CAAC,GAC5B,UAAqC,CAAC,GACb;CACzB,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAA8B;EAClC,YAAY,EAAE,KAAK;EACnB,IAAI;EACJ,cAAc,QAAQ,gBAAgB,UAAU,IAAI;CACtD;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAE5C,MAAM,YAAY,gBAAgB,KAAK;CACvC,aAAa,MAAM,aAAa,OAAO,GAAG,IAAI,GAAG,iBAAiB,WAAW,QAAQ,iBAAiB;CAEtG,OAAO;EACL;EACA,QAAQ;EACR,MAAM,KAAK,UAAU,KAAK;EAC1B;EACc;EACd,IAAI;CACN;AACF;;;;ACxKA,SAASK,WAAWC,YAA6D;CAC/E,OAAO,QAAQA,cAAcA,WAAWC,OAAO,QAAQ,UAAUD,cAAcA,WAAWE,SAAS;AACrG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgBC,aAAaC,QAAiBC,UAAqC,CAAC,GAAyB;CAC3G,MAAML,aAAaN,oBAAoBU,MAAM;CAC7C,EAAAE,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEP,UAAU;CAC3D,EAAAM,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,sEAAsE;CAAA,EAAA,CAAER,WAAWC,UAAU,CAAC;CAErG,MAAMQ,aAAqC;EAC7BR;EACZS,IAAI;EACJC,cAAcd,UAAUI,WAAWE,IAAI;CACzC;CAEAL,sBAAsBW,YAAYH,OAAO;CAEzC,MAAMM,MAAMhB,aAAaa,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUhB,mBAAmB;CAE5C,OAAO;EACLa;EACAI,QAAQ;EACRH;EACAH,IAAI;EACJO,MAAM,EACJZ,QAAQJ,WACV;EACAiB,SAAS,CAACjB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgBkB,aAAad,QAAiBC,UAAqC,CAAC,GAAyB;CAC3G,MAAML,aAAaN,oBAAoBU,MAAM;CAC7C,EAAAE,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEP,UAAU;CAE3D,MAAMQ,aAAqC;EAC7BR;EACZS,IAAI;EACJC,cAAcd,UAAUI,WAAWE,IAAI;CACzC;CAEAL,sBAAsBW,YAAYH,OAAO;CAEzC,MAAMM,MAAMhB,aAAaa,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUhB,mBAAmB;CAE5C,OAAO;EACLa;EACAI,QAAQ;EACRH;EACAH,IAAI;EACJO,MAAM,EACJZ,QAAQJ,WACV;EACAiB,SAAS,CAACjB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwEA,SAAgBmB,aACdf,QACAC,UAA2D,CAAC,GACtC;CACtB,MAAML,aAAaN,oBAAoBU,MAAM;CAC7C,EAAAE,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEP,UAAU;CAC3D,EAAAM,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,sEAAsE;CAAA,EAAA,CAAER,WAAWC,UAAU,CAAC;CAErG,MAAMQ,aAAqC;EAC7BR;EACZS,IAAI;EACJC,cAAcd,UAAUI,WAAWE,IAAI;CACzC;CAEAL,sBAAsBW,YAAYH,OAAO;CAEzC,MAAMM,MAAMhB,aAAaa,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUhB,mBAAmB;CAE5C,OAAO;EACLa;EACAI,QAAQV,QAAQe,QAAQ,UAAU;EAClCR;EACAH,IAAI;EACJO,MAAM,EACJZ,QAAQJ,WACV;EACAiB,SAAS,CAACjB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;AChPA,SAAgBuB,mBACdC,OACAC,aAC6C;CAC7C,OAAO,EACLC,MAAMC,MAAMC,QAAQH,WAAW,IAC3BA,YAAYI,KAAKC,eAAeC,mBAAmBP,OAAOM,UAAU,CAAC,IACrEC,mBAAmBP,OAAOC,WAAW,EAC3C;AACF;AASA,SAASO,OAAO,EACdC,IACAC,KACAC,QACsG;CACtG,IAAIF,OAAO,MACT,OAAO;EAAEA;EAAIE;CAAK;CAEpB,OAAO;EAAEF;EAAIC;EAAKC;CAAK;AACzB;AAEA,SAASC,WACPC,KACwC;CACxC,IAAIV,MAAMC,QAAQS,GAAG,GACnB,OAAOA,IAAIR,KAAKS,QAAQN,OAAOM,GAAG,CAAC;MAC9B,IAAI,OAAOD,QAAQ,YAAYA,QAAQ,MAC5C,OAAOL,OAAOK,GAAG;CAEnB,OAAO;AACT;AAEA,SAASN,mBAAmBP,OAAcM,YAAyC;CACjF,MAAM,EAAEG,IAAIC,KAAKC,SAASL;CAG1B,MAAMS,SAASC,gBAAgBhB,MAAMiB,KAAKX,UAAU,CAAC;CACrD,EAAAY,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,oBAAoBC,OAAOX,EAAE,EAAC,YAAaE,KAAI,WAAYD,IAAG,0CAA2C;CAAA,EAAA,CACzGK,MAAM;CAIR,IAAIA,OAAON,OAAO,MAChB,OAAOM,OAAOL;CAGhB,IAAIK,OAAOM,eACT,KAAK,MAAMC,OAAOC,OAAOC,KAAKT,OAAOM,aAAa,GAAG;EACnD,MAAMI,eAAeV,OAAOM,cAAcC;EAC1C,IAAInB,MAAMC,QAAQqB,aAAavB,IAAI,GACjCuB,aAAavB,OAAOuB,aAAavB,KAAKG,KAAKS,QAAQN,OAAOM,GAAG,CAAC;OACzD,IAAI,OAAOW,aAAavB,SAAS,YAAYuB,aAAavB,SAAS,MACxEuB,aAAavB,OAAOM,OAAOiB,aAAavB,IAAI;OACvC,IAAIqB,OAAOC,KAAKC,gBAAgB,CAAC,CAAC,CAAC,CAACC,WAAW,GACpD,OAAOX,OAAOM,cAAcC;CAEhC;CAGF,OAAOP;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,SAAgBY,eACd3B,OACAM,YAOA;CACA,MAAM,EAAEG,IAAIC,KAAKC,SAASL;CAC1B,EAAAY,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,oBAAoBC,OAAOX,EAAE,EAAC,YAAaE,KAAI,WAAYD,IAAG,0CAA2C;CAAA,EAAA,CACzGV,MAAMiB,KAAKX,UAAU,CAAC;CAGxB,MAAMJ,OACJO,OAAO,OACH;EAAEE;EAAMD;EAAKD;CAAG,IAChB;EACEE;EACAF;CACF;CAEN,IAAIT,MAAM4B,gBAAgBtB,UAAU,GAAG;EACrC,MAAMuB,eAAe7B,MAAM8B,aAAaxB,UAAU;EAClD,MAAMyB,aAA2C,CAAC;EAElDR,OAAOC,KAAKK,YAAY,CAAC,CAACG,SAASV,QAAQ;GAEzC,MAAMY,SADSL,aAAaP,IACP,CAAC;GACtBS,WAAWT,OAAOY,WAAWC,SAAY,OAAOnB,gBAAgBkB,MAAM;EACxE,CAAC;EAEDhC,KAAK6B,aAAaA;CACpB;CAEA,MAAMK,uBAAuBpC,MAAMoC,qBAAqB9B,UAAU;CAClE,IAAI8B,qBAAqBC,MAAM;EAC7B,MAAMhB,gBAAyD,CAAC;EAChEe,qBAAqBJ,SAASM,MAAMhB,QAAQ;GAC1CD,cAAcC,OAAO,EAAEpB,MAAMU,WAAW0B,KAAKC,UAAU,EAAE;EAC3D,CAAC;EAEDrC,KAAKmB,gBAAgBA;CACvB;CAEA,OAAO,EAAEnB,KAAK;AAChB"}
+{"version":3,"file":"json-api.js","names":["recordIdentifierFor","buildBaseURL","pluralize","copyForwardUrlOptions","ACCEPT_HEADER_VALUE","isExisting","identifier","id","type","deleteRecord","record","options","test","Error","urlOptions","op","resourcePath","url","headers","Headers","append","method","data","records","createRecord","updateRecord","patch","patchRecord","opts","serializeResources","cache","identifiers","data","Array","isArray","map","identifier","_serializeResource","fixRef","id","lid","type","fixRelData","rel","ref","record","structuredClone","peek","test","Error","String","relationships","key","Object","keys","relationship","length","serializePatch","hasChangedAttrs","attrsChanges","changedAttrs","attributes","forEach","change","newVal","undefined","changedRelationships","size","diff","localState"],"sources":["../../../src/-private/json-api/-utils.ts","../../../src/-private/json-api/find-record.ts","../../../src/-private/json-api/query.ts","../../../src/-private/json-api/save-record.ts","../../../src/-private/json-api/serialize.ts"],"sourcesContent":["import type { QueryParamsSource } from '@warp-drive/core/types/params';\n\nimport type { BuildURLConfig } from '../../index.ts';\nimport { buildQueryParams as buildParams, setBuildURLConfig as setConfig } from '../../index.ts';\n\nexport interface JSONAPIConfig extends BuildURLConfig {\n  profiles?: {\n    pagination?: string;\n    [key: string]: string | undefined;\n  };\n  extensions?: {\n    atomic?: string;\n    [key: string]: string | undefined;\n  };\n}\n\nconst JsonApiAccept = 'application/vnd.api+json';\nconst DEFAULT_CONFIG: JSONAPIConfig = { host: '', namespace: '' };\nexport let CONFIG: JSONAPIConfig = DEFAULT_CONFIG;\nexport let ACCEPT_HEADER_VALUE = 'application/vnd.api+json';\n\n/**\n * Allows setting extensions and profiles to be used in the `Accept` header.\n *\n * Extensions and profiles are keyed by their namespace with the value being\n * their URI.\n *\n * The [Basic Usage](/guides/the-manual/cookbook/basic-usage#step-2-configure-some-request-defaults)\n * guide uses it to configure a host, a namespace and a pagination profile.\n *\n * Example:\n *\n * ```ts\n * setBuildURLConfig({\n *   extensions: {\n *     atomic: 'https://jsonapi.org/ext/atomic'\n *   },\n *   profiles: {\n *     pagination: 'https://jsonapi.org/profiles/ethanresnick/cursor-pagination'\n *   }\n * });\n * ```\n *\n * This also sets the global configuration for `buildBaseURL`\n * for host and namespace values for the global coniguration\n * done via `import { setBuildURLConfig } from '@warp-drive/utilities';`\n *\n * These values may still be overridden by passing\n * them to buildBaseURL directly.\n *\n * This method may be called as many times as needed\n *\n * ```ts\n * type BuildURLConfig = {\n *   host: string;\n *   namespace: string'\n * }\n * ```\n *\n * @summary Sets the JSON:API extensions and profiles sent in the `Accept` header, plus the global URL host and\n * namespace.\n * @public\n * @param {BuildURLConfig} config\n * @return {void}\n */\nexport function setBuildURLConfig(config: JSONAPIConfig): void {\n  CONFIG = Object.assign({}, DEFAULT_CONFIG, config);\n\n  if (config.profiles || config.extensions) {\n    let accept = JsonApiAccept;\n    if (config.profiles) {\n      const profiles = Object.values(config.profiles);\n      if (profiles.length) {\n        accept += ';profile=\"' + profiles.join(' ') + '\"';\n      }\n    }\n    if (config.extensions) {\n      const extensions = Object.values(config.extensions);\n      if (extensions.length) {\n        accept += ';ext=' + extensions.join(' ');\n      }\n    }\n    ACCEPT_HEADER_VALUE = accept;\n  }\n\n  setConfig(config);\n}\n\ninterface RelatedObject {\n  [key: string]: string | string[] | RelatedObject;\n}\n\nexport type JsonApiQuery = {\n  include?: string | string[] | RelatedObject;\n  fields?: Record<string, string | string[]>;\n  page?: {\n    size?: number;\n    after?: string;\n    before?: string;\n  };\n};\n\nfunction isJsonApiQuery(query: JsonApiQuery | QueryParamsSource): query is JsonApiQuery {\n  if ('include' in query && query.include && typeof query.include === 'object') {\n    return true;\n  }\n  if ('fields' in query || 'page' in query) {\n    return true;\n  }\n  return false;\n}\n\nfunction collapseIncludePaths(basePath: string, include: RelatedObject, paths: string[]) {\n  const keys = Object.keys(include);\n  for (let i = 0; i < keys.length; i++) {\n    // the key is always included too\n    paths.push(`${basePath}.${keys[i]}`);\n    const key = keys[i];\n    const value = include[key];\n\n    // include: { 'company': 'field1,field2' }\n    if (typeof value === 'string') {\n      value.split(',').forEach((field) => {\n        paths.push(`${basePath}.${key}.${field}`);\n      });\n\n      // include: { 'company': ['field1', 'field2'] }\n    } else if (Array.isArray(value)) {\n      value.forEach((field) => {\n        paths.push(`${basePath}.${key}.${field}`);\n      });\n\n      // include: { 'company': { 'nested': 'field1,field2' } }\n    } else {\n      collapseIncludePaths(`${basePath}.${key}`, value, paths);\n    }\n  }\n}\n\n/**\n * Sorts query params by both key and value, returning a query params string\n *\n * Treats `included` specially, splicing it into an array if it is a string and sorting the array.\n *   - If `included` is an object we build paths dynamically for you\n * Treats `fields` specially, building JSON:API partial fields params from an object\n * Treats `page` specially, building cursor-pagination profile page params from an object\n *\n * ```ts\n * const params = buildQueryParams({\n *  include: {\n *    company: {\n *      locations: 'address'\n *    }\n *  },\n *   fields: {\n *     company: ['name', 'ticker'],\n *     person: 'name'\n *   },\n *   page: {\n *     size: 10,\n *     after: 'abc',\n *   }\n * });\n *\n * // => 'fields[company]=name,ticker&fields[person]=name&include=company.locations,company.locations.address&page[after]=abc&page[size]=10'\n * ```\n *\n * Options:\n * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'\n *\n * 'bracket': appends [] to the key for every value e.g. `ids[]=1&ids[]=2`\n * 'indices': appends [i] to the key for every value e.g. `ids[0]=1&ids[1]=2`\n * 'repeat': appends the key for every value e.g. `ids=1&ids=2`\n * 'comma' (default): appends the key once with a comma separated list of values e.g. `ids=1,2`\n *\n * @public\n * @param {URLSearchParams | Object} params\n * @param {Object} [options]\n * @return {String} A sorted query params string without the leading `?`\n */\nexport function buildQueryParams(query: JsonApiQuery | QueryParamsSource): string {\n  if (query instanceof URLSearchParams) {\n    return buildParams(query);\n  }\n\n  if (!isJsonApiQuery(query)) {\n    return buildParams(query);\n  }\n\n  const { include, fields, page, ...rest } = query;\n  const finalQuery: QueryParamsSource = {\n    ...rest,\n  };\n\n  if ('include' in query) {\n    // include: { 'company': 'field1,field2' }\n    // include: { 'company': ['field1', 'field2'] }\n    // include: { 'company': { 'nested': 'field1,field2' } }\n    // include: { 'company': { 'nested': ['field1', 'field2'] } }\n    if (include && !Array.isArray(include) && typeof include === 'object') {\n      const includePaths: string[] = [];\n      collapseIncludePaths('', include, includePaths);\n      finalQuery.include = includePaths.sort();\n\n      // include: 'field1,field2'\n      // include: ['field1', 'field2']\n    } else {\n      finalQuery.include = include;\n    }\n  }\n\n  if (fields) {\n    const keys = Object.keys(fields).sort();\n    for (let i = 0; i < keys.length; i++) {\n      const resourceType = keys[i];\n      const value = fields[resourceType];\n\n      // fields: { 'company': ['field1', 'field2'] }\n      if (Array.isArray(value)) {\n        // toSorted: `value` belongs to the caller, sorting it in place would\n        // reorder whatever else they are doing with it\n        finalQuery[`fields[${resourceType}]`] = value.toSorted().join(',');\n\n        // fields: { 'company': 'field1' }\n        // fields: { 'company': 'field1,field2' }\n      } else {\n        finalQuery[`fields[${resourceType}]`] = value.split(',').sort().join(',');\n      }\n    }\n  }\n\n  if (page) {\n    const keys = Object.keys(page).sort() as Array<'size' | 'after' | 'before'>;\n    keys.forEach((key) => {\n      const value = page[key];\n      finalQuery[`page[${key}]`] = value!;\n    });\n  }\n\n  return buildParams(finalQuery);\n}\n","import type { ReactiveDataDocument } from '@warp-drive/core/reactive';\nimport type { TypeFromInstance } from '@warp-drive/core/types/record';\nimport type {\n  FindRecordOptions,\n  FindRecordRequestOptions,\n  RemotelyAccessibleIdentifier,\n} from '@warp-drive/core/types/request';\nimport type { ApiError } from '@warp-drive/core/types/spec/error';\nimport type { Meta } from '@warp-drive/core/types/spec/json-api-raw';\n\nimport { buildBaseURL, buildQueryParams, type FindRecordUrlOptions } from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions, extractCacheOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n\n/**\n * Builds request options to fetch a single resource by a known id or identifier\n * configured for the url and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * :::tabs\n *\n * == Basic Usage\n *\n * ```ts\n * import { findRecord } from '@warp-drive/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const result = await store.request(\n *   findRecord<Person>('person', '1')\n * );\n * ```\n *\n * == With Options\n *\n * ```ts\n * import { findRecord } from '@warp-drive/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const data = await store.request(\n *   findRecord<Person>(\n *     'person', '1',\n *     { include: ['pets', 'friends'] }\n *   )\n * );\n * ```\n *\n * == With an Identifier\n *\n * ```ts\n * import { findRecord } from '@warp-drive/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const data = await store.request(\n *   findRecord<Person>(\n *     { type: 'person', id: '1' },\n *     { include: ['pets', 'friends'] }\n *   )\n * );\n * ```\n *\n * :::\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { findRecord } from '@warp-drive/utilities/json-api';\n *\n * const data = await store.request(\n *   findRecord(\n *     'person', '1',\n *     { include: ['pets', 'friends'] },\n *     { namespace: 'api/v2' }\n *   )\n * );\n * ```\n *\n * @summary Builds a JSON:API `GET` request for one resource by type and id, with optional `include`.\n * @public\n */\nexport function findRecord<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>,\n  options?: FindRecordOptions\n): FindRecordRequestOptions<ReactiveDataDocument<T, M, E>, T>;\nexport function findRecord(\n  identifier: RemotelyAccessibleIdentifier,\n  options?: FindRecordOptions\n): FindRecordRequestOptions;\nexport function findRecord<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  type: TypeFromInstance<T>,\n  id: string,\n  options?: FindRecordOptions\n): FindRecordRequestOptions<ReactiveDataDocument<T, M, E>, T>;\nexport function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;\nexport function findRecord(\n  arg1: string | RemotelyAccessibleIdentifier,\n  arg2: string | FindRecordOptions | undefined,\n  arg3?: FindRecordOptions\n): FindRecordRequestOptions {\n  const identifier: RemotelyAccessibleIdentifier = typeof arg1 === 'string' ? { type: arg1, id: arg2 as string } : arg1;\n  const options = ((typeof arg1 === 'string' ? arg3 : arg2) || {}) as FindRecordOptions;\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: FindRecordUrlOptions = {\n    identifier,\n    op: 'findRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url: options.include?.length\n      ? `${url}?${buildQueryParams({ include: options.include }, options.urlParamsSettings)}`\n      : url,\n    method: 'GET',\n    headers,\n    cacheOptions,\n    op: 'findRecord',\n    records: [identifier],\n  };\n}\n\n/** @deprecated use {@link ReactiveDataDocument} */\nexport type FindRecordResultDocument<\n  T,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n> = ReactiveDataDocument<T, M, E>;\n","import type { ReactiveDataDocument } from '@warp-drive/core/reactive';\nimport type { QueryParamsSource } from '@warp-drive/core/types/params';\nimport type { TypedRecordInstance, TypeFromInstance } from '@warp-drive/core/types/record';\nimport type {\n  CacheOptions,\n  ConstrainedRequestOptions,\n  PostQueryRequestOptions,\n  QueryRequestOptions,\n} from '@warp-drive/core/types/request';\nimport type { ApiError } from '@warp-drive/core/types/spec/error';\nimport type { Meta } from '@warp-drive/core/types/spec/json-api-raw';\n\nimport { buildBaseURL, buildQueryParams, type QueryUrlOptions } from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions, extractCacheOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n/**\n * Builds request options to query for resources, usually by a primary\n * type, configured for the url and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * The key difference between this and `postQuery` is that this method will send the query\n * as query params in the url of a \"GET\" request instead of as the JSON body of a \"POST\"\n * request.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { query } from '@warp-drive/utilities/json-api';\n *\n * const data = await store.request(query('person'));\n * ```\n *\n * **With Query Params**\n *\n * ```ts\n * import { query } from '@warp-drive/utilities/json-api';\n *\n * const options = query('person', { include: ['pets', 'friends'] });\n * const data = await store.request(options);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { query } from '@warp-drive/utilities/json-api';\n *\n * const options = query('person', { include: ['pets', 'friends'] }, { reload: true });\n * const data = await store.request(options);\n * ```\n *\n * @summary Builds a JSON:API `GET` request that queries a resource type, sending the query as URL query params.\n * @public\n * @badge Builder\n */\nexport function query<\n  T extends TypedRecordInstance,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n>(\n  type: TypeFromInstance<T>,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): QueryRequestOptions<ReactiveDataDocument<T[], M, E>>;\nexport function query(\n  type: string,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): QueryRequestOptions;\nexport function query(\n  type: string,\n  // oxlint-disable-next-line no-shadow\n  query: QueryParamsSource = {},\n  options: ConstrainedRequestOptions = {}\n): QueryRequestOptions {\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: QueryUrlOptions = {\n    identifier: { type },\n    op: 'query',\n    resourcePath: pluralize(type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n  const queryString = buildQueryParams(query, options.urlParamsSettings);\n\n  return {\n    url: queryString ? `${url}?${queryString}` : url,\n    method: 'GET',\n    headers,\n    cacheOptions,\n    op: 'query',\n  };\n}\n\n/**\n * Builds request options to query for resources, usually by a primary\n * type, configured for the url and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * The key difference between this and `query` is that this method will send the query\n * as the JSON body of a \"POST\" request instead of as query params in the url of a \"GET\"\n * request.\n *\n * A CacheKey is generated from the url and query params, and used to cache the response\n * in the store.\n *\n * ```ts\n * import { postQuery } from '@warp-drive/utilities/json-api';\n *\n * const options = postQuery('person', { include: ['pets', 'friends'] });\n * const data = await store.request(options);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { postQuery } from '@warp-drive/utilities/json-api';\n *\n * const options = postQuery('person', { include: ['pets', 'friends'] }, { reload: true });\n * const data = await store.request(options);\n * ```\n *\n * @summary Builds a JSON:API `POST` request that sends a query as the JSON body, cached under a key built from the\n * query params.\n * @public\n * @param type - the name of the resource type to query\n * @param query - the query params to send with the request\n * @param options - options to modify the request behavior\n */\nexport function postQuery<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  type: TypeFromInstance<T>,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): PostQueryRequestOptions<ReactiveDataDocument<T[], M, E>>;\nexport function postQuery(\n  type: string,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): PostQueryRequestOptions;\nexport function postQuery(\n  type: string,\n  // oxlint-disable-next-line no-shadow\n  query: QueryParamsSource = {},\n  options: ConstrainedRequestOptions = {}\n): PostQueryRequestOptions {\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: QueryUrlOptions = {\n    identifier: { type },\n    op: 'query',\n    resourcePath: options.resourcePath ?? pluralize(type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  const queryData = structuredClone(query);\n  cacheOptions.key = cacheOptions.key ?? `${url}?${buildQueryParams(queryData, options.urlParamsSettings)}`;\n\n  return {\n    url,\n    method: 'POST',\n    body: JSON.stringify(query),\n    headers,\n    cacheOptions: cacheOptions as CacheOptions & { key: string },\n    op: 'query',\n  };\n}\n","import { recordIdentifierFor } from '@warp-drive/core';\nimport { assert } from '@warp-drive/core/build-config/macros';\nimport type { ReactiveDataDocument } from '@warp-drive/core/reactive';\nimport type { PersistedResourceKey, ResourceKey } from '@warp-drive/core/types/identifier';\nimport type { TypedRecordInstance } from '@warp-drive/core/types/record';\nimport type {\n  ConstrainedRequestOptions,\n  CreateRequestOptions,\n  DeleteRequestOptions,\n  UpdateRequestOptions,\n} from '@warp-drive/core/types/request';\nimport type { ApiError } from '@warp-drive/core/types/spec/error';\nimport type { Meta } from '@warp-drive/core/types/spec/json-api-raw';\n\nimport {\n  buildBaseURL,\n  type CreateRecordUrlOptions,\n  type DeleteRecordUrlOptions,\n  type UpdateRecordUrlOptions,\n} from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n\nfunction isExisting(identifier: ResourceKey): identifier is PersistedResourceKey {\n  return 'id' in identifier && identifier.id !== null && 'type' in identifier && identifier.type !== null;\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to delete record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { deleteRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n *\n * // mark record as deleted\n * store.deleteRecord(person);\n *\n * // persist deletion\n * const data = await store.request(deleteRecord(person));\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { deleteRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n *\n * // mark record as deleted\n * store.deleteRecord(person);\n *\n * // persist deletion\n * const options = deleteRecord(person, { namespace: 'api/v1' });\n * const data = await store.request(options);\n * ```\n *\n * @summary Builds a JSON:API `DELETE` request that persists deletion of an existing record.\n * @public\n * @param record\n * @param options\n */\nexport function deleteRecord<T>(record: T, options?: ConstrainedRequestOptions): DeleteRequestOptions<T>;\nexport function deleteRecord(record: unknown, options?: ConstrainedRequestOptions): DeleteRequestOptions;\nexport function deleteRecord(record: unknown, options: ConstrainedRequestOptions = {}): DeleteRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n  assert(`Cannot delete a record that does not have an associated type and id.`, isExisting(identifier));\n\n  const urlOptions: DeleteRecordUrlOptions = {\n    identifier: identifier,\n    op: 'deleteRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: 'DELETE',\n    headers,\n    op: 'deleteRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Necessary Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to create new record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { cacheKeyFor } from '@warp-drive/core';\n * import { createRecord } from '@warp-drive/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const person = store.createRecord<Person>('person', { name: 'Ted' });\n * const init = createRecord(person);\n * init.body = JSON.stringify(\n *  {\n *    // it's likely you will want to transform this data\n *    // somewhat\n *    data: store.cache.peek(cacheKeyFor(person))\n *  }\n * );\n * const data = await store.request(init);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { createRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.createRecord('person', { name: 'Ted' });\n * const options = createRecord(person, { namespace: 'api/v1' });\n * const data = await store.request(options);\n * ```\n *\n * @summary Builds a JSON:API `POST` request for saving a new record; the app must set the request body itself.\n * @public\n * @param record\n * @param options\n */\nexport function createRecord<T>(record: T, options?: ConstrainedRequestOptions): CreateRequestOptions<T>;\nexport function createRecord(record: unknown, options?: ConstrainedRequestOptions): CreateRequestOptions;\nexport function createRecord(record: unknown, options: ConstrainedRequestOptions = {}): CreateRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n\n  const urlOptions: CreateRecordUrlOptions = {\n    identifier: identifier,\n    op: 'createRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: 'POST',\n    headers,\n    op: 'createRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Necessary Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to update existing record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * **Example Usage**\n *\n * ```ts\n * import { cacheKeyFor } from '@warp-drive/core';\n * import { updateRecord } from '@warp-drive/utilities/json-api';\n * import type { EditablePerson } from '#/data/types';\n *\n * const mutable = await checkout<EditablePerson>(person);\n * mutable.name = 'Chris';\n * const init = updateRecord(mutable);\n *\n * init.body = JSON.stringify(\n *  // it's likely you will want to transform this data\n *  // somewhat, or serialize only specific properties instead\n *  serializePatch(store.cache, cacheKeyFor(mutable))\n * );\n * const data = await store.request(init);\n * ```\n *\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `patch` - Allows caller to specify whether to use a PATCH request instead of a PUT request, defaults to `false`.\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { updateRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const options = updateRecord(person, { patch: true });\n * const data = await store.request(options);\n * ```\n *\n * @summary Builds a JSON:API `PUT` (or `PATCH`) request for saving an existing record; the app must set the request\n * body itself.\n * @public\n * @param record\n * @param options\n */\nexport function updateRecord<\n  T extends TypedRecordInstance,\n  RT extends TypedRecordInstance = T,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n>(\n  record: T,\n  options?: ConstrainedRequestOptions & { patch?: boolean }\n): UpdateRequestOptions<ReactiveDataDocument<RT, M, E>, T>;\nexport function updateRecord(\n  record: unknown,\n  options?: ConstrainedRequestOptions & { patch?: boolean }\n): UpdateRequestOptions;\nexport function updateRecord(\n  record: unknown,\n  options: ConstrainedRequestOptions & { patch?: boolean } = {}\n): UpdateRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n  assert(`Cannot update a record that does not have an associated type and id.`, isExisting(identifier));\n\n  const urlOptions: UpdateRecordUrlOptions = {\n    identifier: identifier,\n    op: 'updateRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: options.patch ? 'PATCH' : 'PUT',\n    headers,\n    op: 'updateRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * Builds request options to update existing record for resources,\n * configured for the url and header expectations of most JSON:API APIs\n * for a PATCH request.\n *\n * Note: This is a convenience method that calls `updateRecord` with the\n * supplied request with the `patch` option set to `true`.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { patchRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const data = await store.request(patchRecord(person));\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { patchRecord } from '@warp-drive/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const options = patchRecord(person);\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param record\n * @param options\n */\nexport function patchRecord<T>(record: T, options?: ConstrainedRequestOptions): UpdateRequestOptions<T>;\nexport function patchRecord(record: unknown, options?: ConstrainedRequestOptions): UpdateRequestOptions;\nexport function patchRecord(record: unknown, options: ConstrainedRequestOptions = {}): UpdateRequestOptions {\n  const opts = options as ConstrainedRequestOptions & { patch: true };\n  opts.patch = true;\n  return updateRecord(record, opts);\n}\n","import { assert } from '@warp-drive/core/build-config/macros';\nimport type { Cache } from '@warp-drive/core/types/cache';\nimport type { Relationship } from '@warp-drive/core/types/cache/relationship';\nimport type { ResourceKey } from '@warp-drive/core/types/identifier';\nimport type { Value } from '@warp-drive/core/types/json/raw';\nimport type { InnerRelationshipDocument, ResourceObject } from '@warp-drive/core/types/spec/json-api-raw';\n\ntype ChangedRelationshipData = InnerRelationshipDocument;\n\nexport type JsonApiResourcePatch =\n  | {\n      type: string;\n      id: string;\n      attributes?: Record<string, Value>;\n      relationships?: Record<string, ChangedRelationshipData>;\n    }\n  | {\n      type: string;\n      id: null;\n      lid: string;\n      attributes?: Record<string, Value>;\n      relationships?: Record<string, ChangedRelationshipData>;\n    };\n\n/**\n * :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**\n *\n * While this may come as a surprise, they are intended to serialize cache state for more\n * generalized usage. {json:api} has a large variance in acceptable shapes, and only your\n * app can ensure that the body is correctly formatted and contains all necessary data.\n * :::\n *\n * Serializes the current state of a resource or array of resources for use with POST or PUT requests.\n *\n * @summary Copies the cached state of one or more resources into a JSON:API-style `{ data }` object, a starting point\n * for request bodies.\n * @public\n * @param cache - the cache to serialize the resource(s) from\n * @param identifiers - the resource(s) to serialize\n * @return an object with a `data` property containing the serialized resource(s)\n */\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey\n): {\n  /**\n   * The serialized resource.\n   */\n  data: ResourceObject;\n};\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey[]\n): {\n  /**\n   * The serialized resources.\n   */\n  data: ResourceObject[];\n};\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey | ResourceKey[]\n): { data: ResourceObject | ResourceObject[] } {\n  return {\n    data: Array.isArray(identifiers)\n      ? identifiers.map((identifier) => _serializeResource(cache, identifier))\n      : _serializeResource(cache, identifiers),\n  };\n}\n\ntype SerializedRef =\n  | {\n      id: string;\n      type: string;\n    }\n  | { id: null; lid: string; type: string };\n\nfunction fixRef({\n  id,\n  lid,\n  type,\n}: { id: string; lid?: string; type: string } | { id: null; lid: string; type: string }): SerializedRef {\n  if (id !== null) {\n    return { id, type };\n  }\n  return { id, lid, type };\n}\n\nfunction fixRelData(\n  rel: Relationship['data'] | InnerRelationshipDocument['data']\n): SerializedRef | SerializedRef[] | null {\n  if (Array.isArray(rel)) {\n    return rel.map((ref) => fixRef(ref));\n  } else if (typeof rel === 'object' && rel !== null) {\n    return fixRef(rel);\n  }\n  return null;\n}\n\nfunction _serializeResource(cache: Cache, identifier: ResourceKey): ResourceObject {\n  const { id, lid, type } = identifier;\n  // peek gives us everything we want, but since its referentially the same data\n  // as is in the cache we clone it to avoid any accidental mutations\n  const record = structuredClone(cache.peek(identifier)) as ResourceObject;\n  assert(\n    `A record with id ${String(id)} and type ${type} for lid ${lid} was not found not in the supplied Cache.`,\n    record\n  );\n\n  // remove lid from anything that has an ID and slice any relationship arrays\n  if (record.id !== null) {\n    delete record.lid;\n  }\n\n  if (record.relationships) {\n    for (const key of Object.keys(record.relationships)) {\n      const relationship = record.relationships[key];\n      if (Array.isArray(relationship.data)) {\n        relationship.data = relationship.data.map((ref) => fixRef(ref));\n      } else if (typeof relationship.data === 'object' && relationship.data !== null) {\n        relationship.data = fixRef(relationship.data);\n      } else if (Object.keys(relationship ?? {}).length === 0) {\n        delete record.relationships[key];\n      }\n    }\n  }\n\n  return record;\n}\n\n/**\n * :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**\n *\n * While this may come as a surprise, they are intended to serialize cache state for more\n * generalized usage. {json:api} has a large variance in acceptable shapes, and only your\n * app can ensure that the body is correctly formatted and contains all necessary data.\n * :::\n *\n * Serializes changes to a resource. Useful for use with building bodies for PATCH requests.\n *\n * Only attributes which are changed are serialized.\n * Only relationships which are changed are serialized.\n *\n * Collection relationships serialize the collection as a whole.\n *\n * If you would like to serialize updates to a collection more granularly\n * (for instance, as operations) request the diff from the store and\n * serialize as desired:\n *\n * ```ts\n * const relationshipDiffMap = cache.changedRelationships(identifier);\n * ```\n *\n * @summary Serializes only a resource's changed attributes and relationships from the cache into a JSON:API-style\n * `{ data }` patch.\n * @public\n * @param cache - the cache to serialize the resource's changes from\n * @param identifier - the resource whose changes should be serialized\n * @return an object with a `data` property containing the serialized resource patch\n */\nexport function serializePatch(\n  cache: Cache,\n  identifier: ResourceKey\n  // options: { include?: string[] } = {}\n): {\n  /**\n   * The serialized resource patch.\n   */\n  data: JsonApiResourcePatch;\n} {\n  const { id, lid, type } = identifier;\n  assert(\n    `A record with id ${String(id)} and type ${type} for lid ${lid} was not found not in the supplied Cache.`,\n    cache.peek(identifier)\n  );\n\n  const data: JsonApiResourcePatch =\n    id === null\n      ? { type, lid, id }\n      : {\n          type,\n          id,\n        };\n\n  if (cache.hasChangedAttrs(identifier)) {\n    const attrsChanges = cache.changedAttrs(identifier);\n    const attributes: ResourceObject['attributes'] = {};\n\n    Object.keys(attrsChanges).forEach((key) => {\n      const change = attrsChanges[key];\n      const newVal = change[1];\n      attributes[key] = newVal === undefined ? null : structuredClone(newVal);\n    });\n\n    data.attributes = attributes;\n  }\n\n  const changedRelationships = cache.changedRelationships(identifier);\n  if (changedRelationships.size) {\n    const relationships: Record<string, ChangedRelationshipData> = {};\n    changedRelationships.forEach((diff, key) => {\n      relationships[key] = { data: fixRelData(diff.localState) } as ChangedRelationshipData;\n    });\n\n    data.relationships = relationships;\n  }\n\n  return { data };\n}\n"],"mappings":";;;;;;AAgBA,MAAM,gBAAgB;AACtB,MAAM,iBAAgC;CAAE,MAAM;CAAI,WAAW;AAAG;AAChE,IAAW,SAAwB;AACnC,IAAW,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8CjC,SAAgB,kBAAkB,QAA6B;CAC7D,SAAS,OAAO,OAAO,CAAC,GAAG,gBAAgB,MAAM;CAEjD,IAAI,OAAO,YAAY,OAAO,YAAY;EACxC,IAAI,SAAS;EACb,IAAI,OAAO,UAAU;GACnB,MAAM,WAAW,OAAO,OAAO,OAAO,QAAQ;GAC9C,IAAI,SAAS,QACX,UAAU,gBAAe,SAAS,KAAK,GAAG,IAAI;EAElD;EACA,IAAI,OAAO,YAAY;GACrB,MAAM,aAAa,OAAO,OAAO,OAAO,UAAU;GAClD,IAAI,WAAW,QACb,UAAU,UAAU,WAAW,KAAK,GAAG;EAE3C;EACA,sBAAsB;CACxB;CAEA,oBAAU,MAAM;AAClB;;;;ACsBA,SAAgB,WACd,MACA,MACA,MAC0B;CAC1B,MAAM,aAA2C,OAAO,SAAS,WAAW;EAAE,MAAM;EAAM,IAAI;CAAe,IAAI;CACjH,MAAM,WAAY,OAAO,SAAS,WAAW,OAAO,SAAS,CAAC;CAC9D,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAAmC;EACvC;EACA,IAAI;EACJ,cAAc,UAAU,WAAW,IAAI;CACzC;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAE5C,OAAO;EACL,KAAK,QAAQ,SAAS,SAClB,GAAG,IAAI,GAAG,iBAAiB,EAAE,SAAS,QAAQ,QAAQ,GAAG,QAAQ,iBAAiB,MAClF;EACJ,QAAQ;EACR;EACA;EACA,IAAI;EACJ,SAAS,CAAC,UAAU;CACtB;AACF;;;;ACvDA,SAAgB,MACd,MAEA,QAA2B,CAAC,GAC5B,UAAqC,CAAC,GACjB;CACrB,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAA8B;EAClC,YAAY,EAAE,KAAK;EACnB,IAAI;EACJ,cAAc,UAAU,IAAI;CAC9B;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAC5C,MAAM,cAAc,iBAAiB,OAAO,QAAQ,iBAAiB;CAErE,OAAO;EACL,KAAK,cAAc,GAAG,IAAI,GAAG,gBAAgB;EAC7C,QAAQ;EACR;EACA;EACA,IAAI;CACN;AACF;AA6DA,SAAgB,UACd,MAEA,QAA2B,CAAC,GAC5B,UAAqC,CAAC,GACb;CACzB,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAA8B;EAClC,YAAY,EAAE,KAAK;EACnB,IAAI;EACJ,cAAc,QAAQ,gBAAgB,UAAU,IAAI;CACtD;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAE5C,MAAM,YAAY,gBAAgB,KAAK;CACvC,aAAa,MAAM,aAAa,OAAO,GAAG,IAAI,GAAG,iBAAiB,WAAW,QAAQ,iBAAiB;CAEtG,OAAO;EACL;EACA,QAAQ;EACR,MAAM,KAAK,UAAU,KAAK;EAC1B;EACc;EACd,IAAI;CACN;AACF;;;;ACjLA,SAASK,WAAWC,YAA6D;CAC/E,OAAO,QAAQA,cAAcA,WAAWC,OAAO,QAAQ,UAAUD,cAAcA,WAAWE,SAAS;AACrG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,SAAgBC,aAAaC,QAAiBC,UAAqC,CAAC,GAAyB;CAC3G,MAAML,aAAaN,oBAAoBU,MAAM;CAC7C,EAAAE,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEP,UAAU;CAC3D,EAAAM,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,sEAAsE;CAAA,EAAA,CAAER,WAAWC,UAAU,CAAC;CAErG,MAAMQ,aAAqC;EAC7BR;EACZS,IAAI;EACJC,cAAcd,UAAUI,WAAWE,IAAI;CACzC;CAEAL,sBAAsBW,YAAYH,OAAO;CAEzC,MAAMM,MAAMhB,aAAaa,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUhB,mBAAmB;CAE5C,OAAO;EACLa;EACAI,QAAQ;EACRH;EACAH,IAAI;EACJO,MAAM,EACJZ,QAAQJ,WACV;EACAiB,SAAS,CAACjB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,SAAgBkB,aAAad,QAAiBC,UAAqC,CAAC,GAAyB;CAC3G,MAAML,aAAaN,oBAAoBU,MAAM;CAC7C,EAAAE,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEP,UAAU;CAE3D,MAAMQ,aAAqC;EAC7BR;EACZS,IAAI;EACJC,cAAcd,UAAUI,WAAWE,IAAI;CACzC;CAEAL,sBAAsBW,YAAYH,OAAO;CAEzC,MAAMM,MAAMhB,aAAaa,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUhB,mBAAmB;CAE5C,OAAO;EACLa;EACAI,QAAQ;EACRH;EACAH,IAAI;EACJO,MAAM,EACJZ,QAAQJ,WACV;EACAiB,SAAS,CAACjB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6EA,SAAgBmB,aACdf,QACAC,UAA2D,CAAC,GACtC;CACtB,MAAML,aAAaN,oBAAoBU,MAAM;CAC7C,EAAAE,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEP,UAAU;CAC3D,EAAAM,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,sEAAsE;CAAA,EAAA,CAAER,WAAWC,UAAU,CAAC;CAErG,MAAMQ,aAAqC;EAC7BR;EACZS,IAAI;EACJC,cAAcd,UAAUI,WAAWE,IAAI;CACzC;CAEAL,sBAAsBW,YAAYH,OAAO;CAEzC,MAAMM,MAAMhB,aAAaa,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUhB,mBAAmB;CAE5C,OAAO;EACLa;EACAI,QAAQV,QAAQe,QAAQ,UAAU;EAClCR;EACAH,IAAI;EACJO,MAAM,EACJZ,QAAQJ,WACV;EACAiB,SAAS,CAACjB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;;;AC3PA,SAAgBuB,mBACdC,OACAC,aAC6C;CAC7C,OAAO,EACLC,MAAMC,MAAMC,QAAQH,WAAW,IAC3BA,YAAYI,KAAKC,eAAeC,mBAAmBP,OAAOM,UAAU,CAAC,IACrEC,mBAAmBP,OAAOC,WAAW,EAC3C;AACF;AASA,SAASO,OAAO,EACdC,IACAC,KACAC,QACsG;CACtG,IAAIF,OAAO,MACT,OAAO;EAAEA;EAAIE;CAAK;CAEpB,OAAO;EAAEF;EAAIC;EAAKC;CAAK;AACzB;AAEA,SAASC,WACPC,KACwC;CACxC,IAAIV,MAAMC,QAAQS,GAAG,GACnB,OAAOA,IAAIR,KAAKS,QAAQN,OAAOM,GAAG,CAAC;MAC9B,IAAI,OAAOD,QAAQ,YAAYA,QAAQ,MAC5C,OAAOL,OAAOK,GAAG;CAEnB,OAAO;AACT;AAEA,SAASN,mBAAmBP,OAAcM,YAAyC;CACjF,MAAM,EAAEG,IAAIC,KAAKC,SAASL;CAG1B,MAAMS,SAASC,gBAAgBhB,MAAMiB,KAAKX,UAAU,CAAC;CACrD,EAAAY,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,oBAAoBC,OAAOX,EAAE,EAAC,YAAaE,KAAI,WAAYD,IAAG,0CAA2C;CAAA,EAAA,CACzGK,MAAM;CAIR,IAAIA,OAAON,OAAO,MAChB,OAAOM,OAAOL;CAGhB,IAAIK,OAAOM,eACT,KAAK,MAAMC,OAAOC,OAAOC,KAAKT,OAAOM,aAAa,GAAG;EACnD,MAAMI,eAAeV,OAAOM,cAAcC;EAC1C,IAAInB,MAAMC,QAAQqB,aAAavB,IAAI,GACjCuB,aAAavB,OAAOuB,aAAavB,KAAKG,KAAKS,QAAQN,OAAOM,GAAG,CAAC;OACzD,IAAI,OAAOW,aAAavB,SAAS,YAAYuB,aAAavB,SAAS,MACxEuB,aAAavB,OAAOM,OAAOiB,aAAavB,IAAI;OACvC,IAAIqB,OAAOC,KAAKC,gBAAgB,CAAC,CAAC,CAAC,CAACC,WAAW,GACpD,OAAOX,OAAOM,cAAcC;CAEhC;CAGF,OAAOP;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCA,SAAgBY,eACd3B,OACAM,YAOA;CACA,MAAM,EAAEG,IAAIC,KAAKC,SAASL;CAC1B,EAAAY,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,oBAAoBC,OAAOX,EAAE,EAAC,YAAaE,KAAI,WAAYD,IAAG,0CAA2C;CAAA,EAAA,CACzGV,MAAMiB,KAAKX,UAAU,CAAC;CAGxB,MAAMJ,OACJO,OAAO,OACH;EAAEE;EAAMD;EAAKD;CAAG,IAChB;EACEE;EACAF;CACF;CAEN,IAAIT,MAAM4B,gBAAgBtB,UAAU,GAAG;EACrC,MAAMuB,eAAe7B,MAAM8B,aAAaxB,UAAU;EAClD,MAAMyB,aAA2C,CAAC;EAElDR,OAAOC,KAAKK,YAAY,CAAC,CAACG,SAASV,QAAQ;GAEzC,MAAMY,SADSL,aAAaP,IACP,CAAC;GACtBS,WAAWT,OAAOY,WAAWC,SAAY,OAAOnB,gBAAgBkB,MAAM;EACxE,CAAC;EAEDhC,KAAK6B,aAAaA;CACpB;CAEA,MAAMK,uBAAuBpC,MAAMoC,qBAAqB9B,UAAU;CAClE,IAAI8B,qBAAqBC,MAAM;EAC7B,MAAMhB,gBAAyD,CAAC;EAChEe,qBAAqBJ,SAASM,MAAMhB,QAAQ;GAC1CD,cAAcC,OAAO,EAAEpB,MAAMU,WAAW0B,KAAKC,UAAU,EAAE;EAC3D,CAAC;EAEDrC,KAAKmB,gBAAgBA;CACvB;CAEA,OAAO,EAAEnB,KAAK;AAChB"}

package/dist/unpkg/dev-deprecated/rest.js

@@ -1,5 +1,5 @@
 import { buildBaseURL, buildQueryParams } from "./index.js";
-import { f as camelize, s as pluralize } from "./string-j4ur-TDs.js";
+import { f as camelize, s as pluralize } from "./string-I8KHJXV7.js";
 import { n as extractCacheOptions, t as copyForwardUrlOptions } from "./builder-utils-BkXwUT0x.js";
 import { recordIdentifierFor } from "@warp-drive/core";
 
@@ -62,6 +62,9 @@ function isExisting(identifier) {
 * Builds request options to delete record for resources,
 * configured for the url, method and header expectations of REST APIs.
 *
+* See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+* when to use one.
+*
 * **Basic Usage**
 *
 * ```ts
@@ -103,6 +106,7 @@ function isExisting(identifier) {
 * const data = await store.request(options);
 * ```
 *
+* @summary Builds a `DELETE` request that persists deletion of an existing record, using REST-style URLs.
 * @public
 * @param record
 * @param options
@@ -137,6 +141,9 @@ function deleteRecord(record, options = {}) {
 * Builds request options to create new record for resources,
 * configured for the url, method and header expectations of most REST APIs.
 *
+* See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+* when to use one.
+*
 * **Basic Usage**
 *
 * ```ts
@@ -168,6 +175,7 @@ function deleteRecord(record, options = {}) {
 * const data = await store.request(options);
 * ```
 *
+* @summary Builds a `POST` request that saves a newly created record, using REST-style URLs.
 * @public
 * @param record
 * @param options
@@ -199,6 +207,9 @@ function createRecord(record, options = {}) {
 * Builds request options to update existing record for resources,
 * configured for the url, method and header expectations of most REST APIs.
 *
+* See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+* when to use one.
+*
 * **Basic Usage**
 *
 * ```ts
@@ -233,6 +244,7 @@ function createRecord(record, options = {}) {
 * const data = await store.request(options);
 * ```
 *
+* @summary Builds a `PUT` (or `PATCH`) request that saves changes to an existing record, using REST-style URLs.
 * @public
 * @param record
 * @param options