@ember-data/store 5.4.0-alpha.3 → 5.4.0-alpha.31

package/unstable-preview-types/-private/network/request-cache.d.ts

@@ -0,0 +1,107 @@
+import type { StableRecordIdentifier } from '@warp-drive/core-types/identifier';
+import type { FindRecordOptions } from '../../-types/q/store';
+import type Store from '../store-service';
+declare const Touching: unique symbol;
+export declare const RequestPromise: unique symbol;
+export interface Operation {
+    op: string;
+    options: FindRecordOptions | undefined;
+    recordIdentifier: StableRecordIdentifier;
+}
+export interface FindRecordQuery extends Operation {
+    op: 'findRecord';
+}
+export interface SaveRecordMutation extends Operation {
+    op: 'saveRecord';
+}
+export interface Request {
+    data: Operation[];
+    options?: Record<string, unknown>;
+}
+export type RequestStates = 'pending' | 'fulfilled' | 'rejected';
+export interface RequestState {
+    state: RequestStates;
+    type: 'query' | 'mutation';
+    request: Request;
+    response?: Response;
+}
+export interface Response {
+    data: unknown;
+}
+interface InternalRequest extends RequestState {
+    [Touching]: StableRecordIdentifier[];
+    [RequestPromise]?: Promise<unknown>;
+}
+export type RequestSubscription = (requestState: RequestState) => void;
+/**
+ * The RequestStateService is used to track the state of requests
+ * for fetching or updating known resource identifies that are inflight.
+ *
+ * @class RequestStateService
+ * @public
+ */
+export default class RequestStateService {
+    _pending: Map<StableRecordIdentifier, InternalRequest[]>;
+    _done: Map<StableRecordIdentifier, InternalRequest[]>;
+    _subscriptions: Map<StableRecordIdentifier, RequestSubscription[]>;
+    _toFlush: InternalRequest[];
+    _store: Store;
+    constructor(store: Store);
+    _clearEntries(identifier: StableRecordIdentifier): void;
+    _enqueue<T>(promise: Promise<T>, queryRequest: Request): Promise<T>;
+    _triggerSubscriptions(req: InternalRequest): void;
+    _flush(): void;
+    _flushRequest(req: InternalRequest): void;
+    _dequeue(identifier: StableRecordIdentifier, request: InternalRequest): void;
+    _addDone(request: InternalRequest): void;
+    /**
+     * Subscribe to requests for a given resource identity.
+     *
+     * The callback will receive the current state of the request.
+     *
+     * ```ts
+     * interface RequestState {
+     *   state: 'pending' | 'fulfilled' | 'rejected';
+     *   type: 'query' | 'mutation';
+     *   request: Request;
+     *   response?: { data: unknown };
+     * }
+     * ```
+     *
+     * Note: It should be considered dangerous to use this API for more than simple
+     * state derivation or debugging. The `request` and `response` properties are poorly
+     * spec'd and may change unexpectedly when shifting what Handlers are in use or how
+     * requests are issued from the Store.
+     *
+     * We expect to revisit this API in the near future as we continue to refine the
+     * RequestManager ergonomics, as a simpler but more powerful direct integration
+     * with the RequestManager for these purposes is likely to be a better long-term
+     * design.
+     *
+     * @method subscribeForRecord
+     * @public
+     * @param {StableRecordIdentifier} identifier
+     * @param {(state: RequestState) => void} callback
+     */
+    subscribeForRecord(identifier: StableRecordIdentifier, callback: RequestSubscription): void;
+    /**
+     * Retrieve all active requests for a given resource identity.
+     *
+     * @method getPendingRequestsForRecord
+     * @public
+     * @param {StableRecordIdentifier} identifier
+     * @return {RequestState[]} an array of request states for any pending requests for the given identifier
+     */
+    getPendingRequestsForRecord(identifier: StableRecordIdentifier): RequestState[];
+    /**
+     * Retrieve the last completed request for a given resource identity.
+     *
+     * @method getLastRequestForRecord
+     * @public
+     * @param {StableRecordIdentifier} identifier
+     * @return {RequestState | null} the state of the most recent request for the given identifier
+     */
+    getLastRequestForRecord(identifier: StableRecordIdentifier): RequestState | null;
+}
+export {};
+//# sourceMappingURL=request-cache.d.ts.map

package/unstable-preview-types/-private/network/request-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-cache.d.ts","sourceRoot":"","sources":["../../../src/-private/network/request-cache.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAEhF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAE1C,QAAA,MAAM,QAAQ,EAAE,OAAO,MAA2B,CAAC;AACnD,eAAO,MAAM,cAAc,EAAE,OAAO,MAA0B,CAAC;AAG/D,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACvC,gBAAgB,EAAE,sBAAsB,CAAC;CAC1C;AAED,MAAM,WAAW,eAAgB,SAAQ,SAAS;IAChD,EAAE,EAAE,YAAY,CAAC;CAClB;AAED,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACnD,EAAE,EAAE,YAAY,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,SAAS,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,CAAC;AAEjE,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,aAAa,CAAC;IACrB,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,QAAQ;IAEvB,IAAI,EAAE,OAAO,CAAC;CACf;AAED,UAAU,eAAgB,SAAQ,YAAY;IAC5C,CAAC,QAAQ,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACrC,CAAC,cAAc,CAAC,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;CACrC;AAGD,MAAM,MAAM,mBAAmB,GAAG,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI,CAAC;AAMvE;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACtC,QAAQ,EAAE,GAAG,CAAC,sBAAsB,EAAE,eAAe,EAAE,CAAC,CAAa;IACrE,KAAK,EAAE,GAAG,CAAC,sBAAsB,EAAE,eAAe,EAAE,CAAC,CAAa;IAClE,cAAc,EAAE,GAAG,CAAC,sBAAsB,EAAE,mBAAmB,EAAE,CAAC,CAAa;IAC/E,QAAQ,EAAE,eAAe,EAAE,CAAM;IACjC,MAAM,EAAE,KAAK,CAAC;gBAEF,KAAK,EAAE,KAAK;IAIxB,aAAa,CAAC,UAAU,EAAE,sBAAsB;IAIhD,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAiDnE,qBAAqB,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAcjD,MAAM,IAAI,IAAI;IAOd,aAAa,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IASzC,QAAQ,CAAC,UAAU,EAAE,sBAAsB,EAAE,OAAO,EAAE,eAAe;IAQrE,QAAQ,CAAC,OAAO,EAAE,eAAe;IAwBjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,kBAAkB,CAAC,UAAU,EAAE,sBAAsB,EAAE,QAAQ,EAAE,mBAAmB;IASpF;;;;;;;OAOG;IACH,2BAA2B,CAAC,UAAU,EAAE,sBAAsB,GAAG,YAAY,EAAE;IAI/E;;;;;;;OAOG;IACH,uBAAuB,CAAC,UAAU,EAAE,sBAAsB,GAAG,YAAY,GAAG,IAAI;CAOjF"}

package/unstable-preview-types/-private/record-arrays/identifier-array.d.ts

@@ -0,0 +1,135 @@
+import type { Signal } from '@ember-data/tracking/-private';
+import type { StableRecordIdentifier } from '@warp-drive/core-types/identifier';
+import type { TypedRecordInstance, TypeFromInstance } from '@warp-drive/core-types/record';
+import type { ImmutableRequestInfo } from '@warp-drive/core-types/request';
+import type { Links, PaginationLinks } from '@warp-drive/core-types/spec/raw';
+import type RecordArrayManager from '../managers/record-array-manager';
+import type Store from '../store-service';
+export declare const ARRAY_SIGNAL: unique symbol;
+export declare const SOURCE: unique symbol;
+export declare const MUTATE: unique symbol;
+export declare const NOTIFY: unique symbol;
+declare const IS_COLLECTION: unique symbol;
+export declare function notifyArray(arr: IdentifierArray): void;
+declare global {
+    interface ProxyConstructor {
+        new <TSource extends object, TTarget extends object>(target: TSource, handler: ProxyHandler<TSource>): TTarget;
+    }
+}
+export type IdentifierArrayCreateOptions<T = unknown> = {
+    identifiers: StableRecordIdentifier[];
+    type?: T extends TypedRecordInstance ? TypeFromInstance<T> : string;
+    store: Store;
+    allowMutation: boolean;
+    manager: RecordArrayManager;
+    links?: Links | PaginationLinks | null;
+    meta?: Record<string, unknown> | null;
+};
+/**
+  A record array is an array that contains records of a certain type (or modelName).
+  The record array materializes records as needed when they are retrieved for the first
+  time. You should not create record arrays yourself. Instead, an instance of
+  `RecordArray` or its subclasses will be returned by your application's store
+  in response to queries.
+
+  This class should not be imported and instantiated by consuming applications.
+
+  @class RecordArray
+  @public
+*/
+interface IdentifierArray<T = unknown> extends Omit<Array<T>, '[]'> {
+    [MUTATE]?(target: StableRecordIdentifier[], receiver: typeof Proxy<StableRecordIdentifier[], T[]>, prop: string, args: unknown[], _SIGNAL: Signal): unknown;
+}
+declare class IdentifierArray<T = unknown> {
+    DEPRECATED_CLASS_NAME: string;
+    /**
+      The flag to signal a `RecordArray` is currently loading data.
+      Example
+      ```javascript
+      let people = store.peekAll('person');
+      people.isUpdating; // false
+      people.update();
+      people.isUpdating; // true
+      ```
+      @property isUpdating
+      @public
+      @type Boolean
+    */
+    isUpdating: boolean;
+    isLoaded: boolean;
+    isDestroying: boolean;
+    isDestroyed: boolean;
+    _updatingPromise: Promise<IdentifierArray<T>> | null;
+    [IS_COLLECTION]: boolean;
+    [ARRAY_SIGNAL]: Signal;
+    [SOURCE]: StableRecordIdentifier[];
+    [NOTIFY](): void;
+    links: Links | PaginationLinks | null;
+    meta: Record<string, unknown> | null;
+    modelName?: T extends TypedRecordInstance ? TypeFromInstance<T> : string;
+    /**
+      The store that created this record array.
+  
+      @property store
+      @private
+      @type Store
+      */
+    store: Store;
+    _manager: RecordArrayManager;
+    destroy(clear: boolean): void;
+    get length(): number;
+    set length(value: number);
+    constructor(options: IdentifierArrayCreateOptions<T>);
+    /**
+      Used to get the latest version of all of the records in this array
+      from the adapter.
+  
+      Example
+  
+      ```javascript
+      let people = store.peekAll('person');
+      people.isUpdating; // false
+  
+      people.update().then(function() {
+        people.isUpdating; // false
+      });
+  
+      people.isUpdating; // true
+      ```
+  
+      @method update
+      @public
+    */
+    update(): Promise<IdentifierArray<T>>;
+    _update(): Promise<IdentifierArray<T>>;
+    /**
+      Saves all of the records in the `RecordArray`.
+  
+      Example
+  
+      ```javascript
+      let messages = store.peekAll('message');
+      messages.forEach(function(message) {
+        message.hasBeenSeen = true;
+      });
+      messages.save();
+      ```
+  
+      @method save
+      @public
+      @return {Promise<IdentifierArray>} promise
+    */
+    save(): Promise<IdentifierArray>;
+}
+export default IdentifierArray;
+export type CollectionCreateOptions = IdentifierArrayCreateOptions & {
+    query: ImmutableRequestInfo | Record<string, unknown> | null;
+    isLoaded: boolean;
+};
+export declare class Collection<T = unknown> extends IdentifierArray<T> {
+    query: ImmutableRequestInfo | Record<string, unknown> | null;
+    constructor(options: CollectionCreateOptions);
+    _update(): Promise<Collection<T>>;
+    destroy(clear: boolean): void;
+}
+//# sourceMappingURL=identifier-array.d.ts.map

package/unstable-preview-types/-private/record-arrays/identifier-array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifier-array.d.ts","sourceRoot":"","sources":["../../../src/-private/record-arrays/identifier-array.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAQ5D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAChF,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAC3F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAK9E,OAAO,KAAK,kBAAkB,MAAM,kCAAkC,CAAC;AACvE,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAuC1C,eAAO,MAAM,YAAY,eAAoB,CAAC;AAC9C,eAAO,MAAM,MAAM,eAAoB,CAAC;AACxC,eAAO,MAAM,MAAM,eAAoB,CAAC;AACxC,eAAO,MAAM,MAAM,eAAoB,CAAC;AACxC,QAAA,MAAM,aAAa,eAA2B,CAAC;AAE/C,wBAAgB,WAAW,CAAC,GAAG,EAAE,eAAe,QAE/C;AAaD,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,gBAAgB;QACxB,KAAK,OAAO,SAAS,MAAM,EAAE,OAAO,SAAS,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;KAChH;CACF;AAED,MAAM,MAAM,4BAA4B,CAAC,CAAC,GAAG,OAAO,IAAI;IACtD,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,IAAI,CAAC,EAAE,CAAC,SAAS,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;IACpE,KAAK,EAAE,KAAK,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,kBAAkB,CAAC;IAC5B,KAAK,CAAC,EAAE,KAAK,GAAG,eAAe,GAAG,IAAI,CAAC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CACvC,CAAC;AAkCF;;;;;;;;;;;EAWE;AACF,UAAU,eAAe,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IACjE,CAAC,MAAM,CAAC,CAAC,CACP,MAAM,EAAE,sBAAsB,EAAE,EAChC,QAAQ,EAAE,OAAO,KAAK,CAAC,sBAAsB,EAAE,EAAE,CAAC,EAAE,CAAC,EACrD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,EAAE,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;CACZ;AAED,cAAM,eAAe,CAAC,CAAC,GAAG,OAAO;IACvB,qBAAqB,EAAE,MAAM,CAAC;IACtC;;;;;;;;;;;;MAYE;IACM,UAAU,EAAE,OAAO,CAAC;IAC5B,QAAQ,UAAQ;IAChB,YAAY,UAAS;IACrB,WAAW,UAAS;IACpB,gBAAgB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAQ;IAE5D,CAAC,aAAa,CAAC,UAAQ;IACf,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,CAAC,MAAM,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACnC,CAAC,MAAM,CAAC;IAIA,KAAK,EAAE,KAAK,GAAG,eAAe,GAAG,IAAI,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACrC,SAAS,CAAC,EAAE,CAAC,SAAS,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;IACjF;;;;;;QAMI;IACI,KAAK,EAAE,KAAK,CAAC;IACb,QAAQ,EAAE,kBAAkB,CAAC;IAErC,OAAO,CAAC,KAAK,EAAE,OAAO;IAUtB,IACI,MAAM,WAET;IACD,IAAI,MAAM,CAAC,KAAK,QAAA,EAEf;gBAEW,OAAO,EAAE,4BAA4B,CAAC,CAAC,CAAC;IAyOpD;;;;;;;;;;;;;;;;;;;MAmBE;IACF,MAAM,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAyBrC,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAUtC;;;;;;;;;;;;;;;;MAgBE;IACF,IAAI,IAAI,OAAO,CAAC,eAAe,CAAC;CAKjC;AAkBD,eAAe,eAAe,CAAC;AAE/B,MAAM,MAAM,uBAAuB,GAAG,4BAA4B,GAAG;IACnE,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC7D,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,qBAAa,UAAU,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,eAAe,CAAC,CAAC,CAAC;IAC7D,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAQ;gBAExD,OAAO,EAAE,uBAAuB;IAM5C,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAejC,OAAO,CAAC,KAAK,EAAE,OAAO;CAKvB"}