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

package/unstable-preview-types/-types/q/identifier.d.ts

@@ -1,169 +1,171 @@
-/**
-  @module @ember-data/store
-*/
-import type { ImmutableRequestInfo } from '@ember-data/request';
-import type { IdentifierBucket, StableIdentifier, StableRecordIdentifier } from '@warp-drive/core-types/identifier';
-import type { ExistingResourceObject, ResourceIdentifierObject } from '@warp-drive/core-types/spec/raw';
-export type ResourceData = ResourceIdentifierObject | ExistingResourceObject;
-/**
-  Configures how unique identifier lid strings are generated by @ember-data/store.
-
-  This configuration MUST occur prior to the store instance being created.
-
-  Takes a method which can expect to receive various data as its first argument
-  and the name of a bucket as its second argument.
-
-  Currently there are two buckets, 'record' and 'document'.
-
-  ### Resource (`Record`) Identity
-
-  If the bucket is `record` the method must return a unique (to at-least
-  the given bucket) string identifier for the given data as a string to be
-  used as the `lid` of an `Identifier` token.
-
-  This method will only be called by either `getOrCreateRecordIdentifier` or
-  `createIdentifierForNewRecord` when an identifier for the supplied data
-  is not already known via `lid` or `type + id` combo and one needs to be
-  generated or retrieved from a proprietary cache.
-
-  `data` will be the same data argument provided to `getOrCreateRecordIdentifier`
-  and in the `createIdentifierForNewRecord` case will be an object with
-  only `type` as a key.
-
-  ```ts
-  import { setIdentifierGenerationMethod } from '@ember-data/store';
-
-  export function initialize(applicationInstance) {
-    // note how `count` here is now scoped to the application instance
-    // for our generation method by being inside the closure provided
-    // by the initialize function
-    let count = 0;
-
-    setIdentifierGenerationMethod((resource, bucket) => {
-      return resource.lid || `my-key-${count++}`;
-    });
+declare module '@ember-data/store/-types/q/identifier' {
+  /**
+    @module @ember-data/store
+  */
+  import type { ImmutableRequestInfo } from '@ember-data/request';
+  import type { IdentifierBucket, StableIdentifier, StableRecordIdentifier } from '@warp-drive/core-types/identifier';
+  import type { ExistingResourceObject, ResourceIdentifierObject } from '@warp-drive/core-types/spec/raw';
+  export type ResourceData = ResourceIdentifierObject | ExistingResourceObject;
+  /**
+    Configures how unique identifier lid strings are generated by @ember-data/store.
+  
+    This configuration MUST occur prior to the store instance being created.
+  
+    Takes a method which can expect to receive various data as its first argument
+    and the name of a bucket as its second argument.
+  
+    Currently there are two buckets, 'record' and 'document'.
+  
+    ### Resource (`Record`) Identity
+  
+    If the bucket is `record` the method must return a unique (to at-least
+    the given bucket) string identifier for the given data as a string to be
+    used as the `lid` of an `Identifier` token.
+  
+    This method will only be called by either `getOrCreateRecordIdentifier` or
+    `createIdentifierForNewRecord` when an identifier for the supplied data
+    is not already known via `lid` or `type + id` combo and one needs to be
+    generated or retrieved from a proprietary cache.
+  
+    `data` will be the same data argument provided to `getOrCreateRecordIdentifier`
+    and in the `createIdentifierForNewRecord` case will be an object with
+    only `type` as a key.
+  
+    ```ts
+    import { setIdentifierGenerationMethod } from '@ember-data/store';
+  
+    export function initialize(applicationInstance) {
+      // note how `count` here is now scoped to the application instance
+      // for our generation method by being inside the closure provided
+      // by the initialize function
+      let count = 0;
+  
+      setIdentifierGenerationMethod((resource, bucket) => {
+        return resource.lid || `my-key-${count++}`;
+      });
+    }
+  
+    export default {
+      name: 'configure-ember-data-identifiers',
+      initialize
+    };
+    ```
+  
+    ### Document Identity
+  
+    If the bucket is `document` the method will receive the associated
+    immutable `request` passed to `store.request` as its first argument
+    and should return a unique string for the given request if the document
+    should be cached, and `null` if it should not be cached.
+  
+    Note, the request result will still be passed to the cache via `Cache.put`,
+    but caches should take this as a signal that the document should not itself
+    be cached, while its contents may still be used to update other cache state.
+  
+    The presence of `cacheOptions.key` on the request will take precedence
+    for the document cache key, and this method will not be called if it is
+    present.
+  
+    The default method implementation for this bucket is to return `null`
+    for all requests whose method is not `GET`, and to return the `url` for
+    those where it is.
+  
+    This means that queries via `POST` MUST provide `cacheOptions.key` or
+    implement this hook.
+  
+    ⚠️ Caution: Requests that do not have a `method` assigned are assumed to be `GET`
+  
+    @method setIdentifierGenerationMethod
+    @for @ember-data/store
+    @param method
+    @public
+    @static
+  */
+  export interface GenerationMethod {
+      (data: ImmutableRequestInfo, bucket: 'document'): string | null;
+      (data: unknown | {
+          type: string;
+      }, bucket: 'record'): string;
+      (data: unknown, bucket: IdentifierBucket): string | null;
   }
-
-  export default {
-    name: 'configure-ember-data-identifiers',
-    initialize
+  /**
+   Configure a callback for when the identifier cache encounters new resource
+   data for an existing resource.
+  
+   This configuration MUST occur prior to the store instance being created.
+  
+   ```js
+   import { setIdentifierUpdateMethod } from '@ember-data/store';
+   ```
+  
+   Takes a method which can expect to receive an existing `Identifier` alongside
+   some new data to consider as a second argument. This is an opportunity
+   for secondary lookup tables and caches associated with the identifier
+   to be amended.
+  
+   This method is called everytime `updateRecordIdentifier` is called and
+    with the same arguments. It provides the opportunity to update secondary
+    lookup tables for existing identifiers.
+  
+   It will always be called after an identifier created with `createIdentifierForNewRecord`
+    has been committed, or after an update to the `record` a `RecordIdentifier`
+    is assigned to has been committed. Committed here meaning that the server
+    has acknowledged the update (for instance after a call to `.save()`)
+  
+   If `id` has not previously existed, it will be assigned to the `Identifier`
+    prior to this `UpdateMethod` being called; however, calls to the parent method
+    `updateRecordIdentifier` that attempt to change the `id` or calling update
+    without providing an `id` when one is missing will throw an error.
+  
+    @method setIdentifierUpdateMethod
+    @for @ember-data/store
+    @param method
+    @public
+    @static
+  */
+  export type UpdateMethod = {
+      (identifier: StableRecordIdentifier, newData: unknown, bucket: 'record'): void;
+      (identifier: StableIdentifier, newData: unknown, bucket: never): void;
   };
-  ```
-
-  ### Document Identity
-
-  If the bucket is `document` the method will receive the associated
-  immutable `request` passed to `store.request` as its first argument
-  and should return a unique string for the given request if the document
-  should be cached, and `null` if it should not be cached.
-
-  Note, the request result will still be passed to the cache via `Cache.put`,
-  but caches should take this as a signal that the document should not itself
-  be cached, while its contents may still be used to update other cache state.
-
-  The presence of `cacheOptions.key` on the request will take precedence
-  for the document cache key, and this method will not be called if it is
-  present.
-
-  The default method implementation for this bucket is to return `null`
-  for all requests whose method is not `GET`, and to return the `url` for
-  those where it is.
-
-  This means that queries via `POST` MUST provide `cacheOptions.key` or
-  implement this hook.
-
-  ⚠️ Caution: Requests that do not have a `method` assigned are assumed to be `GET`
-
-  @method setIdentifierGenerationMethod
-  @for @ember-data/store
-  @param method
-  @public
-  @static
-*/
-export interface GenerationMethod {
-    (data: ImmutableRequestInfo, bucket: 'document'): string | null;
-    (data: unknown | {
-        type: string;
-    }, bucket: 'record'): string;
-    (data: unknown, bucket: IdentifierBucket): string | null;
+  /**
+   Configure a callback for when the identifier cache is going to release an identifier.
+  
+   This configuration MUST occur prior to the store instance being created.
+  
+   ```js
+   import { setIdentifierForgetMethod } from '@ember-data/store';
+   ```
+  
+   Takes method which can expect to receive an existing `Identifier` that should be eliminated
+   from any secondary lookup tables or caches that the user has populated for it.
+  
+    @method setIdentifierForgetMethod
+    @for @ember-data/store
+    @param method
+    @public
+    @static
+  */
+  export type ForgetMethod = (identifier: StableIdentifier | StableRecordIdentifier, bucket: IdentifierBucket) => void;
+  /**
+   Configure a callback for when the identifier cache is being torn down.
+  
+   This configuration MUST occur prior to the store instance being created.
+  
+   ```js
+   import { setIdentifierResetMethod } from '@ember-data/store';
+   ```
+  
+   Takes a method which can expect to be called when the parent application is destroyed.
+  
+   If you have properly used a WeakMap to encapsulate the state of your customization
+   to the application instance, you may not need to implement the `resetMethod`.
+  
+    @method setIdentifierResetMethod
+    @for @ember-data/store
+    @param method
+    @public
+    @static
+  */
+  export type ResetMethod = () => void;
 }
-/**
- Configure a callback for when the identifier cache encounters new resource
- data for an existing resource.
-
- This configuration MUST occur prior to the store instance being created.
-
- ```js
- import { setIdentifierUpdateMethod } from '@ember-data/store';
- ```
-
- Takes a method which can expect to receive an existing `Identifier` alongside
- some new data to consider as a second argument. This is an opportunity
- for secondary lookup tables and caches associated with the identifier
- to be amended.
-
- This method is called everytime `updateRecordIdentifier` is called and
-  with the same arguments. It provides the opportunity to update secondary
-  lookup tables for existing identifiers.
-
- It will always be called after an identifier created with `createIdentifierForNewRecord`
-  has been committed, or after an update to the `record` a `RecordIdentifier`
-  is assigned to has been committed. Committed here meaning that the server
-  has acknowledged the update (for instance after a call to `.save()`)
-
- If `id` has not previously existed, it will be assigned to the `Identifier`
-  prior to this `UpdateMethod` being called; however, calls to the parent method
-  `updateRecordIdentifier` that attempt to change the `id` or calling update
-  without providing an `id` when one is missing will throw an error.
-
-  @method setIdentifierUpdateMethod
-  @for @ember-data/store
-  @param method
-  @public
-  @static
-*/
-export type UpdateMethod = {
-    (identifier: StableRecordIdentifier, newData: unknown, bucket: 'record'): void;
-    (identifier: StableIdentifier, newData: unknown, bucket: never): void;
-};
-/**
- Configure a callback for when the identifier cache is going to release an identifier.
-
- This configuration MUST occur prior to the store instance being created.
-
- ```js
- import { setIdentifierForgetMethod } from '@ember-data/store';
- ```
-
- Takes method which can expect to receive an existing `Identifier` that should be eliminated
- from any secondary lookup tables or caches that the user has populated for it.
-
-  @method setIdentifierForgetMethod
-  @for @ember-data/store
-  @param method
-  @public
-  @static
-*/
-export type ForgetMethod = (identifier: StableIdentifier | StableRecordIdentifier, bucket: IdentifierBucket) => void;
-/**
- Configure a callback for when the identifier cache is being torn down.
-
- This configuration MUST occur prior to the store instance being created.
-
- ```js
- import { setIdentifierResetMethod } from '@ember-data/store';
- ```
-
- Takes a method which can expect to be called when the parent application is destroyed.
-
- If you have properly used a WeakMap to encapsulate the state of your customization
- to the application instance, you may not need to implement the `resetMethod`.
-
-  @method setIdentifierResetMethod
-  @for @ember-data/store
-  @param method
-  @public
-  @static
-*/
-export type ResetMethod = () => void;
 //# sourceMappingURL=identifier.d.ts.map

package/unstable-preview-types/-types/q/promise-proxies.d.ts

@@ -1,2 +1,4 @@
-export type PromiseProxy<T> = Promise<T>;
+declare module '@ember-data/store/-types/q/promise-proxies' {
+  export type PromiseProxy<T> = Promise<T>;
+}
 //# sourceMappingURL=promise-proxies.d.ts.map

package/unstable-preview-types/-types/q/record-data-json-api.d.ts

@@ -1,34 +1,36 @@
-import type { Value } from '@warp-drive/core-types/json/raw';
-import type { CollectionResourceRelationship, Link, Links, Meta, SingleResourceRelationship } from '@warp-drive/core-types/spec/raw';
-/**
-  @module @ember-data/store
-*/
-export type AttributesHash = Record<string, Value>;
-export interface JsonApiResource {
-    id?: string | null;
-    type?: string;
-    lid?: string;
-    attributes?: AttributesHash;
-    relationships?: Record<string, SingleResourceRelationship | CollectionResourceRelationship>;
-    meta?: Meta;
-    links?: Links;
+declare module '@ember-data/store/-types/q/record-data-json-api' {
+  import type { Value } from '@warp-drive/core-types/json/raw';
+  import type { CollectionResourceRelationship, Link, Links, Meta, SingleResourceRelationship } from '@warp-drive/core-types/spec/raw';
+  /**
+    @module @ember-data/store
+  */
+  export type AttributesHash = Record<string, Value>;
+  export interface JsonApiResource {
+      id?: string | null;
+      type?: string;
+      lid?: string;
+      attributes?: AttributesHash;
+      relationships?: Record<string, SingleResourceRelationship | CollectionResourceRelationship>;
+      meta?: Meta;
+      links?: Links;
+  }
+  export interface JsonApiError {
+      id?: string;
+      title?: string;
+      detail?: string;
+      links?: {
+          about?: Link;
+          type?: Link;
+      };
+      status?: string;
+      code?: string;
+      source?: {
+          pointer: string;
+          parameter?: string;
+          header?: string;
+      };
+      meta?: Meta;
+  }
+  export type JsonApiRelationship = SingleResourceRelationship | CollectionResourceRelationship;
 }
-export interface JsonApiError {
-    id?: string;
-    title?: string;
-    detail?: string;
-    links?: {
-        about?: Link;
-        type?: Link;
-    };
-    status?: string;
-    code?: string;
-    source?: {
-        pointer: string;
-        parameter?: string;
-        header?: string;
-    };
-    meta?: Meta;
-}
-export type JsonApiRelationship = SingleResourceRelationship | CollectionResourceRelationship;
 //# sourceMappingURL=record-data-json-api.d.ts.map

package/unstable-preview-types/-types/q/record-instance.d.ts

@@ -1,27 +1,29 @@
-/**
-  @module @ember-data/store
-*/
-/**
-  In EmberData, a "record instance" is a class instance used to present the data
-  for a single resource, transforming the resource's cached raw data into a form
-  that is useful for the application.
-
-  Since every application's needs are different, EmberData does not assume to know
-  what the shape of the record instance should be. Instead, it provides a way to
-  define the record instance's via the `instantiateRecord` hook on the store.
-
-  Thus for most purposes the `RecordInstance` type is "opaque" to EmberData, and
-  should be treated as "unknown" by the library.
-
-  Wherever possible, if typing an API that is consumer facing, instead of using
-  OpaqueRecordInstance, we should prefer to use a generic and check if the generic
-  extends `TypedRecordInstance`. This allows consumers to define their own record
-  instance types and not only have their types flow through EmberData APIs, but
-  also allows EmberData to provide typechecking and intellisense for the record
-  based on a special symbol prsent on record instances that implement the
-  `TypedRecordInstance` interface.
-
-  @typedoc
-*/
-export type OpaqueRecordInstance = unknown;
+declare module '@ember-data/store/-types/q/record-instance' {
+  /**
+    @module @ember-data/store
+  */
+  /**
+    In EmberData, a "record instance" is a class instance used to present the data
+    for a single resource, transforming the resource's cached raw data into a form
+    that is useful for the application.
+  
+    Since every application's needs are different, EmberData does not assume to know
+    what the shape of the record instance should be. Instead, it provides a way to
+    define the record instance's via the `instantiateRecord` hook on the store.
+  
+    Thus for most purposes the `RecordInstance` type is "opaque" to EmberData, and
+    should be treated as "unknown" by the library.
+  
+    Wherever possible, if typing an API that is consumer facing, instead of using
+    OpaqueRecordInstance, we should prefer to use a generic and check if the generic
+    extends `TypedRecordInstance`. This allows consumers to define their own record
+    instance types and not only have their types flow through EmberData APIs, but
+    also allows EmberData to provide typechecking and intellisense for the record
+    based on a special symbol prsent on record instances that implement the
+    `TypedRecordInstance` interface.
+  
+    @typedoc
+  */
+  export type OpaqueRecordInstance = unknown;
+}
 //# sourceMappingURL=record-instance.d.ts.map