@owlmeans/router 0.1.1

package/README.md

@@ -0,0 +1,24 @@
+# OwlMeans Package Template
+
+This is a template directory for creating new packages within the OwlMeans Common Libraries ecosystem.
+
+## Usage
+
+Copy this template directory when creating a new package:
+
+```bash
+cp -r packages/_tpl packages/your-new-package
+cd packages/your-new-package
+```
+
+Then update:
+- `package.json` - Change the package name and dependencies
+- `README.md` - Replace with proper documentation following OwlMeans standards
+- `src/index.ts` - Implement your package functionality
+
+## Template Structure
+
+- **package.json** - Base package configuration with common scripts and exports
+- **tsconfig.json** - TypeScript configuration aligned with OwlMeans standards  
+- **src/index.ts** - Entry point file
+- **README.md** - This template documentation (replace with actual docs)

package/build/consts.d.ts

@@ -0,0 +1,3 @@
+export declare const DEFAULT_ALIAS = "router-service";
+export declare const ROUTER_SERVICE = "router-service";
+//# sourceMappingURL=consts.d.ts.map

package/build/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,aAAa,mBAAmB,CAAA;AAE7C,eAAO,MAAM,cAAc,mBAAgB,CAAA"}

package/build/consts.js

@@ -0,0 +1,3 @@
+export const DEFAULT_ALIAS = 'router-service';
+export const ROUTER_SERVICE = DEFAULT_ALIAS;
+//# sourceMappingURL=consts.js.map

package/build/consts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.js","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,aAAa,GAAG,gBAAgB,CAAA;AAE7C,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAA"}

package/build/index.d.ts

@@ -0,0 +1,4 @@
+export type * from './types.js';
+export * from './consts.js';
+export * from './service.js';
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,mBAAmB,YAAY,CAAA;AAC/B,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA"}

package/build/index.js

@@ -0,0 +1,3 @@
+export * from './consts.js';
+export * from './service.js';
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA"}

package/build/service.d.ts

@@ -0,0 +1,3 @@
+import type { RouterService } from "./types";
+export declare const makeRouterService: (alias?: string) => RouterService;
+//# sourceMappingURL=service.d.ts.map

package/build/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C,eAAO,MAAM,iBAAiB,GAAI,QAAO,MAAsB,KAAG,aAwBjE,CAAA"}

package/build/service.js

@@ -0,0 +1,23 @@
+import { createService } from "@owlmeans/context";
+import { DEFAULT_ALIAS } from "./consts.js";
+export const makeRouterService = (alias = DEFAULT_ALIAS) => {
+    const service = createService(alias, {
+        outlet: () => {
+            throw new Error('Router Outlet is not implemented');
+        },
+        provider: () => {
+            throw new Error('Router Provider is not implemented');
+        },
+        useParams: () => {
+            throw new Error('Router useParams is not implemented');
+        },
+        useLocation: () => {
+            throw new Error('Router useLocation is not implemented');
+        },
+        useNavigate: () => {
+            throw new Error('Router useNavigate is not implemented');
+        }
+    });
+    return service;
+};
+//# sourceMappingURL=service.js.map

package/build/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAG3C,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,QAAgB,aAAa,EAAiB,EAAE;IAChF,MAAM,OAAO,GAAG,aAAa,CAAgB,KAAK,EAAE;QAClD,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QACrD,CAAC;QAED,QAAQ,EAAE,GAAG,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;QACvD,CAAC;QAED,SAAS,EAAE,GAAG,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,CAAC;QAED,WAAW,EAAE,GAAG,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC1D,CAAC;QAED,WAAW,EAAE,GAAG,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC1D,CAAC;KACF,CAAC,CAAA;IAEF,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA"}

package/build/types.d.ts

@@ -0,0 +1,44 @@
+import type { InitializedService } from "@owlmeans/context";
+export type { ComponentType } from 'react';
+export type LibraryRouter = unknown;
+export type RouteObject = unknown;
+export type RouterProvider = React.ComponentType<any>;
+export interface RouterService extends InitializedService {
+    outlet: () => React.ComponentType;
+    provider: () => RouterProvider;
+    useParams: UseParamsHook;
+    useLocation: UseLocationHook;
+    useNavigate: UseNavigateHook;
+}
+export type RouteParams = Record<string, string | undefined>;
+export interface UseParamsHook {
+    <T extends RouteParams = RouteParams>(): T;
+}
+export interface Path {
+    pathname: string;
+    search: string;
+    hash: string;
+}
+export interface Location<State = any> extends Path {
+    state: State;
+    key: string;
+}
+export interface UseLocationHook {
+    (): Location;
+}
+interface NavigateOptions {
+    replace?: boolean;
+    state?: any;
+    preventScrollReset?: boolean;
+    relative?: "route" | "path";
+    flushSync?: boolean;
+    viewTransition?: boolean;
+}
+export interface NavigateFunction {
+    (to: string | Partial<Path>, options?: NavigateOptions): void | Promise<void>;
+    (delta: number): void | Promise<void>;
+}
+export interface UseNavigateHook {
+    (): NavigateFunction;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,YAAY,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAE1C,MAAM,MAAM,aAAa,GAAG,OAAO,CAAA;AAEnC,MAAM,MAAM,WAAW,GAAG,OAAO,CAAA;AAEjC,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;AAErD,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACvD,MAAM,EAAE,MAAM,KAAK,CAAC,aAAa,CAAA;IACjC,QAAQ,EAAE,MAAM,cAAc,CAAA;IAC9B,SAAS,EAAE,aAAa,CAAA;IACxB,WAAW,EAAE,eAAe,CAAA;IAC5B,WAAW,EAAE,eAAe,CAAA;CAC7B;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;AAE5D,MAAM,WAAW,aAAa;IAC5B,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,KAAK,CAAC,CAAA;CAC3C;AAED,MAAM,WAAW,IAAI;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAE,SAAQ,IAAI;IACjD,KAAK,EAAE,KAAK,CAAA;IAEZ,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,QAAQ,CAAA;CACb;AAED,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7E,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACtC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,gBAAgB,CAAA;CACrB"}

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@owlmeans/router",
+  "version": "0.1.1",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "sleep 60 && nodemon -e ts,tsx,json --watch src --exec \"tsc -p ./tsconfig.json\"",
+    "watch": "tsc -b -w --preserveWatchOutput --pretty"
+  },
+  "main": "build/index.js",
+  "module": "build/index.js",
+  "types": "build/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/index.js",
+      "require": "./build/index.js",
+      "default": "./build/index.js",
+      "module": "./build/index.js",
+      "types": "./build/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@owlmeans/context": "^0.1.1"
+  },
+  "peerDependencies": {
+    "react": "*"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "@types/react": "^19.2.7",
+    "nodemon": "^3.1.11",
+    "typescript": "^5.8.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/consts.ts

@@ -0,0 +1,4 @@
+
+export const DEFAULT_ALIAS = 'router-service'
+
+export const ROUTER_SERVICE = DEFAULT_ALIAS

package/src/index.ts

@@ -0,0 +1,4 @@
+
+export type * from './types.js'
+export * from './consts.js'
+export * from './service.js'

package/src/service.ts

@@ -0,0 +1,29 @@
+import { createService } from "@owlmeans/context"
+import { DEFAULT_ALIAS } from "./consts.js"
+import type { RouterService } from "./types"
+
+export const makeRouterService = (alias: string = DEFAULT_ALIAS): RouterService => {
+  const service = createService<RouterService>(alias, {
+    outlet: () => {
+      throw new Error('Router Outlet is not implemented')
+    },
+
+    provider: () => {
+      throw new Error('Router Provider is not implemented')
+    },
+
+    useParams: () => {
+      throw new Error('Router useParams is not implemented')
+    },
+
+    useLocation: () => {
+      throw new Error('Router useLocation is not implemented')
+    },
+
+    useNavigate: () => {
+      throw new Error('Router useNavigate is not implemented')
+    }
+  })
+
+  return service
+}

package/src/types.ts

@@ -0,0 +1,56 @@
+import type { InitializedService } from "@owlmeans/context"
+export type { ComponentType } from 'react'
+
+export type LibraryRouter = unknown
+
+export type RouteObject = unknown
+
+export type RouterProvider = React.ComponentType<any>
+
+export interface RouterService extends InitializedService {
+  outlet: () => React.ComponentType
+  provider: () => RouterProvider
+  useParams: UseParamsHook
+  useLocation: UseLocationHook
+  useNavigate: UseNavigateHook
+}
+
+export type RouteParams = Record<string, string | undefined>
+
+export interface UseParamsHook {
+  <T extends RouteParams = RouteParams>(): T
+}
+
+export interface Path {
+  pathname: string
+  search: string
+  hash: string
+}
+
+export interface Location<State = any> extends Path {
+  state: State
+
+  key: string
+}
+
+export interface UseLocationHook {
+  (): Location
+}
+
+interface NavigateOptions {
+  replace?: boolean
+  state?: any
+  preventScrollReset?: boolean
+  relative?: "route" | "path"
+  flushSync?: boolean
+  viewTransition?: boolean
+}
+
+export interface NavigateFunction {
+  (to: string | Partial<Path>, options?: NavigateOptions): void | Promise<void>
+  (delta: number): void | Promise<void>
+}
+
+export interface UseNavigateHook {
+  (): NavigateFunction
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": [
+    "../tsconfig.default.json",
+    "../tsconfig.react.json",
+  ],
+  "compilerOptions": {
+    "rootDir": "./src/", /* Specify the root folder within your source files. */
+    "outDir": "./build/", /* Specify an output folder for all emitted files. */
+    "moduleResolution": "Bundler",
+  },
+  "exclude": [
+    "./dist/**/*",
+    "./build/**/*",
+    "./*.ts"
+  ]
+}