encore.dev 1.54.2 → 1.55.0

package/dist/storage/cache/basic.js

@@ -0,0 +1,383 @@
+import { getCurrentRequest } from "../../internal/reqtrack/mod.js";
+import { CacheMiss, CacheKeyExists } from "./errors.js";
+import { Keyspace } from "./keyspace.js";
+/**
+ * Base class for basic (scalar value) keyspaces.
+ * Provides get/set/replace/etc operations.
+ * @internal
+ */
+class BasicKeyspace extends Keyspace {
+    constructor(cluster, config) {
+        super(cluster, config);
+    }
+    /**
+     * Gets the value stored at key.
+     * If the key does not exist, it returns `undefined`.
+     *
+     * @returns The value, or `undefined` if the key does not exist.
+     * @see https://redis.io/commands/get/
+     */
+    async get(key) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const result = await this.cluster.impl.get(mappedKey, source);
+        if (result === null) {
+            return undefined;
+        }
+        return this.deserialize(result);
+    }
+    /**
+     * Gets the values stored at multiple keys.
+     *
+     * @returns An array of values in the same order as the provided keys.
+     * Each element is the value or `undefined` if the key was not found.
+     * @see https://redis.io/commands/mget/
+     */
+    async multiGet(...keys) {
+        const source = getCurrentRequest();
+        const mappedKeys = keys.map((k) => this.mapKey(k));
+        const results = await this.cluster.impl.mget(mappedKeys, source);
+        return results.map((r) => r === null || r === undefined ? undefined : this.deserialize(r));
+    }
+    /**
+     * Updates the value stored at key to val.
+     *
+     * @see https://redis.io/commands/set/
+     */
+    async set(key, value, options) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const serialized = this.serialize(value);
+        const ttlMs = this.resolveTtl(options);
+        await this.cluster.impl.set(mappedKey, serialized, ttlMs, source);
+    }
+    /**
+     * Sets the value stored at key to val, but only if the key does not exist beforehand.
+     *
+     * @throws {CacheKeyExists} If the key already exists.
+     * @see https://redis.io/commands/setnx/
+     */
+    async setIfNotExists(key, value, options) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const serialized = this.serialize(value);
+        const ttlMs = this.resolveTtl(options);
+        const set = await this.cluster.impl.setIfNotExists(mappedKey, serialized, ttlMs, source);
+        if (!set) {
+            throw new CacheKeyExists(mappedKey);
+        }
+    }
+    /**
+     * Replaces the existing value stored at key to val.
+     *
+     * @throws {CacheMiss} If the key does not already exist.
+     * @see https://redis.io/commands/set/
+     */
+    async replace(key, value, options) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const serialized = this.serialize(value);
+        const ttlMs = this.resolveTtl(options);
+        const replaced = await this.cluster.impl.replace(mappedKey, serialized, ttlMs, source);
+        if (!replaced) {
+            throw new CacheMiss(mappedKey);
+        }
+    }
+    /**
+     * Updates the value of key to val and returns the previously stored value.
+     * If the key does not already exist, it sets it and returns `undefined`.
+     *
+     * @returns The previous value, or `undefined` if the key did not exist.
+     * @see https://redis.io/commands/getset/
+     */
+    async getAndSet(key, value, options) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const serialized = this.serialize(value);
+        const ttlMs = this.resolveTtl(options);
+        const oldValue = await this.cluster.impl.getAndSet(mappedKey, serialized, ttlMs, source);
+        if (oldValue === null) {
+            return undefined;
+        }
+        return this.deserialize(oldValue);
+    }
+    /**
+     * Deletes the key and returns the previously stored value.
+     * If the key does not already exist, it returns `undefined`.
+     *
+     * @returns The previous value, or `undefined` if the key did not exist.
+     * @see https://redis.io/commands/getdel/
+     */
+    async getAndDelete(key) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const value = await this.cluster.impl.getAndDelete(mappedKey, source);
+        if (value === null) {
+            return undefined;
+        }
+        return this.deserialize(value);
+    }
+}
+/**
+ * StringKeyspace stores string values.
+ *
+ * @example
+ * ```ts
+ * const tokens = new StringKeyspace<string>(cluster, {
+ *   keyPattern: "token/:id",
+ *   defaultExpiry: ExpireIn(3600000), // 1 hour
+ * });
+ *
+ * await tokens.set("abc123", "user-token-value");
+ * const token = await tokens.get("abc123");
+ * ```
+ */
+export class StringKeyspace extends BasicKeyspace {
+    constructor(cluster, config) {
+        super(cluster, config);
+    }
+    serialize(value) {
+        return Buffer.from(value, "utf-8");
+    }
+    deserialize(data) {
+        return data.toString("utf-8");
+    }
+    /**
+     * Appends a string to the value stored at key.
+     *
+     * If the key does not exist it is first created and set as the empty string,
+     * causing append to behave like set.
+     *
+     * @returns The new string length.
+     * @see https://redis.io/commands/append/
+     */
+    async append(key, value, options) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const ttlMs = this.resolveTtl(options);
+        const result = await this.cluster.impl.append(mappedKey, Buffer.from(value, "utf-8"), ttlMs, source);
+        return Number(result);
+    }
+    /**
+     * Returns a substring of the string value stored at key.
+     *
+     * The `start` and `end` values are zero-based indices, but unlike typical slicing
+     * the `end` value is inclusive.
+     *
+     * Negative values can be used in order to provide an offset starting
+     * from the end of the string, so -1 means the last character.
+     *
+     * If the string does not exist it returns the empty string.
+     *
+     * @param key - The cache key.
+     * @param start - Start index (inclusive, 0-based).
+     * @param end - End index (inclusive, 0-based). Use -1 for end of string.
+     * @returns The substring.
+     * @see https://redis.io/commands/getrange/
+     */
+    async getRange(key, start, end) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const result = await this.cluster.impl.getRange(mappedKey, start, end, source);
+        return result.toString("utf-8");
+    }
+    /**
+     * Overwrites part of the string stored at key, starting at
+     * the zero-based `offset` and for the entire length of `value`, extending
+     * the string if necessary.
+     *
+     * If the offset is larger than the current string length stored at key,
+     * the string is first padded with zero-bytes to make offset fit.
+     *
+     * Non-existing keys are considered as empty strings.
+     *
+     * @param key - The cache key.
+     * @param offset - Zero-based byte offset to start writing at.
+     * @param value - The string to write.
+     * @returns The length of the string after the operation.
+     * @see https://redis.io/commands/setrange/
+     */
+    async setRange(key, offset, value, options) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const ttlMs = this.resolveTtl(options);
+        const result = await this.cluster.impl.setRange(mappedKey, offset, Buffer.from(value, "utf-8"), ttlMs, source);
+        return Number(result);
+    }
+    /**
+     * Returns the length of the string value stored at key.
+     *
+     * Non-existing keys are considered as empty strings.
+     *
+     * @returns The string length.
+     * @see https://redis.io/commands/strlen/
+     */
+    async len(key) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const result = await this.cluster.impl.strlen(mappedKey, source);
+        return Number(result);
+    }
+}
+/**
+ * IntKeyspace stores 64-bit integer values.
+ * Values are floored to integers using `Math.floor`.
+ * For fractional values, use {@link FloatKeyspace} instead.
+ *
+ * @example
+ * ```ts
+ * const counters = new IntKeyspace<string>(cluster, {
+ *   keyPattern: "counter/:name",
+ * });
+ *
+ * await counters.set("page-views", 0);
+ * const newCount = await counters.increment("page-views", 1);
+ * ```
+ */
+export class IntKeyspace extends BasicKeyspace {
+    constructor(cluster, config) {
+        super(cluster, config);
+    }
+    serialize(value) {
+        return Buffer.from(String(Math.floor(value)), "utf-8");
+    }
+    deserialize(data) {
+        return parseInt(data.toString("utf-8"), 10);
+    }
+    /**
+     * Increments the number stored at key by `delta`.
+     *
+     * If the key does not exist it is first created with a value of 0
+     * before incrementing.
+     *
+     * Negative values can be used to decrease the value,
+     * but typically you want to use {@link decrement} for that.
+     *
+     * @param key - The cache key.
+     * @param delta - The amount to increment by (default 1).
+     * @returns The new value after incrementing.
+     * @see https://redis.io/commands/incrby/
+     */
+    async increment(key, delta = 1, options) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const ttlMs = this.resolveTtl(options);
+        return await this.cluster.impl.incrBy(mappedKey, Math.floor(delta), ttlMs, source);
+    }
+    /**
+     * Decrements the number stored at key by `delta`.
+     *
+     * If the key does not exist it is first created with a value of 0
+     * before decrementing.
+     *
+     * Negative values can be used to increase the value,
+     * but typically you want to use {@link increment} for that.
+     *
+     * @param key - The cache key.
+     * @param delta - The amount to decrement by (default 1).
+     * @returns The new value after decrementing.
+     * @see https://redis.io/commands/decrby/
+     */
+    async decrement(key, delta = 1, options) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const ttlMs = this.resolveTtl(options);
+        return await this.cluster.impl.decrBy(mappedKey, Math.floor(delta), ttlMs, source);
+    }
+}
+/**
+ * FloatKeyspace stores 64-bit floating point values.
+ *
+ * @example
+ * ```ts
+ * const scores = new FloatKeyspace<string>(cluster, {
+ *   keyPattern: "score/:playerId",
+ * });
+ *
+ * await scores.set("player1", 100.5);
+ * const newScore = await scores.increment("player1", 10.25);
+ * ```
+ */
+export class FloatKeyspace extends BasicKeyspace {
+    constructor(cluster, config) {
+        super(cluster, config);
+    }
+    serialize(value) {
+        return Buffer.from(String(value), "utf-8");
+    }
+    deserialize(data) {
+        return parseFloat(data.toString("utf-8"));
+    }
+    /**
+     * Increments the number stored at key by `delta`.
+     *
+     * If the key does not exist it is first created with a value of 0
+     * before incrementing.
+     *
+     * Negative values can be used to decrease the value,
+     * but typically you want to use {@link decrement} for that.
+     *
+     * @param key - The cache key.
+     * @param delta - The amount to increment by (default 1).
+     * @returns The new value after incrementing.
+     * @see https://redis.io/commands/incrbyfloat/
+     */
+    async increment(key, delta = 1, options) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const ttlMs = this.resolveTtl(options);
+        return await this.cluster.impl.incrByFloat(mappedKey, delta, ttlMs, source);
+    }
+    /**
+     * Decrements the number stored at key by `delta`.
+     *
+     * If the key does not exist it is first created with a value of 0
+     * before decrementing.
+     *
+     * Negative values can be used to increase the value,
+     * but typically you want to use {@link increment} for that.
+     *
+     * @param key - The cache key.
+     * @param delta - The amount to decrement by (default 1).
+     * @returns The new value after decrementing.
+     * @see https://redis.io/commands/incrbyfloat/
+     */
+    async decrement(key, delta = 1, options) {
+        const source = getCurrentRequest();
+        const mappedKey = this.mapKey(key);
+        const ttlMs = this.resolveTtl(options);
+        return await this.cluster.impl.incrByFloat(mappedKey, -delta, ttlMs, source);
+    }
+}
+/**
+ * StructKeyspace stores arbitrary objects serialized as JSON.
+ *
+ * @example
+ * ```ts
+ * interface User {
+ *   id: string;
+ *   name: string;
+ *   email: string;
+ * }
+ *
+ * const users = new StructKeyspace<string, User>(cluster, {
+ *   keyPattern: "user/:id",
+ *   defaultExpiry: ExpireIn(3600000),
+ * });
+ *
+ * await users.set("user1", { id: "user1", name: "Alice", email: "alice@example.com" });
+ * const user = await users.get("user1");
+ * ```
+ */
+export class StructKeyspace extends BasicKeyspace {
+    constructor(cluster, config) {
+        super(cluster, config);
+    }
+    serialize(value) {
+        return Buffer.from(JSON.stringify(value), "utf-8");
+    }
+    deserialize(data) {
+        return JSON.parse(data.toString("utf-8"));
+    }
+}
+//# sourceMappingURL=basic.js.map

package/dist/storage/cache/basic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic.js","sourceRoot":"","sources":["../../../storage/cache/basic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAgC,MAAM,YAAY,CAAC;AAEpE;;;;GAIG;AACH,MAAe,aAAoB,SAAQ,QAAW;IACpD,YAAY,OAAqB,EAAE,MAAyB;QAC1D,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACzB,CAAC;IAYD;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CAAC,GAAM;QACd,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAE9D,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAS;QACzB,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACjE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACvB,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAChE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,GAAM,EAAE,KAAQ,EAAE,OAAsB;QAChD,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEvC,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,GAAM,EACN,KAAQ,EACR,OAAsB;QAEtB,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEvC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAChD,SAAS,EACT,UAAU,EACV,KAAK,EACL,MAAM,CACP,CAAC;QAEF,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,GAAM,EAAE,KAAQ,EAAE,OAAsB;QACpD,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAC9C,SAAS,EACT,UAAU,EACV,KAAK,EACL,MAAM,CACP,CAAC;QAEF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACb,GAAM,EACN,KAAQ,EACR,OAAsB;QAEtB,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAChD,SAAS,EACT,UAAU,EACV,KAAK,EACL,MAAM,CACP,CAAC;QAEF,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,GAAM;QACvB,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEnC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAEtE,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,cAAkB,SAAQ,aAAwB;IAC7D,YAAY,OAAqB,EAAE,MAAyB;QAC1D,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACzB,CAAC;IAES,SAAS,CAAC,KAAa;QAC/B,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAES,WAAW,CAAC,IAAY;QAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CAAC,GAAM,EAAE,KAAa,EAAE,OAAsB;QACxD,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAC3C,SAAS,EACT,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,EAC3B,KAAK,EACL,MAAM,CACP,CAAC;QACF,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAM,EAAE,KAAa,EAAE,GAAW;QAC/C,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAC7C,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,CACP,CAAC;QACF,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,QAAQ,CACZ,GAAM,EACN,MAAc,EACd,KAAa,EACb,OAAsB;QAEtB,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAC7C,SAAS,EACT,MAAM,EACN,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,EAC3B,KAAK,EACL,MAAM,CACP,CAAC;QACF,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CAAC,GAAM;QACd,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACjE,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;CACF;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,WAAe,SAAQ,aAAwB;IAC1D,YAAY,OAAqB,EAAE,MAAyB;QAC1D,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACzB,CAAC;IAES,SAAS,CAAC,KAAa;QAC/B,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAES,WAAW,CAAC,IAAY;QAChC,OAAO,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,SAAS,CACb,GAAM,EACN,QAAgB,CAAC,EACjB,OAAsB;QAEtB,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACvC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CACnC,SAAS,EACT,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EACjB,KAAK,EACL,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,SAAS,CACb,GAAM,EACN,QAAgB,CAAC,EACjB,OAAsB;QAEtB,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACvC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CACnC,SAAS,EACT,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EACjB,KAAK,EACL,MAAM,CACP,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,aAAiB,SAAQ,aAAwB;IAC5D,YAAY,OAAqB,EAAE,MAAyB;QAC1D,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACzB,CAAC;IAES,SAAS,CAAC,KAAa;QAC/B,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAES,WAAW,CAAC,IAAY;QAChC,OAAO,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,SAAS,CACb,GAAM,EACN,QAAgB,CAAC,EACjB,OAAsB;QAEtB,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACvC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,SAAS,CACb,GAAM,EACN,QAAgB,CAAC,EACjB,OAAsB;QAEtB,MAAM,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACvC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CACxC,SAAS,EACT,CAAC,KAAK,EACN,KAAK,EACL,MAAM,CACP,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,cAAqB,SAAQ,aAAmB;IAC3D,YAAY,OAAqB,EAAE,MAAyB;QAC1D,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACzB,CAAC;IAES,SAAS,CAAC,KAAQ;QAC1B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAES,WAAW,CAAC,IAAY;QAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAM,CAAC;IACjD,CAAC;CACF"}

package/dist/storage/cache/cluster.d.ts

@@ -0,0 +1,48 @@
+import * as runtime from "../../internal/runtime/mod.js";
+import { StringLiteral } from "../../internal/utils/constraints.js";
+/**
+ * Redis eviction policy that determines how keys are evicted when memory is full.
+ */
+export type EvictionPolicy = "noeviction" | "allkeys-lru" | "allkeys-lfu" | "allkeys-random" | "volatile-lru" | "volatile-lfu" | "volatile-ttl" | "volatile-random";
+/**
+ * Configuration options for a cache cluster.
+ */
+export interface CacheClusterConfig {
+    /**
+     * The eviction policy to use when the cache is full.
+     * Defaults to "allkeys-lru".
+     */
+    evictionPolicy?: EvictionPolicy;
+}
+/**
+ * CacheCluster represents a Redis cache cluster.
+ *
+ * Create a new cluster using `new CacheCluster(name)`.
+ * Reference an existing cluster using `CacheCluster.named(name)`.
+ *
+ * @example
+ * ```ts
+ * import { CacheCluster } from "encore.dev/storage/cache";
+ *
+ * const myCache = new CacheCluster("my-cache", {
+ *   evictionPolicy: "allkeys-lru",
+ * });
+ * ```
+ */
+export declare class CacheCluster {
+    /** @internal */
+    readonly impl: runtime.CacheCluster;
+    /** @internal */
+    readonly clusterName: string;
+    /**
+     * Creates a new cache cluster with the given name and configuration.
+     * @param name - The unique name for this cache cluster
+     * @param cfg - Optional configuration for the cluster
+     */
+    constructor(name: string, cfg?: CacheClusterConfig);
+    /**
+     * Reference an existing cache cluster by name.
+     * To create a new cache cluster, use `new CacheCluster(...)` instead.
+     */
+    static named<Name extends string>(name: StringLiteral<Name>): CacheCluster;
+}

package/dist/storage/cache/cluster.js

@@ -0,0 +1,40 @@
+import * as runtime from "../../internal/runtime/mod.js";
+/**
+ * CacheCluster represents a Redis cache cluster.
+ *
+ * Create a new cluster using `new CacheCluster(name)`.
+ * Reference an existing cluster using `CacheCluster.named(name)`.
+ *
+ * @example
+ * ```ts
+ * import { CacheCluster } from "encore.dev/storage/cache";
+ *
+ * const myCache = new CacheCluster("my-cache", {
+ *   evictionPolicy: "allkeys-lru",
+ * });
+ * ```
+ */
+export class CacheCluster {
+    /** @internal */
+    impl;
+    /** @internal */
+    clusterName;
+    /**
+     * Creates a new cache cluster with the given name and configuration.
+     * @param name - The unique name for this cache cluster
+     * @param cfg - Optional configuration for the cluster
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    constructor(name, cfg) {
+        this.clusterName = name;
+        this.impl = runtime.RT.cacheCluster(name);
+    }
+    /**
+     * Reference an existing cache cluster by name.
+     * To create a new cache cluster, use `new CacheCluster(...)` instead.
+     */
+    static named(name) {
+        return new CacheCluster(name);
+    }
+}
+//# sourceMappingURL=cluster.js.map

package/dist/storage/cache/cluster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cluster.js","sourceRoot":"","sources":["../../../storage/cache/cluster.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,4BAA4B,CAAC;AA2BtD;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,YAAY;IACvB,gBAAgB;IACP,IAAI,CAAuB;IACpC,gBAAgB;IACP,WAAW,CAAS;IAE7B;;;;OAIG;IACH,6DAA6D;IAC7D,YAAY,IAAY,EAAE,GAAwB;QAChD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAsB,IAAyB;QACzD,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;CACF"}

package/dist/storage/cache/errors.d.ts

@@ -0,0 +1,19 @@
+/**
+ * CacheError is the base class for all cache-related errors.
+ */
+export declare class CacheError extends Error {
+    constructor(msg: string);
+}
+/**
+ * CacheMiss is thrown when a cache key is not found.
+ */
+export declare class CacheMiss extends CacheError {
+    constructor(key: string);
+}
+/**
+ * CacheKeyExists is thrown when attempting to set a key that already exists
+ * using setIfNotExists.
+ */
+export declare class CacheKeyExists extends CacheError {
+    constructor(key: string);
+}

package/dist/storage/cache/errors.js

@@ -0,0 +1,59 @@
+/**
+ * CacheError is the base class for all cache-related errors.
+ */
+export class CacheError extends Error {
+    constructor(msg) {
+        // extending errors causes issues after you construct them, unless you apply the following fixes
+        super(msg);
+        // set error name as constructor name, make it not enumerable to keep native Error behavior
+        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/new.target#new.target_in_constructors
+        Object.defineProperty(this, "name", {
+            value: "CacheError",
+            enumerable: false,
+            configurable: true
+        });
+        // Fix the prototype chain, capture stack trace.
+        Object.setPrototypeOf(this, CacheError.prototype);
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+/**
+ * CacheMiss is thrown when a cache key is not found.
+ */
+export class CacheMiss extends CacheError {
+    constructor(key) {
+        // extending errors causes issues after you construct them, unless you apply the following fixes
+        super(`cache key "${key}" not found`);
+        // set error name as constructor name, make it not enumerable to keep native Error behavior
+        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/new.target#new.target_in_constructors
+        Object.defineProperty(this, "name", {
+            value: "CacheMiss",
+            enumerable: false,
+            configurable: true
+        });
+        // Fix the prototype chain, capture stack trace.
+        Object.setPrototypeOf(this, CacheMiss.prototype);
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+/**
+ * CacheKeyExists is thrown when attempting to set a key that already exists
+ * using setIfNotExists.
+ */
+export class CacheKeyExists extends CacheError {
+    constructor(key) {
+        // extending errors causes issues after you construct them, unless you apply the following fixes
+        super(`cache key "${key}" already exists`);
+        // set error name as constructor name, make it not enumerable to keep native Error behavior
+        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/new.target#new.target_in_constructors
+        Object.defineProperty(this, "name", {
+            value: "CacheKeyExists",
+            enumerable: false,
+            configurable: true
+        });
+        // Fix the prototype chain, capture stack trace.
+        Object.setPrototypeOf(this, CacheKeyExists.prototype);
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/storage/cache/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../storage/cache/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,GAAW;QACrB,gGAAgG;QAChG,KAAK,CAAC,GAAG,CAAC,CAAC;QAEX,2FAA2F;QAC3F,oHAAoH;QACpH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;YAClC,KAAK,EAAE,YAAY;YACnB,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QAEH,gDAAgD;QAChD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;QAClD,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,UAAU;IACvC,YAAY,GAAW;QACrB,gGAAgG;QAChG,KAAK,CAAC,cAAc,GAAG,aAAa,CAAC,CAAC;QAEtC,2FAA2F;QAC3F,oHAAoH;QACpH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;YAClC,KAAK,EAAE,WAAW;YAClB,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QAEH,gDAAgD;QAChD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;QACjD,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,UAAU;IAC5C,YAAY,GAAW;QACrB,gGAAgG;QAChG,KAAK,CAAC,cAAc,GAAG,kBAAkB,CAAC,CAAC;QAE3C,2FAA2F;QAC3F,oHAAoH;QACpH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;YAClC,KAAK,EAAE,gBAAgB;YACvB,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QAEH,gDAAgD;QAChD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;QACtD,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;CACF"}

package/dist/storage/cache/expiry.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Expiry represents a cache key expiration configuration.
+ * Use the helper functions to create expiry configurations.
+ */
+export type Expiry = {
+    type: "duration";
+    durationMs: number;
+} | {
+    type: "time";
+    hours: number;
+    minutes: number;
+    seconds: number;
+} | "never" | "keep-ttl";
+/**
+ * expireIn sets the cache entry to expire after the specified duration.
+ * @param ms - Duration in milliseconds
+ */
+export declare function expireIn(ms: number): Expiry;
+/**
+ * expireInSeconds sets the cache entry to expire after the specified seconds.
+ * @param seconds - Duration in seconds
+ */
+export declare function expireInSeconds(seconds: number): Expiry;
+/**
+ * expireInMinutes sets the cache entry to expire after the specified minutes.
+ * @param minutes - Duration in minutes
+ */
+export declare function expireInMinutes(minutes: number): Expiry;
+/**
+ * expireInHours sets the cache entry to expire after the specified hours.
+ * @param hours - Duration in hours
+ */
+export declare function expireInHours(hours: number): Expiry;
+/**
+ * expireDailyAt sets the cache entry to expire at a specific time each day (UTC).
+ * @param hours - Hour (0-23)
+ * @param minutes - Minutes (0-59)
+ * @param seconds - Seconds (0-59)
+ */
+export declare function expireDailyAt(hours: number, minutes: number, seconds: number): Expiry;
+/**
+ * neverExpire sets the cache entry to never expire.
+ * Note: Redis may still evict the key based on the eviction policy.
+ */
+export declare const neverExpire: Expiry;
+/**
+ * keepTTL preserves the existing TTL when updating a cache entry.
+ * If the key doesn't exist, no TTL is set.
+ */
+export declare const keepTTL: Expiry;
+/**
+ * Resolves an Expiry to a duration in milliseconds, "never", or "keep-ttl".
+ * @internal
+ */
+export declare function resolveExpiry(expiry: Expiry): number | "never" | "keep-ttl";