@video-editor/shared 0.0.1-beta.1 → 0.0.1-beta.10

package/dist/index.d.ts

@@ -84,18 +84,6 @@ export declare interface IImageFramesSegment extends IFramesSegment {
     format: 'img' | 'gif';
 }
 
-export declare type IImageSegment = ImageSegment<'image'>;
-
-declare interface ImageSegment<T extends ITrackType> extends ISegment<T> {
-    segmentType: T;
-    format: 'img' | 'gif';
-    url: string;
-    fillMode?: IFillMode;
-    animation?: IAnimation;
-    transform?: ITransform;
-    palette?: IPalette;
-}
-
 export declare interface IPalette {
     temperature: number;
     hue: number;
@@ -121,12 +109,13 @@ export declare function isAudioSegment(segment: SegmentUnion): segment is IAudio
  */
 export declare function isEffectSegment(segment: SegmentUnion): segment is IEffectSegment;
 
-export declare interface ISegment<T extends ITrackType> {
+export declare interface ISegment<T extends ITrackType = ITrackType> {
     id: string;
     startTime: number;
     endTime: number;
     segmentType: T;
     url?: string;
+    extra?: SegmentExtra<T> | null;
 }
 
 /**
@@ -140,15 +129,17 @@ export declare function isFilterSegment(segment: SegmentUnion): segment is IFilt
 export declare function isFramesSegment(segment: SegmentUnion): segment is IFramesSegmentUnion;
 
 /**
- * Type guard: check if segment is image segment
+ * Type guard: check if segment is sticker segment
  */
-export declare function isImageSegment(segment: SegmentUnion): segment is IImageSegment;
+export declare function isStickerSegment(segment: SegmentUnion): segment is IStickerSegment;
 
 /**
  * Type guard: check if segment is text segment
  */
 export declare function isTextSegment(segment: SegmentUnion): segment is ITextSegment;
 
+export declare type IStickerSegment = StickerSegment<'sticker'>;
+
 /**
  * Check if a time point is within a segment's time range
  */
@@ -192,6 +183,7 @@ export declare type ITrack<T extends ITrackType> = {
     trackId: string;
     trackType: T;
     children: TrackTypeMapSegment[T][];
+    extra?: TrackExtra<T> | null;
 } & (T extends 'frames' ? {
     isMain?: boolean;
 } : object);
@@ -223,15 +215,37 @@ export declare interface IVideoFramesSegment extends IFramesSegment {
  * the numerical value is normalized in range [0, 1] unless otherwise specified
  */
 export declare interface IVideoProtocol {
+    id: string;
     version: `${number}.${number}.${number}`;
     width: number;
     height: number;
     fps: number;
     tracks: TrackUnion[];
+    extra?: ProtocolExtra | null;
+}
+
+export declare type ProtocolExtra = ProtocolExtraRegistry extends Record<string, never> ? Record<string, never> : NonNullable<ProtocolExtraRegistry>;
+
+export declare interface ProtocolExtraRegistry {
+}
+
+export declare type SegmentExtra<T extends ITrackType> = T extends keyof SegmentExtraRegistry ? NonNullable<SegmentExtraRegistry[T]> : Record<string, never>;
+
+export declare interface SegmentExtraRegistry {
 }
 
 export declare type SegmentUnion = TrackTypeMapSegment[ITrackType];
 
+declare interface StickerSegment<T extends ITrackType> extends ISegment<T> {
+    segmentType: T;
+    format: 'img' | 'gif';
+    url: string;
+    fillMode?: IFillMode;
+    animation?: IAnimation;
+    transform?: ITransform;
+    palette?: IPalette;
+}
+
 declare interface TextSegment<T extends ITrackType> extends ISegment<T> {
     segmentType: T;
     texts: ITextBasic[];
@@ -245,10 +259,15 @@ declare interface TextSegment<T extends ITrackType> extends ISegment<T> {
  */
 export declare const TRACK_TYPES: readonly ITrackType[];
 
+export declare type TrackExtra<T extends ITrackType> = T extends keyof TrackExtraRegistry ? NonNullable<TrackExtraRegistry[T]> : Record<string, never>;
+
+export declare interface TrackExtraRegistry {
+}
+
 export declare interface TrackTypeMapSegment {
     frames: IFramesSegmentUnion;
     text: TextSegment<'text'>;
-    image: ImageSegment<'image'>;
+    sticker: StickerSegment<'sticker'>;
     audio: AudioSegment<'audio'>;
     effect: EffectSegment<'effect'>;
     filter: FilterSegment<'filter'>;

package/dist/{videoEditorShared.js → index.js}

@@ -5,41 +5,41 @@ function r(e) {
 function u(e) {
   return e.segmentType === "frames" && "type" in e && e.type === "video";
 }
-function m(e) {
-  return e.segmentType === "text";
-}
 function s(e) {
-  return e.segmentType === "image";
+  return e.segmentType === "text";
 }
 function f(e) {
+  return e.segmentType === "sticker";
+}
+function m(e) {
   return e.segmentType === "audio";
 }
-function o(e) {
+function c(e) {
   return e.segmentType === "effect";
 }
-function T(e) {
+function o(e) {
   return e.segmentType === "filter";
 }
-function c(e) {
+function T(e) {
   return e.endTime - e.startTime;
 }
 function g(e, t) {
   return e >= t.startTime && e < t.endTime;
 }
-const n = ["frames", "text", "image", "audio", "effect", "filter"];
+const n = ["frames", "text", "sticker", "audio", "effect", "filter"];
 function a(e) {
   return n.includes(e);
 }
 export {
   i as CURRENT_PROTOCOL_VERSION,
   n as TRACK_TYPES,
-  c as getSegmentDuration,
-  f as isAudioSegment,
-  o as isEffectSegment,
-  T as isFilterSegment,
+  T as getSegmentDuration,
+  m as isAudioSegment,
+  c as isEffectSegment,
+  o as isFilterSegment,
   r as isFramesSegment,
-  s as isImageSegment,
-  m as isTextSegment,
+  f as isStickerSegment,
+  s as isTextSegment,
   g as isTimeInSegment,
   a as isValidTrackType,
   u as isVideoFramesSegment

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@video-editor/shared",
   "type": "module",
-  "version": "0.0.1-beta.1",
+  "version": "0.0.1-beta.10",
   "description": "video editor shared libs",
   "author": "",
   "license": "ISC",