@pipedream/sonix 0.1.0 → 1.0.1

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Sonix API enables automated transcription of audio and video files into text, offering functions like uploading media, managing files, and retrieving transcripts. Leveraging Pipedream’s capabilities, you can integrate the Sonix API with various services to streamline media processing workflows, making transcription tasks more efficient. By automating interactions with Sonix, you can trigger actions based on the transcription status, analyze content, and connect transcribed text with other apps for further processing or analysis.
+
+# Example Use Cases
+
+- **Transcription Triggered from Cloud Storage Upload**: When a new audio file is uploaded to cloud storage (e.g., Google Drive), Pipedream detects the event and triggers a workflow that uploads the file to Sonix for transcription. Once the transcript is ready, it can be saved back to Google Drive or sent via email.
+
+- **Media Management with Slack Notifications**: Use Pipedream to monitor your Sonix account for new transcripts. When a transcript is completed, send a notification with details and a download link to a designated Slack channel. This keeps the team updated on transcription progress in real-time without manual checks.
+
+- **Content Analysis and Keyword Extraction**: After a transcript is generated, a workflow can pass the text to a natural language processing (NLP) service, like the Google Cloud Language API, to extract keywords and analyze sentiment. The results could then be sent to a Google Sheet for tracking trends over time.

package/actions/upload-media/upload-media.mjs

@@ -1,29 +1,20 @@
-import { ConfigurationError } from "@pipedream/platform";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
 import FormData from "form-data";
-import fs from "fs";
 import { LANGUAGE_OPTIONS } from "../../common/constants.mjs";
-import { checkTmp } from "../../common/utils.mjs";
 import sonix from "../../sonix.app.mjs";
 
 export default {
   key: "sonix-upload-media",
   name: "Upload Media",
   description: "Submits new media for processing. [See the documentation](https://sonix.ai/docs/api#new_media)",
-  version: "0.0.1",
+  version: "1.0.1",
   type: "action",
   props: {
     sonix,
     file: {
       type: "string",
-      label: "File",
-      description: "Path of the audio or video file in /tmp folder. The limit is 100MB using this parameter. For larger files, use **File URL**. `NOTE: Only one of **File** or **File URL** is required.` 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)",
-      optional: true,
-    },
-    fileUrl: {
-      type: "string",
-      label: "File URL",
-      description: "URL pointing to the audio/video file. `NOTE: Only one of **File** or **File URL** is required.`",
-      optional: true,
+      label: "File Path or URL",
+      description: "The audio or video file to upload (max 100MB). Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)",
     },
     language: {
       type: "string",
@@ -68,20 +59,25 @@ export default {
       description: "URL for Sonix to make a POST request notifying of a change in transcript status (either failed or completed). The POST will include the media status JSON.",
       optional: true,
     },
+    syncDir: {
+      type: "dir",
+      accessMode: "read",
+      sync: true,
+      optional: true,
+    },
   },
   async run({ $ }) {
-    if (!this.file && !this.fileUrl) {
-      throw new ConfigurationError("You must provite whether **File** or **File URL**.");
-    }
-
     const formData = new FormData();
 
-    if (this.file) {
-      const filePath = checkTmp(this.file);
-      formData.append("file", fs.createReadStream(filePath));
-    }
+    const {
+      stream, metadata,
+    } = await getFileStreamAndMetadata(this.file);
+    formData.append("file", stream, {
+      contentType: metadata.contentType,
+      knownLength: metadata.size,
+      filename: metadata.name,
+    });
 
-    this.fileUrl && formData.append("file_url", this.fileUrl);
     this.language && formData.append("language", this.language);
     this.name && formData.append("name", this.name);
     this.transcriptText && formData.append("transcript_text", `${this.transcriptText}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/sonix",
-  "version": "0.1.0",
+  "version": "1.0.1",
   "description": "Pipedream Sonix Components",
   "main": "sonix.app.mjs",
   "keywords": [
@@ -13,8 +13,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.5.1",
-    "form-data": "^4.0.0",
-    "fs": "^0.0.1-security"
+    "@pipedream/platform": "^3.1.0",
+    "form-data": "^4.0.0"
   }
 }