@celljs/cache 4.3.0 → 4.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1 +1,51 @@
1
1
  # Cell - Cache Component with cache-manager
2
+
3
+ Named cache managers for Cell backends, on [cache-manager](https://github.com/jaredwray/cache-manager) 5.
4
+
5
+ ```bash
6
+ npm install @celljs/cache
7
+ ```
8
+
9
+ ```ts
10
+ import { Autowired, Component, Named } from '@celljs/core';
11
+ import { CacheManager } from '@celljs/cache';
12
+
13
+ @Component()
14
+ export class UserService {
15
+ @Autowired(CacheManager) // the cache named "default"
16
+ protected readonly cache: CacheManager;
17
+
18
+ @Autowired(CacheManager) @Named('sessions')
19
+ protected readonly sessions: CacheManager;
20
+
21
+ getUser(id: string) {
22
+ return this.cache.wrap(`user:${id}`, () => this.load(id), 60_000); // computed once, kept 60 s
23
+ }
24
+ }
25
+ ```
26
+
27
+ `CacheManager` has `get`, `set(key, value, ttl?)`, `del`, `reset` and `wrap(key, fn, ttl?)`. A manager is created the first time it is injected.
28
+
29
+ ## Configuration (`cache.config`)
30
+
31
+ One entry per cache name:
32
+
33
+ ```yaml
34
+ cache:
35
+ config:
36
+ default:
37
+ store: memory
38
+ max: 100 # entries
39
+ ttl: 3600000 # milliseconds
40
+ sessions:
41
+ store: redis-yet # needs the cache-manager-redis-yet package
42
+ url: "${env.REDIS_URL}"
43
+ ttl: 86400000
44
+ ```
45
+
46
+ - `ttl` is in **milliseconds**, as in cache-manager 5. The default cache keeps entries 3600 ms.
47
+ - `store` is `memory` or the name of a store package you install: `redis` (`cache-manager-redis`), `redis-store`, `redis-yet`, `ioredis`, `ioredis-yet`, `mongodb`, `mongoose`, `fs-binary`, `fs-hash`, `hazelcast`, `memcached-store`, `memory-store` (each `cache-manager-<name>`). The other keys are the options of that store.
48
+ - A list of entries makes a multi-level cache (`multiCaching`): reads try each store in order.
49
+ - Injecting a name without configuration throws `Not found cache options.`
50
+
51
+ Bind your own `CacheStoreFactory` (`rebind: true`) to create stores another way.
@@ -0,0 +1,38 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "properties": {
4
+ "cache": {
5
+ "type": "object",
6
+ "description": "Caches.",
7
+ "properties": {
8
+ "config": {
9
+ "type": "object",
10
+ "description": "Caches by name; default is used when none is named.",
11
+ "additionalProperties": {
12
+ "type": "object",
13
+ "properties": {
14
+ "store": {
15
+ "anyOf": [
16
+ {
17
+ "type": "string"
18
+ },
19
+ {
20
+ "type": "object"
21
+ }
22
+ ]
23
+ },
24
+ "max": {
25
+ "type": "integer"
26
+ },
27
+ "ttl": {
28
+ "type": "number",
29
+ "description": "Milliseconds (cache-manager 5)."
30
+ }
31
+ },
32
+ "additionalProperties": true
33
+ }
34
+ }
35
+ }
36
+ }
37
+ }
38
+ }
package/cell.yml CHANGED
@@ -1,7 +1,6 @@
1
- cell:
2
- cache:
3
- config:
4
- default:
5
- store: memory
6
- max: 100
7
- ttl: 3600 # seconds
1
+ cache:
2
+ config:
3
+ default:
4
+ store: memory
5
+ max: 100
6
+ ttl: 3600 # milliseconds
@@ -32,7 +32,7 @@ let DefaultCacheManagerFactory = class DefaultCacheManagerFactory {
32
32
  }
33
33
  };
34
34
  __decorate([
35
- Value('cell.cache.config'),
35
+ Value('cache.config'),
36
36
  __metadata("design:type", Object)
37
37
  ], DefaultCacheManagerFactory.prototype, "cacheConfig", void 0);
38
38
  __decorate([
@@ -1 +1 @@
1
- {"version":3,"file":"cache-manager-factory.js","sourceRoot":"","sources":["../../src/node/cache-manager-factory.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAgB,mBAAmB,EAAE,iBAAiB,EAA2B,MAAM,kBAAkB,CAAC;AACjH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAG7D,IAAM,0BAA0B,GAAhC,MAAM,0BAA0B;IAQzB,KAAK,CAAC,uBAAuB,CAAC,cAAqB;QACzD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,OAAO,IAAI,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,CAAC,IAAI,GAAG,SAAS;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAEtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAE1D,MAAM,MAAM,GAAU,EAAE,CAAC;QAEzB,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAM,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;QAChH,OAAO,IAAI,sBAAsB,CAAC,YAAY,CAAC,CAAC;IACpD,CAAC;CAEJ,CAAA;AA9BsB;IADlB,KAAK,CAAC,mBAAmB,CAAC;;+DACiD;AAGzD;IADlB,SAAS,CAAC,iBAAiB,CAAC;;qEAC2B;AAN/C,0BAA0B;IADtC,SAAS,CAAC,mBAAmB,CAAC;GAClB,0BAA0B,CAiCtC"}
1
+ {"version":3,"file":"cache-manager-factory.js","sourceRoot":"","sources":["../../src/node/cache-manager-factory.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAgB,mBAAmB,EAAE,iBAAiB,EAA2B,MAAM,kBAAkB,CAAC;AACjH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAG7D,IAAM,0BAA0B,GAAhC,MAAM,0BAA0B;IAQzB,KAAK,CAAC,uBAAuB,CAAC,cAAqB;QACzD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,OAAO,IAAI,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,CAAC,IAAI,GAAG,SAAS;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAEtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAE1D,MAAM,MAAM,GAAU,EAAE,CAAC;QAEzB,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAM,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;QAChH,OAAO,IAAI,sBAAsB,CAAC,YAAY,CAAC,CAAC;IACpD,CAAC;CAEJ,CAAA;AA9BsB;IADlB,KAAK,CAAC,cAAc,CAAC;;+DACsD;AAGzD;IADlB,SAAS,CAAC,iBAAiB,CAAC;;qEAC2B;AAN/C,0BAA0B;IADtC,SAAS,CAAC,mBAAmB,CAAC;GAClB,0BAA0B,CAiCtC"}
@@ -36,7 +36,7 @@ let DefaultCacheManagerFactory = class DefaultCacheManagerFactory {
36
36
  };
37
37
  exports.DefaultCacheManagerFactory = DefaultCacheManagerFactory;
38
38
  __decorate([
39
- (0, core_1.Value)('cell.cache.config'),
39
+ (0, core_1.Value)('cache.config'),
40
40
  __metadata("design:type", Object)
41
41
  ], DefaultCacheManagerFactory.prototype, "cacheConfig", void 0);
42
42
  __decorate([
@@ -1 +1 @@
1
- {"version":3,"file":"cache-manager-factory.js","sourceRoot":"","sources":["../../src/node/cache-manager-factory.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAAsD;AACtD,qDAAiH;AACjH,uCAA2D;AAC3D,yEAAoE;AAG7D,IAAM,0BAA0B,GAAhC,MAAM,0BAA0B;IAQzB,KAAK,CAAC,uBAAuB,CAAC,cAAqB;QACzD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,uBAAO,EAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,OAAO,IAAI,iDAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,IAAA,4BAAY,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,CAAC,IAAI,GAAG,SAAS;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAEtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAE1D,MAAM,MAAM,GAAU,EAAE,CAAC;QAEzB,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,uBAAO,EAAM,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;QAChH,OAAO,IAAI,iDAAsB,CAAC,YAAY,CAAC,CAAC;IACpD,CAAC;CAEJ,CAAA;;AA9BsB;IADlB,IAAA,YAAK,EAAC,mBAAmB,CAAC;;+DACiD;AAGzD;IADlB,IAAA,gBAAS,EAAC,kCAAiB,CAAC;;qEAC2B;qCAN/C,0BAA0B;IADtC,IAAA,gBAAS,EAAC,oCAAmB,CAAC;GAClB,0BAA0B,CAiCtC"}
1
+ {"version":3,"file":"cache-manager-factory.js","sourceRoot":"","sources":["../../src/node/cache-manager-factory.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAAsD;AACtD,qDAAiH;AACjH,uCAA2D;AAC3D,yEAAoE;AAG7D,IAAM,0BAA0B,GAAhC,MAAM,0BAA0B;IAQzB,KAAK,CAAC,uBAAuB,CAAC,cAAqB;QACzD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,uBAAO,EAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,OAAO,IAAI,iDAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,IAAA,4BAAY,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,CAAC,IAAI,GAAG,SAAS;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAEtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAE1D,MAAM,MAAM,GAAU,EAAE,CAAC;QAEzB,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,uBAAO,EAAM,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;QAChH,OAAO,IAAI,iDAAsB,CAAC,YAAY,CAAC,CAAC;IACpD,CAAC;CAEJ,CAAA;;AA9BsB;IADlB,IAAA,YAAK,EAAC,cAAc,CAAC;;+DACsD;AAGzD;IADlB,IAAA,gBAAS,EAAC,kCAAiB,CAAC;;qEAC2B;qCAN/C,0BAA0B;IADtC,IAAA,gBAAS,EAAC,oCAAmB,CAAC;GAClB,0BAA0B,CAiCtC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celljs/cache",
3
- "version": "4.3.0",
3
+ "version": "4.4.0",
4
4
  "description": "cache component for cache-manager",
5
5
  "keywords": [
6
6
  "cell-component"
@@ -23,7 +23,8 @@
23
23
  "lib",
24
24
  "esm",
25
25
  "src",
26
- "cell.yml"
26
+ "cell.yml",
27
+ "cell.schema.json"
27
28
  ],
28
29
  "scripts": {
29
30
  "build": "tsc -b && bun ../../scripts/build-esm.ts",
@@ -32,7 +33,7 @@
32
33
  "watch": "tsc -b -w --preserveWatchOutput"
33
34
  },
34
35
  "dependencies": {
35
- "@celljs/core": "4.3.0",
36
+ "@celljs/core": "4.4.0",
36
37
  "cache-manager": "^5.2.3"
37
38
  },
38
39
  "devDependencies": {
@@ -6,7 +6,7 @@ import { DelegatingCacheManager } from './delegating-cache-manager';
6
6
  @Component(CacheManagerFactory)
7
7
  export class DefaultCacheManagerFactory implements CacheManagerFactory {
8
8
 
9
- @Value('cell.cache.config')
9
+ @Value('cache.config')
10
10
  protected readonly cacheConfig: { [name: string]: CacheStoreFactoryConfig };
11
11
 
12
12
  @Autowired(CacheStoreFactory)