@frontmcp/utils 1.9.2 → 1.9.4

package/storage/index.d.ts

@@ -9,7 +9,7 @@ export { createStorage, createMemoryStorage, getDetectedStorageType } from './fa
 export { attachRedisErrorListener, DEFAULT_REDIS_ERROR_LOG_INTERVAL_MS } from './redis-error-listener';
 export type { RedisErrorListenerOptions, ErrorEmitterClient } from './redis-error-listener';
 export { mergeRedisUrlFields, describeRedisUrlConflicts } from './redis-url';
-export type { RedisUrlMerge, RedisUrlSiblingFields } from './redis-url';
+export type { RedisUrlConnection, RedisUrlMerge, RedisUrlSiblingFields } from './redis-url';
 export { NamespacedStorageImpl, createRootStorage, createNamespacedStorage, buildPrefix, NAMESPACE_SEPARATOR, } from './namespace';
 export { StorageError, StorageConnectionError, StorageOperationError, StorageNotSupportedError, StorageConfigError, StorageTTLError, StoragePatternError, StorageNotConnectedError, EncryptedStorageError, } from './errors';
 export { TypedStorage } from './typed-storage';

package/storage/redis-url.d.ts

@@ -8,20 +8,42 @@ export interface RedisUrlSiblingFields {
     db?: number;
     tls?: boolean;
 }
+/**
+ * What a `redis://` or `rediss://` URL states, read as ioredis reads it: the userinfo, port and path
+ * first, then the same names in its query. An empty username or password counts as left out.
+ */
+export interface RedisUrlConnection {
+    host?: string;
+    port?: number;
+    username?: string;
+    password?: string;
+    db?: number;
+    tls: boolean;
+    /** The query's other options, which ioredis takes as they are (`family` as a number). */
+    queryOptions: Record<string, string | number>;
+}
 /**
  * Outcome of combining a Redis URL with the fields written beside it.
  */
 export interface RedisUrlMerge {
+    /** What the URL states. */
+    connection: RedisUrlConnection;
     /** Fields the URL leaves out that the sibling fields supply. */
     fillIns: Pick<RedisUrlSiblingFields, 'port' | 'password' | 'db' | 'tls'>;
     /** Sibling fields whose value contradicts the URL. */
     conflicts: Array<keyof RedisUrlSiblingFields>;
 }
+/**
+ * Read a `redis://` or `rediss://` URL. Returns `undefined` for an unparseable URL or another
+ * scheme (such as a socket path), which only ioredis reads.
+ */
+export declare function readRedisUrl(rawUrl: string): RedisUrlConnection | undefined;
 /**
  * The URL is the base: fields beside it fill in only what it leaves out (a
- * port, a password, a database, TLS), and a field that contradicts it is a
- * conflict the caller must reject (#768). Returns `undefined` for an
- * unparseable URL, which the caller reports on its own terms.
+ * port, a password, a database, TLS), and a field that contradicts what it
+ * states, in its userinfo, path or query, is a conflict the caller must reject
+ * (#768). Returns `undefined` for a URL {@link readRedisUrl} cannot read, which
+ * the caller reports on its own terms.
  */
 export declare function mergeRedisUrlFields(rawUrl: string, fields: RedisUrlSiblingFields): RedisUrlMerge | undefined;
 /** Human-readable reason for {@link RedisUrlMerge.conflicts}. */