@ember-data/store 5.4.0-alpha.32 → 5.4.0-alpha.34

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

@@ -1,61 +1,63 @@
-import type { RecordIdentifier, 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 { Cache } from '../../-types/q/cache';
-import type { OpaqueRecordInstance } from '../../-types/q/record-instance';
-import RecordReference from '../legacy-model-support/record-reference';
-import { CacheCapabilitiesManager } from '../managers/cache-capabilities-manager';
-import type { CacheManager } from '../managers/cache-manager';
-import type { CreateRecordProperties } from '../store-service';
-import type Store from '../store-service';
-export declare 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 declare function recordIdentifierFor<T extends TypedRecordInstance>(record: T): StableRecordIdentifier<TypeFromInstance<T>>;
-export declare function recordIdentifierFor(record: OpaqueRecordInstance): StableRecordIdentifier;
-export declare function setRecordIdentifier(record: OpaqueRecordInstance, identifier: StableRecordIdentifier): void;
-export declare const StoreMap: Map<unknown, Store>;
-export declare function storeFor(record: OpaqueRecordInstance): Store | undefined;
-type Caches = {
-    record: Map<StableRecordIdentifier, OpaqueRecordInstance>;
-    reference: WeakMap<StableRecordIdentifier, RecordReference>;
-};
-export declare class InstanceCache {
-    store: Store;
-    cache: Cache;
-    _storeWrapper: CacheCapabilitiesManager;
-    __cacheFor: (resource: RecordIdentifier) => Cache;
-    __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;
+declare module '@ember-data/store/-private/caches/instance-cache' {
+  import type { RecordIdentifier, 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 { Cache } from '@ember-data/store/-types/q/cache';
+  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 } from '@ember-data/store/-private/store-service';
+  import type Store from '@ember-data/store/-private/store-service';
+  export declare 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 declare function recordIdentifierFor<T extends TypedRecordInstance>(record: T): StableRecordIdentifier<TypeFromInstance<T>>;
+  export declare function recordIdentifierFor(record: OpaqueRecordInstance): StableRecordIdentifier;
+  export declare function setRecordIdentifier(record: OpaqueRecordInstance, identifier: StableRecordIdentifier): void;
+  export declare const StoreMap: Map<unknown, Store>;
+  export declare function storeFor(record: OpaqueRecordInstance): Store | undefined;
+  type Caches = {
+      record: Map<StableRecordIdentifier, OpaqueRecordInstance>;
+      reference: WeakMap<StableRecordIdentifier, RecordReference>;
+  };
+  export declare class InstanceCache {
+      store: Store;
+      cache: Cache;
+      _storeWrapper: CacheCapabilitiesManager;
+      __cacheFor: (resource: RecordIdentifier) => Cache;
+      __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 declare function resourceIsFullyDeleted(instanceCache: InstanceCache, identifier: StableRecordIdentifier): boolean;
+  export declare function preloadData(store: Store, identifier: StableRecordIdentifier, preload: Record<string, Value>): void;
+  export declare function _clearCaches(): void;
+  export {};
 }
-export declare function resourceIsFullyDeleted(instanceCache: InstanceCache, identifier: StableRecordIdentifier): boolean;
-export declare function preloadData(store: Store, identifier: StableRecordIdentifier, preload: Record<string, Value>): void;
-export declare function _clearCaches(): void;
-export {};
 //# sourceMappingURL=instance-cache.d.ts.map

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

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

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

@@ -1,144 +1,146 @@
-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/raw';
-import type Store from './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 declare 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>): 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>): 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>): 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>): 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>): 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;
+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/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 declare 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>): 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>): 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>): 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>): 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>): 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