@cipherstash/stack 0.4.0 → 0.5.0

package/dist/index.cjs

@@ -31,28 +31,15 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   Encryption: () => Encryption,
-  EncryptionErrorTypes: () => EncryptionErrorTypes,
+  Secrets: () => Secrets,
   encryptedColumn: () => encryptedColumn,
   encryptedField: () => encryptedField,
   encryptedTable: () => encryptedTable,
-  getErrorMessage: () => getErrorMessage
+  encryptedToPgComposite: () => encryptedToPgComposite,
+  isEncryptedPayload: () => isEncryptedPayload
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/errors/index.ts
-var EncryptionErrorTypes = {
-  ClientInitError: "ClientInitError",
-  EncryptionError: "EncryptionError",
-  DecryptionError: "DecryptionError",
-  LockContextError: "LockContextError",
-  CtsTokenError: "CtsTokenError"
-};
-function getErrorMessage(error) {
-  if (error instanceof Error) return error.message;
-  if (typeof error === "string") return error;
-  return String(error);
-}
-
 // src/schema/index.ts
 var import_zod = require("zod");
 var castAsEnum = import_zod.z.enum(["bigint", "boolean", "date", "number", "string", "json", "text"]).default("text");
@@ -380,6 +367,15 @@ function buildEncryptConfig(...protectTables) {
   return config;
 }
 
+// src/errors/index.ts
+var EncryptionErrorTypes = {
+  ClientInitError: "ClientInitError",
+  EncryptionError: "EncryptionError",
+  DecryptionError: "DecryptionError",
+  LockContextError: "LockContextError",
+  CtsTokenError: "CtsTokenError"
+};
+
 // src/utils/config/index.ts
 var import_node_fs = __toESM(require("fs"), 1);
 var import_node_path = __toESM(require("path"), 1);
@@ -445,25 +441,33 @@ function loadWorkSpaceId(suppliedCrn) {
 
 // src/utils/logger/index.ts
 var import_evlog = require("evlog");
-function samplingFromEnv() {
-  const env = process.env.STASH_LOG_LEVEL;
-  if (!env) return void 0;
-  const levels = ["debug", "info", "warn", "error"];
-  const idx = levels.indexOf(env);
-  if (idx === -1) return void 0;
-  return Object.fromEntries(levels.map((l, i) => [l, i >= idx ? 100 : 0]));
+var validLevels = ["debug", "info", "error"];
+function levelFromEnv() {
+  const env = process.env.STASH_STACK_LOG;
+  if (env && validLevels.includes(env)) return env;
+  return "error";
+}
+function samplingRatesForLevel(level) {
+  switch (level) {
+    case "debug":
+      return { debug: 100, info: 100, warn: 100, error: 100 };
+    case "info":
+      return { debug: 0, info: 100, warn: 100, error: 100 };
+    case "error":
+    default:
+      return { debug: 0, info: 0, warn: 0, error: 100 };
+  }
 }
 var initialized = false;
-function initStackLogger(config) {
+function initStackLogger() {
   if (initialized) return;
   initialized = true;
-  const rates = samplingFromEnv();
+  const level = levelFromEnv();
+  const rates = samplingRatesForLevel(level);
   (0, import_evlog.initLogger)({
     env: { service: "@cipherstash/stack" },
-    enabled: config?.enabled ?? !!rates,
-    pretty: config?.pretty,
-    ...rates && { sampling: { rates } },
-    ...config?.drain && { drain: config.drain }
+    enabled: true,
+    sampling: { rates }
   });
 }
 initStackLogger();
@@ -501,8 +505,14 @@ var logger = {
 // src/encryption/index.ts
 var import_result11 = require("@byteslice/result");
 var import_protect_ffi9 = require("@cipherstash/protect-ffi");
+var import_uuid = require("uuid");
 
 // src/encryption/helpers/index.ts
+function encryptedToPgComposite(obj) {
+  return {
+    data: obj
+  };
+}
 function encryptedToCompositeLiteral(obj) {
   return `(${JSON.stringify(JSON.stringify(obj))})`;
 }
@@ -2809,23 +2819,14 @@ var EncryptionClient = class {
     };
   }
 };
-
-// src/index.ts
-function isValidUuid(uuid) {
-  const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
-  return uuidRegex.test(uuid);
-}
 var Encryption = async (config) => {
-  if (config.logging) {
-    initStackLogger(config.logging);
-  }
   const { schemas, config: clientConfig } = config;
   if (!schemas.length) {
     throw new Error(
       "[encryption]: At least one encryptedTable must be provided to initialize the encryption client"
     );
   }
-  if (clientConfig?.keyset && "id" in clientConfig.keyset && !isValidUuid(clientConfig.keyset.id)) {
+  if (clientConfig?.keyset && "id" in clientConfig.keyset && !(0, import_uuid.validate)(clientConfig.keyset.id)) {
     throw new Error(
       "[encryption]: Invalid UUID provided for keyset id. Must be a valid UUID."
     );
@@ -2841,13 +2842,350 @@ var Encryption = async (config) => {
   }
   return result.data;
 };
+
+// src/secrets/index.ts
+var Secrets = class {
+  encryptionClient = null;
+  config;
+  apiBaseUrl = process.env.STASH_API_URL || "https://dashboard.cipherstash.com/api/secrets";
+  secretsSchema = encryptedTable("secrets", {
+    value: encryptedColumn("value")
+  });
+  constructor(config) {
+    const workspaceCRN = config.workspaceCRN ?? process.env.CS_WORKSPACE_CRN;
+    const clientId = config.clientId ?? process.env.CS_CLIENT_ID;
+    const clientKey = config.clientKey ?? process.env.CS_CLIENT_KEY;
+    const accessKey = config.accessKey ?? process.env.CS_CLIENT_ACCESS_KEY;
+    if (!workspaceCRN || !clientId || !clientKey || !accessKey) {
+      throw new Error(
+        "Missing required configuration or environment variables."
+      );
+    }
+    this.config = {
+      environment: config.environment,
+      workspaceCRN,
+      clientId,
+      clientKey,
+      accessKey
+    };
+  }
+  initPromise = null;
+  /**
+   * Initialize the Secrets client and underlying Encryption client
+   */
+  async ensureInitialized() {
+    if (!this.initPromise) {
+      this.initPromise = this._doInit();
+    }
+    return this.initPromise;
+  }
+  async _doInit() {
+    logger.debug("Initializing the Secrets client.");
+    this.encryptionClient = await Encryption({
+      schemas: [this.secretsSchema],
+      config: {
+        workspaceCrn: this.config.workspaceCRN,
+        clientId: this.config.clientId,
+        clientKey: this.config.clientKey,
+        accessKey: this.config.accessKey,
+        keyset: { name: this.config.environment }
+      }
+    });
+    logger.debug("Successfully initialized the Secrets client.");
+  }
+  /**
+   * Get the authorization header for API requests
+   */
+  getAuthHeader() {
+    return `Bearer ${this.config.accessKey}`;
+  }
+  /**
+   * Make an API request with error handling.
+   *
+   * For GET requests, `params` are appended as URL query parameters.
+   * For POST requests, `body` is sent as JSON in the request body.
+   */
+  async apiRequest(method, path2, options) {
+    try {
+      let url = `${this.apiBaseUrl}${path2}`;
+      if (options?.params) {
+        const searchParams = new URLSearchParams(options.params);
+        url = `${url}?${searchParams.toString()}`;
+      }
+      logger.debug(`Secrets API request: ${method} ${path2}`);
+      const headers = {
+        "Content-Type": "application/json",
+        Authorization: this.getAuthHeader()
+      };
+      const response = await fetch(url, {
+        method,
+        headers,
+        body: options?.body ? JSON.stringify(options.body) : void 0
+      });
+      if (!response.ok) {
+        const errorText = await response.text();
+        let errorMessage = `API request failed with status ${response.status}`;
+        try {
+          const errorJson = JSON.parse(errorText);
+          errorMessage = errorJson.message || errorJson.error || errorMessage;
+        } catch {
+          errorMessage = errorText || errorMessage;
+        }
+        logger.error(`Secrets API error on ${method} ${path2}: ${errorMessage}`);
+        return {
+          failure: {
+            type: "ApiError",
+            message: errorMessage
+          }
+        };
+      }
+      logger.debug(`Secrets API request successful: ${method} ${path2}`);
+      const data = await response.json();
+      return { data };
+    } catch (error) {
+      const message = error instanceof Error ? error.message : "Unknown network error occurred";
+      logger.error(`Secrets network error on ${method} ${path2}: ${message}`);
+      return {
+        failure: {
+          type: "NetworkError",
+          message
+        }
+      };
+    }
+  }
+  /**
+   * Store an encrypted secret in the vault.
+   * The value is encrypted locally before being sent to the API.
+   *
+   * API: POST /api/secrets/set
+   *
+   * @param name - The name of the secret
+   * @param value - The plaintext value to encrypt and store
+   * @returns A Result containing the API response or an error
+   */
+  async set(name, value) {
+    logger.debug("Setting secret");
+    await this.ensureInitialized();
+    if (!this.encryptionClient) {
+      return {
+        failure: {
+          type: "ClientError",
+          message: "Failed to initialize Encryption client"
+        }
+      };
+    }
+    const encryptResult = await this.encryptionClient.encrypt(value, {
+      column: this.secretsSchema.value,
+      table: this.secretsSchema
+    });
+    if (encryptResult.failure) {
+      logger.error("Failed to encrypt secret");
+      return {
+        failure: {
+          type: "EncryptionError",
+          message: encryptResult.failure.message
+        }
+      };
+    }
+    const workspaceId = extractWorkspaceIdFromCrn(this.config.workspaceCRN);
+    return await this.apiRequest("POST", "/set", {
+      body: {
+        workspaceId,
+        environment: this.config.environment,
+        name,
+        encryptedValue: encryptedToPgComposite(encryptResult.data)
+      }
+    });
+  }
+  /**
+   * Retrieve and decrypt a secret from the vault.
+   * The secret is decrypted locally after retrieval.
+   *
+   * API: GET /api/secrets/get?workspaceId=...&environment=...&name=...
+   *
+   * @param name - The name of the secret to retrieve
+   * @returns A Result containing the decrypted value or an error
+   */
+  async get(name) {
+    logger.debug("Getting secret");
+    await this.ensureInitialized();
+    if (!this.encryptionClient) {
+      return {
+        failure: {
+          type: "ClientError",
+          message: "Failed to initialize Encryption client"
+        }
+      };
+    }
+    const workspaceId = extractWorkspaceIdFromCrn(this.config.workspaceCRN);
+    const apiResult = await this.apiRequest("GET", "/get", {
+      params: {
+        workspaceId,
+        environment: this.config.environment,
+        name
+      }
+    });
+    if (apiResult.failure) {
+      return apiResult;
+    }
+    const decryptResult = await this.encryptionClient.decrypt(
+      apiResult.data.encryptedValue.data
+    );
+    if (decryptResult.failure) {
+      logger.error("Failed to decrypt secret");
+      return {
+        failure: {
+          type: "DecryptionError",
+          message: decryptResult.failure.message
+        }
+      };
+    }
+    if (typeof decryptResult.data !== "string") {
+      logger.error("Decrypted secret value is not a string");
+      return {
+        failure: {
+          type: "DecryptionError",
+          message: "Decrypted value is not a string"
+        }
+      };
+    }
+    return { data: decryptResult.data };
+  }
+  /**
+   * Retrieve and decrypt many secrets from the vault.
+   * The secrets are decrypted locally after retrieval.
+   * This method only triggers a single network request to the ZeroKMS.
+   *
+   * API: GET /api/secrets/get-many?workspaceId=...&environment=...&names=name1,name2,...
+   *
+   * Constraints:
+   *   - Minimum 2 secret names required
+   *   - Maximum 100 secret names per request
+   *
+   * @param names - The names of the secrets to retrieve (min 2, max 100)
+   * @returns A Result containing an object mapping secret names to their decrypted values
+   */
+  async getMany(names) {
+    logger.debug(`Getting ${names.length} secrets.`);
+    await this.ensureInitialized();
+    if (!this.encryptionClient) {
+      return {
+        failure: {
+          type: "ClientError",
+          message: "Failed to initialize Encryption client"
+        }
+      };
+    }
+    if (names.length < 2) {
+      return {
+        failure: {
+          type: "ClientError",
+          message: "At least 2 secret names are required for getMany"
+        }
+      };
+    }
+    if (names.length > 100) {
+      return {
+        failure: {
+          type: "ClientError",
+          message: "Maximum 100 secret names per request"
+        }
+      };
+    }
+    const workspaceId = extractWorkspaceIdFromCrn(this.config.workspaceCRN);
+    const apiResult = await this.apiRequest(
+      "GET",
+      "/get-many",
+      {
+        params: {
+          workspaceId,
+          environment: this.config.environment,
+          names: names.join(",")
+        }
+      }
+    );
+    if (apiResult.failure) {
+      return apiResult;
+    }
+    const dataToDecrypt = apiResult.data.map((item) => ({
+      name: item.name,
+      value: item.encryptedValue.data
+    }));
+    const decryptResult = await this.encryptionClient.bulkDecryptModels(dataToDecrypt);
+    if (decryptResult.failure) {
+      logger.error(
+        `Failed to decrypt secrets: ${decryptResult.failure.message}`
+      );
+      return {
+        failure: {
+          type: "DecryptionError",
+          message: decryptResult.failure.message
+        }
+      };
+    }
+    const decryptedSecrets = decryptResult.data;
+    const secretsMap = {};
+    for (const secret of decryptedSecrets) {
+      if (secret.name && secret.value) {
+        secretsMap[secret.name] = secret.value;
+      }
+    }
+    return { data: secretsMap };
+  }
+  /**
+   * List all secrets in the environment.
+   * Only names and metadata are returned; values remain encrypted.
+   *
+   * API: GET /api/secrets/list?workspaceId=...&environment=...
+   *
+   * @returns A Result containing the list of secrets or an error
+   */
+  async list() {
+    logger.debug("Listing secrets.");
+    const workspaceId = extractWorkspaceIdFromCrn(this.config.workspaceCRN);
+    const apiResult = await this.apiRequest(
+      "GET",
+      "/list",
+      {
+        params: {
+          workspaceId,
+          environment: this.config.environment
+        }
+      }
+    );
+    if (apiResult.failure) {
+      return apiResult;
+    }
+    return { data: apiResult.data.secrets };
+  }
+  /**
+   * Delete a secret from the vault.
+   *
+   * API: POST /api/secrets/delete
+   *
+   * @param name - The name of the secret to delete
+   * @returns A Result containing the API response or an error
+   */
+  async delete(name) {
+    logger.debug("Deleting secret");
+    const workspaceId = extractWorkspaceIdFromCrn(this.config.workspaceCRN);
+    return await this.apiRequest("POST", "/delete", {
+      body: {
+        workspaceId,
+        environment: this.config.environment,
+        name
+      }
+    });
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Encryption,
-  EncryptionErrorTypes,
+  Secrets,
   encryptedColumn,
   encryptedField,
   encryptedTable,
-  getErrorMessage
+  encryptedToPgComposite,
+  isEncryptedPayload
 });
 //# sourceMappingURL=index.cjs.map