@warp-drive/core 5.6.0-alpha.11

package/declarations/types/cache.d.ts

@@ -0,0 +1,492 @@
+import type { ResourceBlob } from './cache/aliases.ts';
+import type { Change } from './cache/change.ts';
+import type { Mutation } from './cache/mutations.ts';
+import type { Operation } from './cache/operations.ts';
+import type { CollectionRelationship, ResourceRelationship } from './cache/relationship.ts';
+import type { StableDocumentIdentifier, StableRecordIdentifier } from './identifier.ts';
+import type { Value } from './json/raw.ts';
+import type { TypeFromInstanceOrString } from './record.ts';
+import type { RequestContext, StructuredDataDocument, StructuredDocument } from './request.ts';
+import type { ResourceDocument, SingleResourceDataDocument } from './spec/document.ts';
+import type { ApiError } from './spec/error.ts';
+/**
+ * A hash of changed attributes with the key being the attribute name and the value being an
+ * array of `[oldValue, newValue]`.
+ *
+ * @internal
+ */
+export type ChangedAttributesHash = Record<string, [Value | undefined, Value]>;
+export type RelationshipDiff = {
+    kind: 'collection';
+    remoteState: StableRecordIdentifier[];
+    additions: Set<StableRecordIdentifier>;
+    removals: Set<StableRecordIdentifier>;
+    localState: StableRecordIdentifier[];
+    reordered: boolean;
+} | {
+    kind: 'resource';
+    remoteState: StableRecordIdentifier | null;
+    localState: StableRecordIdentifier | null;
+};
+/**
+ * The interface for WarpDrive Caches.
+ *
+ * A Cache handles in-memory storage of Document and Resource
+ * data.
+ *
+ * @class (Interface) Cache
+ * @public
+ */
+export interface Cache {
+    /**
+     * The Cache Version that this implementation implements.
+     *
+     * @type {'2'}
+     * @public
+     * @property version
+     */
+    version: '2';
+    /**
+     * Cache the response to a request
+     *
+     * Unlike `store.push` which has UPSERT
+     * semantics, `put` has `replace` semantics similar to
+     * the `http` method `PUT`
+     *
+     * the individually cacheable resource data it may contain
+     * should upsert, but the document data surrounding it should
+     * fully replace any existing information
+     *
+     * Note that in order to support inserting arbitrary data
+     * to the cache that did not originate from a request `put`
+     * should expect to sometimes encounter a document with only
+     * a `content` member and therefor must not assume the existence
+     * of `request` and `response` on the document.
+     *
+     * @param {StructuredDocument} doc
+     * @return {ResourceDocument}
+     * @public
+     */
+    put<T>(doc: StructuredDocument<T> | {
+        content: T;
+    }): ResourceDocument;
+    /**
+     * Update the "remote" or "canonical" (persisted) state of the Cache
+     * by merging new information into the existing state.
+     *
+     * @public
+     * @param {Operation | Operation[]} op the operation(s) to perform
+     * @return {void}
+     */
+    patch(op: Operation | Operation[]): void;
+    /**
+     * Update the "local" or "current" (unpersisted) state of the Cache
+     *
+     * @param {Mutation} mutation
+     * @return {void}
+     * @public
+     */
+    mutate(mutation: Mutation): void;
+    /**
+     * Peek resource data from the Cache.
+     *
+     * In development, if the return value
+     * is JSON the return value
+     * will be deep-cloned and deep-frozen
+     * to prevent mutation thereby enforcing cache
+     * Immutability.
+     *
+     * This form of peek is useful for implementations
+     * that want to feed raw-data from cache to the UI
+     * or which want to interact with a blob of data
+     * directly from the presentation cache.
+     *
+     * An implementation might want to do this because
+     * de-referencing records which read from their own
+     * blob is generally safer because the record does
+     * not require retainining connections to the Store
+     * and Cache to present data on a per-field basis.
+     *
+     * This generally takes the place of `getAttr` as
+     * an API and may even take the place of `getRelationship`
+     * depending on implementation specifics, though this
+     * latter usage is less recommended due to the advantages
+     * of the Graph handling necessary entanglements and
+     * notifications for relational data.
+     *
+     * @public
+     * @param {StableRecordIdentifier | StableDocumentIdentifier} identifier
+     * @return {ResourceDocument | ResourceBlob | null} the known resource data
+     */
+    peek<T = unknown>(identifier: StableRecordIdentifier<TypeFromInstanceOrString<T>>): T | null;
+    peek(identifier: StableDocumentIdentifier): ResourceDocument | null;
+    /**
+     * Peek remote resource data from the Cache.
+     *
+     * This will give the data provided from the server without any local changes.
+     *
+     * In development, if the return value
+     * is JSON the return value
+     * will be deep-cloned and deep-frozen
+     * to prevent mutation thereby enforcing cache
+     * Immutability.
+     *
+     * This form of peek is useful for implementations
+     * that want to feed raw-data from cache to the UI
+     * or which want to interact with a blob of data
+     * directly from the presentation cache.
+     *
+     * An implementation might want to do this because
+     * de-referencing records which read from their own
+     * blob is generally safer because the record does
+     * not require retainining connections to the Store
+     * and Cache to present data on a per-field basis.
+     *
+     * This generally takes the place of `getAttr` as
+     * an API and may even take the place of `getRelationship`
+     * depending on implementation specifics, though this
+     * latter usage is less recommended due to the advantages
+     * of the Graph handling necessary entanglements and
+     * notifications for relational data.
+     *
+     * @public
+     * @param {StableRecordIdentifier | StableDocumentIdentifier} identifier
+     * @return {ResourceDocument | ResourceBlob | null} the known resource data
+     */
+    peekRemoteState<T = unknown>(identifier: StableRecordIdentifier<TypeFromInstanceOrString<T>>): T | null;
+    peekRemoteState(identifier: StableDocumentIdentifier): ResourceDocument | null;
+    /**
+     * Peek the Cache for the existing request data associated with
+     * a cacheable request
+     *
+     * This is effectively the reverse of `put` for a request in
+     * that it will return the the request, response, and content
+     * whereas `peek` will return just the `content`.
+     *
+     * @param {StableDocumentIdentifier}
+     * @return {StructuredDocument<ResourceDocument> | null}
+     * @public
+     */
+    peekRequest(identifier: StableDocumentIdentifier): StructuredDocument<ResourceDocument> | null;
+    /**
+     * Push resource data from a remote source into the cache for this identifier
+     *
+     * @public
+     * @param identifier
+     * @param data
+     * @param hasRecord
+     * @return {void | string[]} if `hasRecord` is true then calculated key changes should be returned
+     */
+    upsert(identifier: StableRecordIdentifier, data: ResourceBlob, hasRecord: boolean): void | string[];
+    /**
+     * Create a fork of the cache from the current state.
+     *
+     * Applications should typically not call this method themselves,
+     * preferring instead to fork at the Store level, which will
+     * utilize this method to fork the cache.
+     *
+     * @public
+     * @return {Promise<Cache>}
+     */
+    fork(): Promise<Cache>;
+    /**
+     * Merge a fork back into a parent Cache.
+     *
+     * Applications should typically not call this method themselves,
+     * preferring instead to merge at the Store level, which will
+     * utilize this method to merge the caches.
+     *
+     * @param {Cache} cache
+     * @public
+     * @return {Promise<void>}
+     */
+    merge(cache: Cache): Promise<void>;
+    /**
+     * Generate the list of changes applied to all
+     * record in the store.
+     *
+     * Each individual resource or document that has
+     * been mutated should be described as an individual
+     * `Change` entry in the returned array.
+     *
+     * A `Change` is described by an object containing up to
+     * three properties: (1) the `identifier` of the entity that
+     * changed; (2) the `op` code of that change being one of
+     * `upsert` or `remove`, and if the op is `upsert` a `patch`
+     * containing the data to merge into the cache for the given
+     * entity.
+     *
+     * This `patch` is opaque to the Store but should be understood
+     * by the Cache and may expect to be utilized by an Adapter
+     * when generating data during a `save` operation.
+     *
+     * It is generally recommended that the `patch` contain only
+     * the updated state, ignoring fields that are unchanged
+     *
+     * ```ts
+     * interface Change {
+     *  identifier: StableRecordIdentifier | StableDocumentIdentifier;
+     *  op: 'upsert' | 'remove';
+     *  patch?: unknown;
+     * }
+     * ```
+     *
+     * @public
+     */
+    diff(): Promise<Change[]>;
+    /**
+     * Serialize the entire contents of the Cache into a Stream
+     * which may be fed back into a new instance of the same Cache
+     * via `cache.hydrate`.
+     *
+     * @return {Promise<ReadableStream>}
+     * @public
+     */
+    dump(): Promise<ReadableStream<unknown>>;
+    /**
+     * hydrate a Cache from a Stream with content previously serialized
+     * from another instance of the same Cache, resolving when hydration
+     * is complete.
+     *
+     * This method should expect to be called both in the context of restoring
+     * the Cache during application rehydration after SSR **AND** at unknown
+     * times during the lifetime of an already booted application when it is
+     * desired to bulk-load additional information into the cache. This latter
+     * behavior supports optimizing pre/fetching of data for route transitions
+     * via data-only SSR modes.
+     *
+     * @param {ReadableStream} stream
+     * @return {Promise<void>}
+     * @public
+     */
+    hydrate(stream: ReadableStream<unknown>): Promise<void>;
+    /**
+     * [LIFECYCLE] Signal to the cache that a new record has been instantiated on the client
+     *
+     * It returns properties from options that should be set on the record during the create
+     * process. This return value behavior is deprecated.
+     *
+     * @public
+     * @param identifier
+     * @param createArgs
+     */
+    clientDidCreate(identifier: StableRecordIdentifier, createArgs?: Record<string, unknown>): Record<string, unknown>;
+    /**
+     * [LIFECYCLE] Signals to the cache that a resource
+     * will be part of a save transaction.
+     *
+     * @public
+     * @param identifier
+     */
+    willCommit(identifier: StableRecordIdentifier, context: RequestContext): void;
+    /**
+     * [LIFECYCLE] Signals to the cache that a resource
+     * was successfully updated as part of a save transaction.
+     *
+     * @public
+     * @param identifier - the primary identifier that was operated on
+     * @param data - a document in the cache format containing any updated data
+     * @return {SingleResourceDataDocument}
+     */
+    didCommit(identifier: StableRecordIdentifier, result: StructuredDataDocument<unknown>): SingleResourceDataDocument;
+    /**
+     * [LIFECYCLE] Signals to the cache that a resource
+     * was update via a save transaction failed.
+     *
+     * @public
+     * @param identifier
+     * @param errors
+     */
+    commitWasRejected(identifier: StableRecordIdentifier, errors?: ApiError[]): void;
+    /**
+     * [LIFECYCLE] Signals to the cache that all data for a resource
+     * should be cleared.
+     *
+     * This method is a candidate to become a mutation
+     *
+     * @public
+     * @param identifier
+     */
+    unloadRecord(identifier: StableRecordIdentifier): void;
+    /**
+     * Retrieve the data for an attribute from the cache
+     *
+     * @public
+     * @param identifier
+     * @param field
+     * @return {unknown}
+     */
+    getAttr(identifier: StableRecordIdentifier, field: string | string[]): Value | undefined;
+    /**
+     * Retrieve remote state without any local changes for a specific attribute
+     *
+     * @public
+     * @param identifier
+     * @param field
+     * @return {unknown}
+     */
+    getRemoteAttr(identifier: StableRecordIdentifier, field: string | string[]): Value | undefined;
+    /**
+     * Mutate the data for an attribute in the cache
+     *
+     * This method is a candidate to become a mutation
+     *
+     * @public
+     * @param identifier
+     * @param field
+     * @param value
+     */
+    setAttr(identifier: StableRecordIdentifier, field: string | string[], value: Value): void;
+    /**
+     * Query the cache for the changed attributes of a resource.
+     *
+     * Returns a map of field names to tuples of [old, new] values
+     *
+     * ```
+     * { <field>: [<old>, <new>] }
+     * ```
+     *
+     * @public
+     * @param identifier
+     * @return {Record<string, [unknown, unknown]>} `{ <field>: [<old>, <new>] }`
+     */
+    changedAttrs(identifier: StableRecordIdentifier): ChangedAttributesHash;
+    /**
+     * Query the cache for whether any mutated attributes exist
+     *
+     * @public
+     * @param identifier
+     * @return {Boolean}
+     */
+    hasChangedAttrs(identifier: StableRecordIdentifier): boolean;
+    /**
+     * Tell the cache to discard any uncommitted mutations to attributes
+     *
+     * This method is a candidate to become a mutation
+     *
+     * @public
+     * @param identifier
+     * @return {String[]} the names of fields that were restored
+     */
+    rollbackAttrs(identifier: StableRecordIdentifier): string[];
+    /**
+     * Query the cache for the changes to relationships of a resource.
+     *
+     * Returns a map of relationship names to RelationshipDiff objects.
+     *
+     * ```ts
+     * type RelationshipDiff =
+    | {
+        kind: 'collection';
+        remoteState: StableRecordIdentifier[];
+        additions: Set<StableRecordIdentifier>;
+        removals: Set<StableRecordIdentifier>;
+        localState: StableRecordIdentifier[];
+        reordered: boolean;
+      }
+    | {
+        kind: 'resource';
+        remoteState: StableRecordIdentifier | null;
+        localState: StableRecordIdentifier | null;
+      };
+      ```
+     *
+     * @public
+     * @param {StableRecordIdentifier} identifier
+     * @return {Map<string, RelationshipDiff>}
+     */
+    changedRelationships(identifier: StableRecordIdentifier): Map<string, RelationshipDiff>;
+    /**
+     * Query the cache for whether any mutated attributes exist
+     *
+     * @public
+     * @param {StableRecordIdentifier} identifier
+     * @return {Boolean}
+     */
+    hasChangedRelationships(identifier: StableRecordIdentifier): boolean;
+    /**
+     * Tell the cache to discard any uncommitted mutations to relationships.
+     *
+     * This will also discard the change on any appropriate inverses.
+     *
+     * This method is a candidate to become a mutation
+     *
+     * @public
+     * @param {StableRecordIdentifier} identifier
+     * @return {String[]} the names of relationships that were restored
+     */
+    rollbackRelationships(identifier: StableRecordIdentifier): string[];
+    /**
+     * Query the cache for the current state of a relationship property
+     *
+     * @public
+     * @param {StableRecordIdentifier} identifier
+     * @param {String} field
+     * @return resource relationship object
+     */
+    getRelationship(identifier: StableRecordIdentifier, field: string, isCollection?: boolean): ResourceRelationship | CollectionRelationship;
+    /**
+     * Query the cache for the server state of a relationship property without any local changes
+     *
+     * @public
+     * @param {StableRecordIdentifier} identifier
+     * @param {String} field
+     * @return resource relationship object
+     */
+    getRemoteRelationship(identifier: StableRecordIdentifier, field: string, isCollection?: boolean): ResourceRelationship | CollectionRelationship;
+    /**
+     * Update the cache state for the given resource to be marked
+     * as locally deleted, or remove such a mark.
+     *
+     * This method is a candidate to become a mutation
+     *
+     * @public
+     * @param identifier
+     * @param {Boolean} isDeleted
+     */
+    setIsDeleted(identifier: StableRecordIdentifier, isDeleted: boolean): void;
+    /**
+     * Query the cache for any validation errors applicable to the given resource.
+     *
+     * @public
+     * @param identifier
+     * @return {JsonApiError[]}
+     */
+    getErrors(identifier: StableRecordIdentifier): ApiError[];
+    /**
+     * Query the cache for whether a given resource has any available data
+     *
+     * @public
+     * @param identifier
+     * @return {Boolean}
+     */
+    isEmpty(identifier: StableRecordIdentifier): boolean;
+    /**
+     * Query the cache for whether a given resource was created locally and not
+     * yet persisted.
+     *
+     * @public
+     * @param identifier
+     * @return {Boolean}
+     */
+    isNew(identifier: StableRecordIdentifier): boolean;
+    /**
+     * Query the cache for whether a given resource is marked as deleted (but not
+     * necessarily persisted yet).
+     *
+     * @public
+     * @param identifier
+     * @return {Boolean}
+     */
+    isDeleted(identifier: StableRecordIdentifier): boolean;
+    /**
+     * Query the cache for whether a given resource has been deleted and that deletion
+     * has also been persisted.
+     *
+     * @public
+     * @param identifier
+     * @return {Boolean}
+     */
+    isDeletionCommitted(identifier: StableRecordIdentifier): boolean;
+}
+//# sourceMappingURL=cache.d.ts.map

package/declarations/types/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../src/types/cache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC5F,OAAO,KAAK,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACxF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC/F,OAAO,KAAK,EAAE,gBAAgB,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,GAAG,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;AAE/E,MAAM,MAAM,gBAAgB,GACxB;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,SAAS,EAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACvC,QAAQ,EAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACtC,UAAU,EAAE,sBAAsB,EAAE,CAAC;IACrC,SAAS,EAAE,OAAO,CAAC;CACpB,GACD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,WAAW,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC3C,UAAU,EAAE,sBAAsB,GAAG,IAAI,CAAC;CAC3C,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,WAAW,KAAK;IACpB;;;;;;OAMG;IACH,OAAO,EAAE,GAAG,CAAC;IAKb;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG;QAAE,OAAO,EAAE,CAAC,CAAA;KAAE,GAAG,gBAAgB,CAAC;IAEtE;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,IAAI,CAAC;IAEzC;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,UAAU,EAAE,sBAAsB,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAC7F,IAAI,CAAC,UAAU,EAAE,wBAAwB,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,eAAe,CAAC,CAAC,GAAG,OAAO,EAAE,UAAU,EAAE,sBAAsB,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IACxG,eAAe,CAAC,UAAU,EAAE,wBAAwB,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAE/E;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,UAAU,EAAE,wBAAwB,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAE/F;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,EAAE,sBAAsB,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI,GAAG,MAAM,EAAE,CAAC;IAKpG;;;;;;;;;OASG;IACH,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAK1B;;;;;;;OAOG;IACH,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAEzC;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAKxD;;;;;;;;;OASG;IACH,eAAe,CAAC,UAAU,EAAE,sBAAsB,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnH;;;;;;OAMG;IACH,UAAU,CAAC,UAAU,EAAE,sBAAsB,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAE9E;;;;;;;;OAQG;IACH,SAAS,CAAC,UAAU,EAAE,sBAAsB,EAAE,MAAM,EAAE,sBAAsB,CAAC,OAAO,CAAC,GAAG,0BAA0B,CAAC;IAEnH;;;;;;;OAOG;IACH,iBAAiB,CAAC,UAAU,EAAE,sBAAsB,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAEjF;;;;;;;;OAQG;IACH,YAAY,CAAC,UAAU,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAKvD;;;;;;;OAOG;IACH,OAAO,CAAC,UAAU,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;IAEzF;;;;;;;OAOG;IACH,aAAa,CAAC,UAAU,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;IAE/F;;;;;;;;;OASG;IACH,OAAO,CAAC,UAAU,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAE1F;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,UAAU,EAAE,sBAAsB,GAAG,qBAAqB,CAAC;IAExE;;;;;;OAMG;IACH,eAAe,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAE7D;;;;;;;;OAQG;IACH,aAAa,CAAC,UAAU,EAAE,sBAAsB,GAAG,MAAM,EAAE,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,oBAAoB,CAAC,UAAU,EAAE,sBAAsB,GAAG,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAExF;;;;;;OAMG;IACH,uBAAuB,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAErE;;;;;;;;;;OAUG;IACH,qBAAqB,CAAC,UAAU,EAAE,sBAAsB,GAAG,MAAM,EAAE,CAAC;IAEpE;;;;;;;OAOG;IACH,eAAe,CACb,UAAU,EAAE,sBAAsB,EAClC,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,OAAO,GACrB,oBAAoB,GAAG,sBAAsB,CAAC;IAEjD;;;;;;;OAOG;IACH,qBAAqB,CACnB,UAAU,EAAE,sBAAsB,EAClC,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,OAAO,GACrB,oBAAoB,GAAG,sBAAsB,CAAC;IAKjD;;;;;;;;;OASG;IACH,YAAY,CAAC,UAAU,EAAE,sBAAsB,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3E;;;;;;OAMG;IACH,SAAS,CAAC,UAAU,EAAE,sBAAsB,GAAG,QAAQ,EAAE,CAAC;IAE1D;;;;;;OAMG;IACH,OAAO,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAErD;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAEnD;;;;;;;OAOG;IACH,SAAS,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAEvD;;;;;;;OAOG;IACH,mBAAmB,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;CAClE"}

package/declarations/types/graph.d.ts

@@ -0,0 +1,48 @@
+import type { AddToResourceRelationshipMutation as AddResourceMutation, RemoveFromResourceRelationshipMutation as RemoveResourceMutation } from './cache/mutations.ts';
+import type { AddToResourceRelationshipOperation as AddResourceOperation, RemoveFromResourceRelationshipOperation as RemoveResourceOperation, UpdateResourceRelationshipOperation } from './cache/operations.ts';
+import type { StableRecordIdentifier } from './identifier.ts';
+import type { CollectionResourceRelationship, SingleResourceRelationship } from './spec/json-api-raw.ts';
+export interface Operation {
+    op: string;
+}
+export interface UpdateRelationshipOperation {
+    op: 'updateRelationship';
+    record: StableRecordIdentifier;
+    field: string;
+    value: SingleResourceRelationship | CollectionResourceRelationship;
+}
+export interface DeleteRecordOperation {
+    op: 'deleteRecord';
+    record: StableRecordIdentifier;
+    isNew: boolean;
+}
+export interface UnknownOperation {
+    op: 'never';
+    record: StableRecordIdentifier;
+    field: string;
+}
+export interface ReplaceRelatedRecordOperation {
+    op: 'replaceRelatedRecord';
+    record: StableRecordIdentifier;
+    field: string;
+    value: StableRecordIdentifier | null;
+    prior?: StableRecordIdentifier;
+    index?: number;
+}
+export interface SortRelatedRecords {
+    op: 'sortRelatedRecords';
+    record: StableRecordIdentifier;
+    field: string;
+    value: StableRecordIdentifier[];
+}
+export interface ReplaceRelatedRecordsOperation {
+    op: 'replaceRelatedRecords';
+    record: StableRecordIdentifier;
+    field: string;
+    value: StableRecordIdentifier[];
+    prior?: StableRecordIdentifier[];
+    index?: number;
+}
+export type RemoteRelationshipOperation = UpdateResourceRelationshipOperation | UpdateRelationshipOperation | ReplaceRelatedRecordOperation | ReplaceRelatedRecordsOperation | RemoveResourceOperation | AddResourceOperation | DeleteRecordOperation | SortRelatedRecords;
+export type LocalRelationshipOperation = ReplaceRelatedRecordsOperation | ReplaceRelatedRecordOperation | AddResourceMutation | RemoveResourceMutation | SortRelatedRecords;
+//# sourceMappingURL=graph.d.ts.map

package/declarations/types/graph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph.d.ts","sourceRoot":"","sources":["../../src/types/graph.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iCAAiC,IAAI,mBAAmB,EACxD,sCAAsC,IAAI,sBAAsB,EACjE,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EACV,kCAAkC,IAAI,oBAAoB,EAC1D,uCAAuC,IAAI,uBAAuB,EAClE,mCAAmC,EACpC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,KAAK,EAAE,8BAA8B,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAEzG,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,oBAAoB,CAAC;IACzB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,0BAA0B,GAAG,8BAA8B,CAAC;CACpE;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,cAAc,CAAC;IACnB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C,EAAE,EAAE,sBAAsB,CAAC;IAC3B,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACrC,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,oBAAoB,CAAC;IACzB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,sBAAsB,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,uBAAuB,CAAC;IAC5B,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,2BAA2B,GACnC,mCAAmC,GACnC,2BAA2B,GAC3B,6BAA6B,GAC7B,8BAA8B,GAC9B,uBAAuB,GACvB,oBAAoB,GACpB,qBAAqB,GACrB,kBAAkB,CAAC;AAEvB,MAAM,MAAM,0BAA0B,GAClC,8BAA8B,GAC9B,6BAA6B,GAC7B,mBAAmB,GACnB,sBAAsB,GACtB,kBAAkB,CAAC"}

package/declarations/types/identifier.d.ts

@@ -0,0 +1,111 @@
+export declare const DEBUG_CLIENT_ORIGINATED: unique symbol;
+export declare const DEBUG_IDENTIFIER_BUCKET: unique symbol;
+export declare const DEBUG_STALE_CACHE_OWNER: unique symbol;
+export declare const CACHE_OWNER: '__$co';
+export type IdentifierBucket = 'record' | 'document';
+export interface Identifier {
+    lid: string;
+    clientId?: string;
+}
+export interface ExistingRecordIdentifier<T extends string = string> extends Identifier {
+    id: string;
+    type: T;
+}
+export interface NewRecordIdentifier<T extends string = string> extends Identifier {
+    id: string | null;
+    type: T;
+}
+export type StableDocumentIdentifier = {
+    lid: string;
+};
+export type RequestKey = StableDocumentIdentifier;
+/**
+ * An Identifier specific to a record which may or may not
+ * be present in the cache.
+ *
+ * The absence of an `id` DOES NOT indicate that this
+ * Identifier is for a new client-created record as it
+ * may also indicate that it was generated for a secondary
+ * index and the primary `id` index is not yet known.
+ *
+ * @internal
+ */
+export type RecordIdentifier<T extends string = string> = ExistingRecordIdentifier<T> | NewRecordIdentifier<T>;
+/**
+ * Used when an Identifier is known to be the stable version
+ *
+ * @internal
+ */
+export interface StableIdentifier extends Identifier {
+    [DEBUG_IDENTIFIER_BUCKET]?: string;
+}
+/**
+ * Used when a StableRecordIdentifier was not created locally as part
+ * of a call to store.createRecord
+ *
+ * Distinguishing between this Identifier and one for a client created
+ * record that was created with an ID is generally speaking not possible
+ * at runtime, so anything with an ID typically narrows to this.
+ *
+ * @internal
+ */
+export interface StableExistingRecordIdentifier<T extends string = string> extends StableIdentifier {
+    id: string;
+    type: T;
+    [DEBUG_CLIENT_ORIGINATED]?: boolean;
+    [CACHE_OWNER]: number | undefined;
+    [DEBUG_STALE_CACHE_OWNER]?: number | undefined;
+}
+/**
+ * Used when a StableRecordIdentifier was created locally
+ * (by a call to store.createRecord).
+ *
+ * It is possible in rare circumstances to have a StableRecordIdentifier
+ * that is not for a new record but does not have an ID. This would
+ * happen if a user intentionally created one for use with a secondary-index
+ * prior to the record having been fully loaded.
+ *
+ * @internal
+ */
+export interface StableNewRecordIdentifier<T extends string = string> extends StableIdentifier {
+    id: string | null;
+    type: T;
+    [DEBUG_CLIENT_ORIGINATED]?: boolean;
+    [CACHE_OWNER]: number | undefined;
+    [DEBUG_STALE_CACHE_OWNER]?: number | undefined;
+}
+/**
+ * A referentially stable object with a unique string (lid) that can be used
+ * as a reference to data in the cache.
+ *
+ * Every record instance has a unique identifier, and identifiers may refer
+ * to data that has never been loaded (for instance, in an async relationship).
+ *
+ * @class StableRecordIdentifier
+ * @public
+ */
+/**
+ * A string representing a unique identity.
+ *
+ * @property lid
+ * @type {String}
+ * @public
+ */
+/**
+ * the primary resource `type` or `modelName` this identity belongs to.
+ *
+ * @property type
+ * @type {String}
+ * @public
+ */
+/**
+ * the primary id for the record this identity belongs to. `null`
+ * if not yet assigned an id.
+ *
+ * @property id
+ * @type {String | null}
+ * @public
+ */
+export type StableRecordIdentifier<T extends string = string> = StableExistingRecordIdentifier<T> | StableNewRecordIdentifier<T>;
+export type ResourceKey<T extends string = string> = StableRecordIdentifier<T>;
+//# sourceMappingURL=identifier.d.ts.map

package/declarations/types/identifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifier.d.ts","sourceRoot":"","sources":["../../src/types/identifier.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAA8C,CAAC;AAC5F,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAAoC,CAAC;AAClF,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAAsC,CAAC;AAOpF,eAAO,MAAM,WAAW,EAAE,OAA4C,CAAC;AAEvE,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,UAAU,CAAC;AAErD,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,UAAU;IACrF,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,UAAU;IAChF,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,wBAAwB,CAAC;AAElD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,wBAAwB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAE/G;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,CAAC,uBAAuB,CAAC,CAAC,EAAE,MAAM,CAAC;CACpC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,8BAA8B,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,gBAAgB;IACjG,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC;IACR,CAAC,uBAAuB,CAAC,CAAC,EAAE,OAAO,CAAC;IACpC,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,CAAC,uBAAuB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,yBAAyB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,gBAAgB;IAC5F,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,CAAC,CAAC;IACR,CAAC,uBAAuB,CAAC,CAAC,EAAE,OAAO,CAAC;IACpC,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,CAAC,uBAAuB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;;;;;;;;GASG;AAEH;;;;;;GAMG;AACH;;;;;;GAMG;AACH;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IACxD,8BAA8B,CAAC,CAAC,CAAC,GACjC,yBAAyB,CAAC,CAAC,CAAC,CAAC;AAEjC,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,sBAAsB,CAAC,CAAC,CAAC,CAAC"}

package/declarations/types/json/raw.d.ts

@@ -0,0 +1,7 @@
+export type PrimitiveValue = string | number | boolean | null;
+export interface ObjectValue {
+    [key: string]: Value;
+}
+export type ArrayValue = Value[];
+export type Value = PrimitiveValue | ArrayValue | ObjectValue;
+//# sourceMappingURL=raw.d.ts.map

package/declarations/types/json/raw.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"raw.d.ts","sourceRoot":"","sources":["../../../src/types/json/raw.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAC9D,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC;CACtB;AACD,MAAM,MAAM,UAAU,GAAG,KAAK,EAAE,CAAC;AAEjC,MAAM,MAAM,KAAK,GAAG,cAAc,GAAG,UAAU,GAAG,WAAW,CAAC"}