@pipedream/trint 0.0.3 → 0.1.1

package/actions/get-transcript/get-transcript.mjs

@@ -0,0 +1,39 @@
+import trint from "../../trint.app.mjs";
+import downloadFormats from "../../common/download-formats.mjs";
+
+export default {
+  key: "trint-get-transcript",
+  name: "Get Transcript",
+  description: "Retrieve the full transcription of a processed media file. [See the documentation](https://dev.trint.com/reference/get-file)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    trint,
+    transcriptId: {
+      propDefinition: [
+        trint,
+        "transcriptId",
+      ],
+    },
+    format: {
+      type: "string",
+      label: "Format",
+      description: "The format to export the transcript in. Will return JSON, HTML, or a URL to the transcript in the selected format.",
+      options: downloadFormats,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.trint.getTranscript({
+      $,
+      format: this.format,
+      transcriptId: this.transcriptId,
+    });
+    $.export("$summary", `Successfully retrieved transcript for transcript ID: ${this.transcriptId}`);
+    return response;
+  },
+};

package/actions/upload-file/upload-file.mjs

@@ -0,0 +1,102 @@
+import trint from "../../trint.app.mjs";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
+import languages from "../../common/languages.mjs";
+
+export default {
+  key: "trint-upload-file",
+  name: "Upload File",
+  description: "Upload media files directly to Trint for immediate transcription. [See the documentation](https://dev.trint.com/reference/upload)",
+  version: "0.0.2",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    trint,
+    filePath: {
+      type: "string",
+      label: "File Path or URL",
+      description: "The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.mp4`)",
+      format: "file-ref",
+    },
+    language: {
+      type: "string",
+      label: "Language",
+      description: "The language to transcribe",
+      options: languages,
+      optional: true,
+    },
+    detectSpeakerChange: {
+      type: "boolean",
+      label: "Detect Speaker Change",
+      description: "Automatically split paragraphs based on change of speaker. If the parameter is not specified it defaults to `true`.",
+      optional: true,
+    },
+    workspaceId: {
+      propDefinition: [
+        trint,
+        "workspaceId",
+      ],
+      optional: true,
+    },
+    folderId: {
+      propDefinition: [
+        trint,
+        "folderId",
+        (c) => ({
+          workspaceId: c.workspaceId,
+        }),
+      ],
+      optional: true,
+    },
+    customDictionary: {
+      type: "boolean",
+      label: "Custom Dictionary",
+      description: "Use the Vocab Builder during the transcription of the file. If the parameter is not specified it defaults to `true`.",
+      optional: true,
+    },
+    syncDir: {
+      type: "dir",
+      accessMode: "read",
+      sync: true,
+      optional: true,
+    },
+  },
+  methods: {
+    streamToBuffer(stream) {
+      return new Promise((resolve, reject) => {
+        const chunks = [];
+        stream.on("data", (chunk) => chunks.push(chunk));
+        stream.on("end", () => resolve(Buffer.concat(chunks)));
+        stream.on("error", reject);
+      });
+    },
+  },
+  async run({ $ }) {
+    const {
+      stream, metadata,
+    } = await getFileStreamAndMetadata(this.filePath);
+    const fileBinary = await this.streamToBuffer(stream);
+
+    const response = await this.trint.uploadFile({
+      $,
+      params: {
+        "filename": metadata.name,
+        "language": this.language,
+        "detect-speaker-change": this.detectSpeakerChange,
+        "custom-dictionary": this.customDictionary,
+        "workspace-id": this.workspaceId,
+        "folder-id": this.folderId,
+      },
+      headers: {
+        "Content-Type": metadata.contentType || "application/octet-stream",
+      },
+      data: Buffer.from(fileBinary, "binary"),
+    });
+
+    $.export("$summary", `Successfully uploaded file to Trint: ${response.trintId}`);
+    return response;
+  },
+};

package/common/download-formats.mjs

@@ -0,0 +1,66 @@
+export default [
+  {
+    label: "JSON",
+    value: "json",
+  },
+  {
+    label: "HTML",
+    value: "html",
+  },
+  {
+    label: "Edit Decision List",
+    value: "edl",
+  },
+  {
+    label: "Comments",
+    value: "csv/comments",
+  },
+  {
+    label: "Avid DS",
+    value: "avid-ds",
+  },
+  {
+    label: "Highlights",
+    value: "csv/highlights",
+  },
+  {
+    label: "Transcript",
+    value: "csv/full",
+  },
+  {
+    label: "Markers",
+    value: "csv/markers",
+  },
+  {
+    label: "Microsoft Word",
+    value: "docx",
+  },
+  {
+    label: "XML",
+    value: "xml",
+  },
+  {
+    label: "Premiere XML",
+    value: "premiere-xml",
+  },
+  {
+    label: "Spruce STL",
+    value: "spruce-stl",
+  },
+  {
+    label: "SubRip SRT",
+    value: "srt",
+  },
+  {
+    label: "Telestream Vantage XML",
+    value: "vantage-xml",
+  },
+  {
+    label: "Text",
+    value: "text",
+  },
+  {
+    label: "WebVTT",
+    value: "webvtt",
+  },
+];

package/common/languages.mjs

@@ -0,0 +1,218 @@
+export default [
+  {
+    value: "en-GB",
+    label: "English (British spelling)",
+  },
+  {
+    value: "en",
+    label: "English (American spelling)",
+  },
+  {
+    value: "es",
+    label: "Spanish",
+  },
+  {
+    value: "de",
+    label: "German",
+  },
+  {
+    value: "ar",
+    label: "Arabic",
+  },
+  {
+    value: "bg",
+    label: "Bulgarian",
+  },
+  {
+    value: "bn",
+    label: "Bengali",
+  },
+  {
+    value: "ca",
+    label: "Catalan",
+  },
+  {
+    value: "cmn",
+    label: "Chinese Mandarin",
+  },
+  {
+    value: "hr",
+    label: "Croatian",
+  },
+  {
+    value: "cs",
+    label: "Czech",
+  },
+  {
+    value: "da",
+    label: "Danish",
+  },
+  {
+    value: "nl",
+    label: "Dutch",
+  },
+  {
+    value: "fa",
+    label: "Farsi (Persian)",
+  },
+  {
+    value: "fi",
+    label: "Finnish",
+  },
+  {
+    value: "fr",
+    label: "French",
+  },
+  {
+    value: "el",
+    label: "Greek",
+  },
+  {
+    value: "he",
+    label: "Hebrew",
+  },
+  {
+    value: "hi",
+    label: "Hindi",
+  },
+  {
+    value: "hu",
+    label: "Hungarian",
+  },
+  {
+    value: "it",
+    label: "Italian",
+  },
+  {
+    value: "ja",
+    label: "Japanese",
+  },
+  {
+    value: "ko",
+    label: "Korean",
+  },
+  {
+    value: "lv",
+    label: "Latvian",
+  },
+  {
+    value: "lt",
+    label: "Lithuanian",
+  },
+  {
+    value: "ms",
+    label: "Malay",
+  },
+  {
+    value: "no",
+    label: "Norwegian",
+  },
+  {
+    value: "pl",
+    label: "Polish",
+  },
+  {
+    value: "pt",
+    label: "Portuguese",
+  },
+  {
+    value: "ro",
+    label: "Romanian",
+  },
+  {
+    value: "ru",
+    label: "Russian",
+  },
+  {
+    value: "sk",
+    label: "Slovakian",
+  },
+  {
+    value: "sl",
+    label: "Slovenian",
+  },
+  {
+    value: "sv",
+    label: "Swedish",
+  },
+  {
+    value: "sw",
+    label: "Swahili",
+  },
+  {
+    value: "tr",
+    label: "Turkish",
+  },
+  {
+    value: "id",
+    label: "Indonesian",
+  },
+  {
+    value: "uk",
+    label: "Ukrainian",
+  },
+  {
+    value: "yue",
+    label: "Cantonese",
+  },
+  {
+    value: "cy",
+    label: "Welsh",
+  },
+  {
+    value: "ba",
+    label: "Bashkir",
+  },
+  {
+    value: "eu",
+    label: "Basque",
+  },
+  {
+    value: "be",
+    label: "Belarusian",
+  },
+  {
+    value: "et",
+    label: "Estonian",
+  },
+  {
+    value: "ga",
+    label: "Irish",
+  },
+  {
+    value: "gl",
+    label: "Galician",
+  },
+  {
+    value: "mn",
+    label: "Mongolian",
+  },
+  {
+    value: "mr",
+    label: "Marathi",
+  },
+  {
+    value: "mt",
+    label: "Maltese",
+  },
+  {
+    value: "ta",
+    label: "Tamil",
+  },
+  {
+    value: "th",
+    label: "Thai",
+  },
+  {
+    value: "ug",
+    label: "Uyghur",
+  },
+  {
+    value: "ur",
+    label: "Urdu",
+  },
+  {
+    value: "vi",
+    label: "Vietnamese",
+  },
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/trint",
-  "version": "0.0.3",
+  "version": "0.1.1",
   "description": "Pipedream Trint Components",
   "main": "trint.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.2.2"
   }
 }

package/sources/common/base-webhook.mjs

@@ -0,0 +1,53 @@
+import trint from "../../trint.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  props: {
+    trint,
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+  },
+  hooks: {
+    async activate() {
+      await this.trint.registerWebhook({
+        data: {
+          callbackUrl: this.http.endpoint,
+          callbackSubscriptions: this.getEventTypes(),
+        },
+      });
+    },
+    async deactivate() {
+      await this.trint.deregisterWebhook({
+        data: {
+          callbackUrl: this.http.endpoint,
+        },
+      });
+    },
+  },
+  methods: {
+    getEventTypes() {
+      throw new ConfigurationError("getEventTypes is not implemented");
+    },
+    generateMeta(body) {
+      return {
+        id: body.transcriptId,
+        summary: `New ${body.eventType} event`,
+        ts: Date.now(),
+      };
+    },
+  },
+  async run({ body }) {
+    this.http.respond({
+      status: 200,
+    });
+
+    if (!body) {
+      return;
+    }
+
+    const meta = this.generateMeta(body);
+    this.$emit(body, meta);
+  },
+};

package/sources/new-transcript-complete/new-transcript-complete.mjs

@@ -0,0 +1,21 @@
+import common from "../common/base-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "trint-new-transcript-complete",
+  name: "New Transcript Complete (Instant)",
+  description: "Emit new event when a transcript is complete. [See the documentation](https://dev.trint.com/reference/register-webhook-endpoint)",
+  type: "source",
+  version: "0.0.1",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventTypes() {
+      return [
+        "TRANSCRIPT_COMPLETE",
+      ];
+    },
+  },
+  sampleEmit,
+};

package/sources/new-transcript-complete/test-event.mjs

@@ -0,0 +1,7 @@
+export default { 
+  eventType: 'TRANSCRIPT_COMPLETE',
+  transcriptId: '<TRINT_ID>',
+  title: 'myFile.mp4',
+  user: 'user@me.com',
+  metadata: 'some opaque metadata string' 
+}

package/sources/new-transcript-verified/new-transcript-verified.mjs

@@ -0,0 +1,21 @@
+import common from "../common/base-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "trint-new-transcript-verified",
+  name: "New Transcript Verified (Instant)",
+  description: "Emit new event when a transcript is verified. [See the documentation](https://dev.trint.com/reference/register-webhook-endpoint)",
+  type: "source",
+  version: "0.0.1",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventTypes() {
+      return [
+        "TRANSCRIPT_VERIFIED",
+      ];
+    },
+  },
+  sampleEmit,
+};

package/sources/new-transcript-verified/test-event.mjs

@@ -0,0 +1,7 @@
+export default { 
+  eventType: 'TRANSCRIPT_VERIFIED',
+  transcriptId: '<TRINT_ID>',
+  title: 'myFile.mp4',
+  user: 'user@me.com',
+  metadata: 'some opaque metadata string' 
+}

package/sources/new-transcript-version/new-transcript-version.mjs

@@ -0,0 +1,20 @@
+import common from "../common/base-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "trint-new-transcript-version",
+  name: "New Transcript Version (Instant)",
+  description: "Emit new event when a new transcript version is created. [See the documentation](https://dev.trint.com/reference/register-webhook-endpoint)",
+  type: "source",
+  version: "0.0.1",
+  methods: {
+    ...common.methods,
+    getEventTypes() {
+      return [
+        "TRANSCRIPT_NEW_VERSION",
+      ];
+    },
+  },
+  sampleEmit,
+};

package/sources/new-transcript-version/test-event.mjs

@@ -0,0 +1,6 @@
+export default { 
+  eventType: 'TRANSCRIPT_NEW_VERSION',
+  transcriptId: '<TRINT_ID>',
+  title: 'myFile.mp4',
+  user: 'user@me.com'
+}

package/trint.app.mjs

@@ -1,11 +1,124 @@
+import { axios } from "@pipedream/platform";
+const DEFAULT_LIMIT = 50;
+
 export default {
   type: "app",
   app: "trint",
-  propDefinitions: {},
+  propDefinitions: {
+    workspaceId: {
+      type: "string",
+      label: "Workspace ID",
+      description: "The ID of a workspace",
+      async options() {
+        const workspaces = await this.listWorkspaces();
+        return workspaces?.map(({
+          _id: value, name: label,
+        }) => ({
+          value,
+          label,
+        })) || [];
+      },
+    },
+    folderId: {
+      type: "string",
+      label: "Folder ID",
+      description: "The ID of a folder",
+      async options({ workspaceId }) {
+        const folders = await this.listFolders({
+          params: {
+            "workspace-id": workspaceId,
+          },
+        });
+        return folders?.map(({
+          _id: value, name: label,
+        }) => ({
+          value,
+          label,
+        })) || [];
+      },
+    },
+    transcriptId: {
+      type: "string",
+      label: "Transcript ID",
+      description: "The ID of a transcript",
+      async options({ page }) {
+        const transcripts = await this.listTranscripts({
+          params: {
+            limit: DEFAULT_LIMIT,
+            skip: DEFAULT_LIMIT * page,
+          },
+        });
+        return transcripts?.filter(({ fileType }) => fileType === "TRANSCRIPT")?.map(({
+          id: value, title: label,
+        }) => ({
+          value,
+          label,
+        })) || [];
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.trint.com";
+    },
+    _makeRequest({
+      $ = this, url, path, headers, ...opts
+    }) {
+      return axios($, {
+        url: url || `${this._baseUrl()}${path}`,
+        headers: {
+          ...headers,
+          "api-key": `${this.$auth.api_key}`,
+        },
+        ...opts,
+      });
+    },
+    registerWebhook(opts = {}) {
+      return this._makeRequest({
+        method: "PUT",
+        path: "/callbacks/transcript",
+        ...opts,
+      });
+    },
+    deregisterWebhook(opts = {}) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: "/callbacks/transcript",
+        ...opts,
+      });
+    },
+    getTranscript({
+      format, transcriptId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/export/${format}/${transcriptId}`,
+        ...opts,
+      });
+    },
+    listWorkspaces(opts = {}) {
+      return this._makeRequest({
+        path: "/workspaces",
+        ...opts,
+      });
+    },
+    listFolders(opts = {}) {
+      return this._makeRequest({
+        path: "/folders",
+        ...opts,
+      });
+    },
+    listTranscripts(opts = {}) {
+      return this._makeRequest({
+        path: "/transcripts",
+        ...opts,
+      });
+    },
+    uploadFile(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        url: "https://upload.trint.com/",
+        ...opts,
+      });
     },
   },
 };