soseki 0.0.5 → 0.0.6

package/dist/src/engines/navigation-api-engine.js

@@ -0,0 +1,411 @@
+import unreachable from "../core/_unreachable.js";
+import * as v from "../core/_valibot.js";
+import { NavigationApiNotSupportedError } from "../core/errors.js";
+import expectHistoryEntry from "../core/expect-history-entry.js";
+import createHtmlFormElementFormFormData from "../core/form-data-to-html-form-element.js";
+import HistoryEntryIdSchema from "../core/history-entry-id-schema.js";
+import HistoryEntryUrlSchema from "../core/history-entry-url-schema.js";
+import initLoaders from "../core/init-loaders.js";
+import matchRoutes from "../core/match-routes.js";
+import RoutePath from "../core/route-path.js";
+import startAction from "../core/start-action.js";
+import startLoaders from "../core/start-loaders.js";
+/**
+ * モダンブラウザーに搭載されている標準の `Navigation API` を活用し、クライアントサイドにおける高度な SPA ルーティングを制御するエンジンクラスです。
+ */
+export default class NavigationApiEngine {
+    /**
+     * `NavigationApiEngine` クラスのインスタンスを初期化します。
+     *
+     * 実行環境が `Navigation API` をサポートしていない場合はエラーを投げます。
+     */
+    constructor() {
+        let navigation_;
+        // グローバル環境または window オブジェクトから navigation インスタンスの回収を試みます。
+        for (const getNav of [() => navigation, () => window.navigation]) {
+            try {
+                navigation_ = getNav();
+                if (typeof navigation_ !== "undefined") {
+                    break;
+                }
+            }
+            catch { }
+        }
+        // オブジェクトとして存在しない場合はサポート外の環境とみなします。
+        if (typeof navigation_ !== "object") {
+            throw new NavigationApiNotSupportedError();
+        }
+        this.navigation = navigation_;
+        this.subscribedEntryIds = new Set();
+        this.navAbortController = null;
+    }
+    /**
+     * 現在のページ URL に基づき、ルーターの初期状態を構築・登録します。
+     *
+     * @param args ルート定義配列、共通データストア、初期化用のアボートシグナルを含むオブジェクトです。
+     * @returns 構築された初期の `RouterState`。適合するルートがないか、履歴が無い場合は `null` を返します。
+     */
+    init(args) {
+        const currentEntry = expectHistoryEntry(this.navigation.currentEntry);
+        if (!currentEntry) {
+            return null;
+        }
+        const { routes, getSignal, loaderDataStore } = args;
+        const currentRoutes = matchRoutes(routes, currentEntry.url);
+        if (!currentRoutes) {
+            return null;
+        }
+        // 初期表示に必要なすべてのローダーを一斉に並行起動します。
+        const dataMap = initLoaders(currentRoutes, {
+            url: currentEntry.url,
+            signal: getSignal(),
+        });
+        // 起動したローダーの結果（NinjaPromise）のマップを、現在の履歴 ID をキーとしてキャッシュします。
+        loaderDataStore.set(currentEntry.id, dataMap);
+        return {
+            entry: currentEntry,
+            routes: currentRoutes,
+        };
+    }
+    /**
+     * ブラウザーの継続的なナビゲーションイベント（リンククリック、フォーム送信、履歴移動）の監視を開始します。
+     *
+     * @param args ルート配列、UI側への状態反映関数、各種ストア、シグナル取得関数を含むオブジェクトです。
+     */
+    start(args) {
+        const { routes, update, getSignal, actionDataStore, loaderDataStore } = args;
+        /**
+         * ユーザーのアクションによって発生したすべての遷移要求をインターセプトして処理する、ルーティングの中枢ハンドラーです。
+         */
+        const handleNavigate = (event) => {
+            // 処理すべきでない通常のブラウザー固有のナビゲーション（ハッシュ変更、ファイルのダウンロードなど）は、
+            // 標準の挙動を妨げないようにインターセプトせず即座にスルーします。
+            // 参照: https://developer.mozilla.org/docs/Web/API/Navigation_API#handling_a_navigation_using_intercept
+            if (!event.isTrusted ||
+                !event.canIntercept ||
+                event.hashChange ||
+                event.downloadRequest !== null) {
+                return;
+            }
+            const currentEntry = expectHistoryEntry(this.navigation.currentEntry);
+            if (!currentEntry) {
+                // 現在のエントリーが存在しない場合は、ルーターを未マッチ状態（null）にリセットして制御をブラウザーに返します。
+                event.intercept({
+                    async handler() {
+                        update(null);
+                    },
+                });
+                return;
+            }
+            // 移動先の URL を検証し、適合するルート定義があるかを探索します。
+            const destUrl = v.expect(HistoryEntryUrlSchema(), event.destination.url);
+            const destRoutes = matchRoutes(routes, destUrl);
+            if (!destRoutes) {
+                // 移動先のルート定義が見つからない場合は、ルーターを未マッチ状態（null）にリセットして制御をブラウザーに返します。
+                event.intercept({
+                    async handler() {
+                        update(null);
+                    },
+                });
+                return;
+            }
+            // 前回の遷移から短時間で遷移する場合を考慮し、進行中だった以前の古い非同期処理をすべて安全に中断します。
+            this.navAbortController?.abort();
+            this.navAbortController = new AbortController();
+            const { signal } = this.navAbortController;
+            const { formData } = event;
+            const prevEntryInHandler = currentEntry;
+            // 分岐 A: フォームデータが伴う場合 ＝ データ変更要求（HTTP POST / Action 契機）
+            if (formData) {
+                const { sourceElement } = event;
+                // submit メソッドによってプログラムから動的生成されたフォーム要素であれば、用済みのため DOM から削除します。
+                if (sourceElement?.hasAttribute("data-sosekisubmit")) {
+                    document.body.removeChild(sourceElement);
+                }
+                /**
+                 * A-1: URL が書き換わる直前の段階で割り込んでアクション関数を実行するハンドラーです。
+                 */
+                const precommitHandler = async (controller) => {
+                    const action = startAction(destRoutes, {
+                        url: destUrl,
+                        signal,
+                        formData,
+                    });
+                    if (!action) {
+                        return;
+                    }
+                    // アクションの実行状態を現在の履歴 ID に紐づけてストアへ保存します。
+                    actionDataStore
+                        .getOrInsertComputed(currentEntry.id, () => new Map())
+                        .set(action.func, action.data);
+                    // アクションの開始に伴い、UI 層へローディング状態などの再描画を伝播します。
+                    update();
+                    // 全アクションの処理が完了するまで待機します。
+                    const actionResponse = await action.idle();
+                    const redirectUrl = new URL(currentEntry.url.href);
+                    switch (action.data.status) {
+                        case "rejected": {
+                            // アクションがエラーで失敗した場合は、URL を変更せず現在の元のページに強制リダイレクトさせます。
+                            const { pathname, search, hash } = currentEntry.url;
+                            controller.redirect(pathname + search + hash);
+                            break;
+                        }
+                        case "fulfilled": {
+                            // アクションが正常終了した場合、返り値にリダイレクト指示が含まれていればその目的地へ遷移させます。
+                            // リダイレクトがなければそのまま本来の目的地へとブラウザーのコミット先を書き換えます。
+                            const { redirectTo = currentEntry.url } = actionResponse;
+                            const { pathname, search, hash } = redirectTo;
+                            controller.redirect(pathname + search + hash);
+                            redirectUrl.pathname = pathname;
+                            redirectUrl.search = search;
+                            redirectUrl.hash = hash;
+                            break;
+                        }
+                        default:
+                            unreachable(action.data.status);
+                    }
+                    // 次の描画確定フェーズへコンテキスト情報を引き継ぎます。
+                    return {
+                        action: action.func,
+                        actionData: action.data,
+                        redirectUrl,
+                    };
+                };
+                /**
+                 * A-2: アクションが完了し、ブラウザーの URL コミットが確定した後に画面表示を同期させるハンドラーです。
+                 */
+                const handler = async (args) => {
+                    if (!args) {
+                        return;
+                    }
+                    const { action, actionData, redirectUrl } = args;
+                    // 履歴エントリーを再度取得します。
+                    const currentEntry = expectHistoryEntry(this.navigation.currentEntry);
+                    if (!currentEntry) {
+                        // 現在のエントリーが存在しない場合は、ルーターを未マッチ状態（null）にリセットして制御をブラウザーに返します。
+                        update(null);
+                        return;
+                    }
+                    // コミットされた実際のブラウザー URL が、想定しているリダイレクト先と一致しない場合は処理を中断します。
+                    if (currentEntry.url.href !== redirectUrl.href) {
+                        return;
+                    }
+                    // 確定した新しい履歴 ID に改めてアクション結果をキャッシュします。
+                    actionDataStore
+                        .getOrInsertComputed(currentEntry.id, () => new Map())
+                        .set(action, actionData);
+                    const currentRoutes = matchRoutes(routes, currentEntry.url);
+                    if (!currentRoutes) {
+                        // 現在のルート定義が見つからない場合は、ルーターを未マッチ状態（null）にリセットして制御をブラウザーに返します。
+                        update(null);
+                        return;
+                    }
+                    // アクションの処理結果を反映させるために、該当するルートのローダーを実行します。
+                    const prevEntry = prevEntryInHandler;
+                    const prevRoutes = matchRoutes(routes, prevEntry.url);
+                    const startedLoaders = startLoaders({
+                        signal,
+                        prevEntry,
+                        prevRoutes,
+                        currentEntry,
+                        currentRoutes,
+                        loaderDataStore,
+                    }, {
+                        formData,
+                        actionData,
+                    });
+                    // 最新の確定状態を UI に通知して画面を再描画します。ローダーの結果の中には実行中のものもありますが、それらの待機処理（描画）は各コンポーネントに任せます。
+                    update({
+                        entry: currentEntry,
+                        routes: currentRoutes,
+                    });
+                    // 全ローダーの完了を待機します。ここで待機することで、全ローダーの実行が完了するまでブラウザーのタブにはローディングスピーナーが表示されます。
+                    await startedLoaders?.idle();
+                };
+                // Navigation API のインターセプト機構に、二段階の処理をバインドします。
+                let precommitResult;
+                event.intercept({
+                    async precommitHandler(controller) {
+                        precommitResult = await precommitHandler(controller);
+                    },
+                    async handler() {
+                        await handler(precommitResult);
+                    },
+                });
+            }
+            else {
+                // 分岐 B: フォームデータがない場合 ＝ 通常の画面遷移（HTTP GET / リンククリック・戻る進む契機）
+                const handler = async () => {
+                    const currentEntry = expectHistoryEntry(this.navigation.currentEntry);
+                    if (!currentEntry) {
+                        update(null);
+                        return;
+                    }
+                    // 同期がズレている場合はガードします。
+                    if (currentEntry.url.href !== destUrl.href) {
+                        return;
+                    }
+                    const prevEntry = prevEntryInHandler;
+                    const prevRoutes = matchRoutes(routes, prevEntry.url);
+                    const currentRoutes = destRoutes;
+                    // キャッシュの再利用判定を含めて、移動先のローダー関数群を精査・起動します。
+                    const startedLoaders = startLoaders({
+                        signal,
+                        prevEntry,
+                        prevRoutes,
+                        currentEntry,
+                        currentRoutes,
+                        loaderDataStore,
+                    });
+                    // 最新の確定状態を UI に通知して画面を再描画します。ローダーの結果の中には実行中のものもありますが、それらの待機処理（描画）は各コンポーネントに任せます。
+                    update({
+                        entry: currentEntry,
+                        routes: currentRoutes,
+                    });
+                    // 全ローダーの完了を待機します。ここで待機することで、全ローダーの実行が完了するまでブラウザーのタブにはローディングスピーナーが表示されます。
+                    await startedLoaders?.idle();
+                };
+                event.intercept({
+                    async handler() {
+                        await handler();
+                    },
+                });
+            }
+        };
+        const signal = getSignal();
+        // 外部からルーター全体の監視終了シグナルを受け取った際、中断処理を連動させます。
+        const handleAbort = () => {
+            this.navAbortController?.abort();
+            this.navAbortController = null;
+        };
+        signal.addEventListener("abort", handleAbort, { once: true });
+        // Navigation API の navigate イベントの購読を開始します。
+        this.navigation.addEventListener("navigate", handleNavigate, { signal });
+        // セッション履歴から溢れて破棄された古い履歴エントリーのデータ（アクション・ローダーのキャッシュ）を自動削除します。
+        for (const entry of this.navigation.entries()) {
+            const entryId = v.expect(HistoryEntryIdSchema(), entry.id);
+            if (this.subscribedEntryIds.has(entryId)) {
+                continue;
+            }
+            const handleDispose = () => {
+                this.subscribedEntryIds.delete(entryId);
+                actionDataStore.delete(entryId);
+                loaderDataStore.delete(entryId);
+            };
+            entry.addEventListener("dispose", handleDispose, { signal });
+            this.subscribedEntryIds.add(entryId);
+        }
+        // ナビゲーションの進行に伴い、新しく生成される履歴エントリーに対しても、動的に破棄イベントの監視網を広げます。
+        const handleCurrentEntryChange = () => {
+            const currentEntry = expectHistoryEntry(this.navigation.currentEntry);
+            if (!currentEntry) {
+                return;
+            }
+            if (this.subscribedEntryIds.has(currentEntry.id)) {
+                return;
+            }
+            const handleDispose = () => {
+                this.subscribedEntryIds.delete(currentEntry.id);
+                actionDataStore.delete(currentEntry.id);
+                loaderDataStore.delete(currentEntry.id);
+            };
+            this.navigation.currentEntry.addEventListener("dispose", handleDispose, { signal });
+            this.subscribedEntryIds.add(currentEntry.id);
+        };
+        this.navigation.addEventListener("currententrychange", handleCurrentEntryChange, { signal });
+    }
+    /**
+     * フォームデータまたはクエリーパラメータを、ブラウザーの Navigation API のライフサイクルに載せて命令的に送信します。
+     *
+     * @param args 送信データの種類に応じたサブミット引数です。
+     */
+    submit(args) {
+        switch (args.type) {
+            case "FORM_DATA": {
+                const { action, target } = args;
+                const form = createHtmlFormElementFormFormData(target);
+                form.method = "POST";
+                form.action = action;
+                form.enctype = "multipart/form-data";
+                form.dataset["sosekisubmit"] = ""; // 後で削除できるように目印を付与します。
+                // 実際のフォーム送信を行うために DOM へ一時配置して実行します。
+                // ハンドラーがこの要素を使用した後に DOM から削除します。
+                document.body.appendChild(form);
+                form.submit();
+                break;
+            }
+            case "URL_SEARCH_PARAMS": {
+                const { action, target, history } = args;
+                const path = new RoutePath(action);
+                path.search = target.toString();
+                // Navigation API を用いて、クエリーが上書きされた新しいアドレスへ遷移させます。
+                this.navigation.navigate(path.toString(), { history });
+                break;
+            }
+            default:
+                unreachable(args);
+        }
+    }
+    /**
+     * 命令的なページ遷移を処理します。
+     *
+     * @param args 遷移タイプに応じたナビゲーション引数です。
+     */
+    navigate(args) {
+        switch (args.type) {
+            case "LINK": {
+                const { to, history } = args;
+                switch (to.type) {
+                    case "PATH": {
+                        // 完全なパス文字列の余分なスラッシュなどをエンコードして直接遷移します。
+                        const path = RoutePath.encode(to.path);
+                        this.navigation.navigate(path, { history });
+                        break;
+                    }
+                    case "PARTIAL": {
+                        // 現在のロケーション情報をベースに、指定されたパーツ（パス名、クエリー、ハッシュのみなど）を部分的にパッチ（上書き）したマージ URL を算出します。
+                        const currentPath = new RoutePath(window.location);
+                        const nextPath = new RoutePath(window.location);
+                        if (typeof to.pathname === "string") {
+                            nextPath.pathname = to.pathname;
+                        }
+                        if (typeof to.search === "string") {
+                            nextPath.search = to.search;
+                        }
+                        if (typeof to.hash === "string") {
+                            nextPath.hash = to.hash;
+                        }
+                        const nextPathString = nextPath.toString();
+                        // 無駄な遷移履歴を作らないように、URL に実際の変化がある場合のみ navigate を実行します。
+                        if (nextPathString !== currentPath.toString()) {
+                            this.navigation.navigate(nextPathString, { history });
+                        }
+                        break;
+                    }
+                    default:
+                        unreachable(to);
+                }
+                break;
+            }
+            case "MOVE": {
+                const currentEntry = expectHistoryEntry(this.navigation.currentEntry);
+                if (!currentEntry) {
+                    return;
+                }
+                const { delta } = args;
+                // 現在のインデックスから相対位置（例: -1 なら 1 つ戻る）を計算し、履歴スタックに該当するインデックスが存在するか探索します。
+                const index = currentEntry.index + delta;
+                const entry = this.navigation.entries().find((e) => e.index === index);
+                if (!entry) {
+                    // スタックの限界を超える移動要求の場合は何もしません。
+                    return;
+                }
+                // Navigation API の traverseTo メソッドを使用し、一意の識別キーを指定して目的地へジャンプします。
+                this.navigation.traverseTo(entry.key);
+                break;
+            }
+            default:
+                unreachable(args);
+        }
+    }
+}

package/dist/src/engines.d.ts

@@ -0,0 +1,4 @@
+export type * from "./engines/engine.types.js";
+export type * from "./engines/navigation-api-engine.js";
+export { default as NavigationApiEngine } from "./engines/navigation-api-engine.js";
+//# sourceMappingURL=engines.d.ts.map

package/dist/src/engines.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engines.d.ts","sourceRoot":"","sources":["../../src/engines.ts"],"names":[],"mappings":"AAAA,mBAAmB,2BAA2B,CAAC;AAE/C,mBAAmB,oCAAoC,CAAC;AACxD,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,oCAAoC,CAAC"}

package/dist/src/engines.js

@@ -0,0 +1 @@
+export { default as NavigationApiEngine } from "./engines/navigation-api-engine.js";

package/dist/src/hooks/_use-singleton.d.ts

@@ -0,0 +1,11 @@
+/**
+ * コンポーネントのライフサイクルにおいて、渡されたファクトリー関数を最初のレンダリング時に一度だけ実行し、その結果を以降の再レンダリング間で永続的に共有・保持するためのカスタムフックです。
+ *
+ * `React.useMemo` と異なり、React の内部都合によるキャッシュの不意な破棄・再計算が発生しないことが保証されます。
+ *
+ * @template T ファクトリー関数が生成するオブジェクトの型定義です。
+ * @param fn 初回レンダリング時にのみ呼び出される、オブジェクト生成用の初期化関数です。
+ * @returns 初回実行時に生成され、保持され続けている型 `T` のシングルトンインスタンスを返します。
+ */
+export default function useSingleton<T>(fn: () => T): T;
+//# sourceMappingURL=_use-singleton.d.ts.map

package/dist/src/hooks/_use-singleton.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_use-singleton.d.ts","sourceRoot":"","sources":["../../../src/hooks/_use-singleton.ts"],"names":[],"mappings":"AAOA;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAatD"}

package/dist/src/hooks/_use-singleton.js

@@ -0,0 +1,26 @@
+import * as React from "react";
+/**
+ * 初期化前（未初期化状態）であることを安全に判定するための、値が空の内部専用ユニークオブジェクトです。
+ */
+const nil = {};
+/**
+ * コンポーネントのライフサイクルにおいて、渡されたファクトリー関数を最初のレンダリング時に一度だけ実行し、その結果を以降の再レンダリング間で永続的に共有・保持するためのカスタムフックです。
+ *
+ * `React.useMemo` と異なり、React の内部都合によるキャッシュの不意な破棄・再計算が発生しないことが保証されます。
+ *
+ * @template T ファクトリー関数が生成するオブジェクトの型定義です。
+ * @param fn 初回レンダリング時にのみ呼び出される、オブジェクト生成用の初期化関数です。
+ * @returns 初回実行時に生成され、保持され続けている型 `T` のシングルトンインスタンスを返します。
+ */
+export default function useSingleton(fn) {
+    // 生成されたオブジェクトをコンポーネントの生存期間中保持するために useRef を使用します。
+    // 初期値として、未初期化の目印である nil オブジェクトを型アサーションして流し込みます。
+    const ref = React.useRef(nil);
+    // 参照している中身がマッピングされたオブジェクト（nil）のままであれば、まだ一度も初期化されていないと判定します。
+    if (ref.current === nil) {
+        // 初期化関数を実行し、生成された実体を現在の参照へと上書きします。
+        // この処理は初回のレンダリングパスの中で完全に同期的に実行されます。
+        ref.current = fn();
+    }
+    return ref.current;
+}

package/dist/src/hooks/use-action-data.d.ts

@@ -0,0 +1,17 @@
+import type { NinjaPromise } from "ninja-promise";
+import type RedirectResponse from "../core/redirect-response.js";
+/**
+ * アクション関数の戻り値の型から、リダイレクト応答を除外して正規化するユーティリティー型です。
+ *
+ * アクションがリダイレクトを返した場合、フレームワークの内部仕様によって実際の値は `undefined` に置換されるため、型定義においてもその挙動を忠実に表現します。
+ */
+type ActionResult<TResult> = TResult extends RedirectResponse ? undefined : TResult;
+/**
+ * 現在の階層のルートに紐づくアクション関数の最新の実行結果を購読・取得するためのカスタムフックです。
+ *
+ * @template TData アクション関数そのものの型、またはアクションが返すことが期待されるデータ構造の型定義です。関数型が渡された場合は、自動的にその戻り値の型（推論結果）が解凍されます。
+ * @returns アクションが実行済み、または実行中であれば結果を内包した `NinjaPromise` を返し、一度も実行されていないか対象のアクションが存在しない場合は `undefined` を返します。
+ */
+export default function useActionData<TData = unknown>(): NinjaPromise<ActionResult<Awaited<TData extends (...args: any) => infer TReturn ? TReturn : TData>>> | undefined;
+export {};
+//# sourceMappingURL=use-action-data.d.ts.map

package/dist/src/hooks/use-action-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-action-data.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-action-data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAElD,OAAO,KAAK,gBAAgB,MAAM,8BAA8B,CAAC;AAIjE;;;;GAIG;AACH,KAAK,YAAY,CAAC,OAAO,IAAI,OAAO,SAAS,gBAAgB,GAAG,SAAS,GAAG,OAAO,CAAC;AAEpF;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,KAAK,GAAG,OAAO,KACjD,YAAY,CACV,YAAY,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,MAAM,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC,CAAC,CACvF,GACD,SAAS,CAQZ"}

package/dist/src/hooks/use-action-data.js

@@ -0,0 +1,16 @@
+import useRouteContext from "./use-route-context.js";
+import useRouterContext from "./use-router-context.js";
+/**
+ * 現在の階層のルートに紐づくアクション関数の最新の実行結果を購読・取得するためのカスタムフックです。
+ *
+ * @template TData アクション関数そのものの型、またはアクションが返すことが期待されるデータ構造の型定義です。関数型が渡された場合は、自動的にその戻り値の型（推論結果）が解凍されます。
+ * @returns アクションが実行済み、または実行中であれば結果を内包した `NinjaPromise` を返し、一度も実行されていないか対象のアクションが存在しない場合は `undefined` を返します。
+ */
+export default function useActionData() {
+    const { action } = useRouteContext();
+    const actionData = useRouterContext((router) => {
+        const { currentEntry, actionDataStore } = router;
+        return actionDataStore.get(currentEntry.id)?.get(action);
+    });
+    return actionData;
+}

package/dist/src/hooks/use-form-action.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 現在の階層のルートに紐づく、動的パラメーターが具現化された実際の URL パス文字列を取得するカスタムフックです。
+ *
+ * @returns 現在のルートに対応する具現化済みの URL パス文字列（例: `"/items/123"`）を返します。
+ */
+export default function useFormAction(): string;
+//# sourceMappingURL=use-form-action.d.ts.map

package/dist/src/hooks/use-form-action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-form-action.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-form-action.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,IAAI,MAAM,CAE9C"}

package/dist/src/hooks/use-form-action.js

@@ -0,0 +1,9 @@
+import useRouteContext from "./use-route-context.js";
+/**
+ * 現在の階層のルートに紐づく、動的パラメーターが具現化された実際の URL パス文字列を取得するカスタムフックです。
+ *
+ * @returns 現在のルートに対応する具現化済みの URL パス文字列（例: `"/items/123"`）を返します。
+ */
+export default function useFormAction() {
+    return useRouteContext().urlPath;
+}

package/dist/src/hooks/use-loader-data.d.ts

@@ -0,0 +1,9 @@
+import type { NinjaPromise } from "ninja-promise";
+/**
+ * 現在の階層のルートに紐づくローダー関数の実行結果を購読・取得するためのカスタムフックです。
+ *
+ * @template TData ローダー関数そのものの型、またはローダーが返すことが期待されるデータ構造の型定義です。関数型が渡された場合は、自動的にその非同期戻り値の型（非同期の解凍結果）が推論されます。
+ * @returns ローダーの実行状態を管理している `NinjaPromise` を返します。
+ */
+export default function useLoaderData<TData = unknown>(): NinjaPromise<Awaited<TData extends (...args: any) => infer TReturn ? TReturn : TData>>;
+//# sourceMappingURL=use-loader-data.d.ts.map

package/dist/src/hooks/use-loader-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-loader-data.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-loader-data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAMlD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,KAAK,GAAG,OAAO,KAAK,YAAY,CACpE,OAAO,CAAC,KAAK,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,MAAM,OAAO,GAAG,OAAO,GAAG,KAAK,CAAC,CACzE,CAWA"}

package/dist/src/hooks/use-loader-data.js

@@ -0,0 +1,20 @@
+import { LoaderDataNotFoundError } from "../core/errors.js";
+import useRouteContext from "./use-route-context.js";
+import useRouterContext from "./use-router-context.js";
+/**
+ * 現在の階層のルートに紐づくローダー関数の実行結果を購読・取得するためのカスタムフックです。
+ *
+ * @template TData ローダー関数そのものの型、またはローダーが返すことが期待されるデータ構造の型定義です。関数型が渡された場合は、自動的にその非同期戻り値の型（非同期の解凍結果）が推論されます。
+ * @returns ローダーの実行状態を管理している `NinjaPromise` を返します。
+ */
+export default function useLoaderData() {
+    const { loader } = useRouteContext();
+    const loaderData = useRouterContext((router) => {
+        const { currentEntry, loaderDataStore } = router;
+        return loaderDataStore.get(currentEntry.id)?.get(loader);
+    });
+    if (!loaderData) {
+        throw new LoaderDataNotFoundError({ loader });
+    }
+    return loaderData;
+}

package/dist/src/hooks/use-navigate.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 遷移先のアドレスを指定するための表現型です。
+ *
+ * 完全な URL パス文字列か、またはパスの各コンポーネントを部分的にパッチするためのオブジェクトのいずれかを受け入れます。
+ */
+export type NavigateTo = string | {
+    /**
+     * 遷移先のドメイン以下のリクエストパス（例: `"/dashboard"`）です。
+     */
+    readonly pathname?: string | undefined;
+    /**
+     * 遷移先に付与する検索クエリー文字列（例: `"?id=foo"`）です。
+     */
+    readonly search?: string | undefined;
+    /**
+     * 遷移先に付与するハッシュフラグメント（例: `"#profile"`）です。
+     */
+    readonly hash?: string | undefined;
+};
+/**
+ * 画面遷移の挙動をカスタマイズするためのオプション型です。
+ */
+export type NavigateOptions = {
+    /**
+     * 履歴スタックへの追加方法を制御します。`true` の場合は現在の履歴を上書きし、`false` または省略時は新規追加します。
+     */
+    readonly replace?: boolean | undefined;
+};
+/**
+ * プログラムから命令的に画面遷移を実行する、`NavigateFunction` 関数のオーバーロードインターフェース定義です。
+ */
+export interface NavigateFunction {
+    /**
+     * 指定されたアドレスへ画面を遷移させます。
+     *
+     * @param to 遷移先の対象となるデータ表現です。
+     * @param options 履歴のスタック方法などを制御するオプションです。
+     */
+    (to: NavigateTo, options?: NavigateOptions): void;
+    /**
+     * ブラウザーのセッション履歴スタック内を、現在地を基準に相対移動させます。
+     *
+     * @param delta 移動する履歴のステップ数（例: `-1` で1つ戻る、`1` で1つ進む）です。
+     */
+    (delta: number): void;
+}
+/**
+ * リンクなどを介さない、ボタンのクリックハンドラーや非同期処理の完了時などから、プログラムによって命令的に画面遷移や履歴移動をトリガーするための関数を取得するカスタムフックです。
+ *
+ * @returns `NavigateFunction` 関数です。
+ */
+export default function useNavigate(): NavigateFunction;
+//# sourceMappingURL=use-navigate.d.ts.map

package/dist/src/hooks/use-navigate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-navigate.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-navigate.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAClB,MAAM,GACN;IACE;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAElD;;;;OAIG;IACH,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,IAAI,gBAAgB,CAwCtD"}