@nestjs-pipeline/cache 0.3.0 → 0.4.1
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 +4 -537
- package/dist/adapters/cache-manager.adapter.js +3 -7
- package/dist/adapters/cache-manager.adapter.js.map +1 -1
- package/dist/cache.behavior.d.ts +2 -2
- package/dist/cache.behavior.d.ts.map +1 -1
- package/dist/cache.behavior.js +23 -26
- package/dist/cache.behavior.js.map +1 -1
- package/dist/cache.module.d.ts +1 -1
- package/dist/cache.module.d.ts.map +1 -1
- package/dist/cache.module.js +20 -23
- package/dist/cache.module.js.map +1 -1
- package/dist/constants/tokens.d.ts +1 -1
- package/dist/constants/tokens.js +4 -7
- package/dist/constants/tokens.js.map +1 -1
- package/dist/errors/missing-partition.error.js +2 -6
- package/dist/errors/missing-partition.error.js.map +1 -1
- package/dist/helpers/build-attributes.d.ts +2 -1
- package/dist/helpers/build-attributes.d.ts.map +1 -1
- package/dist/helpers/build-attributes.js +7 -9
- package/dist/helpers/build-attributes.js.map +1 -1
- package/dist/helpers/cache-factory.d.ts +1 -1
- package/dist/helpers/cache-factory.d.ts.map +1 -1
- package/dist/helpers/cache-factory.js +11 -13
- package/dist/helpers/cache-factory.js.map +1 -1
- package/dist/helpers/cache-key.d.ts +1 -1
- package/dist/helpers/cache-key.d.ts.map +1 -1
- package/dist/helpers/cache-key.js +10 -13
- package/dist/helpers/cache-key.js.map +1 -1
- package/dist/helpers/cache.intent.d.ts +2 -2
- package/dist/helpers/cache.intent.d.ts.map +1 -1
- package/dist/helpers/cache.intent.js +3 -6
- package/dist/helpers/cache.intent.js.map +1 -1
- package/dist/index.d.ts +10 -10
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +9 -27
- package/dist/index.js.map +1 -1
- package/dist/interfaces/cache-options.interface.js +1 -2
- package/dist/interfaces/cache-options.interface.js.map +1 -1
- package/package.json +12 -4
package/dist/cache.behavior.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/* Copyright (C) 2026-present Aristotelis — see repository license. */
|
|
3
2
|
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
4
3
|
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
@@ -13,12 +12,10 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
|
13
12
|
return function (target, key) { decorator(target, key, paramIndex); }
|
|
14
13
|
};
|
|
15
14
|
var CacheBehavior_1;
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
const cache_manager_adapter_1 = require("./adapters/cache-manager.adapter");
|
|
21
|
-
const tokens_1 = require("./constants/tokens");
|
|
15
|
+
import { Inject, Injectable, Logger, Optional, } from '@nestjs/common';
|
|
16
|
+
import { createPipelineItem, LOGGING_BEHAVIOR_LOGGER, PIPELINE_BEHAVIOR_CONTRACT, setPipelineItem, } from '@nestjs-pipeline/core';
|
|
17
|
+
import { CacheManagerAdapter, } from './adapters/cache-manager.adapter.js';
|
|
18
|
+
import { CACHE_DEFAULT_OPTIONS, PIPELINE_CACHE } from './constants/tokens.js';
|
|
22
19
|
/**
|
|
23
20
|
* Unique symbol key set on `context.items` recording whether the request was served from cache (`true` on hit).
|
|
24
21
|
*
|
|
@@ -27,12 +24,12 @@ const tokens_1 = require("./constants/tokens");
|
|
|
27
24
|
* const isHit = context.items.get(CACHE_HIT_ITEM) === true;
|
|
28
25
|
* ```
|
|
29
26
|
*/
|
|
30
|
-
|
|
27
|
+
export const CACHE_HIT_ITEM = Symbol('CACHE_HIT_ITEM');
|
|
31
28
|
/**
|
|
32
29
|
* Typed token for {@link CACHE_HIT_ITEM}: the cache hit flag. Reads and writes the same
|
|
33
30
|
* `context.items` entry through `getPipelineItem` / `requirePipelineItem`.
|
|
34
31
|
*/
|
|
35
|
-
|
|
32
|
+
export const CACHE_HIT_ITEM_TOKEN = createPipelineItem('CACHE_HIT_ITEM', CACHE_HIT_ITEM);
|
|
36
33
|
/**
|
|
37
34
|
* Unique symbol key set on `context.items` recording the resolved cache key string.
|
|
38
35
|
*
|
|
@@ -41,12 +38,12 @@ exports.CACHE_HIT_ITEM_TOKEN = (0, core_1.createPipelineItem)('CACHE_HIT_ITEM',
|
|
|
41
38
|
* const key = context.items.get(CACHE_KEY_ITEM) as string | undefined;
|
|
42
39
|
* ```
|
|
43
40
|
*/
|
|
44
|
-
|
|
41
|
+
export const CACHE_KEY_ITEM = Symbol('CACHE_KEY_ITEM');
|
|
45
42
|
/**
|
|
46
43
|
* Typed token for {@link CACHE_KEY_ITEM}: the resolved cache key. Reads and writes the same
|
|
47
44
|
* `context.items` entry through `getPipelineItem` / `requirePipelineItem`.
|
|
48
45
|
*/
|
|
49
|
-
|
|
46
|
+
export const CACHE_KEY_ITEM_TOKEN = createPipelineItem('CACHE_KEY_ITEM', CACHE_KEY_ITEM);
|
|
50
47
|
const DEFAULT_KINDS = ['query'];
|
|
51
48
|
/** Whether this request kind is configured for caching. */
|
|
52
49
|
function inScope(options, requestKind) {
|
|
@@ -91,7 +88,7 @@ function inScope(options, requestKind) {
|
|
|
91
88
|
*/
|
|
92
89
|
let CacheBehavior = class CacheBehavior {
|
|
93
90
|
static { CacheBehavior_1 = this; }
|
|
94
|
-
static [
|
|
91
|
+
static [PIPELINE_BEHAVIOR_CONTRACT] = {
|
|
95
92
|
order: (context) => {
|
|
96
93
|
const options = context.effectiveOptions;
|
|
97
94
|
if (!inScope(options, context.requestKind)) {
|
|
@@ -136,10 +133,10 @@ let CacheBehavior = class CacheBehavior {
|
|
|
136
133
|
constructor(cache, defaults, logger) {
|
|
137
134
|
this.defaults = defaults ?? {};
|
|
138
135
|
this.cacheAdapter =
|
|
139
|
-
cache instanceof
|
|
136
|
+
cache instanceof CacheManagerAdapter
|
|
140
137
|
? cache
|
|
141
|
-
: new
|
|
142
|
-
this.logger = logger ?? new
|
|
138
|
+
: new CacheManagerAdapter(cache);
|
|
139
|
+
this.logger = logger ?? new Logger();
|
|
143
140
|
}
|
|
144
141
|
async handle(context, next) {
|
|
145
142
|
const options = this.resolveEffectiveOptions(context.getBehaviorOptions(CacheBehavior_1));
|
|
@@ -154,7 +151,7 @@ let CacheBehavior = class CacheBehavior {
|
|
|
154
151
|
'permission scope and request payload. Use createPartitionedCacheKeyFactory(...).');
|
|
155
152
|
}
|
|
156
153
|
const key = options.key(context);
|
|
157
|
-
|
|
154
|
+
setPipelineItem(context, CACHE_KEY_ITEM_TOKEN, key);
|
|
158
155
|
let cached;
|
|
159
156
|
let canWrite = true;
|
|
160
157
|
try {
|
|
@@ -165,11 +162,11 @@ let CacheBehavior = class CacheBehavior {
|
|
|
165
162
|
canWrite = false;
|
|
166
163
|
}
|
|
167
164
|
if (cached !== undefined && cached !== null) {
|
|
168
|
-
|
|
165
|
+
setPipelineItem(context, CACHE_HIT_ITEM_TOKEN, true);
|
|
169
166
|
this.diagnose('debug', `Cache hit for ${context.requestName} (${key})`);
|
|
170
167
|
return cached;
|
|
171
168
|
}
|
|
172
|
-
|
|
169
|
+
setPipelineItem(context, CACHE_HIT_ITEM_TOKEN, false);
|
|
173
170
|
this.diagnose('debug', `Cache miss for ${context.requestName} (${key})`);
|
|
174
171
|
const result = await next();
|
|
175
172
|
if (result === undefined || result === null)
|
|
@@ -216,16 +213,16 @@ let CacheBehavior = class CacheBehavior {
|
|
|
216
213
|
return { ...this.defaults, ...options };
|
|
217
214
|
}
|
|
218
215
|
};
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
(0,
|
|
222
|
-
__param(
|
|
223
|
-
__param(1, (
|
|
224
|
-
__param(
|
|
225
|
-
__param(2, (
|
|
226
|
-
__param(2, (0, common_1.Inject)(core_1.LOGGING_BEHAVIOR_LOGGER)),
|
|
216
|
+
CacheBehavior = CacheBehavior_1 = __decorate([
|
|
217
|
+
Injectable(),
|
|
218
|
+
__param(0, Inject(PIPELINE_CACHE)),
|
|
219
|
+
__param(1, Optional()),
|
|
220
|
+
__param(1, Inject(CACHE_DEFAULT_OPTIONS)),
|
|
221
|
+
__param(2, Optional()),
|
|
222
|
+
__param(2, Inject(LOGGING_BEHAVIOR_LOGGER)),
|
|
227
223
|
__metadata("design:paramtypes", [Object, Object, Object])
|
|
228
224
|
], CacheBehavior);
|
|
225
|
+
export { CacheBehavior };
|
|
229
226
|
/** JSON round-trip of a cacheable result, or `undefined` when it has no JSON form. */
|
|
230
227
|
function toJsonForm(value) {
|
|
231
228
|
try {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cache.behavior.js","sourceRoot":"","sources":["../src/cache.behavior.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"cache.behavior.js","sourceRoot":"","sources":["../src/cache.behavior.ts"],"names":[],"mappings":"AAAA,sEAAsE;;;;;;;;;;;;;;AAEtE,OAAO,EACL,MAAM,EACN,UAAU,EACV,MAAM,EAEN,QAAQ,GACT,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,kBAAkB,EAKlB,uBAAuB,EAEvB,0BAA0B,EAK1B,eAAe,GAChB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,mBAAmB,GAEpB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG9E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAC/B,kBAAkB,CAAU,gBAAgB,EAAE,cAAc,CAAC,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAC/B,kBAAkB,CAAS,gBAAgB,EAAE,cAAc,CAAC,CAAC;AAE/D,MAAM,aAAa,GAA2C,CAAC,OAAO,CAAC,CAAC;AAExE,2DAA2D;AAC3D,SAAS,OAAO,CACd,OAAyC,EACzC,WAA4C;IAE5C,OAAO,CAAC,OAAO,EAAE,KAAK,IAAI,aAAa,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEI,IAAM,aAAa,GAAnB,MAAM,aAAa;;IAKR,AAAhB,MAAM,CAAU,CAAC,0BAA0B,CAAC,GAA8B;QACxE,KAAK,EAAE,CACL,OAA0C,EACH,EAAE;YACzC,MAAM,OAAO,GAAG,OAAO,CAAC,gBAEX,CAAC;YACd,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC3C,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO;gBACL,KAAK,EAAE,CAAC,oCAAoC,EAAE,cAAc,CAAC;aAC9D,CAAC;QACJ,CAAC;QACD,QAAQ,EAAE,CACR,OAA0C,EACA,EAAE;YAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,gBAEX,CAAC;YACd,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC3C,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC;gBAClB,OAAO;oBACL;wBACE,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,YAAY,EAAE,gBAAc,IAAI;wBAChC,OAAO,EAAE,yDAAyD;wBAClE,GAAG,EACD,qEAAqE;4BACrE,wFAAwF;qBAC3F;iBACF,CAAC;YACJ,CAAC;YAED,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;gBACtC,OAAO;oBACL;wBACE,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,YAAY,EAAE,gBAAc,IAAI;wBAChC,OAAO,EAAE,mEAAmE,OAAO,OAAO,CAAC,GAAG,EAAE;wBAChG,GAAG,EAAE,yGAAyG;qBAC/G;iBACF,CAAC;YACJ,CAAC;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;KACF,CAAC;IAEe,MAAM,CAAgB;IACtB,QAAQ,CAAuB;IAC/B,YAAY,CAAiB;IAE9C,YAEE,KAA6B,EAG7B,QAA+B,EAG/B,MAAsB;QAEtB,IAAI,CAAC,QAAQ,GAAG,QAAQ,IAAI,EAAE,CAAC;QAC/B,IAAI,CAAC,YAAY;YACf,KAAK,YAAY,mBAAmB;gBAClC,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,IAAI,mBAAmB,CAAC,KAAc,CAAC,CAAC;QAE9C,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;IACvC,CAAC;IAEK,AAAN,KAAK,CAAC,MAAM,CACV,OAAyB,EACzB,IAAkB;QAElB,MAAM,OAAO,GAAG,IAAI,CAAC,uBAAuB,CAC1C,OAAO,CAAC,kBAAkB,iBAAqC,CAChE,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC;YAAE,OAAO,IAAI,EAAE,CAAC;QAC1D,IAAI,OAAO,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC;YAAE,OAAO,IAAI,EAAE,CAAC;QAEpE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACjB,MAAM,IAAI,SAAS,CACjB,oBAAoB,OAAO,CAAC,WAAW,yCAAyC;gBAC9E,6EAA6E;gBAC7E,8EAA8E;gBAC9E,kFAAkF,CACrF,CAAC;QACJ,CAAC;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACjC,eAAe,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,CAAC,CAAC;QAEpD,IAAI,MAAe,CAAC;QACpB,IAAI,QAAQ,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YAC5D,QAAQ,GAAG,KAAK,CAAC;QACnB,CAAC;QACD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAC5C,eAAe,CAAC,OAAO,EAAE,oBAAoB,EAAE,IAAI,CAAC,CAAC;YACrD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,OAAO,CAAC,WAAW,KAAK,GAAG,GAAG,CAAC,CAAC;YACxE,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,eAAe,CAAC,OAAO,EAAE,oBAAoB,EAAE,KAAK,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,OAAO,CAAC,WAAW,KAAK,GAAG,GAAG,CAAC,CAAC;QAEzE,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QAC5B,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI;YAAE,OAAO,MAAM,CAAC;QAE3D,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,CACX,MAAM,EACN,aAAa,OAAO,CAAC,WAAW,+CAA+C,GAAG,GAAG,CACtF,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;YAC3D,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,oEAAoE;IAC5D,gBAAgB,CACtB,SAA2B,EAC3B,OAAyB,EACzB,GAAW,EACX,KAAc,EACd,OAA6B;QAE7B,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEvE,IAAI,OAAO,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC7B,IAAI,CAAC,QAAQ,CACX,MAAM,EACN,SAAS,SAAS,cAAc,OAAO,CAAC,WAAW,GAAG;gBACpD,SAAS,GAAG,oBAAoB,OAAO,EAAE,CAC5C,CAAC;YACF,OAAO;QACT,CAAC;QAED,IAAI,CAAC,QAAQ,CACX,OAAO,EACP,SAAS,SAAS,cAAc,OAAO,CAAC,WAAW,GAAG;YACpD,SAAS,GAAG,sBAAsB,OAAO,EAAE,CAC9C,CAAC;QACF,MAAM,KAAK,CAAC;IACd,CAAC;IAEO,QAAQ,CAAC,KAAiC,EAAE,OAAe;QACjE,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAc,IAAI,CAAC,CAAC;QACpD,CAAC;QAAC,MAAM,CAAC;YACP,wEAAwE;QAC1E,CAAC;IACH,CAAC;IAED,uEAAuE;IACvE,uBAAuB,CACrB,OAA8B;QAE9B,IAAI,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACnC,OAAO,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;IAC1C,CAAC;CACF,CAAA;AAxLY,aAAa;IADzB,UAAU,EAAE;IA+DR,WAAA,MAAM,CAAC,cAAc,CAAC,CAAA;IAEtB,WAAA,QAAQ,EAAE,CAAA;IACV,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;IAE7B,WAAA,QAAQ,EAAE,CAAA;IACV,WAAA,MAAM,CAAC,uBAAuB,CAAC,CAAA;;GApEvB,aAAa,CAwLzB;;AAED,sFAAsF;AACtF,SAAS,UAAU,CAAC,KAAc;IAChC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC"}
|
package/dist/cache.module.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type DynamicModule } from '@nestjs/common';
|
|
2
|
-
import type { CacheModuleAsyncOptions, CacheModuleOptions } from './interfaces/cache-options.interface';
|
|
2
|
+
import type { CacheModuleAsyncOptions, CacheModuleOptions } from './interfaces/cache-options.interface.js';
|
|
3
3
|
/**
|
|
4
4
|
* NestJS module that builds the shared `cache-manager` instance, registers the
|
|
5
5
|
* {@link CacheBehavior}, and (optionally) application-wide default
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cache.module.d.ts","sourceRoot":"","sources":["../src/cache.module.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,aAAa,EAOnB,MAAM,gBAAgB,CAAC;AASxB,OAAO,KAAK,EAEV,uBAAuB,EACvB,kBAAkB,EACnB,MAAM,
|
|
1
|
+
{"version":3,"file":"cache.module.d.ts","sourceRoot":"","sources":["../src/cache.module.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,aAAa,EAOnB,MAAM,gBAAgB,CAAC;AASxB,OAAO,KAAK,EAEV,uBAAuB,EACvB,kBAAkB,EACnB,MAAM,yCAAyC,CAAC;AAyDjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,qBACa,WAAW;IACtB;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,GAAE,kBAAuB,GAAG,aAAa,CAU9D;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,uBAAuB,GAAG,aAAa,CAYnE;CACF"}
|
package/dist/cache.module.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/* Copyright (C) 2026-present Aristotelis — see repository license. */
|
|
3
2
|
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
4
3
|
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
@@ -13,13 +12,11 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
|
13
12
|
return function (target, key) { decorator(target, key, paramIndex); }
|
|
14
13
|
};
|
|
15
14
|
var CacheModule_1;
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
const
|
|
21
|
-
const cache_factory_1 = require("./helpers/cache-factory");
|
|
22
|
-
const logger = new common_1.Logger('CacheModule');
|
|
15
|
+
import { Inject, Injectable, Logger, Module, } from '@nestjs/common';
|
|
16
|
+
import { CacheBehavior } from './cache.behavior.js';
|
|
17
|
+
import { CACHE_DEFAULT_OPTIONS, CACHE_MODULE_OPTIONS, PIPELINE_CACHE, } from './constants/tokens.js';
|
|
18
|
+
import { buildCache } from './helpers/cache-factory.js';
|
|
19
|
+
const logger = new Logger('CacheModule');
|
|
23
20
|
function storeLabel(options) {
|
|
24
21
|
if (options.cache)
|
|
25
22
|
return 'custom-cache';
|
|
@@ -48,36 +45,36 @@ let CacheConnectionLifecycle = class CacheConnectionLifecycle {
|
|
|
48
45
|
}
|
|
49
46
|
};
|
|
50
47
|
CacheConnectionLifecycle = __decorate([
|
|
51
|
-
|
|
52
|
-
__param(0,
|
|
53
|
-
__param(1,
|
|
48
|
+
Injectable(),
|
|
49
|
+
__param(0, Inject(PIPELINE_CACHE)),
|
|
50
|
+
__param(1, Inject(CACHE_MODULE_OPTIONS)),
|
|
54
51
|
__metadata("design:paramtypes", [Object, Object])
|
|
55
52
|
], CacheConnectionLifecycle);
|
|
56
53
|
function cacheProviders(optionsProvider) {
|
|
57
54
|
return [
|
|
58
55
|
optionsProvider,
|
|
59
|
-
|
|
56
|
+
CacheBehavior,
|
|
60
57
|
{
|
|
61
|
-
provide:
|
|
58
|
+
provide: PIPELINE_CACHE,
|
|
62
59
|
useFactory: (options) => {
|
|
63
|
-
const cache =
|
|
60
|
+
const cache = buildCache(options);
|
|
64
61
|
logger.log(`Initialized cache with [${storeLabel(options)}] store`);
|
|
65
62
|
return cache;
|
|
66
63
|
},
|
|
67
|
-
inject: [
|
|
64
|
+
inject: [CACHE_MODULE_OPTIONS],
|
|
68
65
|
},
|
|
69
66
|
{
|
|
70
|
-
provide:
|
|
67
|
+
provide: CACHE_DEFAULT_OPTIONS,
|
|
71
68
|
useFactory: (options) => ({
|
|
72
69
|
...(options.ttl !== undefined ? { ttl: options.ttl } : {}),
|
|
73
70
|
...options.defaults,
|
|
74
71
|
}),
|
|
75
|
-
inject: [
|
|
72
|
+
inject: [CACHE_MODULE_OPTIONS],
|
|
76
73
|
},
|
|
77
74
|
CacheConnectionLifecycle,
|
|
78
75
|
];
|
|
79
76
|
}
|
|
80
|
-
const CACHE_EXPORTS = [
|
|
77
|
+
const CACHE_EXPORTS = [CacheBehavior, PIPELINE_CACHE, CACHE_DEFAULT_OPTIONS];
|
|
81
78
|
/**
|
|
82
79
|
* NestJS module that builds the shared `cache-manager` instance, registers the
|
|
83
80
|
* {@link CacheBehavior}, and (optionally) application-wide default
|
|
@@ -147,7 +144,7 @@ let CacheModule = CacheModule_1 = class CacheModule {
|
|
|
147
144
|
module: CacheModule_1,
|
|
148
145
|
global: true,
|
|
149
146
|
providers: cacheProviders({
|
|
150
|
-
provide:
|
|
147
|
+
provide: CACHE_MODULE_OPTIONS,
|
|
151
148
|
useValue: options,
|
|
152
149
|
}),
|
|
153
150
|
exports: CACHE_EXPORTS,
|
|
@@ -174,7 +171,7 @@ let CacheModule = CacheModule_1 = class CacheModule {
|
|
|
174
171
|
global: true,
|
|
175
172
|
imports: options.imports ?? [],
|
|
176
173
|
providers: cacheProviders({
|
|
177
|
-
provide:
|
|
174
|
+
provide: CACHE_MODULE_OPTIONS,
|
|
178
175
|
useFactory: options.useFactory,
|
|
179
176
|
inject: options.inject ?? [],
|
|
180
177
|
}),
|
|
@@ -182,8 +179,8 @@ let CacheModule = CacheModule_1 = class CacheModule {
|
|
|
182
179
|
};
|
|
183
180
|
}
|
|
184
181
|
};
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
(0, common_1.Module)({})
|
|
182
|
+
CacheModule = CacheModule_1 = __decorate([
|
|
183
|
+
Module({})
|
|
188
184
|
], CacheModule);
|
|
185
|
+
export { CacheModule };
|
|
189
186
|
//# sourceMappingURL=cache.module.js.map
|
package/dist/cache.module.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cache.module.js","sourceRoot":"","sources":["../src/cache.module.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"cache.module.js","sourceRoot":"","sources":["../src/cache.module.ts"],"names":[],"mappings":"AAAA,sEAAsE;;;;;;;;;;;;;;AAEtE,OAAO,EAEL,MAAM,EACN,UAAU,EACV,MAAM,EACN,MAAM,GAGP,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,GACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAOxD,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC;AAEzC,SAAS,UAAU,CAAC,OAA2B;IAC7C,IAAI,OAAO,CAAC,KAAK;QAAE,OAAO,cAAc,CAAC;IACzC,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,eAAe,CAAC;IACxE,IAAI,CAAC,OAAO,CAAC,KAAK;QAAE,OAAO,QAAQ,CAAC;IACpC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;QACjC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAC7C,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;AACzB,CAAC;AAED,mFAAmF;AACnF,SAAS,SAAS,CAAC,OAA2B;IAC5C,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED,IACM,wBAAwB,GAD9B,MACM,wBAAwB;IAEe,KAAK;IACC,OAAO;IAFxD,YAC2C,KAAY,EACN,OAA2B;qBADjC,KAAK;uBACC,OAAO;IACrD,CAAC;IAEJ,KAAK,CAAC,qBAAqB;QACzB,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC;YAAE,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;IAC7D,CAAC;CACF,CAAA;AATK,wBAAwB;IAD7B,UAAU,EAAE;IAGR,WAAA,MAAM,CAAC,cAAc,CAAC,CAAA;IACtB,WAAA,MAAM,CAAC,oBAAoB,CAAC,CAAA;;GAH3B,wBAAwB,CAS7B;AAED,SAAS,cAAc,CAAC,eAAyB;IAC/C,OAAO;QACL,eAAe;QACf,aAAa;QACb;YACE,OAAO,EAAE,cAAc;YACvB,UAAU,EAAE,CAAC,OAA2B,EAAE,EAAE;gBAC1C,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;gBAClC,MAAM,CAAC,GAAG,CAAC,2BAA2B,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBACpE,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,EAAE,CAAC,oBAAoB,CAAC;SAC/B;QACD;YACE,OAAO,EAAE,qBAAqB;YAC9B,UAAU,EAAE,CAAC,OAA2B,EAAwB,EAAE,CAAC,CAAC;gBAClE,GAAG,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC1D,GAAG,OAAO,CAAC,QAAQ;aACpB,CAAC;YACF,MAAM,EAAE,CAAC,oBAAoB,CAAC;SAC/B;QACD,wBAAwB;KACzB,CAAC;AACJ,CAAC;AAED,MAAM,aAAa,GAAG,CAAC,aAAa,EAAE,cAAc,EAAE,qBAAqB,CAAC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AAEI,IAAM,WAAW,mBAAjB,MAAM,WAAW;IACtB;;;;;;OAMG;IACI,AAAP,MAAM,CAAC,OAAO,CAAC,OAAO,GAAuB,EAAE;QAC7C,OAAO;YACL,MAAM,eAAa;YACnB,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE,cAAc,CAAC;gBACxB,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,OAAO;aAClB,CAAC;YACF,OAAO,EAAE,aAAa;SACvB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,AAAP,MAAM,CAAC,YAAY,CAAC,OAAgC;QAClD,OAAO;YACL,MAAM,eAAa;YACnB,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,SAAS,EAAE,cAAc,CAAC;gBACxB,OAAO,EAAE,oBAAoB;gBAC7B,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;aAC7B,CAAC;YACF,OAAO,EAAE,aAAa;SACvB,CAAC;IACJ,CAAC;CACF,CAAA;AAhDY,WAAW;IADvB,MAAM,CAAC,EAAE,CAAC;GACE,WAAW,CAgDvB"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Injection token holding the shared `cache-manager`
|
|
2
|
+
* Injection token holding the shared `cache-manager` `Cache`
|
|
3
3
|
* instance built by {@link CacheModule.forRoot} or {@link CacheModule.forRootAsync}.
|
|
4
4
|
*/
|
|
5
5
|
export declare const PIPELINE_CACHE: unique symbol;
|
package/dist/constants/tokens.js
CHANGED
|
@@ -1,17 +1,14 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/* Copyright (C) 2026-present Aristotelis — see repository license. */
|
|
3
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.CACHE_MODULE_OPTIONS = exports.CACHE_DEFAULT_OPTIONS = exports.PIPELINE_CACHE = void 0;
|
|
5
2
|
/**
|
|
6
|
-
* Injection token holding the shared `cache-manager`
|
|
3
|
+
* Injection token holding the shared `cache-manager` `Cache`
|
|
7
4
|
* instance built by {@link CacheModule.forRoot} or {@link CacheModule.forRootAsync}.
|
|
8
5
|
*/
|
|
9
|
-
|
|
6
|
+
export const PIPELINE_CACHE = Symbol('PIPELINE_CACHE');
|
|
10
7
|
/**
|
|
11
8
|
* Injection token holding the module-wide default {@link CacheBehaviorOptions}
|
|
12
9
|
* merged into every handler's per-pipeline configuration.
|
|
13
10
|
*/
|
|
14
|
-
|
|
11
|
+
export const CACHE_DEFAULT_OPTIONS = Symbol('CACHE_DEFAULT_OPTIONS');
|
|
15
12
|
/** Injection token holding the resolved {@link CacheModuleOptions}. @internal */
|
|
16
|
-
|
|
13
|
+
export const CACHE_MODULE_OPTIONS = Symbol('CACHE_MODULE_OPTIONS');
|
|
17
14
|
//# sourceMappingURL=tokens.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../src/constants/tokens.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../src/constants/tokens.ts"],"names":[],"mappings":"AAAA,sEAAsE;AAEtE;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,uBAAuB,CAAC,CAAC;AAErE,iFAAiF;AACjF,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC"}
|
|
@@ -1,8 +1,5 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/* Copyright (C) 2026-present Aristotelis — see repository license. */
|
|
3
|
-
|
|
4
|
-
exports.MissingCachePartitionError = void 0;
|
|
5
|
-
const core_1 = require("@nestjs-pipeline/core");
|
|
2
|
+
import { MissingPartitionError } from '@nestjs-pipeline/core';
|
|
6
3
|
/**
|
|
7
4
|
* Raised before the cache is consulted when a dimension required by the
|
|
8
5
|
* configured key factory cannot be resolved.
|
|
@@ -13,11 +10,10 @@ const core_1 = require("@nestjs-pipeline/core");
|
|
|
13
10
|
* not merely lose isolation — it can replay one caller's authorized response to
|
|
14
11
|
* another.
|
|
15
12
|
*/
|
|
16
|
-
class MissingCachePartitionError extends
|
|
13
|
+
export class MissingCachePartitionError extends MissingPartitionError {
|
|
17
14
|
name = 'MissingCachePartitionError';
|
|
18
15
|
constructor(requestName, dimension, remedy) {
|
|
19
16
|
super('Cache', requestName, dimension, remedy);
|
|
20
17
|
}
|
|
21
18
|
}
|
|
22
|
-
exports.MissingCachePartitionError = MissingCachePartitionError;
|
|
23
19
|
//# sourceMappingURL=missing-partition.error.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"missing-partition.error.js","sourceRoot":"","sources":["../../src/errors/missing-partition.error.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"missing-partition.error.js","sourceRoot":"","sources":["../../src/errors/missing-partition.error.ts"],"names":[],"mappings":"AAAA,sEAAsE;AAEtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAK9D;;;;;;;;;GASG;AACH,MAAM,OAAO,0BAA2B,SAAQ,qBAA8C;IAC1E,IAAI,GAAG,4BAA4B,CAAC;IAEtD,YACE,WAAmB,EACnB,SAAkC,EAClC,MAAc;QAEd,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;CACF"}
|
|
@@ -12,7 +12,8 @@ import { type IPipelineContext } from '@nestjs-pipeline/core';
|
|
|
12
12
|
* @param context - The pipeline execution, read after `CacheBehavior` ran.
|
|
13
13
|
* @returns The attributes; empty when the behavior did not run.
|
|
14
14
|
*
|
|
15
|
-
* @example Span attributes
|
|
15
|
+
* @example Span attributes
|
|
16
|
+
* With `AttributesBehavior` of `@nestjs-pipeline/opentelemetry`:
|
|
16
17
|
* ```ts
|
|
17
18
|
* PipelineModule.forRoot({
|
|
18
19
|
* globalBehaviors: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build-attributes.d.ts","sourceRoot":"","sources":["../../src/helpers/build-attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,KAAK,gBAAgB,EACtB,MAAM,uBAAuB,CAAC;AAG/B
|
|
1
|
+
{"version":3,"file":"build-attributes.d.ts","sourceRoot":"","sources":["../../src/helpers/build-attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,KAAK,gBAAgB,EACtB,MAAM,uBAAuB,CAAC;AAG/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,gBAAgB,GACxB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAIzB"}
|
|
@@ -1,9 +1,6 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/* Copyright (C) 2026-present Aristotelis — see repository license. */
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
const core_1 = require("@nestjs-pipeline/core");
|
|
6
|
-
const cache_behavior_1 = require("../cache.behavior");
|
|
2
|
+
import { getPipelineItem, hasPipelineItem, } from '@nestjs-pipeline/core';
|
|
3
|
+
import { CACHE_HIT_ITEM_TOKEN } from '../cache.behavior.js';
|
|
7
4
|
/**
|
|
8
5
|
* The cache decision of one execution as flat attributes:
|
|
9
6
|
* `{ 'cache.hit': boolean }` once `CacheBehavior` looked the response up, and
|
|
@@ -17,7 +14,8 @@ const cache_behavior_1 = require("../cache.behavior");
|
|
|
17
14
|
* @param context - The pipeline execution, read after `CacheBehavior` ran.
|
|
18
15
|
* @returns The attributes; empty when the behavior did not run.
|
|
19
16
|
*
|
|
20
|
-
* @example Span attributes
|
|
17
|
+
* @example Span attributes
|
|
18
|
+
* With `AttributesBehavior` of `@nestjs-pipeline/opentelemetry`:
|
|
21
19
|
* ```ts
|
|
22
20
|
* PipelineModule.forRoot({
|
|
23
21
|
* globalBehaviors: {
|
|
@@ -37,9 +35,9 @@ const cache_behavior_1 = require("../cache.behavior");
|
|
|
37
35
|
* }
|
|
38
36
|
* ```
|
|
39
37
|
*/
|
|
40
|
-
function buildCacheAttributes(context) {
|
|
41
|
-
return
|
|
42
|
-
? { 'cache.hit':
|
|
38
|
+
export function buildCacheAttributes(context) {
|
|
39
|
+
return hasPipelineItem(context, CACHE_HIT_ITEM_TOKEN)
|
|
40
|
+
? { 'cache.hit': getPipelineItem(context, CACHE_HIT_ITEM_TOKEN) === true }
|
|
43
41
|
: {};
|
|
44
42
|
}
|
|
45
43
|
//# sourceMappingURL=build-attributes.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build-attributes.js","sourceRoot":"","sources":["../../src/helpers/build-attributes.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"build-attributes.js","sourceRoot":"","sources":["../../src/helpers/build-attributes.ts"],"names":[],"mappings":"AAAA,sEAAsE;AAEtE,OAAO,EACL,eAAe,EACf,eAAe,GAEhB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,UAAU,oBAAoB,CAClC,OAAyB;IAEzB,OAAO,eAAe,CAAC,OAAO,EAAE,oBAAoB,CAAC;QACnD,CAAC,CAAC,EAAE,WAAW,EAAE,eAAe,CAAC,OAAO,EAAE,oBAAoB,CAAC,KAAK,IAAI,EAAE;QAC1E,CAAC,CAAC,EAAE,CAAC;AACT,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type Cache } from 'cache-manager';
|
|
2
2
|
import { Keyv } from 'keyv';
|
|
3
|
-
import type { CacheModuleOptions, CacheStoreConfig } from '../interfaces/cache-options.interface';
|
|
3
|
+
import type { CacheModuleOptions, CacheStoreConfig } from '../interfaces/cache-options.interface.js';
|
|
4
4
|
/**
|
|
5
5
|
* Build a single package-owned `Keyv` instance from a declarative store
|
|
6
6
|
* configuration. Package-owned stores enable `throwOnErrors` so
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cache-factory.d.ts","sourceRoot":"","sources":["../../src/helpers/cache-factory.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"cache-factory.d.ts","sourceRoot":"","sources":["../../src/helpers/cache-factory.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,KAAK,EAAe,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,IAAI,EAAyB,MAAM,MAAM,CAAC;AACnD,OAAO,KAAK,EACV,kBAAkB,EAClB,gBAAgB,EAEjB,MAAM,0CAA0C,CAAC;AAqGlD;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAexD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,KAAK,CAsB7D"}
|
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/* Copyright (C) 2026-present Aristotelis — see repository license. */
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
const
|
|
7
|
-
const keyv_1 = require("keyv");
|
|
2
|
+
import { createRequire } from 'node:module';
|
|
3
|
+
import { createCache } from 'cache-manager';
|
|
4
|
+
import { Keyv } from 'keyv';
|
|
5
|
+
const load = createRequire(import.meta.url);
|
|
8
6
|
/** Maps declarative store types to their optional `@keyv/*` adapter package. */
|
|
9
7
|
const ADAPTER_PACKAGES = {
|
|
10
8
|
redis: '@keyv/redis',
|
|
@@ -51,7 +49,7 @@ function isNativeBindingFailure(error) {
|
|
|
51
49
|
function requireAdapter(pkg) {
|
|
52
50
|
let mod;
|
|
53
51
|
try {
|
|
54
|
-
mod =
|
|
52
|
+
mod = load(pkg);
|
|
55
53
|
}
|
|
56
54
|
catch (error) {
|
|
57
55
|
if (isRequestedModuleMissing(error, pkg)) {
|
|
@@ -84,15 +82,15 @@ function createAdapterStore(config) {
|
|
|
84
82
|
* {@link CacheBehavior} can apply its own `failOpen` / fail-closed policy rather
|
|
85
83
|
* than having Keyv silently consume backend failures first.
|
|
86
84
|
*/
|
|
87
|
-
function buildKeyv(config) {
|
|
85
|
+
export function buildKeyv(config) {
|
|
88
86
|
if (config.type === 'memory') {
|
|
89
|
-
return new
|
|
87
|
+
return new Keyv({
|
|
90
88
|
namespace: config.namespace,
|
|
91
89
|
ttl: config.ttl,
|
|
92
90
|
throwOnErrors: true,
|
|
93
91
|
});
|
|
94
92
|
}
|
|
95
|
-
return new
|
|
93
|
+
return new Keyv({
|
|
96
94
|
store: createAdapterStore(config),
|
|
97
95
|
namespace: config.namespace,
|
|
98
96
|
ttl: config.ttl,
|
|
@@ -126,7 +124,7 @@ function buildKeyv(config) {
|
|
|
126
124
|
* // buildCache() will not mutate shared.throwOnErrors.
|
|
127
125
|
* ```
|
|
128
126
|
*/
|
|
129
|
-
function buildCache(options) {
|
|
127
|
+
export function buildCache(options) {
|
|
130
128
|
if (options.cache) {
|
|
131
129
|
return options.cache;
|
|
132
130
|
}
|
|
@@ -141,9 +139,9 @@ function buildCache(options) {
|
|
|
141
139
|
stores = configs.map(buildKeyv);
|
|
142
140
|
}
|
|
143
141
|
else {
|
|
144
|
-
stores = [new
|
|
142
|
+
stores = [new Keyv({ throwOnErrors: true })];
|
|
145
143
|
}
|
|
146
|
-
return
|
|
144
|
+
return createCache({
|
|
147
145
|
stores,
|
|
148
146
|
ttl: options.ttl,
|
|
149
147
|
nonBlocking: options.nonBlocking,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cache-factory.js","sourceRoot":"","sources":["../../src/helpers/cache-factory.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"cache-factory.js","sourceRoot":"","sources":["../../src/helpers/cache-factory.ts"],"names":[],"mappings":"AAAA,sEAAsE;AAEtE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAc,WAAW,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,IAAI,EAAyB,MAAM,MAAM,CAAC;AASnD,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AAE5C,gFAAgF;AAChF,MAAM,gBAAgB,GAAsD;IAC1E,KAAK,EAAE,aAAa;IACpB,QAAQ,EAAE,gBAAgB;IAC1B,MAAM,EAAE,cAAc;IACtB,QAAQ,EAAE,gBAAgB;CAC3B,CAAC;AAEF;;;;;;;GAOG;AACH,SAAS,wBAAwB,CAAC,KAAc,EAAE,GAAW;IAC3D,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAK,KAAoC,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;QACtE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,GAAG,GAAG,CAAC;QACrD,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,GAAG,GAAG,CAAC,CACtD,CAAC;AACJ,CAAC;AAED,mFAAmF;AACnF,SAAS,sBAAsB,CAAC,KAAc;IAC5C,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC5C,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;QACvC,KAAK,CAAC,OAAO,CAAC,QAAQ,CACpB,kDAAkD,CACnD;QACD,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAC7C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,cAAc,CAAC,GAAW;IACjC,IAAI,GAA0D,CAAC;IAC/D,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,CAAC,GAAG,CAA0D,CAAC;IAC3E,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,wBAAwB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CACb,kCAAkC,GAAG,wEAAwE,GAAG,EAAE,EAClH,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ,CAAC;QAED,IAAI,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CACb,qBAAqB,GAAG,6DAA6D;gBACnF,kEAAkE,GAAG,kDAAkD,EACzH,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ,CAAC;QAED,oEAAoE;QACpE,2EAA2E;QAC3E,+BAA+B;QAC/B,MAAM,KAAK,CAAC;IACd,CAAC;IACD,OAAO,CACJ,GAAwC,CAAC,OAAO;QAChD,GAA0B,CAC5B,CAAC;AACJ,CAAC;AAED,2EAA2E;AAC3E,SAAS,kBAAkB,CAAC,MAAwB;IAClD,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IACtC,MAAM,OAAO,GAAG,cAAc,CAC5B,gBAAgB,CAAC,IAAyC,CAAC,CAC5D,CAAC;IAEF,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACxB,OAAO,IAAI,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,MAAwB;IAChD,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,IAAI,CAAC;YACd,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,aAAa,EAAE,IAAI;SACpB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,IAAI,CAAC;QACd,KAAK,EAAE,kBAAkB,CAAC,MAAM,CAAC;QACjC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,aAAa,EAAE,IAAI;KACpB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,UAAU,CAAC,OAA2B;IACpD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,OAAO,OAAO,CAAC,KAAK,CAAC;IACvB,CAAC;IAED,IAAI,MAAc,CAAC;IACnB,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC1B,CAAC;SAAM,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;YAC1C,CAAC,CAAC,OAAO,CAAC,KAAK;YACf,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpB,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,WAAW,CAAC;QACjB,MAAM;QACN,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type IPipelineContext, type TenantPartitionOptions } from '@nestjs-pipeline/core';
|
|
2
|
-
import type { CacheKeyFactory } from '../interfaces/cache-options.interface';
|
|
2
|
+
import type { CacheKeyFactory } from '../interfaces/cache-options.interface.js';
|
|
3
3
|
/** Options for {@link createPartitionedCacheKeyFactory}. */
|
|
4
4
|
export interface PartitionedCacheKeyOptions extends TenantPartitionOptions {
|
|
5
5
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cache-key.d.ts","sourceRoot":"","sources":["../../src/helpers/cache-key.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAE5B,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"cache-key.d.ts","sourceRoot":"","sources":["../../src/helpers/cache-key.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAE5B,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAKhF,4DAA4D;AAC5D,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACxE;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,MAAM,GAAG,SAAS,CAAC;IAE7D;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,MAAM,GAAG,SAAS,CAAC;IAE1D;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,gCAAgC,CAC9C,OAAO,EAAE,0BAA0B,GAClC,eAAe,CAuDjB"}
|
|
@@ -1,16 +1,13 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/* Copyright (C) 2026-present Aristotelis — see repository license. */
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
const core_1 = require("@nestjs-pipeline/core");
|
|
8
|
-
const missing_partition_error_1 = require("../errors/missing-partition.error");
|
|
2
|
+
import { createHash } from 'node:crypto';
|
|
3
|
+
import { joinKeySegments, stableStringify } from '@cqrs-ddd/safe-stringify';
|
|
4
|
+
import { tenantSegments, } from '@nestjs-pipeline/core';
|
|
5
|
+
import { MissingCachePartitionError } from '../errors/missing-partition.error.js';
|
|
9
6
|
/** Key format version. Bump to make a format change produce a cold cache. */
|
|
10
7
|
const KEY_VERSION = 'v3';
|
|
11
8
|
/** Deterministic digest of the request payload, so secrets stay out of key listings. */
|
|
12
9
|
function digestRequest(request) {
|
|
13
|
-
return
|
|
10
|
+
return createHash('sha256').update(stableStringify(request)).digest('hex');
|
|
14
11
|
}
|
|
15
12
|
/**
|
|
16
13
|
* Builds a cache key that partitions every dimension capable of changing an
|
|
@@ -51,7 +48,7 @@ function digestRequest(request) {
|
|
|
51
48
|
* });
|
|
52
49
|
* ```
|
|
53
50
|
*/
|
|
54
|
-
function createPartitionedCacheKeyFactory(options) {
|
|
51
|
+
export function createPartitionedCacheKeyFactory(options) {
|
|
55
52
|
const requirePrincipal = options.requirePrincipal ?? true;
|
|
56
53
|
const requireScope = options.requireScope ?? true;
|
|
57
54
|
if (requireScope && !options.scope) {
|
|
@@ -61,11 +58,11 @@ function createPartitionedCacheKeyFactory(options) {
|
|
|
61
58
|
"on the caller's permissions.");
|
|
62
59
|
}
|
|
63
60
|
return (context) => {
|
|
64
|
-
const tenant =
|
|
61
|
+
const tenant = tenantSegments(context, options, MissingCachePartitionError);
|
|
65
62
|
const resolvedPrincipal = options.principal(context);
|
|
66
63
|
const principal = typeof resolvedPrincipal === 'string' ? resolvedPrincipal.trim() : '';
|
|
67
64
|
if (requirePrincipal && !principal) {
|
|
68
|
-
throw new
|
|
65
|
+
throw new MissingCachePartitionError(context.requestName, 'principal', 'A cache hit skips the handler and therefore its entity-level ' +
|
|
69
66
|
'authorization. Return the authenticated principal, or pass ' +
|
|
70
67
|
'requirePrincipal: false for a genuinely public response.');
|
|
71
68
|
}
|
|
@@ -74,11 +71,11 @@ function createPartitionedCacheKeyFactory(options) {
|
|
|
74
71
|
? resolvedScope.trim()
|
|
75
72
|
: undefined;
|
|
76
73
|
if (requireScope && !scope) {
|
|
77
|
-
throw new
|
|
74
|
+
throw new MissingCachePartitionError(context.requestName, 'scope', 'A cache hit skips the handler and therefore its entity-level ' +
|
|
78
75
|
'authorization. Return the authorization scope, or pass ' +
|
|
79
76
|
'requireScope: false when responses are scope-independent.');
|
|
80
77
|
}
|
|
81
|
-
return
|
|
78
|
+
return joinKeySegments([
|
|
82
79
|
'cache',
|
|
83
80
|
KEY_VERSION,
|
|
84
81
|
...tenant,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cache-key.js","sourceRoot":"","sources":["../../src/helpers/cache-key.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"cache-key.js","sourceRoot":"","sources":["../../src/helpers/cache-key.ts"],"names":[],"mappings":"AAAA,sEAAsE;AAEtE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC5E,OAAO,EAGL,cAAc,GACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,0BAA0B,EAAE,MAAM,sCAAsC,CAAC;AAGlF,6EAA6E;AAC7E,MAAM,WAAW,GAAG,IAAI,CAAC;AA0CzB,wFAAwF;AACxF,SAAS,aAAa,CAAC,OAAgB;IACrC,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,UAAU,gCAAgC,CAC9C,OAAmC;IAEnC,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,IAAI,IAAI,CAAC;IAC1D,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC;IAClD,IAAI,YAAY,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACnC,MAAM,IAAI,SAAS,CACjB,4EAA4E;YAC1E,4EAA4E;YAC5E,2EAA2E;YAC3E,8BAA8B,CACjC,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,OAAO,EAAE,EAAE;QACjB,MAAM,MAAM,GAAG,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC;QAE5E,MAAM,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACrD,MAAM,SAAS,GACb,OAAO,iBAAiB,KAAK,QAAQ,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAExE,IAAI,gBAAgB,IAAI,CAAC,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,0BAA0B,CAClC,OAAO,CAAC,WAAW,EACnB,WAAW,EACX,+DAA+D;gBAC7D,6DAA6D;gBAC7D,0DAA0D,CAC7D,CAAC;QACJ,CAAC;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,KAAK,GACT,OAAO,aAAa,KAAK,QAAQ,IAAI,aAAa,CAAC,IAAI,EAAE;YACvD,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE;YACtB,CAAC,CAAC,SAAS,CAAC;QAEhB,IAAI,YAAY,IAAI,CAAC,KAAK,EAAE,CAAC;YAC3B,MAAM,IAAI,0BAA0B,CAClC,OAAO,CAAC,WAAW,EACnB,OAAO,EACP,+DAA+D;gBAC7D,yDAAyD;gBACzD,2DAA2D,CAC9D,CAAC;QACJ,CAAC;QAED,OAAO,eAAe,CAAC;YACrB,OAAO;YACP,WAAW;YACX,GAAG,MAAM;YACT,SAAS,IAAI,SAAS;YACtB,KAAK;YACL,OAAO,CAAC,WAAW;YACnB,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC;SAC/B,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { PipelineBehaviorTuple } from '@nestjs-pipeline/core';
|
|
2
|
-
import { CacheBehavior } from '../cache.behavior';
|
|
3
|
-
import type { CacheBehaviorOptions } from '../interfaces/cache-options.interface';
|
|
2
|
+
import { CacheBehavior } from '../cache.behavior.js';
|
|
3
|
+
import type { CacheBehaviorOptions } from '../interfaces/cache-options.interface.js';
|
|
4
4
|
export type CacheIntentOptions = Omit<CacheBehaviorOptions, 'key'> & ({
|
|
5
5
|
key: NonNullable<CacheBehaviorOptions['key']>;
|
|
6
6
|
inheritModuleKey?: never;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cache.intent.d.ts","sourceRoot":"","sources":["../../src/helpers/cache.intent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"cache.intent.d.ts","sourceRoot":"","sources":["../../src/helpers/cache.intent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AAErF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,GAChE,CACI;IACE,GAAG,EAAE,WAAW,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9C,gBAAgB,CAAC,EAAE,KAAK,CAAC;CAC1B,GACD;IAAE,gBAAgB,EAAE,IAAI,CAAC;IAAC,GAAG,CAAC,EAAE,KAAK,CAAA;CAAE,CAC1C,CAAC;AAEJ;;;;;;;;;;;;;GAaG;AACH,wBAAgB,KAAK,CACnB,OAAO,EAAE,kBAAkB,GAC1B,qBAAqB,CAAC,aAAa,EAAE,oBAAoB,CAAC,CAG5D"}
|