@page-component-object/router-react 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 David Vega
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import React, { ReactNode, ReactElement } from 'react';
+import { RouterHistory } from '@page-component-object/core';
+
+type HistoryCaptureProps = {
+    children: ReactNode;
+    onReady: (history: RouterHistory) => void;
+};
+/** Exposes a live `RouterHistory` to test AppManager after mount. */
+declare function HistoryCapture({ children, onReady }: HistoryCaptureProps): React.JSX.Element;
+type MemoryRouterProps = {
+    initialEntries?: string[];
+    initialIndex?: number;
+};
+type ShallowRouteOptions = {
+    routePath?: string;
+    wrapLayout?: (children: ReactElement) => ReactNode;
+};
+/** Builds the routed subtree for shallow view renders. */
+declare function buildShallowRouteTree(element: ReactElement, { routePath, wrapLayout }: ShallowRouteOptions): ReactElement;
+type RoutedShellProps = MemoryRouterProps & {
+    children: ReactNode;
+    onHistoryReady: (history: RouterHistory) => void;
+};
+declare function RoutedShell({ initialEntries, initialIndex, children, onHistoryReady, }: RoutedShellProps): React.JSX.Element;
+
+export { HistoryCapture, type HistoryCaptureProps, type MemoryRouterProps, RoutedShell, type RoutedShellProps, type ShallowRouteOptions, buildShallowRouteTree };

package/dist/index.js

@@ -0,0 +1,49 @@
+// src/index.tsx
+import React from "react";
+import {
+  MemoryRouter,
+  Route,
+  Routes,
+  useLocation,
+  useNavigate
+} from "react-router-dom";
+import { Fragment, jsx } from "react/jsx-runtime";
+function HistoryCapture({ children, onReady }) {
+  const navigate = useNavigate();
+  const location = useLocation();
+  React.useEffect(() => {
+    const routerHistory = {
+      get location() {
+        return {
+          pathname: location.pathname,
+          search: location.search,
+          hash: location.hash
+        };
+      },
+      push: (path) => {
+        void navigate(path);
+      }
+    };
+    onReady(routerHistory);
+  }, [navigate, location, onReady]);
+  return /* @__PURE__ */ jsx(Fragment, { children });
+}
+function buildShallowRouteTree(element, { routePath, wrapLayout }) {
+  if (!routePath) return element;
+  const content = wrapLayout ? wrapLayout(element) : element;
+  return /* @__PURE__ */ jsx(Routes, { children: /* @__PURE__ */ jsx(Route, { path: routePath, element: /* @__PURE__ */ jsx(Fragment, { children: content }) }) });
+}
+function RoutedShell({
+  initialEntries = ["/"],
+  initialIndex,
+  children,
+  onHistoryReady
+}) {
+  return /* @__PURE__ */ jsx(MemoryRouter, { initialEntries, initialIndex, children: /* @__PURE__ */ jsx(HistoryCapture, { onReady: onHistoryReady, children }) });
+}
+export {
+  HistoryCapture,
+  RoutedShell,
+  buildShallowRouteTree
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.tsx"],"sourcesContent":["import React, { type ReactElement, type ReactNode } from 'react';\r\n\r\nimport {\r\n  MemoryRouter,\r\n  Route,\r\n  Routes,\r\n  useLocation,\r\n  useNavigate,\r\n} from 'react-router-dom';\r\n\r\nimport type { RouterHistory } from '@page-component-object/core';\r\n\r\nexport type HistoryCaptureProps = {\r\n  children: ReactNode;\r\n  onReady: (history: RouterHistory) => void;\r\n};\r\n\r\n/** Exposes a live `RouterHistory` to test AppManager after mount. */\r\nexport function HistoryCapture({ children, onReady }: HistoryCaptureProps) {\r\n  const navigate = useNavigate();\r\n  const location = useLocation();\r\n\r\n  React.useEffect(() => {\r\n    const routerHistory: RouterHistory = {\r\n      get location() {\r\n        return {\r\n          pathname: location.pathname,\r\n          search: location.search,\r\n          hash: location.hash,\r\n        };\r\n      },\r\n      push: (path: string) => {\r\n        void navigate(path);\r\n      },\r\n    };\r\n    onReady(routerHistory);\r\n  }, [navigate, location, onReady]);\r\n\r\n  return <>{children}</>;\r\n}\r\n\r\nexport type MemoryRouterProps = {\r\n  initialEntries?: string[];\r\n  initialIndex?: number;\r\n};\r\n\r\nexport type ShallowRouteOptions = {\r\n  routePath?: string;\r\n  wrapLayout?: (children: ReactElement) => ReactNode;\r\n};\r\n\r\n/** Builds the routed subtree for shallow view renders. */\r\nexport function buildShallowRouteTree(\r\n  element: ReactElement,\r\n  { routePath, wrapLayout }: ShallowRouteOptions,\r\n): ReactElement {\r\n  if (!routePath) return element;\r\n\r\n  const content = wrapLayout ? wrapLayout(element) : element;\r\n  return (\r\n    <Routes>\r\n      <Route path={routePath} element={<>{content}</>} />\r\n    </Routes>\r\n  );\r\n}\r\n\r\nexport type RoutedShellProps = MemoryRouterProps & {\r\n  children: ReactNode;\r\n  onHistoryReady: (history: RouterHistory) => void;\r\n};\r\n\r\nexport function RoutedShell({\r\n  initialEntries = ['/'],\r\n  initialIndex,\r\n  children,\r\n  onHistoryReady,\r\n}: RoutedShellProps) {\r\n  return (\r\n    <MemoryRouter initialEntries={initialEntries} initialIndex={initialIndex}>\r\n      <HistoryCapture onReady={onHistoryReady}>{children}</HistoryCapture>\r\n    </MemoryRouter>\r\n  );\r\n}\r\n"],"mappings":";AAAA,OAAO,WAAkD;AAEzD;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AA8BE;AApBF,SAAS,eAAe,EAAE,UAAU,QAAQ,GAAwB;AACzE,QAAM,WAAW,YAAY;AAC7B,QAAM,WAAW,YAAY;AAE7B,QAAM,UAAU,MAAM;AACpB,UAAM,gBAA+B;AAAA,MACnC,IAAI,WAAW;AACb,eAAO;AAAA,UACL,UAAU,SAAS;AAAA,UACnB,QAAQ,SAAS;AAAA,UACjB,MAAM,SAAS;AAAA,QACjB;AAAA,MACF;AAAA,MACA,MAAM,CAAC,SAAiB;AACtB,aAAK,SAAS,IAAI;AAAA,MACpB;AAAA,IACF;AACA,YAAQ,aAAa;AAAA,EACvB,GAAG,CAAC,UAAU,UAAU,OAAO,CAAC;AAEhC,SAAO,gCAAG,UAAS;AACrB;AAaO,SAAS,sBACd,SACA,EAAE,WAAW,WAAW,GACV;AACd,MAAI,CAAC,UAAW,QAAO;AAEvB,QAAM,UAAU,aAAa,WAAW,OAAO,IAAI;AACnD,SACE,oBAAC,UACC,8BAAC,SAAM,MAAM,WAAW,SAAS,gCAAG,mBAAQ,GAAK,GACnD;AAEJ;AAOO,SAAS,YAAY;AAAA,EAC1B,iBAAiB,CAAC,GAAG;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AACF,GAAqB;AACnB,SACE,oBAAC,gBAAa,gBAAgC,cAC5C,8BAAC,kBAAe,SAAS,gBAAiB,UAAS,GACrD;AAEJ;","names":[]}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@page-component-object/router-react",
+  "version": "0.1.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@page-component-object/core": "0.1.0"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0",
+    "react-router-dom": "^6.4.0 || ^7.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.18",
+    "@types/react-dom": "^18.3.5",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router-dom": "^7.6.2",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dvegap95/page-component-test-object.git",
+    "directory": "packages/router-react"
+  },
+  "homepage": "https://github.com/dvegap95/page-component-test-object#readme",
+  "bugs": {
+    "url": "https://github.com/dvegap95/page-component-test-object/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist"
+  }
+}