@warp-drive/core 5.9.0-alpha.3 → 5.9.0-alpha.31

package/dist/document-BEn91SwT.d.ts

@@ -0,0 +1,129 @@
+import { s as PersistedResourceKey } from "./identifier-DQnqOSJK.js";
+import { d as Meta, m as PaginationLinks, u as Links } from "./json-api-raw-C5APJHHB.js";
+import { t as ApiError } from "./error-50OSEhsF.js";
+//#region src/types/spec/document.d.ts
+/**
+ * This type represents a raw {json:api} document for a meta-only
+ * document returned by a request intended to be inserted into the cache.
+ */
+interface ResourceMetaDocument {
+  /**
+   * the url or cache-key associated with the structured document
+   */
+  lid?: string;
+  /**
+   * meta information about the document
+   */
+  meta: Meta;
+  /**
+   * links related to the document
+   */
+  links?: Links | PaginationLinks;
+}
+/**
+ * This type represents a raw {json:api} document for a single resource
+ * returned by a request intended to be inserted into the cache.
+ *
+ * For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+ */
+interface SingleResourceDataDocument<T = PersistedResourceKey, R = PersistedResourceKey> {
+  /**
+   * the url or cache-key associated with the structured document
+   */
+  lid?: string;
+  /**
+   * links related to the document
+   */
+  links?: Links | PaginationLinks;
+  /**
+   * meta information about the document
+   */
+  meta?: Meta;
+  /**
+   * the resource the document represents, or `null` if it has none
+   */
+  data: T | null;
+  /**
+   * any additional resources included via sideloading
+   */
+  included?: R[];
+}
+/**
+ * This type represents a raw {json:api} document for a resource collection
+ * returned by a request intended to be inserted into the cache.
+ *
+ * For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+ */
+interface CollectionResourceDataDocument<T = PersistedResourceKey> {
+  /**
+   * the url or cache-key associated with the structured document
+   */
+  lid?: string;
+  /**
+   * links related to the document, including pagination links
+   */
+  links?: Links | PaginationLinks;
+  /**
+   * meta information about the document
+   */
+  meta?: Meta;
+  /**
+   * the resources the document represents
+   */
+  data: T[];
+  /**
+   * any additional resources included via sideloading
+   */
+  included?: T[];
+}
+/**
+ * A type useful for representing the raw {json:api} documents that
+ * the cache may use.
+ *
+ * See also:
+ * - {@link SingleResourceDataDocument}
+ * - {@link CollectionResourceDataDocument}
+ *
+ * For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+ */
+type ResourceDataDocument<T = PersistedResourceKey> = SingleResourceDataDocument<T> | CollectionResourceDataDocument<T>;
+/**
+ * A type useful for representing the raw {json:api} Error documents that
+ * the cache may use.
+ *
+ * For the Reactive value returned by a request using the store, use {@link ReactiveErrorDocument} instead.
+ */
+interface ResourceErrorDocument {
+  /**
+   * the url or cache-key associated with the structured document
+   */
+  lid?: string;
+  /**
+   * links related to the document
+   */
+  links?: Links | PaginationLinks;
+  /**
+   * meta information about the document
+   */
+  meta?: Meta;
+  /**
+   * the errors the document represents
+   */
+  errors: ApiError[];
+}
+/**
+ * A type useful for representing the raw {json:api} documents that
+ * the cache may use.
+ *
+ * See also:
+ * - {@link ResourceMetaDocument}
+ * - {@link SingleResourceDataDocument}
+ * - {@link CollectionResourceDataDocument}
+ * - {@link ResourceErrorDocument}
+ *
+ * For the Reactive value returned by a request using the store, use {@link ReactiveDocument} instead.
+ */
+type ResourceDocument<T = PersistedResourceKey> = ResourceMetaDocument | SingleResourceDataDocument<T> | CollectionResourceDataDocument<T> | ResourceErrorDocument;
+//#endregion
+export { ResourceMetaDocument as a, ResourceErrorDocument as i, ResourceDataDocument as n, SingleResourceDataDocument as o, ResourceDocument as r, CollectionResourceDataDocument as t };
+//# sourceMappingURL=document-BEn91SwT.d.ts.map

package/dist/document-BEn91SwT.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-BEn91SwT.d.ts","names":[],"sources":["../src/types/spec/document.ts"],"mappings":";;;;;;;;UAUiB;;;;EAIf;;;;EAIA,MAAM;;;;EAIN,QAAQ,QAAQ;;;;;;;;UASD,2BAA2B,IAAI,sBAAsB,IAAI;;;;EAIxE;;;;EAIA,QAAQ,QAAQ;;;;EAIhB,OAAO;;;;EAIP,MAAM;;;;EAIN,WAAW;;;;;;;;UASI,+BAA+B,IAAI;;;;EAIlD;;;;EAIA,QAAQ,QAAQ;;;;EAIhB,OAAO;;;;EAIP,MAAM;;;;EAIN,WAAW;;;;;;;;;;;;KAaD,qBAAqB,IAAI,wBACjC,2BAA2B,KAC3B,+BAA+B;;;;;;;UAQlB;;;;EAIf;;;;EAIA,QAAQ,QAAQ;;;;EAIhB,OAAO;;;;EAIP,QAAQ;;;;;;;;;;;;;;KAeE,iBAAiB,IAAI,wBAC7B,uBACA,2BAA2B,KAC3B,+BAA+B,KAC/B"}

package/dist/error-50OSEhsF.d.ts

@@ -0,0 +1,77 @@
+import { c as Link, d as Meta } from "./json-api-raw-C5APJHHB.js";
+//#region src/types/spec/error.d.ts
+/**
+ * Represents a single error in the `errors` member of a {json:api} document.
+ *
+ * [{json:api} Spec](https://jsonapi.org/format/#error-objects)
+ *
+ * @example
+ * ```json
+ * {
+ *   "status": "422",
+ *   "source": { "pointer": "/data/attributes/name" },
+ *   "title": "Invalid Attribute",
+ *   "detail": "name cannot be blank"
+ * }
+ * ```
+ */
+interface ApiError {
+  /**
+   * a unique identifier for this particular occurrence of the problem
+   */
+  id?: string;
+  /**
+   * a short, human-readable summary of the problem that should not
+   * change from occurrence to occurrence of the problem
+   */
+  title?: string;
+  /**
+   * a human-readable explanation specific to this occurrence of the problem
+   */
+  detail?: string;
+  /**
+   * links related to the error
+   */
+  links?: {
+    /**
+     * a link that leads to further details about this particular occurrence of the problem
+     */
+    about?: Link;
+    /**
+     * a link that identifies the type of error that this particular error is an instance of
+     */
+    type?: Link;
+  };
+  /**
+   * the HTTP status code applicable to this problem, expressed as a string value
+   */
+  status?: string;
+  /**
+   * an application-specific error code, expressed as a string value
+   */
+  code?: string;
+  /**
+   * an object containing references to the primary source of the error
+   */
+  source?: {
+    /**
+     * a JSON Pointer to the value in the request document that caused the error
+     */
+    pointer: string;
+    /**
+     * the URI query parameter that caused the error
+     */
+    parameter?: string;
+    /**
+     * the name of a single request header which caused the error
+     */
+    header?: string;
+  };
+  /**
+   * non-standard meta-information about the error
+   */
+  meta?: Meta;
+}
+//#endregion
+export { ApiError as t };
+//# sourceMappingURL=error-50OSEhsF.d.ts.map

package/dist/error-50OSEhsF.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-50OSEhsF.d.ts","names":[],"sources":["../src/types/spec/error.ts"],"mappings":";;;;;;;;;;;;;;;;;UAiBiB;;;;EAIf;;;;;EAKA;;;;EAIA;;;;EAIA;;;;IAIE,QAAQ;;;;IAIR,OAAO;;;;;EAKT;;;;EAIA;;;;EAIA;;;;IAIE;;;;IAIA;;;;IAIA;;;;;EAKF,OAAO"}