presenter 0.9.0 → 0.9.2

package/dist/animations/Hide.d.ts

@@ -1,3 +1,3 @@
 import { SlideObject } from '../types/SlideObject';
-import { Update } from '../types/Update';
-export declare function Hide<T extends SlideObject>(object: T): Update<T>;
+import { Update, UpdateParams } from '../types/Update';
+export declare function Hide<T extends SlideObject>(object: T, updateParams?: UpdateParams<T>): Update<T>;

package/dist/animations/Show.d.ts

@@ -1,3 +1,3 @@
 import { SlideObject } from '../types/SlideObject';
-import { Update } from '../types/Update';
-export declare function Show<T extends SlideObject>(object: T): Update<T>;
+import { Update, UpdateParams } from '../types/Update';
+export declare function Show<T extends SlideObject>(object: T, updateParams?: UpdateParams<T>): Update<T>;

package/dist/export/index.d.ts

@@ -1,3 +1,4 @@
 export { ImageRenderer } from './image-renderer/ImageRenderer';
+export { NotesRenderer } from './notes-renderer/NotesRenderer';
 export { PDFRenderer } from './pdf-renderer/PDFRenderer';
 export { PowerPointRenderer } from './powerpoint-renderer/PowerPointRenderer';

package/dist/export/notes-renderer/NotesRenderer.d.ts

@@ -0,0 +1,7 @@
+import { NotesRendererProps } from './types/NotesRendererProps';
+export declare class NotesRenderer {
+    private readonly imageRenderer;
+    readonly props: NotesRendererProps;
+    constructor(props: Partial<NotesRendererProps>);
+    save(directoryName: string): Promise<void>;
+}

package/dist/export/notes-renderer/types/NotesEntry.d.ts

@@ -0,0 +1,6 @@
+export interface NotesEntry {
+    readonly caption: string;
+    readonly imageFilename: string;
+    readonly notes: string | null;
+    readonly title: string | null;
+}

package/dist/export/notes-renderer/types/NotesRendererProps.d.ts

@@ -0,0 +1,16 @@
+import { ImageRendererProps } from '../../image-renderer/types/ImageRendererProps';
+export interface NotesRendererProps extends Omit<ImageRendererProps, "animationHoldFrames" | "framesPerSecond" | "isAnimatedExport"> {
+    /** Optional author shown in the document header and embedded in PDF metadata. */
+    readonly author: string | null;
+    /**
+     * Description shown in the document header and embedded in PDF metadata by Typst.
+     * Defaults to the render date when null.
+     */
+    readonly description: string | null;
+    /** Directory, relative to the output directory, where slide images are saved. */
+    readonly imagesDirectoryName: string;
+    /** The filename of the Typst document created inside the output directory. */
+    readonly notesFilename: string;
+    /** Width of each slide image as a proportion of the document's usable width. */
+    readonly slideWidth: number;
+}

package/dist/export/notes-renderer/utils/getNotesEntries.d.ts

@@ -0,0 +1,9 @@
+import { Presentation } from '../../../types/Presentation';
+import { NotesEntry } from '../types/NotesEntry';
+interface GetNotesEntriesProps {
+    readonly getFilenameForImage: (imageIndex: number) => string;
+    readonly imagesDirectoryName: string;
+    readonly presentation: Presentation;
+}
+export declare function getNotesEntries({ getFilenameForImage, imagesDirectoryName, presentation, }: GetNotesEntriesProps): NotesEntry[];
+export {};

package/dist/export/notes-renderer/utils/getTypstDocument.d.ts

@@ -0,0 +1,10 @@
+import { NotesEntry } from '../types/NotesEntry';
+interface GetTypstDocumentProps {
+    readonly author: string | null;
+    readonly description: string | null;
+    readonly entries: NotesEntry[];
+    readonly slideWidth: number;
+    readonly title: string;
+}
+export declare function getTypstDocument({ author, description, entries, slideWidth, title, }: GetTypstDocumentProps): string;
+export {};