@desmat/redis-store 1.3.0 → 1.4.0

package/README.md

@@ -12,6 +12,8 @@ Leans into Redis’ strong suits to bring relational aspects to the simple but p
 
 Plays well with Upstash and Vercel but will work with any Redis instance via REST API.
 
+Also ships with `MemoryStore`, a pure in-memory implementation of `RedisStore` — a drop-in swap for local development and tests that don't need (or want) a live Redis instance. See [In-memory store](#in-memory-store) below.
+
 
 ## Installation
 
@@ -171,3 +173,50 @@ await Promise.all([
 // ZREM testthings:user:<USER_UUID> <UUID>
 // ...
 ```
+
+
+## In-memory store
+
+`MemoryStore<T>` implements the exact same `Store<T>` interface as `RedisStore<T>` but keeps everything in plain JS `Map`s — no Redis connection, no environment variables, no network calls. Application code written against `Store<T>` can swap between the two without any changes.
+
+```typescript
+import { MemoryStore } from '@desmat/redis-store';
+
+const store = {
+  users: new MemoryStore<User>({ key: "user" }),
+  things: new MemoryStore<Thing>({ key: "thing", options: ThingOptions }),
+};
+
+const user = await store.users.create({ name: "User One" });
+const things = await store.things.find({ user: user.id });
+```
+
+Useful for:
+- Local development without provisioning a real Redis instance
+- Test suites that need fast, isolated, disposable data (each `MemoryStore` instance is its own private state — nothing persists between processes, and nothing is shared unless you share the instance)
+
+Constructor accepts an optional `seed` array to pre-populate records (and their lookup indices) at construction time, so seeded data is immediately queryable via `find`/`ids` without needing to call `.create()` for each one:
+
+```typescript
+const things = new MemoryStore<Thing>({
+  key: "thing",
+  options: ThingOptions,
+  seed: [
+    { id: "thing-1", createdAt: Date.now(), createdBy: "user-1", label: "Seeded thing" },
+  ],
+});
+```
+
+Notes on parity with `RedisStore`:
+- `create`/`update`/`delete`/lookup/counter semantics are ported 1:1, including Redis's rank-based (not score-range) windowing for `count`/`offset` in `ids()`/`find()`, and `queryCounter`'s lexicographic range-bound behavior for `incCounters`/`queryCounter`.
+- `options.expire` is a no-op (data is ephemeral for the life of the process anyway).
+- There's no equivalent to `RedisStore`'s raw `.redis` client escape hatch — code that reaches through it directly for one-off scripts (rather than going through the `Store<T>` methods) isn't portable to `MemoryStore`.
+
+
+## Testing
+
+```bash
+npm test
+```
+
+Runs the `MemoryStore` unit test suite (`test/*.test.ts`) via Node's built-in test runner (through `tsx`) — no live Redis needed. `RedisStore` itself has no automated tests; it's a thin wrapper around `@upstash/redis`.

package/dist/index.d.ts

@@ -1,11 +1,14 @@
 import { Redis } from "@upstash/redis";
+import type { Store } from "./store";
 export type RedisStoreRecord = {
     id: string;
     createdAt: number;
     updatedAt?: number;
     deletedAt?: number;
 };
-export default class RedisStore<T extends RedisStoreRecord> {
+export { Store } from "./store";
+export { default as MemoryStore } from "./memory-store";
+export default class RedisStore<T extends RedisStoreRecord> implements Store<T> {
     redis: Redis;
     key: string;
     setKey: string;
@@ -37,7 +40,7 @@ export default class RedisStore<T extends RedisStoreRecord> {
         lookups?: any;
     }): Promise<T>;
     update(value: any, options?: any): Promise<T>;
-    incrementCounters(values: Record<string, string | number>, delta: {
+    incCounters(values: Record<string, string | number>, delta: {
         total: number;
         count: number;
     }): Promise<any>;

package/dist/index.js

@@ -19,9 +19,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryStore = void 0;
 const moment_1 = __importDefault(require("moment"));
 const utils_1 = require("@desmat/utils");
 const redis_1 = require("@upstash/redis");
+var memory_store_1 = require("./memory-store");
+Object.defineProperty(exports, "MemoryStore", { enumerable: true, get: function () { return __importDefault(memory_store_1).default; } });
 // polyfill Set.intersection
 ;
 (function () {
@@ -260,10 +263,16 @@ class RedisStore {
         this.debug && console.log(`RedisStore<${this.key}>.update`, { response });
         return updatedValue;
     }
-    async incrementCounters(values, delta) {
+    async incCounters(values, delta) {
         var _a;
-        this.debug && console.log(`RedisStore<${this.key}>.incrementCounters`, { values, delta });
+        this.debug && console.log(`RedisStore<${this.key}>.incCounters`, { values, delta });
         const counters = ((_a = this.options) === null || _a === void 0 ? void 0 : _a.counters) || [];
+        counters
+            .filter((counter) => !counter.split(":").every((d) => typeof values[d] != "undefined"))
+            .forEach((counter) => {
+            const missing = counter.split(":").filter((d) => typeof values[d] == "undefined");
+            console.warn(`RedisStore<${this.key}>.incCounters WARNING: skipping counter "${counter}": missing dimension(s) ${missing.join(", ")} in values`, { values });
+        });
         const responses = await Promise.all(counters
             .filter((counter) => counter.split(":").every((d) => typeof values[d] != "undefined"))
             .flatMap((counter) => {
@@ -273,7 +282,7 @@ class RedisStore {
                 this.redis.zincrby(`${this.key}Counts:${counter}`, delta.count, member),
             ];
         }));
-        this.debug && console.log(`RedisStore<${this.key}>.incrementCounters`, { responses });
+        this.debug && console.log(`RedisStore<${this.key}>.incCounters`, { responses });
         return responses;
     }
     async queryCounter(kind, counter, exact, range) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@desmat/redis-store",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
@@ -14,7 +14,8 @@
   "scripts": {
     "build": "tsc",
     "prepare": "tsc",
-    "example": "ts-node --skipProject ./src/example.ts"
+    "example": "ts-node --skipProject ./src/example.ts",
+    "test": "tsx --test test/**/*.test.ts"
   },
   "repository": {
     "type": "git",
@@ -36,6 +37,7 @@
   },
   "devDependencies": {
     "@types/node": "^22.8.4",
+    "tsx": "^4.21.0",
     "typescript": "^4.0.0"
   }
 }