@ember-data-types/store 4.13.0-alpha.1

package/unstable-preview-types/-private/caches/identifier-cache.d.ts

@@ -0,0 +1,176 @@
+declare module '@ember-data/store/-private/caches/identifier-cache' {
+  import { type Identifier, type RecordIdentifier, type StableDocumentIdentifier, type StableRecordIdentifier } from '@warp-drive/core-types/identifier';
+  import type { ImmutableRequestInfo } from '@warp-drive/core-types/request';
+  import type { ResourceIdentifierObject } from '@warp-drive/core-types/spec/json-api-raw';
+  import type { ForgetMethod, GenerationMethod, KeyInfo, KeyInfoMethod, ResetMethod, UpdateMethod } from '@ember-data/store/-types/q/identifier';
+  export function isStableIdentifier(identifier: unknown): identifier is StableRecordIdentifier;
+  export function isDocumentIdentifier(identifier: unknown): identifier is StableDocumentIdentifier;
+  interface KeyOptions {
+      lid: IdentifierMap;
+      id: IdentifierMap;
+  }
+  type TypeMap = {
+      [key: string]: KeyOptions;
+  };
+  type IdentifierMap = Map<string, StableRecordIdentifier>;
+  type StableCache = {
+      resources: IdentifierMap;
+      documents: Map<string, StableDocumentIdentifier>;
+      resourcesByType: TypeMap;
+      polymorphicLidBackMap: Map<string, string[]>;
+  };
+  export type MergeMethod = (targetIdentifier: StableRecordIdentifier, matchedIdentifier: StableRecordIdentifier, resourceData: unknown) => StableRecordIdentifier;
+  export function setIdentifierGenerationMethod(method: GenerationMethod | null): void;
+  export function setIdentifierUpdateMethod(method: UpdateMethod | null): void;
+  export function setIdentifierForgetMethod(method: ForgetMethod | null): void;
+  export function setIdentifierResetMethod(method: ResetMethod | null): void;
+  export function setKeyInfoForResource(method: KeyInfoMethod | null): void;
+  /**
+   * Each instance of {Store} receives a unique instance of a IdentifierCache.
+   *
+   * This cache is responsible for assigning or retrieving the unique identify
+   * for arbitrary resource data encountered by the store. Data representing
+   * a unique resource or record should always be represented by the same
+   * identifier.
+   *
+   * It can be configured by consuming applications.
+   *
+   * @class IdentifierCache
+     @public
+   */
+  export class IdentifierCache {
+      _cache: StableCache;
+      _generate: GenerationMethod;
+      _update: UpdateMethod;
+      _forget: ForgetMethod;
+      _reset: ResetMethod;
+      _merge: MergeMethod;
+      _keyInfoForResource: KeyInfoMethod;
+      _id: number;
+      constructor();
+      /**
+       * Internal hook to allow management of merge conflicts with identifiers.
+       *
+       * we allow late binding of this private internal merge so that
+       * the cache can insert itself here to handle elimination of duplicates
+       *
+       * @method __configureMerge
+       * @private
+       */
+      __configureMerge(method: MergeMethod | null): void;
+      upgradeIdentifier(resource: {
+          type: string;
+          id: string | null;
+          lid?: string;
+      }): StableRecordIdentifier;
+      /**
+       * @method _getRecordIdentifier
+       * @private
+       */
+      _getRecordIdentifier(resource: {
+          type: string;
+          id: string | null;
+          lid?: string;
+      }, shouldGenerate: 2): StableRecordIdentifier;
+      _getRecordIdentifier(resource: unknown, shouldGenerate: 1): StableRecordIdentifier;
+      _getRecordIdentifier(resource: unknown, shouldGenerate: 0): StableRecordIdentifier | undefined;
+      /**
+       * allows us to peek without generating when needed
+       * useful for the "create" case when we need to see if
+       * we are accidentally overwritting something
+       *
+       * @method peekRecordIdentifier
+       * @param resource
+       * @return {StableRecordIdentifier | undefined}
+       * @private
+       */
+      peekRecordIdentifier(resource: ResourceIdentifierObject | Identifier): StableRecordIdentifier | undefined;
+      /**
+        Returns the DocumentIdentifier for the given Request, creates one if it does not yet exist.
+        Returns `null` if the request does not have a `cacheKey` or `url`.
+    
+        @method getOrCreateDocumentIdentifier
+        @param request
+        @return {StableDocumentIdentifier | null}
+        @public
+      */
+      getOrCreateDocumentIdentifier(request: ImmutableRequestInfo): StableDocumentIdentifier | null;
+      /**
+        Returns the Identifier for the given Resource, creates one if it does not yet exist.
+    
+        Specifically this means that we:
+    
+        - validate the `id` `type` and `lid` combo against known identifiers
+        - return an object with an `lid` that is stable (repeated calls with the same
+          `id` + `type` or `lid` will return the same `lid` value)
+        - this referential stability of the object itself is guaranteed
+    
+        @method getOrCreateRecordIdentifier
+        @param resource
+        @return {StableRecordIdentifier}
+        @public
+      */
+      getOrCreateRecordIdentifier(resource: unknown): StableRecordIdentifier;
+      /**
+       Returns a new Identifier for the supplied data. Call this method to generate
+       an identifier when a new resource is being created local to the client and
+       potentially does not have an `id`.
+    
+       Delegates generation to the user supplied `GenerateMethod` if one has been provided
+       with the signature `generateMethod({ type }, 'record')`.
+    
+       @method createIdentifierForNewRecord
+       @param data
+       @return {StableRecordIdentifier}
+       @public
+      */
+      createIdentifierForNewRecord(data: {
+          type: string;
+          id?: string | null;
+      }): StableRecordIdentifier;
+      /**
+       Provides the opportunity to update secondary lookup tables for existing identifiers
+       Called after an identifier created with `createIdentifierForNewRecord` has been
+       committed.
+    
+       Assigned `id` to an `Identifier` if `id` has not previously existed; however,
+       attempting to change the `id` or calling update without providing an `id` when
+       one is missing will throw an error.
+    
+        - sets `id` (if `id` was previously `null`)
+        - `lid` and `type` MUST NOT be altered post creation
+    
+        If a merge occurs, it is possible the returned identifier does not match the originally
+        provided identifier. In this case the abandoned identifier will go through the usual
+        `forgetRecordIdentifier` codepaths.
+    
+        @method updateRecordIdentifier
+        @param identifierObject
+        @param data
+        @return {StableRecordIdentifier}
+        @public
+      */
+      updateRecordIdentifier(identifierObject: RecordIdentifier, data: unknown): StableRecordIdentifier;
+      /**
+       * @method _mergeRecordIdentifiers
+       * @private
+       */
+      _mergeRecordIdentifiers(keyInfo: KeyInfo, identifier: StableRecordIdentifier, existingIdentifier: StableRecordIdentifier, data: unknown): StableRecordIdentifier;
+      /**
+       Provides the opportunity to eliminate an identifier from secondary lookup tables
+       as well as eliminates it from ember-data's own lookup tables and book keeping.
+    
+       Useful when a record has been deleted and the deletion has been persisted and
+       we do not care about the record anymore. Especially useful when an `id` of a
+       deleted record might be reused later for a new record.
+    
+       @method forgetRecordIdentifier
+       @param identifierObject
+       @public
+      */
+      forgetRecordIdentifier(identifierObject: RecordIdentifier): void;
+      destroy(): void;
+  }
+  export {};
+}
+//# sourceMappingURL=identifier-cache.d.ts.map

package/unstable-preview-types/-private/caches/identifier-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifier-cache.d.ts","sourceRoot":"","sources":["../../../src/-private/caches/identifier-cache.ts"],"names":[],"mappings":"AAWA,OAAO,EAKL,KAAK,UAAU,EAEf,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAE7B,KAAK,sBAAsB,EAC5B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,KAAK,EAA0B,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AAEjH,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAChB,OAAO,EACP,aAAa,EACb,WAAW,EACX,YAAY,EACb,MAAM,2BAA2B,CAAC;AAWnC,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI,sBAAsB,CAE5F;AAED,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,OAAO,GAAG,UAAU,IAAI,wBAAwB,CAEhG;AAwBD,UAAU,UAAU;IAClB,GAAG,EAAE,aAAa,CAAC;IACnB,EAAE,EAAE,aAAa,CAAC;CACnB;AACD,KAAK,OAAO,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;CAAE,CAAC;AAI7C,KAAK,aAAa,GAAG,GAAG,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;AAEzD,KAAK,WAAW,GAAG;IACjB,SAAS,EAAE,aAAa,CAAC;IACzB,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IACjD,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,CACxB,gBAAgB,EAAE,sBAAsB,EACxC,iBAAiB,EAAE,sBAAsB,EACzC,YAAY,EAAE,OAAO,KAClB,sBAAsB,CAAC;AAE5B,wBAAgB,6BAA6B,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,GAAG,IAAI,CAEnF;AAED,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,GAAG,IAAI,CAE3E;AAED,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,GAAG,IAAI,CAE3E;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,GAAG,IAAI,CAEzE;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,GAAG,IAAI,CAExE;AA+FD;;;;;;;;;;;;GAYG;AACH,qBAAa,eAAe;IAClB,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;IACtB,OAAO,EAAE,YAAY,CAAC;IACtB,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,WAAW,CAAC;IACpB,mBAAmB,EAAE,aAAa,CAAC;IACnC,GAAG,EAAE,MAAM,CAAC;;IAsBpB;;;;;;;;OAQG;IACH,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;IAI3C,iBAAiB,CAAC,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,sBAAsB;IAItG;;;OAGG;IACH,oBAAoB,CAClB,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,EAC3D,cAAc,EAAE,CAAC,GAChB,sBAAsB;IACzB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,GAAG,sBAAsB;IAClF,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,GAAG,sBAAsB,GAAG,SAAS;IAsE9F;;;;;;;;;OASG;IACH,oBAAoB,CAAC,QAAQ,EAAE,wBAAwB,GAAG,UAAU,GAAG,sBAAsB,GAAG,SAAS;IAIzG;;;;;;;;MAQE;IACF,6BAA6B,CAAC,OAAO,EAAE,oBAAoB,GAAG,wBAAwB,GAAG,IAAI;IAyB7F;;;;;;;;;;;;;;MAcE;IACF,2BAA2B,CAAC,QAAQ,EAAE,OAAO,GAAG,sBAAsB;IAItE;;;;;;;;;;;;MAYE;IACF,4BAA4B,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,sBAAsB;IAyBhG;;;;;;;;;;;;;;;;;;;;;MAqBE;IACF,sBAAsB,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,GAAG,sBAAsB;IAoEjG;;;OAGG;IACH,uBAAuB,CACrB,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,sBAAsB,EAClC,kBAAkB,EAAE,sBAAsB,EAC1C,IAAI,EAAE,OAAO,GACZ,sBAAsB;IAoCzB;;;;;;;;;;;MAWE;IACF,sBAAsB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI;IA+BhE,OAAO;CAOR"}

package/unstable-preview-types/-private/caches/instance-cache.d.ts

@@ -0,0 +1,61 @@
+declare module '@ember-data/store/-private/caches/instance-cache' {
+  import type { Cache } from '@warp-drive/core-types/cache';
+  import type { StableRecordIdentifier } from '@warp-drive/core-types/identifier';
+  import type { Value } from '@warp-drive/core-types/json/raw';
+  import type { TypedRecordInstance, TypeFromInstance } from '@warp-drive/core-types/record';
+  import type { OpaqueRecordInstance } from '@ember-data/store/-types/q/record-instance';
+  import RecordReference from '@ember-data/store/-private/legacy-model-support/record-reference';
+  import { CacheCapabilitiesManager } from '@ember-data/store/-private/managers/cache-capabilities-manager';
+  import type { CacheManager } from '@ember-data/store/-private/managers/cache-manager';
+  import type { CreateRecordProperties, Store } from '@ember-data/store/-private/store-service';
+  export function peekRecordIdentifier(record: OpaqueRecordInstance): StableRecordIdentifier | undefined;
+  /**
+    Retrieves the unique referentially-stable [RecordIdentifier](/ember-data/release/classes/StableRecordIdentifier)
+    assigned to the given record instance.
+    ```js
+    import { recordIdentifierFor } from "@ember-data/store";
+    // ... gain access to a record, for instance with peekRecord or findRecord
+    const record = store.peekRecord("user", "1");
+    // get the identifier for the record (see docs for StableRecordIdentifier)
+    const identifier = recordIdentifierFor(record);
+    // access the identifier's properties.
+    const { id, type, lid } = identifier;
+    ```
+    @method recordIdentifierFor
+    @public
+    @static
+    @for @ember-data/store
+    @param {Object} record a record instance previously obstained from the store.
+    @return {StableRecordIdentifier}
+   */
+  export function recordIdentifierFor<T extends TypedRecordInstance>(record: T): StableRecordIdentifier<TypeFromInstance<T>>;
+  export function recordIdentifierFor(record: OpaqueRecordInstance): StableRecordIdentifier;
+  export function setRecordIdentifier(record: OpaqueRecordInstance, identifier: StableRecordIdentifier): void;
+  export const StoreMap: Map<unknown, Store>;
+  export function storeFor(record: OpaqueRecordInstance): Store | undefined;
+  type Caches = {
+      record: Map<StableRecordIdentifier, OpaqueRecordInstance>;
+      reference: WeakMap<StableRecordIdentifier, RecordReference>;
+  };
+  export class InstanceCache {
+      store: Store;
+      cache: Cache;
+      _storeWrapper: CacheCapabilitiesManager;
+      __cacheManager: CacheManager;
+      __instances: Caches;
+      constructor(store: Store);
+      peek(identifier: StableRecordIdentifier): Cache | OpaqueRecordInstance | undefined;
+      getRecord(identifier: StableRecordIdentifier, properties?: CreateRecordProperties): OpaqueRecordInstance;
+      getReference(identifier: StableRecordIdentifier): RecordReference;
+      recordIsLoaded(identifier: StableRecordIdentifier, filterDeleted?: boolean): boolean;
+      disconnect(identifier: StableRecordIdentifier): void;
+      unloadRecord(identifier: StableRecordIdentifier): void;
+      clear(type?: string): void;
+      setRecordId(identifier: StableRecordIdentifier, id: string): void;
+  }
+  export function resourceIsFullyDeleted(instanceCache: InstanceCache, identifier: StableRecordIdentifier): boolean;
+  export function preloadData(store: Store, identifier: StableRecordIdentifier, preload: Record<string, Value>): void;
+  export function _clearCaches(): void;
+  export {};
+}
+//# sourceMappingURL=instance-cache.d.ts.map

package/unstable-preview-types/-private/caches/instance-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance-cache.d.ts","sourceRoot":"","sources":["../../../src/-private/caches/instance-cache.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAChF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAA4B,MAAM,+BAA+B,CAAC;AAQrH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,eAAe,MAAM,0CAA0C,CAAC;AACvE,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAoBtE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,oBAAoB,GAAG,sBAAsB,GAAG,SAAS,CAErG;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,mBAAmB,EAC/D,MAAM,EAAE,CAAC,GACR,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/C,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,oBAAoB,GAAG,sBAAsB,CAAC;AAM1F,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,oBAAoB,EAAE,UAAU,EAAE,sBAAsB,GAAG,IAAI,CAgB1G;AAED,eAAO,MAAM,QAAQ,qBAAqE,CAAC;AAE3F,wBAAgB,QAAQ,CAAC,MAAM,EAAE,oBAAoB,GAAG,KAAK,GAAG,SAAS,CAQxE;AAED,KAAK,MAAM,GAAG;IACZ,MAAM,EAAE,GAAG,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,CAAC;IAC1D,SAAS,EAAE,OAAO,CAAC,sBAAsB,EAAE,eAAe,CAAC,CAAC;CAC7D,CAAC;AAEF,qBAAa,aAAa;IAChB,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,KAAK,CAAC;IACb,aAAa,EAAE,wBAAwB,CAAC;IAExC,cAAc,EAAE,YAAY,CAAC;IACrC,WAAW,EAAE,MAAM,CAGjB;gBAEU,KAAK,EAAE,KAAK;IAkExB,IAAI,CAAC,UAAU,EAAE,sBAAsB,GAAG,KAAK,GAAG,oBAAoB,GAAG,SAAS;IAIlF,SAAS,CAAC,UAAU,EAAE,sBAAsB,EAAE,UAAU,CAAC,EAAE,sBAAsB,GAAG,oBAAoB;IA2BxG,YAAY,CAAC,UAAU,EAAE,sBAAsB;IAW/C,cAAc,CAAC,UAAU,EAAE,sBAAsB,EAAE,aAAa,UAAQ;IAsBxE,UAAU,CAAC,UAAU,EAAE,sBAAsB;IAkB7C,YAAY,CAAC,UAAU,EAAE,sBAAsB;IAuD/C,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM;IAuBnB,WAAW,CAAC,UAAU,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM;CA+C3D;AAMD,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,aAAa,EAAE,UAAU,EAAE,sBAAsB,GAAG,OAAO,CAGhH;AAcD,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,sBAAsB,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,QAwB3G;AAiCD,wBAAgB,YAAY,SAI3B"}

package/unstable-preview-types/-private/caches/resource-utils.d.ts

@@ -0,0 +1,12 @@
+declare module '@ember-data/store/-private/caches/resource-utils' {
+  export function hasLid(resource: unknown): resource is {
+      lid: string;
+  };
+  export function hasId(resource: unknown): resource is {
+      id: string;
+  };
+  export function hasType(resource: unknown): resource is {
+      type: string;
+  };
+}
+//# sourceMappingURL=resource-utils.d.ts.map

package/unstable-preview-types/-private/caches/resource-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-utils.d.ts","sourceRoot":"","sources":["../../../src/-private/caches/resource-utils.ts"],"names":[],"mappings":"AAUA,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAErE;AAED,wBAAgB,KAAK,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAInE;AAED,wBAAgB,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAEvE"}

package/unstable-preview-types/-private/document.d.ts

@@ -0,0 +1,146 @@
+declare module '@ember-data/store/-private/document' {
+  import type { StableDocumentIdentifier } from '@warp-drive/core-types/identifier';
+  import type { RequestInfo } from '@warp-drive/core-types/request';
+  import type { Meta, PaginationLinks } from '@warp-drive/core-types/spec/json-api-raw';
+  import type { Store } from '@ember-data/store/-private/store-service';
+  /**
+   * A Document is a class that wraps the response content from a request to the API
+   * returned by `Cache.put` or `Cache.peek`, converting resource-identifiers into
+   * record instances.
+   *
+   * It is not directly instantiated by the user, and its properties should not
+   * be directly modified. Whether individual properties are mutable or not is
+   * determined by the record instance itself.
+   *
+   * @public
+   * @class Document
+   */
+  export class Document<T> {
+      #private;
+      /**
+       * The links object for this document, if any
+       *
+       * e.g.
+       *
+       * ```
+       * {
+       *   self: '/articles?page[number]=3',
+       * }
+       * ```
+       *
+       * @property links
+       * @type {object|undefined} - a links object
+       * @public
+       */
+      links?: PaginationLinks;
+      /**
+       * The primary data for this document, if any.
+       *
+       * If this document has no primary data (e.g. because it is an error document)
+       * this property will be `undefined`.
+       *
+       * For collections this will be an array of record instances,
+       * for single resource requests it will be a single record instance or null.
+       *
+       * @property data
+       * @public
+       * @type {object|Array<object>|null|undefined} - a data object
+       */
+      data?: T;
+      /**
+       * The errors returned by the API for this request, if any
+       *
+       * @property errors
+       * @public
+       * @type {object|undefined} - an errors object
+       */
+      errors?: object[];
+      /**
+       * The meta object for this document, if any
+       *
+       * @property meta
+       * @public
+       * @type {object|undefined} - a meta object
+       */
+      meta?: Meta;
+      /**
+       * The identifier associated with this document, if any
+       *
+       * @property identifier
+       * @public
+       * @type {StableDocumentIdentifier|null}
+       */
+      identifier: StableDocumentIdentifier | null;
+      constructor(store: Store, identifier: StableDocumentIdentifier | null);
+      /**
+       * Fetches the related link for this document, returning a promise that resolves
+       * with the document when the request completes. If no related link is present,
+       * will fallback to the self link if present
+       *
+       * @method fetch
+       * @public
+       * @param {object} options
+       * @return Promise<Document>
+       */
+      fetch(options?: Partial<RequestInfo<T, Document<T>>>): Promise<Document<T>>;
+      /**
+       * Fetches the next link for this document, returning a promise that resolves
+       * with the new document when the request completes, or null  if there is no
+       * next link.
+       *
+       * @method next
+       * @public
+       * @param {object} options
+       * @return Promise<Document | null>
+       */
+      next(options?: Partial<RequestInfo<T, Document<T>>>): Promise<Document<T> | null>;
+      /**
+       * Fetches the prev link for this document, returning a promise that resolves
+       * with the new document when the request completes, or null if there is no
+       * prev link.
+       *
+       * @method prev
+       * @public
+       * @param {object} options
+       * @return Promise<Document | null>
+       */
+      prev(options?: Partial<RequestInfo<T, Document<T>>>): Promise<Document<T> | null>;
+      /**
+       * Fetches the first link for this document, returning a promise that resolves
+       * with the new document when the request completes, or null if there is no
+       * first link.
+       *
+       * @method first
+       * @public
+       * @param {object} options
+       * @return Promise<Document | null>
+       */
+      first(options?: Partial<RequestInfo<T, Document<T>>>): Promise<Document<T> | null>;
+      /**
+       * Fetches the last link for this document, returning a promise that resolves
+       * with the new document when the request completes, or null if there is no
+       * last link.
+       *
+       * @method last
+       * @public
+       * @param {object} options
+       * @return Promise<Document | null>
+       */
+      last(options?: Partial<RequestInfo<T, Document<T>>>): Promise<Document<T> | null>;
+      /**
+       * Implemented for `JSON.stringify` support.
+       *
+       * Returns the JSON representation of the document wrapper.
+       *
+       * This is a shallow serialization, it does not deeply serialize
+       * the document's contents, leaving that to the individual record
+       * instances to determine how to do, if at all.
+       *
+       * @method toJSON
+       * @public
+       * @return
+       */
+      toJSON(): object;
+  }
+}
+//# sourceMappingURL=document.d.ts.map

package/unstable-preview-types/-private/document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../src/-private/document.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,KAAK,EAAQ,IAAI,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAO7C;;;;;;;;;;;GAWG;AACH,qBAAa,QAAQ,CAAC,CAAC;;IACrB;;;;;;;;;;;;;;OAcG;IACK,KAAK,CAAC,EAAE,eAAe,CAAC;IAChC;;;;;;;;;;;;OAYG;IACK,IAAI,CAAC,EAAE,CAAC,CAAC;IAEjB;;;;;;OAMG;IACK,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;;;;;OAMG;IACK,IAAI,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;;OAMG;IACK,UAAU,EAAE,wBAAwB,GAAG,IAAI,CAAC;gBAGxC,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,wBAAwB,GAAG,IAAI;IAqBrE;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAO,GAAE,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAO/E;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,GAAE,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAIrF;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,GAAE,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAIrF;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAO,GAAE,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAItF;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,GAAE,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAIrF;;;;;;;;;;;;OAYG;IACH,MAAM,IAAI,MAAM;CAiBjB"}

package/unstable-preview-types/-private/legacy-model-support/record-reference.d.ts

@@ -0,0 +1,179 @@
+declare module '@ember-data/store/-private/legacy-model-support/record-reference' {
+  import type { StableRecordIdentifier } from '@warp-drive/core-types/identifier';
+  /**
+    @module @ember-data/store
+  */
+  import type { SingleResourceDocument } from '@warp-drive/core-types/spec/json-api-raw';
+  import type { OpaqueRecordInstance } from '@ember-data/store/-types/q/record-instance';
+  import type { Store } from '@ember-data/store/-private/store-service';
+  /**
+    @module @ember-data/store
+  */
+  /**
+     A `RecordReference` is a low-level API that allows users and
+     addon authors to perform meta-operations on a record.
+  
+     @class RecordReference
+     @public
+  */
+  export default class RecordReference {
+      store: Store;
+      ___token: object;
+      ___identifier: StableRecordIdentifier;
+      _ref: number;
+      constructor(store: Store, identifier: StableRecordIdentifier);
+      destroy(): void;
+      get type(): string;
+      /**
+         The `id` of the record that this reference refers to.
+    
+         Together, the `type` and `id` properties form a composite key for
+         the identity map.
+    
+         Example
+    
+         ```javascript
+         let userRef = store.getReference('user', 1);
+    
+         userRef.id(); // '1'
+         ```
+    
+         @method id
+        @public
+         @return {String} The id of the record.
+      */
+      id(): string | null;
+      /**
+         The `identifier` of the record that this reference refers to.
+    
+         Together, the `type` and `id` properties form a composite key for
+         the identity map.
+    
+         Example
+    
+         ```javascript
+         let userRef = store.getReference('user', 1);
+    
+         userRef.identifier(); // '1'
+         ```
+    
+         @method identifier
+        @public
+         @return {String} The identifier of the record.
+      */
+      identifier(): StableRecordIdentifier;
+      /**
+         How the reference will be looked up when it is loaded. Currently
+         this always returns `identity` to signify that a record will be
+         loaded by its `type` and `id`.
+    
+         Example
+    
+         ```javascript
+         const userRef = store.getReference('user', 1);
+    
+         userRef.remoteType(); // 'identity'
+         ```
+    
+         @method remoteType
+         @public
+         @return {String} 'identity'
+      */
+      remoteType(): 'identity';
+      /**
+        This API allows you to provide a reference with new data. The
+        simplest usage of this API is similar to `store.push`: you provide a
+        normalized hash of data and the object represented by the reference
+        will update.
+    
+        If you pass a promise to `push`, Ember Data will not ask the adapter
+        for the data if another attempt to fetch it is made in the
+        interim. When the promise resolves, the underlying object is updated
+        with the new data, and the promise returned by *this function* is resolved
+        with that object.
+    
+        For example, `recordReference.push(promise)` will be resolved with a
+        record.
+    
+         Example
+    
+         ```javascript
+         let userRef = store.getReference('user', 1);
+    
+         // provide data for reference
+         userRef.push({
+           data: {
+             id: "1",
+             type: "user",
+             attributes: {
+               username: "@user"
+             }
+           }
+         }).then(function(user) {
+           userRef.value() === user;
+         });
+         ```
+    
+        @method push
+        @public
+        @param objectOrPromise a JSON:API ResourceDocument or a promise resolving to one
+        @return a promise for the value (record or relationship)
+      */
+      push(objectOrPromise: SingleResourceDocument | Promise<SingleResourceDocument>): Promise<OpaqueRecordInstance>;
+      /**
+        If the entity referred to by the reference is already loaded, it is
+        present as `reference.value`. Otherwise the value returned by this function
+        is `null`.
+    
+         Example
+    
+         ```javascript
+         let userRef = store.getReference('user', 1);
+    
+         userRef.value(); // user
+         ```
+    
+         @method value
+        @public
+         @return {Model} the record for this RecordReference
+      */
+      value(): OpaqueRecordInstance | null;
+      /**
+         Triggers a fetch for the backing entity based on its `remoteType`
+         (see `remoteType` definitions per reference type).
+    
+         Example
+    
+         ```javascript
+         let userRef = store.getReference('user', 1);
+    
+         // load user (via store.find)
+         userRef.load().then(...)
+         ```
+    
+         @method load
+        @public
+         @return {Promise<record>} the record for this RecordReference
+      */
+      load(): Promise<unknown>;
+      /**
+         Reloads the record if it is already loaded. If the record is not
+         loaded it will load the record via `store.findRecord`
+    
+         Example
+    
+         ```javascript
+         let userRef = store.getReference('user', 1);
+    
+         // or trigger a reload
+         userRef.reload().then(...)
+         ```
+    
+         @method reload
+        @public
+         @return {Promise<record>} the record for this RecordReference
+      */
+      reload(): Promise<unknown>;
+  }
+}
+//# sourceMappingURL=record-reference.d.ts.map

package/unstable-preview-types/-private/legacy-model-support/record-reference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-reference.d.ts","sourceRoot":"","sources":["../../../src/-private/legacy-model-support/record-reference.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAChF;;EAEE;AACF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAEvF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAE3E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAE9C;;EAEE;AAEF;;;;;;EAME;AACF,MAAM,CAAC,OAAO,OAAO,eAAe;IAC1B,KAAK,EAAE,KAAK,CAAC;IAErB,QAAQ,EAAG,MAAM,CAAC;IAClB,aAAa,EAAE,sBAAsB,CAAC;IAE9B,IAAI,EAAE,MAAM,CAAC;gBAET,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,sBAAsB;IAa5D,OAAO;IAIP,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;;;;;;;;;;;;;MAiBE;IACF,EAAE;IAMF;;;;;;;;;;;;;;;;;MAiBE;IACF,UAAU,IAAI,sBAAsB;IAIpC;;;;;;;;;;;;;;;;MAgBE;IACF,UAAU,IAAI,UAAU;IAIxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAsCE;IACF,IAAI,CAAC,eAAe,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAO9G;;;;;;;;;;;;;;;;MAgBE;IACF,KAAK,IAAI,oBAAoB,GAAG,IAAI;IAIpC;;;;;;;;;;;;;;;;MAgBE;IACF,IAAI;IAQJ;;;;;;;;;;;;;;;;MAgBE;IACF,MAAM;CAOP"}

package/unstable-preview-types/-private/legacy-model-support/shim-model-class.d.ts

@@ -0,0 +1,19 @@
+declare module '@ember-data/store/-private/legacy-model-support/shim-model-class' {
+  import type { TypedRecordInstance, TypeFromInstance } from '@warp-drive/core-types/record';
+  import type { LegacyAttributeField, LegacyRelationshipSchema } from '@warp-drive/core-types/schema/fields';
+  import type { KeyOrString, ModelSchema } from '@ember-data/store/-types/q/ds-model';
+  import type { Store } from '@ember-data/store/-private/store-service';
+  export function getShimClass<T>(store: Store, modelName: T extends TypedRecordInstance ? TypeFromInstance<T> : string): ShimModelClass<T>;
+  export default class ShimModelClass<T = unknown> implements ModelSchema<T> {
+      __store: Store;
+      modelName: T extends TypedRecordInstance ? TypeFromInstance<T> : string;
+      constructor(store: Store, modelName: T extends TypedRecordInstance ? TypeFromInstance<T> : string);
+      get fields(): Map<KeyOrString<T>, 'attribute' | 'belongsTo' | 'hasMany'>;
+      get attributes(): Map<KeyOrString<T>, LegacyAttributeField>;
+      get relationshipsByName(): Map<KeyOrString<T>, LegacyRelationshipSchema>;
+      eachAttribute<K extends KeyOrString<T>>(callback: (key: K, attribute: LegacyAttributeField) => void, binding?: T): void;
+      eachRelationship<K extends KeyOrString<T>>(callback: (key: K, relationship: LegacyRelationshipSchema) => void, binding?: T): void;
+      eachTransformedAttribute<K extends KeyOrString<T>>(callback: (key: K, type: string | null) => void, binding?: T): void;
+  }
+}
+//# sourceMappingURL=shim-model-class.d.ts.map

package/unstable-preview-types/-private/legacy-model-support/shim-model-class.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shim-model-class.d.ts","sourceRoot":"","sources":["../../../src/-private/legacy-model-support/shim-model-class.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAC3F,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAE3G,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAM9C,wBAAgB,YAAY,CAAC,CAAC,EAC5B,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,CAAC,SAAS,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM,GACtE,cAAc,CAAC,CAAC,CAAC,CAcnB;AAGD,MAAM,CAAC,OAAO,OAAO,cAAc,CAAC,CAAC,GAAG,OAAO,CAAE,YAAW,WAAW,CAAC,CAAC,CAAC;IAChE,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,CAAC,SAAS,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;gBACpE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,SAAS,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM;IAKjG,IAAI,MAAM,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,SAAS,CAAC,CAWvE;IAED,IAAI,UAAU,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAW1D;IAED,IAAI,mBAAmB,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAWvE;IAED,aAAa,CAAC,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,oBAAoB,KAAK,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;IAQhH,gBAAgB,CAAC,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,EACvC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,YAAY,EAAE,wBAAwB,KAAK,IAAI,EAClE,OAAO,CAAC,EAAE,CAAC;IASb,wBAAwB,CAAC,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;CAQhH"}

package/unstable-preview-types/-private/managers/cache-capabilities-manager.d.ts

@@ -0,0 +1,31 @@
+declare module '@ember-data/store/-private/managers/cache-capabilities-manager' {
+  import type { StableDocumentIdentifier, StableRecordIdentifier } from '@warp-drive/core-types/identifier';
+  import type { CacheCapabilitiesManager as StoreWrapper } from '@ember-data/store/-types/q/cache-capabilities-manager';
+  import type { SchemaService } from '@ember-data/store/-types/q/schema-service';
+  import type { IdentifierCache } from '@ember-data/store/-private/caches/identifier-cache';
+  import type { Store } from '@ember-data/store/-private/store-service';
+  import type { NotificationType } from '@ember-data/store/-private/managers/notification-manager';
+  /**
+    @module @ember-data/store
+  */
+  export interface CacheCapabilitiesManager {
+      getSchemaDefinitionService(): SchemaService;
+  }
+  export class CacheCapabilitiesManager implements StoreWrapper {
+      _willNotify: boolean;
+      _pendingNotifies: Map<StableRecordIdentifier, Set<string>>;
+      _store: Store;
+      constructor(_store: Store);
+      get identifierCache(): IdentifierCache;
+      _scheduleNotification(identifier: StableRecordIdentifier, key: string): void;
+      _flushNotifications(): void;
+      notifyChange(identifier: StableRecordIdentifier, namespace: 'added' | 'removed'): void;
+      notifyChange(identifier: StableDocumentIdentifier, namespace: 'added' | 'updated' | 'removed'): void;
+      notifyChange(identifier: StableRecordIdentifier, namespace: NotificationType, key?: string): void;
+      get schema(): SchemaService;
+      setRecordId(identifier: StableRecordIdentifier, id: string): void;
+      hasRecord(identifier: StableRecordIdentifier): boolean;
+      disconnectRecord(identifier: StableRecordIdentifier): void;
+  }
+}
+//# sourceMappingURL=cache-capabilities-manager.d.ts.map

package/unstable-preview-types/-private/managers/cache-capabilities-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache-capabilities-manager.d.ts","sourceRoot":"","sources":["../../../src/-private/managers/cache-capabilities-manager.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAE1G,OAAO,KAAK,EAAE,wBAAwB,IAAI,YAAY,EAAE,MAAM,2CAA2C,CAAC;AAC1G,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAElE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/D;;EAEE;AAEF,MAAM,WAAW,wBAAwB;IACvC,0BAA0B,IAAI,aAAa,CAAC;CAC7C;AACD,qBAAa,wBAAyB,YAAW,YAAY;IACnD,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,EAAE,GAAG,CAAC,sBAAsB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3D,MAAM,EAAE,KAAK,CAAC;gBAEV,MAAM,EAAE,KAAK;IAMzB,IAAI,eAAe,IAAI,eAAe,CAErC;IAED,qBAAqB,CAAC,UAAU,EAAE,sBAAsB,EAAE,GAAG,EAAE,MAAM;IAyBrE,mBAAmB,IAAI,IAAI;IAgB3B,YAAY,CAAC,UAAU,EAAE,sBAAsB,EAAE,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IACtF,YAAY,CAAC,UAAU,EAAE,wBAAwB,EAAE,SAAS,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,IAAI;IACpG,YAAY,CAAC,UAAU,EAAE,sBAAsB,EAAE,SAAS,EAAE,gBAAgB,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IAkBjG,IAAI,MAAM,kBAET;IAED,WAAW,CAAC,UAAU,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM;IAK1D,SAAS,CAAC,UAAU,EAAE,sBAAsB,GAAG,OAAO;IAItD,gBAAgB,CAAC,UAAU,EAAE,sBAAsB,GAAG,IAAI;CAK3D"}