Project and artwork API

static create(options: ProjectOptions): StoryboardProject;

static fromJSON(input: unknown, options: {
    actor?: string;
} = {}): StoryboardProject;

static async open(path: string, options: {
    actor?: string;
} = {}): Promise<StoryboardProject>;

get id(): string;

get title(): string;

get canUndo(): boolean;

get canRedo(): boolean;

get version(): number;

toJSON(): StoryboardDocument;

readAsset(id: string): Buffer;

async save(path: string, options: {
    overwrite?: boolean;
    expectedVersion?: number;
    assetRoot?: string;
} = {}): Promise<void>;

transaction<T>(label: string, work: () => T): T;

undo(): boolean;

redo(): boolean;

setMetadata(key: string, value: string): this;

addScene(name: string, id?: Id): SceneHandle;

addSequence(name: string, id?: Id): SequenceHandle;

scene(id: Id): SceneHandle;

panel(id: Id): PanelHandle;

select(query: {
    panelId: Id;
    layerId?: Id;
    elementIds?: Id[];
}): Selection;

addScene(name: string, id?: Id): SceneHandle;

addShot(name: string, id?: Id): ShotHandle;

addPanel(options: PanelOptions = {}): PanelHandle;

addRasterLayer(name: string, options: LayerOptions = {}, parentGroupId?: Id): LayerHandle;

addVectorLayer(name: string, options: LayerOptions = {}, parentGroupId?: Id): LayerHandle;

addGroup(name: string, options: LayerOptions = {}, parentGroupId?: Id): LayerHandle;

addMotion(label: string, from: Point, to: Point, color = "#d14a32", id?: Id): Id;

revise(changes: Partial<Pick<Panel, "title" | "durationFrames" | "action" | "dialogue" | "camera" | "notes">>): this;

layer(id: Id): LayerHandle;

rasterSurface(image: PixelBuffer, options: Partial<Pick<RasterSurface, "id" | "name" | "matrix" | "opacity" | "visible">> = {}): Id;

readPixels(elementId: Id, region?: PixelRegion): PixelBuffer;

editPixels(elementId: Id, region: PixelRegion, edit: (patch: PixelBuffer) => void): this;

rasterStroke(points: Point[], brush: BrushPreset, options: StrokeOptions = {}): Id;

erase(points: Point[], brush: BrushPreset, options: Omit<StrokeOptions, "erase"> = {}): Id;

vectorStroke(points: Point[], options: VectorStrokeOptions = {}): Id;

path(commands: PathCommand[], options: {
    id?: Id;
    name?: string;
    fill?: VectorFill;
    stroke?: string;
    strokeWidth?: number;
    opacity?: number;
} = {}): Id;

text(text: string, x: number, y: number, options: {
    id?: Id;
    name?: string;
    color?: string;
    font?: string;
    align?: "left" | "center" | "right";
    opacity?: number;
} = {}): Id;

set(changes: LayerChanges): this;

edit(elementId: Id, updater: (element: DrawingElement) => DrawingElement): this;

outlineStroke(elementId: Id): this;

booleanPath(elementId: Id, tool: readonly PathCommand[], operation: PathBooleanOperation): this;

transform(transform: Partial<Transform>, options: {
    pivot?: Pivot;
} = {}): this;

opacity(value: number): this;

remove(): void;