@owlmeans/client-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,714 @@
+# @owlmeans/client-resource
+
+Client-side resource management library for OwlMeans Common applications. This package provides a comprehensive data persistence and management system for React applications, with support for local database storage, CRUD operations, and seamless integration with the OwlMeans context system.
+
+## Overview
+
+The `@owlmeans/client-resource` package extends the base `@owlmeans/resource` package with client-specific functionality. It provides:
+
+- **Local Database Integration**: Persistent data storage using client-side databases
+- **CRUD Operations**: Complete Create, Read, Update, Delete functionality
+- **Resource Management**: Structured data management with type safety
+- **Context Integration**: Seamless integration with OwlMeans context system
+- **List Management**: Efficient listing and pagination of records
+- **Data Integrity**: Built-in validation and error handling
+- **Storage Abstraction**: Database-agnostic storage interface
+
+This package is part of the OwlMeans resource management ecosystem:
+- **@owlmeans/resource**: Base resource interfaces and utilities
+- **@owlmeans/client-resource**: Client-side resource implementation *(this package)*
+- **@owlmeans/server-resource**: Server-side resource implementation
+
+## Installation
+
+```bash
+npm install @owlmeans/client-resource
+```
+
+## Core Concepts
+
+### Resources
+Resources represent collections of data with consistent CRUD operations. Each resource is backed by a client-side database and provides type-safe access to stored records.
+
+### Client Database Service
+The underlying database service provides an abstraction over various client-side storage mechanisms (IndexedDB, localStorage, etc.).
+
+### Record Management
+All data is stored as records with unique identifiers, supporting both automatic ID generation and custom IDs.
+
+## API Reference
+
+### Factory Functions
+
+#### `appendClientResource<C, T>(context: T, alias: string): T`
+
+Appends a client resource to the application context with the specified alias.
+
+```typescript
+import { appendClientResource } from '@owlmeans/client-resource'
+import { makeClientContext } from '@owlmeans/client-context'
+
+const context = makeClientContext(config)
+appendClientResource(context, 'users')
+
+// Access the resource
+const userResource = context.resource<ClientResource<UserRecord>>('users')
+```
+
+**Parameters:**
+- `context`: T - The client context to append the resource to
+- `alias`: string - Unique identifier for the resource
+
+**Returns:** Enhanced context with the registered resource
+
+### Core Interfaces
+
+#### `ClientResource<T extends ResourceRecord>`
+
+Main interface for client-side resource management with full CRUD capabilities.
+
+```typescript
+interface ClientResource<T extends ResourceRecord = ResourceRecord> extends Resource<T> {
+  db?: ClientDb                    // Underlying database instance
+  erase(): Promise<void>           // Completely erase all data
+  
+  // Inherited from Resource:
+  get(id: string): Promise<T>                           // Get record (throws if not found)
+  load(id: string): Promise<T | null>                   // Load record (returns null if not found)
+  list(criteria?, opts?): Promise<ListResult<T>>        // List records with pagination
+  create(record: Partial<T>): Promise<T>                // Create new record
+  update(record: Partial<T> & { id: string }): Promise<T>  // Update existing record
+  delete(id: string | T): Promise<T | null>             // Delete record
+  pick(id: string | T): Promise<T>                      // Remove and return record
+  save(record: Partial<T>): Promise<T>                  // Save (create or update)
+}
+```
+
+#### `ClientDbService`
+
+Service interface for managing client-side databases.
+
+```typescript
+interface ClientDbService extends InitializedService {
+  initialize(alias?: string): Promise<ClientDb>         // Initialize database instance
+  erase(): Promise<void>                                // Erase all databases
+}
+```
+
+#### `ClientDb`
+
+Low-level database interface for direct storage operations.
+
+```typescript
+interface ClientDb {
+  get<T>(id: string): Promise<T>                        // Get value by ID
+  set<T>(id: string, value: T): Promise<void>           // Set value by ID
+  has(id: string): Promise<boolean>                     // Check if ID exists
+  del(id: string): Promise<boolean>                     // Delete by ID
+}
+```
+
+### Resource Methods Detailed Reference
+
+#### Data Retrieval Methods
+
+**`get(id: string): Promise<T>`**
+- **Purpose**: Retrieves a record by ID, throwing an error if not found
+- **Behavior**: Guaranteed to return a record or throw `UnknownRecordError`
+- **Usage**: When you know the record should exist
+- **Throws**: `UnknownRecordError` if record doesn't exist
+
+```typescript
+const userResource = context.resource<ClientResource<UserRecord>>('users')
+
+try {
+  const user = await userResource.get('user123')
+  console.log('User found:', user.name)
+} catch (error) {
+  console.error('User not found:', error.message)
+}
+```
+
+**`load(id: string): Promise<T | null>`**
+- **Purpose**: Loads a record by ID, returning null if not found
+- **Behavior**: Safe retrieval that never throws for missing records
+- **Usage**: When you need to check if a record exists
+- **Returns**: Record object or null
+
+```typescript
+const user = await userResource.load('user123')
+if (user) {
+  console.log('User exists:', user.name)
+} else {
+  console.log('User not found')
+}
+```
+
+**`list(criteria?, opts?): Promise<ListResult<T>>`**
+- **Purpose**: Lists records with optional filtering and pagination
+- **Behavior**: Efficiently paginates through large datasets
+- **Usage**: For displaying lists of data with optional filtering
+- **Returns**: Object with `items` array and `pager` information
+
+```typescript
+// List all users
+const allUsers = await userResource.list()
+
+// List with pagination
+const pagedUsers = await userResource.list({}, { 
+  pager: { page: 0, size: 10 } 
+})
+
+// List with filtering
+const activeUsers = await userResource.list({ 
+  status: 'active' 
+})
+
+// Combined filtering and pagination
+const result = await userResource.list(
+  { role: 'admin' }, 
+  { pager: { page: 1, size: 5 } }
+)
+
+console.log('Users:', result.items)
+console.log('Total:', result.pager.total)
+```
+
+#### Data Modification Methods
+
+**`create(record: Partial<T>): Promise<T>`**
+- **Purpose**: Creates a new record with automatic ID generation
+- **Behavior**: Generates unique ID if not provided, validates uniqueness
+- **Usage**: For creating new records
+- **Throws**: `RecordExists` if ID already exists
+- **Returns**: Created record with generated/validated ID
+
+```typescript
+const newUser = await userResource.create({
+  name: 'John Doe',
+  email: 'john@example.com',
+  role: 'user'
+})
+console.log('Created user with ID:', newUser.id)
+```
+
+**`update(record: Partial<T> & { id: string }): Promise<T>`**
+- **Purpose**: Updates an existing record with partial data
+- **Behavior**: Merges provided data with existing record
+- **Usage**: For modifying existing records
+- **Throws**: `UnknownRecordError` if record doesn't exist
+- **Returns**: Updated record
+
+```typescript
+const updatedUser = await userResource.update({
+  id: 'user123',
+  name: 'Jane Doe',
+  lastLogin: new Date()
+})
+```
+
+**`save(record: Partial<T>): Promise<T>`**
+- **Purpose**: Smart save that creates or updates based on existence
+- **Behavior**: Creates if ID is missing or record doesn't exist, updates otherwise
+- **Usage**: When you want create-or-update semantics
+- **Returns**: Saved record
+
+```typescript
+// Will create if user doesn't exist
+const user1 = await userResource.save({
+  name: 'New User',
+  email: 'new@example.com'
+})
+
+// Will update if user exists
+const user2 = await userResource.save({
+  id: 'existing-user',
+  name: 'Updated Name'
+})
+```
+
+**`delete(id: string | T): Promise<T | null>`**
+- **Purpose**: Deletes a record by ID or record object
+- **Behavior**: Removes record and updates internal lists
+- **Usage**: For permanent record removal
+- **Returns**: Deleted record or null if not found
+
+```typescript
+// Delete by ID
+const deletedUser = await userResource.delete('user123')
+
+// Delete by record
+const userToDelete = await userResource.load('user456')
+if (userToDelete) {
+  await userResource.delete(userToDelete)
+}
+```
+
+**`pick(id: string | T): Promise<T>`**
+- **Purpose**: Removes and returns a record atomically
+- **Behavior**: Combines delete operation with return of the deleted record
+- **Usage**: When you need to extract a record from storage
+- **Throws**: `UnknownRecordError` if record doesn't exist
+- **Returns**: Picked record
+
+```typescript
+try {
+  const pickedUser = await userResource.pick('user123')
+  console.log('Picked user:', pickedUser.name)
+  // User is now removed from storage
+} catch (error) {
+  console.error('User not found for picking')
+}
+```
+
+**`erase(): Promise<void>`**
+- **Purpose**: Completely erases all data in the resource
+- **Behavior**: Removes all records and resets the resource to empty state
+- **Usage**: For data cleanup or reset operations
+- **Warning**: This operation is irreversible
+
+```typescript
+// Completely clear all user data
+await userResource.erase()
+console.log('All user data erased')
+```
+
+### Database Configuration
+
+Resources can be configured through the context configuration:
+
+```typescript
+const context = makeClientContext({
+  service: 'my-app',
+  // ... other config
+  dbs: [
+    {
+      alias: 'users',
+      service: 'client-db',
+      schema: 'app-users',
+      host: []
+    },
+    {
+      alias: 'settings',
+      service: 'client-db', 
+      schema: 'app-settings',
+      host: []
+    }
+  ]
+})
+```
+
+### Constants
+
+#### `DEFAULT_DB_ALIAS`
+Default database service alias (`'client-db'`).
+
+#### `LIST_KEY`
+Internal key used for maintaining record lists (`'_list'`).
+
+## Usage Examples
+
+### Basic Resource Setup
+
+```typescript
+import { appendClientResource } from '@owlmeans/client-resource'
+import { makeClientContext } from '@owlmeans/client-context'
+
+interface UserRecord extends ResourceRecord {
+  id: string
+  name: string
+  email: string
+  role: 'admin' | 'user'
+  createdAt: Date
+  lastLogin?: Date
+}
+
+// Create context and add resource
+const context = makeClientContext(config)
+appendClientResource(context, 'users')
+
+// Initialize context
+await context.configure().init()
+
+// Access the resource
+const userResource = context.resource<ClientResource<UserRecord>>('users')
+```
+
+### Complete CRUD Operations
+
+```typescript
+// Create a new user
+const newUser = await userResource.create({
+  name: 'Alice Johnson',
+  email: 'alice@example.com',
+  role: 'user',
+  createdAt: new Date()
+})
+console.log('Created user:', newUser.id)
+
+// Load a user
+const user = await userResource.load(newUser.id)
+if (user) {
+  console.log('User found:', user.name)
+}
+
+// Update the user
+const updatedUser = await userResource.update({
+  id: newUser.id,
+  lastLogin: new Date(),
+  role: 'admin'
+})
+
+// List users with pagination
+const userList = await userResource.list({}, {
+  pager: { page: 0, size: 10 }
+})
+console.log('Users:', userList.items.length)
+console.log('Total users:', userList.pager.total)
+
+// Delete the user
+const deletedUser = await userResource.delete(newUser.id)
+console.log('Deleted user:', deletedUser?.name)
+```
+
+### Advanced Filtering and Pagination
+
+```typescript
+interface ProductRecord extends ResourceRecord {
+  id: string
+  name: string
+  category: string
+  price: number
+  inStock: boolean
+}
+
+const productResource = context.resource<ClientResource<ProductRecord>>('products')
+
+// Filter by category
+const electronics = await productResource.list({
+  category: 'electronics'
+})
+
+// Filter by availability
+const availableProducts = await productResource.list({
+  inStock: true
+})
+
+// Paginated results
+let page = 0
+const pageSize = 20
+let hasMore = true
+
+while (hasMore) {
+  const result = await productResource.list({}, {
+    pager: { page, size: pageSize }
+  })
+  
+  console.log(`Page ${page + 1}:`, result.items.length)
+  
+  hasMore = (page + 1) * pageSize < result.pager.total
+  page++
+}
+```
+
+### Error Handling
+
+```typescript
+import { RecordExists, UnknownRecordError, ResourceError } from '@owlmeans/resource'
+
+try {
+  // Attempt to create user with specific ID
+  const user = await userResource.create({
+    id: 'specific-id',
+    name: 'Test User',
+    email: 'test@example.com'
+  })
+} catch (error) {
+  if (error instanceof RecordExists) {
+    console.error('User with this ID already exists')
+  } else if (error instanceof ResourceError) {
+    console.error('Resource error:', error.message)
+  }
+}
+
+try {
+  // Attempt to get non-existent user
+  const user = await userResource.get('non-existent-id')
+} catch (error) {
+  if (error instanceof UnknownRecordError) {
+    console.error('User not found')
+  }
+}
+```
+
+### Multiple Resources Management
+
+```typescript
+interface UserRecord extends ResourceRecord {
+  id: string
+  name: string
+  email: string
+}
+
+interface PostRecord extends ResourceRecord {
+  id: string
+  title: string
+  content: string
+  authorId: string
+  publishedAt: Date
+}
+
+// Setup multiple resources
+const context = makeClientContext(config)
+appendClientResource(context, 'users')
+appendClientResource(context, 'posts')
+
+await context.configure().init()
+
+const userResource = context.resource<ClientResource<UserRecord>>('users')
+const postResource = context.resource<ClientResource<PostRecord>>('posts')
+
+// Create user and posts
+const author = await userResource.create({
+  name: 'John Doe',
+  email: 'john@example.com'
+})
+
+const post1 = await postResource.create({
+  title: 'First Post',
+  content: 'Hello world!',
+  authorId: author.id,
+  publishedAt: new Date()
+})
+
+const post2 = await postResource.create({
+  title: 'Second Post', 
+  content: 'More content here',
+  authorId: author.id,
+  publishedAt: new Date()
+})
+
+// Find posts by author
+const authorPosts = await postResource.list({
+  authorId: author.id
+})
+console.log(`${author.name} has ${authorPosts.items.length} posts`)
+```
+
+### Resource with Custom Database Configuration
+
+```typescript
+const context = makeClientContext({
+  service: 'advanced-app',
+  // ... other config
+  dbs: [
+    {
+      alias: 'user-data',
+      service: 'indexed-db-service',
+      schema: 'users-v2',
+      host: []
+    },
+    {
+      alias: 'cache-data',
+      service: 'memory-db-service', 
+      schema: 'temp-cache',
+      host: []
+    }
+  ]
+})
+
+// Resources will use the configured database services
+appendClientResource(context, 'user-data')
+appendClientResource(context, 'cache-data')
+```
+
+### Reactive Resource Updates
+
+```typescript
+import { useState, useEffect } from 'react'
+import { useContext } from '@owlmeans/client'
+
+function UserList() {
+  const context = useContext()
+  const [users, setUsers] = useState([])
+  
+  useEffect(() => {
+    const loadUsers = async () => {
+      const userResource = context.resource('users')
+      const result = await userResource.list()
+      setUsers(result.items)
+    }
+    
+    loadUsers()
+  }, [])
+  
+  const addUser = async (userData) => {
+    const userResource = context.resource('users')
+    const newUser = await userResource.create(userData)
+    setUsers(prev => [...prev, newUser])
+  }
+  
+  const deleteUser = async (userId) => {
+    const userResource = context.resource('users')
+    await userResource.delete(userId)
+    setUsers(prev => prev.filter(u => u.id !== userId))
+  }
+  
+  return (
+    <div>
+      {users.map(user => (
+        <div key={user.id}>
+          {user.name}
+          <button onClick={() => deleteUser(user.id)}>Delete</button>
+        </div>
+      ))}
+    </div>
+  )
+}
+```
+
+### Data Migration and Cleanup
+
+```typescript
+// Migration helper
+const migrateUserData = async () => {
+  const userResource = context.resource<ClientResource<UserRecord>>('users')
+  const users = await userResource.list()
+  
+  for (const user of users.items) {
+    if (!user.createdAt) {
+      await userResource.update({
+        id: user.id,
+        createdAt: new Date()
+      })
+    }
+  }
+}
+
+// Cleanup old data
+const cleanupOldUsers = async () => {
+  const userResource = context.resource<ClientResource<UserRecord>>('users')
+  const users = await userResource.list()
+  
+  const oneYearAgo = new Date()
+  oneYearAgo.setFullYear(oneYearAgo.getFullYear() - 1)
+  
+  for (const user of users.items) {
+    if (user.lastLogin && user.lastLogin < oneYearAgo) {
+      await userResource.delete(user.id)
+      console.log('Deleted inactive user:', user.name)
+    }
+  }
+}
+
+// Complete resource reset
+const resetAllData = async () => {
+  const userResource = context.resource('users')
+  const postResource = context.resource('posts')
+  
+  await Promise.all([
+    userResource.erase(),
+    postResource.erase()
+  ])
+  
+  console.log('All data erased')
+}
+```
+
+## Error Handling
+
+The package integrates with the OwlMeans error system and may throw the following errors:
+
+### `ResourceError`
+General resource operation errors.
+
+### `UnknownRecordError`
+Thrown when attempting to access a record that doesn't exist.
+
+### `RecordExists`
+Thrown when attempting to create a record with an ID that already exists.
+
+```typescript
+import { ResourceError, UnknownRecordError, RecordExists } from '@owlmeans/resource'
+
+const handleResourceOperation = async () => {
+  try {
+    await userResource.create({ id: 'existing-id', name: 'Test' })
+  } catch (error) {
+    if (error instanceof RecordExists) {
+      console.error('Record already exists')
+    } else if (error instanceof UnknownRecordError) {
+      console.error('Record not found')
+    } else if (error instanceof ResourceError) {
+      console.error('Resource error:', error.message)
+    }
+  }
+}
+```
+
+## Performance Considerations
+
+1. **Pagination**: Use pagination for large datasets to avoid memory issues
+2. **Indexing**: Consider database indexing for frequently queried fields
+3. **Batch Operations**: Group related operations together when possible
+4. **Memory Management**: Use `pick()` instead of `get()` + `delete()` when extracting data
+5. **Database Choice**: Choose appropriate database service based on data size and usage patterns
+
+## Integration with Other Packages
+
+### Client Context Integration
+```typescript
+import { makeClientContext } from '@owlmeans/client-context'
+import { appendClientResource } from '@owlmeans/client-resource'
+
+const context = makeClientContext(config)
+appendClientResource(context, 'users')
+```
+
+### Authentication Integration
+```typescript
+import { appendClientResource } from '@owlmeans/client-resource'
+import { AUTH_RESOURCE } from '@owlmeans/client-auth'
+
+// Setup authentication resource
+appendClientResource(context, AUTH_RESOURCE)
+```
+
+### Database Service Integration
+```typescript
+import { WebDbService } from '@owlmeans/web-db'
+import { appendClientResource } from '@owlmeans/client-resource'
+
+// Register database service first
+context.registerService(webDbService)
+
+// Then add resources that use it
+appendClientResource(context, 'users')
+```
+
+## Best Practices
+
+1. **Type Safety**: Always use TypeScript interfaces for your records
+2. **Resource Naming**: Use descriptive names for resource aliases
+3. **Error Handling**: Implement comprehensive error handling for all operations
+4. **Data Validation**: Validate data before storing in resources
+5. **Memory Management**: Use pagination for large datasets
+6. **Consistent IDs**: Use consistent ID generation strategies
+7. **Database Configuration**: Configure appropriate database services for your use case
+
+## Dependencies
+
+This package depends on:
+- `@owlmeans/resource` - Base resource interfaces and utilities
+- `@owlmeans/client-context` - Client context management
+- `@owlmeans/context` - Core context system
+- `@noble/hashes` - Cryptographic utilities for ID generation
+- `@scure/base` - Base encoding for ID generation
+
+## Related Packages
+
+- [`@owlmeans/resource`](../resource) - Base resource interfaces
+- [`@owlmeans/client-context`](../client-context) - Client context management
+- [`@owlmeans/web-db`](../web-db) - Web database implementation
+- [`@owlmeans/server-resource`](../server-resource) - Server-side resources
+- [`@owlmeans/client-auth`](../client-auth) - Authentication with resource storage

package/build/consts.d.ts

@@ -0,0 +1,3 @@
+export declare const DEFAULT_DB_ALIAS = "client-db";
+export declare const LIST_KEY = "_list";
+//# 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":"AACA,eAAO,MAAM,gBAAgB,cAAc,CAAA;AAE3C,eAAO,MAAM,QAAQ,UAAU,CAAA"}

package/build/consts.js

@@ -0,0 +1,3 @@
+export const DEFAULT_DB_ALIAS = 'client-db';
+export const LIST_KEY = '_list';
+//# sourceMappingURL=consts.js.map

package/build/consts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.js","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAA;AAE3C,MAAM,CAAC,MAAM,QAAQ,GAAG,OAAO,CAAA"}

package/build/index.d.ts

@@ -0,0 +1,4 @@
+export type * from './types.js';
+export * from './consts.js';
+export * from './resource.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,mBAAmB,YAAY,CAAA;AAC/B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA"}

package/build/index.js

@@ -0,0 +1,3 @@
+export * from './consts.js';
+export * from './resource.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":"AAEA,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA"}

package/build/resource.d.ts

@@ -0,0 +1,7 @@
+import type { ClientConfig, ClientContext } from '@owlmeans/client-context';
+type Config = ClientConfig;
+interface Context<C extends Config = Config> extends ClientContext<C> {
+}
+export declare const appendClientResource: <C extends Config, T extends Context<C>>(context: T, alias: string) => T;
+export {};
+//# sourceMappingURL=resource.d.ts.map

package/build/resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAS3E,KAAK,MAAM,GAAG,YAAY,CAAA;AAC1B,UAAU,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;CAAI;AAEzE,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,MAAM,KAAG,CA2LxG,CAAA"}

package/build/resource.js

@@ -0,0 +1,156 @@
+import { appendContextual, assertContext } from '@owlmeans/context';
+import { RecordExists, ResourceError, UnknownRecordError } from '@owlmeans/resource';
+import { DEFAULT_DB_ALIAS, LIST_KEY } from './consts.js';
+import { base58 } from '@scure/base';
+import { randomBytes } from '@noble/hashes/utils';
+export const appendClientResource = (context, alias) => {
+    const location = `client-resource:${alias}`;
+    const assert = () => {
+        if (resource.db == null) {
+            throw new ResourceError(`nodb-${location}`);
+        }
+        return resource.db;
+    };
+    const resource = appendContextual(alias, {
+        init: async () => {
+            const context = assertContext(resource.ctx, location);
+            const config = context.cfg.dbs?.find(db => db.alias === alias) ?? { service: DEFAULT_DB_ALIAS, host: [] };
+            const dbService = context.service(config.service);
+            resource.db = await dbService.initialize(config.schema ?? alias);
+        },
+        get: async (id) => {
+            const record = await resource.load(id);
+            if (record == null) {
+                throw new UnknownRecordError(id);
+            }
+            return record;
+        },
+        load: async (id) => {
+            const db = assert();
+            return await db.get(id);
+        },
+        list: async (criteria, opts) => {
+            if (criteria == null) {
+                criteria = {};
+                opts = { pager: { page: 0, size: 10 } };
+            }
+            if ("pager" in criteria) {
+                opts = criteria;
+                criteria = criteria.criteria;
+            }
+            const db = assert();
+            const list = await db.get(LIST_KEY);
+            const pager = opts?.pager ?? { page: 0, size: 10 };
+            const conditions = Object.entries(criteria ?? {});
+            pager.page = pager.page ?? 0;
+            pager.size = pager.size ?? 10;
+            const result = [];
+            let skip = pager.page * pager.size;
+            let total = 0;
+            let added = 0;
+            for (const id of list) {
+                const record = await db.get(id);
+                if (record != null) {
+                    if (!(conditions.length === 0 || conditions.every(([key, value]) => record[key] === value))) {
+                        continue;
+                    }
+                    if (skip-- <= 0 && added < pager.size) {
+                        added++;
+                        result.push(record);
+                    }
+                    ++total;
+                }
+            }
+            return { items: result, pager: { ...pager, total } };
+        },
+        create: async (record) => {
+            const db = assert();
+            record.id = record.id ?? base58.encode(randomBytes(32));
+            if (await db.has(record.id)) {
+                throw new RecordExists(record.id);
+            }
+            const list = await db.get(LIST_KEY) ?? [];
+            if (list.includes(record.id)) {
+                throw new RecordExists(record.id);
+            }
+            list.push(record.id);
+            await db.set(LIST_KEY, list);
+            await db.set(record.id, record);
+            return record;
+        },
+        update: async (record) => {
+            const db = assert();
+            if (record.id == null) {
+                throw new UnknownRecordError('update');
+            }
+            const update = await resource.load(record.id);
+            if (update == null) {
+                throw new UnknownRecordError(record.id);
+            }
+            Object.assign(update, record);
+            await db.set(record.id, update);
+            return record;
+        },
+        delete: async (id) => {
+            if (typeof id === 'object') {
+                if (id.id == null) {
+                    throw new UnknownRecordError('delete');
+                }
+                return resource.delete(id.id);
+            }
+            const db = assert();
+            if (!await db.has(id)) {
+                return null;
+            }
+            const record = await db.get(id);
+            if (record == null) {
+                throw new SyntaxError('We should not try to delete record that we know that not exists');
+            }
+            await db.del(id);
+            const list = await db.get(LIST_KEY) ?? [];
+            const idx = list.indexOf(id);
+            if (idx > -1) {
+                list.splice(idx, 1);
+                await db.set(LIST_KEY, list);
+            }
+            return record;
+        },
+        pick: async (id) => {
+            if (typeof id === 'object') {
+                if (id.id == null) {
+                    throw new UnknownRecordError('pick');
+                }
+                return resource.pick(id.id);
+            }
+            const db = assert();
+            const record = await db.get(id);
+            if (record != null) {
+                await db.del(id);
+            }
+            else {
+                throw new UnknownRecordError(id);
+            }
+            const list = await db.get(LIST_KEY) ?? [];
+            const idx = list.indexOf(id);
+            if (idx > -1) {
+                list.splice(idx, 1);
+                await db.set(LIST_KEY, list);
+            }
+            return record;
+        },
+        save: async (record) => {
+            if (record.id == null || (await resource.load(record.id) == null)) {
+                return resource.create(record);
+            }
+            return resource.update(record);
+        },
+        erase: async () => {
+            const db = assert();
+            const list = await db.get(LIST_KEY) ?? [];
+            await Promise.all(list.map(id => resource.delete(id)));
+        }
+    });
+    context.registerResource(resource);
+    return context;
+};
+//# sourceMappingURL=resource.js.map

package/build/resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACnE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAEpF,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAExD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAKjD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAyC,OAAU,EAAE,KAAa,EAAK,EAAE;IAE3G,MAAM,QAAQ,GAAG,mBAAmB,KAAK,EAAE,CAAA;IAE3C,MAAM,MAAM,GAAG,GAAa,EAAE;QAC5B,IAAI,QAAQ,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,aAAa,CAAC,QAAQ,QAAQ,EAAE,CAAC,CAAA;QAC7C,CAAC;QAED,OAAO,QAAQ,CAAC,EAAE,CAAA;IACpB,CAAC,CAAA;IAED,MAAM,QAAQ,GAAmC,gBAAgB,CAAiC,KAAK,EAAE;QACvG,IAAI,EAAE,KAAK,IAAI,EAAE;YACf,MAAM,OAAO,GAAG,aAAa,CAAkB,QAAQ,CAAC,GAAc,EAAE,QAAQ,CAAC,CAAA;YACjF,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;YACzG,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAkB,MAAM,CAAC,OAAO,CAAC,CAAA;YAClE,QAAQ,CAAC,EAAE,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,CAAA;QAClE,CAAC;QAED,GAAG,EAAE,KAAK,EAAC,EAAE,EAAC,EAAE;YACd,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAEtC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,MAAM,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAA;YAClC,CAAC;YAED,OAAO,MAAa,CAAA;QACtB,CAAC;QAGD,IAAI,EAAE,KAAK,EAAC,EAAE,EAAC,EAAE;YACf,MAAM,EAAE,GAAG,MAAM,EAAE,CAAA;YAEnB,OAAO,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAe,CAAA;QACvC,CAAC;QAED,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;YAC7B,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACrB,QAAQ,GAAG,EAAE,CAAA;gBACb,IAAI,GAAG,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,CAAA;YACzC,CAAC;YACD,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;gBACxB,IAAI,GAAG,QAAQ,CAAA;gBACf,QAAQ,GAAG,QAAQ,CAAC,QAAwB,CAAA;YAC9C,CAAC;YACD,MAAM,EAAE,GAAG,MAAM,EAAE,CAAA;YACnB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,GAAG,CAAW,QAAQ,CAAC,CAAA;YAE7C,MAAM,KAAK,GAAc,IAAI,EAAE,KAAK,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;YAC7D,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,QAAwB,IAAI,EAAE,CAAC,CAAA;YACjE,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC,CAAA;YAC5B,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAA;YAE7B,MAAM,MAAM,GAAqB,EAAE,CAAA;YACnC,IAAI,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;YAClC,IAAI,KAAK,GAAG,CAAC,CAAA;YACb,IAAI,KAAK,GAAG,CAAC,CAAA;YACb,KAAK,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC;gBACtB,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,CAAiB,EAAE,CAAC,CAAA;gBAC/C,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;oBACnB,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAC/C,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,GAA0B,CAAC,KAAK,KAAK,CAC/D,CAAC,EAAE,CAAC;wBACH,SAAQ;oBACV,CAAC;oBACD,IAAI,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;wBACtC,KAAK,EAAE,CAAA;wBACP,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;oBACrB,CAAC;oBACD,EAAE,KAAK,CAAA;gBACT,CAAC;YACH,CAAC;YAED,OAAO,EAAE,KAAK,EAAE,MAAe,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,EAAE,CAAA;QAC/D,CAAC;QAED,MAAM,EAAE,KAAK,EAAC,MAAM,EAAC,EAAE;YACrB,MAAM,EAAE,GAAG,MAAM,EAAE,CAAA;YAEnB,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAA;YAEvD,IAAI,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YACnC,CAAC;YAED,MAAM,IAAI,GAAa,MAAM,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;YACnD,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YACnC,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YACpB,MAAM,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YAC5B,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;YAE/B,OAAO,MAAa,CAAA;QACtB,CAAC;QAED,MAAM,EAAE,KAAK,EAAC,MAAM,EAAC,EAAE;YACrB,MAAM,EAAE,GAAG,MAAM,EAAE,CAAA;YAEnB,IAAI,MAAM,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;gBACtB,MAAM,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAA;YACxC,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAC7C,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,MAAM,IAAI,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YACzC,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;YAE7B,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;YAE/B,OAAO,MAAa,CAAA;QACtB,CAAC;QAED,MAAM,EAAE,KAAK,EAAC,EAAE,EAAC,EAAE;YACjB,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;gBAC3B,IAAI,EAAE,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;oBAClB,MAAM,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAA;gBACxC,CAAC;gBACD,OAAO,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;YAC/B,CAAC;YAED,MAAM,EAAE,GAAG,MAAM,EAAE,CAAA;YACnB,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBACtB,OAAO,IAAI,CAAA;YACb,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAC/B,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,MAAM,IAAI,WAAW,CAAC,iEAAiE,CAAC,CAAA;YAC1F,CAAC;YACD,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAChB,MAAM,IAAI,GAAa,MAAM,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;YACnD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC5B,IAAI,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;gBACnB,MAAM,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YAC9B,CAAC;YAED,OAAO,MAAa,CAAA;QACtB,CAAC;QAED,IAAI,EAAE,KAAK,EAAC,EAAE,EAAC,EAAE;YACf,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;gBAC3B,IAAI,EAAE,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;oBAClB,MAAM,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAA;gBACtC,CAAC;gBACD,OAAO,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;YAC7B,CAAC;YAED,MAAM,EAAE,GAAG,MAAM,EAAE,CAAA;YACnB,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAC/B,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAClB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAA;YAClC,CAAC;YACD,MAAM,IAAI,GAAa,MAAM,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;YACnD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC5B,IAAI,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;gBACnB,MAAM,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YAC9B,CAAC;YAED,OAAO,MAAa,CAAA;QACtB,CAAC;QAED,IAAI,EAAE,KAAK,EAAC,MAAM,EAAC,EAAE;YACnB,IAAI,MAAM,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC;gBAClE,OAAO,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YAChC,CAAC;YAED,OAAO,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAChC,CAAC;QAED,KAAK,EAAE,KAAK,IAAI,EAAE;YAChB,MAAM,EAAE,GAAG,MAAM,EAAE,CAAA;YACnB,MAAM,IAAI,GAAa,MAAM,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;YACnD,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QACxD,CAAC;KACF,CAAC,CAAA;IAEF,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAA;IAElC,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA"}

package/build/types.d.ts

@@ -0,0 +1,17 @@
+import type { InitializedService } from '@owlmeans/context';
+import type { Resource, ResourceRecord } from '@owlmeans/resource';
+export interface ClientDbService extends InitializedService {
+    initialize: (alias?: string) => Promise<ClientDb>;
+    erase: () => Promise<void>;
+}
+export interface ClientDb {
+    get: <T>(id: string) => Promise<T>;
+    set: <T>(id: string, value: T) => Promise<void>;
+    has: (id: string) => Promise<boolean>;
+    del: (id: string) => Promise<boolean>;
+}
+export interface ClientResource<T extends ResourceRecord = ResourceRecord> extends Resource<T> {
+    db?: ClientDb;
+    erase: () => Promise<void>;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAElE,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;IACjD,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;IAClC,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/C,GAAG,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IACrC,GAAG,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CACtC;AAED,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,CAAE,SAAQ,QAAQ,CAAC,CAAC,CAAC;IAC5F,EAAE,CAAC,EAAE,QAAQ,CAAA;IACb,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B"}

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@owlmeans/client-resource",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "sleep 120 && nodemon -e ts,tsx,json --watch src --exec \"tsc -p ./tsconfig.json\"",
+    "watch": "tsc -b -w --preserveWatchOutput --pretty"
+  },
+  "main": "build/index.js",
+  "module": "build/index.js",
+  "types": "build/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/index.js",
+      "require": "./build/index.js",
+      "default": "./build/index.js",
+      "module": "./build/index.js",
+      "types": "./build/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@noble/hashes": "^1.5.0",
+    "@owlmeans/client-context": "^0.1.0",
+    "@owlmeans/context": "^0.1.0",
+    "@owlmeans/resource": "^0.1.0",
+    "@scure/base": "^1.1.9"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.7",
+    "typescript": "^5.6.3"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/consts.ts

@@ -0,0 +1,4 @@
+
+export const DEFAULT_DB_ALIAS = 'client-db'
+
+export const LIST_KEY = '_list'

package/src/index.ts

@@ -0,0 +1,4 @@
+
+export type * from './types.js'
+export * from './consts.js'
+export * from './resource.js'

package/src/resource.ts

@@ -0,0 +1,200 @@
+import type { ClientConfig, ClientContext } from '@owlmeans/client-context'
+import { appendContextual, assertContext } from '@owlmeans/context'
+import { RecordExists, ResourceError, UnknownRecordError } from '@owlmeans/resource'
+import type { ListCriteria, ListPager, ResourceRecord } from '@owlmeans/resource'
+import { DEFAULT_DB_ALIAS, LIST_KEY } from './consts.js'
+import type { ClientDb, ClientDbService, ClientResource } from './types.js'
+import { base58 } from '@scure/base'
+import { randomBytes } from '@noble/hashes/utils'
+
+type Config = ClientConfig
+interface Context<C extends Config = Config> extends ClientContext<C> { }
+
+export const appendClientResource = <C extends Config, T extends Context<C>>(context: T, alias: string): T => {
+
+  const location = `client-resource:${alias}`
+
+  const assert = (): ClientDb => {
+    if (resource.db == null) {
+      throw new ResourceError(`nodb-${location}`)
+    }
+
+    return resource.db
+  }
+
+  const resource: ClientResource<ResourceRecord> = appendContextual<ClientResource<ResourceRecord>>(alias, {
+    init: async () => {
+      const context = assertContext<Config, Context>(resource.ctx as Context, location)
+      const config = context.cfg.dbs?.find(db => db.alias === alias) ?? { service: DEFAULT_DB_ALIAS, host: [] }
+      const dbService = context.service<ClientDbService>(config.service)
+      resource.db = await dbService.initialize(config.schema ?? alias)
+    },
+
+    get: async id => {
+      const record = await resource.load(id)
+
+      if (record == null) {
+        throw new UnknownRecordError(id)
+      }
+
+      return record as any
+    },
+
+
+    load: async id => {
+      const db = assert()
+
+      return await db.get(id) as any | null
+    },
+
+    list: async (criteria, opts) => {
+      if (criteria == null) {
+        criteria = {}
+        opts = { pager: { page: 0, size: 10 } }
+      }
+      if ("pager" in criteria) {
+        opts = criteria
+        criteria = criteria.criteria as ListCriteria
+      }
+      const db = assert()
+      const list = await db.get<string[]>(LIST_KEY)
+
+      const pager: ListPager = opts?.pager ?? { page: 0, size: 10 }
+      const conditions = Object.entries(criteria as ListCriteria ?? {})
+      pager.page = pager.page ?? 0
+      pager.size = pager.size ?? 10
+
+      const result: ResourceRecord[] = []
+      let skip = pager.page * pager.size
+      let total = 0
+      let added = 0
+      for (const id of list) {
+        const record = await db.get<ResourceRecord>(id)
+        if (record != null) {
+          if (!(conditions.length === 0 || conditions.every(
+            ([key, value]) => record[key as keyof typeof record] === value
+          ))) {
+            continue
+          }
+          if (skip-- <= 0 && added < pager.size) {
+            added++
+            result.push(record)
+          }
+          ++total
+        }
+      }
+
+      return { items: result as any[], pager: { ...pager, total } }
+    },
+
+    create: async record => {
+      const db = assert()
+
+      record.id = record.id ?? base58.encode(randomBytes(32))
+
+      if (await db.has(record.id)) {
+        throw new RecordExists(record.id)
+      }
+
+      const list: string[] = await db.get(LIST_KEY) ?? []
+      if (list.includes(record.id)) {
+        throw new RecordExists(record.id)
+      }
+      list.push(record.id)
+      await db.set(LIST_KEY, list)
+      await db.set(record.id, record)
+
+      return record as any
+    },
+
+    update: async record => {
+      const db = assert()
+
+      if (record.id == null) {
+        throw new UnknownRecordError('update')
+      }
+
+      const update = await resource.load(record.id)
+      if (update == null) {
+        throw new UnknownRecordError(record.id)
+      }
+
+      Object.assign(update, record)
+
+      await db.set(record.id, update)
+
+      return record as any
+    },
+
+    delete: async id => {
+      if (typeof id === 'object') {
+        if (id.id == null) {
+          throw new UnknownRecordError('delete')
+        }
+        return resource.delete(id.id)
+      }
+
+      const db = assert()
+      if (!await db.has(id)) {
+        return null
+      }
+
+      const record = await db.get(id)
+      if (record == null) {
+        throw new SyntaxError('We should not try to delete record that we know that not exists')
+      }
+      await db.del(id)
+      const list: string[] = await db.get(LIST_KEY) ?? []
+      const idx = list.indexOf(id)
+      if (idx > -1) {
+        list.splice(idx, 1)
+        await db.set(LIST_KEY, list)
+      }
+
+      return record as any
+    },
+
+    pick: async id => {
+      if (typeof id === 'object') {
+        if (id.id == null) {
+          throw new UnknownRecordError('pick')
+        }
+        return resource.pick(id.id)
+      }
+
+      const db = assert()
+      const record = await db.get(id)
+      if (record != null) {
+        await db.del(id)
+      } else {
+        throw new UnknownRecordError(id)
+      }
+      const list: string[] = await db.get(LIST_KEY) ?? []
+      const idx = list.indexOf(id)
+      if (idx > -1) {
+        list.splice(idx, 1)
+        await db.set(LIST_KEY, list)
+      }
+
+      return record as any
+    },
+
+    save: async record => {
+      if (record.id == null || (await resource.load(record.id) == null)) {
+        return resource.create(record)
+      }
+
+      return resource.update(record)
+    },
+
+    erase: async () => {
+      const db = assert()
+      const list: string[] = await db.get(LIST_KEY) ?? []
+      await Promise.all(list.map(id => resource.delete(id)))
+    }
+  })
+
+  context.registerResource(resource)
+
+  return context
+}

package/src/types.ts

@@ -0,0 +1,19 @@
+import type { InitializedService } from '@owlmeans/context'
+import type { Resource, ResourceRecord } from '@owlmeans/resource'
+
+export interface ClientDbService extends InitializedService {
+  initialize: (alias?: string) => Promise<ClientDb>
+  erase: () => Promise<void>
+}
+
+export interface ClientDb {
+  get: <T>(id: string) => Promise<T>
+  set: <T>(id: string, value: T) => Promise<void>
+  has: (id: string) => Promise<boolean>
+  del: (id: string) => Promise<boolean>
+}
+
+export interface ClientResource<T extends ResourceRecord = ResourceRecord> extends Resource<T> {
+  db?: ClientDb
+  erase: () => Promise<void>
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": [
+    "../tsconfig.default.json"
+  ],
+  "compilerOptions": {
+    "rootDir": "./src/", /* Specify the root folder within your source files. */
+    "outDir": "./build/", /* Specify an output folder for all emitted files. */
+    "moduleResolution": "Bundler",
+  },
+  "exclude": [
+    "./dist/**/*",
+    "./build/**/*",
+    "./*.ts"
+  ]
+}

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/consts.ts","./src/index.ts","./src/resource.ts","./src/types.ts"],"version":"5.6.3"}