@owlmeans/resource 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OwlMeans Common — Fullstack typescript framework
+
+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,420 @@
+# @owlmeans/resource
+
+A comprehensive data persistence and resource management library for OwlMeans Common applications. This package provides abstract interfaces and implementations for handling database operations, resource management, and data access patterns across different storage backends.
+
+## Overview
+
+The `@owlmeans/resource` package is a foundational data access library in the OwlMeans Common ecosystem that provides:
+
+- **Database Abstraction**: Generic interfaces for different database backends
+- **CRUD Operations**: Complete Create, Read, Update, Delete functionality
+- **Resource Management**: Advanced resource lifecycle management
+- **Query System**: Flexible query and filtering capabilities
+- **Pagination Support**: Built-in pagination and sorting functionality
+- **Validation Integration**: Schema validation with JSON Schema support
+- **Caching & TTL**: Time-to-live and caching mechanisms
+- **Multi-Database Support**: Handle multiple database configurations
+
+## Installation
+
+```bash
+npm install @owlmeans/resource
+```
+
+## Core Concepts
+
+### Resource Interface
+
+The `Resource<T>` interface provides the primary data access API for working with records that extend `ResourceRecord`.
+
+### Database Service
+
+The `ResourceDbService` interface provides an abstraction for database-specific implementations, allowing different storage backends (MongoDB, Redis, etc.) to be used interchangeably.
+
+### Resource Records
+
+All data entities extend `ResourceRecord`, which provides a basic structure with an optional `id` field.
+
+### List Operations
+
+Advanced listing functionality with criteria-based filtering, pagination, and sorting capabilities.
+
+## API Reference
+
+### Types
+
+#### `Resource<T extends ResourceRecord>`
+Primary interface for resource operations.
+
+```typescript
+interface Resource<T extends ResourceRecord> extends BasicResource {
+  get: <Type extends T>(id: string, field?: Getter, opts?: LifecycleOptions) => Promise<Type>
+  load: <Type extends T>(id: string, field?: Getter, opts?: LifecycleOptions) => Promise<Type | null>
+  list: <Type extends T>(criteria?: ListOptions | ListCriteria, opts?: ListOptions) => Promise<ListResult<Type>>
+  save: <Type extends T>(record: Partial<Type>, opts?: Getter) => Promise<Type>
+  create: <Type extends T>(record: Partial<Type>, opts?: LifecycleOptions) => Promise<Type>
+  update: <Type extends T>(record: Partial<Type>, opts?: Getter) => Promise<Type>
+  delete: <Type extends T>(id: string | T, opts?: Getter) => Promise<Type | null>
+  pick: <Type extends T>(id: string | T, opts?: Getter) => Promise<Type>
+}
+```
+
+#### `ResourceRecord`
+Base interface for all resource entities.
+
+```typescript
+interface ResourceRecord {
+  id?: string
+}
+```
+
+#### `ListOptions`
+Configuration for list operations.
+
+```typescript
+interface ListOptions {
+  pager?: ListPager
+  criteria?: ListCriteria
+}
+```
+
+#### `ListPager`
+Pagination and sorting configuration.
+
+```typescript
+interface ListPager {
+  sort?: ListSort[]
+  page?: number
+  size?: number
+  total?: number
+}
+```
+
+#### `ListResult<T>`
+Result structure for list operations.
+
+```typescript
+interface ListResult<T extends ResourceRecord> {
+  items: T[]
+  pager?: ListPager
+}
+```
+
+#### `DbConfig`
+Database configuration structure.
+
+```typescript
+interface DbConfig<P extends {} = {}> {
+  service: string
+  alias?: string
+  host: string | string[]
+  port?: number
+  user?: string
+  secret?: string
+  schema?: string
+  resourcePrefix?: string
+  entitySensitive?: boolean
+  serviceSensitive?: boolean
+  encryptionKey?: string
+  meta?: P
+}
+```
+
+### Factory Functions
+
+#### `createDbService<Db, Client, Service>(alias: string, override: Partial<Service>, init?: InitMethod<Service>): Service`
+Creates a database service with the specified configuration.
+
+**Parameters:**
+- `alias`: Service alias for registration
+- `override`: Partial service implementation
+- `init`: Optional initialization method
+
+**Returns:** Configured database service
+
+### Helper Functions
+
+#### `createListSchema<T>(schema: JSONSchemaType<T>): JSONSchemaType<ListResult<T>>`
+Creates a JSON Schema for list results based on a record schema.
+
+#### `prepareListOptions(defPageSize?: number, criteria?: ListOptions | ListCriteria, opts?: ListOptions): ListOptions`
+Prepares and normalizes list options with default pagination.
+
+#### `filterObject<T>(obj: T, keep?: string[]): T`
+Filters an object, removing null/undefined values except for specified keys.
+
+### CRUD Operations
+
+#### `get(id: string, field?: Getter, opts?: LifecycleOptions): Promise<T>`
+Retrieves a record by ID. Throws `UnknownRecordError` if not found.
+
+#### `load(id: string, field?: Getter, opts?: LifecycleOptions): Promise<T | null>`
+Loads a record by ID. Returns `null` if not found.
+
+#### `save(record: Partial<T>, opts?: Getter): Promise<T>`
+Saves a record (creates if new, updates if exists).
+
+#### `create(record: Partial<T>, opts?: LifecycleOptions): Promise<T>`
+Creates a new record. Throws `RecordExists` if record already exists.
+
+#### `update(record: Partial<T>, opts?: Getter): Promise<T>`
+Updates an existing record. Throws `UnknownRecordError` if not found.
+
+#### `delete(id: string | T, opts?: Getter): Promise<T | null>`
+Deletes a record by ID or record object.
+
+#### `pick(id: string | T, opts?: Getter): Promise<T>`
+Retrieves a record, throwing `UnknownRecordError` if not found.
+
+#### `list(criteria?: ListOptions | ListCriteria, opts?: ListOptions): Promise<ListResult<T>>`
+Lists records with optional filtering, pagination, and sorting.
+
+### Error Types
+
+The package provides a comprehensive error hierarchy for resource operations:
+
+#### `ResourceError`
+Base error class for all resource-related errors.
+
+#### `UnknownRecordError`
+Error thrown when a requested record is not found.
+
+```typescript
+class UnknownRecordError extends ResourceError {
+  constructor(id: string)
+  get id(): string  // Extract the record ID from the error
+}
+```
+
+#### `MisshapedRecord`
+Error for malformed or invalid record data.
+
+#### `RecordExists`
+Error thrown when attempting to create a record that already exists.
+
+#### `RecordUpdateFailed`
+Error for failed update operations.
+
+#### `UnsupportedArgumentError`
+Error for unsupported method arguments.
+
+#### `UnsupportedMethodError`
+Error for unsupported operations.
+
+## Usage Examples
+
+### Basic Resource Operations
+
+```typescript
+interface User extends ResourceRecord {
+  id?: string
+  name: string
+  email: string
+  createdAt?: Date
+}
+
+// Create a new user
+const newUser: User = await userResource.create({
+  name: 'John Doe',
+  email: 'john@example.com'
+})
+
+// Get a user by ID
+const user = await userResource.get('user123')
+
+// Update a user
+const updatedUser = await userResource.update({
+  id: 'user123',
+  name: 'John Smith'
+})
+
+// Delete a user
+await userResource.delete('user123')
+```
+
+### List Operations with Pagination
+
+```typescript
+// Basic list
+const users = await userResource.list()
+
+// List with pagination
+const pagedUsers = await userResource.list({
+  pager: {
+    page: 0,
+    size: 10,
+    sort: [['name', true], 'createdAt']  // Sort by name asc, then createdAt
+  }
+})
+
+// List with criteria
+const filteredUsers = await userResource.list({
+  criteria: {
+    status: 'active',
+    role: ['admin', 'moderator']
+  },
+  pager: { size: 20 }
+})
+```
+
+### Error Handling
+
+```typescript
+import { UnknownRecordError, RecordExists } from '@owlmeans/resource'
+
+try {
+  const user = await userResource.get('nonexistent')
+} catch (error) {
+  if (error instanceof UnknownRecordError) {
+    console.log(`User not found: ${error.id}`)
+  }
+}
+
+try {
+  await userResource.create({ id: 'existing', name: 'Test' })
+} catch (error) {
+  if (error instanceof RecordExists) {
+    console.log('User already exists')
+  }
+}
+```
+
+### Database Configuration
+
+```typescript
+import { createBasicContext } from '@owlmeans/context'
+
+const context = createBasicContext({
+  dbs: [
+    {
+      service: 'mongo-db',
+      alias: 'primary',
+      host: 'localhost',
+      port: 27017,
+      schema: 'myapp',
+      user: 'dbuser',
+      secret: 'dbpass',
+      resourcePrefix: 'app_',
+      entitySensitive: true
+    },
+    {
+      service: 'redis-db',
+      alias: 'cache',
+      host: 'localhost',
+      port: 6379
+    }
+  ]
+})
+```
+
+### Custom Resource Implementation
+
+```typescript
+import { Resource, ResourceRecord } from '@owlmeans/resource'
+
+interface Product extends ResourceRecord {
+  name: string
+  price: number
+  category: string
+}
+
+class ProductResource implements Resource<Product> {
+  // Implement all required methods
+  async get(id: string): Promise<Product> {
+    // Custom implementation
+  }
+  
+  async list(criteria?: ListOptions): Promise<ListResult<Product>> {
+    // Custom implementation with business logic
+  }
+  
+  // ... other methods
+}
+```
+
+### TTL and Caching
+
+```typescript
+// Load with TTL
+const user = await userResource.load('user123', {
+  ttl: 300  // Cache for 5 minutes
+})
+
+// Load with expiration date
+const user = await userResource.load('user123', {
+  ttl: new Date(Date.now() + 300000)  // Expire in 5 minutes
+})
+```
+
+## Advanced Features
+
+### Multi-Database Support
+
+The package supports multiple database configurations within a single application:
+
+```typescript
+// Different databases for different resource types
+const userResource = makeUserResource('primary-db')
+const cacheResource = makeCacheResource('redis-db')
+const analyticsResource = makeAnalyticsResource('analytics-db')
+```
+
+### Schema Validation
+
+Integration with JSON Schema for record validation:
+
+```typescript
+import { createListSchema } from '@owlmeans/resource'
+
+const userSchema: JSONSchemaType<User> = {
+  type: 'object',
+  properties: {
+    id: { type: 'string', nullable: true },
+    name: { type: 'string' },
+    email: { type: 'string', format: 'email' }
+  },
+  required: ['name', 'email'],
+  additionalProperties: false
+}
+
+const userListSchema = createListSchema(userSchema)
+```
+
+### Resource Locking
+
+Support for record locking mechanisms:
+
+```typescript
+interface ResourceLocker<T extends ResourceRecord> {
+  lock: (record: Partial<T>, fields?: string[]) => Promise<T>
+  unlock: (record: Partial<T>, fields?: string[]) => Promise<T>
+}
+```
+
+## Integration with OwlMeans Ecosystem
+
+The `@owlmeans/resource` package integrates with:
+
+- **@owlmeans/context**: Service registration and configuration management
+- **@owlmeans/error**: Resilient error handling system
+- **@owlmeans/mongo-resource**: MongoDB-specific implementation
+- **@owlmeans/redis-resource**: Redis-specific implementation
+- **@owlmeans/client-resource**: Client-side resource management
+- **@owlmeans/static-resource**: Static file resource management
+
+## Performance Considerations
+
+- Use `load()` instead of `get()` when records might not exist
+- Implement appropriate pagination for large datasets
+- Use TTL for frequently accessed but rarely changed data
+- Consider database-specific optimizations for complex queries
+- Implement proper indexing strategies for list criteria
+
+## Security Features
+
+- Entity-sensitive configurations for multi-tenant applications
+- Service-sensitive configurations for microservice architectures
+- Encryption key support for sensitive data
+- Input validation through schema integration
+
+Fixes #32.

package/build/consts.d.ts

@@ -0,0 +1,4 @@
+import type { JSONSchemaType } from 'ajv';
+import type { ListResult, ResourceRecord } from './types.js';
+export declare const createListSchema: <T extends ResourceRecord>(schema: JSONSchemaType<T>) => JSONSchemaType<ListResult<T>>;
+//# sourceMappingURL=consts.d.ts.map

package/build/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE5D,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,cAAc,UAAU,cAAc,CAAC,CAAC,CAAC,KAAG,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CA6CjH,CAAA"}

package/build/consts.js

@@ -0,0 +1,47 @@
+export const createListSchema = (schema) => ({
+    type: 'object',
+    properties: {
+        items: {
+            type: 'array',
+            items: {
+                ...schema,
+                type: 'object',
+                properties: {
+                    id: { type: 'string', nullable: true },
+                    ...schema.properties
+                },
+                ...(schema.required ? { required: [...schema.required] } : undefined),
+                additionalProperties: false,
+            }
+        },
+        pager: {
+            type: 'object',
+            properties: {
+                sort: {
+                    type: 'array',
+                    items: {
+                        oneOf: [
+                            { type: 'string' },
+                            {
+                                type: 'array', items: [
+                                    { type: 'string' },
+                                    { type: 'boolean', nullable: true }
+                                ], minItems: 1, maxItems: 2
+                            }
+                        ]
+                    },
+                    nullable: true
+                },
+                page: { type: 'number', nullable: true },
+                size: { type: 'number', nullable: true },
+                total: { type: 'number', nullable: true }
+            },
+            required: [],
+            nullable: true,
+            additionalProperties: false,
+        }
+    },
+    required: ['items'],
+    additionalProperties: false,
+});
+//# sourceMappingURL=consts.js.map

package/build/consts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.js","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAA2B,MAAyB,EAAiC,EAAE,CAAC,CAAC;IACvH,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,GAAG,MAAM;gBACT,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;oBACtC,GAAG,MAAM,CAAC,UAAU;iBACrB;gBACD,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;gBACrE,oBAAoB,EAAE,KAAK;aAC5B;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,KAAK,EAAE;4BACL,EAAE,IAAI,EAAE,QAAQ,EAAE;4BAClB;gCACE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE;oCACpB,EAAE,IAAI,EAAE,QAAQ,EAAE;oCAClB,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;iCACpC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC;6BAC5B;yBACF;qBACF;oBACD,QAAQ,EAAE,IAAI;iBACf;gBACD,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACxC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACxC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;aAC1C;YACD,QAAQ,EAAE,EAAE;YACZ,QAAQ,EAAE,IAAI;YACd,oBAAoB,EAAE,KAAK;SAC5B;KACF;IACD,QAAQ,EAAE,CAAC,OAAO,CAAC;IACnB,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAA"}

package/build/errors.d.ts

@@ -0,0 +1,32 @@
+import { ResilientError } from '@owlmeans/error';
+export declare class ResourceError extends ResilientError {
+    static typeName: string;
+    constructor(message?: string);
+}
+export declare class UnknownRecordError extends ResourceError {
+    static typeName: string;
+    static readonly idSeparator: string;
+    constructor(id: string);
+    get id(): string;
+}
+export declare class MisshapedRecord extends ResourceError {
+    static typeName: string;
+    constructor(msg: string);
+}
+export declare class RecordExists extends ResourceError {
+    static typeName: string;
+    constructor(msg: string);
+}
+export declare class RecordUpdateFailed extends ResourceError {
+    static typeName: string;
+    constructor(msg: string);
+}
+export declare class UnsupportedArgumentError extends ResourceError {
+    static typeName: string;
+    constructor(argument: string);
+}
+export declare class UnsupportedMethodError extends ResourceError {
+    static typeName: string;
+    constructor(method: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/build/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAG,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEjD,qBAAa,aAAc,SAAQ,cAAc;IAC/C,OAAuB,QAAQ,SAAkB;gBAErC,OAAO,GAAE,MAAgB;CAGtC;AAED,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,OAAuB,QAAQ,SAAgD;IAE/E,gBAAuB,WAAW,EAAE,MAAM,CAAM;gBAEpC,EAAE,EAAE,MAAM;IAKtB,IAAI,EAAE,IAAI,MAAM,CAEf;CACF;AAED,qBAAa,eAAgB,SAAQ,aAAa;IAChD,OAAuB,QAAQ,SAA6C;gBAEhE,GAAG,EAAE,MAAM;CAIxB;AAED,qBAAa,YAAa,SAAQ,aAAa;IAC7C,OAAuB,QAAQ,SAA0C;gBAE7D,GAAG,EAAE,MAAM;CAIxB;AAED,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,OAAuB,QAAQ,SAAgD;gBAEnE,GAAG,EAAE,MAAM;CAIxB;AAED,qBAAa,wBAAyB,SAAQ,aAAa;IACzD,OAAuB,QAAQ,SAAsD;gBAEzE,QAAQ,EAAE,MAAM;CAI7B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;IACvD,OAAuB,QAAQ,SAAoD;gBAEvE,MAAM,EAAE,MAAM;CAI3B"}

package/build/errors.js

@@ -0,0 +1,61 @@
+import { ResilientError } from '@owlmeans/error';
+export class ResourceError extends ResilientError {
+    static typeName = 'ResourceError';
+    constructor(message = 'error') {
+        super(ResourceError.typeName, `resource:${message}`);
+    }
+}
+export class UnknownRecordError extends ResourceError {
+    static typeName = `${ResourceError.typeName}UnknownRecordError`;
+    static idSeparator = '/';
+    constructor(id) {
+        super(`unknown-record${UnknownRecordError.idSeparator}${id}`);
+        this.type = UnknownRecordError.typeName;
+    }
+    get id() {
+        return this.message.split(UnknownRecordError.idSeparator)[1];
+    }
+}
+export class MisshapedRecord extends ResourceError {
+    static typeName = `${ResourceError.typeName}MisshapedRecord`;
+    constructor(msg) {
+        super(`misshaped-record:${msg}`);
+        this.type = MisshapedRecord.typeName;
+    }
+}
+export class RecordExists extends ResourceError {
+    static typeName = `${ResourceError.typeName}RecordExists`;
+    constructor(msg) {
+        super(`record-exists:${msg}`);
+        this.type = RecordExists.typeName;
+    }
+}
+export class RecordUpdateFailed extends ResourceError {
+    static typeName = `${ResourceError.typeName}RecordUpdateFailed`;
+    constructor(msg) {
+        super(`record-update-failed:${msg}`);
+        this.type = RecordUpdateFailed.typeName;
+    }
+}
+export class UnsupportedArgumentError extends ResourceError {
+    static typeName = `${ResourceError.typeName}UnsupportedArgumentError`;
+    constructor(argument) {
+        super(`unsupported-argument:${argument}`);
+        this.type = UnsupportedArgumentError.typeName;
+    }
+}
+export class UnsupportedMethodError extends ResourceError {
+    static typeName = `${ResourceError.typeName}UnsupportedMethodError`;
+    constructor(method) {
+        super(`unsupported-method:${method}`);
+        this.type = UnsupportedMethodError.typeName;
+    }
+}
+ResilientError.registerErrorClass(ResourceError);
+ResilientError.registerErrorClass(UnknownRecordError);
+ResilientError.registerErrorClass(MisshapedRecord);
+ResilientError.registerErrorClass(RecordExists);
+ResilientError.registerErrorClass(RecordUpdateFailed);
+ResilientError.registerErrorClass(UnsupportedArgumentError);
+ResilientError.registerErrorClass(UnsupportedMethodError);
+//# sourceMappingURL=errors.js.map

package/build/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAG,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEjD,MAAM,OAAO,aAAc,SAAQ,cAAc;IACxC,MAAM,CAAU,QAAQ,GAAG,eAAe,CAAA;IAEjD,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,aAAa,CAAC,QAAQ,EAAE,YAAY,OAAO,EAAE,CAAC,CAAA;IACtD,CAAC;;AAGH,MAAM,OAAO,kBAAmB,SAAQ,aAAa;IAC5C,MAAM,CAAU,QAAQ,GAAG,GAAG,aAAa,CAAC,QAAQ,oBAAoB,CAAA;IAExE,MAAM,CAAU,WAAW,GAAW,GAAG,CAAA;IAEhD,YAAY,EAAU;QACpB,KAAK,CAAC,iBAAiB,kBAAkB,CAAC,WAAW,GAAG,EAAE,EAAE,CAAC,CAAA;QAC7D,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAA;IACzC,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;IAC9D,CAAC;;AAGH,MAAM,OAAO,eAAgB,SAAQ,aAAa;IACzC,MAAM,CAAU,QAAQ,GAAG,GAAG,aAAa,CAAC,QAAQ,iBAAiB,CAAA;IAE5E,YAAY,GAAW;QACrB,KAAK,CAAC,oBAAoB,GAAG,EAAE,CAAC,CAAA;QAChC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,QAAQ,CAAA;IACtC,CAAC;;AAGH,MAAM,OAAO,YAAa,SAAQ,aAAa;IACtC,MAAM,CAAU,QAAQ,GAAG,GAAG,aAAa,CAAC,QAAQ,cAAc,CAAA;IAEzE,YAAY,GAAW;QACrB,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAA;QAC7B,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAA;IACnC,CAAC;;AAGH,MAAM,OAAO,kBAAmB,SAAQ,aAAa;IAC5C,MAAM,CAAU,QAAQ,GAAG,GAAG,aAAa,CAAC,QAAQ,oBAAoB,CAAA;IAE/E,YAAY,GAAW;QACrB,KAAK,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAA;QACpC,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAA;IACzC,CAAC;;AAGH,MAAM,OAAO,wBAAyB,SAAQ,aAAa;IAClD,MAAM,CAAU,QAAQ,GAAG,GAAG,aAAa,CAAC,QAAQ,0BAA0B,CAAA;IAErF,YAAY,QAAgB;QAC1B,KAAK,CAAC,wBAAwB,QAAQ,EAAE,CAAC,CAAA;QACzC,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC,QAAQ,CAAA;IAC/C,CAAC;;AAGH,MAAM,OAAO,sBAAuB,SAAQ,aAAa;IAChD,MAAM,CAAU,QAAQ,GAAG,GAAG,aAAa,CAAC,QAAQ,wBAAwB,CAAA;IAEnF,YAAY,MAAc;QACxB,KAAK,CAAC,sBAAsB,MAAM,EAAE,CAAC,CAAA;QACrC,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,QAAQ,CAAA;IAC7C,CAAC;;AAGH,cAAc,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAA;AAChD,cAAc,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;AACrD,cAAc,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAA;AAClD,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAA;AAC/C,cAAc,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;AACrD,cAAc,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAA;AAC3D,cAAc,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAA"}

package/build/helper.d.ts

@@ -0,0 +1,4 @@
+import type { ListCriteria, ListOptions } from './types.js';
+export declare const prepareListOptions: (defPageSize?: number, criteria?: ListOptions | ListCriteria, opts?: ListOptions) => ListOptions;
+export declare const filterObject: <T extends {}>(obj: T, keep?: string[]) => T;
+//# sourceMappingURL=helper.d.ts.map

package/build/helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAa,MAAM,YAAY,CAAA;AAEtE,eAAO,MAAM,kBAAkB,iBAAiB,MAAM,aAAkB,WAAW,GAAG,YAAY,SAAS,WAAW,KAAG,WAsBxH,CAAA;AAED,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,MAAM,EAAE,KAAG,CAMxD,CAAA"}

package/build/helper.js

@@ -0,0 +1,30 @@
+export const prepareListOptions = (defPageSize = 10, criteria, opts) => {
+    if (opts == null) {
+        if (criteria == null) {
+            criteria = {};
+            opts = {};
+        }
+        else if ('criteria' in criteria) {
+            criteria = criteria.criteria;
+            opts = { pager: criteria.pager };
+        }
+        else if ('pager' in criteria) {
+            opts = { pager: criteria.pager };
+            criteria = {};
+        }
+    }
+    const size = (opts?.pager?.size ?? defPageSize);
+    const pager = {
+        sort: opts?.pager?.sort,
+        page: opts?.pager?.page ?? 0,
+        size, total: 0
+    };
+    return { criteria: criteria, pager };
+};
+export const filterObject = (obj, keep) => Object.entries(obj).reduce((obj, [key, value]) => {
+    if (value == null && !keep?.includes(key)) {
+        return obj;
+    }
+    return { ...obj, [key]: value };
+}, {});
+//# sourceMappingURL=helper.js.map

package/build/helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helper.js","sourceRoot":"","sources":["../src/helper.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,cAAsB,EAAE,EAAE,QAAqC,EAAE,IAAkB,EAAe,EAAE;IACrI,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,QAAQ,GAAG,EAAE,CAAA;YACb,IAAI,GAAG,EAAE,CAAA;QACX,CAAC;aAAM,IAAI,UAAU,IAAI,QAAQ,EAAE,CAAC;YAClC,QAAQ,GAAG,QAAQ,CAAC,QAAwB,CAAA;YAC5C,IAAI,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,KAA8B,EAAE,CAAA;QAC3D,CAAC;aAAM,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,IAAI,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,KAA8B,EAAE,CAAA;YACzD,QAAQ,GAAG,EAAE,CAAA;QACf,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,IAAI,WAAW,CAAC,CAAA;IAC/C,MAAM,KAAK,GAAc;QACvB,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI;QACvB,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC;QAC5B,IAAI,EAAE,KAAK,EAAE,CAAC;KACf,CAAA;IAED,OAAO,EAAE,QAAQ,EAAE,QAAwB,EAAE,KAAK,EAAE,CAAA;AACtD,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAAe,GAAM,EAAE,IAAe,EAAK,EAAE,CACvE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IAC/C,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1C,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAA;AACjC,CAAC,EAAE,EAAO,CAAC,CAAA"}

package/build/index.d.ts

@@ -0,0 +1,6 @@
+export * from './errors.js';
+export * from './consts.js';
+export * from './service.js';
+export * from './helper.js';
+export type * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,mBAAmB,YAAY,CAAA"}

package/build/index.js

@@ -0,0 +1,5 @@
+export * from './errors.js';
+export * from './consts.js';
+export * from './service.js';
+export * from './helper.js';
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA"}

package/build/service.d.ts

@@ -0,0 +1,4 @@
+import type { InitMethod } from '@owlmeans/context';
+import type { ResourceDbService } from './types.js';
+export declare const createDbService: <Db, Client, Service extends ResourceDbService<Db, Client> = ResourceDbService<Db, Client>>(alias: string, override: Partial<Service>, init?: InitMethod<Service>) => Service;
+//# sourceMappingURL=service.d.ts.map