@react-foundry/user-info 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,88 @@
+React Foundry - User Info
+=========================
+
+A React context (with hook) for providing information on the user.
+
+This is useful for:
+- referring to the user by name
+- letting them know that they are logged in
+- communicating to them what they are allowed to do on the system with
+  their current permissions / roles
+
+> **Note:** This is _NOT_ a security enforcing function; security should
+>           be enforced on the server-side in API endpoints and GraphQL
+>           resolvers.
+
+
+Using this package
+------------------
+
+First install the package into your project:
+
+```shell
+npm install -S @react-foundry/user-info
+```
+
+Then use it in your code as follows:
+
+```js
+import React, { createElement as h } from 'react';
+import { UserInfoContext, useUserInfo } from '@react-foundry/user-info';
+
+const dummyUserInfo = {
+  username: 'DummyUser',
+  groups: ['DummyGroup'],
+  roles: ['DummyRole']
+};
+
+export const MyConsumer = props => {
+  const { username } = useUserInfo();
+
+  return (
+    <p>Welcome {username}.</p>
+  );
+};
+
+export const MyComponent = props => (
+  <UserInfo.Provider value={dummyUserInfo}>
+    <MyConsumer />
+  </UserInfo.Provider>
+);
+
+export default MyComponent;
+```
+
+(Most users will only need to use the hook as the context has already
+been set up for them.)
+
+
+Working on this package
+-----------------------
+
+Before working on this package you must install its dependencies using
+the following command:
+
+```shell
+pnpm install
+```
+
+
+### Testing
+
+```shell
+npm test
+```
+
+
+### Building
+
+```shell
+npm run build
+```
+
+
+### Clean-up
+
+```shell
+npm run clean
+```

package/dist/UserInfo.d.ts

@@ -0,0 +1,6 @@
+import type { Maybe, UserInfo } from '@react-foundry/types';
+import { Context } from 'react';
+export declare const UserInfoContext: Context<Maybe<UserInfo>>;
+export declare const useUserInfo: () => Maybe<UserInfo>;
+export default UserInfoContext;
+export type { UserInfo };

package/dist/UserInfo.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useUserInfo = exports.UserInfoContext = void 0;
+const react_1 = require("react");
+exports.UserInfoContext = (0, react_1.createContext)(undefined);
+const useUserInfo = () => ((0, react_1.useContext)(exports.UserInfoContext));
+exports.useUserInfo = useUserInfo;
+exports.default = exports.UserInfoContext;

package/dist/UserInfo.mjs

@@ -0,0 +1,4 @@
+import { createContext, useContext } from 'react';
+export const UserInfoContext = createContext(undefined);
+export const useUserInfo = () => (useContext(UserInfoContext));
+export default UserInfoContext;

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@react-foundry/user-info",
+  "version": "0.1.0",
+  "description": "A React context for providing information on the user.",
+  "main": "dist/UserInfo.js",
+  "exports": {
+    ".": {
+      "types": "./dist/UserInfo.d.ts",
+      "import": "./dist/UserInfo.mjs",
+      "require": "./dist/UserInfo.js",
+      "default": "./dist/UserInfo.mjs"
+    }
+  },
+  "files": [
+    "/dist"
+  ],
+  "author": "Daniel A.C. Martin <npm@daniel-martin.co.uk> (http://daniel-martin.co.uk/)",
+  "license": "MIT",
+  "keywords": [
+    "react-components"
+  ],
+  "peerDependencies": {
+    "react": "^19.2.3"
+  },
+  "devDependencies": {
+    "@types/react": "19.2.9",
+    "jest": "30.2.0",
+    "jest-environment-jsdom": "30.2.0",
+    "ts-jest": "29.4.6",
+    "typescript": "5.9.3",
+    "@react-foundry/component-test-helpers": "0.1.0",
+    "@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/UserInfo.mjs",
+  "typings": "dist/UserInfo.d.ts"
+}