@warp-drive/ember 0.0.0-alpha.6 → 0.0.0-alpha.61

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

@@ -3,31 +3,191 @@ declare module '@warp-drive/ember/-private/request' {
   import type { Future, StructuredErrorDocument } from '@ember-data/request';
   import type { StoreRequestInput } from '@ember-data/store';
   import type Store from '@ember-data/store';
-  import type { RequestLoadingState } from '@warp-drive/ember/-private/request-state.ts';
-  interface RequestSignature<T> {
+  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 ContentFeatures<RT> = {
+      isOnline: boolean;
+      isHidden: boolean;
+      isRefreshing: boolean;
+      refresh: () => Promise<void>;
+      reload: () => Promise<void>;
+      abort?: () => void;
+      latestRequest?: Future<RT>;
+  };
+  interface RequestSignature<T, RT> {
       Args: {
-          request?: Future<T>;
-          query?: StoreRequestInput;
+          request?: Future<RT>;
+          query?: StoreRequestInput<T, RT>;
           store?: Store;
+          autorefresh?: AutorefreshBehaviorCombos;
+          autorefreshThreshold?: number;
+          autorefreshBehavior?: 'refresh' | 'reload' | 'policy';
       };
       Blocks: {
           loading: [state: RequestLoadingState];
-          cancelled: [error: StructuredErrorDocument];
-          error: [error: StructuredErrorDocument];
-          content: [value: T];
+          cancelled: [
+              error: StructuredErrorDocument,
+              features: {
+                  isOnline: boolean;
+                  isHidden: boolean;
+                  retry: () => Promise<void>;
+              }
+          ];
+          error: [
+              error: StructuredErrorDocument,
+              features: {
+                  isOnline: boolean;
+                  isHidden: boolean;
+                  retry: () => Promise<void>;
+              }
+          ];
+          content: [value: RT, features: ContentFeatures<RT>];
+          always: [state: RequestState<T, RT>];
       };
   }
-  export class Request<T> extends Component<RequestSignature<T>> {
+  /**
+   * 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.
+   *
+   * @typedoc
+   */
+  export class Request<T, RT> extends Component<RequestSignature<T, RT>> {
       /**
+       * The store instance to use for making requests. If contexts are available, this
+       * will be the `store` on the context, else it will be the store service.
+       *
        * @internal
        */
       _store: Store;
-      retry: () => void;
-      reload: () => void;
-      refresh: () => void;
-      get request(): Future<T>;
+      /**
+       * Whether the browser reports that the network is online.
+       *
+       * @internal
+       */
+      isOnline: boolean;
+      /**
+       * Whether the browser reports that the tab is hidden.
+       *
+       * @internal
+       */
+      isHidden: boolean;
+      /**
+       * Whether the component is currently refreshing the request.
+       *
+       * @internal
+       */
+      isRefreshing: boolean;
+      /**
+       * The most recent blocking request that was made, typically
+       * the result of a reload.
+       *
+       * This will never be the original request passed as an arg to
+       * the component.
+       *
+       * @internal
+       */
+      _localRequest: Future<RT> | undefined;
+      /**
+       * The most recent request that was made, typically due to either a
+       * reload or a refresh.
+       *
+       * This will never be the original request passed as an arg to
+       * the component.
+       *
+       * @internal
+       */
+      _latestRequest: Future<RT> | undefined;
+      /**
+       * The time at which the network was reported as offline.
+       *
+       * @internal
+       */
+      unavailableStart: number | null;
+      intervalStart: number | null;
+      nextInterval: number | null;
+      invalidated: boolean;
+      /**
+       * The event listener for network status changes,
+       * cached to use the reference for removal.
+       *
+       * @internal
+       */
+      onlineChanged: (event: Event) => void;
+      /**
+       * The event listener for visibility status changes,
+       * cached to use the reference for removal.
+       *
+       * @internal
+       */
+      backgroundChanged: (event: Event) => void;
+      /**
+       * The last request passed as an arg to the component,
+       * cached for comparison.
+       *
+       * @internal
+       */
+      _originalRequest: Future<RT> | undefined;
+      /**
+       * The last query passed as an arg to the component,
+       * cached for comparison.
+       *
+       * @internal
+       */
+      _originalQuery: StoreRequestInput<T, RT> | undefined;
+      _subscription: object | null;
+      _subscribedTo: object | null;
+      constructor(owner: unknown, args: RequestSignature<T, RT>['Args']);
+      get autorefreshTypes(): Set<AutorefreshBehaviorType>;
+      scheduleInterval(): Promise<void>;
+      clearInterval(): void;
+      updateSubscriptions(): void;
+      removeSubscriptions(): void;
+      /**
+       * Install the event listeners for network and visibility changes.
+       * This is only done in browser environments with a global `window`.
+       *
+       * @internal
+       */
+      installListeners(): void;
+      /**
+       * If the network is online and the tab is visible, either reload or refresh the request
+       * based on the component's configuration and the requested update mode.
+       *
+       * Valid modes are:
+       *
+       * - `'reload'`: Force a reload of the request.
+       * - `'refresh'`: Refresh the request in the background.
+       * - `'policy'`: Make the request, letting the store's configured CachePolicy decide whether to reload, refresh, or do nothing.
+       * - `undefined`: Make the request using the component's autorefreshBehavior setting if the autorefreshThreshold has passed.
+       *
+       * @internal
+       */
+      maybeUpdate(mode?: 'reload' | 'refresh' | 'policy' | 'invalidated', silent?: boolean): void;
+      /**
+       * Retry the request, reloading it from the server.
+       *
+       * @internal
+       */
+      retry: () => Promise<void>;
+      /**
+       * Refresh the request, updating it in the background.
+       *
+       * @internal
+       */
+      refresh: () => Promise<void>;
+      get errorFeatures(): {
+          isHidden: boolean;
+          isOnline: boolean;
+          retry: () => Promise<void>;
+      };
+      get contentFeatures(): ContentFeatures<RT>;
+      willDestroy(): void;
+      get request(): Future<RT>;
       get store(): Store;
-      get reqState(): import("@warp-drive/ember/-private/request-state.ts").RequestState<T>;
+      get reqState(): RequestState<T, RT>;
+      get result(): RT;
   }
   export {};
 }

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":"AAEA,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAE3C,OAAO,KAAK,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAI3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAG3C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAS9D,UAAU,gBAAgB,CAAC,CAAC;IAC1B,IAAI,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACpB,KAAK,CAAC,EAAE,iBAAiB,CAAC;QAC1B,KAAK,CAAC,EAAE,KAAK,CAAC;KACf,CAAC;IACF,MAAM,EAAE;QACN,OAAO,EAAE,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;QACtC,SAAS,EAAE,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;QAC5C,KAAK,EAAE,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;QACxC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;KACrB,CAAC;CACH;AAED,qBAAa,OAAO,CAAC,CAAC,CAAE,SAAQ,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAC5D;;OAEG;IACuB,MAAM,EAAE,KAAK,CAAC;IAExC,KAAK,aAAY;IACjB,MAAM,aAAY;IAClB,OAAO,aAAY;IAEnB,IACI,OAAO,cAQV;IAED,IAAI,KAAK,IAAI,KAAK,CASjB;IAED,IAAI,QAAQ,iDAEX;CAyBF"}
+{"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;AAwB5E,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,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;IAE7B;;;;;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;IAajE,IACI,gBAAgB,IAAI,GAAG,CAAC,uBAAuB,CAAC,CAanD;IAUK,gBAAgB;IAqCtB,aAAa;IAOb,mBAAmB;IA4CnB,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;IAqE3F;;;;OAIG;IACH,KAAK,sBAGH;IAEF;;;;OAIG;IACH,OAAO,sBAGL;IAEF,IACI,aAAa;;;;MAMhB;IAED,IACI,eAAe,wBAiBlB;IAED,WAAW;IAiBX,IACI,OAAO,IAAI,MAAM,CAAC,EAAE,CAAC,CAmBxB;IAED,IAAI,KAAK,IAAI,KAAK,CASjB;IAED,IAAI,QAAQ,wBAEX;IAED,IAAI,MAAM,OAET;CA4BF"}

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

@@ -1,10 +1,10 @@
-/// <reference path="./-private/promise-state.d.ts" />
-/// <reference path="./-private/request-state.d.ts" />
-/// <reference path="./-private/request.d.ts" />
 /// <reference path="./-private/await.d.ts" />
+/// <reference path="./-private/request.d.ts" />
+/// <reference path="./-private/request-state.d.ts" />
+/// <reference path="./-private/promise-state.d.ts" />
 declare module '@warp-drive/ember' {
-  export { getRequestState } from '@warp-drive/ember/-private/request-state.ts';
-  export { getPromiseState } from '@warp-drive/ember/-private/promise-state.ts';
+  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';
   export { Await, Throw } from '@warp-drive/ember/-private/await.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,6BAA6B,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,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,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"}