@warp-drive/ember 5.7.0-alpha.23 → 5.7.0-alpha.25

package/declarations/-private/request.d.ts

@@ -1,88 +1,27 @@
 import Component from "@glimmer/component";
-import type { Store, StoreRequestInput } from "@warp-drive/core";
-import type { Future } from "@warp-drive/core/request";
-import type { RequestLoadingState, RequestState, RequestSubscription } from "@warp-drive/core/store/-private";
+import type { ComponentLike } from "@glint/template";
+import type { RequestManager, Store } from "@warp-drive/core";
+import type { ContentFeatures, RecoveryFeatures, RequestArgs, RequestLoadingState, RequestState, RequestSubscription } from "@warp-drive/core/store/-private";
 import type { StructuredErrorDocument } from "@warp-drive/core/types/request";
-type AutorefreshBehaviorType = "online" | "interval" | "invalid";
-type AutorefreshBehaviorCombos = boolean | AutorefreshBehaviorType | `${AutorefreshBehaviorType},${AutorefreshBehaviorType}` | `${AutorefreshBehaviorType},${AutorefreshBehaviorType},${AutorefreshBehaviorType}`;
-/**
-* Utilities to assist in recovering from the error.
-*/ export interface RecoveryFeatures {
-	isOnline: boolean;
-	isHidden: boolean;
-	retry: () => Promise<void>;
-}
-/**
-* Utilities for keeping the request fresh
-*/ export interface ContentFeatures<RT> {
-	isOnline: boolean;
-	isHidden: boolean;
-	isRefreshing: boolean;
-	refresh: () => Promise<void>;
-	reload: () => Promise<void>;
-	abort?: () => void;
-	latestRequest?: Future<RT>;
+export interface EmberRequestArgs<
+	RT,
+	E
+> extends RequestArgs<RT, E> {
+	chrome?: ComponentLike<{
+		Blocks: {
+			default: [];
+		};
+		Args: {
+			state: RequestState | null;
+			features: ContentFeatures<RT>;
+		};
+	}>;
 }
 interface RequestSignature<
 	RT,
 	E
 > {
-	Args: {
-		/**
-		* The request to monitor. This should be a `Future` instance returned
-		* by either the `store.request` or `store.requestManager.request` methods.
-		*
-		*/ 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.
-		*
-		*/ query?: StoreRequestInput<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.
-		*
-		*/ 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`.
-		*
-		*/ 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).
-		*
-		*/ 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'`.
-		*
-		*/ autorefreshBehavior?: "refresh" | "reload" | "policy";
-	};
+	Args: EmberRequestArgs<RT, E>;
 	Blocks: {
 		/**
 		* The block to render when the component is idle and waiting to be given a request.
@@ -324,7 +263,6 @@ interface RequestSignature<
 * same, only one actual request will be made.
 *
 *
-* @class <Request />
 * @public
 */ export declare class Request<
 	RT,
@@ -336,9 +274,22 @@ interface RequestSignature<
 	*
 	* @internal
 	*/ _store: Store;
-	get store(): Store;
+	get store(): Store | RequestManager;
 	_state: RequestSubscription<RT, E> | null;
 	get state(): RequestSubscription<RT, E>;
+	/**
+	* The chrome component to use for rendering the request.
+	*
+	* @private
+	*/ get Chrome(): ComponentLike<{
+		Blocks: {
+			default: [];
+		};
+		Args: {
+			state: RequestState | null;
+			features: ContentFeatures<RT>;
+		};
+	}>;
 	willDestroy(): void;
 }
 export {};

package/declarations/index.d.ts

@@ -43,7 +43,7 @@
 *
 * @module
 */
-export { Request } from "./-private/request.js";
+export { Request, type ContentFeatures } from "./-private/request.js";
 export { Await, Throw } from "./-private/await.js";
 /**
 * PromiseState provides a reactive wrapper for a promise which allows you write declarative
@@ -212,4 +212,4 @@ export { getPromiseState } from "@warp-drive/core/store/-private";
 * @param future
 * @return {RequestState}
 */
-export { getRequestState, type RequestLoadingState } from "@warp-drive/core/store/-private";
+export { getRequestState, createRequestSubscription, type RequestLoadingState } from "@warp-drive/core/store/-private";

package/dist/index.js

@@ -1,10 +1,12 @@
 import { service } from '@ember/service';
 import Component from '@glimmer/component';
+import { cached } from '@glimmer/tracking';
 import { macroCondition, moduleExists, importSync, getGlobalConfig } from '@embroider/macros';
 import { getPromiseState, DISPOSE, createRequestSubscription } from '@warp-drive/core/store/-private';
-export { getPromiseState, getRequestState } from '@warp-drive/core/store/-private';
+export { createRequestSubscription, getPromiseState, getRequestState } from '@warp-drive/core/store/-private';
 import { precompileTemplate } from '@ember/template-compilation';
 import { setComponentTemplate } from '@ember/component';
+import templateOnly from '@ember/component/template-only';
 
 const and = (x, y) => Boolean(x && y);
 /**
@@ -129,6 +131,20 @@ function decorateFieldV2(prototype, prop, decorators, initializer) {
     deferDecorator(prototype, prop, desc);
   }
 }
+function decorateMethodV2(prototype, prop, decorators) {
+  const origDesc = Object.getOwnPropertyDescriptor(prototype, prop);
+  let desc = {
+    ...origDesc
+  };
+  for (let decorator of decorators) {
+    desc = decorator(prototype, prop, desc) || desc;
+  }
+  if (desc.initializer !== void 0) {
+    desc.value = desc.initializer ? desc.initializer.call(prototype) : void 0;
+    desc.initializer = void 0;
+  }
+  Object.defineProperty(prototype, prop, desc);
+}
 function initializeDeferredDecorator(target, prop) {
   let desc = findDeferredDecorator(target.constructor, prop);
   if (desc) {
@@ -158,15 +174,9 @@ if (macroCondition(moduleExists('ember-provide-consume-context'))) {
   } = importSync('ember-provide-consume-context');
   consume = contextConsume;
 }
-
-/**
- * Utilities to assist in recovering from the error.
- */
-
-/**
- * Utilities for keeping the request fresh
- */
-
+const DefaultChrome = setComponentTemplate(precompileTemplate("{{yield}}", {
+  strictMode: true
+}), templateOnly());
 /**
  * The `<Request />` component is a powerful tool for managing data fetching and
  * state in your Ember application. It provides a declarative approach to reactive
@@ -381,7 +391,6 @@ if (macroCondition(moduleExists('ember-provide-consume-context'))) {
  * same, only one actual request will be made.
  *
  *
- * @class <Request />
  * @public
  */
 class Request extends Component {
@@ -412,21 +421,40 @@ class Request extends Component {
     const {
       store
     } = this;
-    if (_state && _state.store !== store) {
+    const {
+      subscription
+    } = this.args;
+    if (_state && (_state.store !== store || subscription)) {
       _state[DISPOSE]();
       _state = null;
     }
+    if (subscription) {
+      return subscription;
+    }
     if (!_state) {
       this._state = _state = createRequestSubscription(store, this.args);
     }
     return _state;
   }
+  /**
+  * The chrome component to use for rendering the request.
+  *
+  * @private
+  */
+  get Chrome() {
+    return this.args.chrome || DefaultChrome;
+  }
+  static {
+    decorateMethodV2(this.prototype, "Chrome", [cached]);
+  }
   willDestroy() {
-    this._state[DISPOSE]();
-    this._state = null;
+    if (this._state) {
+      this._state[DISPOSE]();
+      this._state = null;
+    }
   }
   static {
-    setComponentTemplate(precompileTemplate("\n    {{#if (and this.state.isIdle (has-block \"idle\"))}}\n      {{yield to=\"idle\"}}\n\n    {{else if this.state.isIdle}}\n      <Throw @error={{IdleBlockMissingError}} />\n\n    {{else if this.state.reqState.isLoading}}\n      {{yield this.state.reqState.loadingState to=\"loading\"}}\n\n    {{else if (and this.state.reqState.isCancelled (has-block \"cancelled\"))}}\n      {{yield (notNull this.state.reqState.reason) this.state.errorFeatures to=\"cancelled\"}}\n\n    {{else if (and this.state.reqState.isError (has-block \"error\"))}}\n      {{yield (notNull this.state.reqState.reason) this.state.errorFeatures to=\"error\"}}\n\n    {{else if this.state.reqState.isSuccess}}\n      {{yield this.state.result this.state.contentFeatures to=\"content\"}}\n\n    {{else if (not this.state.reqState.isCancelled)}}\n      <Throw @error={{(notNull this.state.reqState.reason)}} />\n    {{/if}}\n\n    {{yield this.state.reqState to=\"always\"}}\n  ", {
+    setComponentTemplate(precompileTemplate("\n    <this.Chrome @state={{if this.state.isIdle null this.state.reqState}} @features={{this.state.contentFeatures}}>\n      {{#if (and this.state.isIdle (has-block \"idle\"))}}\n        {{yield to=\"idle\"}}\n\n      {{else if this.state.isIdle}}\n        <Throw @error={{IdleBlockMissingError}} />\n\n      {{else if this.state.reqState.isLoading}}\n        {{yield this.state.reqState.loadingState to=\"loading\"}}\n\n      {{else if (and this.state.reqState.isCancelled (has-block \"cancelled\"))}}\n        {{yield (notNull this.state.reqState.reason) this.state.errorFeatures to=\"cancelled\"}}\n\n      {{else if (and this.state.reqState.isError (has-block \"error\"))}}\n        {{yield (notNull this.state.reqState.reason) this.state.errorFeatures to=\"error\"}}\n\n      {{else if this.state.reqState.isSuccess}}\n        {{yield this.state.result this.state.contentFeatures to=\"content\"}}\n\n      {{else if (not this.state.reqState.isCancelled)}}\n        <Throw @error={{(notNull this.state.reqState.reason)}} />\n      {{/if}}\n\n      {{yield this.state.reqState to=\"always\"}}\n    </this.Chrome>\n  ", {
       strictMode: true,
       scope: () => ({
         and,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@warp-drive/ember",
   "description": "Data bindings and utilities for Ember applications using WarpDrive",
-  "version": "5.7.0-alpha.23",
+  "version": "5.7.0-alpha.25",
   "license": "MIT",
   "author": "Chris Thoburn <runspired@users.noreply.github.com>",
   "repository": {
@@ -38,7 +38,7 @@
   },
   "dependencies": {
     "@embroider/macros": "^1.16.12",
-    "@warp-drive/core": "5.7.0-alpha.23"
+    "@warp-drive/core": "5.7.0-alpha.25"
   },
   "peerDependenciesMeta": {
     "ember-provide-consume-context": {
@@ -60,8 +60,8 @@
     "@embroider/addon-dev": "^7.1.3",
     "@ember/test-helpers": "5.2.0",
     "@ember/test-waiters": "^4.1.0",
-    "@warp-drive/internal-config": "5.7.0-alpha.23",
-    "@warp-drive/core": "5.7.0-alpha.23",
+    "@warp-drive/internal-config": "5.7.0-alpha.25",
+    "@warp-drive/core": "5.7.0-alpha.25",
     "babel-plugin-ember-template-compilation": "^2.4.1",
     "ember-template-imports": "^4.3.0",
     "ember-source": "~6.3.0",