@fjell/express-router 4.4.12 → 4.4.18

package/README.md

@@ -0,0 +1,332 @@
+# Fjell Express Router
+
+**Express Router for Fjell** - Automatic REST API generation with hierarchical data management for Express.js applications.
+
+Fjell Express Router provides a powerful abstraction layer for creating Express.js REST APIs that automatically handle CRUD operations for complex, hierarchical data models. Built on the Fjell framework, it enables rapid development of enterprise-grade APIs with built-in support for nested resources, business logic integration, and type-safe operations.
+
+## Features
+
+- **Automatic CRUD Routes**: Generate complete REST endpoints with minimal configuration
+- **Hierarchical Data Support**: Handle complex nested relationships with parent-child routing
+- **Type-Safe Operations**: Full TypeScript support with generic type constraints
+- **Flexible Business Logic**: Easy integration of custom business rules and validations
+- **Express.js Integration**: Seamless mounting as Express middleware with full compatibility
+- **Built-in Error Handling**: Comprehensive error responses with proper HTTP status codes
+- **Extensible Architecture**: Support for custom actions, facets, and middleware
+
+## Installation
+
+```bash
+npm install @fjell/express-router
+```
+
+Or with pnpm:
+
+```bash
+pnpm add @fjell/express-router
+```
+
+## Quick Start
+
+```typescript
+import { PItemRouter, createRegistry } from '@fjell/express-router';
+import { Item } from '@fjell/core';
+import express from 'express';
+
+// Define your data model
+interface User extends Item<'user'> {
+  id: string;
+  name: string;
+  email: string;
+  role: 'admin' | 'user' | 'guest';
+}
+
+// Create Express app and registry
+const app = express();
+const registry = createRegistry();
+
+// Create instance and router
+const userInstance = registry.getInstance(
+  'user',
+  userOperations, // Your business logic implementation
+  userOptions     // Configuration options
+);
+
+const userRouter = new PItemRouter(userInstance, 'user');
+
+// Mount router - automatically creates CRUD endpoints
+app.use('/api/users', userRouter.getRouter());
+
+// Start server
+app.listen(3000, () => {
+  console.log('Server running on http://localhost:3000');
+});
+```
+
+This automatically creates the following endpoints:
+
+- `GET /api/users` - List all users
+- `GET /api/users/:userPk` - Get specific user
+- `POST /api/users` - Create new user
+- `PUT /api/users/:userPk` - Update user
+- `DELETE /api/users/:userPk` - Delete user
+
+## Core Concepts
+
+### Router Types
+
+**PItemRouter** - For primary entities that exist independently:
+```typescript
+const userRouter = new PItemRouter(userInstance, 'user');
+const productRouter = new PItemRouter(productInstance, 'product');
+```
+
+**CItemRouter** - For child entities that belong to parent entities:
+```typescript
+const orderRouter = new PItemRouter(orderInstance, 'order');
+const orderItemRouter = new CItemRouter(orderItemInstance, 'orderItem', orderRouter);
+```
+
+### Hierarchical Routing
+
+Create nested routes for complex relationships:
+
+```typescript
+// Organization -> Department -> Employee hierarchy
+const orgRouter = new PItemRouter(orgInstance, 'organization');
+const deptRouter = new CItemRouter(deptInstance, 'department', orgRouter);
+const empRouter = new CItemRouter(empInstance, 'employee', deptRouter);
+
+// Mount hierarchical routes
+app.use('/api/organizations', orgRouter.getRouter());
+app.use('/api/organizations/:organizationPk/departments', deptRouter.getRouter());
+app.use('/api/organizations/:organizationPk/departments/:departmentPk/employees', empRouter.getRouter());
+```
+
+This creates endpoints like:
+- `GET /api/organizations/org-1/departments/dept-1/employees`
+- `POST /api/organizations/org-1/departments/dept-1/employees`
+- `GET /api/organizations/org-1/departments/dept-1/employees/emp-1`
+
+## Advanced Usage
+
+### Custom Business Logic
+
+Add custom routes alongside automatic CRUD operations:
+
+```typescript
+const router = userRouter.getRouter();
+
+// Add custom business logic routes
+router.get('/analytics', async (req, res) => {
+  const analytics = await userInstance.operations.getAnalytics();
+  res.json(analytics);
+});
+
+router.post('/:userPk/activate', async (req, res) => {
+  const userPk = req.params.userPk;
+  const user = await userInstance.operations.activate(userPk);
+  res.json(user);
+});
+
+app.use('/api/users', router);
+```
+
+### Middleware Integration
+
+Add Express middleware for authentication, validation, and more:
+
+```typescript
+import { authenticate, authorize, validateRequest } from './middleware';
+
+// Global middleware
+app.use(express.json());
+app.use(authenticate);
+
+// Router-specific middleware
+const protectedRouter = userRouter.getRouter();
+protectedRouter.use(authorize(['admin', 'user']));
+protectedRouter.use('/sensitive-endpoint', validateRequest);
+
+app.use('/api/users', protectedRouter);
+```
+
+### Error Handling
+
+Built-in error handling with proper HTTP status codes:
+
+```typescript
+// Automatic error responses for common scenarios:
+// 404 - Entity not found
+// 400 - Invalid request data
+// 500 - Internal server errors
+
+// Custom error handling
+app.use((err, req, res, next) => {
+  console.error('API Error:', err);
+  res.status(err.status || 500).json({
+    error: err.message || 'Internal Server Error',
+    ...(process.env.NODE_ENV === 'development' && { stack: err.stack })
+  });
+});
+```
+
+## Data Model Requirements
+
+Your data models must extend the Fjell `Item` interface:
+
+```typescript
+import { Item, UUID } from '@fjell/core';
+
+interface User extends Item<'user'> {
+  id: string;
+  name: string;
+  email: string;
+  // ... other properties
+}
+
+interface Order extends Item<'order'> {
+  id: string;
+  customerId: string;
+  total: number;
+  // ... other properties
+}
+
+interface OrderItem extends Item<'orderItem', 'order'> {
+  id: string;
+  productId: string;
+  quantity: number;
+  price: number;
+  // ... other properties
+}
+```
+
+## Configuration
+
+Configure your instances with business operations and options:
+
+```typescript
+const userInstance = registry.getInstance(
+  'user',
+  {
+    // Business operations implementation
+    create: async (item) => { /* create logic */ },
+    get: async (pk) => { /* get logic */ },
+    update: async (pk, updates) => { /* update logic */ },
+    delete: async (pk) => { /* delete logic */ },
+    list: async (query) => { /* list logic */ },
+    // ... other operations
+  },
+  {
+    // Configuration options
+    allowedMethods: ['GET', 'POST', 'PUT', 'DELETE'],
+    validation: { /* validation rules */ },
+    facets: { /* custom facets */ },
+    actions: { /* custom actions */ },
+    // ... other options
+  }
+);
+```
+
+## Examples
+
+This package includes comprehensive examples in the `examples/` directory:
+
+- **`basic-router-example.ts`** - Start here for fundamental usage patterns
+- **`nested-router-example.ts`** - Hierarchical data management with organizations/departments/employees
+- **`full-application-example.ts`** - Production-ready e-commerce application
+
+Run examples:
+
+```bash
+# Basic example
+npx tsx examples/basic-router-example.ts
+
+# Nested routing example
+npx tsx examples/nested-router-example.ts
+
+# Full application example
+npx tsx examples/full-application-example.ts
+```
+
+## API Reference
+
+### PItemRouter<T, S>
+
+Primary item router for top-level entities.
+
+**Constructor**
+```typescript
+new PItemRouter<T, S>(instance: Instance<T, S>, keyType: S, options?: ItemRouterOptions)
+```
+
+**Methods**
+- `getRouter(): Router` - Get Express router instance
+- `getPkType(): S` - Get primary key type
+- `createItem(req, res)` - Handle POST requests
+- `getItem(req, res)` - Handle GET requests for single items
+- `updateItem(req, res)` - Handle PUT requests
+- `deleteItem(req, res)` - Handle DELETE requests
+
+### CItemRouter<T, S, L1, ...>
+
+Child item router for nested entities.
+
+**Constructor**
+```typescript
+new CItemRouter<T, S, L1>(
+  instance: Instance<T, S, L1>,
+  keyType: S,
+  parentRouter: ItemRouter<L1>,
+  options?: ItemRouterOptions
+)
+```
+
+Inherits all methods from `ItemRouter` with additional parent-child relationship handling.
+
+### createRegistry()
+
+Factory function to create a new registry instance for managing multiple routers.
+
+```typescript
+const registry = createRegistry();
+const instance = registry.getInstance(keyType, operations, options);
+```
+
+## Requirements
+
+- Node.js >= 21
+- TypeScript >= 5.0
+- Express.js >= 5.0
+
+## Dependencies
+
+- `@fjell/core` - Core Fjell framework types and utilities
+- `@fjell/lib` - Fjell library components
+- `@fjell/logging` - Structured logging for Fjell applications
+- `@fjell/registry` - Registry management for Fjell instances
+- `express` - Express.js web framework
+- `deepmerge` - Deep object merging utility
+
+## Contributing
+
+Contributions are welcome! Please read our contributing guidelines and submit pull requests to our repository.
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes with tests
+4. Ensure all tests pass
+5. Submit a pull request
+
+## License
+
+Licensed under the Apache License 2.0. See the LICENSE file for details.
+
+## Support
+
+- **Documentation**: [Full documentation and guides](./docs/)
+- **Examples**: [Comprehensive examples](./examples/)
+- **Issues**: [GitHub Issues](https://github.com/getfjell/express-router/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/getfjell/express-router/discussions)
+
+Built with care by the Fjell team.

package/build.js

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

package/dist/CItemRouter.d.ts

@@ -1,7 +1,7 @@
-import { ComKey, Item, LocKeyArray } from '@fjell/core';
-import { Request, Response } from 'express';
-import { ItemRouter, ItemRouterOptions } from './ItemRouter';
-import { Instance } from './Instance';
+import { ComKey, Item, LocKeyArray } from "@fjell/core";
+import { Request, Response } from "express";
+import { ItemRouter, ItemRouterOptions } from "@/ItemRouter";
+import { Instance } from "./Instance";
 export declare class CItemRouter<T extends Item<S, L1, L2, L3, L4, L5>, S extends string, L1 extends string, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> extends ItemRouter<S, L1, L2, L3, L4, L5> {
     private parentRoute;
     constructor(lib: Instance<T, S, L1, L2, L3, L4, L5>, type: S, parentRoute: ItemRouter<L1, L2, L3, L4, L5, never>, options?: ItemRouterOptions);
@@ -12,3 +12,4 @@ export declare class CItemRouter<T extends Item<S, L1, L2, L3, L4, L5>, S extend
     protected createItem: (req: Request, res: Response) => Promise<void>;
     protected findItems: (req: Request, res: Response) => Promise<void>;
 }
+//# sourceMappingURL=CItemRouter.d.ts.map

package/dist/CItemRouter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CItemRouter.d.ts","sourceRoot":"","sources":["../src/CItemRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EAAE,IAAI,EAAqB,WAAW,EAC7C,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAMtC,qBAAa,WAAW,CACtB,CAAC,SAAS,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EACrC,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,MAAM,EACjB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,CACzB,SAAQ,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IAEzC,OAAO,CAAC,WAAW,CAAwC;gBAGzD,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EACvC,IAAI,EAAE,CAAC,EACP,WAAW,EAAE,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,EAClD,OAAO,GAAE,iBAAsB;IAM1B,SAAS,IAAI,OAAO;IAIpB,KAAK,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IAMnD,MAAM,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IAWrD,YAAY,CAAC,GAAG,EAAE,QAAQ,GAAG,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IAInE,SAAS,CAAC,UAAU,GAAU,KAAK,OAAO,EAAE,KAAK,QAAQ,mBASvD;IAEF,SAAS,CAAC,SAAS,GAAU,KAAK,OAAO,EAAE,KAAK,QAAQ,mBA4BtD;CAEH"}

package/dist/CItemRouter.js

@@ -1,96 +1,67 @@
-import { validatePK, paramsToQuery } from '@fjell/core';
-import { ItemRouter } from './ItemRouter.js';
-
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
+import {
+  paramsToQuery,
+  validatePK
+} from "@fjell/core";
+import { ItemRouter } from "@/ItemRouter";
 class CItemRouter extends ItemRouter {
-    hasParent() {
-        return !!this.parentRoute;
-    }
-    getIk(res) {
-        const pri = this.getPk(res);
-        const loc = this.getLocations(res);
-        return {
-            kt: pri.kt,
-            pk: pri.pk,
-            loc
-        };
-    }
-    getLKA(res) {
-        /**
-     * A location key array is passed to a child router to provide contextfor the items it will
-     * be working with.  It is always a concatenation of "My LKA" + "Parent LKA" which will
-     * bubble all the way up to the root Primary.
-     */ let lka = [
-            this.getLk(res)
-        ];
-        lka = lka.concat(this.parentRoute.getLKA(res));
-        return lka;
-    }
-    getLocations(res) {
-        return this.parentRoute.getLKA(res);
-    }
-    constructor(lib, type, parentRoute, options = {}){
-        super(lib, type, options), _define_property(this, "parentRoute", void 0), _define_property(this, "createItem", async (req, res)=>{
-            const libOperations = this.lib.operations;
-            this.logger.default('Creating Item', {
-                body: req === null || req === void 0 ? void 0 : req.body,
-                query: req === null || req === void 0 ? void 0 : req.query,
-                params: req === null || req === void 0 ? void 0 : req.params,
-                locals: res === null || res === void 0 ? void 0 : res.locals
-            });
-            const itemToCreate = this.convertDates(req.body);
-            let item = validatePK(await libOperations.create(itemToCreate, {
-                locations: this.getLocations(res)
-            }), this.getPkType());
-            item = await this.postCreateItem(item);
-            this.logger.default('Created Item %j', item);
-            res.json(item);
-        }), _define_property(this, "findItems", async (req, res)=>{
-            const libOperations = this.lib.operations;
-            const query = req.query;
-            const finder = query['finder'];
-            const finderParams = query['finderParams'];
-            const one = query['one'];
-            let items = [];
-            if (finder) {
-                // If finder is defined?  Call a finder.
-                this.logger.default('Finding Items with Finder', {
-                    finder,
-                    finderParams,
-                    one
-                });
-                if (one === 'true') {
-                    const item = await this.lib.findOne(finder, JSON.parse(finderParams), this.getLocations(res));
-                    items = item ? [
-                        item
-                    ] : [];
-                } else {
-                    items = await libOperations.find(finder, JSON.parse(finderParams), this.getLocations(res));
-                }
-            } else {
-                // TODO: This is once of the more important places to perform some validaation and feedback
-                const itemQuery = paramsToQuery(req.query);
-                this.logger.default('Finding Items with Query: %j', itemQuery);
-                items = await libOperations.all(itemQuery, this.getLocations(res));
-                this.logger.default('Found %d Items with Query', items.length);
-            }
-            res.json(items.map((item)=>validatePK(item, this.getPkType())));
-        });
-        this.parentRoute = parentRoute;
+  parentRoute;
+  constructor(lib, type, parentRoute, options = {}) {
+    super(lib, type, options);
+    this.parentRoute = parentRoute;
+  }
+  hasParent() {
+    return !!this.parentRoute;
+  }
+  getIk(res) {
+    const pri = this.getPk(res);
+    const loc = this.getLocations(res);
+    return { kt: pri.kt, pk: pri.pk, loc };
+  }
+  getLKA(res) {
+    let lka = [this.getLk(res)];
+    lka = lka.concat(this.parentRoute.getLKA(res));
+    return lka;
+  }
+  getLocations(res) {
+    return this.parentRoute.getLKA(res);
+  }
+  createItem = async (req, res) => {
+    const libOperations = this.lib.operations;
+    this.logger.default("Creating Item", { body: req?.body, query: req?.query, params: req?.params, locals: res?.locals });
+    const itemToCreate = this.convertDates(req.body);
+    let item = validatePK(await libOperations.create(
+      itemToCreate,
+      { locations: this.getLocations(res) }
+    ), this.getPkType());
+    item = await this.postCreateItem(item);
+    this.logger.default("Created Item %j", item);
+    res.json(item);
+  };
+  findItems = async (req, res) => {
+    const libOperations = this.lib.operations;
+    const query = req.query;
+    const finder = query["finder"];
+    const finderParams = query["finderParams"];
+    const one = query["one"];
+    let items = [];
+    if (finder) {
+      this.logger.default("Finding Items with Finder", { finder, finderParams, one });
+      if (one === "true") {
+        const item = await this.lib.findOne(finder, JSON.parse(finderParams), this.getLocations(res));
+        items = item ? [item] : [];
+      } else {
+        items = await libOperations.find(finder, JSON.parse(finderParams), this.getLocations(res));
+      }
+    } else {
+      const itemQuery = paramsToQuery(req.query);
+      this.logger.default("Finding Items with Query: %j", itemQuery);
+      items = await libOperations.all(itemQuery, this.getLocations(res));
+      this.logger.default("Found %d Items with Query", items.length);
     }
+    res.json(items.map((item) => validatePK(item, this.getPkType())));
+  };
 }
-
-export { CItemRouter };
+export {
+  CItemRouter
+};
 //# sourceMappingURL=CItemRouter.js.map

package/dist/CItemRouter.js.map

@@ -1 +1,7 @@
-{"version":3,"file":"CItemRouter.js","sources":["../src/CItemRouter.ts"],"sourcesContent":["import {\n  ComKey, Item, ItemQuery, LocKey, LocKeyArray, paramsToQuery, PriKey, QueryParams, validatePK\n} from \"@fjell/core\";\nimport { Request, Response } from \"express\";\nimport { ItemRouter, ItemRouterOptions } from \"@/ItemRouter\";\nimport { Instance } from \"./Instance\";\n\ninterface ParsedQuery {\n  [key: string]: undefined | string | string[] | ParsedQuery | ParsedQuery[];\n}\n\nexport class CItemRouter<\n  T extends Item<S, L1, L2, L3, L4, L5>,\n  S extends string,\n  L1 extends string,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n> extends ItemRouter<S, L1, L2, L3, L4, L5> {\n\n  private parentRoute: ItemRouter<L1, L2, L3, L4, L5, never>;\n\n  constructor(\n    lib: Instance<T, S, L1, L2, L3, L4, L5>,\n    type: S,\n    parentRoute: ItemRouter<L1, L2, L3, L4, L5, never>,\n    options: ItemRouterOptions = {},\n  ) {\n    super(lib as any, type, options);\n    this.parentRoute = parentRoute;\n  }\n\n  public hasParent(): boolean {\n    return !!this.parentRoute;\n  }\n\n  public getIk(res: Response): ComKey<S, L1, L2, L3, L4, L5> {\n    const pri = this.getPk(res) as PriKey<S>;\n    const loc = this.getLocations(res) as LocKeyArray<L1, L2, L3, L4, L5>;\n    return { kt: pri.kt, pk: pri.pk, loc }\n  }\n\n  public getLKA(res: Response): LocKeyArray<S, L1, L2, L3, L4> {\n    /**\n     * A location key array is passed to a child router to provide contextfor the items it will\n     * be working with.  It is always a concatenation of \"My LKA\" + \"Parent LKA\" which will\n     * bubble all the way up to the root Primary.\n     */\n    let lka: LocKey<S | L1 | L2 | L3 | L4>[] = [this.getLk(res)];\n    lka = lka.concat(this.parentRoute.getLKA(res) as LocKey<S | L1 | L2 | L3 | L4>[]);\n    return lka as LocKeyArray<S, L1, L2, L3, L4>;\n  }\n\n  public getLocations(res: Response): LocKeyArray<L1, L2, L3, L4, L5> {\n    return this.parentRoute.getLKA(res) as LocKeyArray<L1, L2, L3, L4, L5>;\n  }\n\n  protected createItem = async (req: Request, res: Response) => {\n    const libOperations = this.lib.operations;\n    this.logger.default('Creating Item', { body: req?.body, query: req?.query, params: req?.params, locals: res?.locals });\n    const itemToCreate = this.convertDates(req.body as Item<S, L1, L2, L3, L4, L5>);\n    let item = validatePK(await libOperations.create(\n      itemToCreate, { locations: this.getLocations(res) }), this.getPkType()) as Item<S, L1, L2, L3, L4, L5>;\n    item = await this.postCreateItem(item);\n    this.logger.default('Created Item %j', item);\n    res.json(item);\n  };\n\n  protected findItems = async (req: Request, res: Response) => {\n    const libOperations = this.lib.operations;\n    const query: ParsedQuery = req.query as unknown as ParsedQuery;\n    const finder = query['finder'] as string;\n    const finderParams = query['finderParams'] as string;\n    const one = query['one'] as string;\n\n    let items: Item<S, L1, L2, L3, L4, L5>[] = [];\n\n    if (finder) {\n      // If finder is defined?  Call a finder.\n      this.logger.default('Finding Items with Finder', { finder, finderParams, one });\n\n      if (one === 'true') {\n        const item = await (this.lib as any).findOne(finder, JSON.parse(finderParams), this.getLocations(res));\n        items = item ? [item] : [];\n      } else {\n        items = await libOperations.find(finder, JSON.parse(finderParams), this.getLocations(res));\n      }\n    } else {\n      // TODO: This is once of the more important places to perform some validaation and feedback\n      const itemQuery: ItemQuery = paramsToQuery(req.query as QueryParams);\n      this.logger.default('Finding Items with Query: %j', itemQuery);\n      items = await libOperations.all(itemQuery, this.getLocations(res));\n      this.logger.default('Found %d Items with Query', items.length);\n    }\n\n    res.json(items.map((item: Item<S, L1, L2, L3, L4, L5>) => validatePK(item, this.getPkType())));\n  };\n\n}\n"],"names":["CItemRouter","ItemRouter","hasParent","parentRoute","getIk","res","pri","getPk","loc","getLocations","kt","pk","getLKA","lka","getLk","concat","lib","type","options","createItem","req","libOperations","operations","logger","default","body","query","params","locals","itemToCreate","convertDates","item","validatePK","create","locations","getPkType","postCreateItem","json","findItems","finder","finderParams","one","items","findOne","JSON","parse","find","itemQuery","paramsToQuery","all","length","map"],"mappings":";;;;;;;;;;;;;;;;AAWO,MAAMA,WAAAA,SAQHC,UAAAA,CAAAA;IAcDC,SAAAA,GAAqB;AAC1B,QAAA,OAAO,CAAC,CAAC,IAAI,CAACC,WAAW;AAC3B,IAAA;AAEOC,IAAAA,KAAAA,CAAMC,GAAa,EAAiC;AACzD,QAAA,MAAMC,GAAAA,GAAM,IAAI,CAACC,KAAK,CAACF,GAAAA,CAAAA;AACvB,QAAA,MAAMG,GAAAA,GAAM,IAAI,CAACC,YAAY,CAACJ,GAAAA,CAAAA;QAC9B,OAAO;AAAEK,YAAAA,EAAAA,EAAIJ,IAAII,EAAE;AAAEC,YAAAA,EAAAA,EAAIL,IAAIK,EAAE;AAAEH,YAAAA;AAAI,SAAA;AACvC,IAAA;AAEOI,IAAAA,MAAAA,CAAOP,GAAa,EAAkC;AAC3D;;;;AAIC,QACD,IAAIQ,GAAAA,GAAuC;YAAC,IAAI,CAACC,KAAK,CAACT,GAAAA;AAAK,SAAA;QAC5DQ,GAAAA,GAAMA,GAAAA,CAAIE,MAAM,CAAC,IAAI,CAACZ,WAAW,CAACS,MAAM,CAACP,GAAAA,CAAAA,CAAAA;QACzC,OAAOQ,GAAAA;AACT,IAAA;AAEOJ,IAAAA,YAAAA,CAAaJ,GAAa,EAAmC;AAClE,QAAA,OAAO,IAAI,CAACF,WAAW,CAACS,MAAM,CAACP,GAAAA,CAAAA;AACjC,IAAA;IAjCA,WAAA,CACEW,GAAuC,EACvCC,IAAO,EACPd,WAAkD,EAClDe,OAAAA,GAA6B,EAAE,CAC/B;QACA,KAAK,CAACF,GAAAA,EAAYC,IAAAA,EAAMC,OAAAA,CAAAA,EAR1B,gBAAA,CAAA,IAAA,EAAQf,aAAAA,EAAR,MAAA,CAAA,EAqCA,gBAAA,CAAA,IAAA,EAAUgB,YAAAA,EAAa,OAAOC,GAAAA,EAAcf,GAAAA,GAAAA;AAC1C,YAAA,MAAMgB,aAAAA,GAAgB,IAAI,CAACL,GAAG,CAACM,UAAU;AACzC,YAAA,IAAI,CAACC,MAAM,CAACC,OAAO,CAAC,eAAA,EAAiB;AAAEC,gBAAAA,IAAI,EAAEL,GAAAA,KAAAA,IAAAA,IAAAA,GAAAA,KAAAA,MAAAA,GAAAA,MAAAA,GAAAA,GAAAA,CAAKK,IAAI;AAAEC,gBAAAA,KAAK,EAAEN,GAAAA,KAAAA,IAAAA,IAAAA,GAAAA,KAAAA,MAAAA,GAAAA,MAAAA,GAAAA,GAAAA,CAAKM,KAAK;AAAEC,gBAAAA,MAAM,EAAEP,GAAAA,KAAAA,IAAAA,IAAAA,GAAAA,KAAAA,MAAAA,GAAAA,MAAAA,GAAAA,GAAAA,CAAKO,MAAM;AAAEC,gBAAAA,MAAM,EAAEvB,GAAAA,KAAAA,IAAAA,IAAAA,GAAAA,KAAAA,MAAAA,GAAAA,MAAAA,GAAAA,GAAAA,CAAKuB;AAAO,aAAA,CAAA;AACpH,YAAA,MAAMC,eAAe,IAAI,CAACC,YAAY,CAACV,IAAIK,IAAI,CAAA;AAC/C,YAAA,IAAIM,OAAOC,UAAAA,CAAW,MAAMX,aAAAA,CAAcY,MAAM,CAC9CJ,YAAAA,EAAc;gBAAEK,SAAAA,EAAW,IAAI,CAACzB,YAAY,CAACJ,GAAAA;aAAK,CAAA,EAAI,IAAI,CAAC8B,SAAS,EAAA,CAAA;AACtEJ,YAAAA,IAAAA,GAAO,MAAM,IAAI,CAACK,cAAc,CAACL,IAAAA,CAAAA;AACjC,YAAA,IAAI,CAACR,MAAM,CAACC,OAAO,CAAC,iBAAA,EAAmBO,IAAAA,CAAAA;AACvC1B,YAAAA,GAAAA,CAAIgC,IAAI,CAACN,IAAAA,CAAAA;QACX,CAAA,CAAA,EAEA,gBAAA,CAAA,IAAA,EAAUO,WAAAA,EAAY,OAAOlB,GAAAA,EAAcf,GAAAA,GAAAA;AACzC,YAAA,MAAMgB,aAAAA,GAAgB,IAAI,CAACL,GAAG,CAACM,UAAU;YACzC,MAAMI,KAAAA,GAAqBN,IAAIM,KAAK;YACpC,MAAMa,MAAAA,GAASb,KAAK,CAAC,QAAA,CAAS;YAC9B,MAAMc,YAAAA,GAAed,KAAK,CAAC,cAAA,CAAe;YAC1C,MAAMe,GAAAA,GAAMf,KAAK,CAAC,KAAA,CAAM;AAExB,YAAA,IAAIgB,QAAuC,EAAE;AAE7C,YAAA,IAAIH,MAAAA,EAAQ;;AAEV,gBAAA,IAAI,CAAChB,MAAM,CAACC,OAAO,CAAC,2BAAA,EAA6B;AAAEe,oBAAAA,MAAAA;AAAQC,oBAAAA,YAAAA;AAAcC,oBAAAA;AAAI,iBAAA,CAAA;AAE7E,gBAAA,IAAIA,QAAQ,MAAA,EAAQ;AAClB,oBAAA,MAAMV,OAAO,MAAO,IAAI,CAACf,GAAG,CAAS2B,OAAO,CAACJ,MAAAA,EAAQK,KAAKC,KAAK,CAACL,eAAe,IAAI,CAAC/B,YAAY,CAACJ,GAAAA,CAAAA,CAAAA;AACjGqC,oBAAAA,KAAAA,GAAQX,IAAAA,GAAO;AAACA,wBAAAA;AAAK,qBAAA,GAAG,EAAE;gBAC5B,CAAA,MAAO;AACLW,oBAAAA,KAAAA,GAAQ,MAAMrB,aAAAA,CAAcyB,IAAI,CAACP,MAAAA,EAAQK,IAAAA,CAAKC,KAAK,CAACL,YAAAA,CAAAA,EAAe,IAAI,CAAC/B,YAAY,CAACJ,GAAAA,CAAAA,CAAAA;AACvF,gBAAA;YACF,CAAA,MAAO;;gBAEL,MAAM0C,SAAAA,GAAuBC,aAAAA,CAAc5B,GAAAA,CAAIM,KAAK,CAAA;AACpD,gBAAA,IAAI,CAACH,MAAM,CAACC,OAAO,CAAC,8BAAA,EAAgCuB,SAAAA,CAAAA;gBACpDL,KAAAA,GAAQ,MAAMrB,cAAc4B,GAAG,CAACF,WAAW,IAAI,CAACtC,YAAY,CAACJ,GAAAA,CAAAA,CAAAA;AAC7D,gBAAA,IAAI,CAACkB,MAAM,CAACC,OAAO,CAAC,2BAAA,EAA6BkB,MAAMQ,MAAM,CAAA;AAC/D,YAAA;YAEA7C,GAAAA,CAAIgC,IAAI,CAACK,KAAAA,CAAMS,GAAG,CAAC,CAACpB,IAAAA,GAAsCC,UAAAA,CAAWD,IAAAA,EAAM,IAAI,CAACI,SAAS,EAAA,CAAA,CAAA,CAAA;AAC3F,QAAA,CAAA,CAAA;QAnEE,IAAI,CAAChC,WAAW,GAAGA,WAAAA;AACrB,IAAA;AAoEF;;;;"}
+{
+  "version": 3,
+  "sources": ["../src/CItemRouter.ts"],
+  "sourcesContent": ["import {\n  ComKey, Item, ItemQuery, LocKey, LocKeyArray, paramsToQuery, PriKey, QueryParams, validatePK\n} from \"@fjell/core\";\nimport { Request, Response } from \"express\";\nimport { ItemRouter, ItemRouterOptions } from \"@/ItemRouter\";\nimport { Instance } from \"./Instance\";\n\ninterface ParsedQuery {\n  [key: string]: undefined | string | string[] | ParsedQuery | ParsedQuery[];\n}\n\nexport class CItemRouter<\n  T extends Item<S, L1, L2, L3, L4, L5>,\n  S extends string,\n  L1 extends string,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n> extends ItemRouter<S, L1, L2, L3, L4, L5> {\n\n  private parentRoute: ItemRouter<L1, L2, L3, L4, L5, never>;\n\n  constructor(\n    lib: Instance<T, S, L1, L2, L3, L4, L5>,\n    type: S,\n    parentRoute: ItemRouter<L1, L2, L3, L4, L5, never>,\n    options: ItemRouterOptions = {},\n  ) {\n    super(lib as any, type, options);\n    this.parentRoute = parentRoute;\n  }\n\n  public hasParent(): boolean {\n    return !!this.parentRoute;\n  }\n\n  public getIk(res: Response): ComKey<S, L1, L2, L3, L4, L5> {\n    const pri = this.getPk(res) as PriKey<S>;\n    const loc = this.getLocations(res) as LocKeyArray<L1, L2, L3, L4, L5>;\n    return { kt: pri.kt, pk: pri.pk, loc }\n  }\n\n  public getLKA(res: Response): LocKeyArray<S, L1, L2, L3, L4> {\n    /**\n     * A location key array is passed to a child router to provide contextfor the items it will\n     * be working with.  It is always a concatenation of \"My LKA\" + \"Parent LKA\" which will\n     * bubble all the way up to the root Primary.\n     */\n    let lka: LocKey<S | L1 | L2 | L3 | L4>[] = [this.getLk(res)];\n    lka = lka.concat(this.parentRoute.getLKA(res) as LocKey<S | L1 | L2 | L3 | L4>[]);\n    return lka as LocKeyArray<S, L1, L2, L3, L4>;\n  }\n\n  public getLocations(res: Response): LocKeyArray<L1, L2, L3, L4, L5> {\n    return this.parentRoute.getLKA(res) as LocKeyArray<L1, L2, L3, L4, L5>;\n  }\n\n  protected createItem = async (req: Request, res: Response) => {\n    const libOperations = this.lib.operations;\n    this.logger.default('Creating Item', { body: req?.body, query: req?.query, params: req?.params, locals: res?.locals });\n    const itemToCreate = this.convertDates(req.body as Item<S, L1, L2, L3, L4, L5>);\n    let item = validatePK(await libOperations.create(\n      itemToCreate, { locations: this.getLocations(res) }), this.getPkType()) as Item<S, L1, L2, L3, L4, L5>;\n    item = await this.postCreateItem(item);\n    this.logger.default('Created Item %j', item);\n    res.json(item);\n  };\n\n  protected findItems = async (req: Request, res: Response) => {\n    const libOperations = this.lib.operations;\n    const query: ParsedQuery = req.query as unknown as ParsedQuery;\n    const finder = query['finder'] as string;\n    const finderParams = query['finderParams'] as string;\n    const one = query['one'] as string;\n\n    let items: Item<S, L1, L2, L3, L4, L5>[] = [];\n\n    if (finder) {\n      // If finder is defined?  Call a finder.\n      this.logger.default('Finding Items with Finder', { finder, finderParams, one });\n\n      if (one === 'true') {\n        const item = await (this.lib as any).findOne(finder, JSON.parse(finderParams), this.getLocations(res));\n        items = item ? [item] : [];\n      } else {\n        items = await libOperations.find(finder, JSON.parse(finderParams), this.getLocations(res));\n      }\n    } else {\n      // TODO: This is once of the more important places to perform some validaation and feedback\n      const itemQuery: ItemQuery = paramsToQuery(req.query as QueryParams);\n      this.logger.default('Finding Items with Query: %j', itemQuery);\n      items = await libOperations.all(itemQuery, this.getLocations(res));\n      this.logger.default('Found %d Items with Query', items.length);\n    }\n\n    res.json(items.map((item: Item<S, L1, L2, L3, L4, L5>) => validatePK(item, this.getPkType())));\n  };\n\n}\n"],
+  "mappings": "AAAA;AAAA,EACgD;AAAA,EAAoC;AAAA,OAC7E;AAEP,SAAS,kBAAqC;AAOvC,MAAM,oBAQH,WAAkC;AAAA,EAElC;AAAA,EAER,YACE,KACA,MACA,aACA,UAA6B,CAAC,GAC9B;AACA,UAAM,KAAY,MAAM,OAAO;AAC/B,SAAK,cAAc;AAAA,EACrB;AAAA,EAEO,YAAqB;AAC1B,WAAO,CAAC,CAAC,KAAK;AAAA,EAChB;AAAA,EAEO,MAAM,KAA8C;AACzD,UAAM,MAAM,KAAK,MAAM,GAAG;AAC1B,UAAM,MAAM,KAAK,aAAa,GAAG;AACjC,WAAO,EAAE,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI;AAAA,EACvC;AAAA,EAEO,OAAO,KAA+C;AAM3D,QAAI,MAAuC,CAAC,KAAK,MAAM,GAAG,CAAC;AAC3D,UAAM,IAAI,OAAO,KAAK,YAAY,OAAO,GAAG,CAAoC;AAChF,WAAO;AAAA,EACT;AAAA,EAEO,aAAa,KAAgD;AAClE,WAAO,KAAK,YAAY,OAAO,GAAG;AAAA,EACpC;AAAA,EAEU,aAAa,OAAO,KAAc,QAAkB;AAC5D,UAAM,gBAAgB,KAAK,IAAI;AAC/B,SAAK,OAAO,QAAQ,iBAAiB,EAAE,MAAM,KAAK,MAAM,OAAO,KAAK,OAAO,QAAQ,KAAK,QAAQ,QAAQ,KAAK,OAAO,CAAC;AACrH,UAAM,eAAe,KAAK,aAAa,IAAI,IAAmC;AAC9E,QAAI,OAAO,WAAW,MAAM,cAAc;AAAA,MACxC;AAAA,MAAc,EAAE,WAAW,KAAK,aAAa,GAAG,EAAE;AAAA,IAAC,GAAG,KAAK,UAAU,CAAC;AACxE,WAAO,MAAM,KAAK,eAAe,IAAI;AACrC,SAAK,OAAO,QAAQ,mBAAmB,IAAI;AAC3C,QAAI,KAAK,IAAI;AAAA,EACf;AAAA,EAEU,YAAY,OAAO,KAAc,QAAkB;AAC3D,UAAM,gBAAgB,KAAK,IAAI;AAC/B,UAAM,QAAqB,IAAI;AAC/B,UAAM,SAAS,MAAM,QAAQ;AAC7B,UAAM,eAAe,MAAM,cAAc;AACzC,UAAM,MAAM,MAAM,KAAK;AAEvB,QAAI,QAAuC,CAAC;AAE5C,QAAI,QAAQ;AAEV,WAAK,OAAO,QAAQ,6BAA6B,EAAE,QAAQ,cAAc,IAAI,CAAC;AAE9E,UAAI,QAAQ,QAAQ;AAClB,cAAM,OAAO,MAAO,KAAK,IAAY,QAAQ,QAAQ,KAAK,MAAM,YAAY,GAAG,KAAK,aAAa,GAAG,CAAC;AACrG,gBAAQ,OAAO,CAAC,IAAI,IAAI,CAAC;AAAA,MAC3B,OAAO;AACL,gBAAQ,MAAM,cAAc,KAAK,QAAQ,KAAK,MAAM,YAAY,GAAG,KAAK,aAAa,GAAG,CAAC;AAAA,MAC3F;AAAA,IACF,OAAO;AAEL,YAAM,YAAuB,cAAc,IAAI,KAAoB;AACnE,WAAK,OAAO,QAAQ,gCAAgC,SAAS;AAC7D,cAAQ,MAAM,cAAc,IAAI,WAAW,KAAK,aAAa,GAAG,CAAC;AACjE,WAAK,OAAO,QAAQ,6BAA6B,MAAM,MAAM;AAAA,IAC/D;AAEA,QAAI,KAAK,MAAM,IAAI,CAAC,SAAsC,WAAW,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC;AAAA,EAC/F;AAEF;",
+  "names": []
+}

package/dist/Instance.d.ts

@@ -1,7 +1,7 @@
-import { Item } from '@fjell/core';
-import { Instance as BaseInstance, Coordinate, Registry } from '@fjell/registry';
-import { Operations, Options } from '@fjell/lib';
-import { ItemRouter } from './ItemRouter';
+import { Item } from "@fjell/core";
+import { Instance as BaseInstance, Coordinate, Registry } from "@fjell/registry";
+import { Operations, Options } from "@fjell/lib";
+import { ItemRouter } from "./ItemRouter";
 /**
  * The Express Router Instance interface represents a router model instance that extends the base Instance
  * from @fjell/registry and adds express router operations for handling HTTP requests.
@@ -27,3 +27,4 @@ export interface Instance<V extends Item<S, L1, L2, L3, L4, L5>, S extends strin
 }
 export declare const createInstance: <V extends Item<S, L1, L2, L3, L4, L5>, S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never>(registry: Registry, coordinate: Coordinate<S, L1, L2, L3, L4, L5>, router: ItemRouter<S, L1, L2, L3, L4, L5>, operations: Operations<V, S, L1, L2, L3, L4, L5>, options?: Options<V, S, L1, L2, L3, L4, L5>) => Instance<V, S, L1, L2, L3, L4, L5>;
 export declare const isInstance: (instance: any) => instance is Instance<any, any, any, any, any, any, any>;
+//# sourceMappingURL=Instance.d.ts.map

package/dist/Instance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Instance.d.ts","sourceRoot":"","sources":["../src/Instance.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EAAE,QAAQ,IAAI,YAAY,EAAE,UAAU,EAAwC,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACvH,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,QAAQ,CACvB,CAAC,SAAS,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EACrC,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,CACzB,SAAQ,YAAY,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IAC3C,yEAAyE;IACzE,MAAM,EAAE,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC1C,sFAAsF;IACtF,UAAU,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACjD,uFAAuF;IACvF,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3C,iDAAiD;IACjD,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;CACvB;AAED,eAAO,MAAM,cAAc,GACzB,CAAC,SAAS,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EACrC,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,EACzB,EAAE,SAAS,MAAM,GAAG,KAAK,EAEvB,UAAU,QAAQ,EAClB,YAAY,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAC7C,QAAQ,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EACzC,YAAY,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAChD,UAAU,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,KAC1C,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAIrC,CAAA;AAED,eAAO,MAAM,UAAU,GAAI,UAAU,GAAG,KAAG,QAAQ,IAAI,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAQhG,CAAA"}

package/dist/Instance.js

@@ -1,26 +1,16 @@
-import LibLogger from './logger.js';
-import { createInstance as createInstance$1 } from '@fjell/registry';
-
+import LibLogger from "./logger";
+import { createInstance as createBaseInstance } from "@fjell/registry";
 const logger = LibLogger.get("Instance");
-const createInstance = (registry, coordinate, router, operations, options)=>{
-    logger.debug("createInstance", {
-        coordinate,
-        router,
-        registry,
-        operations,
-        options
-    });
-    const baseInstance = createInstance$1(registry, coordinate);
-    return {
-        ...baseInstance,
-        router,
-        operations,
-        options: options || {}
-    };
+const createInstance = (registry, coordinate, router, operations, options) => {
+  logger.debug("createInstance", { coordinate, router, registry, operations, options });
+  const baseInstance = createBaseInstance(registry, coordinate);
+  return { ...baseInstance, router, operations, options: options || {} };
 };
-const isInstance = (instance)=>{
-    return instance != null && typeof instance === 'object' && instance.coordinate != null && instance.router != null && instance.registry != null && instance.operations != null && instance.options != null;
+const isInstance = (instance) => {
+  return instance != null && typeof instance === "object" && instance.coordinate != null && instance.router != null && instance.registry != null && instance.operations != null && instance.options != null;
+};
+export {
+  createInstance,
+  isInstance
 };
-
-export { createInstance, isInstance };
 //# sourceMappingURL=Instance.js.map

package/dist/Instance.js.map

@@ -1 +1,7 @@
-{"version":3,"file":"Instance.js","sources":["../src/Instance.ts"],"sourcesContent":["import LibLogger from \"./logger\";\nimport { Item } from \"@fjell/core\";\nimport { Instance as BaseInstance, Coordinate, createInstance as createBaseInstance, Registry } from \"@fjell/registry\";\nimport { Operations, Options } from \"@fjell/lib\";\nimport { ItemRouter } from \"./ItemRouter\";\n\nconst logger = LibLogger.get(\"Instance\");\n\n/**\n * The Express Router Instance interface represents a router model instance that extends the base Instance\n * from @fjell/registry and adds express router operations for handling HTTP requests.\n *\n * The interface extends the base Instance (which provides coordinate and registry) with:\n * - router: Provides methods for routing HTTP requests and handling CRUD operations\n * - operations: Provides methods for interacting with the data model (get, find, all, etc.)\n * - options: Provides hooks, validators, finders, actions, and facets\n *\n * @template V - The type of the data model item, extending Item\n * @template S - The string literal type representing the model's key type\n * @template L1-L5 - Optional string literal types for location hierarchy levels\n */\nexport interface Instance<\n  V extends Item<S, L1, L2, L3, L4, L5>,\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n> extends BaseInstance<S, L1, L2, L3, L4, L5> {\n  /** The router object that provides methods for handling HTTP requests */\n  router: ItemRouter<S, L1, L2, L3, L4, L5>;\n  /** The operations object that provides methods for interacting with the data model */\n  operations: Operations<V, S, L1, L2, L3, L4, L5>;\n  /** The options object that provides hooks, validators, finders, actions, and facets */\n  options: Options<V, S, L1, L2, L3, L4, L5>;\n  /** The data model item type (for type safety) */\n  readonly itemType?: V;\n}\n\nexport const createInstance = <\n  V extends Item<S, L1, L2, L3, L4, L5>,\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(\n    registry: Registry,\n    coordinate: Coordinate<S, L1, L2, L3, L4, L5>,\n    router: ItemRouter<S, L1, L2, L3, L4, L5>,\n    operations: Operations<V, S, L1, L2, L3, L4, L5>,\n    options?: Options<V, S, L1, L2, L3, L4, L5>,\n  ): Instance<V, S, L1, L2, L3, L4, L5> => {\n  logger.debug(\"createInstance\", { coordinate, router, registry, operations, options });\n  const baseInstance = createBaseInstance(registry, coordinate);\n  return { ...baseInstance, router, operations, options: options || {} as Options<V, S, L1, L2, L3, L4, L5> };\n}\n\nexport const isInstance = (instance: any): instance is Instance<any, any, any, any, any, any, any> => {\n  return instance != null &&\n    typeof instance === 'object' &&\n    instance.coordinate != null &&\n    instance.router != null &&\n    instance.registry != null &&\n    instance.operations != null &&\n    instance.options != null;\n}\n"],"names":["logger","LibLogger","get","createInstance","registry","coordinate","router","operations","options","debug","baseInstance","createBaseInstance","isInstance","instance"],"mappings":";;;AAMA,MAAMA,MAAAA,GAASC,SAAAA,CAAUC,GAAG,CAAC,UAAA,CAAA;MAkChBC,cAAAA,GAAiB,CAS1BC,QAAAA,EACAC,UAAAA,EACAC,QACAC,UAAAA,EACAC,OAAAA,GAAAA;IAEFR,MAAAA,CAAOS,KAAK,CAAC,gBAAA,EAAkB;AAAEJ,QAAAA,UAAAA;AAAYC,QAAAA,MAAAA;AAAQF,QAAAA,QAAAA;AAAUG,QAAAA,UAAAA;AAAYC,QAAAA;AAAQ,KAAA,CAAA;IACnF,MAAME,YAAAA,GAAeC,iBAAmBP,QAAAA,EAAUC,UAAAA,CAAAA;IAClD,OAAO;AAAE,QAAA,GAAGK,YAAY;AAAEJ,QAAAA,MAAAA;AAAQC,QAAAA,UAAAA;AAAYC,QAAAA,OAAAA,EAASA,WAAW;AAAwC,KAAA;AAC5G;AAEO,MAAMI,aAAa,CAACC,QAAAA,GAAAA;IACzB,OAAOA,QAAAA,IAAY,QACjB,OAAOA,QAAAA,KAAa,YACpBA,QAAAA,CAASR,UAAU,IAAI,IAAA,IACvBQ,QAAAA,CAASP,MAAM,IAAI,IAAA,IACnBO,QAAAA,CAAST,QAAQ,IAAI,IAAA,IACrBS,QAAAA,CAASN,UAAU,IAAI,IAAA,IACvBM,QAAAA,CAASL,OAAO,IAAI,IAAA;AACxB;;;;"}
+{
+  "version": 3,
+  "sources": ["../src/Instance.ts"],
+  "sourcesContent": ["import LibLogger from \"./logger\";\nimport { Item } from \"@fjell/core\";\nimport { Instance as BaseInstance, Coordinate, createInstance as createBaseInstance, Registry } from \"@fjell/registry\";\nimport { Operations, Options } from \"@fjell/lib\";\nimport { ItemRouter } from \"./ItemRouter\";\n\nconst logger = LibLogger.get(\"Instance\");\n\n/**\n * The Express Router Instance interface represents a router model instance that extends the base Instance\n * from @fjell/registry and adds express router operations for handling HTTP requests.\n *\n * The interface extends the base Instance (which provides coordinate and registry) with:\n * - router: Provides methods for routing HTTP requests and handling CRUD operations\n * - operations: Provides methods for interacting with the data model (get, find, all, etc.)\n * - options: Provides hooks, validators, finders, actions, and facets\n *\n * @template V - The type of the data model item, extending Item\n * @template S - The string literal type representing the model's key type\n * @template L1-L5 - Optional string literal types for location hierarchy levels\n */\nexport interface Instance<\n  V extends Item<S, L1, L2, L3, L4, L5>,\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n> extends BaseInstance<S, L1, L2, L3, L4, L5> {\n  /** The router object that provides methods for handling HTTP requests */\n  router: ItemRouter<S, L1, L2, L3, L4, L5>;\n  /** The operations object that provides methods for interacting with the data model */\n  operations: Operations<V, S, L1, L2, L3, L4, L5>;\n  /** The options object that provides hooks, validators, finders, actions, and facets */\n  options: Options<V, S, L1, L2, L3, L4, L5>;\n  /** The data model item type (for type safety) */\n  readonly itemType?: V;\n}\n\nexport const createInstance = <\n  V extends Item<S, L1, L2, L3, L4, L5>,\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never\n>(\n    registry: Registry,\n    coordinate: Coordinate<S, L1, L2, L3, L4, L5>,\n    router: ItemRouter<S, L1, L2, L3, L4, L5>,\n    operations: Operations<V, S, L1, L2, L3, L4, L5>,\n    options?: Options<V, S, L1, L2, L3, L4, L5>,\n  ): Instance<V, S, L1, L2, L3, L4, L5> => {\n  logger.debug(\"createInstance\", { coordinate, router, registry, operations, options });\n  const baseInstance = createBaseInstance(registry, coordinate);\n  return { ...baseInstance, router, operations, options: options || {} as Options<V, S, L1, L2, L3, L4, L5> };\n}\n\nexport const isInstance = (instance: any): instance is Instance<any, any, any, any, any, any, any> => {\n  return instance != null &&\n    typeof instance === 'object' &&\n    instance.coordinate != null &&\n    instance.router != null &&\n    instance.registry != null &&\n    instance.operations != null &&\n    instance.options != null;\n}\n"],
+  "mappings": "AAAA,OAAO,eAAe;AAEtB,SAA+C,kBAAkB,0BAAoC;AAIrG,MAAM,SAAS,UAAU,IAAI,UAAU;AAkChC,MAAM,iBAAiB,CAS1B,UACA,YACA,QACA,YACA,YACuC;AACzC,SAAO,MAAM,kBAAkB,EAAE,YAAY,QAAQ,UAAU,YAAY,QAAQ,CAAC;AACpF,QAAM,eAAe,mBAAmB,UAAU,UAAU;AAC5D,SAAO,EAAE,GAAG,cAAc,QAAQ,YAAY,SAAS,WAAW,CAAC,EAAuC;AAC5G;AAEO,MAAM,aAAa,CAAC,aAA2E;AACpG,SAAO,YAAY,QACjB,OAAO,aAAa,YACpB,SAAS,cAAc,QACvB,SAAS,UAAU,QACnB,SAAS,YAAY,QACrB,SAAS,cAAc,QACvB,SAAS,WAAW;AACxB;",
+  "names": []
+}