@warp-drive/ember 5.4.0-alpha.149 → 5.4.0-alpha.151

package/unstable-preview-types/-private/request-state.d.ts

@@ -1,5 +1,13 @@
 declare module '@warp-drive/ember/-private/request-state' {
   import type { Future, ImmutableRequestInfo, ResponseInfo, StructuredErrorDocument } from '@ember-data/request';
+  /**
+   * 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.
+   *
+   * @class RequestLoadingState
+   * @public
+   */
   export class RequestLoadingState {
       _stream: TransformStream | null;
       _future: Future<unknown>;
@@ -37,6 +45,34 @@ declare module '@warp-drive/ember/-private/request-state' {
       constructor(future: Future<unknown>);
       abort: () => void;
   }
+  /**
+   * 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`.
+   *
+   * @class RequestState
+   * @public
+   */
   export class RequestState<T = unknown, RT = unknown> {
       #private;
       result: RT | null;
@@ -50,6 +86,64 @@ declare module '@warp-drive/ember/-private/request-state' {
       get loadingState(): RequestLoadingState;
       constructor(future: Future<RT>);
   }
+  /**
+   *
+   *
+   * `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.
+   *
+   * @method getRequestState
+   * @for @warp-drive/ember
+   * @static
+   * @public
+   * @param future
+   * @return {RequestState}
+   */
   export function getRequestState<RT, T>(future: Future<RT>): RequestState<T, RT>;
 }
 //# sourceMappingURL=request-state.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"request-state.d.ts","sourceRoot":"","sources":["../../src/-private/request-state.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,MAAM,EACN,oBAAoB,EACpB,YAAY,EAEZ,uBAAuB,EACxB,MAAM,qBAAqB,CAAC;AAkE7B,qBAAa,mBAAmB;IAC9B,OAAO,EAAE,eAAe,GAAG,IAAI,CAAQ;IACvC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACzB,UAAU,UAAS;IACnB,QAAQ;IAgCR,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAQ;IAC5B,SAAS,SAAK;IACd,YAAY,SAAK;IAEjB,UAAU,SAAK;IACf,QAAQ,SAAK;IACb,eAAe,SAAK;IAEpB,UAAU,UAAQ;IAClB,UAAU,UAAS;IACnB,WAAW,UAAS;IACpB,YAAY,UAAS;IACrB,UAAU,UAAS;IACnB,MAAM,EAAE,KAAK,GAAG,IAAI,CAAQ;IAErC,IAAI,SAAS,IAAI,OAAO,CAGvB;IAED,IAAI,QAAQ,IAAI,MAAM,CAGrB;IAED,IAAI,MAAM,IAAI,cAAc,GAAG,IAAI,CASlC;IAED,IAAI,SAAS,IAAI,OAAO,CAGvB;IAED,IAAI,WAAW,IAAI,MAAM,CAGxB;IAED,IAAI,SAAS,IAAI,MAAM,CAGtB;IAED,IAAI,OAAO,IAAI,MAAM,CAGpB;IAED,IAAI,cAAc,IAAI,MAAM,CAG3B;IAED,IAAI,UAAU,IAAI,OAAO,CAGxB;IAED,IAAI,WAAW,IAAI,OAAO,CAGzB;IAED,IAAI,SAAS,IAAI,OAAO,CAGvB;IAED,IAAI,KAAK,IAAI,KAAK,GAAG,IAAI,CAGxB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,KAAK,IAAI,MAAM,CAGlB;gBAEW,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC;IAInC,KAAK,QAAO,IAAI,CAEd;CACH;AAED,qBAAa,YAAY,CAAC,CAAC,GAAG,OAAO,EAAE,EAAE,GAAG,OAAO;;IAIxC,MAAM,EAAE,EAAE,GAAG,IAAI,CAAQ;IACzB,KAAK,EAAE,uBAAuB,GAAG,IAAI,CAAQ;IAC7C,SAAS,UAAQ;IACjB,SAAS,UAAS;IAClB,OAAO,UAAS;IAChB,OAAO,EAAE,oBAAoB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAQ;IACnD,QAAQ,EAAE,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAQ;IAEzD,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,IAAI,YAAY,wBAMf;gBAEW,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;CAqC/B;AAED,wBAAgB,eAAe,CAAC,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,EAAE,EAAE,CAAC,CAS9E"}
+{"version":3,"file":"request-state.d.ts","sourceRoot":"","sources":["../../src/-private/request-state.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,MAAM,EACN,oBAAoB,EACpB,YAAY,EAEZ,uBAAuB,EACxB,MAAM,qBAAqB,CAAC;AAiE7B;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,EAAE,eAAe,GAAG,IAAI,CAAQ;IACvC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACzB,UAAU,UAAS;IACnB,QAAQ;IAgCR,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAQ;IAC5B,SAAS,SAAK;IACd,YAAY,SAAK;IAEjB,UAAU,SAAK;IACf,QAAQ,SAAK;IACb,eAAe,SAAK;IAEpB,UAAU,UAAQ;IAClB,UAAU,UAAS;IACnB,WAAW,UAAS;IACpB,YAAY,UAAS;IACrB,UAAU,UAAS;IACnB,MAAM,EAAE,KAAK,GAAG,IAAI,CAAQ;IAErC,IAAI,SAAS,IAAI,OAAO,CAGvB;IAED,IAAI,QAAQ,IAAI,MAAM,CAGrB;IAED,IAAI,MAAM,IAAI,cAAc,GAAG,IAAI,CASlC;IAED,IAAI,SAAS,IAAI,OAAO,CAGvB;IAED,IAAI,WAAW,IAAI,MAAM,CAGxB;IAED,IAAI,SAAS,IAAI,MAAM,CAGtB;IAED,IAAI,OAAO,IAAI,MAAM,CAGpB;IAED,IAAI,cAAc,IAAI,MAAM,CAG3B;IAED,IAAI,UAAU,IAAI,OAAO,CAGxB;IAED,IAAI,WAAW,IAAI,OAAO,CAGzB;IAED,IAAI,SAAS,IAAI,OAAO,CAGvB;IAED,IAAI,KAAK,IAAI,KAAK,GAAG,IAAI,CAGxB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,KAAK,IAAI,MAAM,CAGlB;gBAEW,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC;IAInC,KAAK,QAAO,IAAI,CAEd;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,YAAY,CAAC,CAAC,GAAG,OAAO,EAAE,EAAE,GAAG,OAAO;;IAIxC,MAAM,EAAE,EAAE,GAAG,IAAI,CAAQ;IACzB,KAAK,EAAE,uBAAuB,GAAG,IAAI,CAAQ;IAC7C,SAAS,UAAQ;IACjB,SAAS,UAAS;IAClB,OAAO,UAAS;IAChB,OAAO,EAAE,oBAAoB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAQ;IACnD,QAAQ,EAAE,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAQ;IAEzD,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,IAAI,YAAY,wBAMf;gBAEW,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;CAqC/B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,wBAAgB,eAAe,CAAC,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,EAAE,EAAE,CAAC,CAS9E"}

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

@@ -5,7 +5,7 @@ declare module '@warp-drive/ember/-private/request' {
   import type Store from '@ember-data/store';
   import type { RequestLoadingState, RequestState } from '@warp-drive/ember/-private/request-state.ts';
   type AutorefreshBehaviorType = 'online' | 'interval' | 'invalid';
-  type AutorefreshBehaviorCombos = true | AutorefreshBehaviorType | `${AutorefreshBehaviorType},${AutorefreshBehaviorType}` | `${AutorefreshBehaviorType},${AutorefreshBehaviorType},${AutorefreshBehaviorType}`;
+  type AutorefreshBehaviorCombos = boolean | AutorefreshBehaviorType | `${AutorefreshBehaviorType},${AutorefreshBehaviorType}` | `${AutorefreshBehaviorType},${AutorefreshBehaviorType},${AutorefreshBehaviorType}`;
   type ContentFeatures<RT> = {
       isOnline: boolean;
       isHidden: boolean;
@@ -17,16 +17,91 @@ declare module '@warp-drive/ember/-private/request' {
   };
   interface RequestSignature<T, RT> {
       Args: {
+          /**
+           * The request to monitor. This should be a `Future` instance returned
+           * by either the `store.request` or `store.requestManager.request` methods.
+           *
+           * @typedoc
+           */
           request?: Future<RT>;
+          /**
+           * A query to use for the request. This should be an object that can be
+           * passed to `store.request`. Use this in place of `@request` if you would
+           * like the component to also initiate the request.
+           *
+           * @typedoc
+           */
           query?: StoreRequestInput<T, RT>;
+          /**
+           * The store instance to use for making requests. If contexts are available,
+           * the component will default to using the `store` on the context.
+           *
+           * This is required if the store is not available via context or should be
+           * different from the store provided via context.
+           *
+           * @typedoc
+           */
           store?: Store;
+          /**
+           * The autorefresh behavior for the request. This can be a boolean, or any
+           * combination of the following values: `'online'`, `'interval'`, `'invalid'`.
+           *
+           * - `'online'`: Refresh the request when the browser comes back online
+           * - `'interval'`: Refresh the request at a specified interval
+           * - `'invalid'`: Refresh the request when the store emits an invalidation
+           *
+           * If `true`, this is equivalent to `'online,invalid'`.
+           *
+           * Defaults to `false`.
+           *
+           * @typedoc
+           */
           autorefresh?: AutorefreshBehaviorCombos;
+          /**
+           * The number of milliseconds to wait before refreshing the request when the
+           * browser comes back online or the network becomes available.
+           *
+           * This also controls the interval at which the request will be refreshed if
+           * the `interval` autorefresh type is enabled.
+           *
+           * Defaults to `30_000` (30 seconds).
+           *
+           * @typedoc
+           */
           autorefreshThreshold?: number;
+          /**
+           * The behavior of the request initiated by autorefresh. This can be one of
+           * the following values:
+           *
+           * - `'refresh'`: Refresh the request in the background
+           * - `'reload'`: Force a reload of the request
+           * - `'policy'` (**default**): Let the store's configured CachePolicy decide whether to
+           *    reload, refresh, or do nothing.
+           *
+           * Defaults to `'policy'`.
+           *
+           * @typedoc
+           */
           autorefreshBehavior?: 'refresh' | 'reload' | 'policy';
       };
       Blocks: {
+          /**
+           * The block to render when the component is idle and waiting to be given a request.
+           *
+           * @typedoc
+           */
           idle: [];
+          /**
+           * The block to render when the request is loading.
+           *
+           * @typedoc
+           */
           loading: [state: RequestLoadingState];
+          /**
+           * The block to render when the request was cancelled.
+           *
+           * @typedoc
+           */
           cancelled: [
               error: StructuredErrorDocument,
               features: {
@@ -35,6 +110,15 @@ declare module '@warp-drive/ember/-private/request' {
                   retry: () => Promise<void>;
               }
           ];
+          /**
+           * The block to render when the request failed. If this block is not provided,
+           * the error will be rethrown.
+           *
+           * Thus it is required to provide an error block and proper error handling if
+           * you do not want the error to crash the application.
+           *
+           * @typedoc
+           */
           error: [
               error: StructuredErrorDocument,
               features: {
@@ -43,16 +127,231 @@ declare module '@warp-drive/ember/-private/request' {
                   retry: () => Promise<void>;
               }
           ];
+          /**
+           * The block to render when the request succeeded.
+           *
+           * @typedoc
+           */
           content: [value: RT, features: ContentFeatures<RT>];
           always: [state: RequestState<T, RT>];
       };
   }
   /**
-   * The `<Request>` component is a powerful tool for managing data fetching and
-   * state in your Ember application. It provides declarative reactive control-flow
-   * for managing requests and state in your application.
+   * The `<Request />` component is a powerful tool for managing data fetching and
+   * state in your Ember application. It provides a declarative approach to reactive
+   * control-flow for managing requests and state in your application.
    *
-   * @typedoc
+   * The `<Request />` component is ideal for handling "boundaries", outside which some
+   * state is still allowed to be unresolved and within which it MUST be resolved.
+   *
+   * ## Request States
+   *
+   * `<Request />` has five states, only one of which will be active and rendered at a time.
+   *
+   * - `idle`: The component is waiting to be given a request to monitor
+   * - `loading`: The request is in progress
+   * - `error`: The request failed
+   * - `content`: The request succeeded
+   * - `cancelled`: The request was cancelled
+   *
+   * Additionally, the `content` state has a `refresh` method that can be used to
+   * refresh the request in the background, which is available as a sub-state of
+   * the `content` state.
+   *
+   * As with the `<Await />` component, if no error block is provided and the request
+   * rejects, the error will be thrown. Cancellation errors are swallowed instead of
+   * rethrown if no error block or cancellation block is present.
+   *
+   * ```gts
+   * import { Request } from '@warp-drive/ember';
+   *
+   * <template>
+   *   <Request @request={{@request}}>
+   *     <:loading as |state|>
+   *       <Spinner @percentDone={{state.completedRatio}} />
+   *       <button {{on "click" state.abort}}>Cancel</button>
+   *     </:loading>
+   *
+   *     <:error as |error state|>
+   *       <ErrorForm @error={{error}} />
+   *       <button {{on "click" state.retry}}>Retry</button>
+   *     </:error>
+   *
+   *     <:content as |data state|>
+   *       <h1>{{data.title}}</h1>
+   *       {{#if state.isBackgroundReloading}}
+   *         <SmallSpinner />
+   *         <button {{on "click" state.abort}}>Cancel</button>
+   *       {{else}}
+   *         <button {{on "click" state.refresh}}>Refresh</button>
+   *       {{/if}}
+   *     </:content>
+   *
+   *     <:cancelled as |error state|>
+   *       <h2>The Request was cancelled</h2>
+   *       <button {{on "click" state.retry}}>Retry</button>
+   *     </:cancelled>
+   *
+   *     <:idle>
+   *       <button {{on "click" @kickOffRequest}}>Load Preview?</button>
+   *     </:idle>
+   *
+   *   </Request>
+   * </template>
+   * ```
+   *
+   * ## Streaming Data
+   *
+   * The loading state exposes the download `ReadableStream` instance for consumption
+   *
+   * ```gjs
+   * import { Request } from '@warp-drive/ember';
+   *
+   * <template>
+   *   <Request @request={{@request}}>
+   *     <:loading as |state|>
+   *       <Video @stream={{state.stream}} />
+   *     </:loading>
+   *
+   *     <:error as |error|>
+   *       <ErrorForm @error={{error}} />
+   *     </:error>
+   *   </Request>
+   * </template>
+   * ```
+   *
+   * ## Retry
+   *
+   * Cancelled and error'd requests may be retried by calling the `retry` method.
+   *
+   * Retry will restart the state progression, using the loading, error, cancelled,
+   * and content blocks as appropriate.
+   *
+   * ## Reloading
+   *
+   * The `reload` method will force the request to be fully re-executed, bypassing
+   * cache and restarting the state progression through the loading, error, and
+   * content blocks as appropriate.
+   *
+   * Background reload (refresh) is a special substate of the content state that
+   * allows you to refresh the request in the background. This is useful for when
+   * you want to update the data in the background without blocking the UI.
+   *
+   * Reload and refresh are available as methods on the `content` state.
+   *
+   * ```gjs
+   * import { Request } from '@warp-drive/ember';
+   *
+   * <template>
+   *   <Request @request={{@request}}>
+   *     <:content as |data state|>
+   *       <h1>{{data.title}}</h1>
+   *       {{#if state.isBackgroundReloading}}
+   *         <SmallSpinner />
+   *         <button {{on "click" state.abort}}>Cancel</button>
+   *       {{/if}}
+   *
+   *       <button {{on "click" state.refresh}}>Refresh</button>
+   *       <button {{on "click" state.reload}}>Reload</button>
+   *     </:content>
+   *  </Request>
+   * </template>
+   * ```
+   *
+   * ## Advanced Reloading
+   *
+   * We can nest our usage of `<Request />` to handle more advanced
+   * reloading scenarios.
+   *
+   * ```gjs
+   * import { Request } from '@warp-drive/ember';
+   *
+   * <template>
+   *   <Request @request={{@request}}>
+   *     <:cancelled>
+   *       <h2>The Request Cancelled</h2>
+   *     </:cancelled>
+   *
+   *     <:error as |error|>
+   *       <ErrorForm @error={{error}} />
+   *     </:error>
+   *
+   *     <:content as |result state|>
+   *       <Request @request={{state.latestRequest}}>
+   *         <!-- Handle Background Request -->
+   *       </Request>
+   *
+   *       <h1>{{result.title}}</h1>
+   *
+   *       <button {{on "click" state.refresh}}>Refresh</button>
+   *     </:content>
+   *   </Request>
+   * </template>
+   * ```
+   *
+   * ## Autorefresh
+   *
+   * `<Request />` supports automatic refresh and reload under certain conditions.
+   *
+   * - `online`: This occurs when a browser window or tab comes back to the foreground
+   *   after being backgrounded or when the network reports as being online after
+   *   having been offline.
+   * - `interval`: This occurs when a specified amount of time has passed.
+   * - `invalid`: This occurs when the store emits a notification that the request
+   *   has become invalid.
+   *
+   * You can specify when autorefresh should occur by setting the `autorefresh` arg
+   * to `true` or a comma-separated list of the above values.
+   *
+   * A value of `true` is equivalent to `'online,invalid'`.
+   *
+   * By default, an autorefresh will only occur if the browser was backgrounded or
+   * offline for more than 30s before coming back available. This amount of time can
+   * be tweaked by setting the number of milliseconds via `@autorefreshThreshold`.
+   *
+   * This arg also controls the interval at which the request will be refreshed
+   * if the `interval` autorefresh type is enabled.
+   *
+   * Finally, the behavior of the request initiated by autorefresh can be adjusted
+   * by setting the `autorefreshBehavior` arg to `'refresh'`, `'reload'`, or `'policy'`.
+   *
+   * - `'refresh'`: Refresh the request in the background
+   * - `'reload'`: Force a reload of the request
+   * - `'policy'` (**default**): Let the store's configured CachePolicy decide whether to
+   *    reload, refresh, or do nothing.
+   *
+   * More advanced refresh and reload behaviors can be created by passing the reload and
+   * refresh actions into another component. For instance, refresh could be set up on a
+   * timer or on a websocket subscription.
+   *
+   *
+   * ```gjs
+   * import { Request } from '@warp-drive/ember';
+   *
+   * <template>
+   *   <Request @request={{@request}}>
+   *     <:content as |result state|>
+   *       <h1>{{result.title}}</h1>
+   *
+   *       <Interval @period={{30_000}} @fn={{state.refresh}} />
+   *       <Subscribe @channel={{@someValue}} @fn={{state.refresh}} />
+   *     </:content>
+   *   </Request>
+   * </template>
+   * ```
+   *
+   * If a matching request is refreshed or reloaded by any other component,
+   * the `Request` component will react accordingly.
+   *
+   * ## Deduping
+   *
+   * The store dedupes requests by identity. If a request is made for the same identity
+   * from multiple `<Request />` components, even if the request is not referentially the
+   * same, only one actual request will be made.
+   *
+   *
+   * @class <Request />
+   * @public
    */
   export class Request<T, RT> extends Component<RequestSignature<T, RT>> {
       /**

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

@@ -1 +1 @@
-{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/-private/request.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAK3C,OAAO,KAAK,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAM3C,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AA2B5E,KAAK,uBAAuB,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;AACjE,KAAK,yBAAyB,GAC1B,IAAI,GACJ,uBAAuB,GACvB,GAAG,uBAAuB,IAAI,uBAAuB,EAAE,GACvD,GAAG,uBAAuB,IAAI,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;AAEvF,KAAK,eAAe,CAAC,EAAE,IAAI;IACzB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;CAC5B,CAAC;AAEF,UAAU,gBAAgB,CAAC,CAAC,EAAE,EAAE;IAC9B,IAAI,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACrB,KAAK,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACjC,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,WAAW,CAAC,EAAE,yBAAyB,CAAC;QACxC,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,mBAAmB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;KACvD,CAAC;IACF,MAAM,EAAE;QACN,IAAI,EAAE,EAAE,CAAC;QACT,OAAO,EAAE,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;QACtC,SAAS,EAAE;YACT,KAAK,EAAE,uBAAuB;YAC9B,QAAQ,EAAE;gBAAE,QAAQ,EAAE,OAAO,CAAC;gBAAC,QAAQ,EAAE,OAAO,CAAC;gBAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;aAAE;SAC/E,CAAC;QACF,KAAK,EAAE;YACL,KAAK,EAAE,uBAAuB;YAC9B,QAAQ,EAAE;gBAAE,QAAQ,EAAE,OAAO,CAAC;gBAAC,QAAQ,EAAE,OAAO,CAAC;gBAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;aAAE;SAC/E,CAAC;QACF,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;KACtC,CAAC;CACH;AAED;;;;;;GAMG;AACH,qBAAa,OAAO,CAAC,CAAC,EAAE,EAAE,CAAE,SAAQ,SAAS,CAAC,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACpE;;;;;OAKG;IACuB,MAAM,EAAE,KAAK,CAAC;IAExC;;;;OAIG;IACM,QAAQ,UAAQ;IAEzB;;;;OAIG;IACM,QAAQ,UAAQ;IAEzB;;;;OAIG;IACM,YAAY,UAAS;IAE9B;;;;;;;;OAQG;IACM,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAE/C;;;;;;;;OAQG;IACM,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAEhD;;;;OAIG;IACK,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IAE5B;;;;;OAKG;IACK,aAAa,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAE9C;;;;;OAKG;IACK,iBAAiB,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAElD;;;;;OAKG;IACK,gBAAgB,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAEjD;;;;;OAKG;IACK,cAAc,EAAE,iBAAiB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC;IAErD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEzB,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC;IAY3D,YAAY;IAalB,IACI,MAAM,YAIT;IAED,IACI,gBAAgB,IAAI,GAAG,CAAC,uBAAuB,CAAC,CAanD;IAUK,gBAAgB;IAqCtB,aAAa;IAOb,mBAAmB;IAqFnB,mBAAmB;IAQnB;;;;;OAKG;IACH,gBAAgB;IAgChB;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,aAAa,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IA+E3F;;;;OAIG;IACH,KAAK,sBAGH;IAEF;;;;OAIG;IACH,OAAO,sBAGL;IAEF,IACI,aAAa;;;;MAMhB;IAED,IACI,eAAe,wBAiBlB;IAED,WAAW;IAiBX,IACI,QAAQ,IAAI,MAAM,CAAC,EAAE,CAAC,CAmBzB;IAED,IACI,OAAO,IAAI,MAAM,CAAC,EAAE,CAAC,CAIxB;IAED,IAAI,KAAK,IAAI,KAAK,CASjB;IAED,IAAI,QAAQ,wBAEX;IAED,IAAI,MAAM,IACuB,EAAE,CAClC;CAuCF"}
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/-private/request.ts"],"names":[],"mappings":"AAIA,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAK3C,OAAO,KAAK,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAM3C,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AA2B5E,KAAK,uBAAuB,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;AACjE,KAAK,yBAAyB,GAC1B,OAAO,GACP,uBAAuB,GACvB,GAAG,uBAAuB,IAAI,uBAAuB,EAAE,GACvD,GAAG,uBAAuB,IAAI,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;AAEvF,KAAK,eAAe,CAAC,EAAE,IAAI;IACzB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;CAC5B,CAAC;AAEF,UAAU,gBAAgB,CAAC,CAAC,EAAE,EAAE;IAC9B,IAAI,EAAE;QACJ;;;;;WAKG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QAErB;;;;;;WAMG;QACH,KAAK,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAEjC;;;;;;;;WAQG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC;QAEd;;;;;;;;;;;;;WAaG;QACH,WAAW,CAAC,EAAE,yBAAyB,CAAC;QAExC;;;;;;;;;;WAUG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;;;;;;;;;;WAYG;QACH,mBAAmB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;KACvD,CAAC;IACF,MAAM,EAAE;QACN;;;;WAIG;QACH,IAAI,EAAE,EAAE,CAAC;QAET;;;;WAIG;QACH,OAAO,EAAE,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;QAEtC;;;;WAIG;QACH,SAAS,EAAE;YACT,KAAK,EAAE,uBAAuB;YAC9B,QAAQ,EAAE;gBAAE,QAAQ,EAAE,OAAO,CAAC;gBAAC,QAAQ,EAAE,OAAO,CAAC;gBAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;aAAE;SAC/E,CAAC;QAEF;;;;;;;;WAQG;QACH,KAAK,EAAE;YACL,KAAK,EAAE,uBAAuB;YAC9B,QAAQ,EAAE;gBAAE,QAAQ,EAAE,OAAO,CAAC;gBAAC,QAAQ,EAAE,OAAO,CAAC;gBAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;aAAE;SAC/E,CAAC;QAEF;;;;WAIG;QACH,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;KACtC,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwNG;AACH,qBAAa,OAAO,CAAC,CAAC,EAAE,EAAE,CAAE,SAAQ,SAAS,CAAC,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACpE;;;;;OAKG;IACuB,MAAM,EAAE,KAAK,CAAC;IAExC;;;;OAIG;IACM,QAAQ,UAAQ;IAEzB;;;;OAIG;IACM,QAAQ,UAAQ;IAEzB;;;;OAIG;IACM,YAAY,UAAS;IAE9B;;;;;;;;OAQG;IACM,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAE/C;;;;;;;;OAQG;IACM,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAEhD;;;;OAIG;IACK,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IAE5B;;;;;OAKG;IACK,aAAa,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAE9C;;;;;OAKG;IACK,iBAAiB,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAElD;;;;;OAKG;IACK,gBAAgB,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAEjD;;;;;OAKG;IACK,cAAc,EAAE,iBAAiB,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,CAAC;IAErD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEzB,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC;IAY3D,YAAY;IAalB,IACI,MAAM,YAIT;IAED,IACI,gBAAgB,IAAI,GAAG,CAAC,uBAAuB,CAAC,CAanD;IAUK,gBAAgB;IAqCtB,aAAa;IAOb,mBAAmB;IAqFnB,mBAAmB;IAQnB;;;;;OAKG;IACH,gBAAgB;IAgChB;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,aAAa,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IA+E3F;;;;OAIG;IACH,KAAK,sBAGH;IAEF;;;;OAIG;IACH,OAAO,sBAGL;IAEF,IACI,aAAa;;;;MAMhB;IAED,IACI,eAAe,wBAiBlB;IAED,WAAW;IAiBX,IACI,QAAQ,IAAI,MAAM,CAAC,EAAE,CAAC,CAmBzB;IAED,IACI,OAAO,IAAI,MAAM,CAAC,EAAE,CAAC,CAIxB;IAED,IAAI,KAAK,IAAI,KAAK,CASjB;IAED,IAAI,QAAQ,wBAEX;IAED,IAAI,MAAM,IACuB,EAAE,CAClC;CAuCF"}

package/unstable-preview-types/index.d.ts

@@ -3,6 +3,25 @@
 /// <reference path="./-private/await.d.ts" />
 /// <reference path="./-private/request.d.ts" />
 declare module '@warp-drive/ember' {
+  /**
+   * <h3 align="center">⚛️ Data utilities for using <em style="color: lightgreen">Warp</em><strong style="color: magenta">Drive</strong> with 🐹 <em style="color: orange">Ember</em><em style="color: lightblue">.js</em></h3>
+   *
+   * ## Installation
+   *
+   * ```cli
+   * pnpm install @warp-drive/ember
+   * ```
+   *
+   * ## About
+   *
+   * This library provides reactive utilities for working with promises
+   * and requests, building over these primitives to provide functions
+   * and components that enable you to build robust performant apps with
+   * elegant control flow.
+   *
+   * @module @warp-drive/ember
+   * @main @warp-drive/ember
+   */
   export { getRequestState } from '@warp-drive/ember/-private/request-state';
   export { getPromiseState } from '@warp-drive/ember/-private/promise-state';
   export { Request } from '@warp-drive/ember/-private/request.gts';

package/unstable-preview-types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC"}