@ember-data/store 5.5.0-alpha.19 → 5.5.0-alpha.20

package/dist/-private.js

@@ -1 +1 @@
-export { A as ARRAY_SIGNAL, C as CacheHandler, k as CollectionRecordArray, I as LiveArray, M as MUTATE, R as RecordArrayManager, w as RelatedCollection, l as SOURCE, S as Store, t as StoreMap, _ as _clearCaches, v as _deprecatingNormalize, h as coerceId, g as constructResource, j as ensureStringId, m as fastPush, f as isDocumentIdentifier, i as isStableIdentifier, x as log, y as logGroup, n as notifyArray, p as peekCache, r as recordIdentifierFor, o as removeRecordDataFor, u as setCacheFor, q as setRecordIdentifier, s as storeFor } from "./many-array-CE2Jr4mQ.js";
+export { A as ARRAY_SIGNAL, C as CacheHandler, k as CollectionRecordArray, I as LiveArray, M as MUTATE, R as RecordArrayManager, w as RelatedCollection, l as SOURCE, S as Store, t as StoreMap, _ as _clearCaches, v as _deprecatingNormalize, h as coerceId, g as constructResource, j as ensureStringId, m as fastPush, z as getPromiseState, B as getRequestState, f as isDocumentIdentifier, i as isStableIdentifier, x as log, y as logGroup, n as notifyArray, p as peekCache, r as recordIdentifierFor, o as removeRecordDataFor, u as setCacheFor, q as setRecordIdentifier, s as storeFor } from "./request-state-Bue-PTUf.js";

package/dist/index.js

@@ -1,4 +1,4 @@
-export { C as CacheHandler, S as default, r as recordIdentifierFor, c as setIdentifierForgetMethod, a as setIdentifierGenerationMethod, d as setIdentifierResetMethod, b as setIdentifierUpdateMethod, e as setKeyInfoForResource, s as storeFor } from "./many-array-CE2Jr4mQ.js";
+export { C as CacheHandler, S as default, r as recordIdentifierFor, c as setIdentifierForgetMethod, a as setIdentifierGenerationMethod, d as setIdentifierResetMethod, b as setIdentifierUpdateMethod, e as setKeyInfoForResource, s as storeFor } from "./request-state-Bue-PTUf.js";
 import '@ember/debug';
 import '@embroider/macros';
 import '@ember-data/request-utils/string';

package/dist/{many-array-CE2Jr4mQ.js → request-state-Bue-PTUf.js}

@@ -8,6 +8,7 @@ import { defineSubscription, notifySignal, defineSignal, createSignal, subscribe
 import { CACHE_OWNER, DEBUG_STALE_CACHE_OWNER, DEBUG_IDENTIFIER_BUCKET, DEBUG_CLIENT_ORIGINATED } from '@warp-drive/core-types/identifier';
 import { dasherize } from '@ember-data/request-utils/string';
 import { compat } from '@ember-data/tracking';
+import { getPromiseResult, setPromiseResult } from '@ember-data/request';
 
 /**
   @module @ember-data/store
@@ -3979,7 +3980,7 @@ class RequestStateService {
    * @method subscribeForRecord
    * @public
    * @param {StableRecordIdentifier} identifier
-   * @param {(state: RequestState) => void} callback
+   * @param {(state: RequestCacheRequestState) => void} callback
    */
   subscribeForRecord(identifier, callback) {
     let subscriptions = this._subscriptions.get(identifier);
@@ -3996,7 +3997,7 @@ class RequestStateService {
    * @method getPendingRequestsForRecord
    * @public
    * @param {StableRecordIdentifier} identifier
-   * @return {RequestState[]} an array of request states for any pending requests for the given identifier
+   * @return {RequestCacheRequestState[]} an array of request states for any pending requests for the given identifier
    */
   getPendingRequestsForRecord(identifier) {
     return this._pending.get(identifier) || EMPTY_ARR;
@@ -4008,7 +4009,7 @@ class RequestStateService {
    * @method getLastRequestForRecord
    * @public
    * @param {StableRecordIdentifier} identifier
-   * @return {RequestState | null} the state of the most recent request for the given identifier
+   * @return {RequestCacheRequestState | null} the state of the most recent request for the given identifier
    */
   getLastRequestForRecord(identifier) {
     const requests = this._done.get(identifier);
@@ -6918,4 +6919,571 @@ function mutate(collection, mutation, _SIGNAL) {
   collection._manager.mutate(mutation);
   addToTransaction(_SIGNAL);
 }
-export { ARRAY_SIGNAL as A, CacheHandler as C, IdentifierArray as I, MUTATE as M, RecordArrayManager as R, Store as S, _clearCaches as _, setIdentifierGenerationMethod as a, setIdentifierUpdateMethod as b, setIdentifierForgetMethod as c, setIdentifierResetMethod as d, setKeyInfoForResource as e, isDocumentIdentifier as f, constructResource as g, coerceId as h, isStableIdentifier as i, ensureStringId as j, Collection as k, SOURCE as l, fastPush as m, notifyArray as n, removeRecordDataFor as o, peekCache as p, setRecordIdentifier as q, recordIdentifierFor as r, storeFor as s, StoreMap as t, setCacheFor as u, normalizeModelName as v, RelatedCollection as w, log as x, logGroup as y };
+const PromiseCache = new WeakMap();
+
+/**
+ * The state of a promise in the "pending"
+ * state. This is the default initial state.
+ *
+ * @typedoc
+ */
+
+/**
+ * The state of a promise in the "fulfilled" state.
+ * This is the state of a promise that has resolved
+ * successfully.
+ *
+ * @typedoc
+ */
+
+/**
+ * The state of a promise in the "rejected" state.
+ * This is the state of a promise that has rejected
+ * with an error.
+ *
+ * @typedoc
+ */
+
+/**
+ * The state of a promise. This is the type that is returned
+ * from `getPromiseState`.
+ *
+ * See also:
+ * - {@link PendingPromise}
+ * - {@link ResolvedPromise}
+ * - {@link RejectedPromise}
+ *
+ * @typedoc
+ */
+
+const PromiseStateProto = {};
+
+// TODO introduce a new mechanism for defining multiple properties
+// that share a common signal
+defineSignal(PromiseStateProto, 'reason', null);
+defineSignal(PromiseStateProto, 'value', null);
+defineSignal(PromiseStateProto, 'result', null);
+defineSignal(PromiseStateProto, 'error', null);
+defineSignal(PromiseStateProto, 'status', 'pending');
+defineSignal(PromiseStateProto, 'isPending', true);
+defineSignal(PromiseStateProto, 'isLoading', true);
+defineSignal(PromiseStateProto, 'isSuccess', false);
+defineSignal(PromiseStateProto, 'isError', false);
+function createPromiseState(promise) {
+  const state = getPromiseResult(promise);
+  const promiseState = Object.create(PromiseStateProto);
+  if (state) {
+    if (state.isError) {
+      promiseState.error = state.result;
+      promiseState.reason = state.result;
+      promiseState.status = 'rejected';
+      promiseState.isError = true;
+      promiseState.isPending = false;
+      promiseState.isLoading = false;
+    } else {
+      promiseState.result = state.result;
+      promiseState.value = state.result;
+      promiseState.status = 'fulfilled';
+      promiseState.isSuccess = true;
+      promiseState.isPending = false;
+      promiseState.isLoading = false;
+    }
+  } else {
+    void promise.then(result => {
+      setPromiseResult(promise, {
+        isError: false,
+        result
+      });
+      promiseState.result = result;
+      promiseState.value = result;
+      promiseState.status = 'fulfilled';
+      promiseState.isSuccess = true;
+      promiseState.isPending = false;
+      promiseState.isLoading = false;
+    }, error => {
+      setPromiseResult(promise, {
+        isError: true,
+        result: error
+      });
+      promiseState.error = error;
+      promiseState.reason = error;
+      promiseState.status = 'rejected';
+      promiseState.isError = true;
+      promiseState.isPending = false;
+      promiseState.isLoading = false;
+    });
+  }
+  return promiseState;
+}
+const LegacyPromiseProxy = Symbol.for('LegacyPromiseProxy');
+function isLegacyAwaitable(promise) {
+  return LegacyPromiseProxy in promise && 'promise' in promise && promise[LegacyPromiseProxy] === true;
+}
+function getPromise(promise) {
+  return isLegacyAwaitable(promise) ? promise.promise : promise;
+}
+
+/**
+ * Returns a reactive state-machine for the provided promise or awaitable.
+ *
+ * Repeat calls to `getPromiseState` with the same promise will return the same state object
+ * making is safe and easy to use in templates and JavaScript code to produce reactive
+ * behaviors around promises.
+ *
+ * `getPromiseState` can be used in both JavaScript and Template contexts.
+ *
+ * ```ts
+ * import { getPromiseState } from '@warp-drive/ember';
+ *
+ * const state = getPromiseState(promise);
+ * ```
+ *
+ * For instance, we could write a getter on a component that updates whenever
+ * the promise state advances or the promise changes, by combining the function
+ * with the use of `@cached`
+ *
+ * ```ts
+ * class Component {
+ *   @cached
+ *   get title() {
+ *     const state = getPromiseState(this.args.request);
+ *     if (state.isPending) {
+ *       return 'loading...';
+ *     }
+ *     if (state.isError) { return null; }
+ *     return state.result.title;
+ *   }
+ * }
+ * ```
+ *
+ * Or in a template as a helper:
+ *
+ * ```gjs
+ * import { getPromiseState } from '@warp-drive/ember';
+ *
+ * <template>
+ *   {{#let (getPromiseState @request) as |state|}}
+ *     {{#if state.isPending}} <Spinner />
+ *     {{else if state.isError}} <ErrorForm @error={{state.error}} />
+ *     {{else}}
+ *       <h1>{{state.result.title}}</h1>
+ *     {{/if}}
+ *   {{/let}}
+ * </template>
+ * ```
+ *
+ * If looking to use in a template, consider also the `<Await />` component.
+ *
+ * @typedoc
+ */
+function getPromiseState(promise) {
+  const _promise = getPromise(promise);
+  let state = PromiseCache.get(_promise);
+  if (!state) {
+    state = createPromiseState(_promise);
+    PromiseCache.set(_promise, state);
+  }
+  return state;
+}
+const RequestCache = new WeakMap();
+function isAbortError(error) {
+  return error instanceof DOMException && error.name === 'AbortError';
+}
+async function watchStream(stream, state) {
+  const reader = stream.getReader();
+  let bytesLoaded = 0;
+  let shouldForward = state._stream !== null && state._stream.readable.locked;
+  let isForwarding = shouldForward;
+  let writer = state._stream?.writable.getWriter();
+  const buffer = [];
+  state._isPending = false;
+  state._isStarted = true;
+  state._startTime = performance.now();
+  while (true) {
+    const {
+      value,
+      done
+    } = await reader.read();
+    if (done) {
+      break;
+    }
+    bytesLoaded += value.byteLength;
+    state._bytesLoaded = bytesLoaded;
+    state._lastPacketTime = performance.now();
+    shouldForward = shouldForward || state._stream !== null && state._stream.readable.locked;
+    if (shouldForward) {
+      if (!isForwarding) {
+        isForwarding = true;
+        writer = state._stream.writable.getWriter();
+        for (const item of buffer) {
+          await writer.ready;
+          await writer.write(item);
+        }
+        buffer.length = 0;
+      }
+      await writer.ready;
+      await writer.write(value);
+    } else {
+      buffer.push(value);
+    }
+  }
+
+  // if we are still forwarding, we need to close the writer
+  if (isForwarding) {
+    await writer.ready;
+    await writer.close();
+  } else if (state._stream) {
+    // if we are not forwarding, we need to cancel the stream
+    await state._stream.readable.cancel('The Stream Has Already Ended');
+    state._stream = null;
+  }
+  const endTime = performance.now();
+  state._endTime = endTime;
+  state._isComplete = true;
+  state._isStarted = false;
+}
+
+/**
+ * Lazily consumes the stream of a request, providing a number of
+ * reactive properties that can be used to build UIs that respond
+ * to the progress of a request.
+ *
+ * @typedoc
+ */
+class RequestLoadingState {
+  _stream = null;
+  _future;
+  _triggered = false;
+  _trigger() {
+    if (this._triggered) {
+      return;
+    }
+    this._triggered = true;
+    const future = this._future;
+    const promise = future.getStream();
+    if (promise.sizeHint) {
+      this._sizeHint = promise.sizeHint;
+    }
+    this.promise = promise.then(stream => {
+      if (!stream) {
+        this._isPending = false;
+        this._isComplete = true;
+        return;
+      }
+      return watchStream(stream, this);
+    }, error => {
+      this._isPending = false;
+      this._isStarted = false;
+      if (isAbortError(error)) {
+        this._isCancelled = true;
+        this._isComplete = true;
+      }
+      this._isErrored = true;
+      this._error = error;
+    });
+  }
+  promise = null;
+  get isPending() {
+    this._trigger();
+    return this._isPending;
+  }
+  get sizeHint() {
+    this._trigger();
+    return this._sizeHint;
+  }
+  get stream() {
+    this._trigger();
+    if (!this._stream) {
+      if (this._isComplete || this._isCancelled || this._isErrored) {
+        return null;
+      }
+      this._stream = new TransformStream();
+    }
+    return this._stream.readable;
+  }
+  get isStarted() {
+    this._trigger();
+    return this._isStarted;
+  }
+  get bytesLoaded() {
+    this._trigger();
+    return this._bytesLoaded;
+  }
+  get startTime() {
+    this._trigger();
+    return this._startTime;
+  }
+  get endTime() {
+    this._trigger();
+    return this._endTime;
+  }
+  get lastPacketTime() {
+    this._trigger();
+    return this._lastPacketTime;
+  }
+  get isComplete() {
+    this._trigger();
+    return this._isComplete;
+  }
+  get isCancelled() {
+    this._trigger();
+    return this._isCancelled;
+  }
+  get isErrored() {
+    this._trigger();
+    return this._isErrored;
+  }
+  get error() {
+    this._trigger();
+    return this._error;
+  }
+  get elapsedTime() {
+    return (this.endTime || this.lastPacketTime) - this.startTime;
+  }
+  get completedRatio() {
+    return this.sizeHint ? this.bytesLoaded / this.sizeHint : 0;
+  }
+  get remainingRatio() {
+    return 1 - this.completedRatio;
+  }
+  get duration() {
+    return this.endTime - this.startTime;
+  }
+  get speed() {
+    // bytes per second
+    return this.bytesLoaded / (this.elapsedTime / 1000);
+  }
+  constructor(future) {
+    this._future = future;
+  }
+  abort = () => {
+    this._future.abort();
+  };
+}
+defineSignal(RequestLoadingState.prototype, '_isPending', true);
+defineSignal(RequestLoadingState.prototype, '_isStarted', false);
+defineSignal(RequestLoadingState.prototype, '_isComplete', false);
+defineSignal(RequestLoadingState.prototype, '_isCancelled', false);
+defineSignal(RequestLoadingState.prototype, '_isErrored', false);
+defineSignal(RequestLoadingState.prototype, '_error', null);
+defineSignal(RequestLoadingState.prototype, '_sizeHint', 0);
+defineSignal(RequestLoadingState.prototype, '_bytesLoaded', 0);
+defineSignal(RequestLoadingState.prototype, '_startTime', 0);
+defineSignal(RequestLoadingState.prototype, '_endTime', 0);
+defineSignal(RequestLoadingState.prototype, '_lastPacketTime', 0);
+
+/**
+ * The state of a request in the "pending"
+ * state. This is the default initial state.
+ *
+ * Extends the {@link PendingPromise} interface.
+ *
+ * @typedoc
+ */
+
+/**
+ * The state of a request in the "fulfilled" state.
+ * This is the state of a request that has resolved
+ * successfully.
+ *
+ * Extends the {@link ResolvedPromise} interface.
+ *
+ * @typedoc
+ */
+
+/**
+ * The state of a request in the "rejected" state.
+ * This is the state of a request that has rejected
+ * with an error.
+ *
+ * Extends the {@link RejectedPromise} interface.
+ *
+ * @typedoc
+ */
+
+/**
+ * The state of a request in the "cancelled" state.
+ * This is the state of a promise that has been
+ * cancelled.
+ *
+ * @typedoc
+ */
+
+/**
+ * RequestState extends the concept of PromiseState to provide a reactive
+ * wrapper for a request `Future` which allows you write declarative code
+ * around a Future's control flow.
+ *
+ * It is useful in both Template and JavaScript contexts, allowing you
+ * to quickly derive behaviors and data from pending, error and success
+ * states.
+ *
+ * The key difference between a Promise and a Future is that Futures provide
+ * access to a stream of their content, the identity of the request (if any)
+ * as well as the ability to attempt to abort the request.
+ *
+ * ```ts
+ * interface Future<T> extends Promise<T>> {
+ *   getStream(): Promise<ReadableStream>;
+ *   abort(): void;
+ *   lid: StableDocumentIdentifier | null;
+ * }
+ * ```
+ *
+ * These additional APIs allow us to craft even richer state experiences.
+ *
+ * To get the state of a request, use `getRequestState`.
+ *
+ * See also:
+ * - {@link PendingRequest}
+ * - {@link ResolvedRequest}
+ * - {@link RejectedRequest}
+ * - {@link CancelledRequest}
+ *
+ * @typedoc
+ */
+
+const RequestStateProto = {};
+
+// TODO introduce a new mechanism for defining multiple properties
+// that share a common signal
+defineSignal(RequestStateProto, 'reason', null);
+defineSignal(RequestStateProto, 'value', null);
+defineSignal(RequestStateProto, 'result', null);
+defineSignal(RequestStateProto, 'error', null);
+defineSignal(RequestStateProto, 'status', 'pending');
+defineSignal(RequestStateProto, 'isPending', true);
+defineSignal(RequestStateProto, 'isLoading', true);
+defineSignal(RequestStateProto, 'isSuccess', false);
+defineSignal(RequestStateProto, 'isError', false);
+defineSignal(RequestStateProto, 'request', null);
+defineSignal(RequestStateProto, 'response', null);
+Object.defineProperty(RequestStateProto, 'isCancelled', {
+  get() {
+    return this.isError && isAbortError(this.reason);
+  }
+});
+Object.defineProperty(RequestStateProto, 'loadingState', {
+  get() {
+    if (!this._loadingState) {
+      this._loadingState = new RequestLoadingState(this._request);
+    }
+    return this._loadingState;
+  }
+});
+function createRequestState(future) {
+  const state = getPromiseResult(future);
+  const promiseState = Object.create(RequestStateProto);
+  promiseState._request = future;
+  if (state) {
+    if (state.isError) {
+      promiseState.error = state.result;
+      promiseState.reason = state.result;
+      promiseState.status = 'rejected';
+      promiseState.isError = true;
+      promiseState.isPending = false;
+      promiseState.isLoading = false;
+      promiseState.request = state.result.request;
+      promiseState.response = state.result.response;
+    } else {
+      promiseState.result = state.result.content;
+      promiseState.value = state.result.content;
+      promiseState.status = 'fulfilled';
+      promiseState.isSuccess = true;
+      promiseState.isPending = false;
+      promiseState.isLoading = false;
+      promiseState.request = state.result.request;
+      promiseState.response = state.result.response;
+    }
+  } else {
+    void future.then(result => {
+      setPromiseResult(future, {
+        isError: false,
+        result
+      });
+      promiseState.result = result.content;
+      promiseState.value = result.content;
+      promiseState.status = 'fulfilled';
+      promiseState.isSuccess = true;
+      promiseState.isPending = false;
+      promiseState.isLoading = false;
+      promiseState.request = result.request;
+      promiseState.response = result.response;
+    }, error => {
+      setPromiseResult(future, {
+        isError: true,
+        result: error
+      });
+      promiseState.error = error;
+      promiseState.reason = error;
+      promiseState.status = 'rejected';
+      promiseState.isError = true;
+      promiseState.isPending = false;
+      promiseState.isLoading = false;
+      promiseState.request = error.request;
+      promiseState.response = error.response;
+    });
+  }
+  return promiseState;
+}
+
+/**
+ * `getRequestState` can be used in both JavaScript and Template contexts.
+ *
+ * ```ts
+ * import { getRequestState } from '@warp-drive/ember';
+ *
+ * const state = getRequestState(future);
+ * ```
+ *
+ * For instance, we could write a getter on a component that updates whenever
+ * the request state advances or the future changes, by combining the function
+ * with the use of `@cached`
+ *
+ * ```ts
+ * class Component {
+ *   @cached
+ *   get title() {
+ *     const state = getRequestState(this.args.request);
+ *     if (state.isPending) {
+ *       return 'loading...';
+ *     }
+ *     if (state.isError) { return null; }
+ *     return state.result.title;
+ *   }
+ * }
+ * ```
+ *
+ * Or in a template as a helper:
+ *
+ * ```gjs
+ * import { getRequestState } from '@warp-drive/ember';
+ *
+ * <template>
+ *   {{#let (getRequestState @request) as |state|}}
+ *     {{#if state.isPending}}
+ *       <Spinner />
+ *     {{else if state.isError}}
+ *       <ErrorForm @error={{state.error}} />
+ *     {{else}}
+ *       <h1>{{state.result.title}}</h1>
+ *     {{/if}}
+ *   {{/let}}
+ * </template>
+ * ```
+ *
+ * If looking to use in a template, consider also the `<Request />` component
+ * which offers a numbe of additional capabilities for requests *beyond* what
+ * `RequestState` provides.
+ *
+ * @typedoc
+ */
+function getRequestState(future) {
+  let state = RequestCache.get(future);
+  if (!state) {
+    state = createRequestState(future);
+    RequestCache.set(future, state);
+  }
+  return state;
+}
+export { ARRAY_SIGNAL as A, getRequestState as B, CacheHandler as C, IdentifierArray as I, MUTATE as M, RecordArrayManager as R, Store as S, _clearCaches as _, setIdentifierGenerationMethod as a, setIdentifierUpdateMethod as b, setIdentifierForgetMethod as c, setIdentifierResetMethod as d, setKeyInfoForResource as e, isDocumentIdentifier as f, constructResource as g, coerceId as h, isStableIdentifier as i, ensureStringId as j, Collection as k, SOURCE as l, fastPush as m, notifyArray as n, removeRecordDataFor as o, peekCache as p, setRecordIdentifier as q, recordIdentifierFor as r, storeFor as s, StoreMap as t, setCacheFor as u, normalizeModelName as v, RelatedCollection as w, log as x, logGroup as y, getPromiseState as z };