[Components] openum

Author: jcortes

components/openum/actions/start-signature/start-signature.mjs

@@ -0,0 +1,120 @@
+import {
+  ConfigurationError, getFileStreamAndMetadata,
+} from "@pipedream/platform";
+import app from "../../openum.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "openum-start-signature",
+  name: "Start Signature",
+  description: "Initiates an electronic document delivery process to recipient(s). [See the documentation](https://api.lleida.net/dtd/openum/v1/en/)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    app,
+    requestId: {
+      type: "string",
+      label: "Request ID",
+      description: "Optional reference of the request.",
+      optional: true,
+    },
+    configId: {
+      propDefinition: [
+        app,
+        "configId",
+      ],
+    },
+    contractId: {
+      type: "string",
+      label: "Contract ID",
+      description: "Client reference of the process. This reference is provided as the unique identifier for the process. If `auto_cancel` is enabled in the configuration and an existing reference is specified, the previous pending process will be automatically canceled.",
+    },
+    levels: {
+      type: "string",
+      label: "Levels",
+      description: `Definition of the viewing level/order as a JSON array. Each level object supports: \`level_order\` (integer, 0 to N), \`required_signatories_to_complete_level\` (optional integer), and \`signatories\` (array of recipient objects with fields: \`phone\`, \`email\`, \`name\`, \`surname\`, \`id_number\`, \`landing_access_methods\`, \`landing_access_code\`, \`landing_information\`). The maximum is 20 recipients across all levels.
+
+**Example**:
+\`\`\`json
+[
+  {
+    "level_order": 0,
+    "signatories": [{
+      "email": "user@example.com",
+      "name": "John",
+      "surname": "Doe",
+      "phone": "+34666666666"
+    }]
+  }
+]
+\`\`\`
+`,
+    },
+    filePaths: {
+      type: "string[]",
+      label: "Files",
+      description: "PDF files to deliver to the recipients. Provide paths to files in the `/tmp` directory (e.g. `/tmp/contract.pdf`) or direct URLs to PDF files. Only PDF format is accepted. Maximum 20 files, 25 MB total.",
+    },
+    syncDir: {
+      type: "dir",
+      accessMode: "read",
+      sync: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      requestId,
+      configId,
+      contractId,
+      levels,
+      filePaths,
+    } = this;
+
+    const parsedLevels = utils.parseJson(levels);
+
+    const invalidFiles = filePaths.filter((filePath) => !utils.isPdf(filePath));
+    if (invalidFiles.length) {
+      throw new ConfigurationError(`Only PDF files are allowed. Invalid files: ${invalidFiles.join(", ")}`);
+    }
+
+    const files = await Promise.all(
+      filePaths.map(async (filePath) => {
+        const {
+          stream, metadata,
+        } = await getFileStreamAndMetadata(filePath);
+        const content = await utils.streamToBase64Url(stream);
+        return {
+          filename: metadata.name,
+          content,
+          sign_on_landing: "Y",
+        };
+      }),
+    );
+
+    const response = await app.startSignature({
+      $,
+      data: {
+        request: "START_SIGNATURE",
+        ...(requestId && {
+          request_id: requestId,
+        }),
+        user: app.getUsername(),
+        signature: {
+          config_id: configId,
+          contract_id: contractId,
+          level: parsedLevels,
+          file: files,
+        },
+      },
+    });
+
+    $.export("$summary", `Successfully started signature process with ID \`${response.signature?.signature_id}\``);
+    return response;
+  },
+};

components/openum/common/utils.mjs

@@ -0,0 +1,31 @@
+import { ConfigurationError } from "@pipedream/platform";
+
+const parseJson = (value) => {
+  if (typeof value !== "string") {
+    return value;
+  }
+  try {
+    return JSON.parse(value);
+  } catch {
+    throw new ConfigurationError("Must be a valid JSON value.");
+  }
+};
+
+const isPdf = (filePath) => {
+  const path = filePath.split("?")[0].split("#")[0];
+  return path.toLowerCase().endsWith(".pdf");
+};
+
+const streamToBase64Url = async (stream) => {
+  const chunks = [];
+  for await (const chunk of stream) {
+    chunks.push(chunk);
+  }
+  return Buffer.concat(chunks).toString("base64url");
+};
+
+export default {
+  isPdf,
+  parseJson,
+  streamToBase64Url,
+};

components/openum/openum.app.mjs

@@ -1,11 +1,71 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "openum",
-  propDefinitions: {},
+  propDefinitions: {
+    configId: {
+      type: "string",
+      label: "Config ID",
+      description: "Numerical ID of the configuration.",
+      async options() {
+        const { config } = await this.getConfigList({
+          data: {
+            request: "GET_CONFIG_LIST",
+            user: this.getUsername(),
+            status: "enabled",
+          },
+        });
+        return config
+          .map(({
+            config_id: value, name,
+          }) => ({
+            label: name || value,
+            value,
+          }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    getUsername() {
+      return this.$auth.username;
+    },
+    _baseUrl() {
+      return "https://api.lleida.net/cs/v1";
+    },
+    _headers() {
+      return {
+        "Authorization": `x-api-key ${this.$auth.api_key}`,
+        "Content-Type": "application/json; charset=utf-8",
+        "Accept": "application/json",
+      };
+    },
+    async _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      const response = await axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: this._headers(),
+        ...opts,
+      });
+      if (response.code !== 200) {
+        throw new Error(JSON.stringify(response, null, 2));
+      }
+      return response;
+    },
+    getConfigList(opts = {}) {
+      return this._makeRequest({
+        path: "/get_config_list",
+        method: "POST",
+        ...opts,
+      });
+    },
+    startSignature(opts = {}) {
+      return this._makeRequest({
+        path: "/start_signature",
+        method: "POST",
+        ...opts,
+      });
     },
   },
-};
+};

components/openum/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/openum",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Openum Components",
   "main": "openum.app.mjs",
   "keywords": [
@@ -12,4 +12,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}