fix Clap types

src/clap/parseClap.ts

@@ -1,7 +1,7 @@
 import YAML from "yaml"
 import { v4 as uuidv4 } from "uuid"
 
-import { ClapHeader, ClapMeta, ClapModel, ClapProject, ClapSegment } from "./types"
+import { ClapHeader, ClapMeta, ClapModel, ClapProject, ClapScene, ClapSegment } from "./types"
 import { getValidNumber } from "@/lib/getValidNumber"
 
 /**
@@ -68,6 +68,7 @@ export async function parseClap(inputStringOrBlob: string | Blob): Promise<ClapP
 
 
   const expectedNumberOfModels = maybeClapHeader.numberOfModels || 0
+  const expectedNumberOfScenes = maybeClapHeader.numberOfScenes || 0
   const expectedNumberOfSegments = maybeClapHeader.numberOfSegments || 0
 
   // note: we assume the order is strictly enforced!
@@ -76,10 +77,15 @@ export async function parseClap(inputStringOrBlob: string | Blob): Promise<ClapP
   const afterTheHeaders = 2
   const afterTheModels = afterTheHeaders + expectedNumberOfModels
 
+  const afterTheScenes = afterTheModels + expectedNumberOfScenes
+
   // note: if there are no expected models, maybeModels will be empty
   const maybeModels = rawData.slice(afterTheHeaders, afterTheModels) as ClapModel[]
 
-  const maybeSegments = rawData.slice(afterTheModels) as ClapSegment[]
+  // note: if there are no expected scenes, maybeScenes will be empty
+  const maybeScenes = rawData.slice(afterTheModels, afterTheScenes) as ClapScene[]
+
+  const maybeSegments = rawData.slice(afterTheScenes) as ClapSegment[]
 
   const clapModels: ClapModel[] = maybeModels.map(({
     id,
@@ -118,7 +124,30 @@ export async function parseClap(inputStringOrBlob: string | Blob): Promise<ClapP
     voiceId,
   }))
 
-
+  const clapScenes: ClapScene[] = maybeScenes.map(({
+    id,
+    scene,
+    line,
+    rawLine,
+    sequenceFullText,
+    sequenceStartAtLine,
+    sequenceEndAtLine,
+    startAtLine,
+    endAtLine,
+    events,
+  }) => ({
+    id,
+    scene,
+    line,
+    rawLine,
+    sequenceFullText,
+    sequenceStartAtLine,
+    sequenceEndAtLine,
+    startAtLine,
+    endAtLine,
+    events: events.map(e => e)
+  }))
+  
   const clapSegments: ClapSegment[] = maybeSegments.map(({
     id,
     track,
@@ -126,11 +155,15 @@ export async function parseClap(inputStringOrBlob: string | Blob): Promise<ClapP
     endTimeInMs,
     category,
     modelId,
+    sceneId,
     prompt,
     outputType,
     renderId,
     status,
     assetUrl,
+    assetDuration,
+    createdBy,
+    editedBy,
     outputGain,
     seed,
   }) => ({
@@ -141,11 +174,15 @@ export async function parseClap(inputStringOrBlob: string | Blob): Promise<ClapP
     endTimeInMs,
     category,
     modelId,
+    sceneId,
     prompt,
     outputType,
     renderId,
     status,
     assetUrl,
+    assetDuration,
+    createdBy,
+    editedBy,
     outputGain,
     seed,
   }))
@@ -153,7 +190,7 @@ export async function parseClap(inputStringOrBlob: string | Blob): Promise<ClapP
   return {
     meta: clapMeta,
     models: clapModels,
+    scenes: clapScenes,
     segments: clapSegments
   }
 }
-

src/clap/serializeClap.ts

@@ -1,12 +1,13 @@
 import YAML from "yaml"
 import { v4 as uuidv4 } from "uuid"
 
-import { ClapHeader, ClapMeta, ClapModel, ClapProject, ClapSegment } from "./types"
+import { ClapHeader, ClapMeta, ClapModel, ClapProject, ClapScene, ClapSegment } from "./types"
 import { getValidNumber } from "@/lib/getValidNumber"
 
 export async function serializeClap({
   meta, // ClapMeta
   models, // ClapModel[]
+  scenes, // ClapScene[]
   segments, // ClapSegment[]
 }: ClapProject): Promise<Blob> {
   
@@ -48,6 +49,30 @@ export async function serializeClap({
     voiceId,
   }))
 
+  const clapScenes: ClapScene[] = scenes.map(({
+    id,
+    scene,
+    line,
+    rawLine,
+    sequenceFullText,
+    sequenceStartAtLine,
+    sequenceEndAtLine,
+    startAtLine,
+    endAtLine,
+    events,
+  }) => ({
+    id,
+    scene,
+    line,
+    rawLine,
+    sequenceFullText,
+    sequenceStartAtLine,
+    sequenceEndAtLine,
+    startAtLine,
+    endAtLine,
+    events: events.map(e => e)
+  }))
+
   const clapSegments: ClapSegment[] = segments.map(({
     id,
     track,
@@ -55,11 +80,15 @@ export async function serializeClap({
     endTimeInMs,
     category,
     modelId,
+    sceneId,
     prompt,
     outputType,
     renderId,
     status,
     assetUrl,
+    assetDuration,
+    createdBy,
+    editedBy,
     outputGain,
     seed,
   }) => ({
@@ -69,11 +98,15 @@ export async function serializeClap({
     endTimeInMs,
     category,
     modelId,
+    sceneId,
     prompt,
     outputType,
     renderId,
     status,
     assetUrl,
+    assetDuration,
+    createdBy,
+    editedBy,
     outputGain,
     seed,
   }))
@@ -81,6 +114,7 @@ export async function serializeClap({
   const clapHeader: ClapHeader = {
     format: "clap-0",
     numberOfModels: clapModels.length,
+    numberOfScenes: clapScenes.length,
     numberOfSegments: clapSegments.length,
   }
 
@@ -100,6 +134,7 @@ export async function serializeClap({
     clapHeader,
     clapMeta,
     ...clapModels,
+    ...clapScenes,
     ...clapSegments
   ]
 

src/clap/types.ts

@@ -3,6 +3,11 @@ export type ClapSegmentCategory = "render" | "preview" | "characters" | "locatio
 export type ClapOutputType = "text" | "movement" | "image" | "video" | "audio"
 export type ClapSegmentStatus = "pending" | "completed" | "error"
 
+export type ClapAuthor =
+  | "auto" // the element was edited automatically using basic if/else logical rules
+  | "ai" // the element was edited using a large language model
+  | "human" // the element was edited by a human
+
 export type ClapAssetSource =
   | "REMOTE" // http:// or https://
 
@@ -60,6 +65,7 @@ export type ClapVoice = {
 export type ClapHeader = {
   format: "clap-0"
   numberOfModels: number
+  numberOfScenes: number
   numberOfSegments: number
 }
 
@@ -75,6 +81,29 @@ export type ClapMeta = {
   extraPositivePrompt: string[]
 }
 
+export type ClapSceneEvent = {
+  id: string
+  type: "description" | "dialogue" | "action"
+  character?: string
+  description: string
+  behavior: string
+  startAtLine: number
+  endAtLine: number
+}
+
+export type ClapScene = {
+  id: string
+  scene: string
+  line: string
+  rawLine: string
+  sequenceFullText: string
+  sequenceStartAtLine: number
+  sequenceEndAtLine: number
+  startAtLine: number
+  endAtLine: number
+  events: ClapSceneEvent[]
+}
+
 export type ClapSegment = {
   id: string
   track: number
@@ -82,11 +111,15 @@ export type ClapSegment = {
   endTimeInMs: number
   category: ClapSegmentCategory
   modelId: string
+  sceneId: string
   prompt: string
   outputType: ClapOutputType
   renderId: string
   status: ClapSegmentStatus
   assetUrl: string
+  assetDuration: number
+  createdBy: ClapAuthor
+  editedBy: ClapAuthor
   outputGain: number
   seed: number
 }
@@ -116,6 +149,7 @@ export type ClapModel = {
 export type ClapProject = {
   meta: ClapMeta
   models: ClapModel[]
+  scenes: ClapScene[]
   segments: ClapSegment[]
   // let's keep room for other stuff (screenplay etc)
 }