@owlmeans/redis-resource 0.1.18-rc.8 → 0.1.18

package/build/types.d.ts

@@ -1,24 +1,39 @@
-import type { LifecycleOptions, Resource, ResourceDbService, ResourceRecord } from '@owlmeans/resource';
-import type { RedisCommander, Redis, Cluster } from 'ioredis';
+import type { PubSubResource, Resource, ResourceDbService, ResourceRecord, StreamResource, WatchableResource } from '@owlmeans/resource';
+import type { RedisCommander, Redis, Cluster, RedisOptions, ClusterNode, ClusterOptions } from 'ioredis';
 export interface RedisDbService extends ResourceDbService<RedisDb, RedisClient> {
+    /**
+     * The connection settings behind `alias`, in the shape a client is built from.
+     *
+     * A pooled client cannot be shared by everything: a consumer that blocks on a read holds the
+     * connection for the duration, so anything doing that needs one of its own. Handing out the
+     * settings keeps that decision with the caller while the configuration stays here — the
+     * alternative is every consumer re-deriving them from `cfg.dbs` and drifting.
+     */
+    options: (alias?: string) => RedisConnection;
+}
+/** Either a single-node or a cluster connection, plus the key namespace `alias` resolves to. */
+export interface RedisConnection {
+    single?: RedisOptions;
+    cluster?: {
+        nodes: ClusterNode[];
+        options: ClusterOptions;
+    };
+    prefix: string;
 }
 export type RedisClient = Redis | Cluster;
 export interface RedisDb {
     client: RedisCommander;
     prefix: string;
 }
-export interface RedisResource<T extends ResourceRecord> extends Resource<T> {
+/**
+ * A `Resource` over redis strings — one JSON document per namespaced key — composed with the
+ * three capabilities redis actually has: pub/sub channels, keyspace watching of a single record,
+ * and streams with consumer groups.
+ */
+export interface RedisResource<T extends ResourceRecord> extends Resource<T>, PubSubResource<T>, WatchableResource<T>, StreamResource<T> {
     name?: string;
     db: RedisDb;
+    /** The namespaced redis key for `key`, or the namespace's glob when `key` is omitted. */
     key: (key?: string) => string;
-    subscribe: <Type extends T>(handler: (value: Type) => Promise<void>, key?: SubOpts) => Promise<() => Promise<void>>;
-    publish: <Type extends T>(value: Type, key?: string) => Promise<void>;
-    stream: <Type extends T>(key: string, data: Type) => Promise<void>;
-    consume: <Type extends T>(key: string, group?: string, consumer?: string) => AsyncGenerator<Type>;
-}
-export type SubOpts = number | string | boolean | SubscriptionOptions;
-export interface SubscriptionOptions extends LifecycleOptions {
-    key?: string;
-    once?: boolean;
 }
 //# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAEvG,OAAO,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAE7D,MAAM,WAAW,cAAe,SAAQ,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC;CAC9E;AAED,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,OAAO,CAAA;AAEzC,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,cAAc,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,cAAc,CAAE,SAAQ,QAAQ,CAAC,CAAC,CAAC;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,EAAE,EAAE,OAAO,CAAA;IAEX,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAE7B,SAAS,EAAE,CAAC,IAAI,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;IAEnH,OAAO,EAAE,CAAC,IAAI,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE,MAAM,EAAE,CAAC,IAAI,SAAS,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAElE,OAAO,EAAE,CAAC,IAAI,SAAS,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,cAAc,CAAC,IAAI,CAAC,CAAA;CAClG;AAED,MAAM,MAAM,OAAO,GAAG,MAAM,GAAE,MAAM,GAAG,OAAO,GAAG,mBAAmB,CAAA;AAEpE,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,OAAO,CAAA;CACf"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,iBAAiB,EAC/F,MAAM,oBAAoB,CAAA;AAE3B,OAAO,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExG,MAAM,WAAW,cAAe,SAAQ,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC;IAC7E;;;;;;;OAOG;IACH,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,eAAe,CAAA;CAC7C;AAED,gGAAgG;AAChG,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,WAAW,EAAE,CAAC;QAAC,OAAO,EAAE,cAAc,CAAA;KAAE,CAAA;IAC3D,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,OAAO,CAAA;AAEzC,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,cAAc,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,cAAc,CAAE,SAAQ,QAAQ,CAAC,CAAC,CAAC,EAC1E,cAAc,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,EAAE,EAAE,OAAO,CAAA;IAEX,yFAAyF;IACzF,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;CAC9B"}

package/build/types.local.d.ts

@@ -0,0 +1,4 @@
+import type { ServerConfig, ServerContext } from '@owlmeans/server-context';
+export type Config = ServerConfig;
+export type Context<C extends Config = Config> = ServerContext<C>;
+//# sourceMappingURL=types.local.d.ts.map

package/build/types.local.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.local.d.ts","sourceRoot":"","sources":["../src/types.local.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAE3E,MAAM,MAAM,MAAM,GAAG,YAAY,CAAA;AAEjC,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,aAAa,CAAC,CAAC,CAAC,CAAA"}

package/build/types.local.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.local.js.map

package/build/types.local.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.local.js","sourceRoot":"","sources":["../src/types.local.ts"],"names":[],"mappings":""}

package/build/utils/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/utils/options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAE/D,eAAO,MAAM,iBAAiB,UAAW,OAAO,KAAG,mBAalD,CAAA"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/utils/options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAE/D,eAAO,MAAM,iBAAiB,GAAI,OAAO,OAAO,KAAG,mBAalD,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owlmeans/redis-resource",
-  "version": "0.1.18-rc.8",
+  "version": "0.1.18",
   "license": "MIT",
   "type": "module",
   "scripts": {
@@ -25,14 +25,15 @@
     "ioredis": "*"
   },
   "dependencies": {
-    "@owlmeans/basic-ids": "^0.1.18-rc.7",
-    "@owlmeans/context": "^0.1.18-rc.6",
-    "@owlmeans/resource": "^0.1.18-rc.7",
-    "@owlmeans/server-context": "^0.1.18-rc.8"
+    "@owlmeans/basic-ids": "^0.1.18",
+    "@owlmeans/context": "^0.1.18",
+    "@owlmeans/log": "^0.1.18",
+    "@owlmeans/resource": "^0.1.18",
+    "@owlmeans/server-context": "^0.1.18"
   },
   "devDependencies": {
-    "@owlmeans/dep-config": "workspace:*",
-    "@types/node": "^26.1.0",
+    "@owlmeans/dep-config": "^0.1.18",
+    "@types/node": "^26.6.4",
     "nodemon": "^3.1.14",
     "typescript": "^7.0.2"
   },

package/src/consts.ts

@@ -1,4 +1,29 @@
-
 export const DEFAULT_DB_ALIAS = 'redis'
 
-export const DEFAULT_PAGE_SIZE = 10
+/**
+ * Redis is UNPAGED: `list()` without a `size` returns every match, and `0` says exactly that.
+ * There is no server side LIMIT to fall back on — answering a criteria already walked the whole
+ * namespace — so an implied default would only hide records without saving any work.
+ */
+export const DEFAULT_PAGE_SIZE = 0
+
+/** Keys per SCAN round trip. Bounded so one sweep never blocks the server the way KEYS does. */
+export const SCAN_BATCH = 200
+
+/** Keys per MGET / DEL round trip once SCAN has collected them. */
+export const READ_BATCH = 200
+
+/** Entries kept in a stream, trimmed approximately (`MAXLEN ~`) so trimming stays O(1)-ish. */
+export const STREAM_MAX_LENGTH = 10000
+
+/** How long a stream read blocks before the consumer loops and looks for pending entries. */
+export const DEFAULT_STREAM_BLOCK = 1000
+
+/** How long an unacknowledged entry may sit with its consumer before another may reclaim it. */
+export const RECLAIM_IDLE = 60000
+
+/** Entries reclaimed per XAUTOCLAIM pass. */
+export const RECLAIM_COUNT = 10
+
+/** Length of the generated consumer name when `consume` is not given one. */
+export const CONSUMER_ID_LENGTH = 15