@ember-data-mirror/request 5.4.0-alpha.49

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

@@ -0,0 +1,224 @@
+declare module '@ember-data-mirror/request/-private/types' {
+  import type { IS_FUTURE, RequestContext, RequestInfo, ResponseInfo, StructuredDataDocument } from '@warp-drive-mirror/core-types/request';
+  /**
+   * @module @ember-data-mirror/request
+   */
+  export interface GodContext {
+      controller: AbortController;
+      response: ResponseInfo | null;
+      stream: ReadableStream | Promise<ReadableStream | null> | null;
+      hasRequestedStream: boolean;
+      id: number;
+  }
+  export type Deferred<T> = {
+      resolve(v: T): void;
+      reject(v: unknown): void;
+      promise: Promise<T>;
+  };
+  export type DeferredStream = {
+      resolve(v: ReadableStream | null): void;
+      reject(v: unknown): void;
+      promise: Promise<ReadableStream | null> & {
+          sizeHint?: number;
+      };
+  };
+  /**
+   * A Future is a Promise which resolves to a StructuredDocument
+   * while providing the ability to `abort` the underlying request,
+   * `getStream` the response before the outer promise resolves;
+   *
+   * @class Future
+   * @extends Promise
+   * @public
+   */
+  export type Future<T> = Promise<StructuredDataDocument<T>> & {
+      [IS_FUTURE]: true;
+      /**
+       * Cancel this request by firing the AbortController's signal.
+       *
+       * @method abort
+       * @param {string} [reason] optional reason for aborting the request
+       * @public
+       * @return {void}
+       */
+      abort(reason?: string): void;
+      /**
+       * Get the response stream, if any, once made available.
+       *
+       * @method getStream
+       * @public
+       * @return {Promise<ReadableStream | null>}
+       */
+      getStream(): Promise<ReadableStream | null>;
+      /**
+       *  Run a callback when this request completes. Use sparingly,
+       *  mostly useful for instrumentation and infrastructure.
+       *
+       * @method onFinalize
+       * @param cb the callback to run
+       * @public
+       * @return void
+       */
+      onFinalize(cb: () => void): void;
+  };
+  export type DeferredFuture<T> = {
+      resolve(v: StructuredDataDocument<T>): void;
+      reject(v: unknown): void;
+      promise: Future<T>;
+  };
+  export type NextFn<P = unknown> = (req: RequestInfo) => Future<P>;
+  /**
+   * Requests are fulfilled by handlers. A handler receives the request context
+  as well as a `next` function with which to pass along a request to the next
+  handler if it so chooses.
+  
+  A handler may be any object with a `request` method. This allows both stateful and non-stateful
+  handlers to be utilized.
+  
+  If a handler calls `next`, it receives a `Future` which resolves to a `StructuredDocument`
+  that it can then compose how it sees fit with its own response.
+  
+  ```ts
+  type NextFn<P> = (req: RequestInfo) => Future<P>;
+  
+  interface Handler {
+    async request<T>(context: RequestContext, next: NextFn<P>): T;
+  }
+  ```
+  
+  `RequestContext` contains a readonly version of the RequestInfo as well as a few methods for building up the `StructuredDocument` and `Future` that will be part of the response.
+  
+  ```ts
+  interface RequestContext<T> {
+    readonly request: RequestInfo;
+  
+    setStream(stream: ReadableStream | Promise<ReadableStream>): void;
+    setResponse(response: Response | ResponseInfo): void;
+  }
+  ```
+  
+  A basic `fetch` handler with support for streaming content updates while
+  the download is still underway might look like the following, where we use
+  [`response.clone()`](https://developer.mozilla.org/en-US/docs/Web/API/Response/clone) to `tee` the `ReadableStream` into two streams.
+  
+  A more efficient handler might read from the response stream, building up the
+  response content before passing along the chunk downstream.
+  
+  ```ts
+  const FetchHandler = {
+    async request(context) {
+      const response = await fetch(context.request);
+      context.setResponse(reponse);
+      context.setStream(response.clone().body);
+  
+      return response.json();
+    }
+  }
+  ```
+  
+  ### Stream Currying
+  
+  `RequestManager.request` and `next` differ from `fetch` in one **crucial detail** in that the outer Promise resolves only once the response stream has been processed.
+  
+  For context, it helps to understand a few of the use-cases that RequestManager
+  is intended to allow.
+  
+   - to manage and return streaming content (such as video files)
+   - to fulfill a request from multiple sources or by splitting one request into multiple requests
+     - for instance one API call for a user and another for the user's friends
+     - or e.g. fulfilling part of the request from one source (one API, in-memory, localStorage, IndexedDB etc.) and the rest from another source (a different API, a WebWorker, etc.)
+   - to coalesce multiple requests
+   - to decorate a request with additional info
+     - e.g. an Auth handler that ensures the correct tokens or headers or cookies are attached.
+  
+  ----
+  
+  `await fetch(<req>)` resolves at the moment headers are received. This allows for the body of the request to be processed as a stream by application
+  code *while chunks are still being received by the browser*.
+  
+  When an app chooses to `await response.json()` what occurs is the browser reads the stream to completion and then returns the result. Additionally, this stream may only be read **once**.
+  
+  The `RequestManager` preserves this ability to subscribe to and utilize the stream by either the application or the handler – thereby delivering the full power and flexibility of native APIs – without restricting developers in ways that lead to complicated workarounds.
+  
+  Each handler may call `setStream` only once, but may do so *at any time* until the promise that the handler returns has resolved. The associated promise returned by calling `future.getStream` will resolve with the stream set by `setStream` if that method is called, or `null` if that method
+  has not been called by the time that the handler's request method has resolved.
+  
+  Handlers that do not create a stream of their own, but which call `next`, should defensively pipe the stream forward. While this is not required (see automatic currying below) it is better to do so in most cases as otherwise the stream may not become available to downstream handlers or the application until the upstream handler has fully read it.
+  
+  ```ts
+  context.setStream(future.getStream());
+  ```
+  
+  Handlers that either call `next` multiple times or otherwise have reason to create multiple  fetch requests should either choose to return no stream, meaningfully combine the streams, or select a single prioritized stream.
+  
+  Of course, any handler may choose to read and handle the stream, and return either no stream or a different stream in the process.
+  
+  ### Automatic Currying of Stream and Response
+  
+  In order to simplify the common case for handlers which decorate a request, if `next` is called only a single time and `setResponse` was never called by the handler, the response set by the next handler in the chain will be applied to that handler's outcome. For instance, this makes the following pattern possible `return (await next(<req>)).content;`.
+  
+  Similarly, if `next` is called only a single time and neither `setStream` nor `getStream` was called, we automatically curry the stream from the future returned by `next` onto the future returned by the handler.
+  
+  Finally, if the return value of a handler is a `Future`, we curry `content` and `errors` as well, thus enabling the simplest form `return next(<req>)`.
+  
+  In the case of the `Future` being returned, `Stream` proxying is automatic and immediate and does not wait for the `Future` to resolve.
+  
+  ### Handler Order
+  
+  Request handlers are registered by configuring the manager via `use`
+  
+  ```ts
+  const manager = new RequestManager();
+  
+  manager.use([Handler1, Handler2]);
+  ```
+  
+  Handlers will be invoked in the order they are registered ("fifo", first-in first-out), and may only be registered up until the first request is made. It is recommended but not required to register all handlers at one time in order to ensure explicitly visible handler ordering.
+  
+  
+   @class <Interface> Handler
+   @public
+  */
+  export interface Handler {
+      /**
+       * Method to implement to handle requests. Receives the request
+       * context and a nextFn to call to pass-along the request to
+       * other handlers.
+       *
+       * @method request
+       * @public
+       * @param context
+       * @param next
+       */
+      request<T = unknown>(context: RequestContext, next: NextFn<T>): Promise<T | StructuredDataDocument<T>> | Future<T>;
+  }
+  /**
+   * The CacheHandler is identical to other handlers ecxept that it
+   * is allowed to return a value synchronously. This is useful for
+   * features like reducing microtask queueing when de-duping.
+   *
+   * A RequestManager may only have one CacheHandler, registered via
+   * `manager.useCache(CacheHandler)`.
+   *
+   * @class <Interface> CacheHandler
+   * @public
+   */
+  export interface CacheHandler {
+      /**
+       * Method to implement to handle requests. Receives the request
+       * context and a nextFn to call to pass-along the request to
+       * other handlers.
+       *
+       * @method request
+       * @public
+       * @param context
+       * @param next
+       */
+      request<T = unknown>(context: RequestContext, next: NextFn<T>): Promise<T | StructuredDataDocument<T>> | Future<T> | T;
+  }
+  export interface RequestResponse<T> {
+      result: T;
+  }
+  export type GenericCreateArgs = Record<string | symbol, unknown>;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/-private/types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,SAAS,EACT,cAAc,EACd,WAAW,EACX,YAAY,EACZ,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,eAAe,CAAC;IAC5B,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAC/D,kBAAkB,EAAE,OAAO,CAAC;IAC5B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;IACxB,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;IACpB,MAAM,CAAC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,CAAC,CAAC,EAAE,cAAc,GAAG,IAAI,GAAG,IAAI,CAAC;IACxC,MAAM,CAAC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACjE,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAAG;IAC3D,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;IAClB;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B;;;;;;OAMG;IACH,SAAS,IAAI,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAE5C;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC9B,OAAO,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC5C,MAAM,CAAC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,MAAM,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,GAAG,EAAE,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+GE;AACF,MAAM,WAAW,OAAO;IACtB;;;;;;;;;OASG;IACH,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;CACpH;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;OASG;IACH,OAAO,CAAC,CAAC,GAAG,OAAO,EACjB,OAAO,EAAE,cAAc,EACvB,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,GACd,OAAO,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CAC3D;AAED,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,MAAM,EAAE,CAAC,CAAC;CACX;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC"}

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

@@ -0,0 +1,18 @@
+declare module '@ember-data-mirror/request/-private/utils' {
+  import { type RequestInfo, type StructuredDataDocument } from '@warp-drive-mirror/core-types/request';
+  import { ContextOwner } from '@ember-data-mirror/request/-private/context';
+  import type { DeferredFuture, Future, GodContext, Handler } from '@ember-data-mirror/request/-private/types';
+  export const IS_CACHE_HANDLER: unique symbol;
+  export function curryFuture<T>(owner: ContextOwner, inbound: Future<T>, outbound: DeferredFuture<T>): Future<T>;
+  export type HttpErrorProps = {
+      code: number;
+      name: string;
+      status: number;
+      statusText: string;
+      isRequestError: boolean;
+  };
+  export function enhanceReason(reason?: string): DOMException;
+  export function handleOutcome<T>(owner: ContextOwner, inbound: Promise<T | StructuredDataDocument<T>>, outbound: DeferredFuture<T>): Future<T>;
+  export function executeNextHandler<T>(wares: Readonly<Handler[]>, request: RequestInfo, i: number, god: GodContext): Future<T>;
+}
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/-private/utils.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,WAAW,EAEhB,KAAK,sBAAsB,EAE5B,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAW,YAAY,EAAE,MAAM,WAAW,CAAC;AAIlD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE3E,eAAO,MAAM,gBAAgB,eAA6B,CAAC;AAC3D,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAuC9G;AAMD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,wBAAgB,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,gBAE5C;AAED,wBAAgB,aAAa,CAAC,CAAC,EAC7B,KAAK,EAAE,YAAY,EACnB,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC,EAC/C,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAC1B,MAAM,CAAC,CAAC,CAAC,CAwCX;AAMD,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,EAC1B,OAAO,EAAE,WAAW,EACpB,CAAC,EAAE,MAAM,EACT,GAAG,EAAE,UAAU,GACd,MAAM,CAAC,CAAC,CAAC,CA8CX"}

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

@@ -0,0 +1,34 @@
+declare module '@ember-data-mirror/request/fetch' {
+  /**
+   * A basic Fetch Handler which converts a request into a
+   * `fetch` call presuming the response to be `json`.
+   *
+   * ```ts
+   * import Fetch from '@ember-data-mirror/request/fetch';
+   *
+   * manager.use([Fetch]);
+   * ```
+   *
+   * @module @ember-data-mirror/request/fetch
+   * @main @ember-data-mirror/request/fetch
+   */
+  import { type Context } from '@ember-data-mirror/request/-private/context';
+  /**
+   * A basic handler which converts a request into a
+   * `fetch` call presuming the response to be `json`.
+   *
+   * ```ts
+   * import Fetch from '@ember-data-mirror/request/fetch';
+   *
+   * manager.use([Fetch]);
+   * ```
+   *
+   * @class Fetch
+   * @public
+   */
+  const Fetch: {
+      request<T>(context: Context): Promise<T>;
+  };
+  export default Fetch;
+}
+//# sourceMappingURL=fetch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAIH,OAAO,EAA2B,KAAK,OAAO,EAAE,MAAM,oBAAoB,CAAC;AA8E3E;;;;;;;;;;;;GAYG;AACH,QAAA,MAAM,KAAK;wBACiB,OAAO,GAAG,QAAQ,CAAC,CAAC;CAiJ/C,CAAC;AAMF,eAAe,KAAK,CAAC"}

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

@@ -0,0 +1,17 @@
+/// <reference path="./fetch.d.ts" />
+/// <reference path="./-private/promise-cache.d.ts" />
+/// <reference path="./-private/utils.d.ts" />
+/// <reference path="./-private/debug.d.ts" />
+/// <reference path="./-private/context.d.ts" />
+/// <reference path="./-private/manager.d.ts" />
+/// <reference path="./-private/types.d.ts" />
+/// <reference path="./-private/future.d.ts" />
+declare module '@ember-data-mirror/request' {
+  export { RequestManager as default } from '@ember-data-mirror/request/-private/manager';
+  export { createDeferred } from '@ember-data-mirror/request/-private/future';
+  export type { Future, Handler, CacheHandler, NextFn } from '@ember-data-mirror/request/-private/types';
+  export type { RequestContext, ImmutableRequestInfo, RequestInfo, ResponseInfo, StructuredDocument, StructuredErrorDocument, StructuredDataDocument, } from '@warp-drive-mirror/core-types/request';
+  export { setPromiseResult, getPromiseResult } from '@ember-data-mirror/request/-private/promise-cache';
+  export type { Awaitable } from '@ember-data-mirror/request/-private/promise-cache';
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC9E,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC9E,YAAY,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC"}