@workglow/storage 0.1.2 → 0.2.0

package/dist/common.d.ts

@@ -28,4 +28,5 @@ export * from "./vector/InMemoryVectorStorage";
 export * from "./vector/IVectorStorage";
 export * from "./vector/TelemetryVectorStorage";
 export * from "./credentials/EncryptedKvCredentialStore";
+export * from "./credentials/LazyEncryptedCredentialStore";
 //# sourceMappingURL=common.d.ts.map

package/dist/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAElD,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AAExC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAE9C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,qCAAqC,CAAC;AAEpD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,eAAe,CAAC;AAE9B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC;AACxC,cAAc,iCAAiC,CAAC;AAEhD,cAAc,0CAA0C,CAAC"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAElD,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AAExC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAE9C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,qCAAqC,CAAC;AAEpD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,eAAe,CAAC;AAE9B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC;AACxC,cAAc,iCAAiC,CAAC;AAEhD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC"}

package/dist/credentials/LazyEncryptedCredentialStore.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { CredentialPutOptions, ICredentialStore } from "@workglow/util";
+import type { IKvStorage } from "../kv/IKvStorage";
+/**
+ * An {@link ICredentialStore} wrapper that starts in a locked state and defers
+ * construction of the underlying {@link EncryptedKvCredentialStore} until
+ * {@link unlock} is called with a passphrase.
+ *
+ * **Locked behavior** (before {@link unlock}):
+ * - `get()` returns `undefined` (falls through in a {@link ChainedCredentialStore})
+ * - `has()` returns `false`
+ * - `keys()` returns `[]`
+ * - `put()` throws an error
+ * - `delete()` returns `false`
+ * - `deleteAll()` is a no-op
+ *
+ * **Unlocked behavior**: all methods delegate to the inner
+ * {@link EncryptedKvCredentialStore}.
+ *
+ * @example
+ * ```ts
+ * const lazy = new LazyEncryptedCredentialStore(kvStorage);
+ * await lazy.get("key"); // undefined (locked)
+ *
+ * lazy.unlock("my-passphrase");
+ * await lazy.get("key"); // decrypted value
+ *
+ * lazy.lock(); // discards inner store
+ * await lazy.get("key"); // undefined again
+ * ```
+ */
+export declare class LazyEncryptedCredentialStore implements ICredentialStore {
+    private readonly kv;
+    private inner;
+    constructor(kv: IKvStorage<string, unknown>);
+    /**
+     * Whether the store is currently unlocked and able to decrypt credentials.
+     */
+    get isUnlocked(): boolean;
+    /**
+     * Unlock the store by providing a passphrase. Creates the underlying
+     * {@link EncryptedKvCredentialStore} using the same KV backend.
+     *
+     * @throws if the passphrase is empty
+     */
+    unlock(passphrase: string): void;
+    /**
+     * Lock the store, discarding the inner {@link EncryptedKvCredentialStore}
+     * and its derived key cache.
+     */
+    lock(): void;
+    get(key: string): Promise<string | undefined>;
+    put(key: string, value: string, options?: CredentialPutOptions): Promise<void>;
+    delete(key: string): Promise<boolean>;
+    has(key: string): Promise<boolean>;
+    keys(): Promise<readonly string[]>;
+    deleteAll(): Promise<void>;
+}
+//# sourceMappingURL=LazyEncryptedCredentialStore.d.ts.map

package/dist/credentials/LazyEncryptedCredentialStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LazyEncryptedCredentialStore.d.ts","sourceRoot":"","sources":["../../src/credentials/LazyEncryptedCredentialStore.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC7E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAGnD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,4BAA6B,YAAW,gBAAgB;IAGvD,OAAO,CAAC,QAAQ,CAAC,EAAE;IAF/B,OAAO,CAAC,KAAK,CAAyC;IAEtD,YAA6B,EAAE,EAAE,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,EAAI;IAEhE;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAE/B;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,CAEX;IAEK,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAGlD;IAEK,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAKnF;IAEK,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAG1C;IAEK,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAGvC;IAEK,IAAI,IAAI,OAAO,CAAC,SAAS,MAAM,EAAE,CAAC,CAGvC;IAEK,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAG/B;CACF"}

package/dist/node.js

@@ -14,16 +14,10 @@ import { BaseError } from "@workglow/util";
 
 class StorageError extends BaseError {
   static type = "StorageError";
-  constructor(message) {
-    super(message);
-  }
 }
 
 class StorageValidationError extends StorageError {
   static type = "StorageValidationError";
-  constructor(message) {
-    super(message);
-  }
 }
 
 class StorageEmptyCriteriaError extends StorageValidationError {
@@ -124,14 +118,10 @@ class BaseTabularStorage {
       }
     }
     if (autoGeneratedKeys.length > 1) {
-      throw new Error(`Multiple auto-generated keys detected: ${autoGeneratedKeys.join(", ")}. ` + `Only the first primary key column can be auto-generated.`);
+      throw new Error(`Multiple auto-generated keys detected: ${autoGeneratedKeys.join(", ")}. ` + `At most one primary key column can be auto-generated.`);
     }
     if (autoGeneratedKeys.length > 0) {
       const autoGenKeyName = autoGeneratedKeys[0];
-      const firstPrimaryKey = String(primaryKeyNames[0]);
-      if (autoGenKeyName !== firstPrimaryKey) {
-        throw new Error(`Auto-generated key "${autoGenKeyName}" must be the first primary key column. ` + `Current first primary key is "${firstPrimaryKey}".`);
-      }
       this.autoGeneratedKeyName = autoGenKeyName;
       this.autoGeneratedKeyStrategy = this.determineGenerationStrategy(autoGenKeyName, schema.properties[autoGenKeyName]);
     }
@@ -1117,9 +1107,7 @@ import {
   registerInputResolver
 } from "@workglow/util";
 var TABULAR_REPOSITORIES = createServiceToken5("storage.tabular.repositories");
-if (!globalServiceRegistry.has(TABULAR_REPOSITORIES)) {
-  globalServiceRegistry.register(TABULAR_REPOSITORIES, () => new Map, true);
-}
+globalServiceRegistry.registerIfAbsent(TABULAR_REPOSITORIES, () => new Map, true);
 function getGlobalTabularRepositories() {
   return globalServiceRegistry.get(TABULAR_REPOSITORIES);
 }
@@ -2246,6 +2234,54 @@ class EncryptedKvCredentialStore {
     await this.kv.deleteAll();
   }
 }
+// src/credentials/LazyEncryptedCredentialStore.ts
+class LazyEncryptedCredentialStore {
+  kv;
+  inner;
+  constructor(kv) {
+    this.kv = kv;
+  }
+  get isUnlocked() {
+    return this.inner !== undefined;
+  }
+  unlock(passphrase) {
+    this.inner = new EncryptedKvCredentialStore(this.kv, passphrase);
+  }
+  lock() {
+    this.inner = undefined;
+  }
+  async get(key) {
+    if (!this.inner)
+      return;
+    return this.inner.get(key);
+  }
+  async put(key, value, options) {
+    if (!this.inner) {
+      throw new Error("Credential store is locked. Call unlock() before storing credentials.");
+    }
+    return this.inner.put(key, value, options);
+  }
+  async delete(key) {
+    if (!this.inner)
+      return false;
+    return this.inner.delete(key);
+  }
+  async has(key) {
+    if (!this.inner)
+      return false;
+    return this.inner.has(key);
+  }
+  async keys() {
+    if (!this.inner)
+      return [];
+    return this.inner.keys();
+  }
+  async deleteAll() {
+    if (!this.inner)
+      return;
+    return this.inner.deleteAll();
+  }
+}
 // src/tabular/FsFolderTabularStorage.ts
 import { createServiceToken as createServiceToken12, getLogger as getLogger3, makeFingerprint as makeFingerprint5, sleep as sleep3, uuid4 as uuid43 } from "@workglow/util";
 import { mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
@@ -8291,6 +8327,7 @@ export {
   POSTGRES_KV_REPOSITORY,
   MEMORY_TABULAR_REPOSITORY,
   MEMORY_KV_REPOSITORY,
+  LazyEncryptedCredentialStore,
   KvViaTabularStorage,
   KvStorage,
   KV_REPOSITORY,
@@ -8329,4 +8366,4 @@ export {
   BaseTabularStorage
 };
 
-//# debugId=3F8C2B8863AD982D64756E2164756E21
+//# debugId=9CB3D41A4B06ADAC64756E2164756E21