Repository navigation
feat(ppt): Add Types and Validation for PPT generation #784
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| import type { ImageWithAltText } from "./content.js"; | ||
|
|
||
| type ThemeOption = "modern" | "corporate" | "creative" | "minimal" | "dark"; | ||
|
|
||
| type AudienceOption = "business" | "students" | "technical" | "general"; | ||
|
|
||
| type ToneOption = "professional" | "casual" | "educational" | "persuasive"; | ||
|
|
||
| type OutputFormatOption = "pptx"; | ||
|
|
||
| type AspectRatioOption = "16:9" | "4:3"; | ||
|
|
||
| export type PPTOutputOptions = { | ||
| /** Number of slides to generate (required, range: 5-50) */ | ||
| pages: number; | ||
| /** Output format - only PPTX supported currently (default: "pptx") */ | ||
| format?: OutputFormatOption; | ||
| /** Presentation theme/style (default: "modern") */ | ||
| theme?: ThemeOption; | ||
| /** Target audience for content customization */ | ||
| audience?: AudienceOption; | ||
| /** Presentation tone/style */ | ||
| tone?: ToneOption; | ||
| /** Whether to generate AI images for slides (default: true) */ | ||
| includeImages?: boolean; | ||
| /** Custom output file path (default: auto-generated in ./output/) */ | ||
| outputPath?: string; | ||
| /** Aspect ratio for slides (default: "16:9") */ | ||
| aspectRatio?: AspectRatioOption; | ||
| /** Path to logo image to include in slides */ | ||
| logoPath?: Buffer | string | ImageWithAltText; | ||
| }; | ||
|
Tafheem-Ahemad-Juspay marked this conversation as resolved.
|
||
| /** | ||
| * Result type for generated presentation content | ||
| * | ||
| * Returned in `GenerateResult.ppt` when presentation generation is successful. | ||
| * Contains the file path and metadata about the generated presentation. | ||
| * | ||
| * @example | ||
| * ```typescript | ||
| * const result = await neurolink.generate({ | ||
| * input: { text: "Introducing Our New Product" }, | ||
| * provider: "vertex", | ||
| * output: { mode: "ppt", ppt: { pages: 10, theme: "modern" } } | ||
| * }); | ||
| * | ||
| * if (result.ppt) { | ||
| * console.log(`Presentation saved: ${result.ppt.filePath}`); | ||
| * console.log(`Total slides: ${result.ppt.totalSlides}`); | ||
| * console.log(`Theme: ${result.ppt.metadata?.theme}`); | ||
| * } | ||
| * ``` | ||
| */ | ||
| export type PPTGenerationResult = { | ||
| /** Path to the generated PPTX file */ | ||
| filePath: string; | ||
| /** Total number of slides in the presentation */ | ||
| totalSlides: number; | ||
| /** Output format (always "pptx" currently) */ | ||
| format: OutputFormatOption; | ||
| /** Presentation metadata */ | ||
| metadata?: { | ||
| /** Theme/style used */ | ||
| theme?: string; | ||
| /** Target audience */ | ||
| audience?: string; | ||
| /** Presentation tone */ | ||
| tone?: string; | ||
| /** Model used for image generation */ | ||
| imageModel?: string; | ||
| /** File size in bytes */ | ||
| fileSize?: number; | ||
| }; | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
JSDoc example references non-existent
slides.PPTGenerationResultexposesfilePathandtotalSlides, notslides. Update the example to avoid confusion.📝 Suggested doc fix
📝 Committable suggestion
🤖 Prompt for AI Agents