@silurus/ooxml 0.3.0 → 0.4.0

package/dist/types/pptx.d.ts

@@ -70,6 +70,24 @@ declare interface ChartElement {
     catAxisHidden: boolean;
     valAxisHidden: boolean;
     plotAreaBg: string | null;
+    /** Outer chartSpace background (hex without '#'). null when noFill/absent. */
+    chartBg: string | null;
+    /** True when <c:legend> is declared; false suppresses the legend entirely. */
+    showLegend: boolean;
+    /** catAx crossBetween: "between" (default, 0.5-step padding) or "midCat". */
+    catAxisCrossBetween: 'between' | 'midCat' | string;
+    /** `<c:valAx><c:majorTickMark>`. "cross" (default) | "out" | "in" | "none". */
+    valAxisMajorTickMark: 'cross' | 'out' | 'in' | 'none' | string;
+    /** `<c:catAx><c:majorTickMark>`. */
+    catAxisMajorTickMark: 'cross' | 'out' | 'in' | 'none' | string;
+    /** Title font size in OOXML hundredths of a point (1600 = 16pt). null = default. */
+    titleFontSizeHpt: number | null;
+    /** `<c:catAx><c:txPr>` font size (hpt). null = proportional default. */
+    catAxisFontSizeHpt: number | null;
+    /** `<c:valAx><c:txPr>` font size (hpt). null = proportional default. */
+    valAxisFontSizeHpt: number | null;
+    /** `<c:dLbls><c:txPr>` font size (hpt) for data-point value labels. */
+    dataLabelFontSizeHpt: number | null;
 }
 
 declare interface ChartSeries {
@@ -129,6 +147,24 @@ export declare interface LoadOptions {
     useGoogleFonts?: boolean;
 }
 
+declare interface MediaElement {
+    type: 'media';
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    /** "audio" or "video" */
+    mediaKind: 'audio' | 'video';
+    /** Poster image zip path (e.g. "ppt/media/image2.png"). Empty when no poster. */
+    posterPath: string;
+    /** Poster image MIME type (empty when no poster). */
+    posterMimeType: string;
+    /** Path inside the pptx zip (e.g. "ppt/media/media2.mp4"). Used by getMedia. */
+    mediaPath: string;
+    /** MIME type of the underlying media (e.g. "audio/mpeg", "video/mp4"). */
+    mimeType: string;
+}
+
 export declare interface NoFill {
     fillType: 'none';
 }
@@ -230,6 +266,8 @@ export declare class PptxPresentation {
     private readonly _worker;
     private _presentation;
     private _pendingParseCallbacks;
+    private _pendingMediaCallbacks;
+    private _mediaCache;
     private _nextId;
     private _workerReady;
     private _workerReadyCallbacks;
@@ -246,6 +284,19 @@ export declare class PptxPresentation {
     get slideHeight(): number;
     /** Render a slide onto the given canvas. */
     renderSlide(canvas: HTMLCanvasElement, slideIndex: number, opts?: RenderSlideOptions): Promise<void>;
+    /**
+     * Extract raw media bytes for a zip path referenced by {@link MediaElement}.
+     * Results are cached by path for the lifetime of this instance.
+     */
+    getMedia(mediaPath: string): Promise<Blob>;
+    private _findMimeTypeForPath;
+    /**
+     * Render a slide and attach canvas-native playback controls for any
+     * embedded audio/video. Returns a disposable handle that owns the RAF loop,
+     * media elements, and object URLs. Unlike {@link renderSlide}, this method
+     * is stateful — always call `handle.dispose()` when leaving the slide.
+     */
+    presentSlide(canvas: HTMLCanvasElement, slideIndex: number, opts?: RenderSlideOptions): Promise<PresentationHandle>;
     /** Terminate the worker and release all resources. */
     destroy(): void;
 }
@@ -303,12 +354,31 @@ export declare interface Presentation {
     minorFont: string | null;
 }
 
+declare interface PresentationHandle {
+    play(mediaPath?: string): void;
+    pause(mediaPath?: string): void;
+    dispose(): void;
+}
+
 export declare interface RenderOptions {
     width?: number;
     defaultTextColor?: string | null;
     dpr?: number;
     majorFont?: string | null;
     minorFont?: string | null;
+    /**
+     * Lazily resolve an archive-internal asset (by zip path) to a Blob. The
+     * renderer uses this to fetch posters and other large embedded assets on
+     * demand, keeping the parse output free of inlined base64.
+     */
+    fetchMedia?: (path: string) => Promise<Blob>;
+    /**
+     * When true, renderMedia draws only the poster frame — play/pause badges
+     * and progress bars are left to the caller. Set by the pptx presentSlide
+     * API so its interactive handle can own all control chrome without
+     * the static renderer drawing a duplicate play badge.
+     */
+    skipMediaControls?: boolean;
 }
 
 /**
@@ -323,6 +393,12 @@ export declare interface RenderSlideOptions {
     width?: number;
     /** Device pixel ratio. Defaults to window.devicePixelRatio or 1. */
     dpr?: number;
+    /**
+     * Skip drawing the play badge overlay on media elements. Used internally by
+     * {@link PptxPresentation.presentSlide} so its interactive handle can draw
+     * its own play/pause chrome without duplication.
+     */
+    skipMediaControls?: boolean;
 }
 
 declare interface Shadow {
@@ -376,7 +452,7 @@ export declare interface Slide {
     elements: SlideElement[];
 }
 
-export declare type SlideElement = ShapeElement | PictureElement | TableElement | ChartElement;
+export declare type SlideElement = ShapeElement | PictureElement | TableElement | ChartElement | MediaElement;
 
 export declare interface SolidFill {
     fillType: 'solid';