@twick/core 0.11.0

package/lib/events/EventDispatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventDispatcher.d.ts","sourceRoot":"","sources":["../../src/events/EventDispatcher.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAC,mBAAmB,EAAC,MAAM,uBAAuB,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,eAAe,CAAC,CAAC,CAAE,SAAQ,mBAAmB,CAAC,CAAC,CAAC;IACrD,QAAQ,CAAC,KAAK,EAAE,CAAC;CAGzB;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC"}

package/lib/events/EventDispatcher.js

@@ -0,0 +1,29 @@
+import { EventDispatcherBase } from './EventDispatcherBase';
+/**
+ * Dispatches a {@link SubscribableEvent}.
+ *
+ * @example
+ * ```ts
+ * class Example {
+ *   // expose the event to external classes
+ *   public get onValueChanged {
+ *     return this.value.subscribable;
+ *   }
+ *   // create a private dispatcher
+ *   private value = new EventDispatcher<number>();
+ *
+ *   private dispatchExample() {
+ *     // dispatching will notify all subscribers.
+ *     this.value.dispatch(0);
+ *   }
+ * }
+ * ```
+ *
+ * @typeParam T - The type of the value argument to subscribers.
+ */
+export class EventDispatcher extends EventDispatcherBase {
+    dispatch(value) {
+        this.notifySubscribers(value);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnREaXNwYXRjaGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2V2ZW50cy9FdmVudERpc3BhdGNoZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFDLG1CQUFtQixFQUFDLE1BQU0sdUJBQXVCLENBQUM7QUFFMUQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXFCRztBQUNILE1BQU0sT0FBTyxlQUFtQixTQUFRLG1CQUFzQjtJQUNyRCxRQUFRLENBQUMsS0FBUTtRQUN0QixJQUFJLENBQUMsaUJBQWlCLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDaEMsQ0FBQztDQUNGIn0=

package/lib/events/EventDispatcherBase.d.ts

@@ -0,0 +1,55 @@
+export interface EventHandler<T> {
+    (value: T): any;
+}
+/**
+ * A base for dispatching {@link Subscribable}s.
+ *
+ * @typeParam TValue - The type of the argument passed to subscribers.
+ * @typeParam THandler - The type of the callback function.
+ */
+export declare abstract class EventDispatcherBase<TValue, THandler extends EventHandler<TValue> = EventHandler<TValue>> {
+    readonly subscribable: Subscribable<TValue, THandler>;
+    private subscribers;
+    /**
+     * {@inheritDoc Subscribable.subscribe}
+     */
+    subscribe(handler: THandler): () => void;
+    /**
+     * {@inheritDoc Subscribable.unsubscribe}
+     */
+    unsubscribe(handler: THandler): void;
+    /**
+     * Unsubscribe all subscribers from the event.
+     */
+    clear(): void;
+    protected notifySubscribers(value: TValue): ReturnType<THandler>[];
+}
+/**
+ * Provides safe access to the public interface of {@link EventDispatcherBase}.
+ *
+ * @remarks
+ * External classes can use it to subscribe to an event without being able to
+ * dispatch it.
+ *
+ * @typeParam TValue - The type of the argument passed to subscribers.
+ * @typeParam THandler - The type of the callback function.
+ */
+export declare class Subscribable<TValue, THandler extends EventHandler<TValue> = EventHandler<TValue>> {
+    protected dispatcher: EventDispatcherBase<TValue, THandler>;
+    constructor(dispatcher: EventDispatcherBase<TValue, THandler>);
+    /**
+     * Subscribe to the event.
+     *
+     * @param handler - The handler to invoke when the event occurs.
+     *
+     * @returns A callback function that cancels the subscription.
+     */
+    subscribe(handler: THandler): () => void;
+    /**
+     * Unsubscribe from the event.
+     *
+     * @param handler - The handler to unsubscribe.
+     */
+    unsubscribe(handler: THandler): void;
+}
+//# sourceMappingURL=EventDispatcherBase.d.ts.map

package/lib/events/EventDispatcherBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventDispatcherBase.d.ts","sourceRoot":"","sources":["../../src/events/EventDispatcherBase.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,CAAC,KAAK,EAAE,CAAC,GAAG,GAAG,CAAC;CACjB;AAED;;;;;GAKG;AACH,8BAAsB,mBAAmB,CACvC,MAAM,EACN,QAAQ,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC;IAE5D,SAAgB,YAAY,EAAE,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CACnC;IAEzB,OAAO,CAAC,WAAW,CAAuB;IAE1C;;OAEG;IACI,SAAS,CAAC,OAAO,EAAE,QAAQ;IAKlC;;OAEG;IACI,WAAW,CAAC,OAAO,EAAE,QAAQ;IAIpC;;OAEG;IACI,KAAK;IAIZ,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,EAAE;CAGnE;AAED;;;;;;;;;GASG;AACH,qBAAa,YAAY,CACvB,MAAM,EACN,QAAQ,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC;IAG1D,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC;gBAAjD,UAAU,EAAE,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC;IAG7D;;;;;;OAMG;IACI,SAAS,CAAC,OAAO,EAAE,QAAQ;IAIlC;;;;OAIG;IACI,WAAW,CAAC,OAAO,EAAE,QAAQ;CAGrC"}

package/lib/events/EventDispatcherBase.js

@@ -0,0 +1,68 @@
+/**
+ * A base for dispatching {@link Subscribable}s.
+ *
+ * @typeParam TValue - The type of the argument passed to subscribers.
+ * @typeParam THandler - The type of the callback function.
+ */
+export class EventDispatcherBase {
+    constructor() {
+        this.subscribable = new Subscribable(this);
+        this.subscribers = new Set();
+    }
+    /**
+     * {@inheritDoc Subscribable.subscribe}
+     */
+    subscribe(handler) {
+        this.subscribers.add(handler);
+        return () => this.unsubscribe(handler);
+    }
+    /**
+     * {@inheritDoc Subscribable.unsubscribe}
+     */
+    unsubscribe(handler) {
+        this.subscribers.delete(handler);
+    }
+    /**
+     * Unsubscribe all subscribers from the event.
+     */
+    clear() {
+        this.subscribers.clear();
+    }
+    notifySubscribers(value) {
+        return [...this.subscribers].map(handler => handler(value));
+    }
+}
+/**
+ * Provides safe access to the public interface of {@link EventDispatcherBase}.
+ *
+ * @remarks
+ * External classes can use it to subscribe to an event without being able to
+ * dispatch it.
+ *
+ * @typeParam TValue - The type of the argument passed to subscribers.
+ * @typeParam THandler - The type of the callback function.
+ */
+export class Subscribable {
+    constructor(dispatcher) {
+        this.dispatcher = dispatcher;
+    }
+    /**
+     * Subscribe to the event.
+     *
+     * @param handler - The handler to invoke when the event occurs.
+     *
+     * @returns A callback function that cancels the subscription.
+     */
+    subscribe(handler) {
+        return this.dispatcher.subscribe(handler);
+    }
+    /**
+     * Unsubscribe from the event.
+     *
+     * @param handler - The handler to unsubscribe.
+     */
+    unsubscribe(handler) {
+        this.dispatcher.unsubscribe(handler);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnREaXNwYXRjaGVyQmFzZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9ldmVudHMvRXZlbnREaXNwYXRjaGVyQmFzZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFJQTs7Ozs7R0FLRztBQUNILE1BQU0sT0FBZ0IsbUJBQW1CO0lBQXpDO1FBSWtCLGlCQUFZLEdBQzFCLElBQUksWUFBWSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRWpCLGdCQUFXLEdBQUcsSUFBSSxHQUFHLEVBQVksQ0FBQztJQTJCNUMsQ0FBQztJQXpCQzs7T0FFRztJQUNJLFNBQVMsQ0FBQyxPQUFpQjtRQUNoQyxJQUFJLENBQUMsV0FBVyxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUM5QixPQUFPLEdBQUcsRUFBRSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDekMsQ0FBQztJQUVEOztPQUVHO0lBQ0ksV0FBVyxDQUFDLE9BQWlCO1FBQ2xDLElBQUksQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ25DLENBQUM7SUFFRDs7T0FFRztJQUNJLEtBQUs7UUFDVixJQUFJLENBQUMsV0FBVyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQzNCLENBQUM7SUFFUyxpQkFBaUIsQ0FBQyxLQUFhO1FBQ3ZDLE9BQU8sQ0FBQyxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQztJQUM5RCxDQUFDO0NBQ0Y7QUFFRDs7Ozs7Ozs7O0dBU0c7QUFDSCxNQUFNLE9BQU8sWUFBWTtJQUl2QixZQUNZLFVBQWlEO1FBQWpELGVBQVUsR0FBVixVQUFVLENBQXVDO0lBQzFELENBQUM7SUFFSjs7Ozs7O09BTUc7SUFDSSxTQUFTLENBQUMsT0FBaUI7UUFDaEMsT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUM1QyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLFdBQVcsQ0FBQyxPQUFpQjtRQUNsQyxJQUFJLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUN2QyxDQUFDO0NBQ0YifQ==

package/lib/events/FlagDispatcher.d.ts

@@ -0,0 +1,54 @@
+import type { EventHandler, Subscribable } from './EventDispatcherBase';
+import { EventDispatcherBase } from './EventDispatcherBase';
+/**
+ * Dispatches a {@link SubscribableFlagEvent}.
+ *
+ * @remarks
+ * Subscribers are notified only when the flag is set.
+ * Subsequent calls to {@link raise} don't trigger anything.
+ * Any handlers added while the flag is raised are immediately invoked.
+ *
+ * Resetting the flag doesn't notify the subscribers, but raising it again does.
+ *
+ * @example
+ * ```ts
+ * class Example {
+ *   // expose the event to external classes
+ *   public get onChanged {
+ *     return this.flag.subscribable;
+ *   }
+ *   // create a private dispatcher
+ *   private flag = new FlagDispatcher();
+ *
+ *   private dispatchExample() {
+ *     // setting the flag will notify all subscribers
+ *     this.flag.raise();
+ *   }
+ * }
+ * ```
+ */
+export declare class FlagDispatcher extends EventDispatcherBase<void> {
+    private value;
+    /**
+     * Notify all current and future subscribers.
+     */
+    raise(): void;
+    /**
+     * Stop notifying future subscribers.
+     */
+    reset(): void;
+    /**
+     * Are subscribers being notified?
+     */
+    isRaised(): boolean;
+    subscribe(handler: EventHandler<void>): () => void;
+}
+/**
+ * Provides safe access to the public interface of {@link FlagDispatcher}.
+ *
+ * @remarks
+ * External classes can use it to subscribe to an event without being able to
+ * dispatch it.
+ */
+export type SubscribableFlagEvent = Subscribable<void>;
+//# sourceMappingURL=FlagDispatcher.d.ts.map

package/lib/events/FlagDispatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlagDispatcher.d.ts","sourceRoot":"","sources":["../../src/events/FlagDispatcher.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAE,YAAY,EAAC,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAC,mBAAmB,EAAC,MAAM,uBAAuB,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,cAAe,SAAQ,mBAAmB,CAAC,IAAI,CAAC;IAC3D,OAAO,CAAC,KAAK,CAAS;IAEtB;;OAEG;IACI,KAAK;IAOZ;;OAEG;IACI,KAAK;IAIZ;;OAEG;IACI,QAAQ;IAIR,SAAS,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC;CAO7C;AAED;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC"}

package/lib/events/FlagDispatcher.js

@@ -0,0 +1,63 @@
+import { EventDispatcherBase } from './EventDispatcherBase';
+/**
+ * Dispatches a {@link SubscribableFlagEvent}.
+ *
+ * @remarks
+ * Subscribers are notified only when the flag is set.
+ * Subsequent calls to {@link raise} don't trigger anything.
+ * Any handlers added while the flag is raised are immediately invoked.
+ *
+ * Resetting the flag doesn't notify the subscribers, but raising it again does.
+ *
+ * @example
+ * ```ts
+ * class Example {
+ *   // expose the event to external classes
+ *   public get onChanged {
+ *     return this.flag.subscribable;
+ *   }
+ *   // create a private dispatcher
+ *   private flag = new FlagDispatcher();
+ *
+ *   private dispatchExample() {
+ *     // setting the flag will notify all subscribers
+ *     this.flag.raise();
+ *   }
+ * }
+ * ```
+ */
+export class FlagDispatcher extends EventDispatcherBase {
+    constructor() {
+        super(...arguments);
+        this.value = false;
+    }
+    /**
+     * Notify all current and future subscribers.
+     */
+    raise() {
+        if (!this.value) {
+            this.value = true;
+            this.notifySubscribers();
+        }
+    }
+    /**
+     * Stop notifying future subscribers.
+     */
+    reset() {
+        this.value = false;
+    }
+    /**
+     * Are subscribers being notified?
+     */
+    isRaised() {
+        return this.value;
+    }
+    subscribe(handler) {
+        const unsubscribe = super.subscribe(handler);
+        if (this.value) {
+            handler();
+        }
+        return unsubscribe;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRmxhZ0Rpc3BhdGNoZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZXZlbnRzL0ZsYWdEaXNwYXRjaGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBQyxtQkFBbUIsRUFBQyxNQUFNLHVCQUF1QixDQUFDO0FBRTFEOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQTBCRztBQUNILE1BQU0sT0FBTyxjQUFlLFNBQVEsbUJBQXlCO0lBQTdEOztRQUNVLFVBQUssR0FBRyxLQUFLLENBQUM7SUFpQ3hCLENBQUM7SUEvQkM7O09BRUc7SUFDSSxLQUFLO1FBQ1YsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQztZQUNoQixJQUFJLENBQUMsS0FBSyxHQUFHLElBQUksQ0FBQztZQUNsQixJQUFJLENBQUMsaUJBQWlCLEVBQUUsQ0FBQztRQUMzQixDQUFDO0lBQ0gsQ0FBQztJQUVEOztPQUVHO0lBQ0ksS0FBSztRQUNWLElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFDO0lBQ3JCLENBQUM7SUFFRDs7T0FFRztJQUNJLFFBQVE7UUFDYixPQUFPLElBQUksQ0FBQyxLQUFLLENBQUM7SUFDcEIsQ0FBQztJQUVNLFNBQVMsQ0FBQyxPQUEyQjtRQUMxQyxNQUFNLFdBQVcsR0FBRyxLQUFLLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQzdDLElBQUksSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQ2YsT0FBTyxFQUFFLENBQUM7UUFDWixDQUFDO1FBQ0QsT0FBTyxXQUFXLENBQUM7SUFDckIsQ0FBQztDQUNGIn0=

package/lib/events/ValueDispatcher.d.ts

@@ -0,0 +1,81 @@
+import type { EventHandler } from './EventDispatcherBase';
+import { EventDispatcherBase, Subscribable } from './EventDispatcherBase';
+/**
+ * Dispatches a {@link SubscribableValueEvent}
+ *
+ * @remarks
+ * Changing the value stored by a value dispatcher will immediately notify all
+ * its subscribers.
+ *
+ * @example
+ * ```ts
+ * class Example {
+ *   // expose the event to external classes
+ *   public get onValueChanged {
+ *     return this.value.subscribable;
+ *   }
+ *   // create a private dispatcher
+ *   private value = new ValueDispatcher(0);
+ *
+ *   private changingValueExample() {
+ *     // changing the value will notify all subscribers.
+ *     this.value.current = 7;
+ *   }
+ * }
+ * ```
+ *
+ * @typeParam T - The type of the value passed to subscribers.
+ */
+export declare class ValueDispatcher<T> extends EventDispatcherBase<T> {
+    private value;
+    readonly subscribable: SubscribableValueEvent<T>;
+    /**
+     * {@inheritDoc SubscribableValueEvent.current}
+     */
+    get current(): T;
+    /**
+     * Set the current value of this dispatcher.
+     *
+     * @remarks
+     * Setting the value will immediately notify all subscribers.
+     *
+     * @param value - The new value.
+     */
+    set current(value: T);
+    /**
+     * @param value - The initial value.
+     */
+    constructor(value: T);
+    /**
+     * {@inheritDoc SubscribableValueEvent.subscribe}
+     */
+    subscribe(handler: EventHandler<T>, dispatchImmediately?: boolean): () => void;
+}
+/**
+ * Provides safe access to the public interface of {@link ValueDispatcher}.
+ *
+ * @remarks
+ * External classes can use it to subscribe to an event without being able to
+ * dispatch it.
+ *
+ * @typeParam T - The type of the value passed to subscribers.
+ */
+export declare class SubscribableValueEvent<T> extends Subscribable<T, EventHandler<T>> {
+    /**
+     * Get the most recent value of this dispatcher.
+     */
+    get current(): T;
+    /**
+     * Subscribe to the event.
+     *
+     * Subscribing will immediately invoke the handler with the most recent value.
+     *
+     * @param handler - The handler to invoke when the event occurs.
+     * @param dispatchImmediately - Whether the handler should be immediately
+     *                              invoked with the most recent value.
+     *
+     * @returns Callback function that cancels the subscription.
+     */
+    subscribe(handler: EventHandler<T>, dispatchImmediately?: boolean): () => void;
+}
+//# sourceMappingURL=ValueDispatcher.d.ts.map

package/lib/events/ValueDispatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValueDispatcher.d.ts","sourceRoot":"","sources":["../../src/events/ValueDispatcher.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAC,mBAAmB,EAAE,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,eAAe,CAAC,CAAC,CAAE,SAAQ,mBAAmB,CAAC,CAAC,CAAC;IA2BzC,OAAO,CAAC,KAAK;IA1BhC,SAAgB,YAAY,EAAE,sBAAsB,CAAC,CAAC,CAAC,CACpB;IAEnC;;OAEG;IACH,IAAW,OAAO,IAYQ,CAAC,CAV1B;IAED;;;;;;;OAOG;IACH,IAAW,OAAO,CAAC,KAAK,EAAE,CAAC,EAG1B;IAED;;OAEG;gBACwB,KAAK,EAAE,CAAC;IAInC;;OAEG;IACI,SAAS,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,mBAAmB,UAAO;CAOtE;AAED;;;;;;;;GAQG;AACH,qBAAa,sBAAsB,CAAC,CAAC,CAAE,SAAQ,YAAY,CACzD,CAAC,EACD,YAAY,CAAC,CAAC,CAAC,CAChB;IACC;;OAEG;IACH,IAAW,OAAO,MAEjB;IAED;;;;;;;;;;OAUG;IACI,SAAS,CACd,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EACxB,mBAAmB,UAAO,GACzB,MAAM,IAAI;CAMd"}

package/lib/events/ValueDispatcher.js

@@ -0,0 +1,97 @@
+import { EventDispatcherBase, Subscribable } from './EventDispatcherBase';
+/**
+ * Dispatches a {@link SubscribableValueEvent}
+ *
+ * @remarks
+ * Changing the value stored by a value dispatcher will immediately notify all
+ * its subscribers.
+ *
+ * @example
+ * ```ts
+ * class Example {
+ *   // expose the event to external classes
+ *   public get onValueChanged {
+ *     return this.value.subscribable;
+ *   }
+ *   // create a private dispatcher
+ *   private value = new ValueDispatcher(0);
+ *
+ *   private changingValueExample() {
+ *     // changing the value will notify all subscribers.
+ *     this.value.current = 7;
+ *   }
+ * }
+ * ```
+ *
+ * @typeParam T - The type of the value passed to subscribers.
+ */
+export class ValueDispatcher extends EventDispatcherBase {
+    /**
+     * {@inheritDoc SubscribableValueEvent.current}
+     */
+    get current() {
+        return this.value;
+    }
+    /**
+     * Set the current value of this dispatcher.
+     *
+     * @remarks
+     * Setting the value will immediately notify all subscribers.
+     *
+     * @param value - The new value.
+     */
+    set current(value) {
+        this.value = value;
+        this.notifySubscribers(value);
+    }
+    /**
+     * @param value - The initial value.
+     */
+    constructor(value) {
+        super();
+        this.value = value;
+        this.subscribable = new SubscribableValueEvent(this);
+    }
+    /**
+     * {@inheritDoc SubscribableValueEvent.subscribe}
+     */
+    subscribe(handler, dispatchImmediately = true) {
+        const unsubscribe = super.subscribe(handler);
+        if (dispatchImmediately) {
+            handler(this.value);
+        }
+        return unsubscribe;
+    }
+}
+/**
+ * Provides safe access to the public interface of {@link ValueDispatcher}.
+ *
+ * @remarks
+ * External classes can use it to subscribe to an event without being able to
+ * dispatch it.
+ *
+ * @typeParam T - The type of the value passed to subscribers.
+ */
+export class SubscribableValueEvent extends Subscribable {
+    /**
+     * Get the most recent value of this dispatcher.
+     */
+    get current() {
+        return this.dispatcher.current;
+    }
+    /**
+     * Subscribe to the event.
+     *
+     * Subscribing will immediately invoke the handler with the most recent value.
+     *
+     * @param handler - The handler to invoke when the event occurs.
+     * @param dispatchImmediately - Whether the handler should be immediately
+     *                              invoked with the most recent value.
+     *
+     * @returns Callback function that cancels the subscription.
+     */
+    subscribe(handler, dispatchImmediately = true) {
+        return this.dispatcher.subscribe(handler, dispatchImmediately);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVmFsdWVEaXNwYXRjaGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2V2ZW50cy9WYWx1ZURpc3BhdGNoZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFDLG1CQUFtQixFQUFFLFlBQVksRUFBQyxNQUFNLHVCQUF1QixDQUFDO0FBRXhFOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBeUJHO0FBQ0gsTUFBTSxPQUFPLGVBQW1CLFNBQVEsbUJBQXNCO0lBSTVEOztPQUVHO0lBQ0gsSUFBVyxPQUFPO1FBQ2hCLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQztJQUNwQixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNILElBQVcsT0FBTyxDQUFDLEtBQVE7UUFDekIsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLENBQUM7UUFDbkIsSUFBSSxDQUFDLGlCQUFpQixDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ2hDLENBQUM7SUFFRDs7T0FFRztJQUNILFlBQTJCLEtBQVE7UUFDakMsS0FBSyxFQUFFLENBQUM7UUFEaUIsVUFBSyxHQUFMLEtBQUssQ0FBRztRQTFCbkIsaUJBQVksR0FDMUIsSUFBSSxzQkFBc0IsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQTJCbkMsQ0FBQztJQUVEOztPQUVHO0lBQ0ksU0FBUyxDQUFDLE9BQXdCLEVBQUUsbUJBQW1CLEdBQUcsSUFBSTtRQUNuRSxNQUFNLFdBQVcsR0FBRyxLQUFLLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQzdDLElBQUksbUJBQW1CLEVBQUUsQ0FBQztZQUN4QixPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQ3RCLENBQUM7UUFDRCxPQUFPLFdBQVcsQ0FBQztJQUNyQixDQUFDO0NBQ0Y7QUFFRDs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sT0FBTyxzQkFBMEIsU0FBUSxZQUc5QztJQUNDOztPQUVHO0lBQ0gsSUFBVyxPQUFPO1FBQ2hCLE9BQTRCLElBQUksQ0FBQyxVQUFXLENBQUMsT0FBTyxDQUFDO0lBQ3ZELENBQUM7SUFFRDs7Ozs7Ozs7OztPQVVHO0lBQ0ksU0FBUyxDQUNkLE9BQXdCLEVBQ3hCLG1CQUFtQixHQUFHLElBQUk7UUFFMUIsT0FBNEIsSUFBSSxDQUFDLFVBQVcsQ0FBQyxTQUFTLENBQ3BELE9BQU8sRUFDUCxtQkFBbUIsQ0FDcEIsQ0FBQztJQUNKLENBQUM7Q0FDRiJ9

package/lib/events/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Subscriptions and triggering of events.
+ *
+ * @packageDocumentation
+ */
+export * from './AsyncEventDispatcher';
+export * from './EventDispatcher';
+export * from './EventDispatcherBase';
+export * from './FlagDispatcher';
+export * from './ValueDispatcher';
+//# sourceMappingURL=index.d.ts.map

package/lib/events/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}

package/lib/events/index.js

@@ -0,0 +1,11 @@
+/**
+ * Subscriptions and triggering of events.
+ *
+ * @packageDocumentation
+ */
+export * from './AsyncEventDispatcher';
+export * from './EventDispatcher';
+export * from './EventDispatcherBase';
+export * from './FlagDispatcher';
+export * from './ValueDispatcher';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZXZlbnRzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOzs7O0dBSUc7QUFFSCxjQUFjLHdCQUF3QixDQUFDO0FBQ3ZDLGNBQWMsbUJBQW1CLENBQUM7QUFDbEMsY0FBYyx1QkFBdUIsQ0FBQztBQUN0QyxjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsbUJBQW1CLENBQUMifQ==

package/lib/exporter/Exporter.d.ts

@@ -0,0 +1,101 @@
+import type { Project } from '../app/Project';
+import type { AssetInfo, RendererResult, RendererSettings } from '../app/Renderer';
+/**
+ * The static interface for exporters.
+ */
+export interface ExporterClass {
+    /**
+     * The unique identifier of this exporter.
+     *
+     * @remarks
+     * This identifier will be used to store the settings of this exporter.
+     * It's recommended to prepend it with the name of the package to avoid
+     * collisions.
+     */
+    readonly id: string;
+    /**
+     * The name of this exporter.
+     *
+     * @remarks
+     * This name will be displayed in the editor.
+     */
+    readonly displayName: string;
+    /**
+     * Create an instance of this exporter.
+     *
+     * @remarks
+     * A new exporter is created whenever the user starts a new rendering process.
+     *
+     * @param project - The current project.
+     * @param settings - The rendering settings.
+     */
+    create(project: Project, settings: RendererSettings): Promise<Exporter>;
+}
+/**
+ * The main interface for implementing custom exporters.
+ */
+export interface Exporter {
+    /**
+     * Prepare the rendering configuration.
+     *
+     * @remarks
+     * Called at the beginning of the rendering process, before anything else has
+     * been set up. The returned value can be used to override the rendering
+     * settings provided by the user.
+     */
+    configuration?(): Promise<RendererSettings | void>;
+    /**
+     * Begin the rendering process.
+     *
+     * @remarks
+     * Called after the rendering has been set up, right before the first frame
+     * is rendered. Once `start()` is called, it is guaranteed that the `stop()`
+     * method will be called as well. Can be used to initialize any resources that
+     * require a clean-up.
+     */
+    start?(): Promise<void>;
+    /**
+     * Export a frame.
+     *
+     * @remarks
+     * Called each time after a frame is rendered.
+     *
+     * @param canvas - A canvas containing the rendered frame.
+     * @param frame - The frame number.
+     * @param sceneFrame - The frame number within the scene.
+     * @param sceneName - The name of the scene with which the frame is associated.
+     * @param signal - An abort signal triggered if the user aborts the rendering.
+     */
+    handleFrame(canvas: HTMLCanvasElement, frame: number, sceneFrame: number, sceneName: string, signal: AbortSignal): Promise<void>;
+    /**
+     * after processing the image stream and generating an audio file, merge the video and audio stream as the final video
+     */
+    mergeMedia?(): Promise<void>;
+    /**
+     * Take in media assets per frame and generate audio track for the video.
+     */
+    generateAudio?(assetsInfo: AssetInfo[][], startFrame: number, endFrame: number): Promise<void>;
+    /**
+     * Download all assets necessary for the export process
+     */
+    downloadVideos?(assetsInfo: AssetInfo[][]): Promise<void>;
+    /**
+     * Finish the rendering process.
+     *
+     * @remarks
+     * Called after rendering the visual elements has finished and audio so that audio track can be merged.
+     *
+     * @param result - The result of the rendering.
+     */
+    stop?(result: RendererResult): Promise<void>;
+    /**
+     * Finish the rendering process.
+     *
+     * @remarks
+     * Guaranteed to be called after the rendering has finished - no matter the
+     * result. Performs clean-up.
+     *
+     */
+    kill?(): Promise<void>;
+}
+//# sourceMappingURL=Exporter.d.ts.map

package/lib/exporter/Exporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Exporter.d.ts","sourceRoot":"","sources":["../../src/exporter/Exporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EACV,SAAS,EACT,cAAc,EACd,gBAAgB,EACjB,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACzE;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;;;OAOG;IACH,aAAa,CAAC,IAAI,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAEnD;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,WAAW,CACT,MAAM,EAAE,iBAAiB,EACzB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,CACZ,UAAU,EAAE,SAAS,EAAE,EAAE,EACzB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;OAEG;IACH,cAAc,CAAC,CAAC,UAAU,EAAE,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;;;;;OAOG;IACH,IAAI,CAAC,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;;OAOG;IACH,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB"}

package/lib/exporter/Exporter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXhwb3J0ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZXhwb3J0ZXIvRXhwb3J0ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/lib/exporter/FFmpegExporter.d.ts

@@ -0,0 +1,50 @@
+import type { Project } from '../app/Project';
+import type { AssetInfo, RendererResult, RendererSettings } from '../app/Renderer';
+import type { Exporter } from './Exporter';
+export interface FfmpegExporterOptions {
+    format: 'mp4' | 'webm' | 'proRes';
+}
+/**
+ * FFmpeg video exporter.
+ *
+ * @remarks
+ * Most of the export logic is handled on the server. This class communicates
+ * with the FFmpegBridge through a WebSocket connection which lets it invoke
+ * methods on the FFmpegExporterServer class.
+ *
+ * For example, calling the following method:
+ * ```ts
+ * async this.invoke('process', 7);
+ * ```
+ * Will invoke the `process` method on the FFmpegExporterServer class with `7`
+ * as the argument. The result of the method will be returned as a Promise.
+ *
+ * Before any methods can be invoked, the FFmpegExporterServer class must be
+ * initialized by invoking `start`.
+ */
+export declare class FFmpegExporterClient implements Exporter {
+    static readonly id = "@twick/core/ffmpeg";
+    static readonly displayName = "Video (FFmpeg)";
+    private readonly settings;
+    private readonly exporterOptions;
+    static create(_: Project, settings: RendererSettings): Promise<FFmpegExporterClient>;
+    private static readonly response;
+    constructor(settings: RendererSettings);
+    start(): Promise<void>;
+    handleFrame(canvas: HTMLCanvasElement): Promise<void>;
+    private blobToDataUrl;
+    stop(result: RendererResult): Promise<void>;
+    kill(): Promise<void>;
+    downloadVideos(assets: AssetInfo[][]): Promise<void>;
+    generateAudio(assets: AssetInfo[][], startFrame: number, endFrame: number): Promise<void>;
+    mergeMedia(): Promise<void>;
+    /**
+     * Remotely invoke a method on the server and wait for a response.
+     *
+     * @param method - The method name to execute on the server.
+     * @param data - The data that will be passed as an argument to the method.
+     *               Should be serializable.
+     */
+    private invoke;
+}
+//# sourceMappingURL=FFmpegExporter.d.ts.map

package/lib/exporter/FFmpegExporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FFmpegExporter.d.ts","sourceRoot":"","sources":["../../src/exporter/FFmpegExporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EACV,SAAS,EACT,cAAc,EACd,gBAAgB,EACjB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AAezC,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,oBAAqB,YAAW,QAAQ;IACnD,gBAAuB,EAAE,wBAAwB;IACjD,gBAAuB,WAAW,oBAAoB;IAEtD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAwB;WAEpC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,gBAAgB;IAIjE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAyC;gBAWtD,QAAQ,EAAE,gBAAgB;IAQhC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;YAepD,aAAa;IASd,IAAI,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAY3C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpD,aAAa,CACxB,MAAM,EAAE,SAAS,EAAE,EAAE,EACrB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAaH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAexC;;;;;;OAMG;IACH,OAAO,CAAC,MAAM;CA6Bf"}