@editframe/api 0.12.0-beta.12 → 0.12.0-beta.16

package/dist/index.d.ts

@@ -5,6 +5,6 @@ export { createISOBMFFTrack, CreateISOBMFFTrackPayload, type CreateISOBMFFTrackR
 export { createRender, CreateRenderPayload, type CreateRenderResult, uploadRender, type LookupRenderByMd5Result, lookupRenderByMd5, } from './resources/renders.ts';
 export { createTranscription, CreateTranscriptionPayload, type CreateTranscriptionResult, getTranscriptionInfo, getTranscriptionProgress, type TranscriptionInfoResult, } from './resources/transcriptions.ts';
 export { createURLToken, type URLTokenResult, } from './resources/url-token.ts';
-export { createUnprocessedFile, CreateUnprocessedFilePayload, type CreateUnprocessedFileResult, uploadUnprocessedReadableStream, type LookupUnprocessedFileByMd5Result, lookupUnprocessedFileByMd5, processIsobmffFile, type ProcessIsobmffFileResult, createUnprocessedFileFromPath, uploadUnprocessedFile, } from './resources/unprocessed-file.ts';
+export { createUnprocessedFile, CreateUnprocessedFilePayload, type CreateUnprocessedFileResult, uploadUnprocessedReadableStream, type LookupUnprocessedFileByMd5Result, lookupUnprocessedFileByMd5, processIsobmffFile, type ProcessIsobmffFileResult, } from './resources/unprocessed-file.ts';
 export { getIsobmffProcessInfo, getIsobmffProcessProgress, type IsobmffProcessInfoResult, } from './resources/process-isobmff.ts';
 export { Client } from './client.ts';

package/dist/index.js

@@ -5,7 +5,7 @@ import { CreateISOBMFFTrackPayload, createISOBMFFTrack, uploadISOBMFFTrack } fro
 import { CreateRenderPayload, createRender, lookupRenderByMd5, uploadRender } from "./resources/renders.js";
 import { CreateTranscriptionPayload, createTranscription, getTranscriptionInfo, getTranscriptionProgress } from "./resources/transcriptions.js";
 import { createURLToken } from "./resources/url-token.js";
-import { CreateUnprocessedFilePayload, createUnprocessedFile, createUnprocessedFileFromPath, lookupUnprocessedFileByMd5, processIsobmffFile, uploadUnprocessedFile, uploadUnprocessedReadableStream } from "./resources/unprocessed-file.js";
+import { CreateUnprocessedFilePayload, createUnprocessedFile, lookupUnprocessedFileByMd5, processIsobmffFile, uploadUnprocessedReadableStream } from "./resources/unprocessed-file.js";
 import { getIsobmffProcessInfo, getIsobmffProcessProgress } from "./resources/process-isobmff.js";
 import { Client } from "./client.js";
 export {
@@ -26,7 +26,6 @@ export {
   createTranscription,
   createURLToken,
   createUnprocessedFile,
-  createUnprocessedFileFromPath,
   getISOBMFFFileTranscription,
   getIsobmffProcessInfo,
   getIsobmffProcessProgress,
@@ -44,6 +43,5 @@ export {
   uploadISOBMFFTrack,
   uploadImageFile,
   uploadRender,
-  uploadUnprocessedFile,
   uploadUnprocessedReadableStream
 };

package/dist/node.d.ts

@@ -0,0 +1,6 @@
+import { Client } from './client.ts';
+import { UnprocessedFileUploadDetails } from './resources/unprocessed-file.ts';
+export declare const createImageFileFromPath: (client: Client, path: string) => Promise<import('./index.ts').CreateImageFileResult>;
+export declare const createUnprocessedFileFromPath: (client: Client, path: string) => Promise<import('./index.ts').CreateUnprocessedFileResult>;
+export declare const uploadUnprocessedFile: (client: Client, uploadDetails: UnprocessedFileUploadDetails, path: string) => Promise<import('./uploadChunks.ts').IteratorWithPromise<import('./uploadChunks.ts').UploadChunkEvent>>;
+export * from './index.ts';

package/dist/node.js

@@ -0,0 +1,92 @@
+import { stat } from "node:fs/promises";
+import { basename } from "node:path";
+import mime from "mime";
+import { md5FilePath } from "@editframe/assets";
+import { createImageFile, CreateImageFilePayload } from "./resources/image-file.js";
+import { lookupImageFileByMd5, uploadImageFile } from "./resources/image-file.js";
+import { createUnprocessedFile, uploadUnprocessedReadableStream } from "./resources/unprocessed-file.js";
+import { CreateUnprocessedFilePayload, lookupUnprocessedFileByMd5, processIsobmffFile } from "./resources/unprocessed-file.js";
+import { CreateCaptionFilePayload, createCaptionFile, lookupCaptionFileByMd5, uploadCaptionFile } from "./resources/caption-file.js";
+import { CreateISOBMFFFilePayload, TranscribeISOBMFFFilePayload, createISOBMFFFile, getISOBMFFFileTranscription, lookupISOBMFFFileByMd5, transcribeISOBMFFFile, uploadFragmentIndex } from "./resources/isobmff-file.js";
+import { CreateISOBMFFTrackPayload, createISOBMFFTrack, uploadISOBMFFTrack } from "./resources/isobmff-track.js";
+import { CreateRenderPayload, createRender, lookupRenderByMd5, uploadRender } from "./resources/renders.js";
+import { CreateTranscriptionPayload, createTranscription, getTranscriptionInfo, getTranscriptionProgress } from "./resources/transcriptions.js";
+import { createURLToken } from "./resources/url-token.js";
+import { getIsobmffProcessInfo, getIsobmffProcessProgress } from "./resources/process-isobmff.js";
+import { Client } from "./client.js";
+const createImageFileFromPath = async (client, path) => {
+  const fileInfo = await stat(path);
+  const byte_size = fileInfo.size;
+  const md5 = await md5FilePath(path);
+  const mime_type = mime.getType(path);
+  return createImageFile(client, {
+    ...CreateImageFilePayload.parse({
+      md5,
+      height: 0,
+      width: 0,
+      mime_type,
+      filename: basename(path),
+      byte_size
+    })
+  });
+};
+const createUnprocessedFileFromPath = async (client, path) => {
+  const fileInfo = await stat(path);
+  const byte_size = fileInfo.size;
+  const md5 = await md5FilePath(path);
+  return createUnprocessedFile(client, {
+    md5,
+    filename: basename(path),
+    byte_size
+  });
+};
+const uploadUnprocessedFile = async (client, uploadDetails, path) => {
+  const { createReadStream } = await import("node:fs");
+  const readStream = createReadStream(path);
+  const { createReadableStreamFromReadable } = await import("./utils/createReadableStreamFromReadable.js");
+  return uploadUnprocessedReadableStream(
+    client,
+    uploadDetails,
+    createReadableStreamFromReadable(readStream)
+  );
+};
+export {
+  Client,
+  CreateCaptionFilePayload,
+  CreateISOBMFFFilePayload,
+  CreateISOBMFFTrackPayload,
+  CreateImageFilePayload,
+  CreateRenderPayload,
+  CreateTranscriptionPayload,
+  CreateUnprocessedFilePayload,
+  TranscribeISOBMFFFilePayload,
+  createCaptionFile,
+  createISOBMFFFile,
+  createISOBMFFTrack,
+  createImageFile,
+  createImageFileFromPath,
+  createRender,
+  createTranscription,
+  createURLToken,
+  createUnprocessedFile,
+  createUnprocessedFileFromPath,
+  getISOBMFFFileTranscription,
+  getIsobmffProcessInfo,
+  getIsobmffProcessProgress,
+  getTranscriptionInfo,
+  getTranscriptionProgress,
+  lookupCaptionFileByMd5,
+  lookupISOBMFFFileByMd5,
+  lookupImageFileByMd5,
+  lookupRenderByMd5,
+  lookupUnprocessedFileByMd5,
+  processIsobmffFile,
+  transcribeISOBMFFFile,
+  uploadCaptionFile,
+  uploadFragmentIndex,
+  uploadISOBMFFTrack,
+  uploadImageFile,
+  uploadRender,
+  uploadUnprocessedFile,
+  uploadUnprocessedReadableStream
+};

package/dist/resources/caption-file.d.ts

@@ -5,12 +5,12 @@ export declare const CreateCaptionFilePayload: z.ZodObject<{
     filename: z.ZodString;
     byte_size: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    md5: string;
     filename: string;
+    md5: string;
     byte_size: number;
 }, {
-    md5: string;
     filename: string;
+    md5: string;
     byte_size: number;
 }>;
 export interface CreateCaptionFileResult {

package/dist/resources/image-file.d.ts

@@ -8,19 +8,19 @@ export declare const CreateImageFilePayload: z.ZodObject<{
     filename: z.ZodString;
     byte_size: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    md5: string;
-    filename: string;
-    byte_size: number;
     width: number;
     height: number;
-    mime_type: "image/jpeg" | "image/png" | "image/jpg" | "image/webp";
-}, {
-    md5: string;
     filename: string;
+    md5: string;
+    mime_type: "image/jpeg" | "image/png" | "image/jpg" | "image/webp";
     byte_size: number;
+}, {
     width: number;
     height: number;
+    filename: string;
+    md5: string;
     mime_type: "image/jpeg" | "image/png" | "image/jpg" | "image/webp";
+    byte_size: number;
 }>;
 export interface CreateImageFileResult {
     complete: boolean | null;
@@ -34,7 +34,6 @@ export interface LookupImageFileByMd5Result {
     id: string;
     md5: string;
 }
-export declare const createImageFileFromPath: (client: Client, path: string) => Promise<CreateImageFileResult>;
 export declare const createImageFile: (client: Client, payload: z.infer<typeof CreateImageFilePayload>) => Promise<CreateImageFileResult>;
 export declare const uploadImageFile: (client: Client, uploadDetails: {
     id: string;

package/dist/resources/image-file.js

@@ -1,5 +1,4 @@
 import debug from "debug";
-import "mime";
 import { z } from "zod";
 import { uploadChunks } from "../uploadChunks.js";
 const log = debug("ef:api:image-file");

package/dist/resources/isobmff-file.d.ts

@@ -4,11 +4,11 @@ export declare const CreateISOBMFFFilePayload: z.ZodObject<{
     md5: z.ZodString;
     filename: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    md5: string;
     filename: string;
-}, {
     md5: string;
+}, {
     filename: string;
+    md5: string;
 }>;
 export interface CreateISOBMFFFileResult {
     fragment_index_complete: boolean;

package/dist/resources/isobmff-track.d.ts

@@ -75,9 +75,9 @@ export declare const CreateISOBMFFTrackPayload: z.ZodDiscriminatedUnion<"type",
     codec_name: z.ZodString;
     byte_size: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
+    codec_name: string;
     type: "audio";
     byte_size: number;
-    codec_name: string;
     file_id: string;
     track_id: number;
     probe_info: {
@@ -105,9 +105,9 @@ export declare const CreateISOBMFFTrackPayload: z.ZodDiscriminatedUnion<"type",
     };
     duration_ms: number;
 }, {
+    codec_name: string;
     type: "audio";
     byte_size: number;
-    codec_name: string;
     file_id: string;
     track_id: number;
     probe_info: {
@@ -203,9 +203,9 @@ export declare const CreateISOBMFFTrackPayload: z.ZodDiscriminatedUnion<"type",
     codec_name: z.ZodString;
     byte_size: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
+    codec_name: string;
     type: "video";
     byte_size: number;
-    codec_name: string;
     file_id: string;
     track_id: number;
     probe_info: {
@@ -231,9 +231,9 @@ export declare const CreateISOBMFFTrackPayload: z.ZodDiscriminatedUnion<"type",
     };
     duration_ms: number;
 }, {
+    codec_name: string;
     type: "video";
     byte_size: number;
-    codec_name: string;
     file_id: string;
     track_id: number;
     probe_info: {

package/dist/resources/renders.d.ts

@@ -9,17 +9,17 @@ export declare const CreateRenderPayload: z.ZodObject<{
     duration_ms: z.ZodNumber;
     strategy: z.ZodEnum<["v1", "v2"]>;
 }, "strip", z.ZodTypeAny, {
-    md5: string;
     width: number;
     height: number;
+    md5: string;
     strategy: "v1" | "v2";
     duration_ms: number;
     fps: number;
     work_slice_ms: number;
 }, {
-    md5: string;
     width: number;
     height: number;
+    md5: string;
     strategy: "v1" | "v2";
     duration_ms: number;
     fps: number;

package/dist/resources/unprocessed-file.d.ts

@@ -5,12 +5,12 @@ export declare const CreateUnprocessedFilePayload: z.ZodObject<{
     filename: z.ZodString;
     byte_size: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    md5: string;
     filename: string;
+    md5: string;
     byte_size: number;
 }, {
-    md5: string;
     filename: string;
+    md5: string;
     byte_size: number;
 }>;
 export declare const UpdateUnprocessedFilePayload: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
@@ -21,7 +21,7 @@ interface UnprocessedFile {
     id: string;
     md5: string;
 }
-type UnprocessedFileUploadDetails = Pick<UnprocessedFile, "id" | "byte_size">;
+export type UnprocessedFileUploadDetails = Pick<UnprocessedFile, "id" | "byte_size">;
 export interface CreateUnprocessedFileResult extends UnprocessedFile {
 }
 export interface LookupUnprocessedFileByMd5Result extends UnprocessedFile {
@@ -31,9 +31,7 @@ export interface UpdateUnprocessedFileResult extends UnprocessedFile {
 export interface ProcessIsobmffFileResult {
     id: string;
 }
-export declare const createUnprocessedFileFromPath: (client: Client, path: string) => Promise<CreateUnprocessedFileResult>;
 export declare const createUnprocessedFile: (client: Client, payload: z.infer<typeof CreateUnprocessedFilePayload>) => Promise<CreateUnprocessedFileResult>;
-export declare const uploadUnprocessedFile: (client: Client, uploadDetails: UnprocessedFileUploadDetails, path: string) => Promise<import('../uploadChunks.ts').IteratorWithPromise<import('../uploadChunks.ts').UploadChunkEvent>>;
 export declare const uploadUnprocessedReadableStream: (client: Client, uploadDetails: UnprocessedFileUploadDetails, fileStream: ReadableStream) => import('../uploadChunks.ts').IteratorWithPromise<import('../uploadChunks.ts').UploadChunkEvent>;
 export declare const lookupUnprocessedFileByMd5: (client: Client, md5: string) => Promise<LookupUnprocessedFileByMd5Result | null>;
 export declare const processIsobmffFile: (client: Client, id: string) => Promise<ProcessIsobmffFileResult>;

package/dist/resources/unprocessed-file.js

@@ -9,27 +9,6 @@ const CreateUnprocessedFilePayload = z.object({
   byte_size: z.number().int().max(MAX_FILE_SIZE)
 });
 z.object({});
-const createUnprocessedFileFromPath = async (client, path) => {
-  const [{ stat }, { basename }, { md5FilePath }] = await Promise.all([
-    import("node:fs/promises"),
-    import("node:path"),
-    import("@editframe/assets")
-  ]).catch((error) => {
-    console.error("Error importing modules", error);
-    console.error(
-      "This is likely because you are bundling for the browser. createUnprocessedFileFromPath can only be run in environments that support importing `node:path`"
-    );
-    throw error;
-  });
-  const fileInfo = await stat(path);
-  const byte_size = fileInfo.size;
-  const md5 = await md5FilePath(path);
-  return createUnprocessedFile(client, {
-    md5,
-    filename: basename(path),
-    byte_size
-  });
-};
 const createUnprocessedFile = async (client, payload) => {
   log("Creating an unprocessed file", payload);
   CreateUnprocessedFilePayload.parse(payload);
@@ -53,16 +32,6 @@ const createUnprocessedFile = async (client, payload) => {
     `Failed to create unprocessed file ${response.status} ${response.statusText}`
   );
 };
-const uploadUnprocessedFile = async (client, uploadDetails, path) => {
-  const { createReadStream } = await import("node:fs");
-  const readStream = createReadStream(path);
-  const { createReadableStreamFromReadable } = await import("../utils/createReadableStreamFromReadable.js");
-  return uploadUnprocessedReadableStream(
-    client,
-    uploadDetails,
-    createReadableStreamFromReadable(readStream)
-  );
-};
 const uploadUnprocessedReadableStream = (client, uploadDetails, fileStream) => {
   log("Uploading unprocessed file", uploadDetails.id);
   return uploadChunks(client, {
@@ -106,9 +75,7 @@ const processIsobmffFile = async (client, id) => {
 export {
   CreateUnprocessedFilePayload,
   createUnprocessedFile,
-  createUnprocessedFileFromPath,
   lookupUnprocessedFileByMd5,
   processIsobmffFile,
-  uploadUnprocessedFile,
   uploadUnprocessedReadableStream
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@editframe/api",
-  "version": "0.12.0-beta.12",
+  "version": "0.12.0-beta.16",
   "description": "API functions for EditFrame",
   "exports": {
     ".": {
@@ -8,6 +8,12 @@
         "types": "./dist/index.d.ts",
         "default": "./dist/index.js"
       }
+    },
+    "./node": {
+      "import": {
+        "types": "./dist/node.d.ts",
+        "default": "./dist/node.js"
+      }
     }
   },
   "type": "module",
@@ -29,7 +35,7 @@
     "vite-tsconfig-paths": "^4.3.2"
   },
   "dependencies": {
-    "@editframe/assets": "0.12.0-beta.12",
+    "@editframe/assets": "0.12.0-beta.16",
     "debug": "^4.3.5",
     "jsonwebtoken": "^9.0.2",
     "node-fetch": "^3.3.2",

package/src/resources/image-file.ts

@@ -1,5 +1,4 @@
 import debug from "debug";
-import mime from "mime";
 import { z } from "zod";
 
 import type { Client } from "../client.ts";
@@ -32,39 +31,6 @@ export interface LookupImageFileByMd5Result {
   md5: string;
 }
 
-export const createImageFileFromPath = async (client: Client, path: string) => {
-  const [{ stat }, { basename }, { md5FilePath }] = await Promise.all([
-    import("node:fs/promises"),
-    import("node:path"),
-    import("@editframe/assets"),
-  ]).catch((error) => {
-    console.error("Error importing modules", error);
-    console.error(
-      "This is likely because you are bundling for the browser. createImageFileFromPath can only be run in environments that support importing `node:path`",
-    );
-    throw error;
-  });
-
-  const fileInfo = await stat(path);
-
-  const byte_size = fileInfo.size;
-
-  const md5 = await md5FilePath(path);
-
-  const mime_type = mime.getType(path);
-
-  return createImageFile(client, {
-    ...CreateImageFilePayload.parse({
-      md5,
-      height: 0,
-      width: 0,
-      mime_type,
-      filename: basename(path),
-      byte_size,
-    }),
-  });
-};
-
 export const createImageFile = async (
   client: Client,
   payload: z.infer<typeof CreateImageFilePayload>,

package/src/resources/unprocessed-file.ts

@@ -24,7 +24,10 @@ interface UnprocessedFile {
   md5: string;
 }
 
-type UnprocessedFileUploadDetails = Pick<UnprocessedFile, "id" | "byte_size">;
+export type UnprocessedFileUploadDetails = Pick<
+  UnprocessedFile,
+  "id" | "byte_size"
+>;
 
 export interface CreateUnprocessedFileResult extends UnprocessedFile {}
 
@@ -36,35 +39,6 @@ export interface ProcessIsobmffFileResult {
   id: string;
 }
 
-export const createUnprocessedFileFromPath = async (
-  client: Client,
-  path: string,
-) => {
-  const [{ stat }, { basename }, { md5FilePath }] = await Promise.all([
-    import("node:fs/promises"),
-    import("node:path"),
-    import("@editframe/assets"),
-  ]).catch((error) => {
-    console.error("Error importing modules", error);
-    console.error(
-      "This is likely because you are bundling for the browser. createUnprocessedFileFromPath can only be run in environments that support importing `node:path`",
-    );
-    throw error;
-  });
-
-  const fileInfo = await stat(path);
-
-  const byte_size = fileInfo.size;
-
-  const md5 = await md5FilePath(path);
-
-  return createUnprocessedFile(client, {
-    md5,
-    filename: basename(path),
-    byte_size,
-  });
-};
-
 export const createUnprocessedFile = async (
   client: Client,
   payload: z.infer<typeof CreateUnprocessedFilePayload>,
@@ -95,25 +69,6 @@ export const createUnprocessedFile = async (
   );
 };
 
-export const uploadUnprocessedFile = async (
-  client: Client,
-  uploadDetails: UnprocessedFileUploadDetails,
-  path: string,
-) => {
-  const { createReadStream } = await import("node:fs");
-  const readStream = createReadStream(path);
-
-  const { createReadableStreamFromReadable } = await import(
-    "../utils/createReadableStreamFromReadable.ts"
-  );
-
-  return uploadUnprocessedReadableStream(
-    client,
-    uploadDetails,
-    createReadableStreamFromReadable(readStream),
-  );
-};
-
 export const uploadUnprocessedReadableStream = (
   client: Client,
   uploadDetails: UnprocessedFileUploadDetails,