ziko 0.50.2 → 0.51.1

package/types/index.d.ts

@@ -1,4 +1,5 @@
 export type * from './math'
 export type * from './time'
+export type * from './router'
 export type * from './hooks'
 export type * from './data'

package/types/router/file-based-router/index.d.ts

@@ -0,0 +1,20 @@
+// createSPAFileBasedRouter.d.ts
+
+import { UIElement } from '../../../src/ui/constructors/UIElement.js'
+
+/**
+ * Creates a SPA (Single Page Application) file-based router.
+ * Automatically loads and mounts the component corresponding to the current path.
+ * Supports dynamic routes and parameter extraction.
+ *
+ * @param pages - An object mapping route paths to async module functions that return a component.
+ *                Example: { "/user/[id]": () => import("./pages/user/[id].js") }
+ * @param target - Optional DOM element to mount the component. Defaults to `document.body`.
+ */
+export function createSPAFileBasedRouter(
+  pages: Record<
+    string, 
+    () => Promise<{ default: (param? : Record<string, string>) => UIElement }>
+  >,
+  target?: HTMLElement | UIElement
+): Promise<void>;

package/types/router/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './file-based-router'
+export type * from './utils'

package/types/router/utils/dynamic-routes-parser.d.ts

@@ -0,0 +1,14 @@
+// dynamic_routes_parser.d.ts
+
+/**
+ * Parses a route according to a dynamic mask and returns extracted parameters.
+ *
+ * @param mask - The dynamic route mask (e.g., "/user/[id]+", "/blog/[...slug]").
+ * @param route - The actual route to parse (e.g., "/user/42", "/blog/2025/oct/post").
+ * @returns An object mapping parameter names to their corresponding values.
+ *          Returns an empty object if the route does not match the mask.
+ */
+export declare function dynamic_routes_parser(
+  mask: string,
+  route: string
+): Record<string, string>;

package/types/router/utils/get-root.d.ts

@@ -0,0 +1,11 @@
+// get_root.d.ts
+
+/**
+ * Finds the common root path among an array of paths.
+ * Dynamic segments (e.g., `[id]`) are considered as matching any segment.
+ *
+ * @param paths - An array of route paths (e.g., ["/user/42", "/user/99"]).
+ * @returns The common root path as a string (e.g., "/user/").
+ *          Returns an empty string if no common root exists.
+ */
+export declare function get_root(paths: string[]): string;

package/types/router/utils/index.d.ts

@@ -0,0 +1,5 @@
+export type * from './dynamic-routes-parser.d.ts'
+export type * from './routes-matcher.d.ts'
+export type * from './get-root.d.ts'
+export type * from './routes-grouper.d.ts'
+export type * from './normalize-path.d.ts'

package/types/router/utils/normalize-path.d.ts

@@ -0,0 +1,15 @@
+// normalize_path.d.ts
+
+/**
+ * Normalizes a file path into a route path.
+ *
+ * @param inputPath - The file path to normalize (e.g., "./src/pages/user/[id].ts").
+ * @param root - The root directory to consider as the base (default: "./src/pages").
+ * @param extensions - Array of valid file extensions (default: ["js", "ts"]).
+ * @returns A normalized route path (e.g., "/user/[id]") or an empty string if it cannot be normalized.
+ */
+export declare function normalize_path(
+  inputPath: string,
+  root?: string,
+  extensions?: string[]
+): string;

package/types/router/utils/routes-grouper.d.ts

@@ -0,0 +1,29 @@
+// routes_utils.d.ts
+
+/**
+ * Checks if a route path is dynamic.
+ * Dynamic segments include:
+ *   - Parameters like "[id]"
+ *   - Catch-all segments like "[...slug]"
+ *   - Optional segments like "[id]+"
+ *
+ * @param path - The route path to check.
+ * @returns `true` if the path is dynamic, otherwise `false`.
+ */
+export function is_dynamic(path: string): boolean;
+
+/**
+ * Groups routes into static and dynamic categories.
+ * Throws an error if an optional parameter appears anywhere but the end of the path.
+ *
+ * @param routeMap - An object mapping route paths to their handlers/values.
+ * @returns An object with two properties:
+ *   - `static`: Routes with no dynamic segments.
+ *   - `dynamic`: Routes with dynamic segments.
+ */
+export function routes_grouper<T>(
+  routeMap: Record<string, T>
+): {
+  static: Record<string, T>;
+  dynamic: Record<string, T>;
+};

package/types/router/utils/routes-matcher.d.ts

@@ -0,0 +1 @@
+export declare function routes_matcher(mask: string, route: string): boolean;