@travetto/cache 5.0.0-rc.1 → 5.0.0-rc.11

package/README.md

@@ -26,7 +26,6 @@ npm install @travetto/model-{provider}
 yarn add @travetto/model-{provider}
 ```
 Currently, the following are packages that provide [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11):
-   *  [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") - @travetto/model: [FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L49), [MemoryModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/memory.ts#L54)
    *  [DynamoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-dynamodb#readme "DynamoDB backing for the travetto model module.") - @travetto/model-dynamodb
    *  [Elasticsearch Model Source](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch#readme "Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.") - @travetto/model-elasticsearch
    *  [MongoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-mongo#readme "Mongo backing for the travetto model module.") - @travetto/model-mongo
@@ -35,17 +34,19 @@ Currently, the following are packages that provide [Expiry](https://github.com/t
    *  [PostgreSQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-postgres#readme "PostgreSQL backing for the travetto model module, with real-time modeling support for SQL schemas.") - @travetto/model-postgres
    *  [MySQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-mysql#readme "MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.") - @travetto/model-mysql
    *  [SQLite Model Service](https://github.com/travetto/travetto/tree/main/module/model-sqlite#readme "SQLite backing for the travetto model module, with real-time modeling support for SQL schemas.") - @travetto/model-sqlite
+   *  [Memory Model Support](https://github.com/travetto/travetto/tree/main/module/model-memory#readme "Memory backing for the travetto model module.") - @travetto/model-memory
+   *  [File Model Support](https://github.com/travetto/travetto/tree/main/module/model-file#readme "File system backing for the travetto model module.") - @travetto/model-file
 
 ## Decorators
 The caching framework provides method decorators that enables simple use cases.  One of the requirements to use the caching decorators is that the method arguments, and return values need to be serializable into [JSON](https://www.json.org).  Any other data types are not currently supported and would require either manual usage of the caching services directly, or specification of serialization/deserialization routines in the cache config.
 
 Additionally, to use the decorators you will need to have a [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L35) object accessible on the class instance. This can be dependency injected, or manually constructed. The decorators will detect the field at time of method execution, which decouples construction of your class from the cache construction.
 
-[@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L16) is a decorator that will cache all successful results, keyed by a computation based on the method arguments.  Given the desire for supporting remote caches (e.g. [redis](https://redis.io), [memcached](https://memcached.org)), only asynchronous methods are supported.
+[@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L13) is a decorator that will cache all successful results, keyed by a computation based on the method arguments.  Given the desire for supporting remote caches (e.g. [redis](https://redis.io), [memcached](https://memcached.org)), only asynchronous methods are supported.
 
 **Code: Using decorators to cache expensive async call**
 ```typescript
-import { MemoryModelService } from '@travetto/model';
+import { MemoryModelService } from '@travetto/model-memory';
 import { Cache, CacheService } from '@travetto/cache';
 
 async function request(url: string): Promise<string> {
@@ -69,7 +70,7 @@ export class Worker {
 ```
 
 ### Cache
-The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L16) decorator supports configurations on:
+The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L13) decorator supports configurations on:
    *  `name` the field name of the current class which points to the desired cache source.
    *  `config` the additional/optional config options, on a per invocation basis
 
@@ -82,11 +83,11 @@ The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/dec
       *  `reinstate` the function to execute on return of a cached value.  This allows for any necessary operations to conform to expected output (e.g. re-establishing class instances, etc.).  This method should not be used often, as the return values of the methods should naturally serialize to/from `JSON` and the values should be usable either way.
 
 ### EvictCache
-Additionally, there is support for planned eviction via the [@EvictCache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L43) decorator.  On successful execution of a method with this decorator, the matching keySpace/key value will be evicted from the cache.  This requires coordination between multiple methods, to use the same `keySpace` and `key` to compute the expected key.
+Additionally, there is support for planned eviction via the [@EvictCache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L39) decorator.  On successful execution of a method with this decorator, the matching keySpace/key value will be evicted from the cache.  This requires coordination between multiple methods, to use the same `keySpace` and `key` to compute the expected key.
 
 **Code: Using decorators to cache/evict user access**
 ```typescript
-import { MemoryModelService } from '@travetto/model';
+import { MemoryModelService } from '@travetto/model-memory';
 import { Cache, EvictCache, CacheService } from '@travetto/cache';
 
 class User { }
@@ -124,18 +125,17 @@ By design, the [CacheService](https://github.com/travetto/travetto/tree/main/mod
 ```typescript
 import { InjectableFactory } from '@travetto/di';
 import { ModelExpirySupport } from '@travetto/model';
+import { MemoryModelService } from '@travetto/model-memory';
 import { CacheModelⲐ } from '@travetto/cache';
 
 class Config {
   @InjectableFactory(CacheModelⲐ)
   static getModel(): ModelExpirySupport {
-    // @ts-expect-error
-    return new CustomAwesomeModelService();
+    return new CustomAwesomeModelService({});
   }
 }
 
-// @ts-expect-error
-class CustomAwesomeModelService implements ModelExpirySupport {
+class CustomAwesomeModelService extends MemoryModelService {
   // Implement all the things
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/cache",
-  "version": "5.0.0-rc.1",
+  "version": "5.0.0-rc.11",
   "description": "Caching functionality with decorators for declarative use.",
   "keywords": [
     "typescript",
@@ -25,12 +25,12 @@
     "directory": "module/cache"
   },
   "dependencies": {
-    "@travetto/di": "^5.0.0-rc.1",
-    "@travetto/model": "^5.0.0-rc.1"
+    "@travetto/di": "^5.0.0-rc.10",
+    "@travetto/model": "^5.0.0-rc.11"
   },
   "peerDependencies": {
-    "@travetto/test": "^5.0.0-rc.1",
-    "@travetto/transformer": "^5.0.0-rc.1"
+    "@travetto/test": "^5.0.0-rc.10",
+    "@travetto/transformer": "^5.0.0-rc.7"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/decorator.ts

@@ -1,12 +1,9 @@
-import { TimeSpan, TimeUtil } from '@travetto/base';
+import { castTo, MethodDescriptor, TimeSpan, TimeUtil } from '@travetto/runtime';
 
 import { CacheService } from './service';
 import { CoreCacheConfig, CacheConfig } from './types';
 import { CacheAware, CacheConfigⲐ, EvictConfigⲐ } from './internal/types';
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type MethodDescriptor<R = any, V = unknown> = TypedPropertyDescriptor<(this: V, ...params: any[]) => R>;
-
 /**
  * Indicates a method is intended to cache.  The return type must be properly serializable
  * @param field The field of the cache source
@@ -25,12 +22,11 @@ export function Cache<F extends string, U extends Record<F, CacheService>>(
       config = cfg;
     }
   }
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
   const dec = function <R extends Promise<unknown>>(target: U & CacheAware, propertyKey: string, descriptor: MethodDescriptor<R>): void {
     config.keySpace ??= `${target.constructor.name}.${propertyKey}`;
     (target[CacheConfigⲐ] ??= {})[propertyKey] = config;
-  } as MethodDecorator;
-  return dec;
+  };
+  return castTo(dec);
 }
 
 /**

package/src/error.ts

@@ -1,4 +1,4 @@
-import { AppError } from '@travetto/base';
+import { AppError } from '@travetto/runtime';
 
 /** Cache Error Class */
 export class CacheError extends AppError { }

package/src/service.ts

@@ -1,7 +1,7 @@
 import { ExpiresAt, Index, Model, ModelExpirySupport, NotFoundError } from '@travetto/model';
 import { Text } from '@travetto/schema';
 import { Inject, Injectable } from '@travetto/di';
-import { AppError, Env, TimeUtil } from '@travetto/base';
+import { AppError, Runtime, TimeUtil } from '@travetto/runtime';
 import { isIndexedSupported, isStorageSupported } from '@travetto/model/src/internal/service/common';
 
 import { CacheError } from './error';
@@ -41,7 +41,7 @@ export class CacheService {
   }
 
   async postConstruct(): Promise<void> {
-    if (isStorageSupported(this.#modelService) && (Env.dynamic || this.#modelService.config?.autoCreate)) {
+    if (isStorageSupported(this.#modelService) && (Runtime.dynamic || this.#modelService.config?.autoCreate)) {
       await this.#modelService.createModel?.(CacheRecord);
     }
   }

package/src/types.ts

@@ -1,3 +1,5 @@
+import { TypedFunction } from '@travetto/runtime';
+
 /**
  * A minimal config for a cache operation
  */
@@ -5,13 +7,11 @@ export interface CoreCacheConfig {
   /**
    * A method for converting the input params into the final set of param keys
    */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  params?: (...params: any[]) => unknown[];
+  params?: TypedFunction<unknown[]>;
   /**
    * Takes in a set of params and produce the unique cache key
    */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  key?: (...params: any[]) => string;
+  key?: TypedFunction<string>;
   /**
    * A namespace for the specific cache operation
    */

package/src/util.ts

@@ -1,4 +1,4 @@
-import { Util } from '@travetto/base';
+import { BinaryUtil } from '@travetto/runtime';
 
 import { CoreCacheConfig } from './types';
 
@@ -8,7 +8,7 @@ import { CoreCacheConfig } from './types';
 export class CacheUtil {
 
   /**
-   * Convert value to safe JSON for persistance
+   * Convert value to safe JSON for persistence
    * @param value The value to make safe for storage
    * @param all Should functions and regex be included
    */
@@ -35,6 +35,6 @@ export class CacheUtil {
     const input = config.params?.(params) ?? params;
     const keyParams = config.key?.(...input) ?? input;
     const key = `${config.keySpace!}_${this.toSafeJSON(keyParams)}`;
-    return Util.hash(key, 32);
+    return BinaryUtil.hash(key, 32);
   }
 }

package/support/test/service.ts

@@ -7,7 +7,7 @@ import { Inject, Injectable } from '@travetto/di';
 import { InjectableSuite } from '@travetto/di/support/test/suite';
 import { ModelSuite } from '@travetto/model/support/test/suite';
 import { isIndexedSupported } from '@travetto/model/src/internal/service/common';
-import { Class } from '@travetto/base';
+import { castTo, Class } from '@travetto/runtime';
 import { Schema } from '@travetto/schema';
 
 import { Cache, EvictCache } from '../../src/decorator';
@@ -58,7 +58,7 @@ class SampleService {
     return { length: Object.keys(config).length, size };
   }
 
-  @Cache('source', { keySpace: 'user.id', reinstate: x => User.from(x as User) })
+  @Cache('source', { keySpace: 'user.id', reinstate: x => User.from(castTo(x)) })
   async getUser(userId: string) {
     await timers.setTimeout(100);