@hyeonqyu/typed-router-core 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,47 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+type Paths<TObject, TSplitter extends string, TPrev extends string = ''> = TSplitter | {
+    [K in keyof TObject & string]: TObject[K] extends object ? `${TSplitter}${TPrev extends '' ? K : `${TPrev}${TSplitter}${K}`}` | Paths<TObject[K], TSplitter, TPrev extends '' ? K : `${TPrev}${TSplitter}${K}`> : `${TSplitter}${TPrev extends '' ? K : `${TPrev}${TSplitter}${K}`}`;
+}[keyof TObject & string];
+type PathValue<T, P extends string, S extends string> = P extends S ? T : P extends `${S}${infer Rest}` ? Rest extends `${infer K}${S}${infer R}` ? K extends keyof T ? PathValue<T[K], `${S}${R}`, S> : never : Rest extends keyof T ? T[Rest] : never : never;
+
+type BaseMetadata = NonNullable<unknown>;
+type RouteNode<TMetadata extends BaseMetadata, TContext> = {
+    _metadata: RouteNodeMetadata<TMetadata, TContext>;
+};
+type RouteNodeMetadata<TMetadata extends BaseMetadata, TContext> = {
+    title?: string;
+    label?: string;
+    description?: string;
+    href?: (context: TContext) => string;
+    accessible?: (context: TContext) => boolean;
+} & TMetadata;
+type PartialRouteTree<TMetadata extends BaseMetadata, TContext> = {
+    [key: string]: RouteNode<TMetadata, TContext> | PartialRouteTree<TMetadata, TContext>;
+};
+type ExtractChildRoutes<TMetadata extends BaseMetadata, TContext, TSubRouteTree, TRouteTree> = {
+    [K in '_metadata' | keyof TSubRouteTree]: K extends '_metadata' ? RouteNodeMetadata<TMetadata, TContext> : K extends keyof TSubRouteTree ? TSubRouteTree[K] extends RouteNode<TMetadata, TContext> ? TSubRouteTree[K] : TSubRouteTree[K] extends Record<string, unknown> ? ExtractChildRoutes<TMetadata, TContext, TSubRouteTree[K], TRouteTree> : never : never;
+};
+type RouteTree<TMetadata extends BaseMetadata, TContext, TSubRouteTree extends PartialRouteTree<TMetadata, TContext>, TRouteTree = TSubRouteTree> = {
+    [K in keyof TSubRouteTree]: TSubRouteTree[K] extends RouteNode<TMetadata, TContext> ? TSubRouteTree[K] : TSubRouteTree[K] extends Record<string, unknown> ? ExtractChildRoutes<TMetadata, TContext, TSubRouteTree[K], TRouteTree> : never;
+};
+type RouteTreeWithoutMetadata<T> = {
+    [K in keyof T as K extends '_metadata' ? never : K]: T[K] extends object ? RouteTreeWithoutMetadata<T[K]> : T[K];
+};
+type RoutePathname<TMetadata extends BaseMetadata, TContext, TRouteTree extends PartialRouteTree<TMetadata, TContext>> = Paths<RouteTreeWithoutMetadata<TRouteTree>, '/', ''>;
+
+declare const createAppRoutes: <TMetadata extends BaseMetadata, TContext>() => <TRouteTree extends PartialRouteTree<TMetadata, TContext>>(appRoutes: TRouteTree & RouteTree<TMetadata, TContext, TRouteTree>) => {
+    AppRoutesProvider: ({ children }: {
+        children: ReactNode;
+    }) => react_jsx_runtime.JSX.Element;
+    useAppRoutes: () => TRouteTree & RouteTree<TMetadata, TContext, TRouteTree, TRouteTree>;
+    useCurrentRouteNode: <TPath extends RoutePathname<TMetadata, TContext, TRouteTree>>(pathname: TPath) => PathValue<TRouteTree, TPath, "/">;
+    _types: {
+        AppRoutesMetadata: TMetadata;
+        AppRoutesContext: TContext;
+        AppRoutesPathname: RoutePathname<TMetadata, TContext, TRouteTree>;
+    };
+};
+
+export { type BaseMetadata, type PartialRouteTree, type RouteNode, type RouteNodeMetadata, type RoutePathname, type RouteTree, createAppRoutes };

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+type Paths<TObject, TSplitter extends string, TPrev extends string = ''> = TSplitter | {
+    [K in keyof TObject & string]: TObject[K] extends object ? `${TSplitter}${TPrev extends '' ? K : `${TPrev}${TSplitter}${K}`}` | Paths<TObject[K], TSplitter, TPrev extends '' ? K : `${TPrev}${TSplitter}${K}`> : `${TSplitter}${TPrev extends '' ? K : `${TPrev}${TSplitter}${K}`}`;
+}[keyof TObject & string];
+type PathValue<T, P extends string, S extends string> = P extends S ? T : P extends `${S}${infer Rest}` ? Rest extends `${infer K}${S}${infer R}` ? K extends keyof T ? PathValue<T[K], `${S}${R}`, S> : never : Rest extends keyof T ? T[Rest] : never : never;
+
+type BaseMetadata = NonNullable<unknown>;
+type RouteNode<TMetadata extends BaseMetadata, TContext> = {
+    _metadata: RouteNodeMetadata<TMetadata, TContext>;
+};
+type RouteNodeMetadata<TMetadata extends BaseMetadata, TContext> = {
+    title?: string;
+    label?: string;
+    description?: string;
+    href?: (context: TContext) => string;
+    accessible?: (context: TContext) => boolean;
+} & TMetadata;
+type PartialRouteTree<TMetadata extends BaseMetadata, TContext> = {
+    [key: string]: RouteNode<TMetadata, TContext> | PartialRouteTree<TMetadata, TContext>;
+};
+type ExtractChildRoutes<TMetadata extends BaseMetadata, TContext, TSubRouteTree, TRouteTree> = {
+    [K in '_metadata' | keyof TSubRouteTree]: K extends '_metadata' ? RouteNodeMetadata<TMetadata, TContext> : K extends keyof TSubRouteTree ? TSubRouteTree[K] extends RouteNode<TMetadata, TContext> ? TSubRouteTree[K] : TSubRouteTree[K] extends Record<string, unknown> ? ExtractChildRoutes<TMetadata, TContext, TSubRouteTree[K], TRouteTree> : never : never;
+};
+type RouteTree<TMetadata extends BaseMetadata, TContext, TSubRouteTree extends PartialRouteTree<TMetadata, TContext>, TRouteTree = TSubRouteTree> = {
+    [K in keyof TSubRouteTree]: TSubRouteTree[K] extends RouteNode<TMetadata, TContext> ? TSubRouteTree[K] : TSubRouteTree[K] extends Record<string, unknown> ? ExtractChildRoutes<TMetadata, TContext, TSubRouteTree[K], TRouteTree> : never;
+};
+type RouteTreeWithoutMetadata<T> = {
+    [K in keyof T as K extends '_metadata' ? never : K]: T[K] extends object ? RouteTreeWithoutMetadata<T[K]> : T[K];
+};
+type RoutePathname<TMetadata extends BaseMetadata, TContext, TRouteTree extends PartialRouteTree<TMetadata, TContext>> = Paths<RouteTreeWithoutMetadata<TRouteTree>, '/', ''>;
+
+declare const createAppRoutes: <TMetadata extends BaseMetadata, TContext>() => <TRouteTree extends PartialRouteTree<TMetadata, TContext>>(appRoutes: TRouteTree & RouteTree<TMetadata, TContext, TRouteTree>) => {
+    AppRoutesProvider: ({ children }: {
+        children: ReactNode;
+    }) => react_jsx_runtime.JSX.Element;
+    useAppRoutes: () => TRouteTree & RouteTree<TMetadata, TContext, TRouteTree, TRouteTree>;
+    useCurrentRouteNode: <TPath extends RoutePathname<TMetadata, TContext, TRouteTree>>(pathname: TPath) => PathValue<TRouteTree, TPath, "/">;
+    _types: {
+        AppRoutesMetadata: TMetadata;
+        AppRoutesContext: TContext;
+        AppRoutesPathname: RoutePathname<TMetadata, TContext, TRouteTree>;
+    };
+};
+
+export { type BaseMetadata, type PartialRouteTree, type RouteNode, type RouteNodeMetadata, type RoutePathname, type RouteTree, createAppRoutes };

package/dist/index.js

@@ -0,0 +1,44 @@
+'use strict';
+
+var react = require('react');
+var jsxRuntime = require('react/jsx-runtime');
+
+// src/routes.utils.tsx
+
+// src/object.utils.ts
+var getSafely = (splitter, obj, path) => {
+  if (path === "" || path === splitter) return obj;
+  const keys = path.split(splitter);
+  let value = obj;
+  for (const key of keys) {
+    if (typeof value === "object" && value !== null && key in value) {
+      value = value[key];
+    } else {
+      return void 0;
+    }
+  }
+  return value;
+};
+var createAppRoutes = () => (appRoutes) => {
+  const Context = react.createContext(appRoutes);
+  const useAppRoutes = () => {
+    return react.useContext(Context);
+  };
+  const useCurrentRouteNode = (pathname) => {
+    const routes = react.useContext(Context);
+    return getSafely("/", routes, pathname);
+  };
+  const AppRoutesProvider = ({ children }) => {
+    return /* @__PURE__ */ jsxRuntime.jsx(Context.Provider, { value: appRoutes, children });
+  };
+  return {
+    AppRoutesProvider,
+    useAppRoutes,
+    useCurrentRouteNode,
+    _types: {}
+  };
+};
+
+exports.createAppRoutes = createAppRoutes;
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/object.utils.ts","../src/routes.utils.tsx"],"names":["createContext","useContext"],"mappings":";;;;;;;;AAEO,IAAM,SAAA,GAAY,CACvB,QAAA,EACA,GAAA,EACA,IAAA,KACyC;AACzC,EAAA,IAAI,IAAA,KAAS,EAAA,IAAM,IAAA,KAAS,QAAA,EAAU,OAAO,GAAA;AAE7C,EAAA,MAAM,IAAA,GAAQ,IAAA,CAAgB,KAAA,CAAM,QAAQ,CAAA;AAC5C,EAAA,IAAI,KAAA,GAAiB,GAAA;AAErB,EAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,IAAA,IAAI,OAAO,KAAA,KAAU,QAAA,IAAY,KAAA,KAAU,IAAA,IAAQ,OAAO,KAAA,EAAO;AAC/D,MAAA,KAAA,GAAS,MAAkC,GAAG,CAAA;AAAA,IAChD,CAAA,MAAO;AACL,MAAA,OAAO,MAAA;AAAA,IACT;AAAA,EACF;AAEA,EAAA,OAAO,KAAA;AACT,CAAA;AChBO,IAAM,eAAA,GACX,MACA,CAA2D,SAAA,KAAuE;AAChI,EAAA,MAAM,OAAA,GAAUA,oBAAuE,SAAS,CAAA;AAEhG,EAAA,MAAM,eAAe,MAAM;AACzB,IAAA,OAAOC,iBAAW,OAAO,CAAA;AAAA,EAC3B,CAAA;AAEA,EAAA,MAAM,mBAAA,GAAsB,CAA+D,QAAA,KAAoB;AAC7G,IAAA,MAAM,MAAA,GAASA,iBAAW,OAAO,CAAA;AACjC,IAAA,OAAO,SAAA,CAAU,GAAA,EAAK,MAAA,EAAQ,QAAQ,CAAA;AAAA,EACxC,CAAA;AAEA,EAAA,MAAM,iBAAA,GAAoB,CAAC,EAAE,QAAA,EAAS,KAA+B;AACnE,IAAA,sCAAQ,OAAA,CAAQ,QAAA,EAAR,EAAiB,KAAA,EAAO,WAAY,QAAA,EAAS,CAAA;AAAA,EACvD,CAAA;AAEA,EAAA,OAAO;AAAA,IACL,iBAAA;AAAA,IACA,YAAA;AAAA,IACA,mBAAA;AAAA,IACA,QAAQ;AAAC,GAKX;AACF","file":"index.js","sourcesContent":["import { Paths, PathValue } from './path.types';\n\nexport const getSafely = <TObject, TSplitter extends string, TPath extends string & Paths<TObject, TSplitter>>(\n  splitter: TSplitter,\n  obj: TObject,\n  path: TPath,\n): PathValue<TObject, TPath, TSplitter> => {\n  if (path === '' || path === splitter) return obj as PathValue<TObject, TPath, TSplitter>;\n\n  const keys = (path as string).split(splitter);\n  let value: unknown = obj;\n\n  for (const key of keys) {\n    if (typeof value === 'object' && value !== null && key in value) {\n      value = (value as Record<string, unknown>)[key];\n    } else {\n      return undefined as PathValue<TObject, TPath, TSplitter>;\n    }\n  }\n\n  return value as PathValue<TObject, TPath, TSplitter>;\n};\n","import { createContext, ReactNode, useContext } from 'react';\nimport { getSafely } from './object.utils';\nimport { PathValue } from './path.types';\nimport { BaseMetadata, PartialRouteTree, RoutePathname, RouteTree } from './routes.types';\n\nexport const createAppRoutes =\n  <TMetadata extends BaseMetadata, TContext>() =>\n  <TRouteTree extends PartialRouteTree<TMetadata, TContext>>(appRoutes: TRouteTree & RouteTree<TMetadata, TContext, TRouteTree>) => {\n    const Context = createContext<TRouteTree & RouteTree<TMetadata, TContext, TRouteTree>>(appRoutes);\n\n    const useAppRoutes = () => {\n      return useContext(Context);\n    };\n\n    const useCurrentRouteNode = <TPath extends RoutePathname<TMetadata, TContext, TRouteTree>>(pathname: TPath) => {\n      const routes = useContext(Context);\n      return getSafely('/', routes, pathname) as PathValue<TRouteTree, TPath, '/'>;\n    };\n\n    const AppRoutesProvider = ({ children }: { children: ReactNode }) => {\n      return <Context.Provider value={appRoutes}>{children}</Context.Provider>;\n    };\n\n    return {\n      AppRoutesProvider,\n      useAppRoutes,\n      useCurrentRouteNode,\n      _types: {} as {\n        AppRoutesMetadata: TMetadata;\n        AppRoutesContext: TContext;\n        AppRoutesPathname: RoutePathname<TMetadata, TContext, TRouteTree>;\n      },\n    };\n  };\n"]}

package/dist/index.mjs

@@ -0,0 +1,42 @@
+import { createContext, useContext } from 'react';
+import { jsx } from 'react/jsx-runtime';
+
+// src/routes.utils.tsx
+
+// src/object.utils.ts
+var getSafely = (splitter, obj, path) => {
+  if (path === "" || path === splitter) return obj;
+  const keys = path.split(splitter);
+  let value = obj;
+  for (const key of keys) {
+    if (typeof value === "object" && value !== null && key in value) {
+      value = value[key];
+    } else {
+      return void 0;
+    }
+  }
+  return value;
+};
+var createAppRoutes = () => (appRoutes) => {
+  const Context = createContext(appRoutes);
+  const useAppRoutes = () => {
+    return useContext(Context);
+  };
+  const useCurrentRouteNode = (pathname) => {
+    const routes = useContext(Context);
+    return getSafely("/", routes, pathname);
+  };
+  const AppRoutesProvider = ({ children }) => {
+    return /* @__PURE__ */ jsx(Context.Provider, { value: appRoutes, children });
+  };
+  return {
+    AppRoutesProvider,
+    useAppRoutes,
+    useCurrentRouteNode,
+    _types: {}
+  };
+};
+
+export { createAppRoutes };
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/object.utils.ts","../src/routes.utils.tsx"],"names":[],"mappings":";;;;;;AAEO,IAAM,SAAA,GAAY,CACvB,QAAA,EACA,GAAA,EACA,IAAA,KACyC;AACzC,EAAA,IAAI,IAAA,KAAS,EAAA,IAAM,IAAA,KAAS,QAAA,EAAU,OAAO,GAAA;AAE7C,EAAA,MAAM,IAAA,GAAQ,IAAA,CAAgB,KAAA,CAAM,QAAQ,CAAA;AAC5C,EAAA,IAAI,KAAA,GAAiB,GAAA;AAErB,EAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,IAAA,IAAI,OAAO,KAAA,KAAU,QAAA,IAAY,KAAA,KAAU,IAAA,IAAQ,OAAO,KAAA,EAAO;AAC/D,MAAA,KAAA,GAAS,MAAkC,GAAG,CAAA;AAAA,IAChD,CAAA,MAAO;AACL,MAAA,OAAO,MAAA;AAAA,IACT;AAAA,EACF;AAEA,EAAA,OAAO,KAAA;AACT,CAAA;AChBO,IAAM,eAAA,GACX,MACA,CAA2D,SAAA,KAAuE;AAChI,EAAA,MAAM,OAAA,GAAU,cAAuE,SAAS,CAAA;AAEhG,EAAA,MAAM,eAAe,MAAM;AACzB,IAAA,OAAO,WAAW,OAAO,CAAA;AAAA,EAC3B,CAAA;AAEA,EAAA,MAAM,mBAAA,GAAsB,CAA+D,QAAA,KAAoB;AAC7G,IAAA,MAAM,MAAA,GAAS,WAAW,OAAO,CAAA;AACjC,IAAA,OAAO,SAAA,CAAU,GAAA,EAAK,MAAA,EAAQ,QAAQ,CAAA;AAAA,EACxC,CAAA;AAEA,EAAA,MAAM,iBAAA,GAAoB,CAAC,EAAE,QAAA,EAAS,KAA+B;AACnE,IAAA,2BAAQ,OAAA,CAAQ,QAAA,EAAR,EAAiB,KAAA,EAAO,WAAY,QAAA,EAAS,CAAA;AAAA,EACvD,CAAA;AAEA,EAAA,OAAO;AAAA,IACL,iBAAA;AAAA,IACA,YAAA;AAAA,IACA,mBAAA;AAAA,IACA,QAAQ;AAAC,GAKX;AACF","file":"index.mjs","sourcesContent":["import { Paths, PathValue } from './path.types';\n\nexport const getSafely = <TObject, TSplitter extends string, TPath extends string & Paths<TObject, TSplitter>>(\n  splitter: TSplitter,\n  obj: TObject,\n  path: TPath,\n): PathValue<TObject, TPath, TSplitter> => {\n  if (path === '' || path === splitter) return obj as PathValue<TObject, TPath, TSplitter>;\n\n  const keys = (path as string).split(splitter);\n  let value: unknown = obj;\n\n  for (const key of keys) {\n    if (typeof value === 'object' && value !== null && key in value) {\n      value = (value as Record<string, unknown>)[key];\n    } else {\n      return undefined as PathValue<TObject, TPath, TSplitter>;\n    }\n  }\n\n  return value as PathValue<TObject, TPath, TSplitter>;\n};\n","import { createContext, ReactNode, useContext } from 'react';\nimport { getSafely } from './object.utils';\nimport { PathValue } from './path.types';\nimport { BaseMetadata, PartialRouteTree, RoutePathname, RouteTree } from './routes.types';\n\nexport const createAppRoutes =\n  <TMetadata extends BaseMetadata, TContext>() =>\n  <TRouteTree extends PartialRouteTree<TMetadata, TContext>>(appRoutes: TRouteTree & RouteTree<TMetadata, TContext, TRouteTree>) => {\n    const Context = createContext<TRouteTree & RouteTree<TMetadata, TContext, TRouteTree>>(appRoutes);\n\n    const useAppRoutes = () => {\n      return useContext(Context);\n    };\n\n    const useCurrentRouteNode = <TPath extends RoutePathname<TMetadata, TContext, TRouteTree>>(pathname: TPath) => {\n      const routes = useContext(Context);\n      return getSafely('/', routes, pathname) as PathValue<TRouteTree, TPath, '/'>;\n    };\n\n    const AppRoutesProvider = ({ children }: { children: ReactNode }) => {\n      return <Context.Provider value={appRoutes}>{children}</Context.Provider>;\n    };\n\n    return {\n      AppRoutesProvider,\n      useAppRoutes,\n      useCurrentRouteNode,\n      _types: {} as {\n        AppRoutesMetadata: TMetadata;\n        AppRoutesContext: TContext;\n        AppRoutesPathname: RoutePathname<TMetadata, TContext, TRouteTree>;\n      },\n    };\n  };\n"]}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@hyeonqyu/typed-router-core",
+  "version": "0.1.0",
+  "description": "Core types and utilities for typed-react-router",
+  "author": "hyeonQyu <dhk0561@naver.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hyeonQyu/typed-react-router.git"
+  },
+  "homepage": "https://github.com/hyeonQyu/typed-react-router#readme",
+  "bugs": {
+    "url": "https://github.com/hyeonQyu/typed-react-router/issues"
+  },
+  "keywords": [
+    "react",
+    "routing",
+    "typescript",
+    "type-safe",
+    "information-architecture"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint . --ext .ts,.tsx",
+    "lint:fix": "eslint . --ext .ts,.tsx --fix",
+    "type": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.5",
+    "react": "^19.2.0",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}