@warp-drive/ember 5.6.0-beta.1 → 5.6.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +1 -1
  2. package/declarations/-private/request.d.ts +37 -94
  3. package/declarations/index.d.ts +4 -4
  4. package/dist/index.js +51 -9
  5. package/package.json +25 -20
package/README.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  ---
20
20
 
21
- ```cli
21
+ ```sh
22
22
  pnpm install @warp-drive/ember
23
23
  ```
24
24
 
package/declarations/-private/request.d.ts CHANGED
@@ -1,80 +1,28 @@
1
1
  import Component from "@glimmer/component";
2
- import type { Store, StoreRequestInput } from "@warp-drive/core";
3
- import type { Future } from "@warp-drive/core/request";
4
- import type { RequestLoadingState, RequestState, RequestSubscription } from "@warp-drive/core/store/-private";
2
+ import type { ComponentLike } from "@glint/template";
3
+ import type { RequestManager, Store } from "@warp-drive/core";
4
+ import type { ContentFeatures, RecoveryFeatures, RequestArgs, RequestLoadingState, RequestState, RequestSubscription } from "@warp-drive/core/store/-private";
5
5
  import type { StructuredErrorDocument } from "@warp-drive/core/types/request";
6
- type AutorefreshBehaviorType = "online" | "interval" | "invalid";
7
- type AutorefreshBehaviorCombos = boolean | AutorefreshBehaviorType | `${AutorefreshBehaviorType},${AutorefreshBehaviorType}` | `${AutorefreshBehaviorType},${AutorefreshBehaviorType},${AutorefreshBehaviorType}`;
8
- type ContentFeatures<RT> = {
9
- isOnline: boolean;
10
- isHidden: boolean;
11
- isRefreshing: boolean;
12
- refresh: () => Promise<void>;
13
- reload: () => Promise<void>;
14
- abort?: () => void;
15
- latestRequest?: Future<RT>;
16
- };
6
+ export { ContentFeatures, RecoveryFeatures };
7
+ export interface EmberRequestArgs<
8
+ RT,
9
+ E
10
+ > extends RequestArgs<RT, E> {
11
+ chrome?: ComponentLike<{
12
+ Blocks: {
13
+ default: [];
14
+ };
15
+ Args: {
16
+ state: RequestState | null;
17
+ features: ContentFeatures<RT>;
18
+ };
19
+ }>;
20
+ }
17
21
  interface RequestSignature<
18
22
  RT,
19
- T,
20
23
  E
21
24
  > {
22
- Args: {
23
- /**
24
- * The request to monitor. This should be a `Future` instance returned
25
- * by either the `store.request` or `store.requestManager.request` methods.
26
- *
27
- */ request?: Future<RT>;
28
- /**
29
- * A query to use for the request. This should be an object that can be
30
- * passed to `store.request`. Use this in place of `@request` if you would
31
- * like the component to also initiate the request.
32
- *
33
- */ query?: StoreRequestInput<RT, T>;
34
- /**
35
- * The store instance to use for making requests. If contexts are available,
36
- * the component will default to using the `store` on the context.
37
- *
38
- * This is required if the store is not available via context or should be
39
- * different from the store provided via context.
40
- *
41
- */ store?: Store;
42
- /**
43
- * The autorefresh behavior for the request. This can be a boolean, or any
44
- * combination of the following values: `'online'`, `'interval'`, `'invalid'`.
45
- *
46
- * - `'online'`: Refresh the request when the browser comes back online
47
- * - `'interval'`: Refresh the request at a specified interval
48
- * - `'invalid'`: Refresh the request when the store emits an invalidation
49
- *
50
- * If `true`, this is equivalent to `'online,invalid'`.
51
- *
52
- * Defaults to `false`.
53
- *
54
- */ autorefresh?: AutorefreshBehaviorCombos;
55
- /**
56
- * The number of milliseconds to wait before refreshing the request when the
57
- * browser comes back online or the network becomes available.
58
- *
59
- * This also controls the interval at which the request will be refreshed if
60
- * the `interval` autorefresh type is enabled.
61
- *
62
- * Defaults to `30_000` (30 seconds).
63
- *
64
- */ autorefreshThreshold?: number;
65
- /**
66
- * The behavior of the request initiated by autorefresh. This can be one of
67
- * the following values:
68
- *
69
- * - `'refresh'`: Refresh the request in the background
70
- * - `'reload'`: Force a reload of the request
71
- * - `'policy'` (**default**): Let the store's configured CachePolicy decide whether to
72
- * reload, refresh, or do nothing.
73
- *
74
- * Defaults to `'policy'`.
75
- *
76
- */ autorefreshBehavior?: "refresh" | "reload" | "policy";
77
- };
25
+ Args: EmberRequestArgs<RT, E>;
78
26
  Blocks: {
79
27
  /**
80
28
  * The block to render when the component is idle and waiting to be given a request.
@@ -87,28 +35,19 @@ interface RequestSignature<
87
35
  /**
88
36
  * The block to render when the request was cancelled.
89
37
  *
90
- */ cancelled: [error: StructuredErrorDocument<E>, features: {
91
- isOnline: boolean;
92
- isHidden: boolean;
93
- retry: () => Promise<void>;
94
- }];
38
+ */ cancelled: [error: StructuredErrorDocument<E>, features: RecoveryFeatures];
95
39
  /**
96
40
  * The block to render when the request failed. If this block is not provided,
97
41
  * the error will be rethrown.
98
42
  *
99
43
  * Thus it is required to provide an error block and proper error handling if
100
44
  * you do not want the error to crash the application.
101
- *
102
- */ error: [error: StructuredErrorDocument<E>, features: {
103
- isOnline: boolean;
104
- isHidden: boolean;
105
- retry: () => Promise<void>;
106
- }];
45
+ */ error: [error: StructuredErrorDocument<E>, features: RecoveryFeatures];
107
46
  /**
108
47
  * The block to render when the request succeeded.
109
48
  *
110
49
  */ content: [value: RT, features: ContentFeatures<RT>];
111
- always: [state: RequestState<RT, T, StructuredErrorDocument<E>>];
50
+ always: [state: RequestState<RT, StructuredErrorDocument<E>>];
112
51
  };
113
52
  }
114
53
  /**
@@ -325,22 +264,26 @@ interface RequestSignature<
325
264
  * same, only one actual request will be made.
326
265
  *
327
266
  *
328
- * @class <Request />
329
267
  * @public
330
268
  */ export declare class Request<
331
269
  RT,
332
- T,
333
270
  E
334
- > extends Component<RequestSignature<RT, T, E>> {
271
+ > extends Component<RequestSignature<RT, E>> {
272
+ get store(): Store | RequestManager;
273
+ _state: RequestSubscription<RT, E> | null;
274
+ get state(): RequestSubscription<RT, E>;
335
275
  /**
336
- * The store instance to use for making requests. If contexts are available, this
337
- * will be the `store` on the context, else it will be the store service.
276
+ * The chrome component to use for rendering the request.
338
277
  *
339
- * @internal
340
- */ _store: Store;
341
- get store(): Store;
342
- _state: RequestSubscription<RT, T, E> | null;
343
- get state(): RequestSubscription<RT, T, E>;
278
+ * @private
279
+ */ get Chrome(): ComponentLike<{
280
+ Blocks: {
281
+ default: [];
282
+ };
283
+ Args: {
284
+ state: RequestState | null;
285
+ features: ContentFeatures<RT>;
286
+ };
287
+ }>;
344
288
  willDestroy(): void;
345
289
  }
346
- export {};
package/declarations/index.d.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * ## Installation
5
5
  *
6
- * ```cli
6
+ * ```sh
7
7
  * pnpm install @warp-drive/ember
8
8
  * ```
9
9
  *
@@ -43,7 +43,7 @@
43
43
  *
44
44
  * @module
45
45
  */
46
- export { Request } from "./-private/request.js";
46
+ export { Request, type ContentFeatures, type RecoveryFeatures } from "./-private/request.js";
47
47
  export { Await, Throw } from "./-private/await.js";
48
48
  /**
49
49
  * PromiseState provides a reactive wrapper for a promise which allows you write declarative
@@ -146,7 +146,7 @@ export { getPromiseState } from "@warp-drive/core/store/-private";
146
146
  * interface Future<T> extends Promise<T>> {
147
147
  * getStream(): Promise<ReadableStream>;
148
148
  * abort(): void;
149
- * lid: StableDocumentIdentifier | null;
149
+ * lid: RequestKey | null;
150
150
  * }
151
151
  * ```
152
152
  *
@@ -212,4 +212,4 @@ export { getPromiseState } from "@warp-drive/core/store/-private";
212
212
  * @param future
213
213
  * @return {RequestState}
214
214
  */
215
- export { getRequestState, type RequestLoadingState } from "@warp-drive/core/store/-private";
215
+ export { getRequestState, createRequestSubscription, type RequestLoadingState } from "@warp-drive/core/store/-private";
package/dist/index.js CHANGED
@@ -1,10 +1,12 @@
1
1
  import { service } from '@ember/service';
2
2
  import Component from '@glimmer/component';
3
- import { macroCondition, moduleExists, importSync, getGlobalConfig } from '@embroider/macros';
3
+ import { cached } from '@glimmer/tracking';
4
+ import { macroCondition, getGlobalConfig, moduleExists, importSync } from '@embroider/macros';
4
5
  import { getPromiseState, DISPOSE, createRequestSubscription } from '@warp-drive/core/store/-private';
5
- export { getPromiseState, getRequestState } from '@warp-drive/core/store/-private';
6
+ export { createRequestSubscription, getPromiseState, getRequestState } from '@warp-drive/core/store/-private';
6
7
  import { precompileTemplate } from '@ember/template-compilation';
7
8
  import { setComponentTemplate } from '@ember/component';
9
+ import templateOnly from '@ember/component/template-only';
8
10
 
9
11
  const and = (x, y) => Boolean(x && y);
10
12
  /**
@@ -25,8 +27,13 @@ class Throw extends Component {
25
27
  super(owner, args);
26
28
  // this error is opaque (user supplied) so we don't validate it
27
29
  // as an Error instance.
28
- // eslint-disable-next-line @typescript-eslint/no-throw-literal
29
- throw this.args.error;
30
+ if (macroCondition(getGlobalConfig().WarpDrive.env.PRODUCTION)) {
31
+ // eslint-disable-next-line no-console
32
+ console.error(this.args.error);
33
+ } else {
34
+ // eslint-disable-next-line @typescript-eslint/only-throw-error
35
+ throw this.args.error;
36
+ }
30
37
  }
31
38
  static {
32
39
  setComponentTemplate(precompileTemplate("", {
@@ -129,6 +136,20 @@ function decorateFieldV2(prototype, prop, decorators, initializer) {
129
136
  deferDecorator(prototype, prop, desc);
130
137
  }
131
138
  }
139
+ function decorateMethodV2(prototype, prop, decorators) {
140
+ const origDesc = Object.getOwnPropertyDescriptor(prototype, prop);
141
+ let desc = {
142
+ ...origDesc
143
+ };
144
+ for (let decorator of decorators) {
145
+ desc = decorator(prototype, prop, desc) || desc;
146
+ }
147
+ if (desc.initializer !== void 0) {
148
+ desc.value = desc.initializer ? desc.initializer.call(prototype) : void 0;
149
+ desc.initializer = void 0;
150
+ }
151
+ Object.defineProperty(prototype, prop, desc);
152
+ }
132
153
  function initializeDeferredDecorator(target, prop) {
133
154
  let desc = findDeferredDecorator(target.constructor, prop);
134
155
  if (desc) {
@@ -158,6 +179,9 @@ if (macroCondition(moduleExists('ember-provide-consume-context'))) {
158
179
  } = importSync('ember-provide-consume-context');
159
180
  consume = contextConsume;
160
181
  }
182
+ const DefaultChrome = setComponentTemplate(precompileTemplate("{{yield}}", {
183
+ strictMode: true
184
+ }), templateOnly());
161
185
  /**
162
186
  * The `<Request />` component is a powerful tool for managing data fetching and
163
187
  * state in your Ember application. It provides a declarative approach to reactive
@@ -372,7 +396,6 @@ if (macroCondition(moduleExists('ember-provide-consume-context'))) {
372
396
  * same, only one actual request will be made.
373
397
  *
374
398
  *
375
- * @class <Request />
376
399
  * @public
377
400
  */
378
401
  class Request extends Component {
@@ -403,21 +426,40 @@ class Request extends Component {
403
426
  const {
404
427
  store
405
428
  } = this;
406
- if (_state && _state.store !== store) {
429
+ const {
430
+ subscription
431
+ } = this.args;
432
+ if (_state && (_state.store !== store || subscription)) {
407
433
  _state[DISPOSE]();
408
434
  _state = null;
409
435
  }
436
+ if (subscription) {
437
+ return subscription;
438
+ }
410
439
  if (!_state) {
411
440
  this._state = _state = createRequestSubscription(store, this.args);
412
441
  }
413
442
  return _state;
414
443
  }
444
+ /**
445
+ * The chrome component to use for rendering the request.
446
+ *
447
+ * @private
448
+ */
449
+ get Chrome() {
450
+ return this.args.chrome || DefaultChrome;
451
+ }
452
+ static {
453
+ decorateMethodV2(this.prototype, "Chrome", [cached]);
454
+ }
415
455
  willDestroy() {
416
- this._state[DISPOSE]();
417
- this._state = null;
456
+ if (this._state) {
457
+ this._state[DISPOSE]();
458
+ this._state = null;
459
+ }
418
460
  }
419
461
  static {
420
- 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 ", {
462
+ 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 ", {
421
463
  strictMode: true,
422
464
  scope: () => ({
423
465
  and,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@warp-drive/ember",
3
3
  "description": "Data bindings and utilities for Ember applications using WarpDrive",
4
- "version": "5.6.0-beta.1",
4
+ "version": "5.6.0-beta.3",
5
5
  "license": "MIT",
6
6
  "author": "Chris Thoburn <runspired@users.noreply.github.com>",
7
7
  "repository": {
@@ -37,8 +37,8 @@
37
37
  "ember-provide-consume-context": "^0.7.0"
38
38
  },
39
39
  "dependencies": {
40
- "@embroider/macros": "^1.16.12",
41
- "@warp-drive/core": "5.6.0-beta.0"
40
+ "@embroider/macros": "^1.18.1",
41
+ "@warp-drive/core": "5.6.0-beta.2"
42
42
  },
43
43
  "peerDependenciesMeta": {
44
44
  "ember-provide-consume-context": {
@@ -46,28 +46,28 @@
46
46
  }
47
47
  },
48
48
  "devDependencies": {
49
- "@babel/core": "^7.26.10",
50
- "@babel/plugin-transform-typescript": "^7.27.0",
51
- "@babel/preset-env": "^7.26.9",
52
- "@babel/preset-typescript": "^7.27.0",
53
- "@babel/runtime": "^7.27.0",
49
+ "@babel/core": "^7.28.0",
50
+ "@babel/plugin-transform-typescript": "^7.28.0",
51
+ "@babel/preset-env": "^7.28.0",
52
+ "@babel/preset-typescript": "^7.27.1",
53
+ "@babel/runtime": "^7.28.2",
54
54
  "@glimmer/component": "^2.0.0",
55
- "@glint/core": "unstable",
56
- "@glint/environment-ember-loose": "unstable",
57
- "@glint/environment-ember-template-imports": "unstable",
58
- "@glint/template": "unstable",
55
+ "@glint/core": "alpha",
56
+ "@glint/environment-ember-loose": "alpha",
57
+ "@glint/environment-ember-template-imports": "alpha",
58
+ "@glint/template": "alpha",
59
59
  "decorator-transforms": "^2.3.0",
60
- "@embroider/addon-dev": "^7.1.3",
60
+ "@embroider/addon-dev": "^7.1.5",
61
61
  "@ember/test-helpers": "5.2.0",
62
62
  "@ember/test-waiters": "^4.1.0",
63
- "@warp-drive/internal-config": "5.6.0-beta.1",
64
- "@warp-drive/core": "5.6.0-beta.0",
63
+ "@warp-drive/internal-config": "5.6.0-beta.3",
64
+ "@warp-drive/core": "5.6.0-beta.2",
65
65
  "babel-plugin-ember-template-compilation": "^2.4.1",
66
66
  "ember-template-imports": "^4.3.0",
67
- "ember-source": "~6.3.0",
68
- "rollup": "^4.40.0",
69
- "typescript": "^5.8.3",
70
- "vite": "^7.0.0",
67
+ "ember-source": "~6.6.0",
68
+ "rollup": "^4.48.0",
69
+ "typescript": "^5.9.2",
70
+ "vite": "^7.1.3",
71
71
  "ember-provide-consume-context": "^0.7.0"
72
72
  },
73
73
  "volta": {
@@ -76,7 +76,12 @@
76
76
  "ember-addon": {
77
77
  "main": "addon-main.cjs",
78
78
  "type": "addon",
79
- "version": 2
79
+ "version": 2,
80
+ "externals": [
81
+ "@ember/-internals",
82
+ "@ember/-internals/metal",
83
+ "@glimmer/validator"
84
+ ]
80
85
  },
81
86
  "ember": {
82
87
  "edition": "octane"