@owlmeans/redis-resource 0.1.18-rc.2 → 0.1.18-rc.21

package/src/types.ts

@@ -1,8 +1,26 @@
-import type { LifecycleOptions, Resource, ResourceDbService, ResourceRecord } from '@owlmeans/resource'
+import type {
+  PubSubResource, Resource, ResourceDbService, ResourceRecord, StreamResource, WatchableResource
+} from '@owlmeans/resource'
 
-import type { RedisCommander, Redis, Cluster } from 'ioredis'
+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
@@ -12,25 +30,17 @@ export interface RedisDb {
   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
 }

package/build/utils/index.d.ts

@@ -1,2 +0,0 @@
-export * from './options.js';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAA"}

package/build/utils/index.js

@@ -1,2 +0,0 @@
-export * from './options.js';
-//# sourceMappingURL=index.js.map

package/build/utils/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAA"}

package/build/utils/options.d.ts

@@ -1,3 +0,0 @@
-import type { SubOpts, SubscriptionOptions } from '../types.js';
-export declare const prepareSubOptions: (opts?: SubOpts) => SubscriptionOptions;
-//# sourceMappingURL=options.d.ts.map

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

@@ -1 +0,0 @@
-{"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"}

package/build/utils/options.js

@@ -1,17 +0,0 @@
-export const prepareSubOptions = (opts) => {
-    let _opts = {};
-    if (typeof opts === 'string') {
-        _opts.key = opts;
-    }
-    else if (typeof opts === 'number') {
-        _opts.ttl = opts;
-    }
-    else if (typeof opts === 'boolean') {
-        _opts.once = opts;
-    }
-    else if (typeof opts === 'object') {
-        _opts = opts;
-    }
-    return _opts;
-};
-//# sourceMappingURL=options.js.map

package/build/utils/options.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../../src/utils/options.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAc,EAAuB,EAAE;IACvE,IAAI,KAAK,GAAwB,EAAE,CAAA;IACnC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,KAAK,CAAC,GAAG,GAAG,IAAI,CAAA;IAClB,CAAC;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAA;IAClB,CAAC;SAAM,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE,CAAC;QACrC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAA;IACnB,CAAC;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpC,KAAK,GAAG,IAAI,CAAA;IACd,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA"}

package/src/utils/index.ts

@@ -1,2 +0,0 @@
-
-export * from './options.js'

package/src/utils/options.ts

@@ -1,17 +0,0 @@
-
-import type { SubOpts, SubscriptionOptions } from '../types.js'
-
-export const prepareSubOptions = (opts?: SubOpts): SubscriptionOptions => {
-  let _opts: SubscriptionOptions = {}
-  if (typeof opts === 'string') {
-    _opts.key = opts
-  } else if (typeof opts === 'number') {
-    _opts.ttl = opts
-  } else if (typeof opts === 'boolean') {
-    _opts.once = opts
-  } else if (typeof opts === 'object') {
-    _opts = opts
-  }
-
-  return _opts
-}