@react-foundry/react-router-context 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (C) 2019-2025 Crown Copyright
+Copyright (C) 2019-2026 Daniel A.C. Martin
+
+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/README.md

@@ -0,0 +1,63 @@
+React Foundry - React-Router-Context
+====================================
+
+A collection of React Router contexts for use in React Foundry applications.
+
+
+Using this package
+------------------
+
+First install the package into your project:
+
+```shell
+npm install -S @react-foundry/react-router-context
+```
+
+Then use it in your code as follows:
+
+```js
+import type { RouterContextProvider } from '@react-foundry/react-router-context'; // Replaces import from react-router
+import { userInfoContext, cspNonceContext } from '@react-foundry/react-router-context';
+
+export const loader = async ({ context: _context }: Route.LoaderArgs) => {
+  const context = _context as RouterContextProvider; // Needed to get extra properties recognised
+
+  const cspNonce = context.cspNonce;
+  const userInfo = context.userInfo;
+
+  // Alternatively...
+  const cspNonceAlt = context.get(cspNonceContext);
+  const userInfoAlt = context.get(userInfoContext);
+
+  // ...
+};
+```
+
+
+Working on this package
+-----------------------
+
+Before working on this package you must install its dependencies using
+the following command:
+
+```shell
+pnpm install
+```
+
+
+### Building
+
+Build the package by compiling the source code.
+
+```shell
+npm run build
+```
+
+
+### Clean-up
+
+Remove any previously built files.
+
+```shell
+npm run clean
+```

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import type { RouterContext, RouterContextProvider } from 'react-router';
+import type { Maybe, UserInfo } from '@react-foundry/types';
+export declare const userInfoContext: RouterContext<Maybe<UserInfo>>;
+export declare const cspNonceContext: RouterContext<Maybe<string>>;
+type Extras = {
+    cspNonce: string;
+    user: UserInfo;
+};
+export type EnhancedProvider = RouterContextProvider & Partial<Extras>;
+export declare const sanitiseUserInfo: <T extends UserInfo>({ displayName, emails, expiry, groups, name, photos, roles, username }: T) => UserInfo;
+export type { EnhancedProvider as RouterContextProvider };

package/dist/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitiseUserInfo = exports.cspNonceContext = exports.userInfoContext = void 0;
+exports.userInfoContext = 'USER_INFO';
+exports.cspNonceContext = 'CSP_NONCE';
+const sanitiseUserInfo = ({ displayName, emails, expiry, groups, name, photos, roles, username }) => ({
+    displayName,
+    emails,
+    expiry,
+    groups,
+    name,
+    photos,
+    roles,
+    username
+});
+exports.sanitiseUserInfo = sanitiseUserInfo;

package/dist/index.mjs

@@ -0,0 +1,12 @@
+export const userInfoContext = 'USER_INFO';
+export const cspNonceContext = 'CSP_NONCE';
+export const sanitiseUserInfo = ({ displayName, emails, expiry, groups, name, photos, roles, username }) => ({
+    displayName,
+    emails,
+    expiry,
+    groups,
+    name,
+    photos,
+    roles,
+    username
+});

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@react-foundry/react-router-context",
+  "version": "0.1.0",
+  "description": "A collection of React Router contexts for use in React Foundry applications.",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "/dist"
+  ],
+  "author": "Daniel A.C. Martin <npm@daniel-martin.co.uk> (http://daniel-martin.co.uk/)",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "jest": "30.2.0",
+    "jest-environment-jsdom": "30.2.0",
+    "react-router": "7.13.0",
+    "ts-jest": "29.4.6",
+    "typescript": "5.9.3",
+    "@react-foundry/types": "0.1.0"
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -m es2022 && find dist -name '*.js' -exec sh -c 'mv \"$0\" \"${0%.js}.mjs\"' {} \\;",
+    "build:cjs": "tsc",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo"
+  },
+  "module": "dist/index.mjs",
+  "typings": "dist/index.d.ts"
+}