vidpipe 1.3.17 → 1.3.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -217,6 +217,8 @@ interface ShortClip {
217
217
  isLoopCandidate?: boolean;
218
218
  /** Path to generated thumbnail image for this short clip */
219
219
  thumbnailPath?: string;
220
+ /** GitHub Issue number of the matched/created idea for this clip (per-clip idea tagging) */
221
+ ideaIssueNumber?: number;
220
222
  }
221
223
  /** A planned medium clip segment */
222
224
  interface MediumSegment {
@@ -256,6 +258,8 @@ interface MediumClip {
256
258
  microHooks?: string[];
257
259
  /** Path to generated thumbnail image for this medium clip */
258
260
  thumbnailPath?: string;
261
+ /** GitHub Issue number of the matched/created idea for this clip (per-clip idea tagging) */
262
+ ideaIssueNumber?: number;
259
263
  }
260
264
  interface SocialPost {
261
265
  platform: Platform;
@@ -331,6 +335,7 @@ declare enum PipelineStage {
331
335
  CaptionBurn = "caption-burn",
332
336
  IntroOutro = "intro-outro",
333
337
  Summary = "summary",
338
+ IdeaDiscovery = "idea-discovery",
334
339
  Shorts = "shorts",
335
340
  MediumClips = "medium-clips",
336
341
  SocialMedia = "social-media",
@@ -741,6 +746,43 @@ interface InterviewErrorEvent {
741
746
  * The SDK consumer or CLI UI implements this to show the question and collect the response.
742
747
  */
743
748
  type AnswerProvider = (question: string, context: QuestionContext) => Promise<string>;
749
+ /** A single section in a recording agenda, mapped to one idea. */
750
+ interface AgendaSection {
751
+ /** Section position (1-based) */
752
+ order: number;
753
+ /** Section title for the recording outline */
754
+ title: string;
755
+ /** GitHub Issue number of the idea this section covers */
756
+ ideaIssueNumber: number;
757
+ /** Estimated recording time in minutes */
758
+ estimatedMinutes: number;
759
+ /** Talking points to cover in this section (from the idea + agent refinement) */
760
+ talkingPoints: string[];
761
+ /** Transition phrase to lead into the NEXT section (empty for last section) */
762
+ transition: string;
763
+ /** Recording notes: key phrases, visual cues, energy direction */
764
+ notes: string;
765
+ }
766
+ /** Complete result from agenda generation. */
767
+ interface AgendaResult {
768
+ /** Ordered list of recording sections */
769
+ sections: AgendaSection[];
770
+ /** Opening hook/intro text for the recording */
771
+ intro: string;
772
+ /** Closing CTA/outro text */
773
+ outro: string;
774
+ /** Total estimated recording duration in minutes */
775
+ estimatedDuration: number;
776
+ /** Fully formatted markdown agenda ready to print or save */
777
+ markdown: string;
778
+ /** Generation duration in milliseconds */
779
+ durationMs: number;
780
+ }
781
+ /** Options for generating a recording agenda. */
782
+ interface GenerateAgendaOptions {
783
+ /** Override the output file path for the agenda markdown */
784
+ outputPath?: string;
785
+ }
744
786
 
745
787
  interface AppEnvironment {
746
788
  OPENAI_API_KEY: string;
@@ -813,6 +855,8 @@ interface TimeSlot {
813
855
  interface ClipTypeSchedule {
814
856
  slots: TimeSlot[];
815
857
  avoidDays: DayOfWeek[];
858
+ queueId?: string;
859
+ queueName?: string;
816
860
  }
817
861
  interface PlatformSchedule {
818
862
  slots: TimeSlot[];
@@ -879,6 +923,10 @@ interface ProcessOptions {
879
923
  skipVisualEnhancement?: boolean;
880
924
  /** Skip publishing generated social content */
881
925
  skipSocialPublish?: boolean;
926
+ /** Pipeline spec preset name or path to YAML spec file */
927
+ spec?: string;
928
+ /** ISO 8601 date for the publish-by deadline of auto-created ideas (default: 7 days from now) */
929
+ publishBy?: string;
882
930
  /** Callback for real-time pipeline progress events (stage starts, completions, errors) */
883
931
  onProgress?: (event: ProgressEvent) => void;
884
932
  }
@@ -947,6 +995,13 @@ interface StartInterviewOptions {
947
995
  /** Callback for real-time interview events (questions, thinking, tool calls, insights) */
948
996
  onEvent?: (event: InterviewEvent) => void;
949
997
  }
998
+ /**
999
+ * Options for generating a recording agenda from multiple ideas.
1000
+ */
1001
+ interface GenerateAgendaSDKOptions {
1002
+ /** Override the output file path for the agenda markdown */
1003
+ outputPath?: string;
1004
+ }
950
1005
  /**
951
1006
  * Main VidPipe SDK interface.
952
1007
  */
@@ -957,6 +1012,8 @@ interface VidPipeSDK {
957
1012
  ideate(options?: IdeateOptions): Promise<Idea[]>;
958
1013
  /** Start an interactive session to develop an idea (Socratic interview, etc.) */
959
1014
  startInterview(ideaNumber: number, options: StartInterviewOptions): Promise<InterviewResult>;
1015
+ /** Generate a structured recording agenda from multiple ideas */
1016
+ generateAgenda(ideaNumbers: number[], options?: GenerateAgendaSDKOptions): Promise<AgendaResult>;
960
1017
  /** Idea management */
961
1018
  ideas: {
962
1019
  list(filters?: IdeaFilters): Promise<Idea[]>;
@@ -1018,4 +1075,4 @@ type ProgressListener = (event: ProgressEvent) => void;
1018
1075
 
1019
1076
  type InterviewListener = (event: InterviewEvent) => void;
1020
1077
 
1021
- export { type AgentResult, type AnswerProvider, type AnswerReceivedEvent, type AspectRatio, type CaptionStyle, type Chapter, type CreateIdeaInput, type DiagnosticCheck, type DiagnosticResult, type EmotionalTrigger, type EnhancementOpportunity, type GeneratedClip, type GeneratedOverlay, type HookType, type Idea, type IdeaCommentData, type IdeaFilters, type IdeaPublishRecord, type IdeaStatus, type IdeateOptions, type InsightDiscoveredEvent, type InterviewCompleteEvent, type InterviewErrorEvent, type InterviewEvent, type InterviewInsights, type InterviewListener, type InterviewResult, type InterviewStartEvent, type MediumClip, type MediumClipType, type MediumNarrativeStructure, type MediumSegment, type OverlayPlacement, type OverlayRegion, PLATFORM_CHAR_LIMITS, type PipelineCompleteEvent, type PipelineResult, PipelineStage, type PipelineStartEvent, Platform, type ProcessOptions, type ProgressEvent, type ProgressListener, type QAPair, type QuestionAskedEvent, type QuestionContext, type RealignOptions, SUPPORTED_VIDEO_EXTENSIONS, type ScheduleSlot, type ScreenRegion, type Segment, type ShortClip, type ShortClipVariant, type ShortNarrativeStructure, type ShortSegment, type SilenceRemovalResult, type SlotOptions, type SocialPost, type StageCompleteEvent, type StageErrorEvent, type StageResult, type StageSkipEvent, type StageStartEvent, type StartInterviewOptions, type StartMode, type ThinkingEndEvent, type ThinkingStartEvent, type ToolCallEndEvent, type ToolCallStartEvent, type Transcript, type VidPipeConfig, type VidPipeSDK, type VideoFile, type VideoLayout, type VideoPlatform, type VideoSnapshot, type VideoSummary, type VisualEnhancementResult, type WebcamRegion, type Word, createVidPipe, fromLatePlatform, normalizePlatformString, toLatePlatform };
1078
+ export { type AgendaResult, type AgendaSection, type AgentResult, type AnswerProvider, type AnswerReceivedEvent, type AspectRatio, type CaptionStyle, type Chapter, type CreateIdeaInput, type DiagnosticCheck, type DiagnosticResult, type EmotionalTrigger, type EnhancementOpportunity, type GenerateAgendaOptions, type GeneratedClip, type GeneratedOverlay, type HookType, type Idea, type IdeaCommentData, type IdeaFilters, type IdeaPublishRecord, type IdeaStatus, type IdeateOptions, type InsightDiscoveredEvent, type InterviewCompleteEvent, type InterviewErrorEvent, type InterviewEvent, type InterviewInsights, type InterviewListener, type InterviewResult, type InterviewStartEvent, type MediumClip, type MediumClipType, type MediumNarrativeStructure, type MediumSegment, type OverlayPlacement, type OverlayRegion, PLATFORM_CHAR_LIMITS, type PipelineCompleteEvent, type PipelineResult, PipelineStage, type PipelineStartEvent, Platform, type ProcessOptions, type ProgressEvent, type ProgressListener, type QAPair, type QuestionAskedEvent, type QuestionContext, type RealignOptions, SUPPORTED_VIDEO_EXTENSIONS, type ScheduleSlot, type ScreenRegion, type Segment, type ShortClip, type ShortClipVariant, type ShortNarrativeStructure, type ShortSegment, type SilenceRemovalResult, type SlotOptions, type SocialPost, type StageCompleteEvent, type StageErrorEvent, type StageResult, type StageSkipEvent, type StageStartEvent, type StartInterviewOptions, type StartMode, type ThinkingEndEvent, type ThinkingStartEvent, type ToolCallEndEvent, type ToolCallStartEvent, type Transcript, type VidPipeConfig, type VidPipeSDK, type VideoFile, type VideoLayout, type VideoPlatform, type VideoSnapshot, type VideoSummary, type VisualEnhancementResult, type WebcamRegion, type Word, createVidPipe, fromLatePlatform, normalizePlatformString, toLatePlatform };