march-hare 0.8.0 → 0.9.0

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>;