@mcut/transcription-ai-sdk 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,187 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent
+(50%) or more of the outstanding shares, or (iii) beneficial ownership of
+such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation
+or translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work (an example is provided in the Appendix
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as a
+whole, an original work of authorship. For the purposes of this License,
+Derivative Works shall not include works that remain separable from, or
+merely link (or bind by name) to the interfaces of, the Work and Derivative
+Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the
+purposes of this definition, "submitted" means any form of electronic,
+verbal, or written communication sent to the Licensor or its representatives,
+including but not limited to communication on electronic mailing lists,
+source code control systems, and issue tracking systems that are managed by,
+or on behalf of, the Licensor for the purpose of discussing and improving the
+Work, but excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import,
+and otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily infringed
+by their Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You institute
+patent litigation against any entity (including a cross-claim or counterclaim
+in a lawsuit) alleging that the Work or a Contribution incorporated within
+the Work constitutes direct or contributory patent infringement, then any
+patent licenses granted to You under this License for that Work shall
+terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a
+copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from
+the Source form of the Work, excluding those notices that do not pertain to
+any part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution,
+then any Derivative Works that You distribute must include a readable copy of
+the attribution notices contained within such NOTICE file, excluding those
+notices that do not pertain to any part of the Derivative Works, in at least
+one of the following places: within a NOTICE text file distributed as part of
+the Derivative Works; within the Source form or documentation, if provided
+along with the Derivative Works; or, within a display generated by the
+Derivative Works, if and wherever such third-party notices normally appear.
+The contents of the NOTICE file are for informational purposes only and do
+not modify the License. You may add Your own attribution notices within
+Derivative Works that You distribute, alongside or as an addendum to the
+NOTICE text from the Work, provided that such additional attribution notices
+cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may
+provide additional or different license terms and conditions for use,
+reproduction, or distribution of Your modifications, or for any such
+Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated in
+this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein
+shall supersede or modify the terms of any separate license agreement you may
+have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of the
+Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to
+in writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability
+to use the Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all other
+commercial damages or losses), even if such Contributor has been advised of
+the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work
+or Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification
+within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,11 @@
+# @mcut/transcription-ai-sdk
+
+Vercel AI SDK transcription provider for mcut.
+
+```sh
+bun add @mcut/transcription-ai-sdk @mcut/transcription ai
+```
+
+This package normalizes AI SDK transcription results into the shared
+`@mcut/transcription` format. The `ai` package is a peer dependency so apps can
+choose and configure their transcription model provider.

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+import { experimental_transcribe } from "ai";
+import { TranscriptResult, TranscriptionProvider } from "@mcut/transcription";
+
+//#region src/index.d.ts
+type TranscribeArgs = Parameters<typeof experimental_transcribe>[0];
+interface AISDKTranscriptionProviderOptions {
+  /** Any AI SDK transcription model, e.g. `openai.transcription('whisper-1')`. */
+  model: TranscribeArgs['model'];
+  /**
+   * Provider-specific options forwarded to the AI SDK, e.g.
+   * `{ openai: { timestampGranularities: ['word'] } }` for word timings.
+   */
+  providerOptions?: TranscribeArgs['providerOptions'];
+  /** Provider id for diagnostics. Default `'ai-sdk'`. */
+  id?: string;
+}
+/** The fields of the AI SDK transcription result this adapter consumes. */
+interface AISDKTranscriptionResultLike {
+  text: string;
+  segments: ReadonlyArray<{
+    text: string;
+    startSecond: number;
+    endSecond: number;
+  }>;
+  language: string | undefined;
+  durationInSeconds: number | undefined;
+}
+/**
+ * Normalize an AI SDK transcription result to mcut's `TranscriptResult`.
+ * Word-granularity outputs (every segment a single word) are detected and
+ * exposed as `words` so captions get karaoke timings; sentence-level
+ * segments pass through as `segments`.
+ */
+declare function normalizeAISDKResult(result: AISDKTranscriptionResultLike): TranscriptResult;
+/**
+ * An mcut transcription provider backed by the Vercel AI SDK — one adapter
+ * unlocks every AI SDK transcription model (OpenAI, Deepgram, Groq,
+ * ElevenLabs, AssemblyAI, ...). Runs wherever the AI SDK runs; keep API
+ * keys server-side.
+ *
+ * ```ts
+ * import { openai } from '@ai-sdk/openai'
+ * const provider = createAISDKTranscriptionProvider({
+ *   model: openai.transcription('whisper-1'),
+ *   providerOptions: { openai: { timestampGranularities: ['word'] } },
+ * })
+ * const transcript = await provider.transcribe({ audio: wavBlob })
+ * ```
+ */
+declare function createAISDKTranscriptionProvider(options: AISDKTranscriptionProviderOptions): TranscriptionProvider;
+//#endregion
+export { AISDKTranscriptionProviderOptions, AISDKTranscriptionResultLike, createAISDKTranscriptionProvider, normalizeAISDKResult };

package/dist/index.js

@@ -0,0 +1,59 @@
+import { experimental_transcribe } from "ai";
+//#region src/index.ts
+/**
+* Normalize an AI SDK transcription result to mcut's `TranscriptResult`.
+* Word-granularity outputs (every segment a single word) are detected and
+* exposed as `words` so captions get karaoke timings; sentence-level
+* segments pass through as `segments`.
+*/
+function normalizeAISDKResult(result) {
+	const mapped = result.segments.map((segment) => ({
+		text: segment.text.trim(),
+		startMs: Math.round(segment.startSecond * 1e3),
+		endMs: Math.round(segment.endSecond * 1e3)
+	}));
+	const isWordLevel = mapped.length > 0 && mapped.every((s) => !/\s/.test(s.text));
+	return {
+		text: result.text,
+		...result.language !== void 0 ? { language: result.language } : {},
+		...result.durationInSeconds !== void 0 ? { durationMs: Math.round(result.durationInSeconds * 1e3) } : {},
+		words: isWordLevel ? mapped : [],
+		segments: isWordLevel ? [] : mapped
+	};
+}
+async function toAudioArg(audio) {
+	if (typeof audio === "string") return new URL(audio);
+	if (audio instanceof Blob) return new Uint8Array(await audio.arrayBuffer());
+	if (audio instanceof ArrayBuffer) return new Uint8Array(audio);
+	return audio;
+}
+/**
+* An mcut transcription provider backed by the Vercel AI SDK — one adapter
+* unlocks every AI SDK transcription model (OpenAI, Deepgram, Groq,
+* ElevenLabs, AssemblyAI, ...). Runs wherever the AI SDK runs; keep API
+* keys server-side.
+*
+* ```ts
+* import { openai } from '@ai-sdk/openai'
+* const provider = createAISDKTranscriptionProvider({
+*   model: openai.transcription('whisper-1'),
+*   providerOptions: { openai: { timestampGranularities: ['word'] } },
+* })
+* const transcript = await provider.transcribe({ audio: wavBlob })
+* ```
+*/
+function createAISDKTranscriptionProvider(options) {
+	return {
+		id: options.id ?? "ai-sdk",
+		async transcribe(input, transcribeOptions) {
+			return normalizeAISDKResult(await experimental_transcribe({
+				model: options.model,
+				audio: await toAudioArg(input.audio),
+				...options.providerOptions ? { providerOptions: options.providerOptions } : {},
+				...transcribeOptions?.signal ? { abortSignal: transcribeOptions.signal } : {}
+			}));
+		}
+	};
+}
+//#endregion
+export { createAISDKTranscriptionProvider, normalizeAISDKResult };

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@mcut/transcription-ai-sdk",
+  "version": "0.1.0-alpha.0",
+  "description": "mcut transcription provider backed by the Vercel AI SDK — use any AI SDK transcription model (OpenAI, Deepgram, Groq, ElevenLabs, ...)",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch --no-clean",
+    "typecheck": "tsc --noEmit",
+    "test": "bun test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mattppal/mcut.git",
+    "directory": "packages/transcription-ai-sdk"
+  },
+  "peerDependencies": {
+    "@mcut/transcription": "0.1.0-alpha.0",
+    "ai": ">=5.0.0"
+  },
+  "devDependencies": {
+    "@mcut/transcription": "0.1.0-alpha.0",
+    "ai": "^6.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "author": "Matt Palmer",
+  "homepage": "https://github.com/mattppal/mcut/tree/main/packages/transcription-ai-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/mattppal/mcut/issues"
+  },
+  "keywords": [
+    "mcut",
+    "video",
+    "video-editing",
+    "timeline",
+    "typescript",
+    "transcription",
+    "ai-sdk"
+  ]
+}