@video-editor/protocol 0.0.1-beta.2 → 0.0.1-beta.20

package/dist/index.d.ts

@@ -6,8 +6,8 @@ import { IEffectSegment } from '@video-editor/shared';
 import { IFillMode } from '@video-editor/shared';
 import { IFilterSegment } from '@video-editor/shared';
 import { IFramesSegmentUnion } from '@video-editor/shared';
-import { IImageSegment } from '@video-editor/shared';
 import { ISamples } from './fetch';
+import { IStickerSegment } from '@video-editor/shared';
 import { ITextSegment } from '@video-editor/shared';
 import { ITrackType } from '@video-editor/shared';
 import { ITransition } from '@video-editor/shared';
@@ -23,7 +23,9 @@ import { TrackUnion } from '@video-editor/shared';
 export declare function createResourceManager(opts?: {
     dir?: string;
 }): {
-    add: (url: string) => Promise<void>;
+    add: (url: string, opts?: {
+        body?: ReadableStream<BufferSource>;
+    }) => Promise<void>;
     get: (url: string) => Promise<void | HTMLImageElement | ISamples[]>;
     remove: (url: string) => Promise<void>;
     clear: () => Promise<void>;
@@ -36,7 +38,7 @@ export declare function createValidator(): {
     };
     verifyFramesSegment: (o: object) => IFramesSegmentUnion;
     verifyTextSegment: (o: object) => ITextSegment;
-    verifyPhotoSegment: (o: object) => IImageSegment;
+    verifyStickerSegment: (o: object) => IStickerSegment;
     verifyAudioSegment: (o: object) => IAudioSegment;
     verifyEffectSegment: (o: object) => IEffectSegment;
     verifyFilterSegment: (o: object) => IFilterSegment;
@@ -45,10 +47,15 @@ export declare function createValidator(): {
     };
     verifySegment: (o: object & {
         segmentType: ITrackType;
-    }) => IFramesSegmentUnion | IAudioSegment | IEffectSegment | IFilterSegment | IImageSegment | ITextSegment;
+    }) => IFramesSegmentUnion | IAudioSegment | IEffectSegment | IFilterSegment | IStickerSegment | ITextSegment;
 };
 
-export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
+export declare function createVideoProtocolManager(protocol: IVideoProtocol, options?: {
+    idFactory?: {
+        segment?: () => string;
+        track?: () => string;
+    };
+}): {
     videoBasicInfo: {
         version: `${number}.${number}.${number}`;
         width: number;
@@ -112,7 +119,7 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly endTime: number;
     readonly segmentType: "frames";
     readonly extra?: {
-    readonly [x: string]: Readonly<unknown>;
+    readonly [x: string]: never;
     } | null | undefined;
     } | {
     readonly type: "image";
@@ -162,7 +169,7 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly endTime: number;
     readonly segmentType: "frames";
     readonly extra?: {
-    readonly [x: string]: Readonly<unknown>;
+    readonly [x: string]: never;
     } | null | undefined;
     } | {
     readonly type: "3D";
@@ -211,9 +218,12 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly endTime: number;
     readonly segmentType: "frames";
     readonly extra?: {
-    readonly [x: string]: Readonly<unknown>;
+    readonly [x: string]: never;
     } | null | undefined;
     })[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     readonly isMain?: boolean | undefined;
     }[];
     text: readonly {
@@ -267,15 +277,18 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly endTime: number;
     readonly url?: string | undefined;
     readonly extra?: {
-    readonly [x: string]: Readonly<unknown>;
+    readonly [x: string]: never;
     } | null | undefined;
     }[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
-    image: readonly {
+    sticker: readonly {
     readonly trackId: string;
-    readonly trackType: "image";
+    readonly trackType: "sticker";
     readonly children: readonly {
-    readonly segmentType: "image";
+    readonly segmentType: "sticker";
     readonly format: "img" | "gif";
     readonly url: string;
     readonly fillMode?: IFillMode | undefined;
@@ -309,9 +322,12 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly startTime: number;
     readonly endTime: number;
     readonly extra?: {
-    readonly [x: string]: Readonly<unknown>;
+    readonly [x: string]: never;
     } | null | undefined;
     }[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
     audio: readonly {
     readonly trackId: string;
@@ -328,9 +344,12 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly startTime: number;
     readonly endTime: number;
     readonly extra?: {
-    readonly [x: string]: Readonly<unknown>;
+    readonly [x: string]: never;
     } | null | undefined;
     }[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
     effect: readonly {
     readonly trackId: string;
@@ -344,9 +363,12 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly endTime: number;
     readonly url?: string | undefined;
     readonly extra?: {
-    readonly [x: string]: Readonly<unknown>;
+    readonly [x: string]: never;
     } | null | undefined;
     }[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
     filter: readonly {
     readonly trackId: string;
@@ -361,22 +383,81 @@ export declare function createVideoProtocolManager(protocol: IVideoProtocol): {
     readonly endTime: number;
     readonly url?: string | undefined;
     readonly extra?: {
-    readonly [x: string]: Readonly<unknown>;
+    readonly [x: string]: never;
     } | null | undefined;
     }[];
+    readonly extra?: {
+    readonly [x: string]: never;
+    } | null | undefined;
     }[];
     }>;
     segmentMap: ComputedRef<Record<string, DeepReadonly<SegmentUnion | undefined>>>;
+    protocol: ComputedRef<IVideoProtocol>;
     getSegment: <T extends ITrackType>(id: SegmentUnion["id"], type?: T) => DeepReadonly<TrackTypeMapSegment[T]> | undefined;
-    addSegment: (segment: PartialByKeys<TrackTypeMapSegment[ITrackType], "id">) => string;
-    removeSegment: (id: SegmentUnion["id"]) => boolean;
+    addSegment: (segment: PartialByKeys<TrackTypeMapSegment[ITrackType], "id">) => {
+        id: string;
+        affectedSegments: SegmentUnion[];
+        affectedTracks: TrackUnion[];
+        createdTracks: TrackUnion[];
+        removedTrackIds: string[];
+    };
+    removeSegment: (id: SegmentUnion["id"]) => {
+        success: boolean;
+        affectedSegments: SegmentUnion[];
+        affectedTracks: TrackUnion[];
+        createdTracks: TrackUnion[];
+        removedTrackIds: string[];
+    };
     updateSegment: <T extends ITrackType>(updater: (segment: TrackTypeMapSegment[T]) => void, id?: string, type?: T) => void;
+    moveSegment: (moveOptions: {
+        segmentId: string;
+        sourceTrackId: string;
+        targetTrackId?: string;
+        startTime: number;
+        endTime: number;
+        isNewTrack?: boolean;
+        newTrackInsertIndex?: number;
+        newTrackId?: string;
+    }) => {
+        success: boolean;
+        affectedSegments: SegmentUnion[];
+        affectedTracks: TrackUnion[];
+        createdTracks: TrackUnion[];
+        removedTrackIds: string[];
+    };
+    resizeSegment: (options: {
+        segmentId: string;
+        trackId: string;
+        startTime: number;
+        endTime: number;
+    }) => {
+        success: boolean;
+        affectedSegments: SegmentUnion[];
+        affectedTracks: TrackUnion[];
+        createdTracks: TrackUnion[];
+        removedTrackIds: string[];
+    };
     exportProtocol: () => IVideoProtocol;
     addTransition: (transition: ITransition, addTime?: number) => boolean;
     removeTransition: (segmentId: string) => boolean;
     updateTransition: (segmentId: string, updater: (transition: ITransition) => void) => boolean;
-    undo: () => void;
-    redo: () => void;
+    replaceTrackId: (oldTrackId: string, newTrackId: string) => boolean;
+    undo: () => {
+        success: boolean;
+        affectedSegments: SegmentUnion[];
+        affectedTracks: TrackUnion[];
+        createdTracks: TrackUnion[];
+        removedTrackIds: string[];
+        removedSegmentIds: string[];
+    };
+    redo: () => {
+        success: boolean;
+        affectedSegments: SegmentUnion[];
+        affectedTracks: TrackUnion[];
+        createdTracks: TrackUnion[];
+        removedTrackIds: string[];
+        removedSegmentIds: string[];
+    };
     redoCount: ComputedRef<number>;
     undoCount: ComputedRef<number>;
 };
@@ -421,6 +502,17 @@ declare interface GenerateThumbnailsOptions {
     resourceDir?: string;
 }
 
+export declare function getMp4Meta(url: string, options?: {
+    resourceDir?: string;
+}): Promise<Mp4Meta>;
+
+/**
+ * Convert a user-provided URL into a stable, OPFS-safe key.
+ * - Removes query/hash so signed URLs map to a single cached entry.
+ * - Avoids `://` and other path-unfriendly sequences by encoding segments.
+ */
+export declare function getResourceKey(url: string): string;
+
 export declare function getResourceType(url: string): Promise<{
     type: IResType;
     totalSize: number;
@@ -446,6 +538,15 @@ export { ITrackType }
 
 export { IVideoProtocol }
 
+declare interface Mp4Meta {
+    durationUs: number;
+    durationMs: number;
+    width: number;
+    height: number;
+    audioSampleRate: number;
+    audioChanCount: number;
+}
+
 declare type OPFSToolFile = ReturnType<typeof file>;
 
 export declare const parse: parseFn;