@quenk/frontend 0.20.1

package/lib/app/scene/dialog/confirm.d.ts

@@ -0,0 +1,39 @@
+import { Address } from '@quenk/potoo/lib/actor/address';
+import { Runtime } from '@quenk/potoo/lib/actor/system/vm/runtime';
+import { Dialog, DialogEventFunc, DialogEventHandler, DialogEvent } from './';
+/**
+ * ConfirmDialogEventHandler is the allowed types for confirm dialog event
+ * targets.
+ */
+export type ConfirmDialogEventTarget = DialogEventFunc | Address | DialogEventHandler;
+/**
+ * ConfirmDialogEventHandler is an object that can receive confirm dialog events.
+ */
+export interface ConfirmDialogEventHandler extends DialogEventHandler {
+    /**
+     * onAccept is called when the dialog is closed positively..
+     */
+    onAccept(e: DialogConfirmed): void;
+}
+/**
+ * DialogConfirmed indicates
+ */
+export declare class DialogConfirmed extends DialogEvent {
+}
+/**
+ * ConfirmDialog provides a dialog actor oriented towards the confirmation of
+ * some action or event.
+ *
+ * Use it to display forms or information that needs to be confirmed before
+ * committed. Use the accept() method for confirmation or close() for cancel.
+ */
+export declare abstract class ConfirmDialog extends Dialog {
+    runtime: Runtime;
+    display: Address;
+    target: ConfirmDialogEventTarget;
+    constructor(runtime: Runtime, display: Address, target?: ConfirmDialogEventTarget);
+    /**
+     * confirm the dialog firing an event to the target.
+     */
+    confirm(): void;
+}

package/lib/app/scene/dialog/confirm.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfirmDialog = exports.DialogConfirmed = void 0;
+const display_1 = require("../../display");
+const _1 = require("./");
+/**
+ * DialogConfirmed indicates
+ */
+class DialogConfirmed extends _1.DialogEvent {
+}
+exports.DialogConfirmed = DialogConfirmed;
+/**
+ * ConfirmDialog provides a dialog actor oriented towards the confirmation of
+ * some action or event.
+ *
+ * Use it to display forms or information that needs to be confirmed before
+ * committed. Use the accept() method for confirmation or close() for cancel.
+ */
+class ConfirmDialog extends _1.Dialog {
+    constructor(runtime, display, target = '?') {
+        super(runtime, display, target);
+        this.runtime = runtime;
+        this.display = display;
+        this.target = target;
+    }
+    /**
+     * confirm the dialog firing an event to the target.
+     */
+    confirm() {
+        this.tell(this.display, new display_1.Close(this.name));
+        this.fire(new DialogConfirmed(this.name));
+        this.exit();
+    }
+}
+exports.ConfirmDialog = ConfirmDialog;
+//# sourceMappingURL=confirm.js.map

package/lib/app/scene/dialog/confirm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"confirm.js","sourceRoot":"","sources":["../../../../src/app/scene/dialog/confirm.ts"],"names":[],"mappings":";;;AAGA,2CAAsC;AACtC,yBAKY;AAwBZ;;GAEG;AACH,MAAa,eAAgB,SAAQ,cAAW;CAAI;AAApD,0CAAoD;AAEpD;;;;;;GAMG;AACH,MAAsB,aAAc,SAAQ,SAAM;IAE9C,YACW,OAAgB,EAChB,OAAgB,EAChB,SAAmC,GAAG;QAE7C,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAJzB,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAgC;IAIjD,CAAC;IAED;;OAEG;IACH,OAAO;QAEH,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,EAAE,CAAC;IAEhB,CAAC;CAEJ;AAtBD,sCAsBC"}

package/lib/app/scene/dialog/index.d.ts

@@ -0,0 +1,65 @@
+import { Runtime } from '@quenk/potoo/lib/actor/system/vm/runtime';
+import { Address } from '@quenk/potoo/lib/actor/address';
+import { AppScene } from '../';
+/**
+ * DialogName indicates the name of a dialog.
+ */
+export type DialogName = string;
+/**
+ * DialogEventTarget is the allowed types for dialog event targets.
+ */
+export type DialogEventTarget = DialogEventFunc | Address | DialogEventHandler;
+/**
+ * DialogEventFunc can be invoked to receive dialog events.
+ */
+export type DialogEventFunc = (e: DialogEvent) => void;
+/**
+ * DialogEventHandler is an object that can receive dialog events.
+ */
+export interface DialogEventHandler {
+    /**
+     * onClose is invoked when the dialog is closed.
+     */
+    onClose(e: DialogEvent): void;
+}
+/**
+ * DialogEvent is the base class of event classes used to indicate a change in
+ * a dialog's lifecycle.
+ *
+ * A basic dialog's lifecycle is open -> closed. However no events are fired for
+ * open.
+ */
+export declare abstract class DialogEvent {
+    name: DialogName;
+    constructor(name: DialogName);
+}
+/**
+ * DialogClosed indicates a dialog has been closed.
+ */
+export declare class DialogClosed extends DialogEvent {
+}
+/**
+ * Dialog provides an actor meant to serve as the "controller" for a dialog
+ * view displayed to the user.
+ *
+ * It does not concern itself with the details of actually getting the view on
+ * screen, instead it leaves that up to the provided display actor's address.
+ * If a handler is provided, it will receive an event when the dialog closes.
+ */
+export declare abstract class Dialog extends AppScene {
+    runtime: Runtime;
+    display: Address;
+    target: DialogEventTarget;
+    constructor(runtime: Runtime, display: Address, target?: DialogEventTarget);
+    /**
+     * fire an event to the [[DialogEventTarget]].
+     */
+    fire(e: DialogEvent): void;
+    /**
+     * close this dialog.
+     *
+     * Tells the display to close the view and will exit this actor.
+     */
+    close(): void;
+    run(): Promise<void>;
+}

package/lib/app/scene/dialog/index.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Dialog = exports.DialogClosed = exports.DialogEvent = void 0;
+const type_1 = require("@quenk/noni/lib/data/type");
+const display_1 = require("../../display");
+const __1 = require("../");
+/**
+ * DialogEvent is the base class of event classes used to indicate a change in
+ * a dialog's lifecycle.
+ *
+ * A basic dialog's lifecycle is open -> closed. However no events are fired for
+ * open.
+ */
+class DialogEvent {
+    constructor(name) {
+        this.name = name;
+    }
+}
+exports.DialogEvent = DialogEvent;
+/**
+ * DialogClosed indicates a dialog has been closed.
+ */
+class DialogClosed extends DialogEvent {
+}
+exports.DialogClosed = DialogClosed;
+/**
+ * Dialog provides an actor meant to serve as the "controller" for a dialog
+ * view displayed to the user.
+ *
+ * It does not concern itself with the details of actually getting the view on
+ * screen, instead it leaves that up to the provided display actor's address.
+ * If a handler is provided, it will receive an event when the dialog closes.
+ */
+class Dialog extends __1.AppScene {
+    constructor(runtime, display, target = '?') {
+        super(runtime);
+        this.runtime = runtime;
+        this.display = display;
+        this.target = target;
+    }
+    /**
+     * fire an event to the [[DialogEventTarget]].
+     */
+    fire(e) {
+        if ((0, type_1.isString)(this.target)) {
+            this.tell(this.target, e);
+        }
+        else if ((0, type_1.isFunction)(this.target)) {
+            this.target(e);
+        }
+        else if ((0, type_1.isObject)(this.target)) {
+            // Todo: This is too specific, maybe onEvent instead?
+            this.target.onClose(e);
+        }
+    }
+    /**
+     * close this dialog.
+     *
+     * Tells the display to close the view and will exit this actor.
+     */
+    close() {
+        this.tell(this.display, new display_1.Close(this.name));
+        this.fire(new DialogClosed(this.name));
+        this.exit();
+    }
+    async run() {
+        this.tell(this.display, new display_1.Show(this.name, this.view, this.self));
+    }
+}
+exports.Dialog = Dialog;
+//# sourceMappingURL=index.js.map

package/lib/app/scene/dialog/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/app/scene/dialog/index.ts"],"names":[],"mappings":";;;AAAA,oDAA2E;AAK3E,2CAA4C;AAC5C,2BAAgC;AAiChC;;;;;;GAMG;AACH,MAAsB,WAAW;IAE7B,YAAmB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAI,CAAC;CAE3C;AAJD,kCAIC;AAED;;GAEG;AACH,MAAa,YAAa,SAAQ,WAAW;CAAI;AAAjD,oCAAiD;AAEjD;;;;;;;GAOG;AACH,MAAsB,MAAO,SAAQ,YAAQ;IAEzC,YACW,OAAgB,EAChB,OAAgB,EAChB,SAA4B,GAAG;QAAI,KAAK,CAAC,OAAO,CAAC,CAAC;QAFlD,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAyB;IAAoB,CAAC;IAE/D;;OAEG;IACH,IAAI,CAAC,CAAc;QAEf,IAAI,IAAA,eAAQ,EAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAExB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAE9B,CAAC;aAAM,IAAI,IAAA,iBAAU,EAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAEjC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAEnB,CAAC;aAAM,IAAI,IAAA,eAAQ,EAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAE/B,qDAAqD;YAChC,IAAI,CAAC,MAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEjD,CAAC;IAEL,CAAC;IAED;;;;OAIG;IACH,KAAK;QAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,EAAE,CAAC;IAEhB,CAAC;IAED,KAAK,CAAC,GAAG;QAEL,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAEvE,CAAC;CAEJ;AAhDD,wBAgDC"}

package/lib/app/scene/director.d.ts

@@ -0,0 +1,90 @@
+import { Default, TypeCase } from '@quenk/noni/lib/control/match/case';
+import { Object } from '@quenk/noni/lib/data/jsonx';
+import { Address } from '@quenk/potoo/lib/actor/address';
+import { Immutable } from '@quenk/potoo/lib/actor/framework/resident';
+import { Runtime } from '@quenk/potoo/lib/actor/system/vm/runtime';
+import { Spawnable } from '@quenk/potoo/lib/actor/template';
+/**
+ * SceneId is an identifier used to indicate which scene should be shown.
+ *
+ * This is not necessarily an actor address but can be.
+ */
+export type SceneId = string;
+/**
+ * SceneProvider is a function that takes a Signal and returns a Spawnable
+ * for creating the scene actor.
+ */
+export type SceneProvider = (sig: Signal) => Spawnable;
+/**
+ * SceneMap maps an identifier to a provider.
+ */
+export interface SceneMap {
+    [key: SceneId]: SceneProvider;
+}
+/**
+ * Next signals to the SceneDirector that a new scene actor should be given
+ * control.
+ */
+export declare class Next {
+    scene: SceneId;
+    data: Object;
+    /**
+     * @param scene - The scene to be shown.
+     * @param data - Optional data to be passed to the scene.
+     */
+    constructor(scene: SceneId, data?: Object);
+}
+/**
+ * Signal hints to the receiving scene actor that in now has control
+ * and can stream messages to put up its view.
+ *
+ * @param director - The address of the SceneDirector that will forward
+ *                   the views to the display.
+ * @param data     - Payload sourced from the original request to advance the
+ *                   scene. This is meant to be payloads from hash router etc.
+ */
+export declare class Signal {
+    director: Address;
+    data: Object;
+    constructor(director: Address, data: Object);
+}
+/**
+ * Reload the scene.
+ *
+ * This will act as though a new request to show the scene has been created.
+ */
+export declare class Reload {
+    target: Address;
+    constructor(target: Address);
+}
+/**
+ * Supervisor acts on behalf of the SceneDirector to the scene actor.
+ *
+ * This pattern is used so that messages sent after the scene has changed can
+ * be ignored (by killing off the supervisor thus terminating the communication
+ * line).
+ */
+export declare class Supervisor extends Immutable {
+    runtime: Runtime;
+    provider: SceneProvider;
+    director: Address;
+    display: Address;
+    request: Next;
+    constructor(runtime: Runtime, provider: SceneProvider, director: Address, display: Address, request: Next);
+    actor: string;
+    selectors(): (TypeCase<typeof Reload, Promise<void>> | Default<Promise<void>>)[];
+    run(): Promise<void>;
+}
+/**
+ * SceneDirector acts as an implementation independent router between Scene
+ * classes.
+ */
+export declare class SceneDirector extends Immutable {
+    runtime: Runtime;
+    display: Address;
+    scenes: SceneMap;
+    current: Address;
+    constructor(runtime: Runtime, display: Address, scenes: SceneMap, current?: Address);
+    onNext: (msg: Next) => Promise<void>;
+    selectors(): TypeCase<typeof Next, Promise<void>>[];
+}

package/lib/app/scene/director.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SceneDirector = exports.Supervisor = exports.Reload = exports.Signal = exports.Next = void 0;
+const case_1 = require("@quenk/noni/lib/control/match/case");
+const resident_1 = require("@quenk/potoo/lib/actor/framework/resident");
+/**
+ * Next signals to the SceneDirector that a new scene actor should be given
+ * control.
+ */
+class Next {
+    /**
+     * @param scene - The scene to be shown.
+     * @param data - Optional data to be passed to the scene.
+     */
+    constructor(scene, data = {}) {
+        this.scene = scene;
+        this.data = data;
+    }
+}
+exports.Next = Next;
+/**
+ * Signal hints to the receiving scene actor that in now has control
+ * and can stream messages to put up its view.
+ *
+ * @param director - The address of the SceneDirector that will forward
+ *                   the views to the display.
+ * @param data     - Payload sourced from the original request to advance the
+ *                   scene. This is meant to be payloads from hash router etc.
+ */
+class Signal {
+    constructor(director, data) {
+        this.director = director;
+        this.data = data;
+    }
+}
+exports.Signal = Signal;
+/**
+ * Reload the scene.
+ *
+ * This will act as though a new request to show the scene has been created.
+ */
+class Reload {
+    constructor(target) {
+        this.target = target;
+    }
+}
+exports.Reload = Reload;
+/**
+ * Supervisor acts on behalf of the SceneDirector to the scene actor.
+ *
+ * This pattern is used so that messages sent after the scene has changed can
+ * be ignored (by killing off the supervisor thus terminating the communication
+ * line).
+ */
+class Supervisor extends resident_1.Immutable {
+    constructor(runtime, provider, director, display, request) {
+        super(runtime);
+        this.runtime = runtime;
+        this.provider = provider;
+        this.director = director;
+        this.display = display;
+        this.request = request;
+        this.actor = '?';
+    }
+    selectors() {
+        return [
+            new case_1.TypeCase(Reload, async () => {
+                this.tell(this.director, this.request);
+            }),
+            new case_1.Default(async (m) => {
+                this.tell(this.display, m);
+            })
+        ];
+    }
+    async run() {
+        let lock = new Signal(this.self, this.request.data);
+        this.actor = await this.spawn(this.provider(lock));
+    }
+}
+exports.Supervisor = Supervisor;
+/**
+ * SceneDirector acts as an implementation independent router between Scene
+ * classes.
+ */
+class SceneDirector extends resident_1.Immutable {
+    constructor(runtime, display, scenes, current = '') {
+        super(runtime);
+        this.runtime = runtime;
+        this.display = display;
+        this.scenes = scenes;
+        this.current = current;
+        this.onNext = async (msg) => {
+            if (this.current) {
+                await this.kill(this.current);
+            }
+            let provider = this.scenes[msg.scene];
+            if (provider) {
+                this.current = await this.spawn(rt => new Supervisor(rt, provider, this.self, this.display, msg));
+            }
+            else {
+                //TODO: 404 page
+                console.warn(`No scene exists for ${msg.scene}!`, this.scenes);
+            }
+        };
+    }
+    selectors() {
+        return [new case_1.TypeCase(Next, this.onNext)];
+    }
+}
+exports.SceneDirector = SceneDirector;
+//# sourceMappingURL=director.js.map

package/lib/app/scene/director.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"director.js","sourceRoot":"","sources":["../../../src/app/scene/director.ts"],"names":[],"mappings":";;;AAAA,6DAAuE;AAIvE,wEAAsE;AAwBtE;;;GAGG;AACH,MAAa,IAAI;IACb;;;OAGG;IACH,YACW,KAAc,EACd,OAAe,EAAE;QADjB,UAAK,GAAL,KAAK,CAAS;QACd,SAAI,GAAJ,IAAI,CAAa;IACzB,CAAC;CACP;AATD,oBASC;AAED;;;;;;;;GAQG;AACH,MAAa,MAAM;IACf,YACW,QAAiB,EACjB,IAAY;QADZ,aAAQ,GAAR,QAAQ,CAAS;QACjB,SAAI,GAAJ,IAAI,CAAQ;IACpB,CAAC;CACP;AALD,wBAKC;AAED;;;;GAIG;AACH,MAAa,MAAM;IACf,YAAmB,MAAe;QAAf,WAAM,GAAN,MAAM,CAAS;IAAG,CAAC;CACzC;AAFD,wBAEC;AAGD;;;;;;GAMG;AACH,MAAa,UAAW,SAAQ,oBAAS;IACrC,YACW,OAAgB,EAChB,QAAuB,EACvB,QAAiB,EACjB,OAAgB,EAChB,OAAa;QAEpB,KAAK,CAAC,OAAO,CAAC,CAAC;QANR,YAAO,GAAP,OAAO,CAAS;QAChB,aAAQ,GAAR,QAAQ,CAAe;QACvB,aAAQ,GAAR,QAAQ,CAAS;QACjB,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAM;QAKxB,UAAK,GAAG,GAAG,CAAC;IAFZ,CAAC;IAID,SAAS;QACL,OAAO;YACH,IAAI,eAAQ,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;gBAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3C,CAAC,CAAC;YAEF,IAAI,cAAO,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE;gBAClB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YAC/B,CAAC,CAAC;SACL,CAAC;IACN,CAAC;IAED,KAAK,CAAC,GAAG;QACL,IAAI,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,CAAC;CACJ;AA7BD,gCA6BC;AAED;;;GAGG;AACH,MAAa,aAAc,SAAQ,oBAAS;IACxC,YACW,OAAgB,EAChB,OAAgB,EAChB,MAAgB,EAChB,UAAmB,EAAE;QAE5B,KAAK,CAAC,OAAO,CAAC,CAAC;QALR,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAU;QAChB,YAAO,GAAP,OAAO,CAAc;QAKhC,WAAM,GAAG,KAAK,EAAE,GAAS,EAAE,EAAE;YACzB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;YAED,IAAI,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAEtC,IAAI,QAAQ,EAAE,CAAC;gBACX,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAC3B,EAAE,CAAC,EAAE,CAAC,IAAI,UAAU,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CACnE,CAAC;YACN,CAAC;iBAAM,CAAC;gBACJ,gBAAgB;gBAChB,OAAO,CAAC,IAAI,CAAC,uBAAuB,GAAG,CAAC,KAAK,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACnE,CAAC;QACL,CAAC,CAAC;IAjBF,CAAC;IAmBD,SAAS;QACL,OAAO,CAAC,IAAI,eAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7C,CAAC;CACJ;AA9BD,sCA8BC"}

package/lib/app/scene/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * In a Jouvert application, scenes are actors that produce the primary content
+ * to display to the user.
+ *
+ * The content produced by all the scene actors in an application essentially
+ * provide the application's UI. The actors themselves serve as the controllers
+ * of the application's logic.
+ *
+ * This toolkit provides 3 main types of scene actors:
+ *
+ * 1. [[MainScene]]   - These are actors that provide the main views in an
+ *                      application such as a dashboard or a user profile.
+ *                      These typically coordinate the other types of scenes to
+ *                      provide the appropriate UI at the right time.
+ *
+ * 2. [[FormScene]]   - These are specialised to support the content of one or
+ *                      more HTML forms and have methods for setting and
+ *                      validating values.
+ *
+ * 3. [[DialogScene]] - These scenes are controllers intended for modal dialog
+ *                      content.
+ *
+ * In a typical Jouvert application, these actors send their content via a
+ * [[Show]] message to a display which is usually the address of a
+ * [[Display]] instance. Scene actors are meant to be spawned on demand and
+ * usually send this message as part of their run() method.
+ */
+import { Address } from '@quenk/potoo/lib/actor/address';
+import { Api } from '@quenk/potoo/lib/actor/api';
+import { Immutable } from '@quenk/potoo/lib/actor/framework/resident';
+import { View } from '@quenk/wml';
+/**
+ * Scene is the parent interface of all scenes found with an application.
+ *
+ * The properties of this interface are largely meant for interaction with the
+ * display actor(s).
+ */
+export interface Scene extends Api {
+    /**
+     * name used to identify the Scene mainly used by the display actor.
+     */
+    name: string;
+    /**
+     * view sent to the display actor to render content.
+     */
+    view: View;
+    /**
+     * display content will be sent to.
+     */
+    display: Address;
+}
+/**
+ * BaseAppScene that provides a basis for more specialized AppScenes.
+ *
+ * This class only sends content to the display actor when run.
+ */
+export declare abstract class AppScene extends Immutable implements Scene {
+    abstract name: string;
+    abstract view: View;
+    abstract display: Address;
+    /**
+     * show the AppScene by sending a message to the display.
+     */
+    show(): void;
+    run(): Promise<void>;
+}

package/lib/app/scene/index.js

@@ -0,0 +1,50 @@
+"use strict";
+/**
+ * In a Jouvert application, scenes are actors that produce the primary content
+ * to display to the user.
+ *
+ * The content produced by all the scene actors in an application essentially
+ * provide the application's UI. The actors themselves serve as the controllers
+ * of the application's logic.
+ *
+ * This toolkit provides 3 main types of scene actors:
+ *
+ * 1. [[MainScene]]   - These are actors that provide the main views in an
+ *                      application such as a dashboard or a user profile.
+ *                      These typically coordinate the other types of scenes to
+ *                      provide the appropriate UI at the right time.
+ *
+ * 2. [[FormScene]]   - These are specialised to support the content of one or
+ *                      more HTML forms and have methods for setting and
+ *                      validating values.
+ *
+ * 3. [[DialogScene]] - These scenes are controllers intended for modal dialog
+ *                      content.
+ *
+ * In a typical Jouvert application, these actors send their content via a
+ * [[Show]] message to a display which is usually the address of a
+ * [[Display]] instance. Scene actors are meant to be spawned on demand and
+ * usually send this message as part of their run() method.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppScene = void 0;
+const resident_1 = require("@quenk/potoo/lib/actor/framework/resident");
+const display_1 = require("app/display");
+/**
+ * BaseAppScene that provides a basis for more specialized AppScenes.
+ *
+ * This class only sends content to the display actor when run.
+ */
+class AppScene extends resident_1.Immutable {
+    /**
+     * show the AppScene by sending a message to the display.
+     */
+    show() {
+        this.tell(this.display, new display_1.Show(this.name, this.view, this.self));
+    }
+    async run() {
+        this.show();
+    }
+}
+exports.AppScene = AppScene;
+//# sourceMappingURL=index.js.map

package/lib/app/scene/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/scene/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;;;AAIH,wEAAsE;AAGtE,yCAAmC;AA2BnC;;;;GAIG;AACH,MAAsB,QAClB,SAAQ,oBAAS;IASjB;;OAEG;IACH,IAAI;QAEA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAEvE,CAAC;IAED,KAAK,CAAC,GAAG;QAEL,IAAI,CAAC,IAAI,EAAE,CAAC;IAEhB,CAAC;CAEJ;AAzBD,4BAyBC"}