@jlnstack/routes 0.0.0 → 0.0.2

package/src/index.ts

@@ -1,163 +0,0 @@
-import { createRecursiveProxy } from "./proxy";
-
-type SegmentName<S extends string> = S extends `[...${infer N}]`
-  ? N
-  : S extends `[[...${infer N}]]`
-    ? N
-    : S extends `[${infer N}]`
-      ? N
-      : S;
-
-type ChildSegments<
-  Routes extends string,
-  Path extends string,
-> = Routes extends `${Path}/${infer Next}/${string}`
-  ? SegmentName<Next>
-  : Routes extends `${Path}/${infer Next}`
-    ? SegmentName<Next>
-    : never;
-
-type IsDynamicSegment<S extends string> = S extends
-  | `[${string}]`
-  | `[...${string}]`
-  | `[[...${string}]]`
-  ? true
-  : false;
-
-type IsCatchAllSegment<S extends string> = S extends `[...${string}]`
-  ? true
-  : false;
-
-type IsOptionalCatchAllSegment<S extends string> = S extends `[[...${string}]]`
-  ? true
-  : false;
-
-type GetOriginalSegment<
-  Routes extends string,
-  Path extends string,
-  Seg extends string,
-> = Routes extends `${Path}/${infer Next}/${string}`
-  ? SegmentName<Next> extends Seg
-    ? Next
-    : never
-  : Routes extends `${Path}/${infer Next}`
-    ? SegmentName<Next> extends Seg
-      ? Next
-      : never
-    : never;
-
-type IsDynamicAtPath<
-  Routes extends string,
-  Path extends string,
-  Seg extends string,
-> = GetOriginalSegment<Routes, Path, Seg> extends infer Original
-  ? Original extends string
-    ? IsDynamicSegment<Original> extends true
-      ? true
-      : false
-    : false
-  : false;
-
-type IsCatchAllAtPath<
-  Routes extends string,
-  Path extends string,
-  Seg extends string,
-> = GetOriginalSegment<Routes, Path, Seg> extends infer Original
-  ? Original extends string
-    ? IsCatchAllSegment<Original> extends true
-      ? true
-      : false
-    : false
-  : false;
-
-type IsOptionalCatchAllAtPath<
-  Routes extends string,
-  Path extends string,
-  Seg extends string,
-> = GetOriginalSegment<Routes, Path, Seg> extends infer Original
-  ? Original extends string
-    ? IsOptionalCatchAllSegment<Original> extends true
-      ? true
-      : false
-    : false
-  : false;
-
-type Join<
-  T extends readonly string[],
-  Sep extends string,
-> = T extends readonly [
-  infer First extends string,
-  ...infer Rest extends readonly string[],
-]
-  ? Rest["length"] extends 0
-    ? First
-    : `${First}${Sep}${Join<Rest, Sep>}`
-  : "";
-
-type ReplaceDynamicSegments<
-  Path extends string,
-  P extends Record<string, string | string[] | undefined>,
-> = Path extends `${infer Start}/[[...${infer Param}]]${infer Rest}`
-  ? Param extends keyof P
-    ? P[Param] extends readonly string[]
-      ? `${ReplaceDynamicSegments<Start, P>}/${Join<P[Param], "/">}${ReplaceDynamicSegments<Rest, P>}`
-      : `${ReplaceDynamicSegments<Start, P>}${ReplaceDynamicSegments<Rest, P>}`
-    : `${ReplaceDynamicSegments<Start, P>}${ReplaceDynamicSegments<Rest, P>}`
-  : Path extends `${infer Start}/[...${infer Param}]${infer Rest}`
-    ? Param extends keyof P
-      ? P[Param] extends readonly string[]
-        ? `${ReplaceDynamicSegments<Start, P>}/${Join<P[Param], "/">}${ReplaceDynamicSegments<Rest, P>}`
-        : `${ReplaceDynamicSegments<Start, P>}/[...${Param}]${ReplaceDynamicSegments<Rest, P>}`
-      : `${ReplaceDynamicSegments<Start, P>}/[...${Param}]${ReplaceDynamicSegments<Rest, P>}`
-    : Path extends `${infer Start}/[${infer Param}]${infer Rest}`
-      ? Param extends keyof P
-        ? P[Param] extends string
-          ? `${Start}/${P[Param]}${ReplaceDynamicSegments<Rest, P>}`
-          : `${Start}/[${Param}]${ReplaceDynamicSegments<Rest, P>}`
-        : `${Start}/[${Param}]${ReplaceDynamicSegments<Rest, P>}`
-      : Path;
-
-export type RouteNode<
-  Routes extends string,
-  Path extends string,
-  Params extends Record<string, string | string[]> = {},
-> = {
-  getRoute: [keyof Params] extends [never]
-    ? () => Path extends "" ? "/" : Path
-    : <const P extends Params>(params: P) => ReplaceDynamicSegments<Path, P>;
-} & {
-  [Seg in ChildSegments<Routes, Path>]: RouteNode<
-    Routes,
-    Path extends ""
-      ? `/${GetOriginalSegment<Routes, Path, Seg>}`
-      : `${Path}/${GetOriginalSegment<Routes, Path, Seg>}`,
-    IsOptionalCatchAllAtPath<Routes, Path, Seg> extends true
-      ? Params & { [K in Seg]?: string[] }
-      : IsCatchAllAtPath<Routes, Path, Seg> extends true
-        ? Params & { [K in Seg]: string[] }
-        : IsDynamicAtPath<Routes, Path, Seg> extends true
-          ? Params & { [K in Seg]: string }
-          : Params
-  >;
-};
-
-export function createRoutes<Routes extends string>() {
-  return createRecursiveProxy(({ path, args }) => {
-    const segments = path.slice(0, -1);
-    const params = (args[0] ?? {}) as Record<
-      string,
-      string | string[] | undefined
-    >;
-
-    if (segments.length === 0) return "/";
-
-    const resolved = segments.flatMap((seg) => {
-      const value = params[seg];
-      if (Array.isArray(value)) return value;
-      if (value === undefined) return [];
-      return value ?? seg;
-    });
-
-    return resolved.length === 0 ? "/" : `/${resolved.join("/")}`;
-  }) as RouteNode<Routes, "", {}>;
-}

package/src/proxy.ts

@@ -1,26 +0,0 @@
-interface ProxyCallbackOptions {
-  path: readonly string[];
-  args: readonly unknown[];
-}
-
-type ProxyCallback = (opts: ProxyCallbackOptions) => unknown;
-
-export function createRecursiveProxy(
-  callback: ProxyCallback,
-  path: readonly string[] = [],
-) {
-  const proxy: unknown = new Proxy(() => {}, {
-    get(_obj, key) {
-      if (typeof key !== "string") return undefined;
-      return createRecursiveProxy(callback, [...path, key]);
-    },
-    apply(_1, _2, args) {
-      return callback({
-        path,
-        args,
-      });
-    },
-  });
-
-  return proxy;
-}

package/test/index.test-d.ts

@@ -1,60 +0,0 @@
-import { expectTypeOf, test } from "vitest";
-import { createRoutes, type RouteNode } from "../src/index";
-
-type AppRoutes =
-  | "/"
-  | "/dashboard"
-  | "/dashboard/settings"
-  | "/blog/[slug]"
-  | "/users/[id]/posts/[postId]"
-  | "/docs/[...path]"
-  | "/shop/[[...filters]]";
-
-const routes = createRoutes<AppRoutes>() as RouteNode<AppRoutes, "", {}>;
-
-test("root route returns literal '/'", () => {
-  const route = routes.getRoute();
-  expectTypeOf(route).toEqualTypeOf<"/">();
-});
-
-test("static segment returns literal path", () => {
-  const route = routes.dashboard.getRoute();
-  expectTypeOf(route).toEqualTypeOf<"/dashboard">();
-});
-
-test("nested static segments return literal path", () => {
-  const route = routes.dashboard.settings.getRoute();
-  expectTypeOf(route).toEqualTypeOf<"/dashboard/settings">();
-});
-
-test("dynamic param requires string param", () => {
-  const route = routes.blog.slug.getRoute({ slug: "my-article" });
-  expectTypeOf(route).toEqualTypeOf<"/blog/my-article">();
-});
-
-test("nested dynamic params require all params", () => {
-  const route = routes.users.id.posts.postId.getRoute({
-    id: "123",
-    postId: "456",
-  });
-  expectTypeOf(route).toEqualTypeOf<"/users/123/posts/456">();
-});
-
-test("catch-all requires string array param", () => {
-  const route = routes.docs.path.getRoute({
-    path: ["api", "reference"],
-  });
-  expectTypeOf(route).toMatchTypeOf<"/docs/api/reference">();
-});
-
-test("optional catch-all accepts string array", () => {
-  const route = routes.shop.filters.getRoute({
-    filters: ["color", "red"],
-  });
-  expectTypeOf(route).toMatchTypeOf<"/shop/color/red">();
-});
-
-test("optional catch-all accepts undefined", () => {
-  const route = routes.shop.filters.getRoute({ filters: undefined });
-  expectTypeOf(route).toMatchTypeOf<"/shop">();
-});

package/test/index.test.ts

@@ -1,58 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { createRoutes, type RouteNode } from "../src/index";
-
-type AppRoutes =
-  | "/"
-  | "/dashboard"
-  | "/dashboard/settings"
-  | "/blog/[slug]"
-  | "/users/[id]/posts/[postId]"
-  | "/docs/[...path]"
-  | "/shop/[[...filters]]";
-
-const routes = createRoutes<AppRoutes>() as RouteNode<AppRoutes, "", {}>;
-
-describe("createRoutes", () => {
-  it("returns root route", () => {
-    const route = routes.getRoute();
-    expect(route).toBe("/");
-  });
-
-  it("returns static segment", () => {
-    const route = routes.dashboard.getRoute();
-    expect(route).toBe("/dashboard");
-  });
-
-  it("returns nested static segments", () => {
-    const route = routes.dashboard.settings.getRoute();
-    expect(route).toBe("/dashboard/settings");
-  });
-
-  it("returns dynamic param route", () => {
-    const route = routes.blog.slug.getRoute({ slug: "my-article" });
-    expect(route).toBe("/blog/my-article");
-  });
-
-  it("returns nested dynamic params route", () => {
-    const route = routes.users.id.posts.postId.getRoute({
-      id: "123",
-      postId: "456",
-    });
-    expect(route).toBe("/users/123/posts/456");
-  });
-
-  it("returns catch-all route", () => {
-    const route = routes.docs.path.getRoute({ path: ["api", "reference"] });
-    expect(route).toBe("/docs/api/reference");
-  });
-
-  it("returns optional catch-all with value", () => {
-    const route = routes.shop.filters.getRoute({ filters: ["color", "red"] });
-    expect(route).toBe("/shop/color/red");
-  });
-
-  it("returns optional catch-all without value", () => {
-    const route = routes.shop.filters.getRoute({ filters: undefined });
-    expect(route).toBe("/shop");
-  });
-});

package/tsconfig.json

@@ -1,5 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "include": ["src", "test"],
-  "compilerOptions": {}
-}

package/tsdown.config.ts

@@ -1,16 +0,0 @@
-import { defineConfig } from "tsdown";
-
-export default defineConfig({
-  target: ["node18", "es2017"],
-  entry: ["src/index.ts"],
-  dts: {
-    sourcemap: true,
-    tsconfig: "./tsconfig.json",
-  },
-  unbundle: true,
-  format: ["cjs", "esm"],
-  outExtensions: (ctx) => ({
-    dts: ctx.format === "cjs" ? ".d.cts" : ".d.mts",
-    js: ctx.format === "cjs" ? ".cjs" : ".mjs",
-  }),
-});

package/vitest.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  test: {
-    exclude: ["node_modules", "dist"],
-    typecheck: {
-      enabled: true,
-    },
-  },
-});