neouter 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,55 @@
+# neouter
+
+neouter($/njuːtər/$, ニョーター) is type-safe router for minimalists! (になる予定)
+
+**This project is still under development and may be unstable. PLEASE DO NOT USE IT IN PRODUCTION ENVIRONMENTS!!**
+
+## Installation
+
+```bash
+npm i neouter
+```
+
+## Usage
+
+### Defining Routes
+
+```tsx
+import { useCreateRoutes } from "neouter";
+
+const routes = {
+  "/": {
+    component: () => <div>Hello!</div>,
+  },
+  "/about": {
+    component: () => <div>About</div>,
+  },
+};
+
+export const App = () => {
+  const { Router } = useCreateRoutes({ routes });
+  return <Router />;
+};
+```
+
+### Link
+
+```tsx
+import { Link } from "neouter";
+
+export const Page = () => {
+  return (
+    <div>
+      <p>
+        neouter is a routing library for people who are obsessed with
+        simplicity😄
+      </p>
+      <Link href="/learn">Learn more</Link>
+    </div>
+  );
+};
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md)

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { ComponentProps, ComponentType } from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
 
 //#region src/types.d.ts
 type Path$1 = string;
@@ -29,7 +30,7 @@ declare const BaseLink: ({
   ...props
 }: ComponentProps<"a"> & {
   href: Path$1;
-}) => any;
+}) => react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/hooks/useCreateRoutes.d.ts
 declare const useCreateRoutes: ({
@@ -38,7 +39,15 @@ declare const useCreateRoutes: ({
 }: {
   routes: Routes;
   notFoundComponent?: React.ComponentType;
-}) => any;
+}) => {
+  paths: string[];
+  RouterProvider: ({
+    children
+  }: {
+    children: React.ReactNode;
+  }) => react_jsx_runtime0.JSX.Element;
+  Router: () => react_jsx_runtime0.JSX.Element;
+};
 //#endregion
 //#region src/hooks/usePathParams.d.ts
 declare const usePathParams: <Path extends string>() => ParamsObject<Path> | null;
@@ -47,10 +56,10 @@ declare const usePathParams: <Path extends string>() => ParamsObject<Path> | nul
 type Options = {
   noThrowError?: boolean;
 };
-declare const useQueryParams: <T extends Record<string, QueryParamsValueType>>(expectedTypes: T, options?: Options) => any;
+declare const useQueryParams: <T extends Record<string, QueryParamsValueType>>(expectedTypes: T, options?: Options) => Partial<{ [K in keyof T]: T[K] extends "number" ? number : string }>;
 //#endregion
 //#region src/hooks/useRouter.d.ts
-declare const useRouter: () => readonly [any, any];
+declare const useRouter: () => readonly [string, (path: string) => void];
 //#endregion
 //#region src/libs/extractParams.d.ts
 declare const extractParams: <Path extends string, Params extends string = ExtractParams<Path>>(pathPattern: Path, actualPath: string) => Record<Params, string>;
@@ -62,6 +71,6 @@ declare const getMatchedPath: (routes: Routes, path: string) => Path$1 | null;
 declare function lazyImport<U extends string, T$1 extends { [P in U]: ComponentType }>(factory: () => Promise<T$1>, name: U): T$1;
 //#endregion
 //#region src/libs/redirect.d.ts
-declare const redirect: <T extends Path$1>(path: T) => () => any;
+declare const redirect: <T extends Path$1>(path: T) => () => react_jsx_runtime0.JSX.Element;
 //#endregion
 export { type AssertPathType, BaseLink, type ExtractParams, type ParamsObject, type Path$1 as Path, type QueryParamsValueType, type Routes, type WithQueryAndHash, extractParams, getMatchedPath, lazyImport, redirect, useCreateRoutes, usePathParams, useQueryParams, useRouter };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neouter",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "author": "avaice <avaice@ymail.ne.jp>",
   "license": "ISC",
   "description": "A type-safe router for minimalists",