@warp-drive/react 5.9.0-beta.0 → 5.9.0-beta.2

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# @warp-drive/ember Changelog
+
+For the full project changelog see [https://github.com/warp-drive-data/warp-drive/blob/main/CHANGELOG.md](https://github.com/warp-drive-data/warp-drive/blob/main/CHANGELOG.md)
+
+## v0.0.0-alpha.47 (2024-06-15)
+
+#### :memo: Documentation
+
+* [#9390](https://github.com/warp-drive-data/warp-drive/pull/9390) docs: fix readme links in @warp-drive/ember ([@runspired](https://github.com/runspired))
+* [#9328](https://github.com/warp-drive-data/warp-drive/pull/9328) chore: update READMEs with status and dist tag info ([@runspired](https://github.com/runspired))
+
+#### :rocket: Enhancement
+
+* [#9471](https://github.com/warp-drive-data/warp-drive/pull/9471) feat: npx warp-drive ([@runspired](https://github.com/runspired))
+* [#9468](https://github.com/warp-drive-data/warp-drive/pull/9468) feat: string utils 🌌  ([@runspired](https://github.com/runspired))
+* [#9366](https://github.com/warp-drive-data/warp-drive/pull/9366) feat: typed Model ([@runspired](https://github.com/runspired))
+* [#9363](https://github.com/warp-drive-data/warp-drive/pull/9363) feat: <Request /> autoRefresh ([@runspired](https://github.com/runspired))
+* [#9359](https://github.com/warp-drive-data/warp-drive/pull/9359) feat: type checked builders and inferred request types from builders ([@runspired](https://github.com/runspired))
+* [#9317](https://github.com/warp-drive-data/warp-drive/pull/9317) feat: ensure data utils work well with legacy relationship proxies ([@runspired](https://github.com/runspired))
+* [#9260](https://github.com/warp-drive-data/warp-drive/pull/9260) feat: ember specific data utils ([@runspired](https://github.com/runspired))
+
+#### :bug: Bug Fix
+
+* [#9456](https://github.com/warp-drive-data/warp-drive/pull/9456) fix: visibilitychange => hidden should update unavailableStart ([@runspired](https://github.com/runspired))
+* [#9454](https://github.com/warp-drive-data/warp-drive/pull/9454) Allow RequestState.abort to be used with on modifier ([@gitKrystan](https://github.com/gitKrystan))
+* [#9391](https://github.com/warp-drive-data/warp-drive/pull/9391) fix: dont fall-through after shouldAttempt on refresh ([@runspired](https://github.com/runspired))
+* [#9369](https://github.com/warp-drive-data/warp-drive/pull/9369) fix: @warp-drive-ember, dont leak empty slot ([@runspired](https://github.com/runspired))
+
+#### :house: Internal
+
+* [#9292](https://github.com/warp-drive-data/warp-drive/pull/9292) feat: add new build-config package ([@runspired](https://github.com/runspired))
+* [#9370](https://github.com/warp-drive-data/warp-drive/pull/9370) chore: rename macros ([@runspired](https://github.com/runspired))
+
+#### Committers: (2)
+
+Chris Thoburn ([@runspired](https://github.com/runspired))
+Krystan HuffMenne ([@gitKrystan](https://github.com/gitKrystan))
+

package/dist/index.d.ts

@@ -0,0 +1,180 @@
+import { Context, JSX, ReactNode } from "react";
+import { Signal } from "signal-polyfill";
+import { RequestLoadingState, RequestState } from "@warp-drive/core/reactive";
+import { ContentFeatures, RecoveryFeatures, RequestArgs } from "@warp-drive/core/signals/-leaked";
+import { Store } from "@warp-drive/core";
+import { StructuredErrorDocument } from "@warp-drive/core/types/request";
+//#region src/-private/reactive-context.d.ts
+/**
+ * @category Contexts
+ */
+declare const WatcherContext: Context<{
+  /**
+   * The `Signal.subtle.Watcher` used to observe signal changes for the nearest {@link ReactiveContext}.
+   */
+  watcher: Signal.subtle.Watcher;
+} | null>;
+/**
+ *
+ * @category Components
+ */
+declare function ReactiveContext({ children }: {
+  children: ReactNode;
+}): JSX.Element;
+//#endregion
+//#region src/-private/store-provider.d.ts
+/**
+ * @category Hooks
+ */
+declare function useStore(): Store;
+type WithExistingStore = {
+  store: Store;
+  children: ReactNode;
+};
+type WithNewStore = {
+  Store: typeof Store;
+  children: ReactNode;
+};
+/**
+ * @category Components
+ */
+declare function StoreProvider($props: WithExistingStore | WithNewStore): JSX.Element;
+//#endregion
+//#region src/-private/request.d.ts
+interface ChromeComponentProps<RT> {
+  children: ReactNode;
+  state: RequestState | null;
+  features: ContentFeatures<RT>;
+}
+interface RequestProps<RT, E> extends RequestArgs<RT, E> {
+  chrome?: React.FC<ChromeComponentProps<RT>>;
+  states: RequestStates<RT, E>;
+}
+interface RequestStates<RT, E> {
+  /**
+   * The block to render when the component is idle and waiting to be given a request.
+   *
+   */
+  idle?: React.FC<object>;
+  /**
+   * The block to render when the request is loading.
+   *
+   */
+  loading?: React.FC<{
+    state: RequestLoadingState;
+  }>;
+  /**
+   * The block to render when the request was cancelled.
+   *
+   */
+  cancelled?: React.FC<{
+    /**
+     * The Error the request rejected with.
+     */
+    error: StructuredErrorDocument<E>;
+    /**
+     * Utilities to assist in recovering from the error.
+     */
+    features: RecoveryFeatures;
+  }>;
+  /**
+   * 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.
+   */
+  error: React.FC<{
+    /**
+     * The Error the request rejected with.
+     */
+    error: StructuredErrorDocument<E>;
+    /**
+     * Utilities to assist in recovering from the error.
+     */
+    features: RecoveryFeatures;
+  }>;
+  /**
+   * The block to render when the request succeeded.
+   *
+   */
+  content: React.FC<{
+    result: RT;
+    features: ContentFeatures<RT>;
+  }>;
+}
+/**
+ * Throws the given error. Used internally to rethrow request errors that
+ * are not otherwise handled by a provided error/cancelled block.
+ *
+ * @private
+ */
+declare function Throw({ error }: {
+  error: Error;
+}): never;
+/**
+ * The `<Request />` component is a powerful tool for managing data fetching and
+ * state in your React application. It provides a declarative approach to reactive
+ * control-flow for managing requests and state in your application.
+ *
+ * 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.
+ *
+ * ### Example Usage
+ *
+ * ```tsx
+ * import { Request } from "@warp-drive/react";
+ *
+ * export function UserPreview($props: { id: string | null }) {
+ *   return (
+ *    <Request
+ *       query={findRecord('user', $props.id)}
+ *       states={{
+ *         idle: () => <div>Waiting for User Selection</div>,
+ *         loading: ({ state }) => <div>Loading user data...</div>,
+ *         cancelled: ({ error, features }) => (
+ *           <div>
+ *             <p>Request Cancelled</p>
+ *             <p><button onClick={features.retry}>Start Again?</button></p>
+ *           </div>
+ *         ),
+ *         error: ({ error, features }) => (
+ *           <div>
+ *             <p>Error: {error.message}</p>
+ *             <p><button onClick={features.retry}>Try Again?</button></p>
+ *           </div>
+ *         ),
+ *         content: ({ result, features }) => (
+ *           <div>
+ *            <h2>User Details</h2>
+ *            <p>ID: {result.id}</p>
+ *            <p>Name: {result.name}</p>
+ *          </div>
+ *        ),
+ *      }}
+ *    />
+ *   );
+ * }
+ *
+ * ```
+ *
+ * @category Components
+ */
+declare function Request<RT, E>($props: RequestProps<RT, E>): JSX.Element;
+//#endregion
+export { ReactiveContext, Request, StoreProvider, Throw, WatcherContext, useStore };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/-private/reactive-context.tsx","../src/-private/store-provider.tsx","../src/-private/request.tsx"],"mappings":";;;;;;;;;;cAyJa,gBAAgB;;;;EAI3B,SAAS,OAAO,OAAO;;;;;;iBAST,kBAAkB;EAAc,UAAU;IAAc,IAAI;;;;;;iBCxJ5D,YAAY;KASvB;EAAsB,OAAO;EAAO,UAAU;;KAC9C;EAAiB,cAAc;EAAO,UAAU;;;;;iBAKrC,cAAc,QAAQ,oBAAoB,eAAe,IAAI;;;UCSnE,qBAAqB;EAC7B,UAAU;EACV,OAAO;EACP,UAAU,gBAAgB;;UAOX,aAAa,IAAI,WAAW,YAAY,IAAI;EAC3D,SAAS,MAAM,GAAG,qBAAqB;EAEvC,QAAQ,cAAc,IAAI;;UAGlB,cAAc,IAAI;;;;;EAK1B,OAAO,MAAM;;;;;EAMb,UAAU,MAAM;IAAK,OAAO;;;;;;EAM5B,YAAY,MAAM;;;;IAIhB,OAAO,wBAAwB;;;;IAI/B,UAAU;;;;;;;;;EAUZ,OAAO,MAAM;;;;IAIX,OAAO,wBAAwB;;;;IAI/B,UAAU;;;;;;EAOZ,SAAS,MAAM;IAAK,QAAQ;IAAI,UAAU,gBAAgB;;;;;;;;;iBAS5C,QAAQ;EAAW,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkE1B,QAAQ,IAAI,GAAG,QAAQ,aAAa,IAAI,KAAK,IAAI"}