presenter 0.5.5 → 0.6.1

package/README.md

@@ -3,57 +3,3 @@
 Presenter.js is a presentation tool for programmatically building animated visual slides.
 
 This library is still in development and its API may change at any time.
-
-## Getting Started
-
-### Quick Start
-
-The simplest way to get started with a Presenter.js presentation is via
-`npm create presenter`.
-
-```bash
-$ npm create presenter
-```
-
-Running `npm create presenter` will prompt you to enter a project name and will
-then create a new presentation with Presenter.js, written in TypeScript and
-built with Webpack.
-
-After creating the new presentation, `cd` into the directory and run
-`npm run serve` to run the presentation. Edit `src/index.ts` to make changes
-to your presentation.
-
-### Installing Presenter.js Manually
-
-Presenter.js can also be installed manually via `npm`.
-
-```bash
-$ npm install presenter
-```
-
-### Sample Usage
-
-Create a presentation by specifying a list of slides, where each slide may
-contain objects and animations.
-
-```javascript
-import { Presentation, Slide, Text } from "presenter";
-
-const slide = new Slide([
-  new Text("Welcome to Presenter.js!", {
-    position: { x: 0.5, y: 0.5 },
-    anchor: "center",
-    fontSize: 150,
-  }),
-]);
-
-document.addEventListener("DOMContentLoaded", () => {
-  const presentation = new Presentation(
-    "My Presentation",
-    [slide],
-    document.body,
-  );
-
-  presentation.present();
-});
-```

package/dist/constructors/Grid.d.ts

@@ -0,0 +1,36 @@
+import { Group } from "../objects/Group";
+import { Anchor } from "../types/Anchor";
+import { SlideObject } from "../types/SlideObject";
+export interface GridProps {
+    readonly anchor: Anchor;
+    /** Number of columns in the grid. */
+    readonly cols: number;
+    /** Pixels of horizontal space between objects in the grid. */
+    readonly gapX: number;
+    /** Pixels of vertical space between objects in the grid. */
+    readonly gapY: number;
+    /**
+     * Height, in pixels, of each object in the grid.
+     *
+     * If height is variable, a function can be provided that maps the row/col indices to a height.
+     */
+    readonly height: number | ((row: number, col: number) => number);
+    /** Function mapping row/col indices to the object in the grid at that index. */
+    readonly objects: (row: number, col: number) => SlideObject | null;
+    /** Number of rows in the grid. */
+    readonly rows: number;
+    /**
+     * Width, in pixels, of each object in the grid.
+     *
+     * If width is variable, a function can be provided that maps the row/col indices to a width.
+     */
+    readonly width: number | ((row: number, col: number) => number);
+    readonly x: number;
+    readonly y: number;
+}
+interface Return {
+    readonly grid: Group;
+    readonly objects: (SlideObject | null)[][];
+}
+export declare function Grid(props: Partial<GridProps>): Return;
+export {};

package/dist/export/image-renderer/ImageRenderer.d.ts

@@ -0,0 +1,9 @@
+import { ImageRendererProps } from "./types/ImageRendererProps";
+import { ImageRendererState } from "./types/ImageRendererState";
+export declare class ImageRenderer {
+    props: ImageRendererProps;
+    state: ImageRendererState;
+    constructor(props: Partial<ImageRendererProps>);
+    save(directoryName: string, startImageIndex?: number): Promise<void>;
+    renderImage(slideIndex: number, buildIndex: number, buildTime?: number | null): Promise<void>;
+}

package/dist/export/image-renderer/types/ImageRendererProps.d.ts

@@ -0,0 +1,26 @@
+import { BrowserCanvasObjectRenderer } from "../../../renderer/browser-canvas/types/BrowserCanvasObjectRenderer";
+import { Presentation } from "../../../types/Presentation";
+import { SlideObject } from "../../../types/SlideObject";
+export interface ImageRendererProps {
+    readonly presentation: Presentation;
+    /**
+     * An animated export includes all frames of animation in the entire presentation.
+     * Non-animated exports only include key builds.
+     */
+    readonly isAnimatedExport: boolean;
+    /**
+     * The number of frames to hold for each animation step.
+     * Applies only to animated exports.
+     */
+    readonly animationHoldFrames: number;
+    /**
+     * The number of frames per second for animated exports.
+     */
+    readonly framesPerSecond: number;
+    readonly getFilenameForImage: (imageIndex: number) => string;
+    readonly imageFormat: "png" | "jpeg" | "webp" | "svg";
+    /** How frequently to log progress frame. */
+    readonly logFrequency: number;
+    readonly objectRenderers: Record<string, BrowserCanvasObjectRenderer<SlideObject>>;
+    readonly resourcePathPrefix: string;
+}

package/dist/export/image-renderer/types/ImageRendererState.d.ts

@@ -0,0 +1,8 @@
+import { UnifiedImage } from "../../../renderer/browser-canvas/types/UnifiedImage";
+export interface ImageRendererState {
+    directoryName: string;
+    imageIndex: number;
+    imageById: Record<string, UnifiedImage>;
+    startImageIndex: number;
+}
+export declare const IMAGE_RENDERER_DEFAULT_STATE: ImageRendererState;

package/dist/export/index.d.ts

@@ -0,0 +1,3 @@
+export { ImageRenderer } from "./image-renderer/ImageRenderer";
+export { PDFRenderer } from "./pdf-renderer/PDFRenderer";
+export { PowerPointRenderer } from "./powerpoint-renderer/PowerPointRenderer";

package/dist/export/pdf-renderer/PDFRenderer.d.ts

@@ -0,0 +1,10 @@
+import { Canvas } from "skia-canvas";
+import { PDFRendererProps } from "./types/PDFRendererProps";
+import { PDFRendererState } from "./types/PDFRendererState";
+export declare class PDFRenderer {
+    props: PDFRendererProps;
+    state: PDFRendererState;
+    constructor(props: Partial<PDFRendererProps>);
+    save(filename: string): Promise<void>;
+    addPage(canvas: Canvas, slideIndex: number, buildIndex: number): void;
+}

package/dist/export/pdf-renderer/types/PDFRendererProps.d.ts

@@ -0,0 +1,8 @@
+import { BrowserCanvasObjectRenderer } from "../../../renderer/browser-canvas/types/BrowserCanvasObjectRenderer";
+import { Presentation } from "../../../types/Presentation";
+import { SlideObject } from "../../../types/SlideObject";
+export interface PDFRendererProps {
+    readonly presentation: Presentation;
+    readonly objectRenderers: Record<string, BrowserCanvasObjectRenderer<SlideObject>>;
+    readonly resourcePathPrefix: string;
+}

package/dist/export/pdf-renderer/types/PDFRendererState.d.ts

@@ -0,0 +1,5 @@
+import { UnifiedImage } from "../../../renderer/browser-canvas/types/UnifiedImage";
+export interface PDFRendererState {
+    imageById: Record<string, UnifiedImage>;
+}
+export declare const PDF_RENDERER_DEFAULT_STATE: PDFRendererState;

package/dist/export/powerpoint-renderer/PowerPointRenderer.d.ts

@@ -0,0 +1,11 @@
+import pptxgen from "pptxgenjs";
+import { UnifiedCanvasContext } from "../../renderer/browser-canvas/types/UnifiedCanvasContext";
+import { PowerPointRendererProps } from "./types/PowerPointRendererProps";
+import { PowerPointRendererState } from "./types/PowerPointRendererState";
+export declare class PowerPointRenderer {
+    props: PowerPointRendererProps;
+    state: PowerPointRendererState;
+    constructor(props: Partial<PowerPointRendererProps>);
+    save(filename: string): void;
+    addSlide(powerpoint: pptxgen, context: UnifiedCanvasContext, slideIndex: number, buildIndex: number): void;
+}

package/dist/export/powerpoint-renderer/objects/renderArrow.d.ts

@@ -0,0 +1,3 @@
+import { Arrow } from "../../../objects/Arrow";
+import { PowerPointObjectRenderer } from "../types/PowerPointObjectRenderer";
+export declare const renderArrow: PowerPointObjectRenderer<Arrow>;

package/dist/export/powerpoint-renderer/objects/renderCircle.d.ts

@@ -0,0 +1,3 @@
+import { Circle } from "../../../objects/Circle";
+import { PowerPointObjectRenderer } from "../types/PowerPointObjectRenderer";
+export declare const renderCircle: PowerPointObjectRenderer<Circle>;

package/dist/export/powerpoint-renderer/objects/renderGroup.d.ts

@@ -0,0 +1,3 @@
+import { Group } from "../../../objects/Group";
+import { PowerPointObjectRenderer } from "../types/PowerPointObjectRenderer";
+export declare const renderGroup: PowerPointObjectRenderer<Group>;

package/dist/export/powerpoint-renderer/objects/renderImage.d.ts

@@ -0,0 +1,3 @@
+import { Image } from "../../../objects/Image";
+import { PowerPointObjectRenderer } from "../types/PowerPointObjectRenderer";
+export declare const renderImage: PowerPointObjectRenderer<Image>;

package/dist/export/powerpoint-renderer/objects/renderLine.d.ts

@@ -0,0 +1,3 @@
+import { Line } from "../../../objects/Line";
+import { PowerPointObjectRenderer } from "../types/PowerPointObjectRenderer";
+export declare const renderLine: PowerPointObjectRenderer<Line>;

package/dist/export/powerpoint-renderer/objects/renderPath.d.ts

@@ -0,0 +1,3 @@
+import { Path } from "../../../objects/Path";
+import { PowerPointObjectRenderer } from "../types/PowerPointObjectRenderer";
+export declare const renderPath: PowerPointObjectRenderer<Path>;

package/dist/export/powerpoint-renderer/objects/renderPolygon.d.ts

@@ -0,0 +1,3 @@
+import { Polygon } from "../../../objects/Polygon";
+import { PowerPointObjectRenderer } from "../types/PowerPointObjectRenderer";
+export declare const renderPolygon: PowerPointObjectRenderer<Polygon>;

package/dist/export/powerpoint-renderer/objects/renderRectangle.d.ts

@@ -0,0 +1,3 @@
+import { Rectangle } from "../../../objects/Rectangle";
+import { PowerPointObjectRenderer } from "../types/PowerPointObjectRenderer";
+export declare const renderRectangle: PowerPointObjectRenderer<Rectangle>;

package/dist/export/powerpoint-renderer/objects/renderText.d.ts

@@ -0,0 +1,3 @@
+import { Text } from "../../../objects/Text";
+import { PowerPointObjectRenderer } from "../types/PowerPointObjectRenderer";
+export declare const renderText: PowerPointObjectRenderer<Text>;

package/dist/export/powerpoint-renderer/types/ObjectTransform.d.ts

@@ -0,0 +1,7 @@
+export interface ObjectTransform {
+    readonly translateX: number;
+    readonly translateY: number;
+    readonly scale: number;
+    readonly rotation: number;
+}
+export declare const DEFAULT_OBJECT_TRANSFORM: ObjectTransform;

package/dist/export/powerpoint-renderer/types/PowerPointObjectRenderer.d.ts

@@ -0,0 +1,16 @@
+import pptxgenjs from "pptxgenjs";
+import { UnifiedCanvasContext } from "../../../renderer/browser-canvas/types/UnifiedCanvasContext";
+import { SlideObject } from "../../../types/SlideObject";
+import { ObjectTransform } from "./ObjectTransform";
+export interface PowerPointObjectRendererArgs<T extends SlideObject> {
+    readonly ctx: UnifiedCanvasContext;
+    readonly imagePathById: Record<string, string>;
+    readonly powerpoint: pptxgenjs;
+    readonly slide: pptxgenjs.Slide;
+    readonly object: T;
+    readonly opacity: number;
+    readonly pixelsPerInch: number;
+    readonly transform: ObjectTransform;
+    readonly renderObject: (object: SlideObject, transform: ObjectTransform, overallOpacity: number) => void;
+}
+export type PowerPointObjectRenderer<T extends SlideObject> = (args: PowerPointObjectRendererArgs<T>) => void;

package/dist/export/powerpoint-renderer/types/PowerPointRendererProps.d.ts

@@ -0,0 +1,9 @@
+import { Presentation } from "../../../types/Presentation";
+import { SlideObject } from "../../../types/SlideObject";
+import { PowerPointObjectRenderer } from "./PowerPointObjectRenderer";
+export interface PowerPointRendererProps {
+    readonly presentation: Presentation;
+    readonly objectRenderers: Record<string, PowerPointObjectRenderer<SlideObject>>;
+    readonly pixelsPerInch: number;
+    readonly resourcePathPrefix: string;
+}

package/dist/export/powerpoint-renderer/types/PowerPointRendererState.d.ts

@@ -0,0 +1,4 @@
+export interface PowerPointRendererState {
+    readonly imagePathById: Record<string, string>;
+}
+export declare const POWERPOINT_RENDERER_DEFAULT_STATE: PowerPointRendererState;

package/dist/export/powerpoint-renderer/utils/defaultObjectRenderers.d.ts

@@ -0,0 +1,10 @@
+import { ObjectType } from "../../../types/ObjectType";
+import { SlideObject } from "../../../types/SlideObject";
+import { PowerPointObjectRenderer } from "../types/PowerPointObjectRenderer";
+type ObjectRendererMap = {
+    [T in ObjectType]: PowerPointObjectRenderer<SlideObject & {
+        objectType: T;
+    }>;
+};
+export declare const DEFAULT_OBJECT_RENDERERS: ObjectRendererMap;
+export {};

package/dist/export/powerpoint-renderer/utils/getImagePathById.d.ts

@@ -0,0 +1 @@
+export declare function getImagePathById(relativeImagePathById: Record<string, string>, pathPrefix: string): Record<string, string>;

package/dist/export/powerpoint-renderer/utils/getPptxFillColor.d.ts

@@ -0,0 +1,9 @@
+import { Color } from "../../../types/Color";
+interface Return {
+    /** RGB hex string for color, of length 6 */
+    readonly color: string;
+    /** Color opacity in [0, 100] */
+    readonly transparency: number;
+}
+export declare function getPptxFillColor(color: Color, opacity?: number): Return;
+export {};

package/dist/export/powerpoint-renderer/utils/getPptxText.d.ts

@@ -0,0 +1,13 @@
+import pptxgen from "pptxgenjs";
+import { TextStyle } from "../../../types/TextStyle";
+import { TextUnit } from "../../../types/TextUnit";
+interface Args {
+    readonly length: number | null;
+    readonly opacity: number;
+    readonly pixelsPerInch: number;
+    readonly scale: number;
+    readonly style: TextStyle;
+    readonly textUnits: readonly TextUnit[][];
+}
+export declare function getPptxText({ length, opacity, pixelsPerInch, scale, style, textUnits, }: Args): pptxgen.TextProps[];
+export {};

package/dist/export/powerpoint-renderer/utils/getTransformedBoundingBox.d.ts

@@ -0,0 +1,6 @@
+import { Anchor } from "../../../types/Anchor";
+import { BoundingBox } from "../../../types/BoundingBox";
+import { Position } from "../../../types/Position";
+import { Size } from "../../../types/Size";
+import { ObjectTransform } from "../types/ObjectTransform";
+export declare function getTransformedBoundingBox(position: Position, anchor: Anchor, size: Size, transform: ObjectTransform): BoundingBox;

package/dist/export/powerpoint-renderer/utils/getUnitsFromPixels.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Gets inches from pixels.
+ */
+export declare function getInchesFromPixels(pixels: number, pixelsPerInch: number): number;
+/**
+ * Gets PowerPoint pixels from Presenter.js pixels.
+ */
+export declare function getPptxPixelsFromPixels(pixels: number, pixelsPerInch: number): number;
+export declare function getPptxFontSizeFromPixels(pixels: number, pixelsPerInch: number): number;

package/dist/export/utils/createCanvasElement.d.ts

@@ -0,0 +1,3 @@
+import { Canvas } from "skia-canvas";
+import { Size } from "../../types/Size";
+export declare function createCanvasElement(size: Size): Canvas;

package/dist/export/utils/createPath2D.d.ts

@@ -0,0 +1,2 @@
+import { UnifiedPath2D } from "../../renderer/browser-canvas/types/UnifiedPath2D";
+export declare function createPath2D(pathData?: string | undefined): UnifiedPath2D;

package/dist/export/utils/loadPresentationImages.d.ts

@@ -0,0 +1,2 @@
+import { UnifiedImage } from "../../renderer/browser-canvas/types/UnifiedImage";
+export declare function loadPresentationImages(imagePathById: Record<string, string>, pathPrefix: string): Promise<Record<string, UnifiedImage>>;