npm - @editframe/api - Versions diffs - 0.12.0-beta.2 → 0.12.0-beta.21 - Mend

@editframe/api 0.12.0-beta.2 → 0.12.0-beta.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (111) hide show

package/docs/packages/api/docs/variables/CreateImageFilePayload.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateImageFilePayload | @editframe/api</title><meta name="description" content="Documentation for @editframe/api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@editframe/api</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@editframe/api</a></li><li><a href="CreateImageFilePayload.html">CreateImageFilePayload</a></li></ul><h1>Variable CreateImageFilePayload<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Create<wbr/>Image<wbr/>File<wbr/>Payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ZodObject</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">byte_size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodNumber</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">filename</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodString</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodNumber</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">md5</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodString</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">mime_type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodEnum</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"image/jpeg"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"image/png"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"image/jpg"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"image/webp"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodNumber</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"strip"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ZodTypeAny</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">byte_size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">filename</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">md5</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">mime_type</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image/jpeg"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image/png"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image/jpg"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image/webp"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">byte_size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">filename</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">md5</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">mime_type</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image/jpeg"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image/png"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image/jpg"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image/webp"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/editframe/elements/blob/a7cae45037ea5d64a2143ecc642ff3e9026e1368/packages/api/src/resources/image-file.ts#L11">packages/api/src/resources/image-file.ts:11</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@editframe/api</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/packages/api/docs/variables/CreateRenderPayload.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateRenderPayload | @editframe/api</title><meta name="description" content="Documentation for @editframe/api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@editframe/api</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@editframe/api</a></li><li><a href="CreateRenderPayload.html">CreateRenderPayload</a></li></ul><h1>Variable CreateRenderPayload<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Create<wbr/>Render<wbr/>Payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ZodObject</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">duration_ms</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodNumber</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">fps</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodNumber</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodNumber</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">md5</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodString</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">strategy</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodEnum</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"v1"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"v2"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodNumber</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">work_slice_ms</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodNumber</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"strip"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ZodTypeAny</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">duration_ms</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">fps</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">md5</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">strategy</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"v1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"v2"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">work_slice_ms</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">duration_ms</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">fps</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">md5</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">strategy</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"v1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"v2"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">work_slice_ms</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/editframe/elements/blob/a7cae45037ea5d64a2143ecc642ff3e9026e1368/packages/api/src/resources/renders.ts#L9">packages/api/src/resources/renders.ts:9</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@editframe/api</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/packages/api/docs/variables/CreateTranscriptionPayload.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateTranscriptionPayload | @editframe/api</title><meta name="description" content="Documentation for @editframe/api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@editframe/api</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@editframe/api</a></li><li><a href="CreateTranscriptionPayload.html">CreateTranscriptionPayload</a></li></ul><h1>Variable CreateTranscriptionPayload<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Create<wbr/>Transcription<wbr/>Payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ZodObject</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">file_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodString</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">track_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodNumber</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"strip"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ZodTypeAny</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">file_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">track_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">file_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">track_id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/editframe/elements/blob/a7cae45037ea5d64a2143ecc642ff3e9026e1368/packages/api/src/resources/transcriptions.ts#L9">packages/api/src/resources/transcriptions.ts:9</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@editframe/api</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/packages/api/docs/variables/CreateUnprocessedFilePayload.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateUnprocessedFilePayload | @editframe/api</title><meta name="description" content="Documentation for @editframe/api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@editframe/api</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@editframe/api</a></li><li><a href="CreateUnprocessedFilePayload.html">CreateUnprocessedFilePayload</a></li></ul><h1>Variable CreateUnprocessedFilePayload<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Create<wbr/>Unprocessed<wbr/>File<wbr/>Payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ZodObject</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">byte_size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodNumber</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">filename</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodString</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">md5</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodString</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"strip"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ZodTypeAny</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">byte_size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">filename</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">md5</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">byte_size</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">filename</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">md5</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/editframe/elements/blob/a7cae45037ea5d64a2143ecc642ff3e9026e1368/packages/api/src/resources/unprocessed-file.ts#L11">packages/api/src/resources/unprocessed-file.ts:11</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@editframe/api</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/docs/packages/api/docs/variables/TranscribeISOBMFFFilePayload.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TranscribeISOBMFFFilePayload | @editframe/api</title><meta name="description" content="Documentation for @editframe/api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@editframe/api</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@editframe/api</a></li><li><a href="TranscribeISOBMFFFilePayload.html">TranscribeISOBMFFFilePayload</a></li></ul><h1>Variable TranscribeISOBMFFFilePayload<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">TranscribeISOBMFFFile<wbr/>Payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ZodObject</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">trackId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZodOptional</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ZodString</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"strip"</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ZodTypeAny</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">trackId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">trackId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/editframe/elements/blob/a7cae45037ea5d64a2143ecc642ff3e9026e1368/packages/api/src/resources/isobmff-file.ts#L132">packages/api/src/resources/isobmff-file.ts:132</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@editframe/api</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@editframe/api",
-  "version": "0.12.0-beta.2",
+  "version": "0.12.0-beta.21",
   "description": "API functions for EditFrame",
   "exports": {
     ".": {
@@ -8,20 +8,26 @@
         "types": "./dist/index.d.ts",
         "default": "./dist/index.js"
       }
+    },
+    "./node": {
+      "import": {
+        "types": "./dist/node.d.ts",
+        "default": "./dist/node.js"
+      }
     }
   },
   "type": "module",
   "scripts": {
     "typecheck": "tsc --noEmit --emitDeclarationOnly false",
     "build": "vite build",
-    "build:watch": "vite build --watch"
+    "build:watch": "vite build --watch",
+    "typedoc": "typedoc --json ../../docs/api.json --plugin typedoc-plugin-zod --excludeExternals ./src"
   },
   "author": "",
   "license": "UNLICENSED",
   "devDependencies": {
     "@types/jsonwebtoken": "^9.0.6",
     "@types/node": "^20.14.13",
-    "eventsource-parser": "^3.0.0",
     "typedoc": "^0.26.5",
     "typescript": "^5.5.4",
     "vite": "^5.2.11",
@@ -29,9 +35,11 @@
     "vite-tsconfig-paths": "^4.3.2"
   },
   "dependencies": {
-    "@editframe/assets": "0.12.0-beta.2",
+    "@editframe/assets": "0.12.0-beta.21",
     "debug": "^4.3.5",
+    "eventsource-parser": "^3.0.0",
     "jsonwebtoken": "^9.0.2",
+    "mime": "^4.0.4",
     "node-fetch": "^3.3.2",
     "zod": "^3.23.8"
   }

package/src/resources/caption-file.test.ts CHANGED Viewed

@@ -2,13 +2,13 @@ import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 import { afterAll, afterEach, beforeAll, describe, expect, test } from "vitest";
-import { Client } from "../client.ts";
-import { webReadableFromBuffers } from "../readableFromBuffers.ts";
+import { Client } from "../client.js";
+import { webReadableFromBuffers } from "../readableFromBuffers.js";
 import {
   createCaptionFile,
   lookupCaptionFileByMd5,
   uploadCaptionFile,
-} from "./caption-file.ts";
+} from "./caption-file.js";
 const server = setupServer();
 const client = new Client("ef_TEST_TOKEN", "http://localhost");

package/src/resources/caption-file.ts CHANGED Viewed

@@ -1,27 +1,56 @@
 import debug from "debug";
 import { z } from "zod";
-import type { Client } from "../client.ts";
+import type { Client } from "../client.js";
 const log = debug("ef:api:caption-file");
 const MAX_CAPTION_SIZE = 1024 * 1024 * 2; // 2MB
 export const CreateCaptionFilePayload = z.object({
+  /**
+   * The md5 hash of the caption file
+   */
   md5: z.string(),
+  /**
+   * The filename of the caption file
+   */
   filename: z.string(),
+  /**
+   * The size of the caption file in bytes
+   */
   byte_size: z.number().int().max(MAX_CAPTION_SIZE),
 });
+export type CreateCaptionFilePayload = z.infer<typeof CreateCaptionFilePayload>;
 export interface CreateCaptionFileResult {
+  /**
+   * Whether the caption file is complete
+   */
   complete: boolean | null;
+  /**
+   * The id of the caption file
+   */
   id: string;
+  /**
+   * The md5 hash of the caption file
+   */
   md5: string;
 }
 export interface LookupCaptionFileByMd5Result {
+  /**
+   * Whether the caption file is complete
+   */
   complete: boolean | null;
+  /**
+   * The id of the caption file
+   */
   id: string;
+  /**
+   * The md5 hash of the caption file
+   */
   md5: string;
 }
@@ -52,7 +81,7 @@ const restrictSize = (size: number) => {
  */
 export const createCaptionFile = async (
   client: Client,
-  payload: z.infer<typeof CreateCaptionFilePayload>,
+  payload: CreateCaptionFilePayload,
 ) => {
   log("Creating caption file", payload);
   restrictSize(payload.byte_size);

package/src/resources/image-file.test.ts CHANGED Viewed

@@ -3,13 +3,13 @@ import { setupServer } from "msw/node";
 import { afterAll, afterEach, beforeAll, describe, expect, test } from "vitest";
 import { ZodError } from "zod";
-import { Client } from "../client.ts";
-import { webReadableFromBuffers } from "../readableFromBuffers.ts";
+import { Client } from "../client.js";
+import { webReadableFromBuffers } from "../readableFromBuffers.js";
 import {
   createImageFile,
   lookupImageFileByMd5,
   uploadImageFile,
-} from "./image-file.ts";
+} from "./image-file.js";
 const server = setupServer();
 const client = new Client("ef_TEST_TOKEN", "http://localhost");
@@ -97,9 +97,8 @@ describe("ImageFile", () => {
       await expect(
         uploadImageFile(
           client,
-          "test-file-id",
+          { id: "test-file-id", byte_size: 1024 * 1024 * 17 },
           webReadableFromBuffers(Buffer.from("test")),
-          1024 * 1024 * 17,
         ).whenUploaded(),
       ).rejects.toThrowError(
         "File size 17825792 bytes exceeds limit 16777216 bytes",
@@ -118,9 +117,8 @@ describe("ImageFile", () => {
       await expect(
         uploadImageFile(
           client,
-          "test-file-id",
+          { id: "test-file-id", byte_size: 4 },
           webReadableFromBuffers(Buffer.from("test")),
-          4,
         ).whenUploaded(),
       ).rejects.toThrowError(
         "Failed to upload chunk 0 for /api/v1/image_files/test-file-id/upload 500 Internal Server Error",
@@ -139,9 +137,8 @@ describe("ImageFile", () => {
       await expect(
         uploadImageFile(
           client,
-          "test-file-id",
+          { id: "test-file-id", byte_size: 4 },
           webReadableFromBuffers(Buffer.from("test")),
-          4,
         ).whenUploaded(),
       ).resolves.toEqual([
         { type: "progress", progress: 0 },

package/src/resources/image-file.ts CHANGED Viewed

@@ -1,37 +1,59 @@
 import debug from "debug";
 import { z } from "zod";
-import type { Client } from "../client.ts";
-import { uploadChunks } from "../uploadChunks.ts";
+import type { Client } from "../client.js";
+import { uploadChunks } from "../uploadChunks.js";
 const log = debug("ef:api:image-file");
 const MAX_IMAGE_SIZE = 1024 * 1024 * 16; // 16MB
 export const CreateImageFilePayload = z.object({
+  /**
+   * The md5 hash of the image file.
+   */
   md5: z.string(),
+  /**
+   * The height of the image file in pixels.
+   */
   height: z.number().int(),
+  /**
+   * The width of the image file in pixels.
+   */
   width: z.number().int(),
+  /**
+   * The mime type of the image file.
+   */
   mime_type: z.enum(["image/jpeg", "image/png", "image/jpg", "image/webp"]),
+  /**
+   * The filename of the image file.
+   */
   filename: z.string(),
+  /**
+   * The byte size of the image file.
+   */
   byte_size: z.number().int().max(MAX_IMAGE_SIZE),
 });
+export type CreateImageFilePayload = z.infer<typeof CreateImageFilePayload>;
 export interface CreateImageFileResult {
   complete: boolean | null;
+  byte_size: number;
   id: string;
   md5: string;
 }
 export interface LookupImageFileByMd5Result {
   complete: boolean | null;
+  byte_size: number;
   id: string;
   md5: string;
 }
 export const createImageFile = async (
   client: Client,
-  payload: z.infer<typeof CreateImageFilePayload>,
+  payload: CreateImageFilePayload,
 ) => {
   log("Creating image file", payload);
   CreateImageFilePayload.parse(payload);
@@ -53,15 +75,17 @@ export const createImageFile = async (
 export const uploadImageFile = (
   client: Client,
-  fileId: string,
+  uploadDetails: {
+    id: string;
+    byte_size: number;
+  },
   fileStream: ReadableStream,
-  fileSize: number,
 ) => {
-  log("Uploading image file", fileId);
+  log("Uploading image file", uploadDetails.id);
   return uploadChunks(client, {
-    url: `/api/v1/image_files/${fileId}/upload`,
-    fileSize,
+    url: `/api/v1/image_files/${uploadDetails.id}/upload`,
+    fileSize: uploadDetails.byte_size,
     fileStream,
     maxSize: MAX_IMAGE_SIZE,
   });

package/src/resources/isobmff-file.test.ts CHANGED Viewed

@@ -2,13 +2,13 @@ import { http, HttpResponse } from "msw";
 import { setupServer } from "msw/node";
 import { afterAll, afterEach, beforeAll, describe, expect, test } from "vitest";
-import { Client } from "../client.ts";
-import { webReadableFromBuffers } from "../readableFromBuffers.ts";
+import { Client } from "../client.js";
+import { webReadableFromBuffers } from "../readableFromBuffers.js";
 import {
   createISOBMFFFile,
   lookupISOBMFFFileByMd5,
   uploadFragmentIndex,
-} from "./isobmff-file.ts";
+} from "./isobmff-file.js";
 const server = setupServer();
 const client = new Client("ef_TEST_TOKEN", "http://localhost");

package/src/resources/isobmff-file.ts CHANGED Viewed

@@ -1,7 +1,7 @@
 import debug from "debug";
 import { z } from "zod";
-import type { Client } from "../client.ts";
+import type { Client } from "../client.js";
 const log = debug("ef:api:isobmff-file");
 const FILE_SIZE_LIMIT = 1024 * 1024 * 2; // 32MB
@@ -11,15 +11,35 @@ export const CreateISOBMFFFilePayload = z.object({
   filename: z.string(),
 });
+export type CreateISOBMFFFilePayload = z.infer<typeof CreateISOBMFFFilePayload>;
 export interface CreateISOBMFFFileResult {
+  /**
+   * Whether the fragment index is complete. The fragment index is used internally by editframe to efficiently seek within files.
+   */
   fragment_index_complete: boolean;
+  /**
+   * The filename of the isobmff file
+   */
   filename: string;
+  /**
+   * The id of the isobmff file
+   */
   id: string;
+  /**
+   * The md5 hash of the isobmff file
+   */
   md5: string;
 }
 export interface LookupISOBMFFFileByMd5Result {
+  /**
+   * Whether the fragment index is complete
+   */
   fragment_index_complete: boolean;
+  /**
+   * The filename of the isobmff file
+   */
   filename: string;
   id: string;
   md5: string;
@@ -35,7 +55,7 @@ export interface GetISOBMFFFileTranscriptionResult {
 export const createISOBMFFFile = async (
   client: Client,
-  payload: z.infer<typeof CreateISOBMFFFilePayload>,
+  payload: CreateISOBMFFFilePayload,
 ) => {
   log("Creating isobmff file", payload);
   const response = await client.authenticatedFetch("/api/v1/isobmff_files", {
@@ -128,3 +148,39 @@ export const getISOBMFFFileTranscription = async (
     `Failed to get isobmff file transcription ${id} ${response.status} ${response.statusText}`,
   );
 };
+export const TranscribeISOBMFFFilePayload = z.object({
+  trackId: z.string().optional(),
+});
+export type TranscribeISOBMFFFilePayload = z.infer<
+  typeof TranscribeISOBMFFFilePayload
+>;
+export interface TranscribeISOBMFFFileResult {
+  id: string;
+  file_id: string;
+  track_id: number;
+}
+export const transcribeISOBMFFFile = async (
+  client: Client,
+  id: string,
+  payload: TranscribeISOBMFFFilePayload = {},
+) => {
+  const response = await client.authenticatedFetch(
+    `/api/v1/isobmff_files/${id}/transcribe`,
+    {
+      method: "POST",
+      body: JSON.stringify(payload),
+    },
+  );
+  if (response.ok) {
+    return (await response.json()) as TranscribeISOBMFFFileResult;
+  }
+  throw new Error(
+    `Failed to transcribe isobmff file ${id} ${response.status} ${response.statusText}`,
+  );
+};

package/src/resources/isobmff-track.test.ts CHANGED Viewed

@@ -3,10 +3,10 @@ import { setupServer } from "msw/node";
 import { afterAll, afterEach, beforeAll, describe, expect, test } from "vitest";
 import { ZodError } from "zod";
-import { createTestTrack } from "TEST/createTestTrack.ts";
-import { Client } from "../client.ts";
-import { webReadableFromBuffers } from "../readableFromBuffers.ts";
-import { createISOBMFFTrack, uploadISOBMFFTrack } from "./isobmff-track.ts";
+import { createTestTrack } from "TEST/createTestTrack.js";
+import { Client } from "../client.js";
+import { webReadableFromBuffers } from "../readableFromBuffers.js";
+import { createISOBMFFTrack, uploadISOBMFFTrack } from "./isobmff-track.js";
 const server = setupServer();
 const client = new Client("ef_TEST_TOKEN", "http://localhost");

package/src/resources/isobmff-track.ts CHANGED Viewed

@@ -51,34 +51,46 @@ const VideoStreamSchema = z.object({
 type VideoStreamSchema = z.infer<typeof VideoStreamSchema>;
-import type { Client } from "../client.ts";
-import { uploadChunks } from "../uploadChunks.ts";
+import type { Client } from "../client.js";
+import { uploadChunks } from "../uploadChunks.js";
 const log = debug("ef:api:isobmff-track");
 const MAX_TRACK_SIZE = 1024 * 1024 * 1024; // 1GB
+const AudioTrackPayload = z.object({
+  file_id: z.string(),
+  track_id: z.number().int(),
+  type: z.literal("audio"),
+  probe_info: AudioStreamSchema,
+  duration_ms: z.number().int(),
+  codec_name: z.string(),
+  byte_size: z.number().int().max(MAX_TRACK_SIZE),
+});
+export type AudioTrackPayload = z.infer<typeof AudioTrackPayload>;
+const VideoTrackPayload = z.object({
+  file_id: z.string(),
+  track_id: z.number().int(),
+  type: z.literal("video"),
+  probe_info: VideoStreamSchema,
+  duration_ms: z.number().int(),
+  codec_name: z.string(),
+  byte_size: z.number().int().max(MAX_TRACK_SIZE),
+});
+export type VideoTrackPayload = z.infer<typeof VideoTrackPayload>;
 export const CreateISOBMFFTrackPayload = z.discriminatedUnion("type", [
-  z.object({
-    file_id: z.string(),
-    track_id: z.number().int(),
-    type: z.literal("audio"),
-    probe_info: AudioStreamSchema,
-    duration_ms: z.number().int(),
-    codec_name: z.string(),
-    byte_size: z.number().int().max(MAX_TRACK_SIZE),
-  }),
-  z.object({
-    file_id: z.string(),
-    track_id: z.number().int(),
-    type: z.literal("video"),
-    probe_info: VideoStreamSchema,
-    duration_ms: z.number().int(),
-    codec_name: z.string(),
-    byte_size: z.number().int().max(MAX_TRACK_SIZE),
-  }),
+  AudioTrackPayload,
+  VideoTrackPayload,
 ]);
+export type CreateISOBMFFTrackPayload = z.infer<
+  typeof CreateISOBMFFTrackPayload
+>;
 export interface CreateISOBMFFTrackResult {
   next_byte: number;
   byte_size: number;
@@ -89,7 +101,7 @@ export interface CreateISOBMFFTrackResult {
 export const createISOBMFFTrack = async (
   client: Client,
-  payload: z.infer<typeof CreateISOBMFFTrackPayload>,
+  payload: CreateISOBMFFTrackPayload,
 ) => {
   log("Creating isobmff track", payload);
   CreateISOBMFFTrackPayload.parse(payload);