presenter 0.5.4 → 0.6.0

package/dist/src/presentation/presentation.d.ts

@@ -1,153 +0,0 @@
-import { BoundingBox } from "../util/position";
-import { Slide } from "./slide";
-export interface PresentationFont {
-    url: string;
-    fontFamily: string;
-    fontStyle?: string;
-    fontWeight?: string | number;
-}
-export interface PresentationOptions {
-    /**
-     * Width of the presentation.
-     */
-    width: number;
-    /**
-     * Height of the presentation.
-     */
-    height: number;
-    /**
-     * Slide color for the presentation.
-     */
-    backgroundColor: string;
-    /**
-     * Fonts to embed in PDF export.
-     */
-    fonts: PresentationFont[];
-    /**
-     * How long cached presentation state should be valid for, in minutes.
-     * `null` menas don't use cached data at all.
-     * `0` means use cached data indefinitely.
-     *
-     * When presentation state is cached, reloading the presentation returns
-     * the user to the slide and build they were on previously.
-     */
-    stateCacheTTL: number | null;
-}
-interface PresentationState {
-    currentSlide: number;
-}
-export declare class Presentation {
-    /**
-     * Title of the presentation.
-     */
-    title: string;
-    /**
-     * Element where presentation should be mounted.
-     */
-    element: HTMLElement;
-    /**
-     * SVG container element.
-     */
-    container: HTMLElement;
-    /**
-     * Parent SVG element of presentation.
-     */
-    svg: SVGSVGElement | null;
-    /**
-     * Shadow SVG element, not displayed and used for calculating sizes.
-     */
-    shadow: SVGSVGElement | null;
-    /**
-     * Background SVG element, used for rendering background color.
-     */
-    background: SVGSVGElement | null;
-    /**
-     * Additional element container for elements that aren't part of the SVG.
-     */
-    additionalElementContainer: HTMLElement | null;
-    /**
-     * Element that allows navigation between different slides.
-     */
-    navigatorContainer: HTMLElement | null;
-    /**
-     * Presentation settings.
-     */
-    options: PresentationOptions;
-    /**
-     * Bounds of presentation.
-     */
-    boundingBox: BoundingBox;
-    /**
-     * Presentation slides.
-     */
-    slides: Slide[];
-    /**
-     * Presentation state.
-     */
-    presentationState: PresentationState;
-    /**
-     * Keyboard shortcut access to jump to particular slides.
-     * A null slide index indicates not changing the slide
-     * (i.e. keeping the same slide active.)
-     */
-    shortcuts: Record<string, {
-        slideIndex: number | null;
-        animationIndex: number;
-    }>;
-    /**
-     * Current text command that the presenter has entered into presentation.
-     */
-    textCommand: {
-        active: boolean;
-        command: string;
-    };
-    slideCleanupHandlers: (() => void)[];
-    /**
-     *
-     * @param title Title of the presentation.
-     */
-    constructor(title: string, slides: Slide[], element: HTMLElement, options?: Partial<PresentationOptions>);
-    present(): void;
-    /**
-     * Renders a slide.
-     */
-    renderSlide(slideIndex: number, animationIndex?: number | "last"): void;
-    /**
-     * Sets up keyboard commands for the presentation.
-     */
-    setupKeyboardCommands(): void;
-    handleKeyboardEvent(event: KeyboardEvent): void;
-    resetTextCommand(): void;
-    /**
-     * Updates the size of the parent SVG element.
-     *
-     * The size of the parent SVG element needs to be updated.
-     */
-    updateSVGContainerSize(): void;
-    /**
-     * Advances to next animation in slide, or next slide if there is no next animation.
-     * Returns true if we were able to successfully advance.
-     * @param includeIntermediateBuilds Determines whether to progress through builds.
-     */
-    next(includeIntermediateBuilds: boolean): Promise<boolean>;
-    /**
-     * Goes back to the previous slide.
-     * @param includeIntermediateBuilds Determines whether to progress through builds.
-     */
-    previous(includeIntermediateBuilds: boolean): void;
-    /**
-     * Checks if the presentation takes the entire document body.
-     * @returns True if the presentation takes the entire document body.
-     */
-    isFullBodyPresentation(): boolean;
-    /**
-     * Computes the current size of an element in the DOM.
-     * Optionally accepts a custom list of children to see what the size of an
-     * element would be with different children.
-     * @param element Element to compute size of.
-     * @param children Custom children to use for element.
-     * @returns BoundingBox
-     */
-    computeRenderedBoundingBox(element: SVGGraphicsElement, children?: Node[] | null): BoundingBox;
-}
-export {};

package/dist/src/presentation/presentation.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/presentation/slide.d.ts

@@ -1,43 +0,0 @@
-import { BuildFunctionSequence } from "../util/animation";
-import { SlideObject } from "./object";
-import { Presentation } from "./presentation";
-export interface SlideProps {
-    /**
-     * An optional title for the slide, shown in navigation bar.
-     */
-    title: string | null;
-    /**
-     * Additional HTML element to show behind SVG content.
-     */
-    additionalElement: HTMLElement | (() => HTMLElement) | null;
-    /**
-     * A shortcut allows a keyboard shortcut to link directly to a slide.
-     * Represented as either just a string (the shortcut),
-     * or a string and number (shortcut and animation index).
-     */
-    shortcuts: (string | [string, number])[];
-}
-export declare class Slide {
-    objects: SlideObject<any>[];
-    animations: BuildFunctionSequence;
-    /**
-     * Which animation we're set to render next.
-     * Slides start with animationIndex = 0.
-     */
-    animationIndex: number;
-    /**
-     * Property used by the presenter-export package to note which
-     * animations of the slide are meant to be exported.
-     * "first", "last", "all", and "none" are special-cased values,
-     * otherwise it can be an animationIndex in [0, animations.length].
-     */
-    keyBuilds: "first" | "last" | "all" | "none" | number[] | null;
-    props: SlideProps;
-    constructor(objects: SlideObject<any>[], animations?: BuildFunctionSequence, props?: Partial<SlideProps>);
-    render(presentation: Presentation, animationIndex?: number): void;
-    nextAnimation(): Promise<boolean>;
-    /**
-     * Returns the build indices that are meant to be exported.
-     */
-    getKeyBuilds(): number[];
-}

package/dist/src/presentation/storage.d.ts

@@ -1,9 +0,0 @@
-import { Presentation } from "./presentation";
-export declare function storePresentationState(presentation: Presentation): void;
-/**
- * Restores the presentation state from the cache, if it exists and isn't older
- * than the cache TTL in minutes.
- *
- * Returns `true` if the presentation state was updated.
- */
-export declare function restorePresentationState(presentation: Presentation, ttl: number | null): boolean;

package/dist/src/util/animation.d.ts

@@ -1,60 +0,0 @@
-import anime from "animejs/lib/anime.es.js";
-export { anime };
-/**
- * Data needed to process an animation.
- */
-export interface AnimationProps {
-    /**
-     * Whether to animate the change.
-     */
-    animate?: boolean;
-    element?: HTMLElement | SVGElement;
-    attributes?: Record<string, string>;
-    styles?: Record<string, string>;
-    animationParams?: anime.AnimeParams;
-    children?: Node[];
-    /**
-     * Delay, in milliseconds.
-     */
-    delay?: number;
-    /**
-     * An animation can also specify custom functions that can be called to
-     * perform an animation or update to the end state of the animation.
-     */
-    animateCallback?: () => void;
-    updateCallback?: () => void;
-}
-/**
- * Function that performs an animation on an element.
- */
-export type Animator = (props: AnimationProps | AnimationProps[]) => Promise<void>;
-/**
- * Function that possibly applies a sequence of animations.
- */
-export type BuildFunction = (animate: Animator) => void;
-/**
- * A build function sequence is a sequence, where each element is a build
- * function or a list of build functions to be performed on the same build.
- *
- * In a list of build functions, a number in place of a build function represents a delay.
- */
-export type BuildFunctionSequence = (BuildFunction | (BuildFunction | number)[])[];
-/**
- * Perform an animation on an element.
- * @param props Animation properties.
- */
-export declare const performAnimation: Animator;
-/**
- * Performs animations by skipping the animation duration and jumping to end of animation.
- * @param props Animation properties.
- */
-export declare const skipAnimation: Animator;
-/**
- * When performing animations on non-DOM elements, e.g. variables in the state
- * of a Three.js scene, we need a unchanging reference to state that may get
- * replaced. That state can hold any type.
- */
-export interface StateContainer<T> {
-    state: T;
-}
-export declare function animateStateChange<T>(state: StateContainer<T>, finalState: Partial<T>, duration?: number): BuildFunction;

package/dist/src/util/easing.d.ts

@@ -1,12 +0,0 @@
-/**
- * Clamps a value to a given range.
- */
-export declare function clamp(value: number, min: number, max: number): number;
-/**
- * Maps a [0, 1] value linearly onto [0, 1].
- */
-export declare function easeLinear(value: number): number;
-/**
- * Maps a [0, 1] value onto [0, 1] via a smoothstep cubic easing function.
- */
-export declare function easeCubic(value: number): number;

package/dist/src/util/easing.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/util/position.d.ts

@@ -1,11 +0,0 @@
-export interface Position {
-    x: number;
-    y: number;
-}
-export declare class BoundingBox {
-    origin: Position;
-    width: number;
-    height: number;
-    constructor(origin: Position, width: number, height: number);
-    static fromElement(element: SVGGraphicsElement): BoundingBox;
-}

package/dist/src/util/richText.d.ts

@@ -1,19 +0,0 @@
-import { TextContent } from "../objects/text";
-export interface RichTextProps {
-    fontStyle?: string;
-    fontWeight?: string | number;
-    fontSize?: string | number;
-    fontFamily?: string;
-    textDecoration?: string;
-    smallCaps?: boolean;
-    color?: string;
-    dy?: number;
-    superscript?: boolean;
-    subscript?: boolean;
-}
-export type RichTextSpan = string | [string, RichTextProps];
-export declare function preserveLeadingSpaces(content: TextContent): TextContent;
-/**
- * Given rich text configuration, returns the corresponding tspan nodes.
- */
-export declare function generateTextNodes(lines: (string | RichTextSpan[])[], lineSpacing?: string, anchor?: "start" | "middle" | "end"): Node[];

package/dist/webpack.config.d.ts

@@ -1,70 +0,0 @@
-export let mode: string;
-export namespace entry {
-    export namespace presenter {
-        let _import: string;
-        export { _import as import };
-        export let filename: string;
-        export namespace library {
-            let name: string;
-            let type: string;
-        }
-    }
-    export namespace _export {
-        let _import_1: string;
-        export { _import_1 as import };
-        let filename_1: string;
-        export { filename_1 as filename };
-        export namespace library_1 {
-            let name_1: string;
-            export { name_1 as name };
-            let type_1: string;
-            export { type_1 as type };
-        }
-        export { library_1 as library };
-    }
-    export { _export as export };
-    export namespace morph {
-        let _import_2: string;
-        export { _import_2 as import };
-        let filename_2: string;
-        export { filename_2 as filename };
-        export namespace library_2 {
-            let name_2: string;
-            export { name_2 as name };
-            let type_2: string;
-            export { type_2 as type };
-        }
-        export { library_2 as library };
-    }
-    export namespace code {
-        let _import_3: string;
-        export { _import_3 as import };
-        let filename_3: string;
-        export { filename_3 as filename };
-        export namespace library_3 {
-            let name_3: string;
-            export { name_3 as name };
-            let type_3: string;
-            export { type_3 as type };
-        }
-        export { library_3 as library };
-    }
-}
-export namespace output {
-    let path: string;
-    let libraryTarget: string;
-    let globalObject: string;
-}
-export namespace watchOptions {
-    let ignored: string[];
-}
-export namespace resolve {
-    let extensions: string[];
-}
-export namespace module {
-    let rules: {
-        test: RegExp;
-        use: string;
-        exclude: RegExp[];
-    }[];
-}