@warp-drive/core-types 0.0.0-alpha.16 → 0.0.0-alpha.17

package/addon/symbols.js

@@ -18,4 +18,23 @@ const RecordStore = Symbol('Store');
  * @typedoc
  */
 const ResourceType = Symbol('$type');
-export { RecordStore, ResourceType };
+
+/**
+ * Symbol for the name of a transform.
+ *
+ * This is an optional feature that can be used by
+ * transform implementations to provide a typescript
+ * hint for the name of the transform.
+ *
+ * If not used, `attr<Transform>('name')` will
+ * allow any string name. `attr('name')` will always
+ * allow any string name.
+ *
+ * If used, `attr<Transform>('name')` will enforce
+ * that the name is the same as the transform name.
+ *
+ * @type {Symbol}
+ * @typedoc
+ */
+const TransformName = Symbol('$TransformName');
+export { RecordStore, ResourceType, TransformName };

package/addon/symbols.js.map

@@ -1 +1 @@
-{"version":3,"file":"symbols.js","sources":["../src/symbols.ts"],"sourcesContent":["/*\n * @module @warp-drive/core-types\n */\nexport const RecordStore = Symbol('Store');\n\n/**\n * Symbol for the type of a resource.\n *\n * This is an optional feature that can be used by\n * record implementations to provide a typescript\n * hint for the type of the resource.\n *\n * When used, EmberData and WarpDrive APIs can\n * take advantage of this to provide better type\n * safety and intellisense.\n *\n * @type {Symbol}\n * @typedoc\n */\nexport const ResourceType = Symbol('$type');\n"],"names":["RecordStore","Symbol","ResourceType"],"mappings":"AAAA;AACA;AACA;MACaA,WAAW,GAAGC,MAAM,CAAC,OAAO,EAAC;;AAE1C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;MACaC,YAAY,GAAGD,MAAM,CAAC,OAAO;;;;"}
+{"version":3,"file":"symbols.js","sources":["../src/symbols.ts"],"sourcesContent":["/*\n * @module @warp-drive/core-types\n */\nexport const RecordStore = Symbol('Store');\n\n/**\n * Symbol for the type of a resource.\n *\n * This is an optional feature that can be used by\n * record implementations to provide a typescript\n * hint for the type of the resource.\n *\n * When used, EmberData and WarpDrive APIs can\n * take advantage of this to provide better type\n * safety and intellisense.\n *\n * @type {Symbol}\n * @typedoc\n */\nexport const ResourceType = Symbol('$type');\n\n/**\n * Symbol for the name of a transform.\n *\n * This is an optional feature that can be used by\n * transform implementations to provide a typescript\n * hint for the name of the transform.\n *\n * If not used, `attr<Transform>('name')` will\n * allow any string name. `attr('name')` will always\n * allow any string name.\n *\n * If used, `attr<Transform>('name')` will enforce\n * that the name is the same as the transform name.\n *\n * @type {Symbol}\n * @typedoc\n */\nexport const TransformName = Symbol('$TransformName');\n"],"names":["RecordStore","Symbol","ResourceType","TransformName"],"mappings":"AAAA;AACA;AACA;MACaA,WAAW,GAAGC,MAAM,CAAC,OAAO,EAAC;;AAE1C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;MACaC,YAAY,GAAGD,MAAM,CAAC,OAAO,EAAC;;AAE3C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;MACaE,aAAa,GAAGF,MAAM,CAAC,gBAAgB;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive/core-types",
-  "version": "0.0.0-alpha.16",
+  "version": "0.0.0-alpha.17",
   "description": "Provides core logic, utils and types for WarpDrive and EmberData",
   "keywords": [
     "ember-addon"
@@ -15,13 +15,14 @@
   "files": [
     "addon",
     "addon-main.cjs",
+    "unstable-preview-types",
     "README.md",
     "LICENSE.md",
     "NCC-1701-a.svg",
     "NCC-1701-a-blue.svg"
   ],
   "dependencies": {
-    "@ember-data/private-build-infra": "5.4.0-alpha.30",
+    "@ember-data/private-build-infra": "5.4.0-alpha.31",
     "ember-cli-babel": "^8.2.0",
     "pnpm-sync-dependencies-meta-injected": "0.0.10"
   },
@@ -45,7 +46,7 @@
     "@glimmer/component": "^1.1.2",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@warp-drive/internal-config": "5.4.0-alpha.30",
+    "@warp-drive/internal-config": "5.4.0-alpha.31",
     "ember-source": "~5.6.0",
     "rollup": "^4.9.6",
     "typescript": "^5.3.3",
@@ -69,7 +70,7 @@
   },
   "scripts": {
     "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
-    "build:types": "echo \"Types are private\" && exit 0",
+    "build:types": "tsc --build",
     "build:client": "rollup --config && babel ./addon --out-dir addon --plugins=../private-build-infra/src/transforms/babel-plugin-transform-ext.js",
     "_build": "bun run build:client && bun run build:types",
     "_syncPnpm": "bun run sync-dependencies-meta-injected"

package/unstable-preview-types/cache/aliases.d.ts

@@ -0,0 +1,2 @@
+export type ResourceBlob = unknown;
+//# sourceMappingURL=aliases.d.ts.map

package/unstable-preview-types/cache/aliases.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aliases.d.ts","sourceRoot":"","sources":["../../src/cache/aliases.ts"],"names":[],"mappings":"AAWA,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC"}

package/unstable-preview-types/cache/change.d.ts

@@ -0,0 +1,7 @@
+import type { StableDocumentIdentifier, StableRecordIdentifier } from '../identifier';
+export interface Change {
+    identifier: StableRecordIdentifier | StableDocumentIdentifier;
+    op: 'upsert' | 'remove';
+    patch?: unknown;
+}
+//# sourceMappingURL=change.d.ts.map

package/unstable-preview-types/cache/change.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"change.d.ts","sourceRoot":"","sources":["../../src/cache/change.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAEtF,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,sBAAsB,GAAG,wBAAwB,CAAC;IAC9D,EAAE,EAAE,QAAQ,GAAG,QAAQ,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB"}

package/unstable-preview-types/cache/mutations.d.ts

@@ -0,0 +1,39 @@
+import type { StableRecordIdentifier } from '../identifier';
+export interface AddToRelatedRecordsMutation {
+    op: 'addToRelatedRecords';
+    record: StableRecordIdentifier;
+    field: string;
+    value: StableRecordIdentifier | StableRecordIdentifier[];
+    index?: number;
+}
+export interface RemoveFromRelatedRecordsMutation {
+    op: 'removeFromRelatedRecords';
+    record: StableRecordIdentifier;
+    field: string;
+    value: StableRecordIdentifier | StableRecordIdentifier[];
+    index?: number;
+}
+export interface ReplaceRelatedRecordMutation {
+    op: 'replaceRelatedRecord';
+    record: StableRecordIdentifier;
+    field: string;
+    value: StableRecordIdentifier | null;
+    prior?: StableRecordIdentifier;
+    index?: number;
+}
+export interface ReplaceRelatedRecordsMutation {
+    op: 'replaceRelatedRecords';
+    record: StableRecordIdentifier;
+    field: string;
+    value: StableRecordIdentifier[];
+    prior?: StableRecordIdentifier[];
+    index?: number;
+}
+export interface SortRelatedRecordsMutation {
+    op: 'sortRelatedRecords';
+    record: StableRecordIdentifier;
+    field: string;
+    value: StableRecordIdentifier[];
+}
+export type Mutation = ReplaceRelatedRecordsMutation | ReplaceRelatedRecordMutation | RemoveFromRelatedRecordsMutation | AddToRelatedRecordsMutation | SortRelatedRecordsMutation;
+//# sourceMappingURL=mutations.d.ts.map

package/unstable-preview-types/cache/mutations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/cache/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAE5D,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,qBAAqB,CAAC;IAC1B,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,CAAC;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gCAAgC;IAC/C,EAAE,EAAE,0BAA0B,CAAC;IAC/B,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,CAAC;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,4BAA4B;IAC3C,EAAE,EAAE,sBAAsB,CAAC;IAC3B,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IAEd,KAAK,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAGrC,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C,EAAE,EAAE,uBAAuB,CAAC;IAC5B,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IAGd,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAGhC,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAGjC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,oBAAoB,CAAC;IACzB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,sBAAsB,EAAE,CAAC;CACjC;AAgBD,MAAM,MAAM,QAAQ,GAChB,6BAA6B,GAC7B,4BAA4B,GAC5B,gCAAgC,GAChC,2BAA2B,GAC3B,0BAA0B,CAAC"}

package/unstable-preview-types/cache/operations.d.ts

@@ -0,0 +1,15 @@
+import type { StableRecordIdentifier } from '../identifier';
+export interface Op {
+    op: string;
+}
+export interface MergeOperation extends Op {
+    op: 'mergeIdentifiers';
+    record: StableRecordIdentifier;
+    value: StableRecordIdentifier;
+}
+export interface RemoveOperation extends Op {
+    op: 'removeIdentifier';
+    record: StableRecordIdentifier;
+}
+export type Operation = MergeOperation | RemoveOperation;
+//# sourceMappingURL=operations.d.ts.map

package/unstable-preview-types/cache/operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../../src/cache/operations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAE5D,MAAM,WAAW,EAAE;IACjB,EAAE,EAAE,MAAM,CAAC;CACZ;AAUD,MAAM,WAAW,cAAe,SAAQ,EAAE;IACxC,EAAE,EAAE,kBAAkB,CAAC;IAEvB,MAAM,EAAE,sBAAsB,CAAC;IAE/B,KAAK,EAAE,sBAAsB,CAAC;CAC/B;AAED,MAAM,WAAW,eAAgB,SAAQ,EAAE;IACzC,EAAE,EAAE,kBAAkB,CAAC;IACvB,MAAM,EAAE,sBAAsB,CAAC;CAChC;AAMD,MAAM,MAAM,SAAS,GAAG,cAAc,GAAG,eAAe,CAAC"}

package/unstable-preview-types/cache/relationship.d.ts

@@ -0,0 +1,14 @@
+import type { StableRecordIdentifier } from '../identifier';
+import type { Links, Meta, PaginationLinks } from '../spec/raw';
+export interface ResourceRelationship {
+    data?: StableRecordIdentifier | null;
+    meta?: Meta;
+    links?: Links;
+}
+export interface CollectionRelationship {
+    data?: StableRecordIdentifier[];
+    meta?: Meta;
+    links?: PaginationLinks;
+}
+export type Relationship = ResourceRelationship | CollectionRelationship;
+//# sourceMappingURL=relationship.d.ts.map

package/unstable-preview-types/cache/relationship.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relationship.d.ts","sourceRoot":"","sources":["../../src/cache/relationship.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAGhE,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACrC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAID,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAChC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG,sBAAsB,CAAC"}

package/unstable-preview-types/cache.d.ts

@@ -0,0 +1,475 @@
+/**
+ * @module @ember-data/experimental-preview-types
+ */
+import type { ResourceBlob } from './cache/aliases';
+import type { Change } from './cache/change';
+import type { Mutation } from './cache/mutations';
+import type { Operation } from './cache/operations';
+import type { CollectionRelationship, ResourceRelationship } from './cache/relationship';
+import type { StableDocumentIdentifier, StableRecordIdentifier } from './identifier';
+import type { Value } from './json/raw';
+import type { RequestContext, StructuredDataDocument, StructuredDocument } from './request';
+import type { ResourceDocument, SingleResourceDataDocument } from './spec/document';
+import type { ApiError } from './spec/error';
+/**
+ * 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 EmberData 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.
+     *
+     * @method put
+     * @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.
+     *
+     * Note: currently the only valid resource operation is a MergeOperation
+     * which occurs when a collision of identifiers is detected.
+     *
+     * @method patch
+     * @public
+     * @param {Operation} op the operation to perform
+     * @return {void}
+     */
+    patch(op: Operation): void;
+    /**
+     * Update the "local" or "current" (unpersisted) state of the Cache
+     *
+     * @method mutate
+     * @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.
+     *
+     * @method peek
+     * @public
+     * @param {StableRecordIdentifier | StableDocumentIdentifier} identifier
+     * @return {ResourceDocument | ResourceBlob | null} the known resource data
+     */
+    peek(identifier: StableRecordIdentifier): ResourceBlob | null;
+    peek(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`.
+     *
+     * @method peekRequest
+     * @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
+     *
+     * @method upsert
+     * @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.
+     *
+     * @method fork
+     * @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.
+     *
+     * @method merge
+     * @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;
+     * }
+     * ```
+     *
+     * @method diff
+     * @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`.
+     *
+     * @method dump
+     * @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.
+     *
+     * @method hydrate
+     * @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.
+     *
+     * @method clientDidCreate
+     * @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.
+     *
+     * @method willCommit
+     * @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.
+     *
+     * @method didCommit
+     * @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.
+     *
+     * @method commitWasRejected
+     * @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
+     *
+     * @method unloadRecord
+     * @public
+     * @param identifier
+     */
+    unloadRecord(identifier: StableRecordIdentifier): void;
+    /**
+     * Retrieve the data for an attribute from the cache
+     *
+     * @method getAttr
+     * @public
+     * @param identifier
+     * @param field
+     * @return {unknown}
+     */
+    getAttr(identifier: StableRecordIdentifier, field: string): Value | undefined;
+    /**
+     * Mutate the data for an attribute in the cache
+     *
+     * This method is a candidate to become a mutation
+     *
+     * @method setAttr
+     * @public
+     * @param identifier
+     * @param field
+     * @param value
+     */
+    setAttr(identifier: StableRecordIdentifier, field: 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>] }
+     * ```
+     *
+     * @method changedAttrs
+     * @public
+     * @param identifier
+     * @return {Record<string, [unknown, unknown]>} { <field>: [<old>, <new>] }
+     */
+    changedAttrs(identifier: StableRecordIdentifier): ChangedAttributesHash;
+    /**
+     * Query the cache for whether any mutated attributes exist
+     *
+     * @method hasChangedAttrs
+     * @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
+     *
+     * @method rollbackAttrs
+     * @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;
+      };
+      ```
+     *
+     * @method changedRelationships
+     * @public
+     * @param {StableRecordIdentifier} identifier
+     * @return {Map<string, RelationshipDiff>}
+     */
+    changedRelationships(identifier: StableRecordIdentifier): Map<string, RelationshipDiff>;
+    /**
+     * Query the cache for whether any mutated attributes exist
+     *
+     * @method hasChangedRelationships
+     * @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
+     *
+     * @method rollbackRelationships
+     * @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
+     *
+     * @method getRelationship
+     * @public
+     * @param {StableRecordIdentifier} identifier
+     * @param {string} field
+     * @return resource relationship object
+     */
+    getRelationship(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
+     *
+     * @method setIsDeleted
+     * @public
+     * @param identifier
+     * @param isDeleted {boolean}
+     */
+    setIsDeleted(identifier: StableRecordIdentifier, isDeleted: boolean): void;
+    /**
+     * Query the cache for any validation errors applicable to the given resource.
+     *
+     * @method getErrors
+     * @public
+     * @param identifier
+     * @return {JsonApiError[]}
+     */
+    getErrors(identifier: StableRecordIdentifier): ApiError[];
+    /**
+     * Query the cache for whether a given resource has any available data
+     *
+     * @method isEmpty
+     * @public
+     * @param identifier
+     * @return {boolean}
+     */
+    isEmpty(identifier: StableRecordIdentifier): boolean;
+    /**
+     * Query the cache for whether a given resource was created locally and not
+     * yet persisted.
+     *
+     * @method isNew
+     * @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).
+     *
+     * @method isDeleted
+     * @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.
+     *
+     * @method isDeletionCommitted
+     * @public
+     * @param identifier
+     * @return {boolean}
+     */
+    isDeletionCommitted(identifier: StableRecordIdentifier): boolean;
+}
+//# sourceMappingURL=cache.d.ts.map

package/unstable-preview-types/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACzF,OAAO,KAAK,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACrF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC5F,OAAO,KAAK,EAAE,gBAAgB,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AACpF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;;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;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG;QAAE,OAAO,EAAE,CAAC,CAAA;KAAE,GAAG,gBAAgB,CAAC;IAEtE;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,EAAE,SAAS,GAAG,IAAI,CAAC;IAE3B;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CAAC,UAAU,EAAE,sBAAsB,GAAG,YAAY,GAAG,IAAI,CAAC;IAC9D,IAAI,CAAC,UAAU,EAAE,wBAAwB,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAEpE;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,UAAU,EAAE,wBAAwB,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAE/F;;;;;;;;;OASG;IACH,MAAM,CAAC,UAAU,EAAE,sBAAsB,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI,GAAG,MAAM,EAAE,CAAC;IAKpG;;;;;;;;;;OAUG;IACH,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAEvB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAK1B;;;;;;;;OAQG;IACH,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAEzC;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAKxD;;;;;;;;;;OAUG;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;;;;;;;OAOG;IACH,UAAU,CAAC,UAAU,EAAE,sBAAsB,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAE9E;;;;;;;;;OASG;IACH,SAAS,CAAC,UAAU,EAAE,sBAAsB,EAAE,MAAM,EAAE,sBAAsB,CAAC,OAAO,CAAC,GAAG,0BAA0B,CAAC;IAEnH;;;;;;;;OAQG;IACH,iBAAiB,CAAC,UAAU,EAAE,sBAAsB,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAEjF;;;;;;;;;OASG;IACH,YAAY,CAAC,UAAU,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAKvD;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAU,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;IAE9E;;;;;;;;;;OAUG;IACH,OAAO,CAAC,UAAU,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAE/E;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,UAAU,EAAE,sBAAsB,GAAG,qBAAqB,CAAC;IAExE;;;;;;;OAOG;IACH,eAAe,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAE7D;;;;;;;;;OASG;IACH,aAAa,CAAC,UAAU,EAAE,sBAAsB,GAAG,MAAM,EAAE,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,oBAAoB,CAAC,UAAU,EAAE,sBAAsB,GAAG,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAExF;;;;;;;OAOG;IACH,uBAAuB,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAErE;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,UAAU,EAAE,sBAAsB,GAAG,MAAM,EAAE,CAAC;IAEpE;;;;;;;;OAQG;IACH,eAAe,CACb,UAAU,EAAE,sBAAsB,EAClC,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,OAAO,GACrB,oBAAoB,GAAG,sBAAsB,CAAC;IAKjD;;;;;;;;;;OAUG;IACH,YAAY,CAAC,UAAU,EAAE,sBAAsB,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3E;;;;;;;OAOG;IACH,SAAS,CAAC,UAAU,EAAE,sBAAsB,GAAG,QAAQ,EAAE,CAAC;IAE1D;;;;;;;OAOG;IACH,OAAO,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAErD;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAEnD;;;;;;;;OAQG;IACH,SAAS,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAEvD;;;;;;;;OAQG;IACH,mBAAmB,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAAC;CAClE"}