soseki 0.0.4 → 0.0.6

package/src/core/start-actions.ts

@@ -1,274 +0,0 @@
-import actionIdRegistry from "./_action-id-registry.js";
-import unreachable from "./_unreachable.js";
-import { ACTION_ID_FORM_DATA_NAME } from "./constants.js";
-import type { IDataMap } from "./data-map.types.js";
-import type { IDataStore } from "./data-store.types.js";
-import DeferredPromise from "./deferred-promise.js";
-import { ActionConditionError, ActionExecutionError, MultipleRedirectError } from "./errors.js";
-import type { HistoryEntry } from "./expect-history-entry.js";
-import type { MatchedRoute } from "./match-routes.js";
-import type { ReadonlyFormData } from "./readonly-form-data.types.js";
-import RedirectResponse from "./redirect-response.js";
-import RouteRequest from "./route-request.js";
-import type { IAction } from "./route.types.js";
-
-/**
- * アクションの開始に使用するパラメーターの型定義です。
- */
-export type StartActionsParams = {
-  /**
-   * マッチしたルート情報のリストです。パラメーターとデータ関数を含みます。
-   */
-  readonly routes: readonly Pick<MatchedRoute, "params" | "urlPath" | "dataFuncs">[];
-
-  /**
-   * 履歴エントリーの情報です。 ID と URL を含みます。
-   */
-  readonly entry: Pick<HistoryEntry, "id" | "url">;
-
-  /**
-   * フォームから送信された読み取り専用のデータです。
-   */
-  readonly formData: ReadonlyFormData;
-
-  /**
-   * アクションの結果を保持するためのデータストアです。
-   */
-  readonly dataStore: IDataStore<IAction>;
-
-  /**
-   * 非同期処理を中断するためのシグナルです。
-   */
-  readonly signal: AbortSignal;
-};
-
-/**
- * アクションの実行結果を表す型定義です。
- */
-export type ActionsResult = {
-  /**
-   * リダイレクトが必要な場合のパス名です。リダイレクトが発生しない場合は undefined となります。
-   */
-  redirect: string | undefined;
-
-  /**
-   * 各アクションと実行結果を紐付けたマップです。
-   */
-  resultMap: ReadonlyMap<IAction, unknown>;
-};
-
-/**
- * ルートに定義されたアクションの実行を開始します。
- *
- * 条件に合致するアクションが存在する場合、それらを待機するための非同期関数を返します。
- *
- * @param params アクションの開始に必要なパラメーターオブジェクトです。
- * @returns アクションの完了を待機するための関数です。実行すべきアクションがない場合は undefined を返します。
- */
-export default function startActions(params: StartActionsParams): undefined | {
-  /**
-   * アクションの完了を待機し、結果を集約して返す非同期関数です。
-   *
-   * @returns アクションの結果（リダイレクト先や実行結果のマップ）を返します。
-   */
-  (): Promise<ActionsResult>;
-} {
-  const {
-    entry,
-    routes,
-    signal,
-    formData,
-    dataStore,
-  } = params;
-  const request = new RouteRequest("POST", entry.url, signal, formData);
-  const redirects: string[] = [];
-  const dataIncMap: IDataMap<IAction> = new Map();
-  let encountered = false;
-  // ルートを走査し、実行すべきアクションを特定します。
-  for (const route of routes) {
-    for (const { action, shouldAction } of route.dataFuncs) {
-      if (!action) {
-        continue;
-      }
-
-      // アクションを持つルートが見つかったため、フラグを立てます。
-      encountered = true;
-
-      // アクションを実行すべきかどうかを判定します。
-      const should = DeferredPromise.try(function executeShouldAction() {
-        return shouldAction({
-          params: route.params,
-          request,
-          defaultShouldAction: formData.has(ACTION_ID_FORM_DATA_NAME)
-            ? formData.get(ACTION_ID_FORM_DATA_NAME) === actionIdRegistry.get(action)
-            : true,
-        });
-      });
-
-      let data: DeferredPromise<unknown>;
-      switch (should.status) {
-        case "pending": {
-          // shouldAction は同期的に真偽値を返す必要があるので、pending 状態（つまり非同期）であってはいけません。
-          const error = new ActionConditionError(request.url.href, shouldAction, should);
-          // エラーハンドリングは、このアクションデータを参照するコンポーネントに任せます。
-          data = DeferredPromise.reject(error);
-          break;
-        }
-
-        case "rejected":
-          // エラーハンドリングは、このアクションデータを参照するコンポーネントに任せます。
-          data = should;
-          break;
-
-        case "fulfilled": {
-          const { value } = should;
-          switch (value) {
-            case true: {
-              // 条件を満たす場合のみ、アクションの実行をスケジュールします。
-              const clientData = DeferredPromise.try(function executeAction() {
-                return action({
-                  params: route.params,
-                  request,
-                });
-              });
-              switch (clientData.status) {
-                case "pending": {
-                  // 特定の返り値を別の値に入れ替えるために中継 DeferredPromise をアクションデータとします。
-                  const proxy = DeferredPromise.withResolvers();
-                  data = proxy.promise;
-                  (async () => {
-                    try {
-                      const value = await clientData;
-                      switch (true) {
-                        case value instanceof RedirectResponse:
-                          // リダイレクトを指示する返り値を記録し、コンポーネントが参照するデータを undefined に置き換えます。
-                          redirects.push(value.pathname);
-                          proxy.resolve(undefined);
-                          break;
-
-                        default:
-                          proxy.resolve(value);
-                      }
-                    } catch (ex) {
-                      proxy.reject(ex);
-                    }
-                  })();
-                  break;
-                }
-
-                case "rejected":
-                  // エラーハンドリングは、このアクションデータを参照するコンポーネントに任せます。
-                  data = clientData;
-                  break;
-
-                case "fulfilled": {
-                  const { value } = clientData;
-                  switch (true) {
-                    case value instanceof RedirectResponse:
-                      // リダイレクトを指示する返り値を記録し、コンポーネントが参照するデータを undefined に置き換えます。
-                      redirects.push(value.pathname);
-                      data = DeferredPromise.resolve(undefined);
-                      break;
-
-                    default:
-                      data = clientData;
-                  }
-
-                  break;
-                }
-
-                default:
-                  unreachable(clientData);
-              }
-
-              break;
-            }
-
-            case false:
-              // 条件を満たさない場合はアクションの実行をスキップします。
-              continue;
-
-            default: {
-              // shouldAction が真偽値を返さなかった場合、エラーとします。
-              const error = new ActionConditionError(request.url.href, shouldAction, value);
-              // エラーハンドリングは、このアクションデータを参照するコンポーネントに任せます。
-              data = DeferredPromise.reject(error);
-            }
-          }
-
-          break;
-        }
-
-        default:
-          unreachable(should);
-      }
-
-      dataIncMap.set(action, data);
-    }
-
-    // アクションを持つルートが見つかった時点で走査を終了します。
-    if (encountered) {
-      break;
-    }
-  }
-
-  if (!encountered) {
-    // 実行されたアクションが無い場合は、これ以上することは何もありません。
-    return;
-  }
-
-  if (dataIncMap.size <= 0) {
-    return async () => ({
-      redirect: undefined,
-      resultMap: new Map(),
-    });
-  }
-
-  // 特定されたアクションのマップをデータストアに格納します。
-  const dataMap = dataStore.get(entry.id);
-  if (dataMap) {
-    for (const [action, data] of dataIncMap) {
-      dataMap.set(action, data);
-    }
-  } else {
-    dataStore.set(entry.id, dataIncMap);
-  }
-
-  return async function waitForActionsComplete() {
-    const resultMap: IDataMap<IAction, unknown> = new Map();
-    const promises: Promise<void>[] = [];
-    const rejected: { action: IAction; reason: unknown }[] = [];
-    for (const [action, data] of dataIncMap) {
-      const promise = (async () => {
-        try {
-          const value = await data;
-          resultMap.set(action, value);
-        } catch (ex) {
-          rejected.push({
-            action,
-            reason: ex,
-          });
-        }
-      })();
-      promises.push(promise);
-    }
-
-    // すべてのアクションの完了を待ちます。
-    await Promise.all(promises);
-
-    // エラーが発生したアクションがある場合は例外を投げます。
-    if (rejected.length > 0) {
-      throw new ActionExecutionError(request.url.href, rejected);
-    }
-
-    // 複数のアクションからリダイレクトが返された場合は不正な状態としてエラーを投げます。
-    if (redirects.length > 1) {
-      throw new MultipleRedirectError(request.url.href, redirects);
-    }
-
-    return {
-      redirect: redirects[0],
-      resultMap,
-    };
-  };
-}

package/src/hooks/_use-route-context.ts

@@ -1,19 +0,0 @@
-import * as React from "react";
-import RouteContext, { type RouteContextValue } from "../contexts/route-context.js";
-import { RouteContextMissingError } from "../core/errors.js";
-
-/**
- * ルートに関するコンテキスト情報を取得するためのカスタムフックです。
- *
- *  `RouteContext` から現在のコンテキスト値を抽出し、コンテキストが提供されていない場合にはエラーを投げます。
- *
- * @returns 現在のルートコンテキストの値を返します。
- */
-export default function useRouteContext(): RouteContextValue {
-  const routeContext = React.use(RouteContext);
-  if (!routeContext) {
-    throw new RouteContextMissingError();
-  }
-
-  return routeContext;
-}

package/src/hooks/_use-router-context.ts

@@ -1,25 +0,0 @@
-import * as React from "react";
-import RouterContext, { type RouterRef } from "../contexts/router-context.js";
-import { RouterContextMissingError } from "../core/errors.js";
-
-/**
- * ルーターのコンテキストから特定の状態を抽出して取得するためのカスタムフックです。
- *
- * @template TSlice 抽出される状態の型です。
- * @param selector ルーターの参照から必要なデータを抽出するためのセレクター関数です。
- * @returns セレクターによって抽出された状態を返します。
- */
-export default function useRouterContext<TSlice>(
-  selector: (router: RouterRef["current"]) => TSlice,
-): TSlice {
-  const routerContext = React.use(RouterContext);
-  if (!routerContext) {
-    throw new RouterContextMissingError();
-  }
-
-  const {
-    routerRef,
-    subscribe,
-  } = routerContext;
-  return React.useSyncExternalStore(subscribe, () => selector(routerRef.current));
-}

package/src/hooks/use-pathname.ts

@@ -1,10 +0,0 @@
-import useRouterContext from "./_use-router-context.js";
-
-/**
- * 現在のルートにおける URL のパスネームを取得するためのカスタムフックです。
- *
- * @returns 現在のルートにおけるパスネームを表す文字列を返します。
- */
-export default function usePathname(): string {
-  return useRouterContext(router => router.currentEntry.url.pathname);
-}

package/src/utils/get-action-id.ts

@@ -1,12 +0,0 @@
-import { ACTION_ID_FORM_DATA_NAME } from "../core/constants.js";
-
-/**
- * フォームデータからアクション ID を取得します。
- *
- * @param formData 取得対象のフォームデータです。
- * @returns 取得したアクション ID を返します。文字列でない場合や存在しない場合は null を返します。
- */
-export default function getActionId(formData: FormData): string | null {
-  const id = formData.get(ACTION_ID_FORM_DATA_NAME);
-  return typeof id === "string" ? id : null;
-}

package/src/utils/href.ts

@@ -1,17 +0,0 @@
-import { inject, type RouteParams } from "regexparam";
-import type { PathParams } from "../core/route.types.js";
-
-/**
- * 指定されたパスのテンプレートにパラメーターを注入し、完全な URL パスを生成します。
- *
- * @template TPath パスのテンプレート文字列の型です。
- * @param path パスのテンプレート文字列です（例: `/users/:id`）。
- * @param params パスに注入するパラメーターのオブジェクトです。
- * @returns パラメーターが注入された後の文字列を返します。
- */
-export default function href<const TPath extends string>(
-  path: TPath,
-  params: PathParams<TPath>,
-): string {
-  return inject(path, params as RouteParams<TPath>);
-}

package/src/utils/route-index.ts

@@ -1,70 +0,0 @@
-import type { DataFunctionObject, RouteDefinition } from "../core/route.types.js";
-import route, { type RouteEntryModule, type RouteModule } from "./route-route.js";
-
-/**
- * インデックスルートの定義を構成するモジュールの型定義です。
- *
- * @template TPath ルートのパス（パスパターン）の型です。
- */
-export type IndexRouteModule<TPath extends string = string> = RouteModule<TPath>;
-
-/**
- * インデックスルートの起点となるエントリーモジュールの型定義です。
- *
- * @template TPath ルートのパス（パスパターン）の型です。
- */
-export type IndexRouteEntryModule<TPath extends string = string> = RouteEntryModule<TPath>;
-
-/**
- * 複数のモジュール配列からインデックスルート定義を生成するオーバーロードです。
- *
- * @template TPath ルートのパスの型です。
- * @param mods エントリーモジュールと追加のデータ操作関数の配列です。
- * @returns 構成されたインデックスルート定義オブジェクトを返します。
- */
-function index<const TPath extends string = string>(
-  mods: readonly [entry: IndexRouteEntryModule<TPath>, ...ui: DataFunctionObject<TPath>[]],
-): RouteDefinition<TPath>;
-
-/**
- * 単一のルートモジュールからインデックスルート定義を生成するオーバーロードです。
- *
- * @template TPath ルートのパスの型です。
- * @param mod ルートモジュールオブジェクトです。
- * @returns 構成されたインデックスルート定義オブジェクトを返します。
- */
-function index<const TPath extends string = string>(
-  mod: IndexRouteModule<TPath>,
-): RouteDefinition<TPath>;
-
-/**
- * インデックスルートモジュールまたはモジュール配列を受け取り、インデックスルート定義を生成します。
- *
- * @template TPath ルートのパスの型です。
- * @param modOrMods ルートモジュールまたはエントリーモジュールを含む配列です。
- * @param children 子ルートの配列です（インデックスルートでは通常使用されません）。
- * @returns 構成されたインデックスルート定義オブジェクトを返します。
- */
-function index<const TPath extends string = string>(
-  modOrMods:
-    | IndexRouteModule<TPath>
-    | readonly [entry: IndexRouteEntryModule<TPath>, ...ui: DataFunctionObject<TPath>[]],
-  children: readonly RouteDefinition[],
-): RouteDefinition<TPath>;
-
-/**
- * インデックスルート定義を構築する関数の実体です。
- * `route` 関数を利用して定義を生成し、`children` を明示的に `undefined` に設定します。
- */
-function index(
-  arg0:
-    | IndexRouteModule
-    | readonly [entry: IndexRouteEntryModule, ...ui: DataFunctionObject[]],
-): RouteDefinition {
-  // route 関数でベースとなる定義を生成した後、子ルートを持たないように上書きします。
-  return Object.assign(route(arg0, []), {
-    children: undefined,
-  });
-}
-
-export default index;

package/src/utils/route-route.ts

@@ -1,111 +0,0 @@
-import type { DataFunctionObject, RouteDefinition } from "../core/route.types.js";
-
-/**
- * ルートの定義を構成するモジュールの型定義です。
- *
- * @template TPath ルートのパス（パスパターン）の型です。
- */
-export type RouteModule<TPath extends string = string> = DataFunctionObject<TPath> & {
-  /**
-   * ルートのパス（パスパターン）です。
-   */
-  readonly path: TPath;
-
-  /**
-   * このルートで描画される React コンポーネントです。
-   */
-  readonly default?: React.ComponentType<{}> | undefined;
-};
-
-/**
- * ルートの起点となるエントリーモジュールの型定義です。
- *
- * データ操作関数の定義を直接含みます。
- *
- * @template TPath ルートのパス（パスパターン）の型です。
- */
-export type RouteEntryModule<TPath extends string = string> = DataFunctionObject<TPath> & {
-  /**
-   * ルートのパス（パスパターン）です。
-   */
-  readonly path: TPath;
-
-  /**
-   * このルートで描画される React コンポーネントです。
-   */
-  readonly default?: React.ComponentType<{}> | undefined;
-};
-
-/**
- * 複数のモジュール配列からルート定義を生成するオーバーロードです。
- *
- * @template TPath ルートのパスの型です。
- * @param mods エントリーモジュールと追加のデータ操作関数の配列です。
- * @param children 子ルートの配列です。
- * @returns 構成されたルート定義オブジェクトを返します。
- */
-function route<const TPath extends string = string>(
-  mods: readonly [entry: RouteEntryModule<TPath>, ...ui: DataFunctionObject<TPath>[]],
-  children: readonly RouteDefinition[],
-): RouteDefinition<TPath>;
-
-/**
- * 単一のルートモジュールからルート定義を生成するオーバーロードです。
- *
- * @template TPath ルートのパスの型です。
- * @param mod ルートモジュールオブジェクトです。
- * @param children 子ルートの配列です。
- * @returns 構成されたルート定義オブジェクトを返します。
- */
-function route<const TPath extends string = string>(
-  mod: RouteModule<TPath>,
-  children: readonly RouteDefinition[],
-): RouteDefinition<TPath>;
-
-/**
- * ルートモジュールまたはモジュール配列を受け取り、ルート定義を生成します。
- *
- * @template TPath ルートのパスの型です。
- * @param modOrMods ルートモジュールまたはエントリーモジュールを含む配列です。
- * @param children 子ルートの配列です。
- * @returns 構成されたルート定義オブジェクトを返します。
- */
-function route<const TPath extends string = string>(
-  modOrMods:
-    | RouteModule<TPath>
-    | readonly [entry: RouteEntryModule<TPath>, ...ui: DataFunctionObject<TPath>[]],
-  children: readonly RouteDefinition[],
-): RouteDefinition<TPath>;
-
-/**
- * ルート定義を構築する関数の実体です。
- */
-function route(
-  modOrMods:
-    | RouteModule
-    | readonly [entry: RouteEntryModule, ...ui: DataFunctionObject[]],
-  children: readonly RouteDefinition[],
-): RouteDefinition {
-  // 配列形式で渡された場合の処理です。
-  if (Array.isArray(modOrMods)) {
-    const mods = modOrMods;
-    const [entry, ...ui] = mods;
-    return {
-      path: entry.path,
-      children,
-      component: entry.default,
-      dataFunctions: [entry, ...ui],
-    };
-  }
-
-  // オブジェクト形式で渡された場合の処理です。
-  const mod = modOrMods;
-  return {
-    path: mod.path,
-    children,
-    component: mod.default,
-    dataFunctions: [mod],
-  };
-}
-
-export default route;

package/src/utils/set-action-id.ts

@@ -1,14 +0,0 @@
-import actionIdRegistry from "../core/_action-id-registry.js";
-import { ACTION_ID_FORM_DATA_NAME } from "../core/constants.js";
-import type { IAction } from "../core/route.types.js";
-
-/**
- * フォームデータに対してアクション ID を発行し、設定します。
- *
- * @param formData アクション ID を設定する対象のフォームデータです。
- * @param action アクション関数です。
- */
-export default function setActionId(formData: FormData, action: IAction): void {
-  const id = actionIdRegistry.set(action);
-  formData.set(ACTION_ID_FORM_DATA_NAME, id);
-}