/** * Auto-generated API documentation for IDE sidebar * Generated from TypeScript source files via reflection * DO NOT EDIT MANUALLY - run `npm run docs:generate` to regenerate */ export interface ApiSection { name: string; items: ApiItem[]; } export interface ApiItem { name: string; type: "function" | "class" | "type" | "interface" | "const" | "method"; signature?: string; description?: string; example?: string; returns?: string; params?: { name: string; type: string; description?: string }[]; } export const API_DOCS: ApiSection[] = [ { name: "Text Prompts", items: [ { name: "builder()", type: "function", signature: "builder(): PromptBuilder", description: "Create a new prompt builder", returns: "PromptBuilder", params: [], }, { name: "fromPrompt()", type: "function", signature: "fromPrompt(content: string): PromptBuilder", description: "Create a prompt builder from an existing prompt", returns: "PromptBuilder", params: [{"name":"content","type":"string"}], }, { name: "PromptBuilder", type: "class", description: "", }, { name: ".role()", type: "method", signature: "role(role: string): this", description: "Set the role/persona for the AI", returns: "this", params: [{"name":"role","type":"string"}], }, { name: ".persona()", type: "method", signature: "persona(persona: string): this", description: "Alias for role()", returns: "this", params: [{"name":"persona","type":"string"}], }, { name: ".context()", type: "method", signature: "context(context: string): this", description: "Set the context/background information", returns: "this", params: [{"name":"context","type":"string"}], }, { name: ".background()", type: "method", signature: "background(background: string): this", description: "Alias for context()", returns: "this", params: [{"name":"background","type":"string"}], }, { name: ".task()", type: "method", signature: "task(task: string): this", description: "Set the main task/instruction", returns: "this", params: [{"name":"task","type":"string"}], }, { name: ".instruction()", type: "method", signature: "instruction(instruction: string): this", description: "Alias for task()", returns: "this", params: [{"name":"instruction","type":"string"}], }, { name: ".constraints()", type: "method", signature: "constraints(constraints: string[]): this", description: "Add constraints/rules the AI should follow", returns: "this", params: [{"name":"constraints","type":"string[]"}], }, { name: ".constraint()", type: "method", signature: "constraint(constraint: string): this", description: "Add a single constraint", returns: "this", params: [{"name":"constraint","type":"string"}], }, { name: ".rules()", type: "method", signature: "rules(rules: string[]): this", description: "Alias for constraints()", returns: "this", params: [{"name":"rules","type":"string[]"}], }, { name: ".output()", type: "method", signature: "output(format: string): this", description: "Set the expected output format", returns: "this", params: [{"name":"format","type":"string"}], }, { name: ".format()", type: "method", signature: "format(format: string): this", description: "Alias for output()", returns: "this", params: [{"name":"format","type":"string"}], }, { name: ".example()", type: "method", signature: "example(input: string, output: string): this", description: "Add an example input/output pair", returns: "this", params: [{"name":"input","type":"string"},{"name":"output","type":"string"}], }, { name: ".examples()", type: "method", signature: "examples(examples: Array<{ input: string; output: string }>): this", description: "Add multiple examples", returns: "this", params: [{"name":"examples","type":"Array<{ input: string; output: string }>"}], }, { name: ".variable()", type: "method", signature: "variable(name: string, options?: { description?: string; required?: boolean; defaultValue?: string }): this", description: "Define a variable placeholder", returns: "this", params: [{"name":"name","type":"string"},{"name":"options","type":"{ description?: string; required?: boolean; defaultValue?: string }"}], }, { name: ".section()", type: "method", signature: "section(title: string, content: string): this", description: "Add a custom section", returns: "this", params: [{"name":"title","type":"string"},{"name":"content","type":"string"}], }, { name: ".raw()", type: "method", signature: "raw(content: string): this", description: "Set raw content (bypasses structured building)", returns: "this", params: [{"name":"content","type":"string"}], }, { name: ".build()", type: "method", signature: "build(): BuiltPrompt", description: "Build the final prompt", returns: "BuiltPrompt", params: [], }, { name: ".toString()", type: "method", signature: "toString(): string", description: "Build and return only the content string", returns: "string", params: [], }, { name: "PromptVariable", type: "interface", description: "Prompt Builder - A fluent DSL for creating structured prompts", }, { name: "BuiltPrompt", type: "interface", description: "", }, { name: "templates", type: "const", signature: "templates", description: "", }, { name: "templates.codeReview()", type: "method", signature: "codeReview(options?: { language?: string; focus?: string[] }): any", description: "Create a code review prompt", returns: "any", params: [{"name":"options","type":"{ language?: string; focus?: string[] }"}], }, { name: "templates.translation()", type: "method", signature: "translation(from: string, to: string): any", description: "Create a translation prompt", returns: "any", params: [{"name":"from","type":"string"},{"name":"to","type":"string"}], }, { name: "templates.summarize()", type: "method", signature: "summarize(options?: { maxLength?: number; style?: 'bullet' | 'paragraph' }): any", description: "Create a summarization prompt", returns: "any", params: [{"name":"options","type":"{ maxLength?: number; style?: 'bullet' | 'paragraph' }"}], }, { name: "templates.qa()", type: "method", signature: "qa(context?: string): any", description: "Create a Q&A prompt", returns: "any", params: [{"name":"context","type":"string"}], }, { name: "templates.debug()", type: "method", signature: "debug(options?: { language?: string; errorType?: string }): any", description: "Create a debugging prompt", returns: "any", params: [{"name":"options","type":"{ language?: string; errorType?: string }"}], }, { name: "templates.write()", type: "method", signature: "write(options?: { type?: 'blog' | 'email' | 'essay' | 'story' | 'documentation'; tone?: string }): any", description: "Create a writing assistant prompt", returns: "any", params: [{"name":"options","type":"{ type?: 'blog' | 'email' | 'essay' | 'story' | 'documentation'; tone?: string }"}], }, { name: "templates.explain()", type: "method", signature: "explain(options?: { level?: 'beginner' | 'intermediate' | 'expert'; useAnalogies?: boolean }): any", description: "Create an explanation/teaching prompt", returns: "any", params: [{"name":"options","type":"{ level?: 'beginner' | 'intermediate' | 'expert'; useAnalogies?: boolean }"}], }, { name: "templates.extract()", type: "method", signature: "extract(options?: { format?: 'json' | 'csv' | 'table'; fields?: string[] }): any", description: "Create a data extraction prompt", returns: "any", params: [{"name":"options","type":"{ format?: 'json' | 'csv' | 'table'; fields?: string[] }"}], }, { name: "templates.brainstorm()", type: "method", signature: "brainstorm(options?: { count?: number; creative?: boolean }): any", description: "Create a brainstorming prompt", returns: "any", params: [{"name":"options","type":"{ count?: number; creative?: boolean }"}], }, { name: "templates.refactor()", type: "method", signature: "refactor(options?: { goal?: 'readability' | 'performance' | 'maintainability' | 'all'; language?: string }): any", description: "Create a code refactoring prompt", returns: "any", params: [{"name":"options","type":"{ goal?: 'readability' | 'performance' | 'maintainability' | 'all'; language?: string }"}], }, { name: "templates.apiDocs()", type: "method", signature: "apiDocs(options?: { style?: 'openapi' | 'markdown' | 'jsdoc'; includeExamples?: boolean }): any", description: "Create an API documentation prompt", returns: "any", params: [{"name":"options","type":"{ style?: 'openapi' | 'markdown' | 'jsdoc'; includeExamples?: boolean }"}], }, { name: "templates.unitTest()", type: "method", signature: "unitTest(options?: { framework?: string; coverage?: 'basic' | 'comprehensive' }): any", description: "Create a unit test generation prompt", returns: "any", params: [{"name":"options","type":"{ framework?: string; coverage?: 'basic' | 'comprehensive' }"}], }, { name: "templates.commitMessage()", type: "method", signature: "commitMessage(options?: { style?: 'conventional' | 'simple'; includeBody?: boolean }): any", description: "Create a commit message prompt", returns: "any", params: [{"name":"options","type":"{ style?: 'conventional' | 'simple'; includeBody?: boolean }"}], }, { name: "templates.reviewComment()", type: "method", signature: "reviewComment(options?: { tone?: 'constructive' | 'direct'; severity?: boolean }): any", description: "Create a code review comment prompt", returns: "any", params: [{"name":"options","type":"{ tone?: 'constructive' | 'direct'; severity?: boolean }"}], }, { name: "templates.regex()", type: "method", signature: "regex(options?: { flavor?: 'javascript' | 'python' | 'pcre' }): any", description: "Create a regex generator prompt", returns: "any", params: [{"name":"options","type":"{ flavor?: 'javascript' | 'python' | 'pcre' }"}], }, { name: "templates.sql()", type: "method", signature: "sql(options?: { dialect?: 'postgresql' | 'mysql' | 'sqlite' | 'mssql'; optimize?: boolean }): any", description: "Create a SQL query prompt", returns: "any", params: [{"name":"options","type":"{ dialect?: 'postgresql' | 'mysql' | 'sqlite' | 'mssql'; optimize?: boolean }"}], } ], }, { name: "Chat Prompts", items: [ { name: "chat()", type: "function", signature: "chat(): ChatPromptBuilder", description: "Create a new chat prompt builder", returns: "ChatPromptBuilder", params: [], }, { name: "ChatPromptBuilder", type: "class", description: "", }, { name: ".system()", type: "method", signature: "system(content: string): this", description: "", returns: "this", params: [{"name":"content","type":"string"}], }, { name: ".user()", type: "method", signature: "user(content: string, name?: string): this", description: "", returns: "this", params: [{"name":"content","type":"string"},{"name":"name","type":"string"}], }, { name: ".assistant()", type: "method", signature: "assistant(content: string): this", description: "", returns: "this", params: [{"name":"content","type":"string"}], }, { name: ".message()", type: "method", signature: "message(role: MessageRole, content: string, name?: string): this", description: "", returns: "this", params: [{"name":"role","type":"MessageRole"},{"name":"content","type":"string"},{"name":"name","type":"string"}], }, { name: ".messages()", type: "method", signature: "messages(messages: ChatMessage[]): this", description: "", returns: "this", params: [{"name":"messages","type":"ChatMessage[]"}], }, { name: ".conversation()", type: "method", signature: "conversation(turns: Array<{ user: string; assistant?: string }>): this", description: "", returns: "this", params: [{"name":"turns","type":"Array<{ user: string; assistant?: string }>"}], }, { name: ".persona()", type: "method", signature: "persona(settings: ChatPersona | string): this", description: "", returns: "this", params: [{"name":"settings","type":"ChatPersona | string"}], }, { name: ".role()", type: "method", signature: "role(role: string): this", description: "", returns: "this", params: [{"name":"role","type":"string"}], }, { name: ".tone()", type: "method", signature: "tone(tone: PersonaTone | PersonaTone[]): this", description: "", returns: "this", params: [{"name":"tone","type":"PersonaTone | PersonaTone[]"}], }, { name: ".expertise()", type: "method", signature: "expertise(expertise: PersonaExpertise | PersonaExpertise[]): this", description: "", returns: "this", params: [{"name":"expertise","type":"PersonaExpertise | PersonaExpertise[]"}], }, { name: ".personality()", type: "method", signature: "personality(traits: string[]): this", description: "", returns: "this", params: [{"name":"traits","type":"string[]"}], }, { name: ".background()", type: "method", signature: "background(background: string): this", description: "", returns: "this", params: [{"name":"background","type":"string"}], }, { name: ".speakAs()", type: "method", signature: "speakAs(name: string): this", description: "", returns: "this", params: [{"name":"name","type":"string"}], }, { name: ".responseLanguage()", type: "method", signature: "responseLanguage(language: string): this", description: "", returns: "this", params: [{"name":"language","type":"string"}], }, { name: ".context()", type: "method", signature: "context(settings: ChatContext | string): this", description: "", returns: "this", params: [{"name":"settings","type":"ChatContext | string"}], }, { name: ".domain()", type: "method", signature: "domain(domain: string): this", description: "", returns: "this", params: [{"name":"domain","type":"string"}], }, { name: ".audience()", type: "method", signature: "audience(audience: string): this", description: "", returns: "this", params: [{"name":"audience","type":"string"}], }, { name: ".purpose()", type: "method", signature: "purpose(purpose: string): this", description: "", returns: "this", params: [{"name":"purpose","type":"string"}], }, { name: ".constraints()", type: "method", signature: "constraints(constraints: string[]): this", description: "", returns: "this", params: [{"name":"constraints","type":"string[]"}], }, { name: ".constraint()", type: "method", signature: "constraint(constraint: string): this", description: "", returns: "this", params: [{"name":"constraint","type":"string"}], }, { name: ".assumptions()", type: "method", signature: "assumptions(assumptions: string[]): this", description: "", returns: "this", params: [{"name":"assumptions","type":"string[]"}], }, { name: ".knowledge()", type: "method", signature: "knowledge(facts: string[]): this", description: "", returns: "this", params: [{"name":"facts","type":"string[]"}], }, { name: ".task()", type: "method", signature: "task(instruction: string | ChatTask): this", description: "", returns: "this", params: [{"name":"instruction","type":"string | ChatTask"}], }, { name: ".instruction()", type: "method", signature: "instruction(instruction: string): this", description: "", returns: "this", params: [{"name":"instruction","type":"string"}], }, { name: ".steps()", type: "method", signature: "steps(steps: string[]): this", description: "", returns: "this", params: [{"name":"steps","type":"string[]"}], }, { name: ".deliverables()", type: "method", signature: "deliverables(deliverables: string[]): this", description: "", returns: "this", params: [{"name":"deliverables","type":"string[]"}], }, { name: ".criteria()", type: "method", signature: "criteria(criteria: string[]): this", description: "", returns: "this", params: [{"name":"criteria","type":"string[]"}], }, { name: ".avoid()", type: "method", signature: "avoid(antiPatterns: string[]): this", description: "", returns: "this", params: [{"name":"antiPatterns","type":"string[]"}], }, { name: ".priority()", type: "method", signature: "priority(priority: ChatTask['priority']): this", description: "", returns: "this", params: [{"name":"priority","type":"ChatTask['priority']"}], }, { name: ".example()", type: "method", signature: "example(input: string, output: string, explanation?: string): this", description: "", returns: "this", params: [{"name":"input","type":"string"},{"name":"output","type":"string"},{"name":"explanation","type":"string"}], }, { name: ".examples()", type: "method", signature: "examples(examples: ChatExample[]): this", description: "", returns: "this", params: [{"name":"examples","type":"ChatExample[]"}], }, { name: ".fewShot()", type: "method", signature: "fewShot(examples: Array<{ input: string; output: string }>): this", description: "", returns: "this", params: [{"name":"examples","type":"Array<{ input: string; output: string }>"}], }, { name: ".output()", type: "method", signature: "output(settings: ChatOutput): this", description: "", returns: "this", params: [{"name":"settings","type":"ChatOutput"}], }, { name: ".outputFormat()", type: "method", signature: "outputFormat(format: ResponseFormatType): this", description: "", returns: "this", params: [{"name":"format","type":"ResponseFormatType"}], }, { name: ".json()", type: "method", signature: "json(schema?: JsonSchema): this", description: "", returns: "this", params: [{"name":"schema","type":"JsonSchema"}], }, { name: ".jsonSchema()", type: "method", signature: "jsonSchema(name: string, schema: Record, description?: string): this", description: "", returns: "this", params: [{"name":"name","type":"string"},{"name":"schema","type":"Record"},{"name":"description","type":"string"}], }, { name: ".markdown()", type: "method", signature: "markdown(): this", description: "", returns: "this", params: [], }, { name: ".code()", type: "method", signature: "code(language?: string): this", description: "", returns: "this", params: [{"name":"language","type":"string"}], }, { name: ".table()", type: "method", signature: "table(): this", description: "", returns: "this", params: [], }, { name: ".length()", type: "method", signature: "length(length: OutputLength): this", description: "", returns: "this", params: [{"name":"length","type":"OutputLength"}], }, { name: ".style()", type: "method", signature: "style(style: OutputStyle): this", description: "", returns: "this", params: [{"name":"style","type":"OutputStyle"}], }, { name: ".brief()", type: "method", signature: "brief(): this", description: "", returns: "this", params: [], }, { name: ".moderate()", type: "method", signature: "moderate(): this", description: "", returns: "this", params: [], }, { name: ".detailed()", type: "method", signature: "detailed(): this", description: "", returns: "this", params: [], }, { name: ".comprehensive()", type: "method", signature: "comprehensive(): this", description: "", returns: "this", params: [], }, { name: ".exhaustive()", type: "method", signature: "exhaustive(): this", description: "", returns: "this", params: [], }, { name: ".withExamples()", type: "method", signature: "withExamples(): this", description: "", returns: "this", params: [], }, { name: ".withExplanation()", type: "method", signature: "withExplanation(): this", description: "", returns: "this", params: [], }, { name: ".withSources()", type: "method", signature: "withSources(): this", description: "", returns: "this", params: [], }, { name: ".withConfidence()", type: "method", signature: "withConfidence(): this", description: "", returns: "this", params: [], }, { name: ".reasoning()", type: "method", signature: "reasoning(settings: ChatReasoning): this", description: "", returns: "this", params: [{"name":"settings","type":"ChatReasoning"}], }, { name: ".reasoningStyle()", type: "method", signature: "reasoningStyle(style: ReasoningStyle): this", description: "", returns: "this", params: [{"name":"style","type":"ReasoningStyle"}], }, { name: ".stepByStep()", type: "method", signature: "stepByStep(): this", description: "", returns: "this", params: [], }, { name: ".chainOfThought()", type: "method", signature: "chainOfThought(): this", description: "", returns: "this", params: [], }, { name: ".treeOfThought()", type: "method", signature: "treeOfThought(): this", description: "", returns: "this", params: [], }, { name: ".firstPrinciples()", type: "method", signature: "firstPrinciples(): this", description: "", returns: "this", params: [], }, { name: ".devilsAdvocate()", type: "method", signature: "devilsAdvocate(): this", description: "", returns: "this", params: [], }, { name: ".showWork()", type: "method", signature: "showWork(show?: any): this", description: "", returns: "this", params: [{"name":"show","type":"any"}], }, { name: ".verifyAnswer()", type: "method", signature: "verifyAnswer(verify?: any): this", description: "", returns: "this", params: [{"name":"verify","type":"any"}], }, { name: ".considerAlternatives()", type: "method", signature: "considerAlternatives(consider?: any): this", description: "", returns: "this", params: [{"name":"consider","type":"any"}], }, { name: ".explainAssumptions()", type: "method", signature: "explainAssumptions(explain?: any): this", description: "", returns: "this", params: [{"name":"explain","type":"any"}], }, { name: ".memory()", type: "method", signature: "memory(memory: ChatMemory): this", description: "", returns: "this", params: [{"name":"memory","type":"ChatMemory"}], }, { name: ".remember()", type: "method", signature: "remember(facts: string[]): this", description: "", returns: "this", params: [{"name":"facts","type":"string[]"}], }, { name: ".preferences()", type: "method", signature: "preferences(prefs: string[]): this", description: "", returns: "this", params: [{"name":"prefs","type":"string[]"}], }, { name: ".history()", type: "method", signature: "history(messages: ChatMessage[]): this", description: "", returns: "this", params: [{"name":"messages","type":"ChatMessage[]"}], }, { name: ".summarizeHistory()", type: "method", signature: "summarizeHistory(summary: string): this", description: "", returns: "this", params: [{"name":"summary","type":"string"}], }, { name: ".addSystemPart()", type: "method", signature: "addSystemPart(part: string): this", description: "", returns: "this", params: [{"name":"part","type":"string"}], }, { name: ".raw()", type: "method", signature: "raw(content: string): this", description: "", returns: "this", params: [{"name":"content","type":"string"}], }, { name: ".build()", type: "method", signature: "build(): BuiltChatPrompt", description: "", returns: "BuiltChatPrompt", params: [], }, { name: ".toString()", type: "method", signature: "toString(): string", description: "", returns: "string", params: [], }, { name: ".toSystemPrompt()", type: "method", signature: "toSystemPrompt(): string", description: "", returns: "string", params: [], }, { name: ".toMessages()", type: "method", signature: "toMessages(): ChatMessage[]", description: "", returns: "ChatMessage[]", params: [], }, { name: ".toJSON()", type: "method", signature: "toJSON(): string", description: "", returns: "string", params: [], }, { name: ".toYAML()", type: "method", signature: "toYAML(): string", description: "", returns: "string", params: [], }, { name: ".toMarkdown()", type: "method", signature: "toMarkdown(): string", description: "", returns: "string", params: [], }, { name: "ChatMessage", type: "interface", description: "", }, { name: "JsonSchema", type: "interface", description: "", }, { name: "ResponseFormat", type: "interface", description: "", }, { name: "ChatPersona", type: "interface", description: "", }, { name: "ChatContext", type: "interface", description: "", }, { name: "ChatTask", type: "interface", description: "", }, { name: "ChatOutput", type: "interface", description: "", }, { name: "ChatReasoning", type: "interface", description: "", }, { name: "ChatExample", type: "interface", description: "", }, { name: "ChatMemory", type: "interface", description: "", }, { name: "BuiltChatPrompt", type: "interface", description: "", }, { name: "MessageRole", type: "type", signature: "type MessageRole = 'system' | 'user' | 'assistant'", description: "Chat Prompt Builder - Model-Agnostic Conversation Prompt Builder\n\nBuild structured prompts for any chat/conversation model.\nFocus on prompt engineering, not model-specific features.", }, { name: "ResponseFormatType", type: "type", signature: "type ResponseFormatType = 'text' | 'json' | 'markdown' | 'code' | 'table'", description: "", }, { name: "PersonaTone", type: "type", signature: "type PersonaTone = | 'professional' | 'casual' | 'formal' | 'friendly' | 'academic'\n | 'technical' | 'creative' | 'empathetic' | 'authoritative' | 'playful'\n | 'concise' | 'detailed' | 'socratic' | 'coaching' | 'analytical'\n | 'encouraging' | 'neutral' | 'humorous' | 'serious'", description: "", }, { name: "PersonaExpertise", type: "type", signature: "type PersonaExpertise = | 'general' | 'coding' | 'writing' | 'analysis' | 'research'\n | 'teaching' | 'counseling' | 'creative' | 'legal' | 'medical'\n | 'financial' | 'scientific' | 'engineering' | 'design' | 'marketing'\n | 'business' | 'philosophy' | 'history' | 'languages' | 'mathematics'", description: "", }, { name: "ReasoningStyle", type: "type", signature: "type ReasoningStyle = | 'step-by-step' | 'chain-of-thought' | 'tree-of-thought' \n | 'direct' | 'analytical' | 'comparative' | 'deductive' | 'inductive'\n | 'first-principles' | 'analogical' | 'devil-advocate'", description: "", }, { name: "OutputLength", type: "type", signature: "type OutputLength = 'brief' | 'moderate' | 'detailed' | 'comprehensive' | 'exhaustive'", description: "", }, { name: "OutputStyle", type: "type", signature: "type OutputStyle = 'prose' | 'bullet-points' | 'numbered-list' | 'table' | 'code' | 'mixed' | 'qa' | 'dialogue'", description: "", }, { name: "chatPresets", type: "const", signature: "chatPresets", description: "", }, { name: "chatPresets.coder()", type: "method", signature: "coder(language?: string): any", description: "Code assistant preset", returns: "any", params: [{"name":"language","type":"string"}], }, { name: "chatPresets.writer()", type: "method", signature: "writer(style?: 'creative' | 'professional' | 'academic'): any", description: "Writing assistant preset", returns: "any", params: [{"name":"style","type":"'creative' | 'professional' | 'academic'"}], }, { name: "chatPresets.tutor()", type: "method", signature: "tutor(subject?: string): any", description: "Teacher/tutor preset", returns: "any", params: [{"name":"subject","type":"string"}], }, { name: "chatPresets.analyst()", type: "method", signature: "analyst(): any", description: "Analyst preset", returns: "any", params: [], }, { name: "chatPresets.socratic()", type: "method", signature: "socratic(): any", description: "Socratic dialogue preset", returns: "any", params: [], }, { name: "chatPresets.critic()", type: "method", signature: "critic(): any", description: "Critic preset", returns: "any", params: [], }, { name: "chatPresets.brainstormer()", type: "method", signature: "brainstormer(): any", description: "Brainstormer preset", returns: "any", params: [], }, { name: "chatPresets.jsonResponder()", type: "method", signature: "jsonResponder(schemaName: string, schema: Record): any", description: "JSON response preset", returns: "any", params: [{"name":"schemaName","type":"string"},{"name":"schema","type":"Record"}], }, { name: "chatPresets.summarizer()", type: "method", signature: "summarizer(length?: OutputLength): any", description: "Summarizer preset", returns: "any", params: [{"name":"length","type":"OutputLength"}], }, { name: "chatPresets.translator()", type: "method", signature: "translator(targetLanguage: string): any", description: "Translator preset", returns: "any", params: [{"name":"targetLanguage","type":"string"}], } ], }, { name: "Image Prompts", items: [ { name: "image()", type: "function", signature: "image(): ImagePromptBuilder", description: "Create a new image prompt builder", returns: "ImagePromptBuilder", params: [], }, { name: "ImagePromptBuilder", type: "class", description: "", }, { name: ".subject()", type: "method", signature: "subject(main: string | ImageSubject): this", description: "", returns: "this", params: [{"name":"main","type":"string | ImageSubject"}], }, { name: ".subjectDetails()", type: "method", signature: "subjectDetails(details: string[]): this", description: "", returns: "this", params: [{"name":"details","type":"string[]"}], }, { name: ".expression()", type: "method", signature: "expression(expression: string): this", description: "", returns: "this", params: [{"name":"expression","type":"string"}], }, { name: ".pose()", type: "method", signature: "pose(pose: string): this", description: "", returns: "this", params: [{"name":"pose","type":"string"}], }, { name: ".action()", type: "method", signature: "action(action: string): this", description: "", returns: "this", params: [{"name":"action","type":"string"}], }, { name: ".clothing()", type: "method", signature: "clothing(clothing: string): this", description: "", returns: "this", params: [{"name":"clothing","type":"string"}], }, { name: ".accessories()", type: "method", signature: "accessories(accessories: string[]): this", description: "", returns: "this", params: [{"name":"accessories","type":"string[]"}], }, { name: ".subjectCount()", type: "method", signature: "subjectCount(count: ImageSubject['count']): this", description: "", returns: "this", params: [{"name":"count","type":"ImageSubject['count']"}], }, { name: ".camera()", type: "method", signature: "camera(settings: ImageCamera): this", description: "", returns: "this", params: [{"name":"settings","type":"ImageCamera"}], }, { name: ".angle()", type: "method", signature: "angle(angle: CameraAngle): this", description: "", returns: "this", params: [{"name":"angle","type":"CameraAngle"}], }, { name: ".shot()", type: "method", signature: "shot(shot: ShotType): this", description: "", returns: "this", params: [{"name":"shot","type":"ShotType"}], }, { name: ".lens()", type: "method", signature: "lens(lens: LensType): this", description: "", returns: "this", params: [{"name":"lens","type":"LensType"}], }, { name: ".focus()", type: "method", signature: "focus(focus: FocusType): this", description: "", returns: "this", params: [{"name":"focus","type":"FocusType"}], }, { name: ".aperture()", type: "method", signature: "aperture(aperture: string): this", description: "", returns: "this", params: [{"name":"aperture","type":"string"}], }, { name: ".filmStock()", type: "method", signature: "filmStock(filmStock: FilmStock): this", description: "", returns: "this", params: [{"name":"filmStock","type":"FilmStock"}], }, { name: ".filmFormat()", type: "method", signature: "filmFormat(format: FilmFormat): this", description: "", returns: "this", params: [{"name":"format","type":"FilmFormat"}], }, { name: ".cameraBrand()", type: "method", signature: "cameraBrand(brand: CameraBrand): this", description: "", returns: "this", params: [{"name":"brand","type":"CameraBrand"}], }, { name: ".cameraModel()", type: "method", signature: "cameraModel(model: CameraModel): this", description: "", returns: "this", params: [{"name":"model","type":"CameraModel"}], }, { name: ".sensor()", type: "method", signature: "sensor(sensor: SensorFormat): this", description: "", returns: "this", params: [{"name":"sensor","type":"SensorFormat"}], }, { name: ".lensModel()", type: "method", signature: "lensModel(model: LensModel): this", description: "", returns: "this", params: [{"name":"model","type":"LensModel"}], }, { name: ".lensBrand()", type: "method", signature: "lensBrand(brand: LensBrand): this", description: "", returns: "this", params: [{"name":"brand","type":"LensBrand"}], }, { name: ".focalLength()", type: "method", signature: "focalLength(length: string): this", description: "", returns: "this", params: [{"name":"length","type":"string"}], }, { name: ".bokeh()", type: "method", signature: "bokeh(style: BokehStyle): this", description: "", returns: "this", params: [{"name":"style","type":"BokehStyle"}], }, { name: ".filter()", type: "method", signature: "filter(filter: FilterType | FilterType[]): this", description: "", returns: "this", params: [{"name":"filter","type":"FilterType | FilterType[]"}], }, { name: ".iso()", type: "method", signature: "iso(iso: number): this", description: "", returns: "this", params: [{"name":"iso","type":"number"}], }, { name: ".shutterSpeed()", type: "method", signature: "shutterSpeed(speed: string): this", description: "", returns: "this", params: [{"name":"speed","type":"string"}], }, { name: ".whiteBalance()", type: "method", signature: "whiteBalance(wb: ImageCamera['whiteBalance']): this", description: "", returns: "this", params: [{"name":"wb","type":"ImageCamera['whiteBalance']"}], }, { name: ".colorProfile()", type: "method", signature: "colorProfile(profile: string): this", description: "", returns: "this", params: [{"name":"profile","type":"string"}], }, { name: ".lighting()", type: "method", signature: "lighting(settings: ImageLighting): this", description: "", returns: "this", params: [{"name":"settings","type":"ImageLighting"}], }, { name: ".lightingType()", type: "method", signature: "lightingType(type: LightingType | LightingType[]): this", description: "", returns: "this", params: [{"name":"type","type":"LightingType | LightingType[]"}], }, { name: ".timeOfDay()", type: "method", signature: "timeOfDay(time: TimeOfDay): this", description: "", returns: "this", params: [{"name":"time","type":"TimeOfDay"}], }, { name: ".weather()", type: "method", signature: "weather(weather: WeatherLighting): this", description: "", returns: "this", params: [{"name":"weather","type":"WeatherLighting"}], }, { name: ".lightDirection()", type: "method", signature: "lightDirection(direction: ImageLighting['direction']): this", description: "", returns: "this", params: [{"name":"direction","type":"ImageLighting['direction']"}], }, { name: ".lightIntensity()", type: "method", signature: "lightIntensity(intensity: ImageLighting['intensity']): this", description: "", returns: "this", params: [{"name":"intensity","type":"ImageLighting['intensity']"}], }, { name: ".composition()", type: "method", signature: "composition(settings: ImageComposition): this", description: "", returns: "this", params: [{"name":"settings","type":"ImageComposition"}], }, { name: ".ruleOfThirds()", type: "method", signature: "ruleOfThirds(): this", description: "", returns: "this", params: [], }, { name: ".goldenRatio()", type: "method", signature: "goldenRatio(): this", description: "", returns: "this", params: [], }, { name: ".symmetry()", type: "method", signature: "symmetry(type: ImageComposition['symmetry']): this", description: "", returns: "this", params: [{"name":"type","type":"ImageComposition['symmetry']"}], }, { name: ".foreground()", type: "method", signature: "foreground(fg: string): this", description: "", returns: "this", params: [{"name":"fg","type":"string"}], }, { name: ".midground()", type: "method", signature: "midground(mg: string): this", description: "", returns: "this", params: [{"name":"mg","type":"string"}], }, { name: ".background()", type: "method", signature: "background(bg: string): this", description: "", returns: "this", params: [{"name":"bg","type":"string"}], }, { name: ".environment()", type: "method", signature: "environment(setting: string | ImageEnvironment): this", description: "", returns: "this", params: [{"name":"setting","type":"string | ImageEnvironment"}], }, { name: ".location()", type: "method", signature: "location(location: string): this", description: "", returns: "this", params: [{"name":"location","type":"string"}], }, { name: ".props()", type: "method", signature: "props(props: string[]): this", description: "", returns: "this", params: [{"name":"props","type":"string[]"}], }, { name: ".atmosphere()", type: "method", signature: "atmosphere(atmosphere: string): this", description: "", returns: "this", params: [{"name":"atmosphere","type":"string"}], }, { name: ".season()", type: "method", signature: "season(season: ImageEnvironment['season']): this", description: "", returns: "this", params: [{"name":"season","type":"ImageEnvironment['season']"}], }, { name: ".style()", type: "method", signature: "style(settings: ImageStyle): this", description: "", returns: "this", params: [{"name":"settings","type":"ImageStyle"}], }, { name: ".medium()", type: "method", signature: "medium(medium: ArtStyle | ArtStyle[]): this", description: "", returns: "this", params: [{"name":"medium","type":"ArtStyle | ArtStyle[]"}], }, { name: ".artist()", type: "method", signature: "artist(artist: string | string[]): this", description: "", returns: "this", params: [{"name":"artist","type":"string | string[]"}], }, { name: ".influence()", type: "method", signature: "influence(influences: string[]): this", description: "", returns: "this", params: [{"name":"influences","type":"string[]"}], }, { name: ".color()", type: "method", signature: "color(settings: ImageColor): this", description: "", returns: "this", params: [{"name":"settings","type":"ImageColor"}], }, { name: ".palette()", type: "method", signature: "palette(palette: ColorPalette | ColorPalette[]): this", description: "", returns: "this", params: [{"name":"palette","type":"ColorPalette | ColorPalette[]"}], }, { name: ".primaryColors()", type: "method", signature: "primaryColors(colors: string[]): this", description: "", returns: "this", params: [{"name":"colors","type":"string[]"}], }, { name: ".accentColors()", type: "method", signature: "accentColors(colors: string[]): this", description: "", returns: "this", params: [{"name":"colors","type":"string[]"}], }, { name: ".colorGrade()", type: "method", signature: "colorGrade(grade: string): this", description: "", returns: "this", params: [{"name":"grade","type":"string"}], }, { name: ".technical()", type: "method", signature: "technical(settings: ImageTechnical): this", description: "", returns: "this", params: [{"name":"settings","type":"ImageTechnical"}], }, { name: ".aspectRatio()", type: "method", signature: "aspectRatio(ratio: AspectRatio): this", description: "", returns: "this", params: [{"name":"ratio","type":"AspectRatio"}], }, { name: ".resolution()", type: "method", signature: "resolution(resolution: string): this", description: "", returns: "this", params: [{"name":"resolution","type":"string"}], }, { name: ".quality()", type: "method", signature: "quality(quality: ImageTechnical['quality']): this", description: "", returns: "this", params: [{"name":"quality","type":"ImageTechnical['quality']"}], }, { name: ".mood()", type: "method", signature: "mood(mood: Mood | Mood[]): this", description: "", returns: "this", params: [{"name":"mood","type":"Mood | Mood[]"}], }, { name: ".negative()", type: "method", signature: "negative(items: string[]): this", description: "", returns: "this", params: [{"name":"items","type":"string[]"}], }, { name: ".custom()", type: "method", signature: "custom(text: string): this", description: "", returns: "this", params: [{"name":"text","type":"string"}], }, { name: ".build()", type: "method", signature: "build(): BuiltImagePrompt", description: "", returns: "BuiltImagePrompt", params: [], }, { name: ".toString()", type: "method", signature: "toString(): string", description: "", returns: "string", params: [], }, { name: ".toJSON()", type: "method", signature: "toJSON(): string", description: "", returns: "string", params: [], }, { name: ".toYAML()", type: "method", signature: "toYAML(): string", description: "", returns: "string", params: [], }, { name: ".toMarkdown()", type: "method", signature: "toMarkdown(): string", description: "", returns: "string", params: [], }, { name: ".format()", type: "method", signature: "format(fmt: OutputFormat): string", description: "", returns: "string", params: [{"name":"fmt","type":"OutputFormat"}], }, { name: "ImageSubject", type: "interface", description: "", }, { name: "ImageCamera", type: "interface", description: "", }, { name: "ImageLighting", type: "interface", description: "", }, { name: "ImageComposition", type: "interface", description: "", }, { name: "ImageStyle", type: "interface", description: "", }, { name: "ImageColor", type: "interface", description: "", }, { name: "ImageEnvironment", type: "interface", description: "", }, { name: "ImageTechnical", type: "interface", description: "", }, { name: "BuiltImagePrompt", type: "interface", description: "", }, { name: "OutputFormat", type: "type", signature: "type OutputFormat = 'text' | 'json' | 'yaml' | 'markdown'", description: "Media Prompt Builders - The D3.js of Prompt Building\n\nComprehensive, structured builders for Image, Video, and Audio generation prompts.\nEvery attribute a professional would consider is available as a chainable method.", }, { name: "CameraBrand", type: "type", signature: "type CameraBrand = | 'sony' | 'canon' | 'nikon' | 'fujifilm' | 'leica' | 'hasselblad' | 'phase-one'\n | 'panasonic' | 'olympus' | 'pentax' | 'red' | 'arri' | 'blackmagic' | 'panavision'", description: "", }, { name: "CameraModel", type: "type", signature: "type CameraModel = | 'sony-a7iv' | 'sony-a7riv' | 'sony-a7siii' | 'sony-a1' | 'sony-fx3' | 'sony-fx6'\n | 'sony-venice' | 'sony-venice-2' | 'sony-a9ii' | 'sony-zv-e1'\n // Canon\n | 'canon-r5' | 'canon-r6' | 'canon-r3' | 'canon-r8' | 'canon-c70' | 'canon-c300-iii'\n | 'canon-c500-ii' | 'canon-5d-iv' | 'canon-1dx-iii' | 'canon-eos-r5c'\n // Nikon\n | 'nikon-z9' | 'nikon-z8' | 'nikon-z6-iii' | 'nikon-z7-ii' | 'nikon-d850' | 'nikon-d6'\n // Fujifilm\n | 'fujifilm-x-t5' | 'fujifilm-x-h2s' | 'fujifilm-x100vi' | 'fujifilm-gfx100s'\n | 'fujifilm-gfx100-ii' | 'fujifilm-x-pro3'\n // Leica\n | 'leica-m11' | 'leica-sl2' | 'leica-sl2-s' | 'leica-q3' | 'leica-m10-r'\n // Hasselblad\n | 'hasselblad-x2d' | 'hasselblad-907x' | 'hasselblad-h6d-100c'\n // Cinema Cameras\n | 'arri-alexa-35' | 'arri-alexa-mini-lf' | 'arri-alexa-65' | 'arri-amira'\n | 'red-v-raptor' | 'red-komodo' | 'red-gemini' | 'red-monstro'\n | 'blackmagic-ursa-mini-pro' | 'blackmagic-pocket-6k' | 'blackmagic-pocket-4k'\n | 'panavision-dxl2' | 'panavision-millennium-xl2'", description: "", }, { name: "SensorFormat", type: "type", signature: "type SensorFormat = | 'full-frame' | 'aps-c' | 'micro-four-thirds' | 'medium-format' | 'large-format'\n | 'super-35' | 'vista-vision' | 'imax' | '65mm' | '35mm-film' | '16mm-film' | '8mm-film'", description: "", }, { name: "FilmFormat", type: "type", signature: "type FilmFormat = | '35mm' | '120-medium-format' | '4x5-large-format' | '8x10-large-format'\n | '110-film' | 'instant-film' | 'super-8' | '16mm' | '65mm-imax'", description: "", }, { name: "CameraAngle", type: "type", signature: "type CameraAngle = | 'eye-level' | 'low-angle' | 'high-angle' | 'dutch-angle' | 'birds-eye' \n | 'worms-eye' | 'over-the-shoulder' | 'point-of-view' | 'aerial' | 'drone'\n | 'canted' | 'oblique' | 'hip-level' | 'knee-level' | 'ground-level'", description: "", }, { name: "ShotType", type: "type", signature: "type ShotType = | 'extreme-close-up' | 'close-up' | 'medium-close-up' | 'medium' | 'medium-wide'\n | 'wide' | 'extreme-wide' | 'establishing' | 'full-body' | 'portrait' | 'headshot'", description: "", }, { name: "LensType", type: "type", signature: "type LensType = | 'wide-angle' | 'ultra-wide' | 'standard' | 'telephoto' | 'macro' | 'fisheye'\n | '14mm' | '24mm' | '35mm' | '50mm' | '85mm' | '100mm' | '135mm' | '200mm' | '400mm'\n | '600mm' | '800mm' | 'tilt-shift' | 'anamorphic' | 'spherical' | 'prime' | 'zoom'", description: "", }, { name: "LensBrand", type: "type", signature: "type LensBrand = | 'zeiss' | 'leica' | 'canon' | 'nikon' | 'sony' | 'sigma' | 'tamron' | 'voigtlander'\n | 'fujifilm' | 'samyang' | 'rokinon' | 'tokina' | 'cooke' | 'arri' | 'panavision'\n | 'angenieux' | 'red' | 'atlas' | 'sirui'", description: "", }, { name: "LensModel", type: "type", signature: "type LensModel = | 'zeiss-otus-55' | 'zeiss-batis-85' | 'zeiss-milvus-35' | 'zeiss-supreme-prime'\n // Leica\n | 'leica-summilux-50' | 'leica-summicron-35' | 'leica-noctilux-50' | 'leica-apo-summicron'\n // Canon\n | 'canon-rf-50-1.2' | 'canon-rf-85-1.2' | 'canon-rf-28-70-f2' | 'canon-rf-100-500'\n // Sony\n | 'sony-gm-24-70' | 'sony-gm-70-200' | 'sony-gm-50-1.2' | 'sony-gm-85-1.4'\n // Sigma Art\n | 'sigma-art-35' | 'sigma-art-50' | 'sigma-art-85' | 'sigma-art-105-macro'\n // Cinema\n | 'cooke-s7i' | 'cooke-anamorphic' | 'arri-signature-prime' | 'arri-ultra-prime'\n | 'panavision-primo' | 'panavision-anamorphic' | 'atlas-orion-anamorphic'\n // Vintage\n | 'helios-44-2' | 'canon-fd-55' | 'minolta-rokkor-58' | 'pentax-takumar-50'", description: "", }, { name: "FocusType", type: "type", signature: "type FocusType = | 'shallow' | 'deep' | 'soft-focus' | 'tilt-shift' | 'rack-focus' | 'split-diopter'\n | 'zone-focus' | 'hyperfocal' | 'selective' | 'bokeh-heavy' | 'tack-sharp'", description: "", }, { name: "BokehStyle", type: "type", signature: "type BokehStyle = | 'smooth' | 'creamy' | 'swirly' | 'busy' | 'soap-bubble' | 'cat-eye' | 'oval-anamorphic'", description: "", }, { name: "FilterType", type: "type", signature: "type FilterType = | 'uv' | 'polarizer' | 'nd' | 'nd-graduated' | 'black-pro-mist' | 'white-pro-mist'\n | 'glimmer-glass' | 'classic-soft' | 'streak' | 'starburst' | 'diffusion'\n | 'infrared' | 'color-gel' | 'warming' | 'cooling' | 'vintage-look'", description: "", }, { name: "CameraMovement", type: "type", signature: "type CameraMovement = | 'static' | 'pan' | 'tilt' | 'dolly' | 'truck' | 'pedestal' | 'zoom' \n | 'handheld' | 'steadicam' | 'crane' | 'drone' | 'tracking' | 'arc' | 'whip-pan'\n | 'roll' | 'boom' | 'jib' | 'cable-cam' | 'motion-control' | 'snorricam'\n | 'dutch-roll' | 'vertigo-effect' | 'crash-zoom' | 'slow-push' | 'slow-pull'", description: "", }, { name: "CameraRig", type: "type", signature: "type CameraRig = | 'tripod' | 'monopod' | 'gimbal' | 'steadicam' | 'easyrig' | 'shoulder-rig'\n | 'slider' | 'dolly' | 'jib' | 'crane' | 'technocrane' | 'russian-arm'\n | 'cable-cam' | 'drone' | 'fpv-drone' | 'motion-control' | 'handheld'", description: "", }, { name: "GimbalModel", type: "type", signature: "type GimbalModel = | 'dji-ronin-4d' | 'dji-ronin-rs3-pro' | 'dji-ronin-rs4' | 'moza-air-2'\n | 'zhiyun-crane-3s' | 'freefly-movi-pro' | 'tilta-gravity-g2x'", description: "", }, { name: "LightingType", type: "type", signature: "type LightingType = | 'natural' | 'studio' | 'dramatic' | 'soft' | 'hard' | 'diffused'\n | 'key' | 'fill' | 'rim' | 'backlit' | 'silhouette' | 'rembrandt'\n | 'split' | 'butterfly' | 'loop' | 'broad' | 'short' | 'chiaroscuro'\n | 'high-key' | 'low-key' | 'three-point' | 'practical' | 'motivated'", description: "", }, { name: "TimeOfDay", type: "type", signature: "type TimeOfDay = | 'dawn' | 'sunrise' | 'golden-hour' | 'morning' | 'midday' | 'afternoon'\n | 'blue-hour' | 'sunset' | 'dusk' | 'twilight' | 'night' | 'midnight'", description: "", }, { name: "WeatherLighting", type: "type", signature: "type WeatherLighting = | 'sunny' | 'cloudy' | 'overcast' | 'foggy' | 'misty' | 'rainy' \n | 'stormy' | 'snowy' | 'hazy'", description: "", }, { name: "ArtStyle", type: "type", signature: "type ArtStyle = | 'photorealistic' | 'hyperrealistic' | 'cinematic' | 'documentary'\n | 'editorial' | 'fashion' | 'portrait' | 'landscape' | 'street'\n | 'fine-art' | 'conceptual' | 'surreal' | 'abstract' | 'minimalist'\n | 'maximalist' | 'vintage' | 'retro' | 'noir' | 'gothic' | 'romantic'\n | 'impressionist' | 'expressionist' | 'pop-art' | 'art-nouveau' | 'art-deco'\n | 'cyberpunk' | 'steampunk' | 'fantasy' | 'sci-fi' | 'anime' | 'manga'\n | 'comic-book' | 'illustration' | 'digital-art' | 'oil-painting' | 'watercolor'\n | 'sketch' | 'pencil-drawing' | 'charcoal' | 'pastel' | '3d-render'", description: "", }, { name: "FilmStock", type: "type", signature: "type FilmStock = | 'kodak-portra-160' | 'kodak-portra-400' | 'kodak-portra-800' \n | 'kodak-ektar-100' | 'kodak-gold-200' | 'kodak-ultramax-400' | 'kodak-colorplus-200'\n // Kodak Black & White\n | 'kodak-tri-x-400' | 'kodak-tmax-100' | 'kodak-tmax-400' | 'kodak-tmax-3200'\n // Kodak Slide\n | 'kodak-ektachrome-e100' | 'kodachrome-64' | 'kodachrome-200'\n // Kodak Cinema\n | 'kodak-vision3-50d' | 'kodak-vision3-200t' | 'kodak-vision3-250d' | 'kodak-vision3-500t'\n // Fujifilm\n | 'fujifilm-pro-400h' | 'fujifilm-superia-400' | 'fujifilm-c200'\n | 'fujifilm-velvia-50' | 'fujifilm-velvia-100' | 'fujifilm-provia-100f'\n | 'fujifilm-acros-100' | 'fujifilm-neopan-400' | 'fujifilm-eterna-500t'\n // Ilford\n | 'ilford-hp5-plus' | 'ilford-delta-100' | 'ilford-delta-400' | 'ilford-delta-3200'\n | 'ilford-fp4-plus' | 'ilford-pan-f-plus' | 'ilford-xp2-super'\n // CineStill\n | 'cinestill-50d' | 'cinestill-800t' | 'cinestill-400d' | 'cinestill-bwxx'\n // Lomography\n | 'lomography-100' | 'lomography-400' | 'lomography-800'\n | 'lomochrome-purple' | 'lomochrome-metropolis' | 'lomochrome-turquoise'\n // Instant\n | 'polaroid-sx-70' | 'polaroid-600' | 'polaroid-i-type' | 'polaroid-spectra'\n | 'instax-mini' | 'instax-wide' | 'instax-square'\n // Vintage/Discontinued\n | 'agfa-vista-400' | 'agfa-apx-100' | 'fomapan-100' | 'fomapan-400'\n | 'bergger-pancro-400' | 'jch-streetpan-400'", description: "", }, { name: "AspectRatio", type: "type", signature: "type AspectRatio = | '1:1' | '4:3' | '3:2' | '16:9' | '21:9' | '9:16' | '2:3' | '4:5' | '5:4'", description: "", }, { name: "ColorPalette", type: "type", signature: "type ColorPalette = | 'warm' | 'cool' | 'neutral' | 'vibrant' | 'muted' | 'pastel' | 'neon'\n | 'monochrome' | 'sepia' | 'desaturated' | 'high-contrast' | 'low-contrast'\n | 'earthy' | 'oceanic' | 'forest' | 'sunset' | 'midnight' | 'golden'", description: "", }, { name: "Mood", type: "type", signature: "type Mood = | 'serene' | 'peaceful' | 'melancholic' | 'dramatic' | 'tense' | 'mysterious'\n | 'romantic' | 'nostalgic' | 'hopeful' | 'joyful' | 'energetic' | 'chaotic'\n | 'ethereal' | 'dark' | 'light' | 'whimsical' | 'eerie' | 'epic' | 'intimate'", description: "", }, { name: "VideoTransition", type: "type", signature: "type VideoTransition = | 'cut' | 'fade' | 'dissolve' | 'wipe' | 'morph' | 'match-cut' | 'jump-cut'\n | 'cross-dissolve' | 'iris' | 'push' | 'slide'", description: "", }, { name: "VideoPacing", type: "type", signature: "type VideoPacing = | 'slow' | 'medium' | 'fast' | 'variable' | 'building' | 'frenetic' | 'contemplative'", description: "", }, { name: "MusicGenre", type: "type", signature: "type MusicGenre = | 'pop' | 'rock' | 'jazz' | 'classical' | 'electronic' | 'hip-hop' | 'r&b'\n | 'country' | 'folk' | 'blues' | 'metal' | 'punk' | 'indie' | 'alternative'\n | 'ambient' | 'lo-fi' | 'synthwave' | 'orchestral' | 'cinematic' | 'world'\n | 'latin' | 'reggae' | 'soul' | 'funk' | 'disco' | 'house' | 'techno' | 'edm'", description: "", }, { name: "Instrument", type: "type", signature: "type Instrument = | 'piano' | 'guitar' | 'acoustic-guitar' | 'electric-guitar' | 'bass' | 'drums'\n | 'violin' | 'cello' | 'viola' | 'flute' | 'saxophone' | 'trumpet' | 'trombone'\n | 'synthesizer' | 'organ' | 'harp' | 'percussion' | 'strings' | 'brass' | 'woodwinds'\n | 'choir' | 'vocals' | 'beatbox' | 'turntables' | 'harmonica' | 'banjo' | 'ukulele'", description: "", }, { name: "VocalStyle", type: "type", signature: "type VocalStyle = | 'male' | 'female' | 'duet' | 'choir' | 'a-cappella' | 'spoken-word' | 'rap'\n | 'falsetto' | 'belting' | 'whisper' | 'growl' | 'melodic' | 'harmonized'", description: "", }, { name: "Tempo", type: "type", signature: "type Tempo = | 'largo' | 'adagio' | 'andante' | 'moderato' | 'allegro' | 'vivace' | 'presto'\n | number", description: "", } ], }, { name: "Video Prompts", items: [ { name: "video()", type: "function", signature: "video(): VideoPromptBuilder", description: "Create a new video prompt builder", returns: "VideoPromptBuilder", params: [], }, { name: "VideoPromptBuilder", type: "class", description: "", }, { name: ".scene()", type: "method", signature: "scene(description: string | VideoScene): this", description: "", returns: "this", params: [{"name":"description","type":"string | VideoScene"}], }, { name: ".setting()", type: "method", signature: "setting(setting: string): this", description: "", returns: "this", params: [{"name":"setting","type":"string"}], }, { name: ".subject()", type: "method", signature: "subject(main: string | VideoSubject): this", description: "", returns: "this", params: [{"name":"main","type":"string | VideoSubject"}], }, { name: ".appearance()", type: "method", signature: "appearance(appearance: string): this", description: "", returns: "this", params: [{"name":"appearance","type":"string"}], }, { name: ".clothing()", type: "method", signature: "clothing(clothing: string): this", description: "", returns: "this", params: [{"name":"clothing","type":"string"}], }, { name: ".camera()", type: "method", signature: "camera(settings: VideoCamera): this", description: "", returns: "this", params: [{"name":"settings","type":"VideoCamera"}], }, { name: ".shot()", type: "method", signature: "shot(shot: ShotType): this", description: "", returns: "this", params: [{"name":"shot","type":"ShotType"}], }, { name: ".angle()", type: "method", signature: "angle(angle: CameraAngle): this", description: "", returns: "this", params: [{"name":"angle","type":"CameraAngle"}], }, { name: ".movement()", type: "method", signature: "movement(movement: CameraMovement): this", description: "", returns: "this", params: [{"name":"movement","type":"CameraMovement"}], }, { name: ".lens()", type: "method", signature: "lens(lens: LensType): this", description: "", returns: "this", params: [{"name":"lens","type":"LensType"}], }, { name: ".platform()", type: "method", signature: "platform(platform: VideoCamera['platform']): this", description: "", returns: "this", params: [{"name":"platform","type":"VideoCamera['platform']"}], }, { name: ".cameraSpeed()", type: "method", signature: "cameraSpeed(speed: VideoCamera['movementSpeed']): this", description: "", returns: "this", params: [{"name":"speed","type":"VideoCamera['movementSpeed']"}], }, { name: ".movementDirection()", type: "method", signature: "movementDirection(direction: VideoCamera['movementDirection']): this", description: "", returns: "this", params: [{"name":"direction","type":"VideoCamera['movementDirection']"}], }, { name: ".rig()", type: "method", signature: "rig(rig: CameraRig): this", description: "", returns: "this", params: [{"name":"rig","type":"CameraRig"}], }, { name: ".gimbal()", type: "method", signature: "gimbal(gimbal: GimbalModel): this", description: "", returns: "this", params: [{"name":"gimbal","type":"GimbalModel"}], }, { name: ".cameraBrand()", type: "method", signature: "cameraBrand(brand: CameraBrand): this", description: "", returns: "this", params: [{"name":"brand","type":"CameraBrand"}], }, { name: ".cameraModel()", type: "method", signature: "cameraModel(model: CameraModel): this", description: "", returns: "this", params: [{"name":"model","type":"CameraModel"}], }, { name: ".sensor()", type: "method", signature: "sensor(sensor: SensorFormat): this", description: "", returns: "this", params: [{"name":"sensor","type":"SensorFormat"}], }, { name: ".lensModel()", type: "method", signature: "lensModel(model: LensModel): this", description: "", returns: "this", params: [{"name":"model","type":"LensModel"}], }, { name: ".lensBrand()", type: "method", signature: "lensBrand(brand: LensBrand): this", description: "", returns: "this", params: [{"name":"brand","type":"LensBrand"}], }, { name: ".focalLength()", type: "method", signature: "focalLength(length: string): this", description: "", returns: "this", params: [{"name":"length","type":"string"}], }, { name: ".anamorphic()", type: "method", signature: "anamorphic(ratio?: VideoCamera['anamorphicRatio']): this", description: "", returns: "this", params: [{"name":"ratio","type":"VideoCamera['anamorphicRatio']"}], }, { name: ".aperture()", type: "method", signature: "aperture(aperture: string): this", description: "", returns: "this", params: [{"name":"aperture","type":"string"}], }, { name: ".frameRate()", type: "method", signature: "frameRate(fps: VideoCamera['frameRate']): this", description: "", returns: "this", params: [{"name":"fps","type":"VideoCamera['frameRate']"}], }, { name: ".slowMotion()", type: "method", signature: "slowMotion(enabled?: any): this", description: "", returns: "this", params: [{"name":"enabled","type":"any"}], }, { name: ".shutterAngle()", type: "method", signature: "shutterAngle(angle: number): this", description: "", returns: "this", params: [{"name":"angle","type":"number"}], }, { name: ".filter()", type: "method", signature: "filter(filter: FilterType | FilterType[]): this", description: "", returns: "this", params: [{"name":"filter","type":"FilterType | FilterType[]"}], }, { name: ".filmStock()", type: "method", signature: "filmStock(stock: FilmStock): this", description: "", returns: "this", params: [{"name":"stock","type":"FilmStock"}], }, { name: ".filmGrain()", type: "method", signature: "filmGrain(grain: VideoCamera['filmGrain']): this", description: "", returns: "this", params: [{"name":"grain","type":"VideoCamera['filmGrain']"}], }, { name: ".halation()", type: "method", signature: "halation(enabled?: any): this", description: "", returns: "this", params: [{"name":"enabled","type":"any"}], }, { name: ".lighting()", type: "method", signature: "lighting(settings: VideoLighting): this", description: "", returns: "this", params: [{"name":"settings","type":"VideoLighting"}], }, { name: ".lightingType()", type: "method", signature: "lightingType(type: LightingType | LightingType[]): this", description: "", returns: "this", params: [{"name":"type","type":"LightingType | LightingType[]"}], }, { name: ".timeOfDay()", type: "method", signature: "timeOfDay(time: TimeOfDay): this", description: "", returns: "this", params: [{"name":"time","type":"TimeOfDay"}], }, { name: ".weather()", type: "method", signature: "weather(weather: WeatherLighting): this", description: "", returns: "this", params: [{"name":"weather","type":"WeatherLighting"}], }, { name: ".action()", type: "method", signature: "action(action: string, options?: Partial>): this", description: "", returns: "this", params: [{"name":"action","type":"string"},{"name":"options","type":"Partial>"}], }, { name: ".actions()", type: "method", signature: "actions(actions: string[]): this", description: "", returns: "this", params: [{"name":"actions","type":"string[]"}], }, { name: ".motion()", type: "method", signature: "motion(settings: VideoMotion): this", description: "", returns: "this", params: [{"name":"settings","type":"VideoMotion"}], }, { name: ".motionBeats()", type: "method", signature: "motionBeats(beats: string[]): this", description: "", returns: "this", params: [{"name":"beats","type":"string[]"}], }, { name: ".style()", type: "method", signature: "style(settings: VideoStyle): this", description: "", returns: "this", params: [{"name":"settings","type":"VideoStyle"}], }, { name: ".format()", type: "method", signature: "format(format: string): this", description: "", returns: "this", params: [{"name":"format","type":"string"}], }, { name: ".era()", type: "method", signature: "era(era: string): this", description: "", returns: "this", params: [{"name":"era","type":"string"}], }, { name: ".styleFilmStock()", type: "method", signature: "styleFilmStock(stock: string): this", description: "", returns: "this", params: [{"name":"stock","type":"string"}], }, { name: ".look()", type: "method", signature: "look(look: ArtStyle | ArtStyle[]): this", description: "", returns: "this", params: [{"name":"look","type":"ArtStyle | ArtStyle[]"}], }, { name: ".reference()", type: "method", signature: "reference(references: string[]): this", description: "", returns: "this", params: [{"name":"references","type":"string[]"}], }, { name: ".color()", type: "method", signature: "color(settings: VideoColor): this", description: "", returns: "this", params: [{"name":"settings","type":"VideoColor"}], }, { name: ".palette()", type: "method", signature: "palette(palette: ColorPalette | ColorPalette[]): this", description: "", returns: "this", params: [{"name":"palette","type":"ColorPalette | ColorPalette[]"}], }, { name: ".colorAnchors()", type: "method", signature: "colorAnchors(anchors: string[]): this", description: "", returns: "this", params: [{"name":"anchors","type":"string[]"}], }, { name: ".colorGrade()", type: "method", signature: "colorGrade(grade: string): this", description: "", returns: "this", params: [{"name":"grade","type":"string"}], }, { name: ".audio()", type: "method", signature: "audio(settings: VideoAudio): this", description: "", returns: "this", params: [{"name":"settings","type":"VideoAudio"}], }, { name: ".dialogue()", type: "method", signature: "dialogue(dialogue: string): this", description: "", returns: "this", params: [{"name":"dialogue","type":"string"}], }, { name: ".ambient()", type: "method", signature: "ambient(ambient: string): this", description: "", returns: "this", params: [{"name":"ambient","type":"string"}], }, { name: ".diegetic()", type: "method", signature: "diegetic(sounds: string[]): this", description: "", returns: "this", params: [{"name":"sounds","type":"string[]"}], }, { name: ".soundEffects()", type: "method", signature: "soundEffects(effects: string[]): this", description: "", returns: "this", params: [{"name":"effects","type":"string[]"}], }, { name: ".music()", type: "method", signature: "music(music: string): this", description: "", returns: "this", params: [{"name":"music","type":"string"}], }, { name: ".technical()", type: "method", signature: "technical(settings: VideoTechnical): this", description: "", returns: "this", params: [{"name":"settings","type":"VideoTechnical"}], }, { name: ".duration()", type: "method", signature: "duration(seconds: number): this", description: "", returns: "this", params: [{"name":"seconds","type":"number"}], }, { name: ".resolution()", type: "method", signature: "resolution(res: VideoTechnical['resolution']): this", description: "", returns: "this", params: [{"name":"res","type":"VideoTechnical['resolution']"}], }, { name: ".fps()", type: "method", signature: "fps(fps: VideoTechnical['fps']): this", description: "", returns: "this", params: [{"name":"fps","type":"VideoTechnical['fps']"}], }, { name: ".aspectRatio()", type: "method", signature: "aspectRatio(ratio: VideoTechnical['aspectRatio']): this", description: "", returns: "this", params: [{"name":"ratio","type":"VideoTechnical['aspectRatio']"}], }, { name: ".addShot()", type: "method", signature: "addShot(shot: VideoShot): this", description: "", returns: "this", params: [{"name":"shot","type":"VideoShot"}], }, { name: ".shotList()", type: "method", signature: "shotList(shots: VideoShot[]): this", description: "", returns: "this", params: [{"name":"shots","type":"VideoShot[]"}], }, { name: ".mood()", type: "method", signature: "mood(mood: Mood | Mood[]): this", description: "", returns: "this", params: [{"name":"mood","type":"Mood | Mood[]"}], }, { name: ".pacing()", type: "method", signature: "pacing(pacing: VideoPacing): this", description: "", returns: "this", params: [{"name":"pacing","type":"VideoPacing"}], }, { name: ".transition()", type: "method", signature: "transition(transition: VideoTransition): this", description: "", returns: "this", params: [{"name":"transition","type":"VideoTransition"}], }, { name: ".transitions()", type: "method", signature: "transitions(transitions: VideoTransition[]): this", description: "", returns: "this", params: [{"name":"transitions","type":"VideoTransition[]"}], }, { name: ".custom()", type: "method", signature: "custom(text: string): this", description: "", returns: "this", params: [{"name":"text","type":"string"}], }, { name: ".build()", type: "method", signature: "build(): BuiltVideoPrompt", description: "", returns: "BuiltVideoPrompt", params: [], }, { name: ".toString()", type: "method", signature: "toString(): string", description: "", returns: "string", params: [], }, { name: ".toJSON()", type: "method", signature: "toJSON(): string", description: "", returns: "string", params: [], }, { name: ".toYAML()", type: "method", signature: "toYAML(): string", description: "", returns: "string", params: [], }, { name: ".toMarkdown()", type: "method", signature: "toMarkdown(): string", description: "", returns: "string", params: [], }, { name: ".outputFormat()", type: "method", signature: "outputFormat(fmt: OutputFormat): string", description: "", returns: "string", params: [{"name":"fmt","type":"OutputFormat"}], }, { name: "VideoScene", type: "interface", description: "", }, { name: "VideoSubject", type: "interface", description: "", }, { name: "VideoCamera", type: "interface", description: "", }, { name: "VideoLighting", type: "interface", description: "", }, { name: "VideoAction", type: "interface", description: "", }, { name: "VideoMotion", type: "interface", description: "", }, { name: "VideoStyle", type: "interface", description: "", }, { name: "VideoColor", type: "interface", description: "", }, { name: "VideoAudio", type: "interface", description: "", }, { name: "VideoTechnical", type: "interface", description: "", }, { name: "VideoShot", type: "interface", description: "", }, { name: "BuiltVideoPrompt", type: "interface", description: "", } ], }, { name: "Audio Prompts", items: [ { name: "audio()", type: "function", signature: "audio(): AudioPromptBuilder", description: "Create a new audio/music prompt builder", returns: "AudioPromptBuilder", params: [], }, { name: "AudioPromptBuilder", type: "class", description: "", }, { name: ".genre()", type: "method", signature: "genre(primary: MusicGenre | AudioGenre): this", description: "", returns: "this", params: [{"name":"primary","type":"MusicGenre | AudioGenre"}], }, { name: ".subgenre()", type: "method", signature: "subgenre(subgenre: string): this", description: "", returns: "this", params: [{"name":"subgenre","type":"string"}], }, { name: ".fusion()", type: "method", signature: "fusion(genres: MusicGenre[]): this", description: "", returns: "this", params: [{"name":"genres","type":"MusicGenre[]"}], }, { name: ".mood()", type: "method", signature: "mood(primary: Mood | string, ...secondary: (Mood | string)[]): this", description: "", returns: "this", params: [{"name":"primary","type":"Mood | string"},{"name":"secondary","type":"(Mood | string)[]"}], }, { name: ".energy()", type: "method", signature: "energy(level: AudioMood['energy']): this", description: "", returns: "this", params: [{"name":"level","type":"AudioMood['energy']"}], }, { name: ".emotion()", type: "method", signature: "emotion(emotion: string): this", description: "", returns: "this", params: [{"name":"emotion","type":"string"}], }, { name: ".tempo()", type: "method", signature: "tempo(bpmOrSettings: number | AudioTempo): this", description: "", returns: "this", params: [{"name":"bpmOrSettings","type":"number | AudioTempo"}], }, { name: ".bpm()", type: "method", signature: "bpm(bpm: number): this", description: "", returns: "this", params: [{"name":"bpm","type":"number"}], }, { name: ".tempoMarking()", type: "method", signature: "tempoMarking(marking: TempoMarking): this", description: "", returns: "this", params: [{"name":"marking","type":"TempoMarking"}], }, { name: ".tempoFeel()", type: "method", signature: "tempoFeel(feel: AudioTempo['feel']): this", description: "", returns: "this", params: [{"name":"feel","type":"AudioTempo['feel']"}], }, { name: ".vocals()", type: "method", signature: "vocals(settings: AudioVocals): this", description: "", returns: "this", params: [{"name":"settings","type":"AudioVocals"}], }, { name: ".vocalStyle()", type: "method", signature: "vocalStyle(style: VocalStyle | VocalStyle[]): this", description: "", returns: "this", params: [{"name":"style","type":"VocalStyle | VocalStyle[]"}], }, { name: ".language()", type: "method", signature: "language(language: VocalLanguage): this", description: "", returns: "this", params: [{"name":"language","type":"VocalLanguage"}], }, { name: ".lyrics()", type: "method", signature: "lyrics(lyrics: string): this", description: "", returns: "this", params: [{"name":"lyrics","type":"string"}], }, { name: ".lyricsTheme()", type: "method", signature: "lyricsTheme(theme: string): this", description: "", returns: "this", params: [{"name":"theme","type":"string"}], }, { name: ".delivery()", type: "method", signature: "delivery(delivery: string): this", description: "", returns: "this", params: [{"name":"delivery","type":"string"}], }, { name: ".instrumental()", type: "method", signature: "instrumental(): this", description: "", returns: "this", params: [], }, { name: ".instruments()", type: "method", signature: "instruments(instruments: Instrument[]): this", description: "", returns: "this", params: [{"name":"instruments","type":"Instrument[]"}], }, { name: ".instrumentation()", type: "method", signature: "instrumentation(settings: AudioInstrumentation): this", description: "", returns: "this", params: [{"name":"settings","type":"AudioInstrumentation"}], }, { name: ".leadInstrument()", type: "method", signature: "leadInstrument(instrument: Instrument | Instrument[]): this", description: "", returns: "this", params: [{"name":"instrument","type":"Instrument | Instrument[]"}], }, { name: ".rhythmSection()", type: "method", signature: "rhythmSection(instruments: Instrument[]): this", description: "", returns: "this", params: [{"name":"instruments","type":"Instrument[]"}], }, { name: ".bassInstrument()", type: "method", signature: "bassInstrument(instrument: Instrument): this", description: "", returns: "this", params: [{"name":"instrument","type":"Instrument"}], }, { name: ".percussion()", type: "method", signature: "percussion(instruments: Instrument | Instrument[]): this", description: "", returns: "this", params: [{"name":"instruments","type":"Instrument | Instrument[]"}], }, { name: ".pads()", type: "method", signature: "pads(instruments: Instrument | Instrument[]): this", description: "", returns: "this", params: [{"name":"instruments","type":"Instrument | Instrument[]"}], }, { name: ".featuredInstrument()", type: "method", signature: "featuredInstrument(instrument: Instrument): this", description: "", returns: "this", params: [{"name":"instrument","type":"Instrument"}], }, { name: ".structure()", type: "method", signature: "structure(settings: AudioStructure | { [key in SongSection]?: number }): this", description: "", returns: "this", params: [{"name":"settings","type":"AudioStructure | { [key in SongSection]?: number }"}], }, { name: ".section()", type: "method", signature: "section(type: SongSection, bars?: number, description?: string): this", description: "", returns: "this", params: [{"name":"type","type":"SongSection"},{"name":"bars","type":"number"},{"name":"description","type":"string"}], }, { name: ".form()", type: "method", signature: "form(form: string): this", description: "", returns: "this", params: [{"name":"form","type":"string"}], }, { name: ".duration()", type: "method", signature: "duration(seconds: number): this", description: "", returns: "this", params: [{"name":"seconds","type":"number"}], }, { name: ".production()", type: "method", signature: "production(settings: AudioProduction): this", description: "", returns: "this", params: [{"name":"settings","type":"AudioProduction"}], }, { name: ".productionStyle()", type: "method", signature: "productionStyle(style: ProductionStyle | ProductionStyle[]): this", description: "", returns: "this", params: [{"name":"style","type":"ProductionStyle | ProductionStyle[]"}], }, { name: ".era()", type: "method", signature: "era(era: Era): this", description: "", returns: "this", params: [{"name":"era","type":"Era"}], }, { name: ".reference()", type: "method", signature: "reference(artists: string[]): this", description: "", returns: "this", params: [{"name":"artists","type":"string[]"}], }, { name: ".texture()", type: "method", signature: "texture(texture: string): this", description: "", returns: "this", params: [{"name":"texture","type":"string"}], }, { name: ".effects()", type: "method", signature: "effects(effects: string[]): this", description: "", returns: "this", params: [{"name":"effects","type":"string[]"}], }, { name: ".technical()", type: "method", signature: "technical(settings: AudioTechnical): this", description: "", returns: "this", params: [{"name":"settings","type":"AudioTechnical"}], }, { name: ".key()", type: "method", signature: "key(key: MusicalKey): this", description: "", returns: "this", params: [{"name":"key","type":"MusicalKey"}], }, { name: ".timeSignature()", type: "method", signature: "timeSignature(sig: TimeSignature): this", description: "", returns: "this", params: [{"name":"sig","type":"TimeSignature"}], }, { name: ".formatType()", type: "method", signature: "formatType(format: AudioTechnical['format']): this", description: "", returns: "this", params: [{"name":"format","type":"AudioTechnical['format']"}], }, { name: ".tag()", type: "method", signature: "tag(tag: string): this", description: "", returns: "this", params: [{"name":"tag","type":"string"}], }, { name: ".tags()", type: "method", signature: "tags(tags: string[]): this", description: "", returns: "this", params: [{"name":"tags","type":"string[]"}], }, { name: ".custom()", type: "method", signature: "custom(text: string): this", description: "", returns: "this", params: [{"name":"text","type":"string"}], }, { name: ".build()", type: "method", signature: "build(): BuiltAudioPrompt", description: "", returns: "BuiltAudioPrompt", params: [], }, { name: ".toString()", type: "method", signature: "toString(): string", description: "", returns: "string", params: [], }, { name: ".toStyleString()", type: "method", signature: "toStyleString(): string", description: "", returns: "string", params: [], }, { name: ".toJSON()", type: "method", signature: "toJSON(): string", description: "", returns: "string", params: [], }, { name: ".toYAML()", type: "method", signature: "toYAML(): string", description: "", returns: "string", params: [], }, { name: ".toMarkdown()", type: "method", signature: "toMarkdown(): string", description: "", returns: "string", params: [], }, { name: ".outputFormat()", type: "method", signature: "outputFormat(fmt: OutputFormat): string", description: "", returns: "string", params: [{"name":"fmt","type":"OutputFormat"}], }, { name: "AudioGenre", type: "interface", description: "", }, { name: "AudioMood", type: "interface", description: "", }, { name: "AudioTempo", type: "interface", description: "", }, { name: "AudioVocals", type: "interface", description: "", }, { name: "AudioInstrumentation", type: "interface", description: "", }, { name: "AudioStructure", type: "interface", description: "", }, { name: "AudioProduction", type: "interface", description: "", }, { name: "AudioTechnical", type: "interface", description: "", }, { name: "BuiltAudioPrompt", type: "interface", description: "", }, { name: "MusicGenre", type: "type", signature: "type MusicGenre = | 'pop' | 'rock' | 'jazz' | 'classical' | 'electronic' | 'hip-hop' | 'r&b'\n | 'country' | 'folk' | 'blues' | 'metal' | 'punk' | 'indie' | 'alternative'\n | 'ambient' | 'lo-fi' | 'synthwave' | 'orchestral' | 'cinematic' | 'world'\n | 'latin' | 'reggae' | 'soul' | 'funk' | 'disco' | 'house' | 'techno' | 'edm'\n | 'trap' | 'drill' | 'k-pop' | 'j-pop' | 'bossa-nova' | 'gospel' | 'grunge'\n | 'shoegaze' | 'post-rock' | 'prog-rock' | 'psychedelic' | 'chillwave'\n | 'vaporwave' | 'drum-and-bass' | 'dubstep' | 'trance' | 'hardcore'", description: "", }, { name: "Instrument", type: "type", signature: "type Instrument = | 'piano' | 'guitar' | 'acoustic-guitar' | 'electric-guitar' | 'bass' | 'drums'\n | 'violin' | 'cello' | 'viola' | 'flute' | 'saxophone' | 'trumpet' | 'trombone'\n | 'synthesizer' | 'organ' | 'harp' | 'percussion' | 'strings' | 'brass' | 'woodwinds'\n | 'choir' | 'vocals' | 'beatbox' | 'turntables' | 'harmonica' | 'banjo' | 'ukulele'\n | 'mandolin' | 'accordion' | 'marimba' | 'vibraphone' | 'xylophone' | 'timpani'\n | 'congas' | 'bongos' | 'djembe' | 'tabla' | 'sitar' | 'erhu' | 'koto'\n | '808' | '909' | 'moog' | 'rhodes' | 'wurlitzer' | 'mellotron' | 'theremin'", description: "", }, { name: "VocalStyle", type: "type", signature: "type VocalStyle = | 'male' | 'female' | 'duet' | 'choir' | 'a-cappella' | 'spoken-word' | 'rap'\n | 'falsetto' | 'belting' | 'whisper' | 'growl' | 'melodic' | 'harmonized'\n | 'auto-tuned' | 'operatic' | 'soul' | 'breathy' | 'nasal' | 'raspy' | 'clear'", description: "", }, { name: "VocalLanguage", type: "type", signature: "type VocalLanguage = | 'english' | 'spanish' | 'french' | 'german' | 'italian' | 'portuguese'\n | 'japanese' | 'korean' | 'chinese' | 'arabic' | 'hindi' | 'russian' | 'turkish'\n | 'instrumental'", description: "", }, { name: "TempoMarking", type: "type", signature: "type TempoMarking = | 'largo' | 'adagio' | 'andante' | 'moderato' | 'allegro' | 'vivace' | 'presto'", description: "", }, { name: "TimeSignature", type: "type", signature: "type TimeSignature = '4/4' | '3/4' | '6/8' | '2/4' | '5/4' | '7/8' | '12/8'", description: "", }, { name: "MusicalKey", type: "type", signature: "type MusicalKey = | 'C' | 'C#' | 'Db' | 'D' | 'D#' | 'Eb' | 'E' | 'F' | 'F#' | 'Gb' \n | 'G' | 'G#' | 'Ab' | 'A' | 'A#' | 'Bb' | 'B'\n | 'Cm' | 'C#m' | 'Dm' | 'D#m' | 'Ebm' | 'Em' | 'Fm' | 'F#m' \n | 'Gm' | 'G#m' | 'Am' | 'A#m' | 'Bbm' | 'Bm'", description: "", }, { name: "SongSection", type: "type", signature: "type SongSection = | 'intro' | 'verse' | 'pre-chorus' | 'chorus' | 'bridge' | 'breakdown'\n | 'drop' | 'build-up' | 'outro' | 'solo' | 'interlude' | 'hook'", description: "", }, { name: "ProductionStyle", type: "type", signature: "type ProductionStyle = | 'lo-fi' | 'hi-fi' | 'vintage' | 'modern' | 'polished' | 'raw' | 'organic'\n | 'synthetic' | 'acoustic' | 'electric' | 'hybrid' | 'minimalist' | 'maximalist'\n | 'layered' | 'sparse' | 'dense' | 'atmospheric' | 'punchy' | 'warm' | 'bright'", description: "", }, { name: "Era", type: "type", signature: "type Era = | '1950s' | '1960s' | '1970s' | '1980s' | '1990s' | '2000s' | '2010s' | '2020s'\n | 'retro' | 'vintage' | 'classic' | 'modern' | 'futuristic'", description: "", } ], }, { name: "Variables", items: [ { name: "detectVariables()", type: "function", signature: "detectVariables(text: string): DetectedVariable[]", description: "Detect variable-like patterns in text\nReturns detected variables that are NOT in our supported format", returns: "DetectedVariable[]", params: [{"name":"text","type":"string"}], }, { name: "convertToSupportedFormat()", type: "function", signature: "convertToSupportedFormat(variable: DetectedVariable): string", description: "Convert a detected variable to our supported format", returns: "string", params: [{"name":"variable","type":"DetectedVariable"}], }, { name: "convertAllVariables()", type: "function", signature: "convertAllVariables(text: string): string", description: "Convert all detected variables in text to our supported format", returns: "string", params: [{"name":"text","type":"string"}], }, { name: "getPatternDescription()", type: "function", signature: "getPatternDescription(pattern: VariablePattern): string", description: "Get a human-readable pattern description", returns: "string", params: [{"name":"pattern","type":"VariablePattern"}], }, { name: "extractVariables()", type: "function", signature: "extractVariables(text: string): Array<{ name: string; defaultValue?: string }>", description: "Extract variables from our supported ${var} or ${var:default} format", returns: "Array<{ name: string; defaultValue?: string }>", params: [{"name":"text","type":"string"}], }, { name: "compile()", type: "function", signature: "compile(template: string, values: Record, options?: { useDefaults?: boolean }): string", description: "Compile a prompt template with variable values", returns: "string", params: [{"name":"template","type":"string"},{"name":"values","type":"Record"},{"name":"options","type":"{ useDefaults?: boolean }"}], }, { name: "DetectedVariable", type: "interface", description: "Variable Detection Utility\nDetects common variable-like patterns in text that could be converted\nto our supported format: ${variableName} or ${variableName:default}", }, { name: "VariablePattern", type: "type", signature: "type VariablePattern = | \"double_bracket\" // [[name]] or [[ name ]]\n | \"double_curly\" // {{name}} or {{ name }}\n | \"single_bracket\" // [NAME] or [name]\n | \"single_curly\" // {NAME} or {name}\n | \"angle_bracket\" // or \n | \"percent\" // %NAME% or %name%\n | \"dollar_curly\"", description: "", }, { name: "normalize", type: "const", signature: "normalize = convertAllVariables", description: "Alias for convertAllVariables - normalizes all variable formats to ${var}", }, { name: "detect", type: "const", signature: "detect = detectVariables", description: "Alias for detectVariables", } ], }, { name: "Similarity", items: [ { name: "normalizeContent()", type: "function", signature: "normalizeContent(content: string): string", description: "Content similarity utilities for duplicate detection", returns: "string", params: [{"name":"content","type":"string"}], }, { name: "calculateSimilarity()", type: "function", signature: "calculateSimilarity(content1: string, content2: string): number", description: "Combined similarity score using multiple algorithms\nReturns a value between 0 (completely different) and 1 (identical)", returns: "number", params: [{"name":"content1","type":"string"},{"name":"content2","type":"string"}], }, { name: "isSimilarContent()", type: "function", signature: "isSimilarContent(content1: string, content2: string, threshold?: number): boolean", description: "Check if two contents are similar enough to be considered duplicates\nDefault threshold is 0.85 (85% similar)", returns: "boolean", params: [{"name":"content1","type":"string"},{"name":"content2","type":"string"},{"name":"threshold","type":"number"}], }, { name: "getContentFingerprint()", type: "function", signature: "getContentFingerprint(content: string): string", description: "Get normalized content hash for database indexing/comparison\nThis is a simple hash for quick lookups before full similarity check", returns: "string", params: [{"name":"content","type":"string"}], }, { name: "findDuplicates()", type: "function", signature: "findDuplicates(prompts: T[], threshold?: number): T[][]", description: "Find duplicates in an array of prompts\nReturns groups of similar prompts", returns: "T[][]", params: [{"name":"prompts","type":"T[]"},{"name":"threshold","type":"number"}], }, { name: "deduplicate()", type: "function", signature: "deduplicate(prompts: T[], threshold?: number): T[]", description: "Deduplicate an array of prompts, keeping the first occurrence", returns: "T[]", params: [{"name":"prompts","type":"T[]"},{"name":"threshold","type":"number"}], }, { name: "calculate", type: "const", signature: "calculate = calculateSimilarity", description: "Alias for calculateSimilarity", }, { name: "isDuplicate", type: "const", signature: "isDuplicate = isSimilarContent", description: "Alias for isSimilarContent", } ], }, { name: "Quality", items: [ { name: "check()", type: "function", signature: "check(prompt: string): QualityResult", description: "Check prompt quality locally (no API needed)", returns: "QualityResult", params: [{"name":"prompt","type":"string"}], }, { name: "validate()", type: "function", signature: "validate(prompt: string): void", description: "Validate a prompt and throw if invalid", returns: "void", params: [{"name":"prompt","type":"string"}], }, { name: "isValid()", type: "function", signature: "isValid(prompt: string): boolean", description: "Check if a prompt is valid", returns: "boolean", params: [{"name":"prompt","type":"string"}], }, { name: "getSuggestions()", type: "function", signature: "getSuggestions(prompt: string): string[]", description: "Get suggestions for improving a prompt", returns: "string[]", params: [{"name":"prompt","type":"string"}], }, { name: "QualityIssue", type: "interface", description: "Prompt Quality Checker - Local validation for prompt quality", }, { name: "QualityResult", type: "interface", description: "", } ], }, { name: "Parser", items: [ { name: "parse()", type: "function", signature: "parse(content: string, format?: 'yaml' | 'json' | 'markdown' | 'text'): ParsedPrompt", description: "Parse prompt content in various formats", returns: "ParsedPrompt", params: [{"name":"content","type":"string"},{"name":"format","type":"'yaml' | 'json' | 'markdown' | 'text'"}], }, { name: "toYaml()", type: "function", signature: "toYaml(prompt: ParsedPrompt): string", description: "Serialize a ParsedPrompt to YAML format", returns: "string", params: [{"name":"prompt","type":"ParsedPrompt"}], }, { name: "toJson()", type: "function", signature: "toJson(prompt: ParsedPrompt, pretty?: boolean): string", description: "Serialize a ParsedPrompt to JSON format", returns: "string", params: [{"name":"prompt","type":"ParsedPrompt"},{"name":"pretty","type":"boolean"}], }, { name: "getSystemPrompt()", type: "function", signature: "getSystemPrompt(prompt: ParsedPrompt): string", description: "Get the system message content from a parsed prompt", returns: "string", params: [{"name":"prompt","type":"ParsedPrompt"}], }, { name: "interpolate()", type: "function", signature: "interpolate(prompt: ParsedPrompt, values: Record): ParsedPrompt", description: "Interpolate variables in a prompt", returns: "ParsedPrompt", params: [{"name":"prompt","type":"ParsedPrompt"},{"name":"values","type":"Record"}], }, { name: "PromptMessage", type: "interface", description: "Prompt Parser - Parse and load prompt files in various formats\n\nSupports:\n- .prompt.yml / .prompt.yaml (YAML format)\n- .prompt.json (JSON format)\n- .prompt.md (Markdown with frontmatter)\n- .txt (Plain text)", }, { name: "ParsedPrompt", type: "interface", description: "", } ], }, ];