@caseparts-org/casecore 0.0.2 → 0.0.3

package/README.md

@@ -1,69 +1,60 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-
-      // Remove tseslint.configs.recommended and replace with this
-      ...tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      ...tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      ...tseslint.configs.stylisticTypeChecked,
-
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
-```
-
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
-```
+# CaseCore React Component & Logic Library
+
+This project is a reusable logic and component library for React and Next.js applications, designed to house all core business logic for our front-end apps, decoupled from any specific UI. While it currently focuses on authentication, claims, and session management, it is intended to grow into a central place for all shared business logic, utilities, and core functionality needed across our projects.
+
+## Project Structure
+
+- **/lib/**
+  - Contains all code intended for export as part of the library.
+  - Includes authentication context/provider, hooks, utility functions, and type definitions.
+  - The main entry point for consumers is `lib/index.ts`.
+- **/src/App.tsx**
+  - Local demo/test app for development, not included in the library build.
+  - Useful for running and testing components locally with `npm run dev`.
+- **/public/**
+  - Static assets for local development/demo.
+- **/index.html**
+  - Entry point for local development with Vite.
+
+## Key Features
+
+- **Authentication Context (`AuthProvider`)**
+  - Provides authentication state, login/logout/impersonate methods, and claims to your app via React context.
+  - Handles JWT parsing, localStorage/sessionStorage, and API integration.
+- **Claims & Session Utilities**
+  - `buildClaimsFromPayload`: Normalizes JWT payloads into a consistent claims object.
+  - `getSessionId`: Manages session IDs in sessionStorage.
+  - `useLocalStorage`: React hook for persistent state with automatic key prefixing.
+- **TypeScript-first**
+  - All types and interfaces are defined in `lib/authentication/AuthTypes.ts` for strong typing and IDE support.
+- **Testing**
+  - Tests are colocated with their modules (e.g., `AuthContext.test.tsx`).
+  - Mocks for fetch and JWT decoding are used to simulate authentication flows.
+
+## Usage
+
+- **As a library:**
+  - Import from `lib/index.ts` in your consuming app:
+    ```ts
+    import { AuthProvider, useAuthContext } from 'casecore/lib';
+    ```
+- **For local development:**
+  - Run `npm run dev` to start the Vite dev server and use the demo app in `src/App.tsx`.
+- **To run tests locally:**
+  - Run `npm test` or `npx vitest run` to execute all tests.
+  - For watch mode (auto-re-run on file changes), use:
+    ```sh
+    npx vitest
+    ```
+  - Test files are colocated with their modules (e.g., `AuthContext.test.tsx`).
+
+## Contributing
+
+- Add new core logic, hooks, or components to `/lib`.
+- Add or update exports in `lib/index.ts`.
+- Use `/src` and `/public` for local-only demo/testing code.
+- Write and run tests for all exported logic.
+
+## License
+
+MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@caseparts-org/casecore",
   "private": false,
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,7 +29,8 @@
   "dependencies": {
     "jwt-decode": "^4.0.0",
     "react": "^18.0.0",
-    "react-dom": "^18.0.0"
+    "react-dom": "^18.0.0",
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.29.0",