@pipedream/jobnimbus 0.1.0 → 1.0.0

package/README.md

@@ -1,12 +1,11 @@
 # Overview
 
-Jobnimbus API can be used to create custom applications for managing job
-information.
+The Jobnimbus API allows for the creation of complex workflows revolving around job and customer management within the construction and contracting industries. With this API, users can automate tasks such as updating job statuses, managing contacts, and creating tasks or appointments. This streamlines the process of moving a job from lead to completion, ensuring communication and record-keeping are seamless.
 
-Some examples of what you can build using the Jobnimbus API include:
+# Example Use Cases
 
-- A custom job board
-- A job search engine
-- A job management system
-- A CRM for job-related information
-- A job-related data analytics platform
+- **Automated Job Status Updates**: Trigger a Pipedream workflow whenever a job status is updated in Jobnimbus to send a custom notification via SMS or email through Twilio or SendGrid. This keeps team members in the loop in real-time about job progress.
+
+- **Dynamic Contact Import**: When a new contact is added to a Google Sheet, use Pipedream to automatically create a corresponding contact in Jobnimbus. This ensures your customer database is always synchronized and up-to-date without manual entry.
+
+- **Task Management with Calendar Integration**: On creation of a new task in Jobnimbus, trigger a Pipedream workflow to add an event to a Google Calendar, inviting all relevant team members. This automation helps in scheduling and making sure everyone is aware of their assignments.

package/actions/create-attachment/create-attachment.mjs

@@ -1,21 +1,22 @@
 import app from "../../jobnimbus.app.mjs";
 import utils from "../../common/utils.mjs";
 import { attachmentTypes } from "../../common/constants.mjs";
-import { ConfigurationError } from "@pipedream/platform";
-import fs from "fs";
+import {
+  ConfigurationError, getFileStream,
+} from "@pipedream/platform";
 
 export default {
   key: "jobnimbus-create-attachment",
-  version: "0.0.1",
+  version: "1.0.0",
   type: "action",
   name: "Create Attachment",
   description: "Creates an attachment. [See the documentation](https://documenter.getpostman.com/view/3919598/S11PpG4x#5f3f485b-91f9-4ed9-912c-99a07987ac6c)",
   props: {
     app,
-    filePath: {
+    file: {
       type: "string",
-      label: "File Path",
-      description: "The file to upload, please provide a valid file from `/tmp`. To upload a file to `/tmp` folder, please follow the doc [here](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
+      label: "File Path or URL",
+      description: "The file to upload. Provide a file URL or a path to a file in the `/tmp` directory.",
     },
     type: {
       type: "string",
@@ -43,22 +44,34 @@ export default {
       optional: true,
     },
   },
+  methods: {
+    streamToBase64(stream) {
+      return new Promise((resolve, reject) => {
+        const chunks = [];
+        stream.on("data", (chunk) => chunks.push(chunk));
+        stream.on("end", () => {
+          const buffer = Buffer.concat(chunks);
+          resolve(buffer.toString("base64"));
+        });
+        stream.on("error", reject);
+      });
+    },
+  },
   async run ({ $ }) {
-    const filePath = utils.isValidFile(this.filePath);
-    if (!filePath) {
-      throw new ConfigurationError("`File Path` must be a valid file path!");
+    if (!this.file) {
+      throw new ConfigurationError("The `File Path or URL` prop is required.");
     }
-    const fileData = fs.readFileSync(filePath, {
-      flag: "r",
-      encoding: "base64",
-    });
+
+    const stream = await getFileStream(this.file);
+    const fileData = await this.streamToBase64(stream);
+
     const data = {
       ...utils.extractProps(this, {
         customerIdFromContacts: "customer",
       }),
       data: fileData,
     };
-    delete data["filePath"];
+    delete data.file;
     const resp = await this.app.createAttachment({
       $,
       data,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/jobnimbus",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Pipedream Jobnimbus Components",
   "main": "jobnimbus.app.mjs",
   "keywords": [
@@ -9,10 +9,10 @@
   ],
   "homepage": "https://pipedream.com/apps/jobnimbus",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
-  "dependencies": {
-    "@pipedream/platform": "^1.5.1"
-  },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.0"
   }
 }