@chttp/cache 0.0.0-stage → 0.2.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/LICENSE +202 -0
- package/README.md +92 -2
- package/dist/esm/cache.d.ts +27 -0
- package/dist/esm/cache.js +122 -0
- package/dist/esm/index.d.ts +7 -0
- package/dist/esm/index.js +13 -0
- package/package.json +50 -3
- package/src/cache.ts +150 -0
- package/src/index.ts +19 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 Joaquin Terrasa & contributors
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,93 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @chttp/cache
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Map-based LRU + TTL in-process memory cache with [lru-cache](https://github.com/isaacs/node-lru-cache)-parity semantics, authored inside the [scriptc](https://github.com/vercel-labs/scriptc) compilable subset — it compiles into a native ELF alongside a [chttp](https://github.com/sigilco/chttp) app with `scriptc build`, and runs under Node unchanged.
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
import { Cache } from "@chttp/cache";
|
|
7
|
+
|
|
8
|
+
const sessions: Cache<string> = new Cache({ max: 10_000, ttl: 60_000 });
|
|
9
|
+
|
|
10
|
+
sessions.set("sess-1", "uid:42");
|
|
11
|
+
sessions.get("sess-1"); // "uid:42" — and bumps recency
|
|
12
|
+
sessions.has("sess-1"); // true — no recency bump
|
|
13
|
+
sessions.peek("sess-1"); // "uid:42" — no recency bump
|
|
14
|
+
sessions.get("missing"); // null — misses are null, never undefined
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
- **`get` bumps recency; `peek`/`has` don't.** Recency decides which entry evicts when `size > max`.
|
|
18
|
+
- **TTL is lazy.** Expired entries purge on access (`get`/`has`/`peek`), never on a timer. An expired entry nobody reads holds memory until evicted — `max` is the bound.
|
|
19
|
+
- **`max` evicts least-recently-used.** Insertion-ordered `Map`; the first key out is the eviction victim.
|
|
20
|
+
- **Misses are `null`, and `has()` disambiguates.** A stored `null` reads as `null` too — `has()` tells it apart from a miss.
|
|
21
|
+
- **Per-entry TTL** overrides the constructor default: `set(key, value, { ttl: 5_000 })`.
|
|
22
|
+
- **Config fails fast.** Non-positive `max` or `ttl` throws `E_BAD_CACHE_OPTIONS` at construction (and on `set` opts); nothing throws on the traffic path.
|
|
23
|
+
|
|
24
|
+
## Surface
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
declare class Cache<V> {
|
|
28
|
+
constructor(opts?: { max?: number; ttl?: number }, now?: () => number);
|
|
29
|
+
get(key: string): V | null;
|
|
30
|
+
set(key: string, value: V, opts?: { ttl?: number }): this;
|
|
31
|
+
has(key: string): boolean;
|
|
32
|
+
peek(key: string): V | null;
|
|
33
|
+
delete(key: string): void;
|
|
34
|
+
clear(): void;
|
|
35
|
+
readonly size: number;
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
`max` defaults to `Infinity` (unbounded); `ttl` defaults to no expiry. `now` is a constructor-only test seam for a fake clock — not part of the stable surface.
|
|
40
|
+
|
|
41
|
+
## Divergences from lru-cache
|
|
42
|
+
|
|
43
|
+
Deliberate, documented — every one is a subset constraint or a YAGNI call:
|
|
44
|
+
|
|
45
|
+
| lru-cache | @chttp/cache |
|
|
46
|
+
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
47
|
+
| `V \| undefined` misses | `V \| null` misses; `has()` disambiguates |
|
|
48
|
+
| `new LRUCache<K, V>()` (typed keys + values) | `Cache<V>` phantom-generic alias — keys are `string`, values narrow at the call site |
|
|
49
|
+
| `ttlAutopurge`, internal timers | lazy purge on access only; `max` bounds memory |
|
|
50
|
+
| `dispose`/`fetch`/`sizeCalculation`, stale-while-revalidate | not shipped — follow-up tickets on demand |
|
|
51
|
+
| `mget`/`mset` | loop `get`/`set` |
|
|
52
|
+
| `ttl: 0` = no expiry | `ttl <= 0` throws `E_BAD_CACHE_OPTIONS` |
|
|
53
|
+
|
|
54
|
+
## Bigger than memory? Cache-aside, not a second module
|
|
55
|
+
|
|
56
|
+
A single-ELF app has exactly one memory domain — that covers rate-limit windows, session memoization, upstream-response memoization and job dedup. When it doesn't (multi-replica coherence, persistence), layer a store _under_ this cache instead of swapping the API:
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
// Store seam — implement this plain shape against your backend
|
|
60
|
+
// (Upstash REST over fetch, Redis over net.Socket, ...).
|
|
61
|
+
interface CacheStore {
|
|
62
|
+
get(key: string): Promise<string | null>; // values JSON-encoded
|
|
63
|
+
set(key: string, value: string, ttlSeconds?: number): Promise<void>;
|
|
64
|
+
delete(key: string): Promise<void>;
|
|
65
|
+
deleteByPrefix?(prefix: string): Promise<void>;
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
const memory = new Cache({ max: 5_000, ttl: 30_000 });
|
|
71
|
+
|
|
72
|
+
async function getUser(store: CacheStore, id: string): Promise<string | null> {
|
|
73
|
+
const hit = memory.get("user:" + id);
|
|
74
|
+
if (hit !== null) {
|
|
75
|
+
return hit;
|
|
76
|
+
}
|
|
77
|
+
const v = await store.get("user:" + id);
|
|
78
|
+
if (v !== null) {
|
|
79
|
+
memory.set("user:" + id, v);
|
|
80
|
+
}
|
|
81
|
+
return v;
|
|
82
|
+
}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Backend clients live as greppable examples (an Upstash REST store is the recommended default; a RESP-over-`net.Socket` Redis store ships only on demand) — the package itself stays zero-dependency.
|
|
86
|
+
|
|
87
|
+
## Tests
|
|
88
|
+
|
|
89
|
+
`pnpm --filter @chttp/cache test` builds with tsc, runs the `node --test` suite (LRU order, TTL via the injected clock, value round-trips, a real `@chttp/router` handler chain over HTTP) and the ELF smoke (`test/elf.test.sh`: `scriptc build` + native run). `scripts/scriptc-gate.sh` keeps `gate.ts` at 100% static coverage.
|
|
90
|
+
|
|
91
|
+
## License
|
|
92
|
+
|
|
93
|
+
Apache-2.0
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
export interface CacheOptions {
|
|
2
|
+
max?: number;
|
|
3
|
+
ttl?: number;
|
|
4
|
+
}
|
|
5
|
+
export interface CacheSetOptions {
|
|
6
|
+
ttl?: number;
|
|
7
|
+
}
|
|
8
|
+
export interface CacheEntry {
|
|
9
|
+
value: unknown;
|
|
10
|
+
expiresAt: number;
|
|
11
|
+
}
|
|
12
|
+
export declare class CacheCore {
|
|
13
|
+
_store: Map<string, CacheEntry>;
|
|
14
|
+
_max: number;
|
|
15
|
+
_ttl: number;
|
|
16
|
+
_now: () => number;
|
|
17
|
+
constructor(opts?: CacheOptions, now?: () => number);
|
|
18
|
+
_expired(entry: CacheEntry, now: number): boolean;
|
|
19
|
+
_evict(): void;
|
|
20
|
+
get(key: string): unknown | null;
|
|
21
|
+
set(key: string, value: unknown, opts?: CacheSetOptions): CacheCore;
|
|
22
|
+
has(key: string): boolean;
|
|
23
|
+
peek(key: string): unknown | null;
|
|
24
|
+
delete(key: string): void;
|
|
25
|
+
clear(): void;
|
|
26
|
+
get size(): number;
|
|
27
|
+
}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
// CacheCore — Map-based LRU+TTL memory cache authored inside the
|
|
2
|
+
// scriptc-compilable subset (Map lifted by the 0.3.3 probe; see AGENTS.md).
|
|
3
|
+
//
|
|
4
|
+
// Semantics follow lru-cache's stable core:
|
|
5
|
+
// - get bumps recency (delete + reinsert); peek/has do not.
|
|
6
|
+
// - has/peek still purge an expired entry (lazy TTL only — no timers).
|
|
7
|
+
// - set on an existing key re-inserts at MRU position (Map preserves
|
|
8
|
+
// position on overwrite, so an explicit delete is required first).
|
|
9
|
+
// - Past `max`, the least-recently-used entry (the Map's first key,
|
|
10
|
+
// insertion-ordered) evicts until size <= max.
|
|
11
|
+
// - Misses return null (never undefined — SC3004); has() disambiguates
|
|
12
|
+
// a stored null-ish value from a miss.
|
|
13
|
+
//
|
|
14
|
+
// Subset notes: `| null` unions only; class fields concretely typed (values
|
|
15
|
+
// live in a plain CacheEntry record, where `unknown` members are legal);
|
|
16
|
+
// eviction reads the first key via one `for...of` over `entries()` +
|
|
17
|
+
// immediate break — no iterator `.next()` games. Timestamps are Date.now()
|
|
18
|
+
// (TTLs are seconds-scale; a monotonic clock is not worth the surface).
|
|
19
|
+
export class CacheCore {
|
|
20
|
+
_store;
|
|
21
|
+
_max;
|
|
22
|
+
_ttl;
|
|
23
|
+
_now;
|
|
24
|
+
// `now` is a constructor-only test seam (fake clock), deliberately NOT a
|
|
25
|
+
// CacheOptions record member — function values inside records degrade
|
|
26
|
+
// instantiation under scriptc.
|
|
27
|
+
constructor(opts, now) {
|
|
28
|
+
const o = opts === undefined || opts === null ? {} : opts;
|
|
29
|
+
const max = o.max === undefined ? Infinity : o.max;
|
|
30
|
+
const ttl = o.ttl === undefined ? Infinity : o.ttl;
|
|
31
|
+
if (!(max > 0)) {
|
|
32
|
+
throw new Error("E_BAD_CACHE_OPTIONS: max must be a positive number");
|
|
33
|
+
}
|
|
34
|
+
if (!(ttl > 0)) {
|
|
35
|
+
throw new Error("E_BAD_CACHE_OPTIONS: ttl must be a positive number");
|
|
36
|
+
}
|
|
37
|
+
this._store = new Map();
|
|
38
|
+
this._max = max;
|
|
39
|
+
this._ttl = ttl;
|
|
40
|
+
this._now = now === undefined ? Date.now : now;
|
|
41
|
+
}
|
|
42
|
+
_expired(entry, now) {
|
|
43
|
+
return entry.expiresAt !== Infinity && now >= entry.expiresAt;
|
|
44
|
+
}
|
|
45
|
+
_evict() {
|
|
46
|
+
while (this._store.size > this._max) {
|
|
47
|
+
let oldest = null;
|
|
48
|
+
for (const e of this._store.entries()) {
|
|
49
|
+
oldest = e[0];
|
|
50
|
+
break;
|
|
51
|
+
}
|
|
52
|
+
if (oldest === null) {
|
|
53
|
+
break;
|
|
54
|
+
}
|
|
55
|
+
this._store.delete(oldest);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
get(key) {
|
|
59
|
+
const entry = this._store.get(key);
|
|
60
|
+
if (entry === undefined) {
|
|
61
|
+
return null;
|
|
62
|
+
}
|
|
63
|
+
if (this._expired(entry, this._now())) {
|
|
64
|
+
this._store.delete(key);
|
|
65
|
+
return null;
|
|
66
|
+
}
|
|
67
|
+
// Recency bump: delete + reinsert moves the entry to MRU position.
|
|
68
|
+
this._store.delete(key);
|
|
69
|
+
this._store.set(key, entry);
|
|
70
|
+
return entry.value;
|
|
71
|
+
}
|
|
72
|
+
set(key, value, opts) {
|
|
73
|
+
let ttl = this._ttl;
|
|
74
|
+
if (opts !== undefined && opts !== null && opts.ttl !== undefined) {
|
|
75
|
+
ttl = opts.ttl;
|
|
76
|
+
if (!(ttl > 0)) {
|
|
77
|
+
throw new Error("E_BAD_CACHE_OPTIONS: ttl must be a positive number");
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
// Map preserves insertion position on overwrite — delete first so a
|
|
81
|
+
// re-set key lands at MRU, matching lru-cache.
|
|
82
|
+
this._store.delete(key);
|
|
83
|
+
const entry = {
|
|
84
|
+
value: value,
|
|
85
|
+
expiresAt: ttl === Infinity ? Infinity : this._now() + ttl,
|
|
86
|
+
};
|
|
87
|
+
this._store.set(key, entry);
|
|
88
|
+
this._evict();
|
|
89
|
+
return this;
|
|
90
|
+
}
|
|
91
|
+
has(key) {
|
|
92
|
+
const entry = this._store.get(key);
|
|
93
|
+
if (entry === undefined) {
|
|
94
|
+
return false;
|
|
95
|
+
}
|
|
96
|
+
if (this._expired(entry, this._now())) {
|
|
97
|
+
this._store.delete(key);
|
|
98
|
+
return false;
|
|
99
|
+
}
|
|
100
|
+
return true;
|
|
101
|
+
}
|
|
102
|
+
peek(key) {
|
|
103
|
+
const entry = this._store.get(key);
|
|
104
|
+
if (entry === undefined) {
|
|
105
|
+
return null;
|
|
106
|
+
}
|
|
107
|
+
if (this._expired(entry, this._now())) {
|
|
108
|
+
this._store.delete(key);
|
|
109
|
+
return null;
|
|
110
|
+
}
|
|
111
|
+
return entry.value;
|
|
112
|
+
}
|
|
113
|
+
delete(key) {
|
|
114
|
+
this._store.delete(key);
|
|
115
|
+
}
|
|
116
|
+
clear() {
|
|
117
|
+
this._store.clear();
|
|
118
|
+
}
|
|
119
|
+
get size() {
|
|
120
|
+
return this._store.size;
|
|
121
|
+
}
|
|
122
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { CacheCore } from "./cache.ts";
|
|
2
|
+
import type { CacheEntry, CacheOptions, CacheSetOptions } from "./cache.ts";
|
|
3
|
+
export { CacheCore };
|
|
4
|
+
export type { CacheEntry, CacheOptions, CacheSetOptions };
|
|
5
|
+
export interface Cache<_V> extends CacheCore {
|
|
6
|
+
}
|
|
7
|
+
export declare const Cache: typeof CacheCore;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// @chttp/cache — public surface.
|
|
2
|
+
//
|
|
3
|
+
// The runtime class is the non-generic CacheCore: generic CLASS
|
|
4
|
+
// parameters degrade instances to methodless shells under scriptc
|
|
5
|
+
// 0.3.x, so `Cache<V>` is a type-level alias over CacheCore — the same
|
|
6
|
+
// pattern @chttp/router uses for Ctx<P>/ReqView<P>. `V` is a phantom
|
|
7
|
+
// parameter documenting intended value type; get/peek still return
|
|
8
|
+
// `unknown | null` (see the README divergence table). A narrowed
|
|
9
|
+
// `get(key): V | null` interface member would itself refuse to lower,
|
|
10
|
+
// so the typed surface cannot be carried on the class.
|
|
11
|
+
import { CacheCore } from "./cache.js";
|
|
12
|
+
export { CacheCore };
|
|
13
|
+
export const Cache = CacheCore;
|
package/package.json
CHANGED
|
@@ -1,6 +1,53 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@chttp/cache",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "Map-based LRU+TTL memory cache with lru-cache-parity semantics, authored inside the scriptc compilable subset",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/sigilco/cutils.git",
|
|
9
|
+
"directory": "packages/cache"
|
|
10
|
+
},
|
|
11
|
+
"files": [
|
|
12
|
+
"dist",
|
|
13
|
+
"src"
|
|
14
|
+
],
|
|
15
|
+
"type": "module",
|
|
16
|
+
"main": "./dist/esm/index.js",
|
|
17
|
+
"types": "./dist/esm/index.d.ts",
|
|
18
|
+
"exports": {
|
|
19
|
+
".": {
|
|
20
|
+
"types": "./dist/esm/index.d.ts",
|
|
21
|
+
"import": "./dist/esm/index.js"
|
|
22
|
+
},
|
|
23
|
+
"./package.json": "./package.json"
|
|
24
|
+
},
|
|
25
|
+
"devDependencies": {
|
|
26
|
+
"@chttp/router": "^0.2.1",
|
|
27
|
+
"@types/node": "^24.0.0",
|
|
28
|
+
"typescript": "^5.9.0"
|
|
29
|
+
},
|
|
30
|
+
"engines": {
|
|
31
|
+
"node": ">=22"
|
|
32
|
+
},
|
|
33
|
+
"author": "Joaquin Terrasa & contributors",
|
|
34
|
+
"keywords": [
|
|
35
|
+
"cache",
|
|
36
|
+
"lru",
|
|
37
|
+
"ttl",
|
|
38
|
+
"memory-cache",
|
|
39
|
+
"lru-cache",
|
|
40
|
+
"scriptc",
|
|
41
|
+
"native"
|
|
42
|
+
],
|
|
43
|
+
"homepage": "https://github.com/sigilco/cutils/tree/main/packages/cache#readme",
|
|
44
|
+
"bugs": {
|
|
45
|
+
"url": "https://github.com/sigilco/cutils/issues"
|
|
46
|
+
},
|
|
47
|
+
"sideEffects": false,
|
|
48
|
+
"scripts": {
|
|
49
|
+
"build": "tsc -p tsconfig.json",
|
|
50
|
+
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
51
|
+
"test": "npm run build && node --test test/*.test.js test/*.test.mjs && bash test/elf.test.sh"
|
|
52
|
+
}
|
|
6
53
|
}
|
package/src/cache.ts
ADDED
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
// CacheCore — Map-based LRU+TTL memory cache authored inside the
|
|
2
|
+
// scriptc-compilable subset (Map lifted by the 0.3.3 probe; see AGENTS.md).
|
|
3
|
+
//
|
|
4
|
+
// Semantics follow lru-cache's stable core:
|
|
5
|
+
// - get bumps recency (delete + reinsert); peek/has do not.
|
|
6
|
+
// - has/peek still purge an expired entry (lazy TTL only — no timers).
|
|
7
|
+
// - set on an existing key re-inserts at MRU position (Map preserves
|
|
8
|
+
// position on overwrite, so an explicit delete is required first).
|
|
9
|
+
// - Past `max`, the least-recently-used entry (the Map's first key,
|
|
10
|
+
// insertion-ordered) evicts until size <= max.
|
|
11
|
+
// - Misses return null (never undefined — SC3004); has() disambiguates
|
|
12
|
+
// a stored null-ish value from a miss.
|
|
13
|
+
//
|
|
14
|
+
// Subset notes: `| null` unions only; class fields concretely typed (values
|
|
15
|
+
// live in a plain CacheEntry record, where `unknown` members are legal);
|
|
16
|
+
// eviction reads the first key via one `for...of` over `entries()` +
|
|
17
|
+
// immediate break — no iterator `.next()` games. Timestamps are Date.now()
|
|
18
|
+
// (TTLs are seconds-scale; a monotonic clock is not worth the surface).
|
|
19
|
+
|
|
20
|
+
export interface CacheOptions {
|
|
21
|
+
max?: number; // default Infinity; LRU evicts past this
|
|
22
|
+
ttl?: number; // default: no expiry; ms; per-entry override on set()
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export interface CacheSetOptions {
|
|
26
|
+
ttl?: number; // per-entry TTL in ms; overrides the constructor default
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
// Internal record shape for stored values. `value` is `unknown`, which is
|
|
30
|
+
// legal inside a plain record (only class fields must be concrete). The
|
|
31
|
+
// public type-level `Cache<V>` alias in index.ts narrows it per consumer.
|
|
32
|
+
export interface CacheEntry {
|
|
33
|
+
value: unknown;
|
|
34
|
+
expiresAt: number; // epoch ms; Infinity = never expires
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export class CacheCore {
|
|
38
|
+
_store: Map<string, CacheEntry>;
|
|
39
|
+
_max: number;
|
|
40
|
+
_ttl: number;
|
|
41
|
+
_now: () => number;
|
|
42
|
+
|
|
43
|
+
// `now` is a constructor-only test seam (fake clock), deliberately NOT a
|
|
44
|
+
// CacheOptions record member — function values inside records degrade
|
|
45
|
+
// instantiation under scriptc.
|
|
46
|
+
constructor(opts?: CacheOptions, now?: () => number) {
|
|
47
|
+
const o: CacheOptions = opts === undefined || opts === null ? {} : opts;
|
|
48
|
+
const max: number = o.max === undefined ? Infinity : o.max;
|
|
49
|
+
const ttl: number = o.ttl === undefined ? Infinity : o.ttl;
|
|
50
|
+
if (!(max > 0)) {
|
|
51
|
+
throw new Error("E_BAD_CACHE_OPTIONS: max must be a positive number");
|
|
52
|
+
}
|
|
53
|
+
if (!(ttl > 0)) {
|
|
54
|
+
throw new Error("E_BAD_CACHE_OPTIONS: ttl must be a positive number");
|
|
55
|
+
}
|
|
56
|
+
this._store = new Map<string, CacheEntry>();
|
|
57
|
+
this._max = max;
|
|
58
|
+
this._ttl = ttl;
|
|
59
|
+
this._now = now === undefined ? Date.now : now;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
_expired(entry: CacheEntry, now: number): boolean {
|
|
63
|
+
return entry.expiresAt !== Infinity && now >= entry.expiresAt;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
_evict(): void {
|
|
67
|
+
while (this._store.size > this._max) {
|
|
68
|
+
let oldest: string | null = null;
|
|
69
|
+
for (const e of this._store.entries()) {
|
|
70
|
+
oldest = e[0];
|
|
71
|
+
break;
|
|
72
|
+
}
|
|
73
|
+
if (oldest === null) {
|
|
74
|
+
break;
|
|
75
|
+
}
|
|
76
|
+
this._store.delete(oldest);
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
get(key: string): unknown | null {
|
|
81
|
+
const entry = this._store.get(key);
|
|
82
|
+
if (entry === undefined) {
|
|
83
|
+
return null;
|
|
84
|
+
}
|
|
85
|
+
if (this._expired(entry, this._now())) {
|
|
86
|
+
this._store.delete(key);
|
|
87
|
+
return null;
|
|
88
|
+
}
|
|
89
|
+
// Recency bump: delete + reinsert moves the entry to MRU position.
|
|
90
|
+
this._store.delete(key);
|
|
91
|
+
this._store.set(key, entry);
|
|
92
|
+
return entry.value;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
set(key: string, value: unknown, opts?: CacheSetOptions): CacheCore {
|
|
96
|
+
let ttl = this._ttl;
|
|
97
|
+
if (opts !== undefined && opts !== null && opts.ttl !== undefined) {
|
|
98
|
+
ttl = opts.ttl;
|
|
99
|
+
if (!(ttl > 0)) {
|
|
100
|
+
throw new Error("E_BAD_CACHE_OPTIONS: ttl must be a positive number");
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
// Map preserves insertion position on overwrite — delete first so a
|
|
104
|
+
// re-set key lands at MRU, matching lru-cache.
|
|
105
|
+
this._store.delete(key);
|
|
106
|
+
const entry: CacheEntry = {
|
|
107
|
+
value: value,
|
|
108
|
+
expiresAt: ttl === Infinity ? Infinity : this._now() + ttl,
|
|
109
|
+
};
|
|
110
|
+
this._store.set(key, entry);
|
|
111
|
+
this._evict();
|
|
112
|
+
return this;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
has(key: string): boolean {
|
|
116
|
+
const entry = this._store.get(key);
|
|
117
|
+
if (entry === undefined) {
|
|
118
|
+
return false;
|
|
119
|
+
}
|
|
120
|
+
if (this._expired(entry, this._now())) {
|
|
121
|
+
this._store.delete(key);
|
|
122
|
+
return false;
|
|
123
|
+
}
|
|
124
|
+
return true;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
peek(key: string): unknown | null {
|
|
128
|
+
const entry = this._store.get(key);
|
|
129
|
+
if (entry === undefined) {
|
|
130
|
+
return null;
|
|
131
|
+
}
|
|
132
|
+
if (this._expired(entry, this._now())) {
|
|
133
|
+
this._store.delete(key);
|
|
134
|
+
return null;
|
|
135
|
+
}
|
|
136
|
+
return entry.value;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
delete(key: string): void {
|
|
140
|
+
this._store.delete(key);
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
clear(): void {
|
|
144
|
+
this._store.clear();
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
get size(): number {
|
|
148
|
+
return this._store.size;
|
|
149
|
+
}
|
|
150
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
// @chttp/cache — public surface.
|
|
2
|
+
//
|
|
3
|
+
// The runtime class is the non-generic CacheCore: generic CLASS
|
|
4
|
+
// parameters degrade instances to methodless shells under scriptc
|
|
5
|
+
// 0.3.x, so `Cache<V>` is a type-level alias over CacheCore — the same
|
|
6
|
+
// pattern @chttp/router uses for Ctx<P>/ReqView<P>. `V` is a phantom
|
|
7
|
+
// parameter documenting intended value type; get/peek still return
|
|
8
|
+
// `unknown | null` (see the README divergence table). A narrowed
|
|
9
|
+
// `get(key): V | null` interface member would itself refuse to lower,
|
|
10
|
+
// so the typed surface cannot be carried on the class.
|
|
11
|
+
|
|
12
|
+
import { CacheCore } from "./cache.ts";
|
|
13
|
+
import type { CacheEntry, CacheOptions, CacheSetOptions } from "./cache.ts";
|
|
14
|
+
|
|
15
|
+
export { CacheCore };
|
|
16
|
+
export type { CacheEntry, CacheOptions, CacheSetOptions };
|
|
17
|
+
|
|
18
|
+
export interface Cache<_V> extends CacheCore {}
|
|
19
|
+
export const Cache = CacheCore;
|