@devp0nt/route0 1.0.0-next.64 → 1.0.0-next.66

package/dist/esm/index.d.ts

@@ -1,3 +1,5 @@
+import { StandardSchemaV1 } from '@standard-schema/spec';
+
 /**
  * Strongly typed route descriptor and URL builder.
  *
@@ -138,14 +140,19 @@ declare class Route0<TDefinition extends string> {
     getLocation(location: AnyLocation): KnownLocation<TDefinition>;
     getLocation(url: AnyLocation): KnownLocation<TDefinition>;
     getLocation(hrefOrHrefRelOrLocation: string | AnyLocation | URL): KnownLocation<TDefinition>;
-    /**
-     * Safe parser for flat input objects.
-     *
-     * Returns structured success/error result instead of throwing.
-     */
-    safeParseFlatInput<TLoose extends boolean = HasLooseSearch<TDefinition>>(input: unknown, loose?: TLoose): TLoose extends true ? SafeParseInputLooseResult<TDefinition> : SafeParseInputStrictResult<TDefinition>;
-    /** Throwing variant of `safeParseFlatInput()`. */
-    parseFlatInput<TLoose extends boolean = HasLooseSearch<TDefinition>>(input: unknown, loose?: TLoose): TLoose extends true ? LooseFlatOutput<TDefinition> : StrictFlatOutput<TDefinition>;
+    private _validateParamsInput;
+    private _validateSearchInput;
+    private _validateFlatInput;
+    private _safeParseSchemaResult;
+    private _parseSchemaResult;
+    /** Standard Schema for route params input. */
+    readonly paramsInputSchema: Route0Schema<ParamsInput<TDefinition> | undefined, ParamsOutput<TDefinition>>;
+    /** Standard Schema for strict search input. */
+    readonly strictSearchInputSchema: Route0Schema<StrictSearchInput<TDefinition> | undefined, StrictSearchOutput<TDefinition>>;
+    /** Standard Schema for loose search input. */
+    readonly looseSearchInputSchema: Route0Schema<LooseSearchInput<TDefinition> | undefined, LooseSearchOutput<TDefinition>>;
+    /** Standard Schema for route flat input (uses route default strict/loose mode). */
+    readonly flatInputSchema: Route0Schema<FlatInput<TDefinition, HasLooseSearch<TDefinition>> | undefined, FlatOutput<TDefinition, HasLooseSearch<TDefinition>>>;
     /** True when path structure is equal (param names are ignored). */
     isSame(other: AnyRoute): boolean;
     /** Static convenience wrapper for `isSame`. */
@@ -173,7 +180,7 @@ declare class Routes<const T extends RoutesRecord = any> {
     _: {
         routes: Routes<T>['_routes'];
         getLocation: Routes<T>['_getLocation'];
-        override: Routes<T>['_override'];
+        clone: Routes<T>['_clone'];
         pathsOrdering: Routes<T>['_pathsOrdering'];
         keysOrdering: Routes<T>['_keysOrdering'];
         ordered: Routes<T>['_ordered'];
@@ -197,7 +204,7 @@ declare class Routes<const T extends RoutesRecord = any> {
     _getLocation(hrefOrHrefRelOrLocation: string | AnyLocation | URL): UnknownLocation | ExactLocation;
     private static makeOrdering;
     /** Returns a cloned routes collection with config applied to each route. */
-    _override(config: RouteConfigInput): RoutesPretty<T>;
+    _clone(config: RouteConfigInput): RoutesPretty<T>;
     static _: {
         prettify: typeof Routes.prettify;
         hydrate: typeof Routes.hydrate;
@@ -221,7 +228,7 @@ type RoutesRecordHydrated<TRoutesRecord extends RoutesRecord = any> = {
     [K in keyof TRoutesRecord]: CallableRoute<TRoutesRecord[K]>;
 };
 /** Public shape returned by `Routes.create()`. Default `any` so `satisfies RoutesPretty` accepts any created routes. */
-type RoutesPretty<TRoutesRecord extends RoutesRecord = any> = RoutesRecordHydrated<TRoutesRecord> & Omit<Routes<TRoutesRecord>, '_routes' | '_getLocation' | '_override' | '_pathsOrdering' | '_keysOrdering' | '_ordered'>;
+type RoutesPretty<TRoutesRecord extends RoutesRecord = any> = RoutesRecordHydrated<TRoutesRecord> & Omit<Routes<TRoutesRecord>, '_routes' | '_getLocation' | '_clone' | '_pathsOrdering' | '_keysOrdering' | '_ordered'>;
 type ExtractRoutesKeys<TRoutes extends RoutesPretty | RoutesRecord> = TRoutes extends RoutesPretty ? Extract<keyof TRoutes['_']['routes'], string> : TRoutes extends RoutesRecord ? Extract<keyof TRoutes, string> : never;
 type ExtractRoute<TRoutes extends RoutesPretty | RoutesRecord, TKey extends ExtractRoutesKeys<TRoutes>> = TRoutes extends RoutesPretty ? TRoutes['_']['routes'][TKey] : TRoutes extends RoutesRecord ? TRoutes[TKey] : never;
 type Definition<T extends AnyRoute | string> = T extends AnyRoute ? T['definition'] : T extends string ? T : never;
@@ -508,5 +515,9 @@ type _SafeParseInputResult<TInputParsed extends Record<string, unknown>> = {
 };
 type SafeParseInputStrictResult<TDefinition extends string> = _SafeParseInputResult<StrictFlatOutput<TDefinition>>;
 type SafeParseInputLooseResult<TDefinition extends string> = _SafeParseInputResult<LooseFlatOutput<TDefinition>>;
+type Route0Schema<TInput extends Record<string, unknown> | undefined, TOutput extends Record<string, unknown>> = StandardSchemaV1<TInput, TOutput> & {
+    parse: (input: unknown) => TOutput;
+    safeParse: (input: unknown) => _SafeParseInputResult<TOutput>;
+};
 
-export { type AmpSplit, type AncestorLocation, type AncestorLocationState, type AnyLocation, type AnyRoute, type AnyRouteOrDefinition, type CallableRoute, type CanInputBeEmpty, type DedupeSlashes, type Definition, type DescendantLocation, type DescendantLocationState, type EmptyRecord, type ExactLocation, type ExactLocationState, type Extended, type ExtractPathParams, type ExtractRoute, type ExtractRoutesKeys, type FlatInput, type FlatInputStringOnly, type FlatInputWithHash, type FlatOutput, type FlatOutputWithHash, type HasLooseSearch, type HasNamedSearch, type HasParams, type HasSearch, type IsAncestor, type IsDescendant, type IsSame, type IsSameParams, type JoinPath, type KnownLocation, type LocationParams, type LocationSearch, type LooseFlatInput, type LooseFlatInputStringOnly, type LooseFlatInputWithHash, type LooseFlatOutput, type LooseFlatOutputWithHash, type LooseSearchInput, type LooseSearchInputStringOnly, type LooseSearchOutput, type NonEmpty, type OnlyIfHasParams, type OnlyIfNoParams, type ParamsDefinition, type ParamsInput, type ParamsInputStringOnly, type ParamsOutput, type PathDefinition, type PathExtended, type ReplacePathParams, Route0, type RouteConfigInput, Routes, type RoutesPretty, type RoutesRecord, type RoutesRecordHydrated, type SafeParseInputLooseResult, type SafeParseInputStrictResult, type SearchDefinition, type SearchTailDefinitionWithFirstAmp, type SearchTailDefinitionWithoutFirstAmp, type SearchTailDefinitionWithoutFirstAndLastAmp, type StrictFlatInput, type StrictFlatInputStringOnly, type StrictFlatInputWithHash, type StrictFlatOutput, type StrictFlatOutputWithHash, type StrictSearchInput, type StrictSearchInputStringOnly, type StrictSearchOutput, type TrimSearchTailDefinition, type UnknownLocation, type UnknownLocationState, type UnmatchedLocation, type UnmatchedLocationState, type WeakAncestorLocation, type WeakAncestorLocationState, type WeakDescendantLocation, type WeakDescendantLocationState, type WithParamsInput, type _GeneralLocation, type _IsAncestor, type _IsDescendant, type _IsSame, type _IsSameParams, type _LooseFlatInput, type _LooseFlatInputStringOnly, type _LooseSearchInput, type _LooseSearchInputStringOnly, type _ParamsDefinition, type _ParamsInput, type _ParamsInputStringOnly, type _PathDefinition, type _SafeParseInputResult, type _SearchDefinition, type _StrictFlatInput, type _StrictFlatInputStringOnly, type _StrictSearchInput, type _StrictSearchInputStringOnly };
+export { type AmpSplit, type AncestorLocation, type AncestorLocationState, type AnyLocation, type AnyRoute, type AnyRouteOrDefinition, type CallableRoute, type CanInputBeEmpty, type DedupeSlashes, type Definition, type DescendantLocation, type DescendantLocationState, type EmptyRecord, type ExactLocation, type ExactLocationState, type Extended, type ExtractPathParams, type ExtractRoute, type ExtractRoutesKeys, type FlatInput, type FlatInputStringOnly, type FlatInputWithHash, type FlatOutput, type FlatOutputWithHash, type HasLooseSearch, type HasNamedSearch, type HasParams, type HasSearch, type IsAncestor, type IsDescendant, type IsSame, type IsSameParams, type JoinPath, type KnownLocation, type LocationParams, type LocationSearch, type LooseFlatInput, type LooseFlatInputStringOnly, type LooseFlatInputWithHash, type LooseFlatOutput, type LooseFlatOutputWithHash, type LooseSearchInput, type LooseSearchInputStringOnly, type LooseSearchOutput, type NonEmpty, type OnlyIfHasParams, type OnlyIfNoParams, type ParamsDefinition, type ParamsInput, type ParamsInputStringOnly, type ParamsOutput, type PathDefinition, type PathExtended, type ReplacePathParams, Route0, type Route0Schema, type RouteConfigInput, Routes, type RoutesPretty, type RoutesRecord, type RoutesRecordHydrated, type SafeParseInputLooseResult, type SafeParseInputStrictResult, type SearchDefinition, type SearchTailDefinitionWithFirstAmp, type SearchTailDefinitionWithoutFirstAmp, type SearchTailDefinitionWithoutFirstAndLastAmp, type StrictFlatInput, type StrictFlatInputStringOnly, type StrictFlatInputWithHash, type StrictFlatOutput, type StrictFlatOutputWithHash, type StrictSearchInput, type StrictSearchInputStringOnly, type StrictSearchOutput, type TrimSearchTailDefinition, type UnknownLocation, type UnknownLocationState, type UnmatchedLocation, type UnmatchedLocationState, type WeakAncestorLocation, type WeakAncestorLocationState, type WeakDescendantLocation, type WeakDescendantLocationState, type WithParamsInput, type _GeneralLocation, type _IsAncestor, type _IsDescendant, type _IsSame, type _IsSameParams, type _LooseFlatInput, type _LooseFlatInputStringOnly, type _LooseSearchInput, type _LooseSearchInputStringOnly, type _ParamsDefinition, type _ParamsInput, type _ParamsInputStringOnly, type _PathDefinition, type _SafeParseInputResult, type _SearchDefinition, type _StrictFlatInput, type _StrictFlatInputStringOnly, type _StrictSearchInput, type _StrictSearchInputStringOnly };

package/dist/esm/index.js

@@ -9,7 +9,7 @@ class Route0 {
   get origin() {
     if (!this._origin) {
       throw new Error(
-        "origin for route " + this.definition + ' is not set, please provide it like Route0.create(route, {origin: "https://example.com"}) in config or set via overrides like routes._.override({origin: "https://example.com"})'
+        "origin for route " + this.definition + ' is not set, please provide it like Route0.create(route, {origin: "https://example.com"}) in config or set via clones like routes._.clone({origin: "https://example.com"})'
       );
     }
     return this._origin;
@@ -434,76 +434,171 @@ class Route0 {
       unmatched
     };
   }
-  /**
-   * Safe parser for flat input objects.
-   *
-   * Returns structured success/error result instead of throwing.
-   */
-  safeParseFlatInput(input, loose) {
-    loose ??= this.hasLooseSearch;
+  _validateParamsInput(input) {
     const paramsKeys = this.getParamsKeys();
     if (input === void 0) {
       if (paramsKeys.length) {
         return {
-          success: false,
-          data: void 0,
-          error: new Error(`Missing params: ${paramsKeys.map((k) => `"${k}"`).join(", ")}`)
+          issues: [
+            {
+              message: `Missing params: ${paramsKeys.map((k) => `"${k}"`).join(", ")}`
+            }
+          ]
         };
       }
       input = {};
     }
     if (typeof input !== "object" || input === null) {
       return {
-        success: false,
-        data: void 0,
-        error: new Error("Invalid input: expected object")
+        issues: [{ message: "Invalid input: expected object" }]
       };
     }
-    const inputKeys = Object.keys(input);
+    const inputObj = input;
+    const inputKeys = Object.keys(inputObj);
     const notDefinedKeys = paramsKeys.filter((k) => !inputKeys.includes(k));
     if (notDefinedKeys.length) {
       return {
-        success: false,
-        data: void 0,
-        error: new Error(`Missing params: ${notDefinedKeys.map((k) => `"${k}"`).join(", ")}`)
+        issues: [
+          {
+            message: `Missing params: ${notDefinedKeys.map((k) => `"${k}"`).join(", ")}`
+          }
+        ]
       };
     }
     const data = {};
-    const filterKeys = !loose ? [...paramsKeys, ...this.getSearchKeys()] : false;
-    for (const [k, v] of Object.entries(input)) {
-      if (filterKeys && !filterKeys.includes(k)) {
-        continue;
+    for (const k of paramsKeys) {
+      const v = inputObj[k];
+      if (typeof v === "string") {
+        data[k] = v;
+      } else if (typeof v === "number") {
+        data[k] = String(v);
+      } else {
+        return {
+          issues: [{ message: `Invalid input: expected string, number, got ${typeof v} for "${k}"` }]
+        };
       }
+    }
+    return {
+      value: data
+    };
+  }
+  _validateSearchInput(input, loose) {
+    if (input === void 0) {
+      input = {};
+    }
+    if (typeof input !== "object" || input === null) {
+      return {
+        issues: [{ message: "Invalid input: expected object" }]
+      };
+    }
+    const inputObj = input;
+    const paramsKeys = this.getParamsKeys();
+    const searchKeys = this.getSearchKeys();
+    const data = {};
+    for (const [k, v] of Object.entries(inputObj)) {
+      if (k === "hash") continue;
+      if (paramsKeys.includes(k)) continue;
+      if (!loose && !searchKeys.includes(k)) continue;
+      if (v === void 0) continue;
       if (typeof v === "string") {
         data[k] = v;
       } else if (typeof v === "number") {
         data[k] = String(v);
       } else {
-        const isParamKey = paramsKeys.includes(k);
         return {
-          success: false,
-          data: void 0,
-          error: new Error(
-            `Invalid input: expected string, number,${!isParamKey ? " or undefined," : ""} got ${typeof v} for "${k}"`
-          )
+          issues: [{ message: `Invalid input: expected string, number, or undefined, got ${typeof v} for "${k}"` }]
         };
       }
     }
     return {
-      success: true,
-      data,
-      error: void 0
+      value: data
+    };
+  }
+  _validateFlatInput(input, loose) {
+    const paramsResult = this._validateParamsInput(input);
+    if ("issues" in paramsResult) {
+      return {
+        issues: paramsResult.issues ?? []
+      };
+    }
+    const searchResult = this._validateSearchInput(input, loose);
+    if ("issues" in searchResult) {
+      return {
+        issues: searchResult.issues ?? []
+      };
+    }
+    return {
+      value: {
+        ...searchResult.value,
+        ...paramsResult.value
+      }
     };
   }
-  /** Throwing variant of `safeParseFlatInput()`. */
-  parseFlatInput(input, loose) {
-    loose ??= this.hasLooseSearch;
-    const result = this.safeParseFlatInput(input, loose);
-    if (result.error) {
-      throw result.error;
+  _safeParseSchemaResult(result) {
+    if ("issues" in result) {
+      return {
+        success: false,
+        data: void 0,
+        error: new Error(result.issues?.[0]?.message ?? "Invalid input")
+      };
     }
-    return result.data;
+    return {
+      success: true,
+      data: result.value,
+      error: void 0
+    };
   }
+  _parseSchemaResult(result) {
+    const safeResult = this._safeParseSchemaResult(result);
+    if (safeResult.error) {
+      throw safeResult.error;
+    }
+    return safeResult.data;
+  }
+  /** Standard Schema for route params input. */
+  paramsInputSchema = {
+    "~standard": {
+      version: 1,
+      vendor: "route0",
+      validate: (value) => this._validateParamsInput(value),
+      types: void 0
+    },
+    parse: (value) => this._parseSchemaResult(this._validateParamsInput(value)),
+    safeParse: (value) => this._safeParseSchemaResult(this._validateParamsInput(value))
+  };
+  /** Standard Schema for strict search input. */
+  strictSearchInputSchema = {
+    "~standard": {
+      version: 1,
+      vendor: "route0",
+      validate: (value) => this._validateSearchInput(value, false),
+      types: void 0
+    },
+    parse: (value) => this._parseSchemaResult(this._validateSearchInput(value, false)),
+    safeParse: (value) => this._safeParseSchemaResult(this._validateSearchInput(value, false))
+  };
+  /** Standard Schema for loose search input. */
+  looseSearchInputSchema = {
+    "~standard": {
+      version: 1,
+      vendor: "route0",
+      validate: (value) => this._validateSearchInput(value, true),
+      types: void 0
+    },
+    parse: (value) => this._parseSchemaResult(this._validateSearchInput(value, true)),
+    safeParse: (value) => this._safeParseSchemaResult(this._validateSearchInput(value, true))
+  };
+  /** Standard Schema for route flat input (uses route default strict/loose mode). */
+  flatInputSchema = {
+    "~standard": {
+      version: 1,
+      vendor: "route0",
+      validate: (value) => this._validateFlatInput(value, this.hasLooseSearch),
+      types: void 0
+    },
+    parse: (value) => this._parseSchemaResult(this._validateFlatInput(value, this.hasLooseSearch)),
+    safeParse: (value) => this._safeParseSchemaResult(this._validateFlatInput(value, this.hasLooseSearch))
+  };
   /** True when path structure is equal (param names are ignored). */
   isSame(other) {
     return this.pathDefinition.replace(/:([A-Za-z0-9_]+)/g, "__PARAM__") === other.pathDefinition.replace(/:([A-Za-z0-9_]+)/g, "__PARAM__");
@@ -631,7 +726,7 @@ class Routes {
     this._ = {
       routes: this._routes,
       getLocation: this._getLocation.bind(this),
-      override: this._override.bind(this),
+      clone: this._clone.bind(this),
       pathsOrdering: this._pathsOrdering,
       keysOrdering: this._keysOrdering,
       ordered: this._ordered
@@ -643,7 +738,7 @@ class Routes {
     if (!override) {
       return result;
     }
-    return result._.override(override);
+    return result._.clone(override);
   }
   static prettify(instance) {
     Object.setPrototypeOf(instance, Routes.prototype);
@@ -651,7 +746,7 @@ class Routes {
       value: "Routes"
     });
     Object.assign(instance, {
-      override: instance._override.bind(instance)
+      clone: instance._clone.bind(instance)
     });
     Object.assign(instance, instance._routes);
     return instance;
@@ -700,7 +795,7 @@ class Routes {
     return { pathsOrdering, keysOrdering };
   }
   /** Returns a cloned routes collection with config applied to each route. */
-  _override(config) {
+  _clone(config) {
     const newRoutes = {};
     for (const key in this._routes) {
       if (Object.hasOwn(this._routes, key)) {