@owlmeans/static-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,330 @@
+# @owlmeans/static-resource
+
+The **@owlmeans/static-resource** package provides an in-memory resource storage solution for OwlMeans Common Libraries, designed for fullstack microservices and microclients development with focus on security and proper authentication and authorization.
+
+## Purpose
+
+This package serves as a lightweight, in-memory resource implementation that:
+
+- **Provides temporary storage** for resources that don't require persistent storage
+- **Supports TTL (Time To Live)** for automatic cleanup of expired records
+- **Integrates with context system** for dependency injection and resource management
+- **Offers CRUD operations** with validation and error handling
+- **Enables testing scenarios** where persistent storage is not needed
+
+## Core Concepts
+
+### Static Resource
+A static resource is an in-memory storage that implements the standard `Resource<ResourceRecord>` interface from `@owlmeans/resource`. It stores records in memory and provides methods for creating, reading, and deleting records.
+
+### Key-Value Storage
+Records are stored using a key-value approach where each record must have an `id` field. Multiple static resource instances can share the same underlying storage by using the same key.
+
+### TTL Support
+Records can be created with a Time To Live (TTL) option, after which they are automatically removed from the storage.
+
+## API Reference
+
+### Factory Functions
+
+#### `createStaticResource(alias?, key?): Resource<ResourceRecord>`
+
+Creates a new static resource instance.
+
+```typescript
+import { createStaticResource } from '@owlmeans/static-resource'
+
+const resource = createStaticResource('my-cache')
+```
+
+**Parameters:**
+- `alias`: string (optional) - Resource alias, defaults to `DEFAULT_ALIAS` ('static')
+- `key`: string (optional) - Storage key, defaults to the alias value
+
+**Returns:** Resource instance implementing full CRUD operations
+
+#### `appendStaticResource<C, T>(ctx, alias?, key?): T & StaticResourceAppend`
+
+Adds static resource functionality to a context.
+
+```typescript
+import { appendStaticResource } from '@owlmeans/static-resource'
+import { makeBasicContext, makeBasicConfig, AppType } from '@owlmeans/context'
+
+const config = makeBasicConfig(AppType.Backend, 'my-service')
+const context = makeBasicContext(config)
+const contextWithStatic = appendStaticResource(context, 'cache')
+```
+
+**Parameters:**
+- `ctx`: T - The context to extend
+- `alias`: string (optional) - Resource alias, defaults to `DEFAULT_ALIAS`
+- `key`: string (optional) - Storage key, defaults to the alias value
+
+**Returns:** Extended context with `getStaticResource` method
+
+### Resource Methods
+
+The static resource implements the standard `Resource<ResourceRecord>` interface:
+
+#### `get<T>(id, field?, opts?): Promise<T>`
+
+Retrieves a record by ID or field value. Throws `UnknownRecordError` if not found.
+
+```typescript
+const user = await resource.get<User>('user-123')
+```
+
+#### `load<T>(id, field?, opts?): Promise<T | null>`
+
+Loads a record by ID or field value. Returns `null` if not found.
+
+```typescript
+const user = await resource.load<User>('user-123')
+if (user) {
+  console.log('User found:', user.name)
+}
+```
+
+#### `list<T>(criteria?, opts?): Promise<ListResult<T>>`
+
+Lists all records in the storage.
+
+```typescript
+const result = await resource.list<User>()
+console.log('Total users:', result.items.length)
+```
+
+**Note:** Criteria and options parameters are not supported and will throw `UnsupportedArgumentError`.
+
+#### `create<T>(record, opts?): Promise<T>`
+
+Creates a new record in the storage.
+
+```typescript
+const user = await resource.create({
+  id: 'user-123',
+  name: 'John Doe',
+  email: 'john@example.com'
+}, { ttl: 3600 }) // TTL in seconds
+```
+
+**Options:**
+- `ttl`: number | Date - Time to live in seconds (number) or expiration date (Date)
+
+**Throws:**
+- `UnknownRecordError` - If record doesn't have an `id` field
+- `RecordExists` - If record with the same ID already exists
+
+#### `delete(id, opts?): Promise<T | null>`
+
+Deletes a record and returns it, or `null` if not found.
+
+```typescript
+const deletedUser = await resource.delete('user-123')
+```
+
+#### `pick<T>(id, opts?): Promise<T>`
+
+Deletes a record and returns it. Throws `UnknownRecordError` if not found.
+
+```typescript
+const pickedUser = await resource.pick('user-123')
+```
+
+### Unsupported Methods
+
+The following methods throw `UnsupportedMethodError`:
+- `save()` - Static resources don't support updating existing records
+- `update()` - Static resources don't support partial updates
+
+### Types
+
+#### `StaticResourceAppend`
+
+Interface added to contexts when using `appendStaticResource`.
+
+```typescript
+interface StaticResourceAppend {
+  getStaticResource: <T extends ResourceRecord>(alias?: string) => Resource<T>
+}
+```
+
+#### `Config` and `Context`
+
+Type aliases for basic context configuration and context interfaces.
+
+```typescript
+interface Config extends BasicConfig {}
+interface Context<C extends Config = Config> extends BasicContext<C> {}
+```
+
+### Constants
+
+#### `DEFAULT_ALIAS`
+
+Default alias for static resources.
+
+```typescript
+const DEFAULT_ALIAS = 'static'
+```
+
+## Usage Examples
+
+### Basic Usage
+
+```typescript
+import { createStaticResource } from '@owlmeans/static-resource'
+
+// Create a static resource
+const cache = createStaticResource('user-cache')
+
+// Create records
+await cache.create({ id: 'user-1', name: 'Alice', role: 'admin' })
+await cache.create({ id: 'user-2', name: 'Bob', role: 'user' })
+
+// Retrieve records
+const alice = await cache.get('user-1')
+console.log('Found user:', alice.name)
+
+// List all records
+const { items } = await cache.list()
+console.log('Total users:', items.length)
+
+// Delete a record
+const deleted = await cache.delete('user-1')
+console.log('Deleted user:', deleted?.name)
+```
+
+### Context Integration
+
+```typescript
+import { appendStaticResource } from '@owlmeans/static-resource'
+import { makeBasicContext, makeBasicConfig, AppType } from '@owlmeans/context'
+
+const config = makeBasicConfig(AppType.Backend, 'user-service')
+const context = makeBasicContext(config)
+
+// Add static resource to context
+const enhancedContext = appendStaticResource(context, 'session-cache')
+
+// Configure and initialize context
+enhancedContext.configure()
+await enhancedContext.init()
+
+// Use the static resource
+const sessionCache = enhancedContext.getStaticResource('session-cache')
+await sessionCache.create({
+  id: 'session-123',
+  userId: 'user-456',
+  expires: new Date(Date.now() + 3600000)
+})
+```
+
+### TTL Usage
+
+```typescript
+import { createStaticResource } from '@owlmeans/static-resource'
+
+const cache = createStaticResource('temporary-cache')
+
+// Create record with TTL in seconds
+await cache.create({
+  id: 'temp-data',
+  value: 'This will expire'
+}, { ttl: 60 }) // Expires in 60 seconds
+
+// Create record with expiration date
+const expirationDate = new Date(Date.now() + 30000) // 30 seconds from now
+await cache.create({
+  id: 'temp-data-2',
+  value: 'This will also expire'
+}, { ttl: expirationDate })
+
+// Records will be automatically removed after TTL expires
+setTimeout(async () => {
+  const record = await cache.load('temp-data')
+  console.log('Record exists:', record !== null) // false
+}, 61000)
+```
+
+### Shared Storage
+
+```typescript
+import { createStaticResource } from '@owlmeans/static-resource'
+
+// Multiple resources sharing the same storage
+const cacheA = createStaticResource('cache-a', 'shared-storage')
+const cacheB = createStaticResource('cache-b', 'shared-storage')
+
+// Record created in cacheA is accessible from cacheB
+await cacheA.create({ id: 'shared-record', data: 'shared data' })
+const record = await cacheB.load('shared-record')
+console.log('Shared record:', record?.data) // 'shared data'
+```
+
+### Error Handling
+
+```typescript
+import { createStaticResource } from '@owlmeans/static-resource'
+import { UnknownRecordError, RecordExists } from '@owlmeans/resource'
+
+const resource = createStaticResource('error-demo')
+
+try {
+  // This will throw UnknownRecordError
+  await resource.get('non-existent-id')
+} catch (error) {
+  if (error instanceof UnknownRecordError) {
+    console.log('Record not found:', error.message)
+  }
+}
+
+try {
+  await resource.create({ id: 'user-1', name: 'Alice' })
+  // This will throw RecordExists
+  await resource.create({ id: 'user-1', name: 'Bob' })
+} catch (error) {
+  if (error instanceof RecordExists) {
+    console.log('Record already exists:', error.message)
+  }
+}
+```
+
+## Error Handling
+
+The package uses standard error types from `@owlmeans/resource`:
+
+- **`UnknownRecordError`** - Thrown when trying to access a non-existent record
+- **`RecordExists`** - Thrown when trying to create a record with an existing ID
+- **`MisshapedRecord`** - Thrown when record structure is invalid (missing ID)
+- **`UnsupportedArgumentError`** - Thrown when unsupported arguments are provided
+- **`UnsupportedMethodError`** - Thrown when calling unsupported methods
+
+## Integration with OwlMeans Common
+
+This package follows the OwlMeans Common library structure:
+- **types**: TypeScript interfaces and type definitions
+- **consts**: Static values and constants
+- **resource**: Resource implementation and factory functions
+
+The static resource integrates seamlessly with other OwlMeans packages:
+- Uses `@owlmeans/context` for dependency injection
+- Implements `@owlmeans/resource` interface for consistency
+- Supports `@owlmeans/error` error types
+
+## Best Practices
+
+1. **Use for temporary data** - Static resources are perfect for caching, sessions, or test data
+2. **Implement TTL for cleanup** - Always set TTL for records that should expire automatically
+3. **Share storage carefully** - Use the same key only when you want resources to share data
+4. **Handle errors gracefully** - Always catch and handle resource-specific errors
+5. **Integrate with context** - Use `appendStaticResource` for proper context integration
+6. **Test scenarios** - Perfect for unit tests where you don't want persistent storage
+
+## Dependencies
+
+This package depends on:
+- `@owlmeans/context` - For contextual resource management
+- `@owlmeans/resource` - For resource interface and error types
+- `@owlmeans/error` - For error handling infrastructure

package/build/consts.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_ALIAS = "static";
+//# 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,aAAa,WAAW,CAAA"}

package/build/consts.js

@@ -0,0 +1,2 @@
+export const DEFAULT_ALIAS = 'static';
+//# 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,aAAa,GAAG,QAAQ,CAAA"}

package/build/index.d.ts

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

package/build/index.js

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

package/build/resource.d.ts

@@ -0,0 +1,5 @@
+import type { Resource, ResourceRecord } from '@owlmeans/resource';
+import type { Config, Context, StaticResourceAppend } from './types.js';
+export declare const createStaticResource: (alias?: string, key?: string) => Resource<ResourceRecord>;
+export declare const appendStaticResource: <C extends Config, T extends Context<C>>(ctx: T, alias?: string, key?: string) => T & StaticResourceAppend;
+//# 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":"AAEA,OAAO,KAAK,EAC8D,QAAQ,EAChF,cAAc,EACf,MAAM,oBAAoB,CAAA;AAE3B,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAMvE,eAAO,MAAM,oBAAoB,WAAW,MAAM,QAAwB,MAAM,6BAmI/E,CAAA;AAED,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,OACpE,CAAC,UAAS,MAAM,QAAwB,MAAM,KAClD,CAAC,GAAG,oBAWN,CAAA"}

package/build/resource.js

@@ -0,0 +1,122 @@
+import { appendContextual } from '@owlmeans/context';
+import { DEFAULT_ALIAS } from './consts.js';
+import { MisshapedRecord, RecordExists, UnknownRecordError, UnsupportedArgumentError, UnsupportedMethodError } from '@owlmeans/resource';
+const stores = {};
+export const createStaticResource = (alias = DEFAULT_ALIAS, key) => {
+    key = key ?? alias;
+    const getStore = () => {
+        if (stores[key] == null) {
+            stores[key] = new Map();
+        }
+        return stores[key];
+    };
+    const resource = appendContextual(alias, {
+        get: async (id, field, opts) => {
+            const record = await resource.load(id, field, opts);
+            if (record == null) {
+                throw new UnknownRecordError(id);
+            }
+            return record;
+        },
+        load: async (id, field, opts) => {
+            field = field ?? 'id';
+            if (opts != null) {
+                throw new UnsupportedArgumentError('static:get:opts');
+            }
+            const store = getStore();
+            const record = field === 'id'
+                ? store.get(id)
+                : [...store.values()].find(record => record[field] === id);
+            if (record == null) {
+                return null;
+            }
+            return record;
+        },
+        list: async (criteria, opts) => {
+            if (criteria != null) {
+                throw new UnsupportedArgumentError('static:list:criteria');
+            }
+            if (opts != null) {
+                throw new UnsupportedArgumentError('static:list:opts');
+            }
+            const result = {
+                items: [...getStore().values()]
+            };
+            return result;
+        },
+        save: () => { throw new UnsupportedMethodError('static:save'); },
+        create: async (record, opts) => {
+            const store = getStore();
+            if (record.id == null) {
+                throw new UnknownRecordError('id');
+            }
+            if (store.has(record.id)) {
+                throw new RecordExists(record.id);
+            }
+            store.set(record.id, record);
+            if (opts?.ttl != null) {
+                const ttl = opts.ttl instanceof Date
+                    ? (opts.ttl.getTime() - Date.now()) / 1000
+                    : typeof opts.ttl === 'number'
+                        ? opts.ttl * 1000
+                        : null;
+                if (ttl == null) {
+                    throw new UnsupportedArgumentError('static:opts:ttl-string');
+                }
+                setTimeout(() => record.id != null && void store.delete(record.id), ttl);
+            }
+            return record;
+        },
+        update: () => { throw new UnsupportedMethodError('static:update'); },
+        delete: async (id, opts) => {
+            let record = null;
+            if (typeof id === 'object') {
+                if (id.id == null) {
+                    throw new MisshapedRecord('id');
+                }
+                record = await resource.load(id.id);
+            }
+            else if (typeof opts === 'string') {
+                record = await resource.load(id, opts);
+            }
+            if (record == null) {
+                return null;
+            }
+            let field = 'id';
+            if (typeof opts === 'string') {
+                field = opts;
+                opts = undefined;
+            }
+            else if (typeof opts === 'object') {
+                field = opts.field ?? field;
+            }
+            id = record.id ?? '';
+            if (id === '') {
+                throw new MisshapedRecord('id');
+            }
+            const store = getStore();
+            if (store.delete(id)) {
+                return record;
+            }
+            return null;
+        },
+        pick: async (id, opts) => {
+            const record = await resource.delete(id, opts);
+            if (record == null) {
+                throw new UnknownRecordError((typeof id === 'string' ? id : id.id) ?? 'unknown');
+            }
+            return record;
+        }
+    });
+    return resource;
+};
+export const appendStaticResource = (ctx, alias = DEFAULT_ALIAS, key) => {
+    const resource = createStaticResource(alias, key);
+    const _ctx = ctx;
+    _ctx.registerResource(resource);
+    if (_ctx.getStaticResource == null) {
+        _ctx.getStaticResource = alias => ctx.resource(alias ?? resource.alias);
+    }
+    return _ctx;
+};
+//# sourceMappingURL=resource.js.map

package/build/resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAK3C,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAMxI,MAAM,MAAM,GAAgD,EAAE,CAAA;AAC9D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,QAAgB,aAAa,EAAE,GAAY,EAAE,EAAE;IAClF,GAAG,GAAG,GAAG,IAAI,KAAK,CAAA;IAElB,MAAM,QAAQ,GAAG,GAAG,EAAE;QACpB,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,CAAA;QACzB,CAAC;QAED,OAAO,MAAM,CAAC,GAAG,CAAC,CAAA;IACpB,CAAC,CAAA;IAED,MAAM,QAAQ,GAA6B,gBAAgB,CAAe,KAAK,EAAE;QAC/E,GAAG,EAAE,KAAK,EAA4B,EAAU,EAAE,KAAc,EAAE,IAAuB,EAAE,EAAE;YAC3F,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAI,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;YACtD,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,MAAM,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAA;YAClC,CAAC;YAED,OAAO,MAAM,CAAA;QACf,CAAC;QAED,IAAI,EAAE,KAAK,EAA4B,EAAU,EAAE,KAAc,EAAE,IAAuB,EAAE,EAAE;YAC5F,KAAK,GAAG,KAAK,IAAI,IAAI,CAAA;YACrB,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;gBACjB,MAAM,IAAI,wBAAwB,CAAC,iBAAiB,CAAC,CAAA;YACvD,CAAC;YACD,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAA;YACxB,MAAM,MAAM,GAAG,KAAK,KAAK,IAAI;gBAC3B,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAa;gBAC3B,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CACxB,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAA4B,CAAC,KAAK,EAAE,CACrC,CAAA;YAEpB,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAA;YACb,CAAC;YAED,OAAO,MAAM,CAAA;QACf,CAAC;QAED,IAAI,EAAE,KAAK,EAA4B,QAAqC,EAAE,IAAkB,EAAE,EAAE;YAClG,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,IAAI,wBAAwB,CAAC,sBAAsB,CAAC,CAAA;YAC5D,CAAC;YACD,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;gBACjB,MAAM,IAAI,wBAAwB,CAAC,kBAAkB,CAAC,CAAA;YACxD,CAAC;YAED,MAAM,MAAM,GAAkB;gBAC5B,KAAK,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAQ;aACvC,CAAA;YAED,OAAO,MAAM,CAAA;QACf,CAAC;QAED,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,sBAAsB,CAAC,aAAa,CAAC,CAAA,CAAC,CAAC;QAE/D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YAC7B,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAA;YACxB,IAAI,MAAM,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;gBACtB,MAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAA;YACpC,CAAC;YACD,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YACnC,CAAC;YACD,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;YAC5B,IAAI,IAAI,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;gBACtB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,YAAY,IAAI;oBAClC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI;oBAC1C,CAAC,CAAC,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ;wBAC5B,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI;wBACjB,CAAC,CAAC,IAAI,CAAA;gBACV,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;oBAChB,MAAM,IAAI,wBAAwB,CAAC,wBAAwB,CAAC,CAAA;gBAC9D,CAAC;gBACD,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAA;YAC1E,CAAC;YAED,OAAO,MAAa,CAAA;QACtB,CAAC;QAED,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,sBAAsB,CAAC,eAAe,CAAC,CAAA,CAAC,CAAC;QAEnE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE;YACzB,IAAI,MAAM,GAA0B,IAAI,CAAA;YACxC,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;gBAC3B,IAAI,EAAE,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;oBAClB,MAAM,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;gBACjC,CAAC;gBACD,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;YACrC,CAAC;iBAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACpC,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;YACxC,CAAC;YAED,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAA;YACb,CAAC;YAED,IAAI,KAAK,GAAG,IAAI,CAAA;YAChB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,KAAK,GAAG,IAAI,CAAA;gBACZ,IAAI,GAAG,SAAS,CAAA;YAClB,CAAC;iBAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACpC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAA;YAC7B,CAAC;YAED,EAAE,GAAG,MAAM,CAAC,EAAE,IAAI,EAAE,CAAA;YAEpB,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBACd,MAAM,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;YACjC,CAAC;YAED,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAA;YACxB,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;gBACrB,OAAO,MAAa,CAAA;YACtB,CAAC;YAED,OAAO,IAAI,CAAA;QACb,CAAC;QAED,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE;YACvB,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;YAC9C,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,MAAM,IAAI,kBAAkB,CAAC,CAAC,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,SAAS,CAAC,CAAA;YAClF,CAAC;YAED,OAAO,MAAa,CAAA;QACtB,CAAC;KACF,CAAC,CAAA;IAEF,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,GAAM,EAAE,QAAgB,aAAa,EAAE,GAAY,EACzB,EAAE;IAC5B,MAAM,QAAQ,GAAG,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;IAEjD,MAAM,IAAI,GAAG,GAA+B,CAAA;IAE5C,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAA;IAC/B,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAA;IACzE,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA"}

package/build/types.d.ts

@@ -0,0 +1,10 @@
+import type { Resource, ResourceRecord } from '@owlmeans/resource';
+import type { BasicConfig, BasicContext } from '@owlmeans/context';
+export interface StaticResourceAppend {
+    getStaticResource: <T extends ResourceRecord>(alias?: string) => Resource<T>;
+}
+export interface Config extends BasicConfig {
+}
+export interface Context<C extends Config = Config> extends BasicContext<C> {
+}
+//# 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,QAAQ,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAElE,MAAM,WAAW,oBAAoB;IACnC,iBAAiB,EAAE,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAA;CAC7E;AAED,MAAM,WAAW,MAAO,SAAQ,WAAW;CAAG;AAE9C,MAAM,WAAW,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,YAAY,CAAC,CAAC,CAAC;CAAG"}

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,35 @@
+{
+  "name": "@owlmeans/static-resource",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "sleep 348 && 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": {
+    "@owlmeans/context": "^0.1.0",
+    "@owlmeans/error": "^0.1.0",
+    "@owlmeans/resource": "^0.1.0"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.7",
+    "typescript": "^5.6.3"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/consts.ts

@@ -0,0 +1,2 @@
+
+export const DEFAULT_ALIAS = 'static'

package/src/index.ts

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

package/src/resource.ts

@@ -0,0 +1,160 @@
+import { appendContextual } from '@owlmeans/context'
+import { DEFAULT_ALIAS } from './consts.js'
+import type {
+  GetterOptions, ListOptions, ListResult, LifecycleOptions, ListCriteria, Resource,
+  ResourceRecord
+} from '@owlmeans/resource'
+import { MisshapedRecord, RecordExists, UnknownRecordError, UnsupportedArgumentError, UnsupportedMethodError } from '@owlmeans/resource'
+import type { Config, Context, StaticResourceAppend } from './types.js'
+
+type Getter = string | GetterOptions
+type ResourceType = Resource<ResourceRecord>
+
+const stores: Record<string, Map<string, ResourceRecord>> = {}
+export const createStaticResource = (alias: string = DEFAULT_ALIAS, key?: string) => {
+  key = key ?? alias
+
+  const getStore = () => {
+    if (stores[key] == null) {
+      stores[key] = new Map()
+    }
+
+    return stores[key]
+  }
+
+  const resource: Resource<ResourceRecord> = appendContextual<ResourceType>(alias, {
+    get: async <T extends ResourceRecord>(id: string, field?: Getter, opts?: LifecycleOptions) => {
+      const record = await resource.load<T>(id, field, opts)
+      if (record == null) {
+        throw new UnknownRecordError(id)
+      }
+
+      return record
+    },
+
+    load: async <T extends ResourceRecord>(id: string, field?: Getter, opts?: LifecycleOptions) => {
+      field = field ?? 'id'
+      if (opts != null) {
+        throw new UnsupportedArgumentError('static:get:opts')
+      }
+      const store = getStore()
+      const record = field === 'id'
+        ? store.get(id) as T | null
+        : [...store.values()].find(
+          record => record[field as keyof typeof record] === id
+        ) as T | undefined
+
+      if (record == null) {
+        return null
+      }
+
+      return record
+    },
+
+    list: async <T extends ResourceRecord>(criteria?: ListOptions | ListCriteria, opts?: ListOptions) => {
+      if (criteria != null) {
+        throw new UnsupportedArgumentError('static:list:criteria')
+      }
+      if (opts != null) {
+        throw new UnsupportedArgumentError('static:list:opts')
+      }
+
+      const result: ListResult<T> = {
+        items: [...getStore().values()] as T[]
+      }
+
+      return result
+    },
+
+    save: () => { throw new UnsupportedMethodError('static:save') },
+
+    create: async (record, opts) => {
+      const store = getStore()
+      if (record.id == null) {
+        throw new UnknownRecordError('id')
+      }
+      if (store.has(record.id)) {
+        throw new RecordExists(record.id)
+      }
+      store.set(record.id, record)
+      if (opts?.ttl != null) {
+        const ttl = opts.ttl instanceof Date 
+          ? (opts.ttl.getTime() - Date.now()) / 1000
+          : typeof opts.ttl === 'number'
+            ? opts.ttl * 1000
+            : null
+        if (ttl == null) {
+          throw new UnsupportedArgumentError('static:opts:ttl-string')
+        }
+        setTimeout(() => record.id != null && void store.delete(record.id), ttl)
+      }
+
+      return record as any
+    },
+
+    update: () => { throw new UnsupportedMethodError('static:update') },
+
+    delete: async (id, opts) => {
+      let record: ResourceRecord | null = null
+      if (typeof id === 'object') {
+        if (id.id == null) {
+          throw new MisshapedRecord('id')
+        }
+        record = await resource.load(id.id)
+      } else if (typeof opts === 'string') {
+        record = await resource.load(id, opts)
+      }
+
+      if (record == null) {
+        return null
+      }
+
+      let field = 'id'
+      if (typeof opts === 'string') {
+        field = opts
+        opts = undefined
+      } else if (typeof opts === 'object') {
+        field = opts.field ?? field
+      }
+
+      id = record.id ?? ''
+
+      if (id === '') {
+        throw new MisshapedRecord('id')
+      }
+
+      const store = getStore()
+      if (store.delete(id)) {
+        return record as any
+      }
+
+      return null
+    },
+
+    pick: async (id, opts) => {
+      const record = await resource.delete(id, opts)
+      if (record == null) {
+        throw new UnknownRecordError((typeof id === 'string' ? id : id.id) ?? 'unknown')
+      }
+
+      return record as any
+    }
+  })
+
+  return resource
+}
+
+export const appendStaticResource = <C extends Config, T extends Context<C>>(
+  ctx: T, alias: string = DEFAULT_ALIAS, key?: string
+): T & StaticResourceAppend => {
+  const resource = createStaticResource(alias, key)
+
+  const _ctx = ctx as T & StaticResourceAppend
+
+  _ctx.registerResource(resource)
+  if (_ctx.getStaticResource == null) {
+    _ctx.getStaticResource = alias => ctx.resource(alias ?? resource.alias)
+  }
+
+  return _ctx
+}

package/src/types.ts

@@ -0,0 +1,10 @@
+import type { Resource, ResourceRecord } from '@owlmeans/resource'
+import type { BasicConfig, BasicContext } from '@owlmeans/context'
+
+export interface StaticResourceAppend {
+  getStaticResource: <T extends ResourceRecord>(alias?: string) => Resource<T>
+}
+
+export interface Config extends BasicConfig {}
+
+export interface Context<C extends Config = Config> extends BasicContext<C> {}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "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. */
+  },
+  "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"}