feat(folder-scoped-integration): implemented api changes for integrations to support folders

2026-10-15 12:38:36 +00:00 · 2023-06-15 22:46:39 +05:30
parent c77ebd4d0e
commit 2471418591
8 changed files with 599 additions and 485 deletions
@@ -1,110 +1,112 @@
-import { Types } from 'mongoose';
+import { Types } from "mongoose";
 import {
-    getSecretsBotHelper,
-    encryptSymmetricHelper,
-    decryptSymmetricHelper,
-    getKey,
-    getIsWorkspaceE2EEHelper
-} from '../helpers/bot';
+  getSecretsBotHelper,
+  encryptSymmetricHelper,
+  decryptSymmetricHelper,
+  getKey,
+  getIsWorkspaceE2EEHelper,
+} from "../helpers/bot";

 /**
 * Class to handle bot actions
 */
 class BotService {
-    
-    /**
-     * Return whether or not workspace with id [workspaceId] is end-to-end encrypted
-     * @param workspaceId - id of workspace
-     * @returns {Boolean}
-     */
-    static async getIsWorkspaceE2EE(workspaceId: Types.ObjectId) {
-        return await getIsWorkspaceE2EEHelper(workspaceId);
-    }
+  /**
+   * Return whether or not workspace with id [workspaceId] is end-to-end encrypted
+   * @param workspaceId - id of workspace
+   * @returns {Boolean}
+   */
+  static async getIsWorkspaceE2EE(workspaceId: Types.ObjectId) {
+    return await getIsWorkspaceE2EEHelper(workspaceId);
+  }

-    /**
-     * Get workspace key for workspace with id [workspaceId] shared to bot.
-     * @param {Object} obj
-     * @param {Types.ObjectId} obj.workspaceId - id of workspace to get workspace key for
-     * @returns 
-     */
-    static async getWorkspaceKeyWithBot({
-        workspaceId
-    }: {
-        workspaceId: Types.ObjectId;
-    }) {
-        return await getKey({
-            workspaceId
-        });
-    }
-    
-    /**
-     * Return decrypted secrets for workspace with id [workspaceId] and 
-     * environment [environmen] shared to bot.
-     * @param {Object} obj
-     * @param {String} obj.workspaceId - id of workspace of secrets
-     * @param {String} obj.environment - environment for secrets
-     * @returns {Object} secretObj - object where keys are secret keys and values are secret values
-     */
-    static async getSecrets({
-        workspaceId,
-        environment
-    }: {
-        workspaceId: Types.ObjectId;
-        environment: string;
-    }) {
-        return await getSecretsBotHelper({
-            workspaceId,
-            environment
-        });
-    }
-    
-    /**
-     * Return symmetrically encrypted [plaintext] using the
-     * bot's copy of the workspace key for workspace with id [workspaceId] 
-     * @param {Object} obj
-     * @param {String} obj.workspaceId - id of workspace
-     * @param {String} obj.plaintext - plaintext to encrypt
-     */
-    static async encryptSymmetric({
-        workspaceId,
-        plaintext
-    }: {
-        workspaceId: Types.ObjectId;
-        plaintext: string;
-    }) {
-        return await encryptSymmetricHelper({
-            workspaceId,
-            plaintext
-        });
-    }
-    
-    /**
-     * Return symmetrically decrypted [ciphertext] using the
-     * bot's copy of the workspace key for workspace with id [workspaceId]
-     * @param {Object} obj
-     * @param {String} obj.workspaceId - id of workspace
-     * @param {String} obj.ciphertext - ciphertext to decrypt
-     * @param {String} obj.iv - iv
-     * @param {String} obj.tag - tag
-     */
-    static async decryptSymmetric({
-        workspaceId,
-        ciphertext,
-        iv,
-        tag
-    }: {
-        workspaceId: Types.ObjectId;
-        ciphertext: string;
-        iv: string;
-        tag: string;
-    }) {
-        return await decryptSymmetricHelper({
-            workspaceId,
-            ciphertext,
-            iv,
-            tag
-        });
-    }
+  /**
+   * Get workspace key for workspace with id [workspaceId] shared to bot.
+   * @param {Object} obj
+   * @param {Types.ObjectId} obj.workspaceId - id of workspace to get workspace key for
+   * @returns
+   */
+  static async getWorkspaceKeyWithBot({
+    workspaceId,
+  }: {
+    workspaceId: Types.ObjectId;
+  }) {
+    return await getKey({
+      workspaceId,
+    });
+  }
+
+  /**
+   * Return decrypted secrets for workspace with id [workspaceId] and
+   * environment [environmen] shared to bot.
+   * @param {Object} obj
+   * @param {String} obj.workspaceId - id of workspace of secrets
+   * @param {String} obj.environment - environment for secrets
+   * @returns {Object} secretObj - object where keys are secret keys and values are secret values
+   */
+  static async getSecrets({
+    workspaceId,
+    environment,
+    secretPath,
+  }: {
+    workspaceId: Types.ObjectId;
+    environment: string;
+    secretPath: string;
+  }) {
+    return await getSecretsBotHelper({
+      workspaceId,
+      environment,
+      secretPath,
+    });
+  }
+
+  /**
+   * Return symmetrically encrypted [plaintext] using the
+   * bot's copy of the workspace key for workspace with id [workspaceId]
+   * @param {Object} obj
+   * @param {String} obj.workspaceId - id of workspace
+   * @param {String} obj.plaintext - plaintext to encrypt
+   */
+  static async encryptSymmetric({
+    workspaceId,
+    plaintext,
+  }: {
+    workspaceId: Types.ObjectId;
+    plaintext: string;
+  }) {
+    return await encryptSymmetricHelper({
+      workspaceId,
+      plaintext,
+    });
+  }
+
+  /**
+   * Return symmetrically decrypted [ciphertext] using the
+   * bot's copy of the workspace key for workspace with id [workspaceId]
+   * @param {Object} obj
+   * @param {String} obj.workspaceId - id of workspace
+   * @param {String} obj.ciphertext - ciphertext to decrypt
+   * @param {String} obj.iv - iv
+   * @param {String} obj.tag - tag
+   */
+  static async decryptSymmetric({
+    workspaceId,
+    ciphertext,
+    iv,
+    tag,
+  }: {
+    workspaceId: Types.ObjectId;
+    ciphertext: string;
+    iv: string;
+    tag: string;
+  }) {
+    return await decryptSymmetricHelper({
+      workspaceId,
+      ciphertext,
+      iv,
+      tag,
+    });
+  }
 }

-export default BotService;
+export default BotService;