@fjell/express-router 4.4.55 → 4.4.57

package/dist/util/general.js

@@ -1,6 +1,6 @@
 const clean = (obj) => {
   return Object.fromEntries(
-    Object.entries(obj).filter(([_, v]) => v !== void 0)
+    Object.entries(obj).filter(([, v]) => v !== void 0)
   );
 };
 const stringifyJSON = function(obj, visited = /* @__PURE__ */ new Set()) {

package/dist/util/general.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/util/general.ts"],
-  "sourcesContent": ["\n/* eslint-disable no-undefined */\nexport const clean = (obj: any) => {\n  return Object.fromEntries(\n    Object.entries(obj).filter(([_, v]) => v !== undefined)\n  );\n}\n\n//Recursive implementation of jSON.stringify;\nexport const stringifyJSON = function (obj: any, visited: Set<any> = new Set()): string {\n  const arrOfKeyVals: string[] = [];\n  const arrVals: string[] = [];\n  let objKeys: string[] = [];\n\n  /*********CHECK FOR PRIMITIVE TYPES**********/\n  if (typeof obj === 'number' || typeof obj === 'boolean' || obj === null)\n    return '' + obj;\n  else if (typeof obj === 'string')\n    return '\"' + obj + '\"';\n\n  /*********DETECT CIRCULAR REFERENCES**********/\n  if (obj instanceof Object && visited.has(obj)) {\n    return '\"(circular)\"';\n  }\n\n  /*********CHECK FOR ARRAY**********/\n  else if (Array.isArray(obj)) {\n    //check for empty array\n    if (obj[0] === undefined)\n      return '[]';\n    else {\n      // Add array to visited before processing its elements\n      visited.add(obj);\n      obj.forEach(function (el) {\n        arrVals.push(stringifyJSON(el, visited));\n      });\n      // Remove array from visited after processing to prevent memory leaks\n      visited.delete(obj);\n      return '[' + arrVals + ']';\n    }\n  }\n  /*********CHECK FOR OBJECT**********/\n  else if (obj instanceof Object) {\n    // Add object to visited before processing its properties\n    visited.add(obj);\n    //get object keys\n    objKeys = Object.keys(obj);\n    //set key output;\n    objKeys.forEach(function (key) {\n      const keyOut = '\"' + key + '\":';\n      const keyValOut = obj[key];\n      //skip functions and undefined properties\n      if (keyValOut instanceof Function || keyValOut === undefined)\n        return; // Skip this entry entirely instead of pushing an empty string\n      else if (typeof keyValOut === 'string')\n        arrOfKeyVals.push(keyOut + '\"' + keyValOut + '\"');\n      else if (typeof keyValOut === 'boolean' || typeof keyValOut === 'number' || keyValOut === null)\n        arrOfKeyVals.push(keyOut + keyValOut);\n      //check for nested objects, call recursively until no more objects\n      else if (keyValOut instanceof Object) {\n        arrOfKeyVals.push(keyOut + stringifyJSON(keyValOut, visited));\n      }\n    });\n    // Remove object from visited after processing to prevent memory leaks\n    visited.delete(obj);\n    return '{' + arrOfKeyVals + '}';\n  }\n  return '';\n};\n"],
-  "mappings": "AAEO,MAAM,QAAQ,CAAC,QAAa;AACjC,SAAO,OAAO;AAAA,IACZ,OAAO,QAAQ,GAAG,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,MAAM,MAAS;AAAA,EACxD;AACF;AAGO,MAAM,gBAAgB,SAAU,KAAU,UAAoB,oBAAI,IAAI,GAAW;AACtF,QAAM,eAAyB,CAAC;AAChC,QAAM,UAAoB,CAAC;AAC3B,MAAI,UAAoB,CAAC;AAGzB,MAAI,OAAO,QAAQ,YAAY,OAAO,QAAQ,aAAa,QAAQ;AACjE,WAAO,KAAK;AAAA,WACL,OAAO,QAAQ;AACtB,WAAO,MAAM,MAAM;AAGrB,MAAI,eAAe,UAAU,QAAQ,IAAI,GAAG,GAAG;AAC7C,WAAO;AAAA,EACT,WAGS,MAAM,QAAQ,GAAG,GAAG;AAE3B,QAAI,IAAI,CAAC,MAAM;AACb,aAAO;AAAA,SACJ;AAEH,cAAQ,IAAI,GAAG;AACf,UAAI,QAAQ,SAAU,IAAI;AACxB,gBAAQ,KAAK,cAAc,IAAI,OAAO,CAAC;AAAA,MACzC,CAAC;AAED,cAAQ,OAAO,GAAG;AAClB,aAAO,MAAM,UAAU;AAAA,IACzB;AAAA,EACF,WAES,eAAe,QAAQ;AAE9B,YAAQ,IAAI,GAAG;AAEf,cAAU,OAAO,KAAK,GAAG;AAEzB,YAAQ,QAAQ,SAAU,KAAK;AAC7B,YAAM,SAAS,MAAM,MAAM;AAC3B,YAAM,YAAY,IAAI,GAAG;AAEzB,UAAI,qBAAqB,YAAY,cAAc;AACjD;AAAA,eACO,OAAO,cAAc;AAC5B,qBAAa,KAAK,SAAS,MAAM,YAAY,GAAG;AAAA,eACzC,OAAO,cAAc,aAAa,OAAO,cAAc,YAAY,cAAc;AACxF,qBAAa,KAAK,SAAS,SAAS;AAAA,eAE7B,qBAAqB,QAAQ;AACpC,qBAAa,KAAK,SAAS,cAAc,WAAW,OAAO,CAAC;AAAA,MAC9D;AAAA,IACF,CAAC;AAED,YAAQ,OAAO,GAAG;AAClB,WAAO,MAAM,eAAe;AAAA,EAC9B;AACA,SAAO;AACT;",
+  "sourcesContent": ["\n/* eslint-disable no-undefined */\nexport const clean = (obj: any) => {\n  return Object.fromEntries(\n    Object.entries(obj).filter(([, v]) => v !== undefined)\n  );\n}\n\n//Recursive implementation of jSON.stringify;\nexport const stringifyJSON = function (obj: any, visited: Set<any> = new Set()): string {\n  const arrOfKeyVals: string[] = [];\n  const arrVals: string[] = [];\n  let objKeys: string[] = [];\n\n  /*********CHECK FOR PRIMITIVE TYPES**********/\n  if (typeof obj === 'number' || typeof obj === 'boolean' || obj === null)\n    return '' + obj;\n  else if (typeof obj === 'string')\n    return '\"' + obj + '\"';\n\n  /*********DETECT CIRCULAR REFERENCES**********/\n  if (obj instanceof Object && visited.has(obj)) {\n    return '\"(circular)\"';\n  }\n\n  /*********CHECK FOR ARRAY**********/\n  else if (Array.isArray(obj)) {\n    //check for empty array\n    if (obj[0] === undefined)\n      return '[]';\n    else {\n      // Add array to visited before processing its elements\n      visited.add(obj);\n      obj.forEach(function (el) {\n        arrVals.push(stringifyJSON(el, visited));\n      });\n      // Remove array from visited after processing to prevent memory leaks\n      visited.delete(obj);\n      return '[' + arrVals + ']';\n    }\n  }\n  /*********CHECK FOR OBJECT**********/\n  else if (obj instanceof Object) {\n    // Add object to visited before processing its properties\n    visited.add(obj);\n    //get object keys\n    objKeys = Object.keys(obj);\n    //set key output;\n    objKeys.forEach(function (key) {\n      const keyOut = '\"' + key + '\":';\n      const keyValOut = obj[key];\n      //skip functions and undefined properties\n      if (keyValOut instanceof Function || keyValOut === undefined)\n        return; // Skip this entry entirely instead of pushing an empty string\n      else if (typeof keyValOut === 'string')\n        arrOfKeyVals.push(keyOut + '\"' + keyValOut + '\"');\n      else if (typeof keyValOut === 'boolean' || typeof keyValOut === 'number' || keyValOut === null)\n        arrOfKeyVals.push(keyOut + keyValOut);\n      //check for nested objects, call recursively until no more objects\n      else if (keyValOut instanceof Object) {\n        arrOfKeyVals.push(keyOut + stringifyJSON(keyValOut, visited));\n      }\n    });\n    // Remove object from visited after processing to prevent memory leaks\n    visited.delete(obj);\n    return '{' + arrOfKeyVals + '}';\n  }\n  return '';\n};\n"],
+  "mappings": "AAEO,MAAM,QAAQ,CAAC,QAAa;AACjC,SAAO,OAAO;AAAA,IACZ,OAAO,QAAQ,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,MAAM,MAAM,MAAS;AAAA,EACvD;AACF;AAGO,MAAM,gBAAgB,SAAU,KAAU,UAAoB,oBAAI,IAAI,GAAW;AACtF,QAAM,eAAyB,CAAC;AAChC,QAAM,UAAoB,CAAC;AAC3B,MAAI,UAAoB,CAAC;AAGzB,MAAI,OAAO,QAAQ,YAAY,OAAO,QAAQ,aAAa,QAAQ;AACjE,WAAO,KAAK;AAAA,WACL,OAAO,QAAQ;AACtB,WAAO,MAAM,MAAM;AAGrB,MAAI,eAAe,UAAU,QAAQ,IAAI,GAAG,GAAG;AAC7C,WAAO;AAAA,EACT,WAGS,MAAM,QAAQ,GAAG,GAAG;AAE3B,QAAI,IAAI,CAAC,MAAM;AACb,aAAO;AAAA,SACJ;AAEH,cAAQ,IAAI,GAAG;AACf,UAAI,QAAQ,SAAU,IAAI;AACxB,gBAAQ,KAAK,cAAc,IAAI,OAAO,CAAC;AAAA,MACzC,CAAC;AAED,cAAQ,OAAO,GAAG;AAClB,aAAO,MAAM,UAAU;AAAA,IACzB;AAAA,EACF,WAES,eAAe,QAAQ;AAE9B,YAAQ,IAAI,GAAG;AAEf,cAAU,OAAO,KAAK,GAAG;AAEzB,YAAQ,QAAQ,SAAU,KAAK;AAC7B,YAAM,SAAS,MAAM,MAAM;AAC3B,YAAM,YAAY,IAAI,GAAG;AAEzB,UAAI,qBAAqB,YAAY,cAAc;AACjD;AAAA,eACO,OAAO,cAAc;AAC5B,qBAAa,KAAK,SAAS,MAAM,YAAY,GAAG;AAAA,eACzC,OAAO,cAAc,aAAa,OAAO,cAAc,YAAY,cAAc;AACxF,qBAAa,KAAK,SAAS,SAAS;AAAA,eAE7B,qBAAqB,QAAQ;AACpC,qBAAa,KAAK,SAAS,cAAc,WAAW,OAAO,CAAC;AAAA,MAC9D;AAAA,IACF,CAAC;AAED,YAAQ,OAAO,GAAG;AAClB,WAAO,MAAM,eAAe;AAAA,EAC9B;AACA,SAAO;AACT;",
   "names": []
 }

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@fjell/express-router",
-  "version": "4.4.55",
-  "license": "Apache-2.0",
+  "description": "Express Router for Fjell",
+  "version": "4.4.57",
   "keywords": [
     "express",
     "router",
     "fjell"
   ],
-  "description": "Express Router for Fjell",
+  "license": "Apache-2.0",
   "engines": {
     "node": ">=21"
   },
-  "main": "dist/index.js",
-  "module": "dist/index.js",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     }
   },
-  "type": "module",
   "scripts": {
     "build": "npm run clean && node build.js",
     "dev": "nodemon --watch src --ext ts --exec 'npm run build'",
@@ -34,17 +34,17 @@
     "docs:test": "cd docs && npm run test"
   },
   "dependencies": {
-    "@fjell/core": "^4.4.49",
-    "@fjell/lib": "^4.4.57",
-    "@fjell/logging": "^4.4.49",
-    "@fjell/registry": "^4.4.51",
+    "@fjell/core": "^4.4.51",
+    "@fjell/lib": "^4.4.59",
+    "@fjell/logging": "^4.4.50",
+    "@fjell/registry": "^4.4.53",
     "deepmerge": "^4.3.1",
     "express": "^5.1.0"
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.33.0",
-    "@fjell/eslint-config": "^1.1.25",
+    "@fjell/eslint-config": "^1.1.28",
     "@tsconfig/recommended": "^1.0.10",
     "@types/express": "^5.0.3",
     "@types/node": "^24.2.1",

package/MIGRATION_v3.md

@@ -1,255 +0,0 @@
-# Migration Guide: v2.x to v3.0
-
-## Overview
-
-Version 3.0 of `@fjell/express-router` adopts the standardized Operations interface from `@fjell/core`. This provides a unified interface across all Fjell packages and enables better type safety and cross-package compatibility.
-
-## Breaking Changes
-
-### Operations Interface
-
-The router now works directly with the `Operations` interface from `@fjell/core`, which is implemented by `@fjell/lib`, `@fjell/cache`, and other Fjell packages.
-
-**Good News**: This is a non-breaking change for most users since `@fjell/lib` already implements the core Operations interface.
-
-## What You Need to Do
-
-### Step 1: Update Dependencies
-
-Update to the latest versions of Fjell packages:
-
-```bash
-npm install @fjell/core@latest @fjell/lib@latest @fjell/express-router@latest
-```
-
-### Step 2: Verify Your Code (Usually No Changes Needed)
-
-Your existing code should continue to work without modifications:
-
-```typescript
-// This continues to work in v3.0
-import { PItemRouter, CItemRouter } from '@fjell/express-router';
-import { createLibrary } from '@fjell/lib';
-import { createRegistry } from '@fjell/registry';
-
-const registry = createRegistry();
-const library = createLibrary(
-  registry,
-  { keyType: 'user' },
-  userOperations,
-  userOptions
-);
-
-const userRouter = new PItemRouter(library, 'user');
-app.use('/api/users', userRouter.getRouter());
-```
-
-### Step 3: Optional - Use Type Imports from Core
-
-You can now import types directly from `@fjell/core` if needed:
-
-```typescript
-import { Operations, OperationParams, AffectedKeys } from '@fjell/core';
-import type { Item } from '@fjell/core';
-
-// Your Operations implementation
-const myOperations: Operations<Item<'user'>, 'user'> = {
-  // ... implementation
-};
-```
-
-## Benefits of v3.0
-
-### 1. Unified Interface
-
-Works with any package that implements `@fjell/core` Operations:
-
-```typescript
-import { PItemRouter } from '@fjell/express-router';
-import { createLibrary } from '@fjell/lib';
-import { createCache } from '@fjell/cache';
-
-// Works with @fjell/lib
-const library = createLibrary(registry, { keyType: 'user' }, ops, opts);
-const libRouter = new PItemRouter(library, 'user');
-
-// Works with @fjell/cache
-const cache = createCache(library);
-const cacheRouter = new PItemRouter(cache as any, 'user');
-```
-
-### 2. Better Type Safety
-
-Enhanced TypeScript support with explicit method types from core:
-
-```typescript
-import type { GetMethod, CreateMethod } from '@fjell/core';
-
-// Core types are available for advanced use cases
-const getHandler: GetMethod<User, 'user'> = async (key) => {
-  // Handler implementation
-};
-```
-
-### 3. Consistent API
-
-Same routing behavior across all Operations implementations:
-
-- `GET /items` → `operations.all()`
-- `GET /items/:id` → `operations.get(key)`
-- `POST /items` → `operations.create(item)`
-- `PUT /items/:id` → `operations.update(key, item)`
-- `DELETE /items/:id` → `operations.remove(key)`
-- `POST /items/:id/action` → `operations.action(key, action, params)`
-- `GET /items/:id/facet` → `operations.facet(key, facet, params)`
-- `POST /items/action` → `operations.allAction(action, params)`
-- `GET /items/facet` → `operations.allFacet(facet, params)`
-
-### 4. Cross-Package Compatibility
-
-Works seamlessly with all Fjell packages:
-
-- `@fjell/lib` - Server-side operations
-- `@fjell/cache` - Caching layer
-- `@fjell/client-api` - HTTP client
-- `@fjell/providers` - React UI components
-
-## What Hasn't Changed
-
-- Router creation API remains the same
-- Route configuration is identical
-- Router-level handlers work as before
-- Middleware integration unchanged
-- Error handling unchanged
-- All existing options and configurations continue to work
-
-## Examples
-
-### Basic Router (No Changes Required)
-
-```typescript
-import express from 'express';
-import { PItemRouter } from '@fjell/express-router';
-import { createLibrary } from '@fjell/lib';
-import { createRegistry } from '@fjell/registry';
-
-const app = express();
-const registry = createRegistry();
-
-// Create library
-const userLibrary = createLibrary(
-  registry,
-  { keyType: 'user' },
-  userOperations,
-  userOptions
-);
-
-// Create router (same as v2.x)
-const userRouter = new PItemRouter(userLibrary, 'user');
-app.use('/api/users', userRouter.getRouter());
-
-app.listen(3000);
-```
-
-### Nested Routers (No Changes Required)
-
-```typescript
-// Parent router
-const organizationRouter = new PItemRouter(orgLibrary, 'organization');
-
-// Child router
-const departmentRouter = new CItemRouter(
-  deptLibrary,
-  'department',
-  organizationRouter
-);
-
-// Mount routers (same as v2.x)
-app.use('/api/organizations', organizationRouter.getRouter());
-app.use(
-  '/api/organizations/:organizationPk/departments',
-  departmentRouter.getRouter()
-);
-```
-
-### Router-Level Handlers (No Changes Required)
-
-```typescript
-const userRouter = new PItemRouter(userLibrary, 'user', {
-  actions: {
-    activate: async (ik, params, { req, res }) => {
-      // Handler implementation (same as v2.x)
-      const user = await userLibrary.operations.get(ik);
-      await activateUser(user);
-      res.json({ success: true });
-    }
-  },
-  facets: {
-    profile: async (ik, params, { req, res }) => {
-      // Handler implementation (same as v2.x)
-      const user = await userLibrary.operations.get(ik);
-      const profile = await getProfile(user);
-      res.json(profile);
-    }
-  }
-});
-```
-
-## Troubleshooting
-
-### Type Errors
-
-If you encounter type errors after upgrading:
-
-1. Ensure all Fjell packages are updated to their latest versions
-2. Check that `@fjell/core` is installed
-3. Clear your TypeScript cache: `rm -rf node_modules/.cache`
-4. Rebuild: `npm run build`
-
-### Import Errors
-
-If you have import errors:
-
-```typescript
-// If this fails:
-import type { Operations } from '@fjell/express-router';
-
-// Use this instead:
-import type { Operations } from '@fjell/core';
-// or
-import type { Operations } from '@fjell/lib';
-```
-
-### Runtime Errors
-
-If your Operations object doesn't work with the router:
-
-1. Verify it implements all required methods from `@fjell/core` Operations
-2. Check that method signatures match the core interface
-3. Ensure return types are correct (e.g., `action` and `allAction` return `[result, affectedKeys]`)
-
-## Migration Checklist
-
-- [ ] Update `@fjell/core` to latest version
-- [ ] Update `@fjell/lib` to latest version  
-- [ ] Update `@fjell/express-router` to v3.0+
-- [ ] Update other Fjell packages to latest versions
-- [ ] Run `npm install`
-- [ ] Run tests: `npm test`
-- [ ] Run build: `npm run build`
-- [ ] Verify application starts correctly
-- [ ] Test API endpoints work as expected
-
-## Need Help?
-
-- **Documentation**: [README.md](./README.md)
-- **Examples**: [examples/](./examples/)
-- **Issues**: [GitHub Issues](https://github.com/getfjell/express-router/issues)
-- **Discussions**: [GitHub Discussions](https://github.com/getfjell/express-router/discussions)
-
-## Summary
-
-Version 3.0 is a **seamless upgrade** for most users. The router now uses the standardized Operations interface from `@fjell/core`, providing better type safety and cross-package compatibility, but your existing code should continue to work without modifications.
-
-Simply update your dependencies and you're ready to go! 🎉
-

package/build.js

@@ -1,4 +0,0 @@
-import buildMultiFile from '@fjell/eslint-config/esbuild/multi-file';
-
-// Multi-file compilation - compiles each TypeScript file separately
-buildMultiFile();

package/docs/docs.config.ts

@@ -1,44 +0,0 @@
-import { DocsConfig } from '@fjell/docs-template';
-
-const config: DocsConfig = {
-  projectName: 'Fjell Express Router',
-  basePath: '/express-router/',
-  port: 3004,
-  branding: {
-    theme: 'express-router',
-    tagline: 'Express Router for Fjell',
-    backgroundImage: '/pano.png',
-    github: 'https://github.com/getfjell/express-router',
-    npm: 'https://www.npmjs.com/package/@fjell/express-router'
-  },
-  sections: [
-    {
-      id: 'overview',
-      title: 'Getting Started',
-      subtitle: 'Express Router for Fjell',
-      file: '/README.md'
-    },
-    {
-      id: 'examples',
-      title: 'Examples',
-      subtitle: 'Code examples & usage patterns',
-      file: '/examples-README.md'
-    }
-  ],
-  filesToCopy: [
-    {
-      source: '../README.md',
-      destination: 'public/README.md'
-    },
-    {
-      source: '../examples/README.md',
-      destination: 'public/examples-README.md'
-    }
-  ],
-  plugins: [],
-  version: {
-    source: 'package.json'
-  }
-}
-
-export default config

package/docs/index.html

@@ -1,18 +0,0 @@
-<!doctype html>
-<html lang="en">
-
-<head>
-  <meta charset="UTF-8" />
-  <link rel="icon" type="image/svg+xml" href="/fjell-icon.svg" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Fjell Express Router - Express Router for Fjell</title>
-  <meta name="description"
-    content="Express Router for Fjell - A powerful Express.js router integration for the Fjell framework">
-</head>
-
-<body>
-  <div id="root"></div>
-  <script type="module" src="/src/main.tsx"></script>
-</body>
-
-</html>

package/docs/package.json

@@ -1,34 +0,0 @@
-{
-  "name": "fjell-express-router-docs",
-  "private": true,
-  "version": "0.0.0",
-  "type": "module",
-  "scripts": {
-    "copy-docs": "node node_modules/@fjell/docs-template/dist/scripts/copy-docs.js",
-    "dev": "npm run copy-docs && vite",
-    "build": "npm run copy-docs && vite build",
-    "preview": "vite preview",
-    "test": "vitest run --coverage",
-    "test:watch": "vitest --watch"
-  },
-  "dependencies": {
-    "@fjell/docs-template": "^1.0.24",
-    "react": "^19.1.0",
-    "react-dom": "^19.1.0"
-  },
-  "devDependencies": {
-    "@testing-library/jest-dom": "^6.6.3",
-    "@testing-library/react": "^16.3.0",
-    "@testing-library/user-event": "^14.6.1",
-    "@types/react": "^19.1.8",
-    "@types/react-dom": "^19.1.6",
-    "@types/react-syntax-highlighter": "^15.5.13",
-    "@vitejs/plugin-react": "^4.6.0",
-    "@vitest/coverage-v8": "^3.2.4",
-    "@vitest/ui": "^3.2.4",
-    "jsdom": "^26.1.0",
-    "typescript": "^5.8.3",
-    "vite": "^7.0.0",
-    "vitest": "^3.2.4"
-  }
-}