@flaghoist/adapter-redis 0.1.1 → 0.2.0

package/README.md

@@ -33,6 +33,9 @@ createFlagServer((env) => ({
 Pick this over Cloudflare KV when you want changes to be visible immediately everywhere, rather than
 a few seconds later. Pick KV when you would rather not run anything.
 
+Webhook endpoints (if you use them) live in their own hash, `flaghoist:webhooks` by default. Change
+it with `{ webhookHashKey: '...' }`.
+
 Validated by the same conformance suite as the other adapters.
 
 ## Status

package/dist/index.cjs

@@ -36,8 +36,37 @@ function toFlag(raw) {
   if (typeof raw === "object") return (0, import_core.parseFlag)(raw);
   return null;
 }
+function toWebhook(raw) {
+  if (raw == null) return null;
+  if (typeof raw === "string") {
+    try {
+      return JSON.parse(raw);
+    } catch {
+      return null;
+    }
+  }
+  if (typeof raw === "object") return raw;
+  return null;
+}
+var wrapRecord = (value) => JSON.stringify({ flaghoistRecord: 1, value });
+function unwrapRecord(raw) {
+  let parsed = raw;
+  if (typeof raw === "string") {
+    try {
+      parsed = JSON.parse(raw);
+    } catch {
+      return null;
+    }
+  }
+  if (parsed === null || typeof parsed !== "object") return null;
+  const envelope = parsed;
+  if (envelope.flaghoistRecord !== 1) return null;
+  return envelope.value ?? null;
+}
 function redisAdapter(client, options = {}) {
   const hashKey = options.hashKey ?? "flaghoist:flags";
+  const whKey = options.webhookHashKey ?? "flaghoist:webhooks";
+  const recPrefix = options.recordHashPrefix ?? "flaghoist:records:";
   return {
     async get(key) {
       return toFlag(await client.hget(hashKey, key));
@@ -57,6 +86,48 @@ function redisAdapter(client, options = {}) {
         if (flag) flags.push(flag);
       }
       return flags;
+    },
+    async putWebhook(id, webhook) {
+      await client.hset(whKey, id, JSON.stringify(webhook));
+    },
+    async getWebhook(id) {
+      return toWebhook(await client.hget(whKey, id));
+    },
+    async deleteWebhook(id) {
+      await client.hdel(whKey, id);
+    },
+    async listWebhooks() {
+      const all = await client.hgetall(whKey);
+      if (!all) return [];
+      const hooks = [];
+      for (const raw of Object.values(all)) {
+        const hook = toWebhook(raw);
+        if (hook) hooks.push(hook);
+      }
+      return hooks;
+    },
+    async getRecord(collection, id) {
+      (0, import_core.assertRecordAddress)(collection, id);
+      return unwrapRecord(await client.hget(recPrefix + collection, id));
+    },
+    async putRecord(collection, id, value) {
+      (0, import_core.assertRecordAddress)(collection, id);
+      await client.hset(recPrefix + collection, id, wrapRecord(value));
+    },
+    async deleteRecord(collection, id) {
+      (0, import_core.assertRecordAddress)(collection, id);
+      await client.hdel(recPrefix + collection, id);
+    },
+    async listRecords(collection) {
+      (0, import_core.assertRecordAddress)(collection);
+      const all = await client.hgetall(recPrefix + collection);
+      if (!all) return [];
+      const entries = [];
+      for (const [id, raw] of Object.entries(all)) {
+        const value = unwrapRecord(raw);
+        if (value !== null) entries.push({ id, value });
+      }
+      return entries;
     }
   };
 }

package/dist/index.d.cts

@@ -15,6 +15,13 @@ interface RedisClientLike {
 interface RedisAdapterOptions {
     /** Redis hash key under which all flags are stored. Default: `"flaghoist:flags"`. */
     hashKey?: string;
+    /** Redis hash key for webhook endpoints. Default: `"flaghoist:webhooks"`. */
+    webhookHashKey?: string;
+    /**
+     * Prefix for record-store hashes. Each collection gets its own hash, `<prefix><collection>`.
+     * Default: `"flaghoist:records:"`.
+     */
+    recordHashPrefix?: string;
 }
 /**
  * A StorageAdapter backed by Redis. All flags live in a single hash, so reads and writes are

package/dist/index.d.ts

@@ -15,6 +15,13 @@ interface RedisClientLike {
 interface RedisAdapterOptions {
     /** Redis hash key under which all flags are stored. Default: `"flaghoist:flags"`. */
     hashKey?: string;
+    /** Redis hash key for webhook endpoints. Default: `"flaghoist:webhooks"`. */
+    webhookHashKey?: string;
+    /**
+     * Prefix for record-store hashes. Each collection gets its own hash, `<prefix><collection>`.
+     * Default: `"flaghoist:records:"`.
+     */
+    recordHashPrefix?: string;
 }
 /**
  * A StorageAdapter backed by Redis. All flags live in a single hash, so reads and writes are

package/dist/index.js

@@ -1,5 +1,8 @@
 // src/index.ts
-import { parseFlag } from "@flaghoist/core";
+import {
+  assertRecordAddress,
+  parseFlag
+} from "@flaghoist/core";
 function toFlag(raw) {
   if (raw == null) return null;
   if (typeof raw === "string") {
@@ -12,8 +15,37 @@ function toFlag(raw) {
   if (typeof raw === "object") return parseFlag(raw);
   return null;
 }
+function toWebhook(raw) {
+  if (raw == null) return null;
+  if (typeof raw === "string") {
+    try {
+      return JSON.parse(raw);
+    } catch {
+      return null;
+    }
+  }
+  if (typeof raw === "object") return raw;
+  return null;
+}
+var wrapRecord = (value) => JSON.stringify({ flaghoistRecord: 1, value });
+function unwrapRecord(raw) {
+  let parsed = raw;
+  if (typeof raw === "string") {
+    try {
+      parsed = JSON.parse(raw);
+    } catch {
+      return null;
+    }
+  }
+  if (parsed === null || typeof parsed !== "object") return null;
+  const envelope = parsed;
+  if (envelope.flaghoistRecord !== 1) return null;
+  return envelope.value ?? null;
+}
 function redisAdapter(client, options = {}) {
   const hashKey = options.hashKey ?? "flaghoist:flags";
+  const whKey = options.webhookHashKey ?? "flaghoist:webhooks";
+  const recPrefix = options.recordHashPrefix ?? "flaghoist:records:";
   return {
     async get(key) {
       return toFlag(await client.hget(hashKey, key));
@@ -33,6 +65,48 @@ function redisAdapter(client, options = {}) {
         if (flag) flags.push(flag);
       }
       return flags;
+    },
+    async putWebhook(id, webhook) {
+      await client.hset(whKey, id, JSON.stringify(webhook));
+    },
+    async getWebhook(id) {
+      return toWebhook(await client.hget(whKey, id));
+    },
+    async deleteWebhook(id) {
+      await client.hdel(whKey, id);
+    },
+    async listWebhooks() {
+      const all = await client.hgetall(whKey);
+      if (!all) return [];
+      const hooks = [];
+      for (const raw of Object.values(all)) {
+        const hook = toWebhook(raw);
+        if (hook) hooks.push(hook);
+      }
+      return hooks;
+    },
+    async getRecord(collection, id) {
+      assertRecordAddress(collection, id);
+      return unwrapRecord(await client.hget(recPrefix + collection, id));
+    },
+    async putRecord(collection, id, value) {
+      assertRecordAddress(collection, id);
+      await client.hset(recPrefix + collection, id, wrapRecord(value));
+    },
+    async deleteRecord(collection, id) {
+      assertRecordAddress(collection, id);
+      await client.hdel(recPrefix + collection, id);
+    },
+    async listRecords(collection) {
+      assertRecordAddress(collection);
+      const all = await client.hgetall(recPrefix + collection);
+      if (!all) return [];
+      const entries = [];
+      for (const [id, raw] of Object.entries(all)) {
+        const value = unwrapRecord(raw);
+        if (value !== null) entries.push({ id, value });
+      }
+      return entries;
     }
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flaghoist/adapter-redis",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Redis StorageAdapter for Flaghoist — works with ioredis (Node) and Upstash (edge).",
   "license": "Apache-2.0",
   "type": "module",
@@ -27,7 +27,7 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@flaghoist/core": "0.1.1"
+    "@flaghoist/core": "0.2.0"
   },
   "devDependencies": {
     "@flaghoist/adapter-conformance": "0.0.0"