@editframe/vite-plugin 0.24.1-beta.0 → 0.25.0-beta.0

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

@@ -0,0 +1,73 @@
+import { z } from "zod";
+import type { Client } from "../client.js";
+export declare const CreateCaptionFilePayload: z.ZodObject<{
+    /**
+     * The md5 hash of the caption file
+     */
+    md5: z.ZodString;
+    /**
+     * The filename of the caption file
+     */
+    filename: z.ZodString;
+    /**
+     * The size of the caption file in bytes
+     */
+    byte_size: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    md5: string;
+    filename: string;
+    byte_size: number;
+}, {
+    md5: string;
+    filename: string;
+    byte_size: number;
+}>;
+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;
+}
+/**
+ * Create a caption file
+ * @param client - The authenticated client to use for the request
+ * @param payload -  The payload to send to the server
+ * @returns The result of the request
+ * @example
+ * ```ts
+ * const result = await createCaptionFile(client, {
+ *  id: "123",
+ * filename: "caption.srt",
+ * });
+ * console.log(result);
+ * ```
+ * @category CaptionFile
+ * @resource
+ * @beta
+ */
+export declare const createCaptionFile: (client: Client, payload: CreateCaptionFilePayload) => Promise<CreateCaptionFileResult>;
+export declare const uploadCaptionFile: (client: Client, fileId: string, fileStream: ReadableStream, fileSize: number) => Promise<any>;
+export declare const lookupCaptionFileByMd5: (client: Client, md5: string) => Promise<LookupCaptionFileByMd5Result | null>;

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

@@ -0,0 +1,111 @@
+import { z } from "zod";
+import type { Client } from "../client.js";
+export declare const ImageFileMimeTypes: z.ZodEnum<["image/jpeg", "image/png", "image/jpg", "image/webp", "image/svg+xml"]>;
+export declare const CreateImageFilePayload: z.ZodEffects<z.ZodObject<{
+    /**
+     * The md5 hash of the image file.
+     */
+    md5: z.ZodOptional<z.ZodString>;
+    /**
+     * The height of the image file in pixels.
+     */
+    height: z.ZodOptional<z.ZodNumber>;
+    /**
+     * The width of the image file in pixels.
+     */
+    width: z.ZodOptional<z.ZodNumber>;
+    /**
+     * The mime type of the image file. Optional if the filename has a known file extension.
+     */
+    mime_type: z.ZodOptional<z.ZodEnum<["image/jpeg", "image/png", "image/jpg", "image/webp", "image/svg+xml"]>>;
+    /**
+     * The filename of the image file.
+     */
+    filename: z.ZodString;
+    /**
+     * The byte size of the image file.
+     */
+    byte_size: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    filename: string;
+    byte_size: number;
+    md5?: string | undefined;
+    height?: number | undefined;
+    width?: number | undefined;
+    mime_type?: "image/jpeg" | "image/png" | "image/jpg" | "image/webp" | "image/svg+xml" | undefined;
+}, {
+    filename: string;
+    byte_size: number;
+    md5?: string | undefined;
+    height?: number | undefined;
+    width?: number | undefined;
+    mime_type?: "image/jpeg" | "image/png" | "image/jpg" | "image/webp" | "image/svg+xml" | undefined;
+}>, {
+    filename: string;
+    byte_size: number;
+    md5?: string | undefined;
+    height?: number | undefined;
+    width?: number | undefined;
+    mime_type?: "image/jpeg" | "image/png" | "image/jpg" | "image/webp" | "image/svg+xml" | undefined;
+}, {
+    filename: string;
+    byte_size: number;
+    md5?: string | undefined;
+    height?: number | undefined;
+    width?: number | undefined;
+    mime_type?: "image/jpeg" | "image/png" | "image/jpg" | "image/webp" | "image/svg+xml" | undefined;
+}>;
+export type CreateImageFilePayload = z.infer<typeof CreateImageFilePayload>;
+export interface CreateImageFileResult {
+    /**
+     * Whether the image file has been fully uploaded.
+     */
+    complete: boolean | null;
+    /**
+     * The byte size of the image file.
+     */
+    byte_size: number;
+    /**
+     * The id of the image file.
+     */
+    id: string;
+    /**
+     * The md5 hash of the image file.
+     */
+    md5: string | null;
+}
+export interface LookupImageFileByMd5Result {
+    /**
+     * Whether the image file has been fully uploaded.
+     */
+    complete: boolean | null;
+    /**
+     * The byte size of the image file.
+     */
+    byte_size: number;
+    /**
+     * The id of the image file.
+     */
+    id: string;
+    /**
+     * md5 hash of the image file.
+     */
+    md5: string | null;
+    /**
+     * The height of the image file in pixels.
+     */
+    height: number | null;
+    /**
+     * The width of the image file in pixels.
+     */
+    width: number | null;
+}
+export interface GetImageFileMetadataResult extends LookupImageFileByMd5Result {
+}
+export declare const createImageFile: (client: Client, payload: CreateImageFilePayload) => Promise<CreateImageFileResult>;
+export declare const uploadImageFile: (client: Client, uploadDetails: {
+    id: string;
+    byte_size: number;
+}, fileStream: ReadableStream, chunkSizeBytes?: number) => import("../uploadChunks.js").IteratorWithPromise<import("../uploadChunks.js").UploadChunkEvent>;
+export declare const getImageFileMetadata: (client: Client, id: string) => Promise<GetImageFileMetadataResult | null>;
+export declare const lookupImageFileByMd5: (client: Client, md5: string) => Promise<LookupImageFileByMd5Result | null>;

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

@@ -0,0 +1,68 @@
+import { z } from "zod";
+import type { Client } from "../client.js";
+export declare const CreateISOBMFFFilePayload: z.ZodObject<{
+    md5: z.ZodString;
+    filename: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    md5: string;
+    filename: string;
+}, {
+    md5: string;
+    filename: 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;
+}
+export interface GetISOBMFFFileTranscriptionResult {
+    id: string;
+    work_slice_ms: number;
+    isobmff_track: {
+        duration_ms: number;
+    };
+}
+export declare const createISOBMFFFile: (client: Client, payload: CreateISOBMFFFilePayload) => Promise<CreateISOBMFFFileResult>;
+export declare const uploadFragmentIndex: (client: Client, fileId: string, fileStream: ReadableStream, fileSize: number) => Promise<any>;
+export declare const lookupISOBMFFFileByMd5: (client: Client, md5: string) => Promise<LookupISOBMFFFileByMd5Result | null>;
+export declare const getISOBMFFFileTranscription: (client: Client, id: string) => Promise<GetISOBMFFFileTranscriptionResult | null>;
+export declare const TranscribeISOBMFFFilePayload: z.ZodObject<{
+    trackId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    trackId?: string | undefined;
+}, {
+    trackId?: string | undefined;
+}>;
+export type TranscribeISOBMFFFilePayload = z.infer<typeof TranscribeISOBMFFFilePayload>;
+export interface TranscribeISOBMFFFileResult {
+    id: string;
+    file_id: string;
+    track_id: number;
+}
+export declare const transcribeISOBMFFFile: (client: Client, id: string, payload?: TranscribeISOBMFFFilePayload) => Promise<TranscribeISOBMFFFileResult>;