march-hare 0.7.5 → 0.9.0

package/dist/with/index.d.ts

@@ -0,0 +1,40 @@
+import { Actions, HandlerContext, Model, Props } from '../types/index';
+/**
+ * Handler factories that wire an action directly to a model field.
+ *
+ * - {@link With.Update} assigns the dispatched payload to `model[key]`.
+ * - {@link With.Invert} flips a boolean field on `model[key]`.
+ *
+ * Both are typed so the call site fails to compile when `key` is missing or
+ * has an incompatible type.
+ *
+ * @example
+ * ```ts
+ * import { With } from "march-hare";
+ *
+ * type Model = { name: string; sidebar: boolean };
+ *
+ * class Actions {
+ *   static SetName = Action<string>("SetName");
+ *   static ToggleSidebar = Action("ToggleSidebar");
+ * }
+ *
+ * actions.useAction(Actions.SetName, With.Update("name"));
+ * actions.useAction(Actions.ToggleSidebar, With.Invert("sidebar"));
+ * ```
+ */
+export declare const With: {
+    /**
+     * Returns a handler that assigns the action payload to `model[key]`.
+     *
+     * Type-checks at the call site: the payload type must be assignable to
+     * the model property's type, and the key must exist on the model.
+     */
+    Update<K extends string>(key: K): <M extends Model, A extends Actions | void, D extends Props, P extends K extends keyof M ? M[K] : never>(context: HandlerContext<M, A, D>, payload: P) => void;
+    /**
+     * Returns a handler that inverts a boolean field on the model.
+     *
+     * Type-checks at the call site: `model[key]` must be a boolean.
+     */
+    Invert<K extends string>(key: K): <M extends Model & Record<K, boolean>, A extends Actions | void, D extends Props>(context: HandlerContext<M, A, D>) => void;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "march-hare",
-  "version": "0.7.5",
+  "version": "0.9.0",
   "type": "module",
   "license": "MIT",
   "packageManager": "yarn@1.22.22",

package/dist/boundary/components/store/index.d.ts

@@ -1,41 +0,0 @@
-import { Props } from './types';
-import * as React from "react";
-export { useStore } from './utils';
-/**
- * App-wide store of cross-cutting, mutable state. The interface is
- * declared empty here and **augmented** by consumer code via module
- * augmentation:
- *
- * @example
- * ```ts
- * declare module "march-hare" {
- *   interface Store {
- *     session: Session | null;
- *     locale: string;
- *     featureFlags: Record<string, boolean>;
- *   }
- * }
- * ```
- *
- * Every key declared here flows into:
- *
- * - `useStore()` &mdash; the per-`<Boundary>` handle for reads and writes.
- * - `context.store` inside `useActions` handlers.
- * - The `store` field on every `Resource` fetcher's args object.
- *
- * The Store is **not** reactive. Mutating it does not re-render. Drive
- * view state through the model; use the Store for cross-handler
- * coordination, session tokens, locale, feature flags, etc.
- */
-export interface Store {
-}
-/**
- * Provides a per-Boundary {@link Store} value to every component inside
- * the boundary. Usually wired in via the `<Boundary store={initial}>`
- * prop rather than used directly.
- *
- * The Store is **not** reactive. Mutating it does not trigger a
- * re-render. Drive view state through the model; use the Store for
- * cross-handler coordination.
- */
-export declare function Store({ initial, children }: Props): React.ReactNode;

package/dist/boundary/components/store/types.d.ts

@@ -1,11 +0,0 @@
-import { ReactNode } from 'react';
-import { Store } from './index';
-export type { Store } from './index';
-/**
- * Props for the Store provider component. Accepts the initial Store
- * value that satisfies the augmented {@link Store} interface.
- */
-export type Props = {
-    initial: Store;
-    children: ReactNode;
-};

package/dist/boundary/components/store/utils.d.ts

@@ -1,64 +0,0 @@
-import { RefObject } from 'react';
-import { Store } from './index';
-import * as React from "react";
-/**
- * React context exposing the per-Boundary Store ref. The ref itself is
- * stable across renders — readers grab `.current` at call time.
- *
- * @internal
- */
-export declare const Context: React.Context<React.RefObject<Store>>;
-/**
- * Hook that returns a read-only handle to the per-Boundary {@link Store}.
- * Reads use plain dot notation (`store.session`) and always reflect the
- * latest value, even after `await` boundaries &mdash; the handle is a
- * `Proxy` that delegates property access to the live ref.
- *
- * Writes are not exposed here. Mutate the Store inside an action handler
- * via `context.actions.produce(({ model, store }) => { store.x = ... })`
- * &mdash; the same Immer-style recipe used for the model. Mutations do
- * **not** trigger a re-render; drive view state through the model.
- *
- * The Store's shape is declared via module augmentation on the library's
- * {@link Store} interface, so dot reads are fully typed at every call
- * site.
- *
- * @example
- * ```ts
- * declare module "march-hare" {
- *   interface Store {
- *     session: Session | null;
- *     locale: string;
- *   }
- * }
- *
- * function useAuthActions() {
- *   const store = useStore();
- *   const actions = useActions<void, typeof Actions>();
- *
- *   actions.useAction(Actions.SignIn, async (context, credentials) => {
- *     const result = await context.actions.resource(signIn(credentials));
- *     context.actions.produce(({ store }) => {
- *       store.session = result;
- *     });
- *   });
- *
- *   actions.useAction(Actions.Refresh, async (context) => {
- *     if (store.session === null) return;
- *     // ...
- *   });
- *
- *   return actions;
- * }
- * ```
- */
-export declare function useStore(): Store;
-/**
- * Internal accessor for the per-Boundary Store ref &mdash; used by the
- * Resource layer to pass a fresh snapshot to each fetcher invocation
- * and by the action layer to write through `context.actions.produce`.
- * Not exported from the library.
- *
- * @internal
- */
-export declare function useStoreRef(): RefObject<Store>;