@keq-request/cache 5.0.0-alpha.10

package/CHANGELOG.md

@@ -0,0 +1,166 @@
+# Changelog
+
+## 5.0.0-alpha.10
+
+### Patch Changes
+
+- e7eb9dc: Don't publish .turbo and jest.config.cts to npm
+- 7343445: Incorrect build before release
+- Updated dependencies [e7eb9dc]
+- Updated dependencies [7343445]
+  - keq@5.0.0-alpha.10
+
+## 5.0.0-alpha.9
+
+### Patch Changes
+
+- 2686b8d: build with burbo
+- 2686b8d: remove private dependencies
+- Updated dependencies [2686b8d]
+- Updated dependencies [2686b8d]
+  - keq@5.0.0-alpha.9
+
+## 5.0.0-alpha.8
+
+### Patch Changes
+
+- 0873c7e: Incorrect build before release.
+- Updated dependencies [0873c7e]
+  - keq@5.0.0-alpha.8
+
+## 5.0.0-alpha.7
+
+### Major Changes
+
+- 5175097: **BREAKING CHANGE:** group all packages under the @keq-request scope
+
+  - keq-cache => @keq-request/cache
+  - keq-headers => @keq-request/headers
+  - keq-cli => @keq-request/cli
+  - keq-url => @keq-request/url
+  - keq-exception => @keq-request/exception
+
+- 153244f: **BREAKING CHANGE:** `onNetworkResponse` has been removed, please use `.on('cache:update', callback)` instead.
+
+### Minor Changes
+
+- 153244f: **Feat:** Add `onCacheGet`, `onCacheSet`, `onCacheRemove`, `onCacheEvict` and `onCacheExpired` hook for `MemoryStorage` and `IndexedDBStorage`.
+- 153244f: **Feat:** Add `cache:hit`, `cache:miss` and `cache:update` to keq events.
+
+### Patch Changes
+
+- 153244f: **Feat:** `pattern` accept boolean and defaults to true
+- 153244f: **Fix:** unable to cache modified `ctx.res`.
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [7ff2162]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+- Updated dependencies [153244f]
+  - keq@5.0.0-alpha.7
+
+## [2.1.1](https://github.com/keq-request/keq-cache/compare/v2.1.0...v2.1.1) (2025-07-11)
+
+### Bug Fixes
+
+- missing .js ext ([609631a](https://github.com/keq-request/keq-cache/commit/609631af7334fa41f42b9607137c61be1435e29e))
+
+## [2.1.0](https://github.com/keq-request/keq-cache/compare/v2.0.0...v2.1.0) (2025-07-03)
+
+### Features
+
+- add MultiTierStorage ([07a293b](https://github.com/keq-request/keq-cache/commit/07a293b75689c33ee05f31bd3446856244f83aa4))
+- add TierStorage ([02ceb48](https://github.com/keq-request/keq-cache/commit/02ceb4885f8a413fddd9fa732c0a2223a809b1f5))
+- custom strategy ([3053306](https://github.com/keq-request/keq-cache/commit/3053306cfa408b9ed72a1d5fbbb9d4bbdfe7e816))
+
+### Bug Fixes
+
+- wrong class name ([91989ea](https://github.com/keq-request/keq-cache/commit/91989eaeb1241d16128f08351f95b7b1b1c9fd22))
+
+## [2.0.0](https://github.com/keq-request/keq-cache/compare/v1.2.2...v2.0.0) (2025-05-26)
+
+### ⚠ BREAKING CHANGES
+
+- maxStorageSize and threshold is removed, please use size parameter of Storage
+
+### Features
+
+- custom storage support ([bebd310](https://github.com/keq-request/keq-cache/commit/bebd3106c735fcb5b12142a3d1c19025806a2098))
+
+### Bug Fixes
+
+- memory storage does not specify the isolation scope ([99da6d7](https://github.com/keq-request/keq-cache/commit/99da6d7c23b2b91eb12075195a5d55ae1021fab0))
+
+## [1.2.2](https://github.com/keq-request/keq-cache/compare/v1.2.1...v1.2.2) (2025-04-27)
+
+### Performance Improvements
+
+- skip cache if indexed-db not work ([45ccbd8](https://github.com/keq-request/keq-cache/commit/45ccbd8d42ce7bf14fc03f98b7a8ce162c61e43d)), closes [#10](https://github.com/keq-request/keq-cache/issues/10)
+
+## [1.2.1](https://github.com/keq-request/keq-cache/compare/v1.2.0...v1.2.1) (2025-04-23)
+
+### Bug Fixes
+
+- should not add proxy to indexed db ([02b5442](https://github.com/keq-request/keq-cache/commit/02b54429856f4e343cd04d98cfb78a1d99e31249))
+
+## [1.2.0](https://github.com/keq-request/keq-cache/compare/v1.1.0...v1.2.0) (2025-04-22)
+
+### Features
+
+- add exclude options used exlcude the response should not be cached ([4f6aa79](https://github.com/keq-request/keq-cache/commit/4f6aa793b4aa671695ee1e792dcf1de83b66b37b))
+
+### Bug Fixes
+
+- response is consumed abnormally ([3b6d204](https://github.com/keq-request/keq-cache/commit/3b6d204f94982219e27f751b162396bd1ff27548))
+
+## [1.1.0](https://github.com/keq-request/keq-cache/compare/v1.0.6...v1.1.0) (2025-04-18)
+
+### Features
+
+- add onNetworkResponse event ([d9b94d0](https://github.com/keq-request/keq-cache/commit/d9b94d0e5d3dd172d48c8228ba51ad32d1eeee41))
+
+## [1.0.6](https://github.com/keq-request/keq-cache/compare/v1.0.5...v1.0.6) (2025-04-16)
+
+### Bug Fixes
+
+- cannot find idb package ([b33e267](https://github.com/keq-request/keq-cache/commit/b33e267b7eb845e9e78c2ccb5d2a33db0ee7973a))
+
+## [1.0.5](https://github.com/keq-request/keq-cache/compare/v1.0.4...v1.0.5) (2025-04-16)
+
+### Bug Fixes
+
+- cannot find idb package ([031f453](https://github.com/keq-request/keq-cache/commit/031f45358713cff0fe95a13613c2bf8b72fcb5c8))
+
+## [1.0.4](https://github.com/keq-request/keq-cache/compare/v1.0.3...v1.0.4) (2024-11-25)
+
+### Bug Fixes
+
+- indexed-db not work ([187ed1f](https://github.com/keq-request/keq-cache/commit/187ed1ff399ca681a683c2b4d615963aced202b8))
+
+## [1.0.3](https://github.com/keq-request/keq-cache/compare/v1.0.2...v1.0.3) (2024-11-19)
+
+### Bug Fixes
+
+- update import statements to include file extensions for esm ([f7118ee](https://github.com/keq-request/keq-cache/commit/f7118eeb2913ce48dc2bc53c99b831d52ecb8098))
+
+## [1.0.2](https://github.com/keq-request/keq-cache/compare/v1.0.1...v1.0.2) (2024-11-19)
+
+### Bug Fixes
+
+- update import statements to include file extensions for esm ([49ed02f](https://github.com/keq-request/keq-cache/commit/49ed02f64e15f14a04c8f54281b913545db97af2))
+
+## 1.0.1 (2024-11-18)
+
+### Bug Fixes
+
+- ctx.options.cache not working ([4f327eb](https://github.com/keq-request/keq-cache/commit/4f327eb887698b51cb44ebe4742f9e79a94fa30d))
+- update cache strategy handling to enforce required strategy option ([7798327](https://github.com/keq-request/keq-cache/commit/77983270544286046ab47df11b39c054fa84164e))
+
+### Miscellaneous Chores
+
+- release 1.0.1 ([6dcfd9d](https://github.com/keq-request/keq-cache/commit/6dcfd9d94ad82f0726d5c4031291ece719bd766c))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Val.istar.Guo
+
+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/dist/cache-entry/cache-entry.d.ts

@@ -0,0 +1,17 @@
+import { CacheEntryOptions } from './types/cache-entry-options.js';
+import { CacheEntryBuildOptions } from './types/cache-entry-build-options.js';
+export declare class CacheEntry {
+    key: string;
+    response: Response;
+    /**
+     * @en bytes
+     * @zh 字节数
+     */
+    size: number;
+    expiredAt: Date;
+    constructor(options: CacheEntryOptions);
+    static build(options: CacheEntryBuildOptions): Promise<CacheEntry>;
+    clone(): CacheEntry;
+    assign(another: CacheEntry): CacheEntry;
+}
+//# sourceMappingURL=cache-entry.d.ts.map

package/dist/cache-entry/cache-entry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache-entry.d.ts","sourceRoot":"","sources":["../../src/cache-entry/cache-entry.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAA;AAG7E,qBAAa,UAAU;IACrB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,QAAQ,CAAA;IAElB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ,SAAS,EAAE,IAAI,CAAA;gBAEH,OAAO,EAAE,iBAAiB;WAOzB,KAAK,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;IAgBxE,KAAK,IAAI,UAAU;IAUnB,MAAM,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU;CAOxC"}

package/dist/cache-entry/index.d.ts

@@ -0,0 +1,4 @@
+export * from './cache-entry.js';
+export * from './types/cache-entry-options.js';
+export * from './types/cache-entry-build-options.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cache-entry/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cache-entry/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,sCAAsC,CAAA"}

package/dist/cache-entry/types/cache-entry-build-options.d.ts

@@ -0,0 +1,8 @@
+export interface CacheEntryBuildOptions {
+    key: string;
+    response: Response;
+    size?: number;
+    ttl?: number;
+    expiredAt?: Date;
+}
+//# sourceMappingURL=cache-entry-build-options.d.ts.map

package/dist/cache-entry/types/cache-entry-build-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache-entry-build-options.d.ts","sourceRoot":"","sources":["../../../src/cache-entry/types/cache-entry-build-options.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,IAAI,CAAA;CACjB"}

package/dist/cache-entry/types/cache-entry-options.d.ts

@@ -0,0 +1,7 @@
+export interface CacheEntryOptions {
+    key: string;
+    response: Response;
+    size: number;
+    expiredAt?: Date;
+}
+//# sourceMappingURL=cache-entry-options.d.ts.map

package/dist/cache-entry/types/cache-entry-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache-entry-options.d.ts","sourceRoot":"","sources":["../../../src/cache-entry/types/cache-entry-options.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,IAAI,CAAA;CACjB"}

package/dist/cache.d.ts

@@ -0,0 +1,30 @@
+import type { Keq, KeqMiddleware, KeqContext } from 'keq';
+import { KeqCacheOption } from './types/keq-cache-option.js';
+import { KeqCacheParameters } from './types/keq-cache-parameters.js';
+declare module 'keq' {
+    interface KeqMiddlewareOptions<OP> {
+        /**
+         * [keq-cache](https://github.com/keq-request/keq-cache)
+         */
+        cache(option: KeqCacheOption): Keq<OP>;
+    }
+    interface KeqEvents {
+        'cache:hit': {
+            key: string;
+            response: Response;
+            context: KeqContext;
+        };
+        'cache:miss': {
+            key: string;
+            context: KeqContext;
+        };
+        'cache:update': {
+            key: string;
+            oldResponse?: Response;
+            newResponse: Response;
+            context: KeqContext;
+        };
+    }
+}
+export declare function cache(opts: KeqCacheParameters): KeqMiddleware;
+//# sourceMappingURL=cache.d.ts.map

package/dist/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAMpE,OAAO,QAAQ,KAAK,CAAC;IACnB,UAAiB,oBAAoB,CAAC,EAAE;QACtC;;WAEG;QACH,KAAK,CAAC,MAAM,EAAE,cAAc,GAAG,GAAG,CAAC,EAAE,CAAC,CAAA;KACvC;IAED,UAAiB,SAAS;QACxB,WAAW,EAAE;YACX,GAAG,EAAE,MAAM,CAAA;YACX,QAAQ,EAAE,QAAQ,CAAA;YAClB,OAAO,EAAE,UAAU,CAAA;SACpB,CAAA;QAED,YAAY,EAAE;YACZ,GAAG,EAAE,MAAM,CAAA;YACX,OAAO,EAAE,UAAU,CAAA;SACpB,CAAA;QAED,cAAc,EAAE;YACd,GAAG,EAAE,MAAM,CAAA;YACX,WAAW,CAAC,EAAE,QAAQ,CAAA;YACtB,WAAW,EAAE,QAAQ,CAAA;YACrB,OAAO,EAAE,UAAU,CAAA;SACpB,CAAA;KACF;CACF;AAGD,wBAAgB,KAAK,CAAC,IAAI,EAAE,kBAAkB,GAAG,aAAa,CA0C7D"}

package/dist/constants/eviction.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum Eviction {
+    LRU = "lru",
+    LFU = "lfu",
+    RANDOM = "random",
+    TTL = "ttl"
+}
+//# sourceMappingURL=eviction.enum.d.ts.map

package/dist/constants/eviction.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eviction.enum.d.ts","sourceRoot":"","sources":["../../src/constants/eviction.enum.ts"],"names":[],"mappings":"AAAA,oBAAY,QAAQ;IAClB,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,GAAG,QAAQ;CACZ"}

package/dist/constants/strategy.enum.d.ts

@@ -0,0 +1,7 @@
+export declare const Strategy: {
+    STALE_WHILE_REVALIDATE: import("..").KeqCacheStrategy;
+    NETWORK_FIRST: import("..").KeqCacheStrategy;
+    NETWORK_ONLY: import("..").KeqCacheStrategy;
+    CACHE_FIRST: import("..").KeqCacheStrategy;
+};
+//# sourceMappingURL=strategy.enum.d.ts.map

package/dist/constants/strategy.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strategy.enum.d.ts","sourceRoot":"","sources":["../../src/constants/strategy.enum.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,QAAQ;;;;;CAKpB,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from './cache.js';
+export * from './constants/strategy.enum.js';
+export * from './constants/eviction.enum.js';
+export { KeqCacheStorage as CacheStorage, IndexedDBStorage, MemoryStorage, TierStorage, } from './storage/index.js';
+export { KeqCacheOption } from './types/keq-cache-option.js';
+export { KeqCacheStrategy } from './types/keq-cache-strategy.js';
+export { KeqCacheParameters } from './types/keq-cache-parameters.js';
+export { KeqCacheRule } from './types/keq-cache-rule.js';
+export { StrategyOptions } from './types/strategies-options.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,8BAA8B,CAAA;AAC5C,cAAc,8BAA8B,CAAA;AAE5C,OAAO,EACL,eAAe,IAAI,YAAY,EAC/B,gBAAgB,EAChB,aAAa,EACb,WAAW,GACZ,MAAM,oBAAoB,CAAA;AAG3B,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA"}