soseki 0.0.9 → 0.0.10

package/dist/src/core/match-route-path.d.ts

@@ -0,0 +1,46 @@
+/**
+ * ルーティングの照合対象となる URL 情報を表すインターフェースです。
+ */
+export interface MatchRoutePathTargetURL {
+    /**
+     * 照合対象のパス名です。
+     */
+    readonly pathname: string;
+}
+/**
+ * `matchRoutePath` 関数の動作を設定するための型定義です。
+ */
+export type MatchRoutePathOptions = {
+    /**
+     * 照合の基準となるルーティングのパターン文字列です。
+     */
+    readonly pattern: string;
+    /**
+     * 照合対象とする文字列または URL オブジェクトです。
+     */
+    readonly target: string | MatchRoutePathTargetURL;
+    /**
+     * 子ディレクトリーへの前方一致を許可するかどうかを制御するフラグです。
+     *
+     * @default false
+     */
+    readonly allowChild?: boolean | undefined;
+};
+/**
+ * 指定されたパターンと対象のパス名が一致するかどうかを判定します。
+ *
+ * @param options パターン、対象、および一致条件を含む設定オブジェクトです。
+ * @returns パターンに一致した場合は `true` を、一致しない場合は `false` を返します。
+ */
+declare function matchRoutePath(options: MatchRoutePathOptions): boolean;
+/**
+ * 指定されたパターンと対象のパス名が一致するかどうかを判定します。
+ *
+ * @param pattern 照合の基準となるルーティングのパターン文字列です。
+ * @param target 照合対象とする文字列または URL オブジェクトです。
+ * @param options オプションです。
+ * @returns パターンに一致した場合は `true` を、一致しない場合は `false` を返します。
+ */
+declare function matchRoutePath(pattern: MatchRoutePathOptions["pattern"], target: MatchRoutePathOptions["target"], options?: Omit<MatchRoutePathOptions, "pattern" | "target">): boolean;
+export default matchRoutePath;
+//# sourceMappingURL=match-route-path.d.ts.map

package/dist/src/core/match-route-path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"match-route-path.d.ts","sourceRoot":"","sources":["../../../src/core/match-route-path.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAElD;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF;;;;;GAKG;AACH,iBAAS,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC;AAEjE;;;;;;;GAOG;AACH,iBAAS,cAAc,CACrB,OAAO,EAAE,qBAAqB,CAAC,SAAS,CAAC,EACzC,MAAM,EAAE,qBAAqB,CAAC,QAAQ,CAAC,EACvC,OAAO,CAAC,EAAE,IAAI,CAAC,qBAAqB,EAAE,SAAS,GAAG,QAAQ,CAAC,GAC1D,OAAO,CAAC;AAqBX,eAAe,cAAc,CAAC"}

package/dist/src/core/match-route-path.js

@@ -0,0 +1,16 @@
+import { parse } from "regexparam";
+import RoutePath from "./route-path.js";
+function matchRoutePath(...args) {
+    const { target, pattern, allowChild = false, } = typeof args[0] !== "string"
+        ? args[0]
+        : {
+            ...args[2],
+            target: args[1],
+            pattern: args[0],
+        };
+    const patternPathname = new RoutePath(pattern).pathname;
+    const targetPathname = typeof target === "string" ? target : target.pathname;
+    const patternRegex = parse(patternPathname, allowChild).pattern;
+    return patternRegex.test(targetPathname);
+}
+export default matchRoutePath;

package/dist/src/engines/navigation-api-engine.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"navigation-api-engine.d.ts","sourceRoot":"","sources":["../../../src/engines/navigation-api-engine.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,OAAO;IACzD;;OAEG;IACH,OAAO,CAAC,UAAU,CAAa;IAE/B;;OAEG;IACH,OAAO,CAAC,kBAAkB,CAAsB;IAEhD;;OAEG;IACH,OAAO,CAAC,kBAAkB,CAAyB;IAEnD;;;;OAIG;;IAwBH;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,UAAU;IA2BhD;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,WAAW;IAgSnD;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI;IAkCtC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,GAAG,IAAI;CAgE3C"}
+{"version":3,"file":"navigation-api-engine.d.ts","sourceRoot":"","sources":["../../../src/engines/navigation-api-engine.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,OAAO;IACzD;;OAEG;IACH,OAAO,CAAC,UAAU,CAAa;IAE/B;;OAEG;IACH,OAAO,CAAC,kBAAkB,CAAsB;IAEhD;;OAEG;IACH,OAAO,CAAC,kBAAkB,CAAyB;IAEnD;;;;OAIG;;IAwBH;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,UAAU;IA2BhD;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,WAAW;IA8RnD;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI;IAkCtC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,GAAG,IAAI;CAgE3C"}

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

@@ -78,8 +78,7 @@ export default class NavigationApiEngine {
          * ユーザーのアクションによって発生したすべての遷移要求をインターセプトして処理する、ルーティングの中枢ハンドラーです。
          */
         const handleNavigate = (event) => {
-            // 処理すべきでない通常のブラウザー固有のナビゲーション（ハッシュ変更、ファイルのダウンロードなど）は、
-            // 標準の挙動を妨げないようにインターセプトせず即座にスルーします。
+            // 処理すべきでない通常のブラウザー固有のナビゲーション（ハッシュ変更、ファイルのダウンロードなど）は、標準の挙動を妨げないようにインターセプトせず即座にスルーします。
             // 参照: https://developer.mozilla.org/docs/Web/API/Navigation_API#handling_a_navigation_using_intercept
             if (!event.isTrusted ||
                 !event.canIntercept ||
@@ -146,19 +145,18 @@ export default class NavigationApiEngine {
                     switch (action.data.status) {
                         case "rejected": {
                             // アクションがエラーで失敗した場合は、URL を変更せず現在の元のページに強制リダイレクトさせます。
-                            const { pathname, search, hash } = currentEntry.url;
-                            controller.redirect(pathname + search + hash);
+                            controller.redirect(RoutePath.encode(currentEntry.url));
                             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;
+                            const redirectPath = new RoutePath(redirectTo);
+                            controller.redirect(redirectPath.toString());
+                            redirectUrl.pathname = redirectPath.pathname;
+                            redirectUrl.search = redirectPath.search;
+                            redirectUrl.hash = redirectPath.hash;
                             break;
                         }
                         default:

package/dist/src/soseki.d.ts

@@ -5,6 +5,8 @@ export { default as Outlet } from "./components/outlet.jsx";
 /**************************************************************************************************/
 export type { Issue, UnreachableErrorArgs, UnreachableErrorMeta, LoaderConditionErrorArgs, LoaderConditionErrorMeta, LoaderDataNotFoundErrorArgs, LoaderDataNotFoundErrorMeta, UnexpectedValidationErrorArgs, UnexpectedValidationErrorMeta, } from "./core/errors.js";
 export { ErrorBase, setErrorMessage, UnreachableError, ValidationErrorBase, LoaderConditionError, LoaderDataNotFoundError, RouteContextMissingError, RouterContextMissingError, UnexpectedValidationError, NavigationApiNotSupportedError, } from "./core/errors.js";
+export type * from "./core/match-route-path.js";
+export { default as matchRoutePath } from "./core/match-route-path.js";
 export type * from "./core/readonly-form-data.types.js";
 export type * from "./core/readonly-url.types.js";
 export type * from "./core/redirect-response.js";

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

@@ -1 +1 @@
-{"version":3,"file":"soseki.d.ts","sourceRoot":"","sources":["../../src/soseki.ts"],"names":[],"mappings":"AAAA,mBAAmB,iCAAiC,CAAC;AACrD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAE3E,mBAAmB,yBAAyB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAE5D,oGAAoG;AAEpG,YAAY,EACV,KAAK,EACL,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,wBAAwB,EACxB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,6BAA6B,GAC9B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,SAAS,EACT,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,8BAA8B,GAC/B,MAAM,kBAAkB,CAAC;AAE1B,mBAAmB,oCAAoC,CAAC;AAExD,mBAAmB,8BAA8B,CAAC;AAElD,mBAAmB,6BAA6B,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE1E,mBAAmB,yBAAyB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAElE,mBAAmB,uBAAuB,CAAC;AAE3C,oGAAoG;AAEpG,mBAAmB,4BAA4B,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEtE,mBAAmB,4BAA4B,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEtE,mBAAmB,4BAA4B,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEtE,mBAAmB,yBAAyB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEjE,mBAAmB,uBAAuB,CAAC;AAC3C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAE7D,mBAAmB,2BAA2B,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEpE,mBAAmB,uBAAuB,CAAC;AAC3C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAE7D,oGAAoG;AAEpG,mBAAmB,qBAAqB,CAAC;AACzC,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"soseki.d.ts","sourceRoot":"","sources":["../../src/soseki.ts"],"names":[],"mappings":"AAAA,mBAAmB,iCAAiC,CAAC;AACrD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAE3E,mBAAmB,yBAAyB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAE5D,oGAAoG;AAEpG,YAAY,EACV,KAAK,EACL,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,wBAAwB,EACxB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,6BAA6B,GAC9B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,SAAS,EACT,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,8BAA8B,GAC/B,MAAM,kBAAkB,CAAC;AAE1B,mBAAmB,4BAA4B,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEvE,mBAAmB,oCAAoC,CAAC;AAExD,mBAAmB,8BAA8B,CAAC;AAElD,mBAAmB,6BAA6B,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE1E,mBAAmB,yBAAyB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAElE,mBAAmB,uBAAuB,CAAC;AAE3C,oGAAoG;AAEpG,mBAAmB,4BAA4B,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEtE,mBAAmB,4BAA4B,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEtE,mBAAmB,4BAA4B,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEtE,mBAAmB,yBAAyB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEjE,mBAAmB,uBAAuB,CAAC;AAC3C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAE7D,mBAAmB,2BAA2B,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEpE,mBAAmB,uBAAuB,CAAC;AAC3C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAE7D,oGAAoG;AAEpG,mBAAmB,qBAAqB,CAAC;AACzC,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/src/soseki.js

@@ -1,6 +1,7 @@
 export { default as BrowserRouter } from "./components/browser-router.jsx";
 export { default as Outlet } from "./components/outlet.jsx";
 export { ErrorBase, setErrorMessage, UnreachableError, ValidationErrorBase, LoaderConditionError, LoaderDataNotFoundError, RouteContextMissingError, RouterContextMissingError, UnexpectedValidationError, NavigationApiNotSupportedError, } from "./core/errors.js";
+export { default as matchRoutePath } from "./core/match-route-path.js";
 export { default as RedirectResponse } from "./core/redirect-response.js";
 export { default as RouteRequest } from "./core/route-request.js";
 export { default as useActionData } from "./hooks/use-action-data.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "soseki",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "",
   "homepage": "https://github.com/tai-kun/soseki.js",
   "license": "MIT",

package/src/core/match-route-path.ts

@@ -0,0 +1,78 @@
+import { parse } from "regexparam";
+
+import RoutePath from "./route-path.js";
+
+/**
+ * ルーティングの照合対象となる URL 情報を表すインターフェースです。
+ */
+export interface MatchRoutePathTargetURL {
+  /**
+   * 照合対象のパス名です。
+   */
+  readonly pathname: string;
+}
+
+/**
+ * `matchRoutePath` 関数の動作を設定するための型定義です。
+ */
+export type MatchRoutePathOptions = {
+  /**
+   * 照合の基準となるルーティングのパターン文字列です。
+   */
+  readonly pattern: string;
+
+  /**
+   * 照合対象とする文字列または URL オブジェクトです。
+   */
+  readonly target: string | MatchRoutePathTargetURL;
+
+  /**
+   * 子ディレクトリーへの前方一致を許可するかどうかを制御するフラグです。
+   *
+   * @default false
+   */
+  readonly allowChild?: boolean | undefined;
+};
+
+/**
+ * 指定されたパターンと対象のパス名が一致するかどうかを判定します。
+ *
+ * @param options パターン、対象、および一致条件を含む設定オブジェクトです。
+ * @returns パターンに一致した場合は `true` を、一致しない場合は `false` を返します。
+ */
+function matchRoutePath(options: MatchRoutePathOptions): boolean;
+
+/**
+ * 指定されたパターンと対象のパス名が一致するかどうかを判定します。
+ *
+ * @param pattern 照合の基準となるルーティングのパターン文字列です。
+ * @param target 照合対象とする文字列または URL オブジェクトです。
+ * @param options オプションです。
+ * @returns パターンに一致した場合は `true` を、一致しない場合は `false` を返します。
+ */
+function matchRoutePath(
+  pattern: MatchRoutePathOptions["pattern"],
+  target: MatchRoutePathOptions["target"],
+  options?: Omit<MatchRoutePathOptions, "pattern" | "target">,
+): boolean;
+
+function matchRoutePath(...args: any): boolean {
+  const {
+    target,
+    pattern,
+    allowChild = false,
+  }: MatchRoutePathOptions = typeof args[0] !== "string"
+    ? args[0]
+    : {
+        ...args[2],
+        target: args[1],
+        pattern: args[0],
+      };
+  const patternPathname = new RoutePath(pattern).pathname;
+  const targetPathname = typeof target === "string" ? target : target.pathname;
+  const patternRegex = parse(patternPathname, allowChild).pattern;
+
+  return patternRegex.test(targetPathname);
+}
+
+export default matchRoutePath;

package/src/engines/navigation-api-engine.ts

@@ -105,8 +105,7 @@ export default class NavigationApiEngine implements IEngine {
      * ユーザーのアクションによって発生したすべての遷移要求をインターセプトして処理する、ルーティングの中枢ハンドラーです。
      */
     const handleNavigate = (event: NavigateEvent): void => {
-      // 処理すべきでない通常のブラウザー固有のナビゲーション（ハッシュ変更、ファイルのダウンロードなど）は、
-      // 標準の挙動を妨げないようにインターセプトせず即座にスルーします。
+      // 処理すべきでない通常のブラウザー固有のナビゲーション（ハッシュ変更、ファイルのダウンロードなど）は、標準の挙動を妨げないようにインターセプトせず即座にスルーします。
       // 参照: https://developer.mozilla.org/docs/Web/API/Navigation_API#handling_a_navigation_using_intercept
       if (
         !event.isTrusted ||
@@ -187,8 +186,7 @@ export default class NavigationApiEngine implements IEngine {
           switch (action.data.status) {
             case "rejected": {
               // アクションがエラーで失敗した場合は、URL を変更せず現在の元のページに強制リダイレクトさせます。
-              const { pathname, search, hash } = currentEntry.url;
-              controller.redirect(pathname + search + hash);
+              controller.redirect(RoutePath.encode(currentEntry.url));
 
               break;
             }
@@ -197,12 +195,12 @@ export default class NavigationApiEngine implements IEngine {
               // アクションが正常終了した場合、返り値にリダイレクト指示が含まれていればその目的地へ遷移させます。
               // リダイレクトがなければそのまま本来の目的地へとブラウザーのコミット先を書き換えます。
               const { redirectTo = currentEntry.url } = actionResponse;
-              const { pathname, search, hash } = redirectTo;
-              controller.redirect(pathname + search + hash);
+              const redirectPath = new RoutePath(redirectTo);
+              controller.redirect(redirectPath.toString());
 
-              redirectUrl.pathname = pathname;
-              redirectUrl.search = search;
-              redirectUrl.hash = hash;
+              redirectUrl.pathname = redirectPath.pathname;
+              redirectUrl.search = redirectPath.search;
+              redirectUrl.hash = redirectPath.hash;
 
               break;
             }

package/src/soseki.ts

@@ -30,6 +30,9 @@ export {
   NavigationApiNotSupportedError,
 } from "./core/errors.js";
 
+export type * from "./core/match-route-path.js";
+export { default as matchRoutePath } from "./core/match-route-path.js";
+
 export type * from "./core/readonly-form-data.types.js";
 
 export type * from "./core/readonly-url.types.js";