@tomorrowevening/theatre-studio 1.0.4 → 1.0.5

package/dist/TheatreStudio.d.ts

@@ -0,0 +1,426 @@
+import type { IProject, IRafDriver, ISheet, ISheetObject } from '@tomorrowevening/theatre-core';
+import type { Pointer } from '@tomorrowevening/theatre-dataverse';
+import type { VoidFn } from '@tomorrowevening/theatre-shared/utils/types';
+import type { IScrub } from '@tomorrowevening/theatre-studio/Scrub';
+import type { PaneInstanceId } from '@tomorrowevening/theatre-shared/utils/ids';
+import type TheatreSheetObject from '@tomorrowevening/theatre-core/sheetObjects/TheatreSheetObject';
+import type TheatreSheet from '@tomorrowevening/theatre-core/sheets/TheatreSheet';
+import type { __UNSTABLE_Project_OnDiskState } from '@tomorrowevening/theatre-core';
+export interface ITransactionAPI {
+    /**
+     * Set the value of a prop by its pointer. If the prop is sequenced, the value
+     * will be a keyframe at the current sequence position.
+     *
+     * @example
+     * Usage:
+     * ```ts
+     * const obj = sheet.object("box", {x: 0, y: 0})
+     * studio.transaction(({set}) => {
+     *   // set a specific prop's value
+     *   set(obj.props.x, 10) // New value is {x: 10, y: 0}
+     *   // values are set partially
+     *   set(obj.props, {y: 11}) // New value is {x: 10, y: 11}
+     *
+     *   // this will error, as there is no such prop as 'z'
+     *   set(obj.props.z, 10)
+     * })
+     * ```
+     * @param pointer - A Pointer, like object.props
+     * @param value - The value to override the existing value. This is treated as a deep partial value.
+     */
+    set<V>(pointer: Pointer<V>, value: V): void;
+    /**
+     * Unsets the value of a prop by its pointer.
+     *
+     * @example
+     * Usage:
+     * ```ts
+     * const obj = sheet.object("box", {x: 0, y: 0})
+     * studio.transaction(({set}) => {
+     *   // set props.x to its default value
+     *   unset(obj.props.x)
+     *   // set all props to their default value
+     *   set(obj.props)
+     * })
+     * ```
+     * @param pointer - A pointer, like object.props
+     */
+    unset<V>(pointer: Pointer<V>): void;
+    /**
+     * EXPERIMENTAL API - this api may be removed without notice.
+     *
+     * Makes Theatre forget about this object. This means all the prop overrides and sequenced props
+     * will be reset, and the object won't show up in the exported state.
+     */
+    __experimental_forgetObject(object: TheatreSheetObject): void;
+    /**
+     * EXPERIMENTAL API - this api may be removed without notice.
+     *
+     * Makes Theatre forget about this sheet.
+     */
+    __experimental_forgetSheet(sheet: TheatreSheet): void;
+}
+/**
+ *
+ */
+export interface PaneClassDefinition {
+    /**
+     * Each pane has a `class`, which is a string.
+     */
+    class: string;
+    mount: (opts: {
+        paneId: string;
+        node: HTMLElement;
+    }) => () => void;
+}
+export type ToolConfigIcon = {
+    type: 'Icon';
+    svgSource: string;
+    title: string;
+    onClick: () => void;
+};
+export type ToolConfigOption = {
+    value: string;
+    label: string;
+    svgSource: string;
+};
+export type ToolConfigSwitch = {
+    type: 'Switch';
+    value: string;
+    onChange: (value: string) => void;
+    options: ToolConfigOption[];
+};
+export type ToolconfigFlyoutMenuItem = {
+    label: string;
+    onClick?: () => void;
+};
+export type ToolConfigFlyoutMenu = {
+    /**
+     * A flyout menu
+     */
+    type: 'Flyout';
+    /**
+     * The label of the trigger button
+     */
+    label: string;
+    items: ToolconfigFlyoutMenuItem[];
+};
+export type ToolConfig = ToolConfigIcon | ToolConfigSwitch | ToolConfigFlyoutMenu;
+export type ToolsetConfig = Array<ToolConfig>;
+/**
+ * A Theatre.js Studio extension. You can define one either
+ * in a separate package, or within your project.
+ */
+export interface IExtension {
+    /**
+     * Pick a unique ID for your extension. Ideally the name would be unique if
+     * the extension was to be published to the npm repository.
+     */
+    id: string;
+    /**
+     * Set this if you'd like to add a component to the global toolbar (on the top)
+     *
+     * @example
+     * TODO
+     */
+    toolbars?: {
+        [key in 'global' | string]: (set: (config: ToolsetConfig) => void, studio: IStudio) => () => void;
+    };
+    /**
+     * Introduces new pane types.
+     * @example
+     * TODO
+     */
+    panes?: Array<PaneClassDefinition>;
+}
+export type PaneInstance<ClassName extends string> = {
+    extensionId: string;
+    instanceId: PaneInstanceId;
+    definition: PaneClassDefinition;
+};
+export interface IStudioUI {
+    /**
+     * Temporarily hides the studio
+     */
+    hide(): void;
+    /**
+     * Whether the studio is currently visible or hidden
+     */
+    readonly isHidden: boolean;
+    /**
+     * Makes the studio visible again.
+     */
+    restore(): void;
+    renderToolset(toolsetId: string, htmlNode: HTMLElement): () => void;
+}
+export interface _StudioInitializeOpts {
+    /**
+     * The local storage key to use to persist the state.
+     *
+     * Default: "theatrejs:0.4"
+     */
+    persistenceKey?: string;
+    /**
+     * Whether to persist the changes in the browser's temporary storage.
+     * It is useful to set this to false in the test environment or when debugging things.
+     *
+     * Default: true
+     */
+    usePersistentStorage?: boolean;
+    __experimental_rafDriver?: IRafDriver | undefined;
+}
+/**
+ * This is the public api of Theatre's studio. It is exposed through:
+ *
+ * @example
+ * Basic usage:
+ * ```ts
+ * import studio from '@tomorrowevening/theatre-studio'
+ *
+ * studio.initialize()
+ * ```
+ *
+ * @example
+ * Usage with **tree-shaking**:
+ * ```ts
+ * import studio from '@tomorrowevening/theatre-studio'
+ *
+ * if (process.env.NODE_ENV !== 'production') {
+ *   studio.initialize()
+ * }
+ * ```
+ */
+export interface IStudio {
+    readonly ui: IStudioUI;
+    /**
+     * Initializes the studio. Call it once in your index.js/index.ts module.
+     * It silently ignores subsequent calls.
+     */
+    initialize(opts?: _StudioInitializeOpts): void;
+    /**
+     * Runs an undo-able transaction. Creates a single undo level for all
+     * the operations inside the transaction.
+     *
+     * Will roll back if an error is thrown.
+     *
+     * @example
+     * Usage:
+     * ```ts
+     * studio.transaction(({set, unset}) => {
+     *   set(obj.props.x, 10) // set the value of obj.props.x to 10
+     *   unset(obj.props.y) // unset the override at obj.props.y
+     * })
+     * ```
+     */
+    transaction(fn: (api: ITransactionAPI) => void): void;
+    /**
+     * Creates a scrub, which is just like a transaction, except you
+     * can run it multiple times without creating extra undo levels.
+     *
+     * @example
+     * Usage:
+     * ```ts
+     * const scrub = studio.scrub()
+     * scrub.capture(({set}) => {
+     *   set(obj.props.x, 10) // set the value of obj.props.x to 10
+     * })
+     *
+     * // half a second later...
+     * scrub.capture(({set}) => {
+     *   set(obj.props.y, 11) // set the value of obj.props.y to 11
+     *   // note that since we're not setting obj.props.x, its value reverts back to its old value (ie. not 10)
+     * })
+     *
+     * // then either:
+     * scrub.commit() // commits the scrub and creates a single undo level
+     * // or:
+     * scrub.reset() // clear all the ops in the scrub so we can run scrub.capture() again
+     * // or:
+     * scrub.discard() // clears the ops and destroys it (ie. can't call scrub.capture() anymore)
+     * ```
+     */
+    scrub(): IScrub;
+    /**
+     * Creates a debounced scrub, which is just like a normal scrub, but
+     * automatically runs scrub.commit() after `threshhold` milliseconds have
+     * passed after the last `scrub.capture`.
+     *
+     * @param threshhold - How long to wait before committing the scrub
+     *
+     * @example
+     * Usage:
+     * ```ts
+     * // Will create a new undo-level after 2 seconds have passed
+     * // since the last scrub.capture()
+     * const scrub = studio.debouncedScrub(2000)
+     *
+     * // capture some ops
+     * scrub.capture(...)
+     * // wait one second
+     * await delay(1000)
+     * // capture more ops but no new undo level is made,
+     * // because the last scrub.capture() was called less than 2 seconds ago
+     * scrub.capture(...)
+     *
+     * // wait another seonc and half
+     * await delay(1500)
+     * // still no new undo level, because less than 2 seconds have passed
+     * // since the last capture
+     * scrub.capture(...)
+     *
+     * // wait 3 seconds
+     * await delay(3000) // at this point, one undo level is created.
+     *
+     * // this call to capture will start a new undo level
+     * scrub.capture(...)
+     * ```
+     */
+    debouncedScrub(threshhold: number): Pick<IScrub, 'capture'>;
+    /**
+     * Sets the current selection.
+     *
+     * @example
+     * Usage:
+     * ```ts
+     * const sheet1: ISheet = ...
+     * const obj1: ISheetObject<any> = ...
+     *
+     * studio.setSelection([sheet1, obj1])
+     * ```
+     *
+     * You can read the current selection from studio.selection
+     */
+    setSelection(selection: Array<ISheetObject<any> | ISheet>): void;
+    /**
+     * Calls fn every time the current selection changes.
+     */
+    onSelectionChange(fn: (s: Array<ISheetObject<{}> | ISheet>) => void): VoidFunction;
+    /**
+     * The current selection, consisting of Sheets and Sheet Objects
+     *
+     * @example
+     * Usage:
+     * ```ts
+     * console.log(studio.selection) // => [ISheetObject, ISheet]
+     * ```
+     */
+    readonly selection: Array<ISheetObject<{}> | ISheet>;
+    /**
+     * Registers an extension
+     */
+    extend(
+    /**
+     * The extension's definition
+     */
+    extension: IExtension, opts?: {
+        /**
+         * Whether to reconfigure the extension. This is useful if you're
+         * hot-reloading the extension.
+         *
+         * Mind you, that if the old version of the extension defines a pane,
+         * and the new version doesn't, all instances of that pane will disappear, as expected.
+         * _However_, if you again reconfigure the extension with the old version, the instances
+         * of the pane that pane will re-appear.
+         *
+         * We're not sure about whether this behavior makes sense or not. If not, let us know
+         * in the discord server or open an issue on github.
+         */
+        __experimental_reconfigure?: boolean;
+    }): void;
+    /**
+     * Creates a new pane
+     *
+     * @param paneClass - The class name of the pane (provided by an extension)
+     */
+    createPane<PaneClass extends string>(paneClass: PaneClass): PaneInstance<PaneClass>;
+    /**
+     * Returns the Theatre.js project that contains the studio's sheets and objects.
+     *
+     * It is useful if you'd like to have sheets/objects that are present only when
+     * studio is present.
+     */
+    getStudioProject(): IProject;
+    /**
+     * Creates a JSON object that contains the state of the project. You can use this
+     * to programmatically save the state of your projects to the storage system of your
+     * choice, rather than manually clicking on the "Export" button in the UI.
+     *
+     * @param projectId - same projectId as in `core.getProject(projectId)`
+     *
+     * @example
+     * Usage:
+     * ```ts
+     * const projectId = "project"
+     * const json = studio.createContentOfSaveFile(projectId)
+     * const string = JSON.stringify(json)
+     * fetch(`/projects/${projectId}/state`, {method: 'POST', body: string}).then(() => {
+     *   console.log("Saved")
+     * })
+     * ```
+     */
+    createContentOfSaveFile(projectId: string): Record<string, unknown>;
+    __experimental: {
+        /**
+         * Warning: This is an experimental API and will change in the future.
+         *
+         * Disables the play/pause keyboard shortcut (spacebar)
+         * Also see `__experimental_enablePlayPauseKeyboardShortcut()` to re-enable it.
+         */
+        __experimental_disblePlayPauseKeyboardShortcut(): void;
+        /**
+         * Warning: This is an experimental API and will change in the future.
+         *
+         * Disables the play/pause keyboard shortcut (spacebar)
+         */
+        __experimental_enablePlayPauseKeyboardShortcut(): void;
+        /**
+         * Clears persistent storage and ensures that the current state will not be
+         * saved on window unload. Further changes to state will continue writing to
+         * persistent storage, if enabled during initialization.
+         *
+         * @param persistenceKey - same persistencyKey as in `studio.initialize(opts)`, if any
+         */
+        __experimental_clearPersistentStorage(persistenceKey?: string): void;
+        /**
+         * Warning: This is an experimental API and will change in the future.
+         *
+         * This is functionally the same as `studio.createContentOfSaveFile()`, but
+         * returns a typed object instead of a JSON object.
+         *
+         * See {@link __UNSTABLE_Project_OnDiskState} for more information.
+         */
+        __experimental_createContentOfSaveFileTyped(projectId: string): __UNSTABLE_Project_OnDiskState;
+    };
+}
+export default class TheatreStudio implements IStudio {
+    readonly ui: {
+        hide(): void;
+        readonly isHidden: boolean;
+        restore(): void;
+        renderToolset(toolsetId: string, htmlNode: HTMLElement): () => void;
+    };
+    private readonly _cache;
+    __experimental: {
+        __experimental_disblePlayPauseKeyboardShortcut(): void;
+        __experimental_enablePlayPauseKeyboardShortcut(): void;
+        __experimental_clearPersistentStorage(persistenceKey?: string): void;
+        __experimental_createContentOfSaveFileTyped(projectId: string): __UNSTABLE_Project_OnDiskState;
+    };
+    initialize(opts?: Parameters<IStudio['initialize']>[0]): Promise<void>;
+    extend(extension: IExtension, opts?: {
+        __experimental_reconfigure?: boolean;
+    }): void;
+    transaction(fn: (api: ITransactionAPI) => void): void;
+    private _getSelectionPrism;
+    private _getSelection;
+    setSelection(selection: Array<ISheetObject | ISheet>): void;
+    onSelectionChange(fn: (s: (ISheetObject | ISheet)[]) => void): VoidFn;
+    get selection(): Array<ISheetObject | ISheet>;
+    scrub(): IScrub;
+    getStudioProject(): IProject;
+    debouncedScrub(threshold?: number): Pick<IScrub, 'capture'>;
+    createPane<PaneClass extends string>(paneClass: PaneClass): PaneInstance<PaneClass>;
+    destroyPane(paneId: string): void;
+    createContentOfSaveFile(projectId: string): Record<string, unknown>;
+}
+//# sourceMappingURL=TheatreStudio.d.ts.map

package/dist/TheatreStudio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TheatreStudio.d.ts","sourceRoot":"","sources":["../../../../studio/src/TheatreStudio.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAC,MAAM,+BAA+B,CAAA;AAC7F,OAAO,KAAK,EAAQ,OAAO,EAAC,MAAM,oCAAoC,CAAA;AAGtE,OAAO,KAAK,EAAkB,MAAM,EAAC,MAAM,6CAA6C,CAAA;AACxF,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,uCAAuC,CAAA;AAWjE,OAAO,KAAK,EAAC,cAAc,EAAY,MAAM,2CAA2C,CAAA;AAKxF,OAAO,KAAK,kBAAkB,MAAM,+DAA+D,CAAA;AACnG,OAAO,KAAK,YAAY,MAAM,mDAAmD,CAAA;AACjF,OAAO,KAAK,EAAC,8BAA8B,EAAC,MAAM,+BAA+B,CAAA;AAEjF,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAA;IAC3C;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;IAEnC;;;;;OAKG;IACH,2BAA2B,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAAA;IAE7D;;;;OAIG;IACH,0BAA0B,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAA;CACtD;AACD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAeb,KAAK,EAAE,CAAC,IAAI,EAAE;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,WAAW,CAAA;KAAC,KAAK,MAAM,IAAI,CAAA;CACjE;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,IAAI,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,QAAQ,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACjC,OAAO,EAAE,gBAAgB,EAAE,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAA;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,wBAAwB,EAAE,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,UAAU,GAClB,cAAc,GACd,gBAAgB,GAChB,oBAAoB,CAAA;AAExB,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,UAAU,CAAC,CAAA;AAE7C;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;;OAKG;IACH,QAAQ,CAAC,EAAE;SACR,GAAG,IAAI,QAAQ,GAAG,MAAM,GAAG,CAC1B,GAAG,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,EACpC,MAAM,EAAE,OAAO,KACZ,MAAM,IAAI;KAChB,CAAA;IAED;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;CACnC;AAED,MAAM,MAAM,YAAY,CAAC,SAAS,SAAS,MAAM,IAAI;IACnD,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,cAAc,CAAA;IAC1B,UAAU,EAAE,mBAAmB,CAAA;CAChC,CAAA;AAED,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,IAAI,IAAI,IAAI,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B;;OAEG;IACH,OAAO,IAAI,IAAI,CAAA;IAEf,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,MAAM,IAAI,CAAA;CACpE;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B,wBAAwB,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;CAClD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAA;IAEtB;;;OAGG;IACH,UAAU,CAAC,IAAI,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;IAE9C;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAA;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,IAAI,MAAM,CAAA;IAEf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAE3D;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,IAAI,CAAA;IAEhE;;OAEG;IACH,iBAAiB,CACf,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,IAAI,GAChD,YAAY,CAAA;IAEf;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAA;IAEpD;;OAEG;IACH,MAAM;IACJ;;OAEG;IACH,SAAS,EAAE,UAAU,EACrB,IAAI,CAAC,EAAE;QACL;;;;;;;;;;;WAWG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;KACrC,GACA,IAAI,CAAA;IAEP;;;;OAIG;IACH,UAAU,CAAC,SAAS,SAAS,MAAM,EACjC,SAAS,EAAE,SAAS,GACnB,YAAY,CAAC,SAAS,CAAC,CAAA;IAE1B;;;;;OAKG;IACH,gBAAgB,IAAI,QAAQ,CAAA;IAE5B;;;;;;;;;;;;;;;;;OAiBG;IACH,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEnE,cAAc,EAAE;QACd;;;;;WAKG;QACH,8CAA8C,IAAI,IAAI,CAAA;QACtD;;;;WAIG;QACH,8CAA8C,IAAI,IAAI,CAAA;QACtD;;;;;;WAMG;QACH,qCAAqC,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEpE;;;;;;;WAOG;QACH,2CAA2C,CACzC,SAAS,EAAE,MAAM,GAChB,8BAA8B,CAAA;KAClC,CAAA;CACF;AAED,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,OAAO;IACnD,QAAQ,CAAC,EAAE;;;;iCAagB,MAAM,YAAY,WAAW;MAGvD;IAED,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoB;IAE3C,cAAc;0DACsC,IAAI;0DAQJ,IAAI;+DAIC,MAAM,GAAG,IAAI;+DAIvD,MAAM,GAChB,8BAA8B;MAGlC;IAOD,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtE,MAAM,CACJ,SAAS,EAAE,UAAU,EACrB,IAAI,CAAC,EAAE;QAAC,0BAA0B,CAAC,EAAE,OAAO,CAAA;KAAC,GAC5C,IAAI;IAIP,WAAW,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI;IAmCrD,OAAO,CAAC,kBAAkB;IAa1B,OAAO,CAAC,aAAa;IAIrB,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,GAAG,IAAI;IAY3D,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,EAAE,KAAK,IAAI,GAAG,MAAM;IAMrE,IAAI,SAAS,IAAI,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,CAE5C;IAED,KAAK,IAAI,MAAM;IAIf,gBAAgB;IAUhB,cAAc,CAAC,SAAS,GAAE,MAAa,GAAG,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC;IA+BjE,UAAU,CAAC,SAAS,SAAS,MAAM,EACjC,SAAS,EAAE,SAAS,GACnB,YAAY,CAAC,SAAS,CAAC;IAI1B,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIjC,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAKpE"}

package/dist/TheatreStudio.js

@@ -0,0 +1,154 @@
+import { prism } from '@tomorrowevening/theatre-dataverse';
+import SimpleCache from '@tomorrowevening/theatre-shared/utils/SimpleCache';
+import { isSheetObjectPublicAPI, isSheetPublicAPI, } from '@tomorrowevening/theatre-shared/instanceTypes';
+import { getOutlineSelection } from './selectors';
+import getStudio from './getStudio';
+import { debounce } from 'lodash-es';
+import { __experimental_disblePlayPauseKeyboardShortcut, __experimental_enablePlayPauseKeyboardShortcut, } from './UIRoot/useKeyboardShortcuts';
+export default class TheatreStudio {
+    ui = {
+        hide() {
+            getStudio().ui.hide();
+        },
+        get isHidden() {
+            return getStudio().ui.isHidden;
+        },
+        restore() {
+            getStudio().ui.restore();
+        },
+        renderToolset(toolsetId, htmlNode) {
+            return getStudio().ui.renderToolset(toolsetId, htmlNode);
+        },
+    };
+    _cache = new SimpleCache();
+    __experimental = {
+        __experimental_disblePlayPauseKeyboardShortcut() {
+            // This is an experimental API to respond to this issue: https://discord.com/channels/870988717190426644/870988717190426647/1067906775602430062
+            // Ideally we need a coherent way for the user to control keyboard inputs, so we will remove this method in the future.
+            // Here is the procedure for removing it:
+            // 1. Replace this code with a `throw new Error("This is experimental method is now deprecated, and here is how to migrate: ...")`
+            // 2. Then keep it for a few months, and then remove it.
+            __experimental_disblePlayPauseKeyboardShortcut();
+        },
+        __experimental_enablePlayPauseKeyboardShortcut() {
+            // see __experimental_disblePlayPauseKeyboardShortcut()
+            __experimental_enablePlayPauseKeyboardShortcut();
+        },
+        __experimental_clearPersistentStorage(persistenceKey) {
+            return getStudio().clearPersistentStorage(persistenceKey);
+        },
+        __experimental_createContentOfSaveFileTyped(projectId) {
+            return getStudio().createContentOfSaveFile(projectId);
+        },
+    };
+    /**
+     * @internal
+     */
+    constructor(internals) { }
+    initialize(opts) {
+        const studio = getStudio();
+        return studio.initialize(opts);
+    }
+    extend(extension, opts) {
+        getStudio().extend(extension, opts);
+    }
+    transaction(fn) {
+        return getStudio().transaction(({ set, unset, stateEditors }) => {
+            const __experimental_forgetObject = (object) => {
+                if (!isSheetObjectPublicAPI(object)) {
+                    throw new Error(`object in transactionApi.__experimental_forgetObject(object) must be the return type of sheet.object(...)`);
+                }
+                stateEditors.coreByProject.historic.sheetsById.forgetObject(object.address);
+            };
+            const __experimental_forgetSheet = (sheet) => {
+                if (!isSheetPublicAPI(sheet)) {
+                    throw new Error(`sheet in transactionApi.__experimental_forgetSheet(sheet) must be the return type of project.sheet()`);
+                }
+                stateEditors.coreByProject.historic.sheetsById.forgetSheet(sheet.address);
+            };
+            return fn({
+                set,
+                unset,
+                __experimental_forgetObject,
+                __experimental_forgetSheet,
+            });
+        });
+    }
+    _getSelectionPrism() {
+        return this._cache.get('_getSelectionPrism()', () => prism(() => {
+            return getOutlineSelection()
+                .filter((s) => s.type === 'Theatre_SheetObject' || s.type === 'Theatre_Sheet')
+                .map((s) => s.publicApi);
+        }));
+    }
+    _getSelection() {
+        return this._getSelectionPrism().getValue();
+    }
+    setSelection(selection) {
+        const sanitizedSelection = [...selection]
+            .filter((s) => isSheetObjectPublicAPI(s) || isSheetPublicAPI(s))
+            .map((s) => getStudio().corePrivateAPI(s));
+        getStudio().transaction(({ stateEditors }) => {
+            stateEditors.studio.historic.panels.outline.selection.set(sanitizedSelection);
+        });
+    }
+    onSelectionChange(fn) {
+        const studio = getStudio();
+        return this._getSelectionPrism().onChange(studio.ticker, fn, true);
+    }
+    get selection() {
+        return this._getSelection();
+    }
+    scrub() {
+        return getStudio().scrub();
+    }
+    getStudioProject() {
+        const core = getStudio().core;
+        if (!core) {
+            throw new Error(`You're calling studio.getStudioProject() before \`@tomorrowevening/theatre-core\` is loaded. To fix this:
+1. Check if \`@tomorrowevening/theatre-core\` is import/required in your bundle.
+2. Check the stack trace of this error and make sure the funciton that calls getStudioProject() is run after \`@tomorrowevening/theatre-core\` is loaded.`);
+        }
+        return getStudio().getStudioProject(core);
+    }
+    debouncedScrub(threshold = 1000) {
+        let currentScrub;
+        const scheduleCommit = debounce(() => {
+            const s = currentScrub;
+            if (!s)
+                return;
+            currentScrub = undefined;
+            s.commit();
+        }, threshold);
+        const capture = (arg) => {
+            if (!currentScrub) {
+                currentScrub = this.scrub();
+            }
+            let errored = true;
+            try {
+                currentScrub.capture(arg);
+                errored = false;
+            }
+            finally {
+                if (errored) {
+                    const s = currentScrub;
+                    currentScrub = undefined;
+                    s.discard();
+                }
+                else {
+                    scheduleCommit();
+                }
+            }
+        };
+        return { capture };
+    }
+    createPane(paneClass) {
+        return getStudio().paneManager.createPane(paneClass);
+    }
+    destroyPane(paneId) {
+        return getStudio().paneManager.destroyPane(paneId);
+    }
+    createContentOfSaveFile(projectId) {
+        return getStudio().createContentOfSaveFile(projectId);
+    }
+}

package/dist/UI/UI.d.ts

@@ -0,0 +1,14 @@
+import type { Studio } from '@tomorrowevening/theatre-studio/Studio';
+export default class UI {
+    readonly studio: Studio;
+    private _rendered;
+    private _nonSSRBits;
+    readonly ready: Promise<void>;
+    constructor(studio: Studio);
+    render(): void;
+    hide(): void;
+    restore(): void;
+    get isHidden(): boolean;
+    renderToolset(toolsetId: string, htmlNode: HTMLElement): () => void;
+}
+//# sourceMappingURL=UI.d.ts.map

package/dist/UI/UI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UI.d.ts","sourceRoot":"","sources":["../../../../../studio/src/UI/UI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,wCAAwC,CAAA;AAQlE,MAAM,CAAC,OAAO,OAAO,EAAE;IAUT,QAAQ,CAAC,MAAM,EAAE,MAAM;IATnC,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,WAAW,CAEC;IACpB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAG5B;gBAEoB,MAAM,EAAE,MAAM;IAEnC,MAAM;IAgBN,IAAI;IAMJ,OAAO;IAOP,IAAI,QAAQ,YAIX;IAED,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW;CAuBvD"}

package/dist/UI/UI.js

@@ -0,0 +1,65 @@
+import { val } from '@tomorrowevening/theatre-dataverse';
+const NonSSRBitsClass = typeof window !== 'undefined'
+    ? import('./UINonSSRBits').then((M) => M.default)
+    : null;
+export default class UI {
+    studio;
+    _rendered = false;
+    _nonSSRBits = NonSSRBitsClass
+        ? NonSSRBitsClass.then((NonSSRBitsClass) => new NonSSRBitsClass())
+        : Promise.reject();
+    ready = this._nonSSRBits.then(() => undefined, () => undefined);
+    constructor(studio) {
+        this.studio = studio;
+    }
+    render() {
+        if (this._rendered) {
+            return;
+        }
+        this._rendered = true;
+        this._nonSSRBits
+            .then((b) => {
+            b.render();
+        })
+            .catch((err) => {
+            console.error(err);
+            throw err;
+        });
+    }
+    hide() {
+        this.studio.transaction(({ drafts }) => {
+            drafts.ahistoric.visibilityState = 'everythingIsHidden';
+        });
+    }
+    restore() {
+        this.render();
+        this.studio.transaction(({ drafts }) => {
+            drafts.ahistoric.visibilityState = 'everythingIsVisible';
+        });
+    }
+    get isHidden() {
+        return (val(this.studio.atomP.ahistoric.visibilityState) === 'everythingIsHidden');
+    }
+    renderToolset(toolsetId, htmlNode) {
+        let shouldUnmount = false;
+        let unmount = null;
+        this._nonSSRBits
+            .then((nonSSRBits) => {
+            if (shouldUnmount)
+                return; // unmount requested before the toolset is mounted, so, abort
+            unmount = nonSSRBits.renderToolset(toolsetId, htmlNode);
+        })
+            .catch((err) => {
+            console.error(err);
+        });
+        return () => {
+            if (unmount) {
+                unmount();
+                return;
+            }
+            if (shouldUnmount)
+                return;
+            shouldUnmount = true;
+        };
+    }
+}

package/dist/UI/UINonSSRBits.d.ts

@@ -0,0 +1,10 @@
+export default class UINonSSRBits {
+    readonly containerEl: HTMLDivElement;
+    private _renderTimeout;
+    private _documentBodyUIIsRenderedIn;
+    readonly containerShadow: ShadowRoot & HTMLElement;
+    constructor();
+    render(): void;
+    renderToolset(toolsetId: string, htmlNode: HTMLElement): () => void;
+}
+//# sourceMappingURL=UINonSSRBits.d.ts.map

package/dist/UI/UINonSSRBits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UINonSSRBits.d.ts","sourceRoot":"","sources":["../../../../../studio/src/UI/UINonSSRBits.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,QAAQ,CAAC,WAAW,iBAAgC;IACpD,OAAO,CAAC,cAAc,CAAsC;IAC5D,OAAO,CAAC,2BAA2B,CAAqC;IACxE,QAAQ,CAAC,eAAe,EAAE,UAAU,GAAG,WAAW,CAAA;;IAmClD,MAAM;IAgBN,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW;CAWvD"}