@quenk/frontend 0.20.1

package/lib/app/model/http.js

@@ -0,0 +1,184 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleHttpModel = exports.HttpModel = exports.RequestFactory = exports.NO_PATH = void 0;
+const status = require("@quenk/jhr/lib/status");
+const future_1 = require("@quenk/noni/lib/control/monad/future");
+const maybe_1 = require("@quenk/noni/lib/data/maybe");
+const string_1 = require("@quenk/noni/lib/data/string");
+const record_1 = require("@quenk/noni/lib/data/record");
+const type_1 = require("@quenk/noni/lib/data/type");
+const request_1 = require("@quenk/jhr/lib/request");
+exports.NO_PATH = '?invalid?';
+/**
+ * RequestFactory generates request objects with paths from the provided
+ * Paths object.
+ *
+ * A set of internal rules are used for each operation to determine the path.
+ * This helps reduce the amount of paths that need to be supplied by re-using
+ * the "search" path for "create" etc.
+ */
+class RequestFactory {
+    constructor(paths = {}) {
+        this.paths = paths;
+    }
+    /**
+     * create generates a request for the model "create" method.
+     */
+    create(data) {
+        return new request_1.Post(this.paths.create || this.paths.search || exports.NO_PATH, data, {
+            tags: {
+                path: this.paths.create || this.paths.get || exports.NO_PATH,
+                verb: 'post',
+                method: 'create'
+            }
+        });
+    }
+    /**
+     * search generates a request for the model "search" method.
+     */
+    search(qry) {
+        return new request_1.Get(this.paths.search || exports.NO_PATH, qry, {
+            tags: (0, record_1.merge)((0, type_1.isObject)(qry.$tags) ? qry.$tags : {}, {
+                path: this.paths.search,
+                verb: 'get',
+                method: 'search'
+            })
+        });
+    }
+    /**
+     * update generates a request for the model "update" method.
+     */
+    update(id, changes) {
+        return new request_1.Patch((0, string_1.interpolate)(this.paths.update ||
+            this.paths.get ||
+            exports.NO_PATH, { id }), changes, {
+            tags: {
+                path: this.paths.update,
+                verb: 'patch',
+                method: 'update'
+            }
+        });
+    }
+    /**
+     * get generates a request for the model "get" method.
+     */
+    get(id) {
+        return new request_1.Get((0, string_1.interpolate)(this.paths.get || exports.NO_PATH, { id }), {}, {
+            tags: {
+                path: this.paths.get,
+                verb: 'get',
+                method: 'get'
+            }
+        });
+    }
+    /**
+     * remove generates a request for the model "remove" method.
+     */
+    remove(id) {
+        return new request_1.Delete((0, string_1.interpolate)(this.paths.remove ||
+            this.paths.get ||
+            exports.NO_PATH, { id }), {}, {
+            tags: {
+                path: this.paths.remove,
+                verb: 'delete',
+                method: 'remove'
+            }
+        });
+    }
+}
+exports.RequestFactory = RequestFactory;
+const errors = {
+    [status.BAD_REQUEST]: 'BADREQUEST',
+    [status.UNAUTHORIZED]: 'UNAUTHORIZED',
+    [status.FORBIDDEN]: 'FORBIDDEN',
+    [status.CONFLICT]: 'CONFLICT',
+    'other': 'UNEXPECTED_STATUS'
+};
+const response2Error = (r) => new Error(errors[r.code] || errors.other);
+/**
+ * HttpModel is an abstract implementation of a Model class that uses http
+ * for CSUGR operations.
+ *
+ * To use send requests via jhr directly, use the child class in this module,
+ * to utilize a Remote actor, see the RemoteModel implementation elsewhere.
+ */
+class HttpModel {
+    create(data) {
+        let that = this;
+        return (0, future_1.doFuture)(function* () {
+            let res = yield that.send(that.requests.create(data));
+            if (res.code !== status.CREATED)
+                return (0, future_1.raise)(response2Error(res));
+            return (0, future_1.pure)(res.body.data.id);
+        });
+    }
+    search(qry) {
+        let that = this;
+        return (0, future_1.doFuture)(function* () {
+            let res = yield that.send(that.requests.search(qry));
+            if ((res.code !== status.OK) && (res.code !== status.NO_CONTENT))
+                return (0, future_1.raise)(response2Error(res));
+            return (0, future_1.pure)((res.code === status.NO_CONTENT) ?
+                []
+                : res.body.data);
+        });
+    }
+    update(id, changes) {
+        let that = this;
+        return (0, future_1.doFuture)(function* () {
+            let res = yield that.send(that.requests.update(id, changes));
+            if (res.code === status.NOT_FOUND)
+                return (0, future_1.pure)(false);
+            if (res.code !== status.OK)
+                return (0, future_1.raise)(response2Error(res));
+            return (0, future_1.pure)(true);
+        });
+    }
+    get(id) {
+        let that = this;
+        return (0, future_1.doFuture)(function* () {
+            let res = yield that.send(that.requests.get(id));
+            if (res.code === status.NOT_FOUND)
+                return (0, future_1.pure)((0, maybe_1.nothing)());
+            if (res.code !== status.OK)
+                return (0, future_1.raise)(response2Error(res));
+            return (0, future_1.pure)((0, maybe_1.fromNullable)(res.body));
+        });
+    }
+    remove(id) {
+        let that = this;
+        return (0, future_1.doFuture)(function* () {
+            let res = yield that.send(that.requests.remove(id));
+            if (res.code !== status.OK)
+                return (0, future_1.raise)(response2Error(res));
+            return (0, future_1.pure)(true);
+        });
+    }
+}
+exports.HttpModel = HttpModel;
+/**
+ * SimpleHttpModel is an HttpModel that uses the JHR lib directly.
+ *
+ * There is no intermediate transformations or interception other than what
+ * the jhr agent is configured for. Use this in smaller, less complicated apps
+ * where these abstraction are not needed. See the RemoteModel class if you
+ * need something more complicated.
+ */
+class SimpleHttpModel extends HttpModel {
+    constructor(agent, requests) {
+        super();
+        this.agent = agent;
+        this.requests = requests;
+    }
+    /**
+     * fromPaths generates a new HttpModel using Paths object.
+     */
+    static fromPaths(agent, paths) {
+        return new SimpleHttpModel(agent, new RequestFactory(paths));
+    }
+    send(req) {
+        return this.agent.send(req);
+    }
+}
+exports.SimpleHttpModel = SimpleHttpModel;
+//# sourceMappingURL=http.js.map

package/lib/app/model/http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../../../src/app/model/http.ts"],"names":[],"mappings":";;;AAAA,gDAAgD;AAEhD,iEAK8C;AAC9C,sDAA0E;AAE1E,wDAA0D;AAC1D,wDAA4D;AAC5D,oDAAqD;AAKrD,oDAAkE;AAgGrD,QAAA,OAAO,GAAG,WAAW,CAAC;AAEnC;;;;;;;GAOG;AACH,MAAa,cAAc;IAEvB,YAAmB,QAAe,EAAE;QAAjB,UAAK,GAAL,KAAK,CAAY;IAAI,CAAC;IAEzC;;OAEG;IACH,MAAM,CAAmB,IAAO;QAC5B,OAAO,IAAI,cAAI,CACX,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,eAAO,EACjD,IAAI,EACJ;YACI,IAAI,EAAE;gBACF,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,eAAO;gBACpD,IAAI,EAAE,MAAM;gBACZ,MAAM,EAAE,QAAQ;aACnB;SACJ,CACJ,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAW;QACd,OAAO,IAAI,aAAG,CACV,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,eAAO,EAC5B,GAAG,EACH;YACI,IAAI,EAAE,IAAA,cAAK,EACP,IAAA,eAAQ,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAS,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC9C,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;gBACvB,IAAI,EAAE,KAAK;gBACX,MAAM,EAAE,QAAQ;aACnB,CAAC;SACL,CACJ,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM,CAAmB,EAAM,EAAE,OAAmB;QAChD,OAAO,IAAI,eAAK,CACZ,IAAA,oBAAW,EACP,IAAI,CAAC,KAAK,CAAC,MAAM;YACjB,IAAI,CAAC,KAAK,CAAC,GAAG;YACd,eAAO,EAAE,EAAE,EAAE,EAAE,CAClB,EACD,OAAO,EACP;YACI,IAAI,EAAE;gBACF,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;gBACvB,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE,QAAQ;aACnB;SACJ,CACJ,CAAC;IACN,CAAC;IAED;;OAEG;IACH,GAAG,CAAmB,EAAM;QACxB,OAAO,IAAI,aAAG,CACV,IAAA,oBAAW,EAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,eAAO,EAAE,EAAE,EAAE,EAAE,CAAC,EAC9C,EAAE,EACF;YACI,IAAI,EAAE;gBACF,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG;gBACpB,IAAI,EAAE,KAAK;gBACX,MAAM,EAAE,KAAK;aAChB;SACJ,CACJ,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAM;QACT,OAAO,IAAI,gBAAM,CACb,IAAA,oBAAW,EACP,IAAI,CAAC,KAAK,CAAC,MAAM;YACjB,IAAI,CAAC,KAAK,CAAC,GAAG;YACd,eAAO,EAAE,EAAE,EAAE,EAAE,CAClB,EACD,EAAE,EACF;YACI,IAAI,EAAE;gBACF,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;gBACvB,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,QAAQ;aACnB;SACJ,CACJ,CAAC;IACN,CAAC;CACJ;AAjGD,wCAiGC;AAED,MAAM,MAAM,GAAmB;IAC3B,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,YAAY;IAClC,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,cAAc;IACrC,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,WAAW;IAC/B,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,UAAU;IAC7B,OAAO,EAAE,mBAAmB;CAC/B,CAAA;AAED,MAAM,cAAc,GAAG,CAAI,CAAc,EAAE,EAAE,CACzC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;AAE9C;;;;;;GAMG;AACH,MAAsB,SAAS;IAY3B,MAAM,CAAC,IAAO;QAEV,IAAI,IAAI,GAAG,IAAI,CAAC;QAEhB,OAAO,IAAA,iBAAQ,EAAC,QAAQ,CAAC;YAErB,IAAI,GAAG,GACH,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAEhD,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,OAAO;gBAAE,OAAO,IAAA,cAAK,EAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;YAEnE,OAAO,IAAA,aAAI,EAAgB,GAAG,CAAC,IAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAElD,CAAC,CAAC,CAAC;IAEP,CAAC;IAED,MAAM,CAAC,GAAW;QAEd,IAAI,IAAI,GAAG,IAAI,CAAC;QAEhB,OAAO,IAAA,iBAAQ,EAAC,QAAQ,CAAC;YAErB,IAAI,GAAG,GACH,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAE/C,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,UAAU,CAAC;gBAC5D,OAAO,IAAA,cAAK,EAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;YAEtC,OAAO,IAAA,aAAI,EAAC,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC1C,EAAE;gBACF,CAAC,CAAmB,GAAG,CAAC,IAAK,CAAC,IAAI,CAAC,CAAC;QAE5C,CAAC,CAAC,CAAC;IAEP,CAAC;IAED,MAAM,CAAC,EAAM,EAAE,OAAmB;QAE9B,IAAI,IAAI,GAAG,IAAI,CAAC;QAEhB,OAAO,IAAA,iBAAQ,EAAC,QAAQ,CAAC;YAErB,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;YAE7D,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,SAAS;gBAAE,OAAO,IAAA,aAAI,EAAC,KAAK,CAAC,CAAC;YAEtD,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,EAAE;gBAAE,OAAO,IAAA,cAAK,EAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;YAE9D,OAAO,IAAA,aAAI,EAAC,IAAI,CAAC,CAAC;QAEtB,CAAC,CAAC,CAAC;IAEP,CAAC;IAED,GAAG,CAAC,EAAM;QAEN,IAAI,IAAI,GAAG,IAAI,CAAC;QAEhB,OAAO,IAAA,iBAAQ,EAAC,QAAQ,CAAC;YAErB,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;YAEjD,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,SAAS;gBAAE,OAAO,IAAA,aAAI,EAAC,IAAA,eAAO,GAAE,CAAC,CAAC;YAE1D,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,EAAE;gBAAE,OAAO,IAAA,cAAK,EAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;YAE9D,OAAO,IAAA,aAAI,EAAC,IAAA,oBAAY,EAAa,GAAG,CAAC,IAAK,CAAC,CAAC,CAAC;QAErD,CAAC,CAAC,CAAC;IAEP,CAAC;IAED,MAAM,CAAC,EAAM;QAET,IAAI,IAAI,GAAG,IAAI,CAAC;QAEhB,OAAO,IAAA,iBAAQ,EAAC,QAAQ,CAAC;YAErB,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;YAEnD,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,EAAE;gBAAE,OAAO,IAAA,cAAK,EAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;YAE9D,OAAO,IAAA,aAAI,EAAC,IAAI,CAAC,CAAC;QAEtB,CAAC,CAAC,CAAC;IAEP,CAAC;CAEJ;AArGD,8BAqGC;AAED;;;;;;;GAOG;AACH,MAAa,eAAkC,SAAQ,SAAY;IAE/D,YACW,KAA4B,EAC5B,QAAwB;QAAI,KAAK,EAAE,CAAC;QADpC,UAAK,GAAL,KAAK,CAAuB;QAC5B,aAAQ,GAAR,QAAQ,CAAgB;IAAa,CAAC;IAEjD;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAA4B,EAAE,KAAY;QAEvD,OAAO,IAAI,eAAe,CAAC,KAAK,EAAE,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAEjE,CAAC;IAED,IAAI,CAAC,GAAoB;QAErB,OAA4C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAErE,CAAC;CAEJ;AArBD,0CAqBC"}

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

@@ -0,0 +1,36 @@
+import { Object } from '@quenk/noni/lib/data/jsonx';
+import { Maybe } from '@quenk/noni/lib/data/maybe';
+import { Future } from '@quenk/noni/lib/control/monad/future';
+/**
+ * Id is a valid unique identifier for a single record.
+ */
+export type Id = string | number;
+/**
+ * Model is an interface for preforming CSUGR operations on a data
+ * type found in the application we are interested in persisting.
+ *
+ * Actual implementations may manipulate data stored on the client side or
+ * a remote endpoint.
+ */
+export interface Model<T extends Object> {
+    /**
+     * create a new entry for the data type.
+     */
+    create(data: T): Future<Id>;
+    /**
+     * search for entries that match the specified query criteria.
+     */
+    search(qry: Object): Future<T[]>;
+    /**
+     * update a single entry with the data provided.
+     */
+    update(id: Id, changes: Partial<T>): Future<boolean>;
+    /**
+     * get a single entry using its id.
+     */
+    get(id: Id): Future<Maybe<T>>;
+    /**
+     * remove a single entry using its id
+     */
+    remove(id: Id): Future<boolean>;
+}

package/lib/app/model/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/model/index.ts"],"names":[],"mappings":""}

package/lib/app/router/hash.d.ts

@@ -0,0 +1,143 @@
+import * as router from './';
+import { Key } from 'path-to-regexp';
+import { Object as JObject } from '@quenk/noni/lib/data/json';
+import { Future } from '@quenk/noni/lib/control/monad/future';
+/**
+ * Path type alias.
+ */
+export type Path = string;
+/**
+ * Query type alias.
+ */
+export type Query = JObject;
+/**
+ * Params
+ */
+export type Params = JObject;
+/**
+ * Filter type.
+ */
+export type Filter<R extends Request> = router.Filter<R>;
+/**
+ * Handler type.
+ */
+export type Handler<R extends Request> = router.Handler<R>;
+/**
+ * OnError type.
+ */
+export type OnError = (e: Error) => Future<void>;
+/**
+ * OnNotFound type.
+ */
+export type OnNotFound = (path: Path) => Future<void>;
+/**
+ * Routes table.
+ */
+export interface Routes<R extends Request> {
+    [key: string]: [Filter<R>[], Handler<R>];
+}
+/**
+ * Request interface.
+ */
+export interface Request {
+    /**
+     * path requested
+     */
+    path: Path;
+    /**
+     * query data.
+     */
+    query: Query;
+    /**
+     * params data.
+     */
+    params: Params;
+}
+/**
+ * Cache used internally by the Router.
+ * @private
+ */
+export declare class Cache<R extends Request> {
+    regex: RegExp;
+    keys: Key[];
+    filters: Filter<R>[];
+    handler: Handler<R>;
+    constructor(regex: RegExp, keys: Key[], filters: Filter<R>[], handler: Handler<R>);
+}
+/**
+ * AbstractHashRouter implementation based on the value of window.location.hash.
+ */
+export declare abstract class AbstractHashRouter<R extends Request> implements router.Router<R> {
+    window: Window;
+    routes: Routes<R>;
+    constructor(window: Window, routes?: Routes<R>);
+    cache: Cache<R>[];
+    keys: Object[];
+    /**
+     * createRequest is a constructor for new Request instances.
+     */
+    abstract createRequest(path: Path, query: Query, params: Params): Future<R>;
+    /**
+     * onError is invoked when an non-thrown error is invoked.
+     */
+    abstract onError(e: Error): Future<void>;
+    /**
+     * onNotFound is invoked each time the user navigates to an unknown route.
+     */
+    abstract onNotFound(path: Path): Future<void>;
+    handleEvent(_: Event): void;
+    /**
+     * add a Handler to the route table for a specific path.
+     */
+    add(path: string, handler: Handler<R>): AbstractHashRouter<R>;
+    use(path: string, mware: Filter<R>): AbstractHashRouter<R>;
+    clear(): void;
+    /**
+     * start activates routing by installing a hook into the supplied
+     * window.
+     */
+    start(): AbstractHashRouter<R>;
+    stop(): AbstractHashRouter<R>;
+}
+/**
+ * DefaultRequest represents a change in the browser's hash triggered
+ * by the user.
+ */
+export declare class DefaultRequest {
+    path: string;
+    query: Query;
+    params: Params;
+    constructor(path: string, query: Query, params: Params);
+}
+/**
+ * HashRouter implementation.
+ */
+export declare class HashRouter extends AbstractHashRouter<DefaultRequest> {
+    window: Window;
+    routes: Routes<DefaultRequest>;
+    error: OnError;
+    notFound: OnNotFound;
+    constructor(window: Window, routes?: Routes<DefaultRequest>, error?: OnError, notFound?: OnNotFound);
+    createRequest(path: Path, query: Query, params: Params): Future<DefaultRequest>;
+    /**
+     * navigate to a new path without user interaction.
+     *
+     * Use this method to change application routes on behalf of the user or
+     * automatically.
+     *
+     * @param path - The path to navigate to; should not include '#'.
+     */
+    navigate(path: Path): void;
+    onError(e: Error): Future<void>;
+    onNotFound(path: Path): Future<void>;
+}
+/**
+ * takeHash from a Window object.
+ *
+ * If the hash is empty "/" is returned.
+ */
+export declare const takeHash: (w: Window) => string[];
+/**
+ * compile a Routes map into a Cache for faster route matching.
+ */
+export declare const compile: <R extends Request>(r: Routes<R>) => Cache<R>[];

package/lib/app/router/hash.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compile = exports.takeHash = exports.HashRouter = exports.DefaultRequest = exports.AbstractHashRouter = exports.Cache = void 0;
+const qs = require("qs");
+const toRegex = require("path-to-regexp");
+const function_1 = require("@quenk/noni/lib/data/function");
+const future_1 = require("@quenk/noni/lib/control/monad/future");
+const record_1 = require("@quenk/noni/lib/data/record");
+const EVENT_HASH_CHANGED = 'hashchange';
+/**
+ * Cache used internally by the Router.
+ * @private
+ */
+class Cache {
+    constructor(regex, keys, filters, handler) {
+        this.regex = regex;
+        this.keys = keys;
+        this.filters = filters;
+        this.handler = handler;
+    }
+}
+exports.Cache = Cache;
+/**
+ * AbstractHashRouter implementation based on the value of window.location.hash.
+ */
+class AbstractHashRouter {
+    constructor(window, routes = {}) {
+        this.window = window;
+        this.routes = routes;
+        this.cache = [];
+        this.keys = [];
+    }
+    handleEvent(_) {
+        let [path, query] = (0, exports.takeHash)(this.window);
+        let cache = this.cache;
+        let mware = [];
+        let handler = () => (0, future_1.pure)(undefined);
+        let keys = [];
+        let r = null;
+        let count = 0;
+        while ((r == null) && (count < cache.length)) {
+            r = cache[count].regex.exec(path);
+            keys = cache[count].keys;
+            mware = cache[count].filters;
+            handler = cache[count].handler;
+            count = count + 1;
+        }
+        if (r != null) {
+            let ft = this.createRequest(path, qs.parse(query), parseParams(keys, r));
+            mware
+                .reduce((p, c) => p.chain(c), ft)
+                .chain(handler)
+                .trap(e => this.onError(e))
+                .fork(console.error, function_1.noop);
+        }
+        else {
+            this.onNotFound(path).fork(console.error, function_1.noop);
+        }
+    }
+    /**
+     * add a Handler to the route table for a specific path.
+     */
+    add(path, handler) {
+        if (this.routes.hasOwnProperty(path)) {
+            this.routes[path][1] = handler;
+        }
+        else {
+            this.routes[path] = [[], handler];
+        }
+        this.cache = (0, exports.compile)(this.routes);
+        return this;
+    }
+    use(path, mware) {
+        if (this.routes.hasOwnProperty(path)) {
+            this.routes[path][0].push(mware);
+        }
+        else {
+            this.routes[path] = [[mware], () => (0, future_1.pure)(undefined)];
+        }
+        this.cache = (0, exports.compile)(this.routes);
+        return this;
+    }
+    clear() {
+        this.cache = [];
+        this.routes = {};
+    }
+    /**
+     * start activates routing by installing a hook into the supplied
+     * window.
+     */
+    start() {
+        this.window.addEventListener(EVENT_HASH_CHANGED, this);
+        return this;
+    }
+    stop() {
+        this.window.removeEventListener(EVENT_HASH_CHANGED, this);
+        return this;
+    }
+}
+exports.AbstractHashRouter = AbstractHashRouter;
+/**
+ * DefaultRequest represents a change in the browser's hash triggered
+ * by the user.
+ */
+class DefaultRequest {
+    constructor(path, query, params) {
+        this.path = path;
+        this.query = query;
+        this.params = params;
+    }
+}
+exports.DefaultRequest = DefaultRequest;
+/**
+ * HashRouter implementation.
+ */
+class HashRouter extends AbstractHashRouter {
+    constructor(window, routes = {}, error = (e) => {
+        console.error(e);
+        return future_1.voidPure;
+    }, notFound = () => (0, future_1.pure)((0, function_1.noop)())) {
+        super(window, routes);
+        this.window = window;
+        this.routes = routes;
+        this.error = error;
+        this.notFound = notFound;
+    }
+    createRequest(path, query, params) {
+        return (0, future_1.pure)(new DefaultRequest(path, query, params));
+    }
+    /**
+     * navigate to a new path without user interaction.
+     *
+     * Use this method to change application routes on behalf of the user or
+     * automatically.
+     *
+     * @param path - The path to navigate to; should not include '#'.
+     */
+    navigate(path) {
+        path = path.split('#').join('');
+        path = `#${path}`;
+        if (window.location.hash === path)
+            this.handleEvent(new Event('hashchanged'));
+        window.location.hash = path;
+    }
+    onError(e) {
+        return this.error(e);
+    }
+    onNotFound(path) {
+        return this.notFound(path);
+    }
+}
+exports.HashRouter = HashRouter;
+const parseParams = (keys, results) => {
+    let params = Object.create(null);
+    keys.forEach((key, index) => params[key.name] = results[index + 1]);
+    return params;
+};
+/**
+ * takeHash from a Window object.
+ *
+ * If the hash is empty "/" is returned.
+ */
+const takeHash = (w) => ((w.location.hash != null) && (w.location.hash != '')) ?
+    w.location.hash
+        .replace(/^#/, '/')
+        .replace(/\/\//g, '/')
+        .split('?') :
+    ['/'];
+exports.takeHash = takeHash;
+/**
+ * compile a Routes map into a Cache for faster route matching.
+ */
+const compile = (r) => (0, record_1.reduce)(r, [], (p, c, path) => {
+    let keys = [];
+    return p.concat(new Cache(toRegex.pathToRegexp(path, keys), keys, c[0], c[1]));
+});
+exports.compile = compile;
+//# sourceMappingURL=hash.js.map

package/lib/app/router/hash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.js","sourceRoot":"","sources":["../../../src/app/router/hash.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,0CAA0C;AAM1C,4DAAqD;AACrD,iEAA8E;AAC9E,wDAAqD;AAErD,MAAM,kBAAkB,GAAG,YAAY,CAAC;AAoExC;;;GAGG;AACH,MAAa,KAAK;IAEd,YACW,KAAa,EACb,IAAW,EACX,OAAoB,EACpB,OAAmB;QAHnB,UAAK,GAAL,KAAK,CAAQ;QACb,SAAI,GAAJ,IAAI,CAAO;QACX,YAAO,GAAP,OAAO,CAAa;QACpB,YAAO,GAAP,OAAO,CAAY;IAAI,CAAC;CAEtC;AARD,sBAQC;AAED;;GAEG;AACH,MAAsB,kBAAkB;IAGpC,YACW,MAAc,EACd,SAAoB,EAAE;QADtB,WAAM,GAAN,MAAM,CAAQ;QACd,WAAM,GAAN,MAAM,CAAgB;QAEjC,UAAK,GAAe,EAAE,CAAC;QAEvB,SAAI,GAAa,EAAE,CAAC;IAJiB,CAAC;IAqBtC,WAAW,CAAC,CAAQ;QAEhB,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACvB,IAAI,KAAK,GAAgB,EAAE,CAAC;QAC5B,IAAI,OAAO,GAAe,GAAG,EAAE,CAAC,IAAA,aAAI,EAAO,SAAS,CAAC,CAAC;QACtD,IAAI,IAAI,GAAa,EAAE,CAAC;QACxB,IAAI,CAAC,GAAQ,IAAI,CAAC;QAClB,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,OAAO,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAE3C,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YACzB,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAA;YAC5B,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;YAC/B,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC;QAEtB,CAAC;QAED,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAEZ,IAAI,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAC7C,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAE1B,KAAK;iBACA,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;iBAChC,KAAK,CAAC,OAAO,CAAC;iBACd,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;iBAC1B,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,eAAI,CAAC,CAAC;QAEnC,CAAC;aAAM,CAAC;YAEJ,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,eAAI,CAAC,CAAC;QAEpD,CAAC;IAEL,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,IAAY,EAAE,OAAmB;QAEjC,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YAEnC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QAEnC,CAAC;aAAM,CAAC;YAEJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAEtC,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAA,eAAO,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAElC,OAAO,IAAI,CAAC;IAEhB,CAAC;IAED,GAAG,CAAC,IAAY,EAAE,KAAgB;QAE9B,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YAEnC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAErC,CAAC;aAAM,CAAC;YAEJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,IAAA,aAAI,EAAM,SAAS,CAAC,CAAC,CAAC;QAE9D,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAA,eAAO,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAElC,OAAO,IAAI,CAAC;IAEhB,CAAC;IAED,KAAK;QAED,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IAErB,CAAC;IAED;;;OAGG;IACH,KAAK;QAED,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC;IAEhB,CAAC;IAED,IAAI;QAEA,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IAEhB,CAAC;CAEJ;AAjID,gDAiIC;AAED;;;GAGG;AACH,MAAa,cAAc;IAEvB,YACW,IAAY,EACZ,KAAY,EACZ,MAAc;QAFd,SAAI,GAAJ,IAAI,CAAQ;QACZ,UAAK,GAAL,KAAK,CAAO;QACZ,WAAM,GAAN,MAAM,CAAQ;IAAI,CAAC;CAEjC;AAPD,wCAOC;AAED;;GAEG;AACH,MAAa,UAAW,SAAQ,kBAAkC;IAE9D,YACW,MAAc,EACd,SAAiC,EAAE,EACnC,QAAiB,CAAC,CAAQ,EAAE,EAAE;QACjC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,OAAO,iBAAQ,CAAC;IACpB,CAAC,EACM,WAAuB,GAAG,EAAE,CAAC,IAAA,aAAI,EAAC,IAAA,eAAI,GAAE,CAAC;QAChD,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAPf,WAAM,GAAN,MAAM,CAAQ;QACd,WAAM,GAAN,MAAM,CAA6B;QACnC,UAAK,GAAL,KAAK,CAGX;QACM,aAAQ,GAAR,QAAQ,CAAiC;IAEpD,CAAC;IAED,aAAa,CAAC,IAAU,EAAE,KAAY,EAAE,MAAc;QAElD,OAAO,IAAA,aAAI,EAAC,IAAI,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAEzD,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAU;QAEf,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEhC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAElB,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI;YAC7B,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAE/C,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAEhC,CAAC;IAED,OAAO,CAAC,CAAQ;QAEZ,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEzB,CAAC;IAED,UAAU,CAAC,IAAU;QAEjB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAE/B,CAAC;CAEJ;AApDD,gCAoDC;AAED,MAAM,WAAW,GAAG,CAAC,IAAc,EAAE,OAAgB,EAAW,EAAE;IAE9D,IAAI,MAAM,GAAY,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAE1C,IAAI,CAAC,OAAO,CAAC,CAAC,GAAQ,EAAE,KAAK,EAAE,EAAE,CAC7B,MAAM,CAAS,GAAG,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAEnD,OAAO,MAAM,CAAC;AAElB,CAAC,CAAA;AAED;;;;GAIG;AACI,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE,CAClC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,QAAQ,CAAC,IAAI;SACV,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;SAClB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACjB,CAAC,GAAG,CAAC,CAAC;AAND,QAAA,QAAQ,YAMP;AAEd;;GAEG;AACI,MAAM,OAAO,GAAG,CAAoB,CAAY,EAAc,EAAE,CACnE,IAAA,eAAM,EAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAa,EAAE,CAA4B,EAAE,IAAY,EAAE,EAAE;IAExE,IAAI,IAAI,GAAU,EAAE,CAAC;IACrB,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,CACrB,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE7D,CAAC,CAAC,CAAC;AAPM,QAAA,OAAO,WAOb"}

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

@@ -0,0 +1,49 @@
+import { Future } from '@quenk/noni/lib/control/monad/future';
+/**
+ * Route is a string used as an identifier for application state.
+ */
+export type Route = string;
+/**
+ * Filter types transform <R> values before they are passed to handlers.
+ */
+export type Filter<R> = (req: R) => Future<R>;
+/**
+ * Handler is the action taken to terminate a request.
+ */
+export type Handler<R> = (r: R) => Future<void>;
+/**
+ * Router is an interface for changing application state based on user requests.
+ *
+ * Each request is enscapulated by the type <R> that is constrained by
+ * the Router implementation.
+ */
+export interface Router<R> {
+    /**
+     * onError hook.
+     */
+    onError(e: Error): Future<void>;
+    /**
+     * onNotFound hook.
+     */
+    onNotFound(url: string): Future<void>;
+    /**
+     * add a Handler to the internal route table.
+     */
+    add(path: Route, handler: Handler<R>): Router<R>;
+    /**
+     * use a Filter for a specific path.
+     */
+    use(path: Route, mware: Filter<R>): Router<R>;
+    /**
+     * clear all routes from the Router.
+     */
+    clear(): void;
+    /**
+     * start the Router.
+     */
+    start(): Router<R>;
+    /**
+     * stop the Router.
+     */
+    stop(): Router<R>;
+}

package/lib/app/router/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/router/index.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,13 @@
+import { Address } from '@quenk/potoo/lib/actor/address';
+import { Runtime } from '@quenk/potoo/lib/actor/system/vm/runtime';
+import { Dialog, DialogEventTarget } from '.';
+/**
+ * AlertDialog provides a dialog for displaying an alert message.
+ */
+export declare abstract class AlertDialog extends Dialog {
+    runtime: Runtime;
+    display: Address;
+    message: string;
+    target: DialogEventTarget;
+    constructor(runtime: Runtime, display: Address, message: string, target?: DialogEventTarget);
+}

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlertDialog = void 0;
+const _1 = require(".");
+/**
+ * AlertDialog provides a dialog for displaying an alert message.
+ */
+class AlertDialog extends _1.Dialog {
+    constructor(runtime, display, message, target = '?') {
+        super(runtime, display, target);
+        this.runtime = runtime;
+        this.display = display;
+        this.message = message;
+        this.target = target;
+    }
+}
+exports.AlertDialog = AlertDialog;
+//# sourceMappingURL=alert.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"alert.js","sourceRoot":"","sources":["../../../../src/app/scene/dialog/alert.ts"],"names":[],"mappings":";;;AAGA,wBAA8C;AAE9C;;GAEG;AACH,MAAsB,WAAY,SAAQ,SAAM;IAE5C,YACW,OAAgB,EAChB,OAAgB,EAChB,OAAe,EACf,SAA4B,GAAG;QAEtC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QALzB,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAQ;QACf,WAAM,GAAN,MAAM,CAAyB;IAI1C,CAAC;CAEJ;AAZD,kCAYC"}