@nascentdigital/funnel-editor 4.4.18

package/dist/collection/components/CollectionStatus.js

@@ -0,0 +1,218 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionStatus = CollectionStatus;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const funnel_cms_1 = require("@nascentdigital/funnel-cms");
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const classnames_1 = __importDefault(require("classnames"));
+const react_1 = require("motion/react");
+const core_1 = require("../../core");
+const hooks_1 = require("../hooks");
+const status_1 = require("./status");
+// component
+function CollectionStatus({ className }) {
+    // bind hooks
+    const collection = (0, core_1.usePossibleCollection)();
+    const controller = (0, hooks_1.useCollectionController)();
+    const dialog = (0, core_1.useDialog)();
+    const editorApi = (0, core_1.useEditorApi)();
+    const router = (0, core_1.useEditorRouter)();
+    // skip if collection isn't ready
+    if (!collection) {
+        return null;
+    }
+    // render
+    return ((0, jsx_runtime_1.jsxs)("div", { className: (0, classnames_1.default)(className, 'flex flex-col gap-l8 pt-l9 px-l8 pb-l8'), children: [(0, jsx_runtime_1.jsx)("h2", { className: "label-sm text-content-tertiary uppercase", children: "Collection Item Status" }), (0, jsx_runtime_1.jsx)(react_1.AnimatePresence, { mode: "wait", children: renderStatus({ collection, controller, dialog, editorApi, router }) })] }));
+}
+function renderStatus(args) {
+    // published (unchanged)
+    const { collection } = args;
+    const { state, modified } = collection;
+    if (state === 'published') {
+        return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)(core_1.FadeIn, { children: renderLiveUnchanged(args) }, "live"), modified &&
+                    (0, jsx_runtime_1.jsx)(core_1.FadeIn, { children: (0, jsx_runtime_1.jsx)(status_1.AutoSave, { className: "mt-l8" }) }, "live-status")] }));
+    }
+    // live (with changes)
+    let status;
+    const { nameField, publishedOn, errors } = collection;
+    const invalid = !nameField.valid || errors.fields.length > 0;
+    if (publishedOn) {
+        status = invalid
+            ? renderLiveInvalid(args)
+            : renderLiveValid(args);
+    }
+    // draft (never published)
+    else {
+        status = invalid
+            ? renderDraftInvalid(args)
+            : renderDraftValid(args);
+    }
+    // render
+    return ((0, jsx_runtime_1.jsxs)(core_1.FadeIn, { children: [status, (0, jsx_runtime_1.jsx)(status_1.AutoSave, { className: "mt-l8" })] }, `${publishedOn ? 'updated' : 'draft'}/${invalid ? 'invalid' : 'valid'}`));
+}
+function renderDraftInvalid(args) {
+    // render
+    return ((0, jsx_runtime_1.jsx)(core_1.InfoPanel, { contentClassName: "flex flex-col gap-l8 mt-l8", title: "Finish Up", caption: "**You're almost there!** Complete all required content to publish this item.", status: "info", menu: [
+            {
+                id: 'delete',
+                label: 'Delete Draft',
+                icon: 'Trash',
+                destructive: true
+            }
+        ], onMenuSelect: () => onDiscard(args) }));
+}
+function renderDraftValid(args) {
+    // render
+    return ((0, jsx_runtime_1.jsx)(core_1.InfoPanel, { contentClassName: "flex flex-col gap-l8 mt-l8", title: "Launch Page", caption: "**All set!** Your page is complete and ready to go live.", status: "success", menu: [
+            {
+                id: 'delete',
+                label: 'Delete Draft',
+                icon: 'Trash',
+                destructive: true
+            }
+        ], onMenuSelect: () => onDiscard(args), children: (0, jsx_runtime_1.jsx)(core_1.Button, { variant: "primary", onClick: () => onPublish(args), children: "Go Live!" }) }));
+}
+function renderLiveUnchanged(args) {
+    // render
+    return ((0, jsx_runtime_1.jsx)(core_1.InfoPanel, { contentClassName: "flex flex-col gap-l8 mt-l8", title: "Live", caption: "**You're all caught up!**  There are no changes to publish.", status: "success", menu: [
+            {
+                id: 'unpublish',
+                label: 'Unpublish Item',
+                icon: 'Archive'
+            }
+        ], onMenuSelect: () => onUnpublish(args) }));
+}
+function renderLiveInvalid(args) {
+    // render
+    return ((0, jsx_runtime_1.jsx)(core_1.InfoPanel, { contentClassName: "flex flex-col gap-l8 mt-l8", title: "Action Needed", caption: "**Wait a sec!**  A few issues need fixing before you can publish.", status: "error", menu: [
+            {
+                id: 'discard',
+                label: 'Discard Changes',
+                icon: 'Trash'
+            }
+        ], onMenuSelect: () => onDiscard(args) }));
+}
+function renderLiveValid(args) {
+    // render
+    return ((0, jsx_runtime_1.jsx)(core_1.InfoPanel, { contentClassName: "flex flex-col gap-l8 mt-l8", title: "Updates Ready", caption: "**All set!** Your page is complete and ready to go live.", status: "success", menu: [
+            {
+                id: 'discard',
+                label: 'Discard Changes',
+                icon: 'Trash'
+            }
+        ], onMenuSelect: () => onDiscard(args), children: (0, jsx_runtime_1.jsx)(core_1.Button, { variant: "primary", onClick: () => onPublish(args), children: "Publish Updates" }) }));
+}
+async function onPublish({ collection, router }) {
+    // skip if there's no changeset (shouldn't be possible)
+    const { changeSetId } = collection;
+    if (!changeSetId) {
+        console.error('[CollectionStatus] missing changeset on Collection', collection);
+        return;
+    }
+    // navigate to changeset
+    router.navigateToChangeSet(changeSetId)
+        .catch(console.error);
+}
+async function onUnpublish({ router, collection, controller, dialog, editorApi }) {
+    var _a;
+    // confirm and unpublish
+    const linkedError = { value: undefined };
+    await dialog.confirm({
+        title: 'Are you sure you want to unpublish?',
+        message: 'This will affect any page using this collection',
+        executingLabel: 'Unpublishing...',
+        confirmationCode: ((_a = collection.name) === null || _a === void 0 ? void 0 : _a.toLowerCase()) || collection.type.toLowerCase(),
+        confirmLabel: 'Unpublish it',
+        destructive: true,
+        asyncTask: async () => {
+            // try to unpublish
+            try {
+                // unpublish page
+                await controller.unpublish();
+                // navigate back
+                await router.navigateToCollectionItems({ type: collection.type });
+                // indicate success
+                return { success: true };
+            }
+            // or indicate failure
+            catch (e) {
+                // special handling for dependants error
+                if (e instanceof funnel_cms_1.LinkedDependantsError) {
+                    // track error
+                    linkedError.value = e;
+                    // indicate success (so we can handle later
+                    return { success: true };
+                }
+                // or show inline error
+                else {
+                    return {
+                        success: false,
+                        error: e instanceof Error
+                            ? e
+                            : new funnel_core_1.ServerError('Something went wrong while trying to unpublish the collection.')
+                    };
+                }
+            }
+        }
+    });
+    // raise linked error dialog if we failed
+    if (linkedError.value) {
+        // show error
+        const { collections, pages } = linkedError.value;
+        const unlink = await dialog.confirm({
+            title: 'Links Detected',
+            message: ((0, jsx_runtime_1.jsx)(core_1.LinkGroup, { title: "We found some dependencies that need to be unlinked before we can unpublish this page:", pages: pages, collections: collections })),
+            confirmLabel: 'Unlink',
+            executingLabel: 'Unlinking...',
+            destructive: true
+        });
+    }
+}
+async function onDiscard({ router, editorApi, dialog, controller, collection }) {
+    var _a;
+    // skip if there's no changeset (not possible)
+    const { changeSetId } = collection;
+    if (!changeSetId) {
+        console.error('[CollectionStatus] missing changeset on Collection', collection);
+        return;
+    }
+    // confirm (or skip)
+    await dialog.confirm({
+        title: `Discard ${collection.template.name} changes`,
+        message: `Are you really sure you want to discard changes this ${collection.template.name}?`,
+        executingLabel: 'Reverting...',
+        confirmationCode: ((_a = collection.name) === null || _a === void 0 ? void 0 : _a.toLowerCase()) || collection.type.toLowerCase(),
+        confirmLabel: 'Revert',
+        destructive: true,
+        asyncTask: async () => {
+            // try to revert
+            try {
+                // revert
+                await editorApi.revertChangeSet({ changeSetId, changeIds: [collection.id] });
+                // reload if it was already published (just a revert)
+                if (collection.published) {
+                    // reload
+                    await controller.reload();
+                }
+                // or indicate success
+                return { success: true };
+            }
+            // or indicate failure
+            catch (e) {
+                return {
+                    success: false,
+                    error: e instanceof Error
+                        ? e
+                        : new funnel_core_1.ServerError('Something prevented us from reverting changes to this page - please try again later.')
+                };
+            }
+        }
+    });
+    // go back if collection was a draft (nothing to look at)
+    if (!collection.published) {
+        await router.navigateToCollectionItems({ type: collection.type });
+    }
+}

package/dist/collection/components/index.d.ts

@@ -0,0 +1,3 @@
+export * from './CollectionHeader';
+export * from './CollectionNotCreated';
+export * from './CollectionStatus';

package/dist/collection/components/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./CollectionHeader"), exports);
+__exportStar(require("./CollectionNotCreated"), exports);
+__exportStar(require("./CollectionStatus"), exports);

package/dist/collection/components/status/AutoSave.d.ts

@@ -0,0 +1,6 @@
+export declare function AutoSave({ className }: AutoSave.Props): import("react/jsx-runtime").JSX.Element;
+export declare namespace AutoSave {
+    type Props = {
+        className?: string;
+    };
+}

package/dist/collection/components/status/AutoSave.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutoSave = AutoSave;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const client_1 = require("@nascentdigital/funnel-ui/client");
+const core_1 = require("../../../core");
+const hooks_1 = require("../../hooks");
+// component
+function AutoSave({ className }) {
+    var _a;
+    // bind collection controller
+    const controller = (0, hooks_1.useCollectionController)();
+    // sync collection (in case of reload)
+    (0, core_1.useCollection)();
+    // force refresh every minute (required for stuff like "Last Saved" label)
+    (0, client_1.useRefresh)('1m');
+    // determine status
+    const { collection, state } = controller;
+    let status;
+    switch (state) {
+        case 'ready':
+            status = (collection === null || collection === void 0 ? void 0 : collection.modified)
+                ? 'changed'
+                : 'saved';
+            break;
+        case 'error':
+            status = 'error';
+            break;
+        default:
+            status = 'saving';
+            break;
+    }
+    // render
+    return ((0, jsx_runtime_1.jsx)(core_1.AutoSave, { className: className, status: status, lastSaved: (_a = collection === null || collection === void 0 ? void 0 : collection.updatedOn) !== null && _a !== void 0 ? _a : collection === null || collection === void 0 ? void 0 : collection.createdOn }));
+}

package/dist/collection/components/status/index.d.ts

@@ -0,0 +1 @@
+export * from './AutoSave';

package/dist/collection/components/status/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AutoSave"), exports);

package/dist/collection/hooks/CollectionController.d.ts

@@ -0,0 +1,40 @@
+import { EventBus } from '@nascentdigital/funnel-core';
+import { Collection, CollectionGroup, CollectionRepository, CollectionTarget, EditorApiClient } from '../../core';
+export declare class CollectionController {
+    private readonly _eventBus;
+    readonly repository: CollectionRepository;
+    private _state;
+    private _target?;
+    private _collectionGroup?;
+    private _collection?;
+    private _saveQueuedFor?;
+    private _subscription?;
+    constructor(editorApi: EditorApiClient);
+    get events$(): import("rxjs").Observable<Collection.Event | CollectionController.Event>;
+    get state(): CollectionController.State;
+    private set state(value);
+    get ready(): boolean;
+    get target(): CollectionTarget;
+    get languages(): ("id" | "is" | "tw" | "cy" | "fr" | "fy" | "to" | "br" | "hr" | "li" | "th" | "tr" | "no" | "aa" | "ab" | "ae" | "af" | "ak" | "am" | "an" | "ar" | "as" | "av" | "ay" | "az" | "ba" | "be" | "bg" | "bh" | "bi" | "bm" | "bn" | "bo" | "bs" | "ca" | "ce" | "ch" | "co" | "cr" | "cs" | "cu" | "cv" | "da" | "de" | "dv" | "dz" | "ee" | "el" | "en" | "eo" | "es" | "et" | "eu" | "fa" | "ff" | "fi" | "fj" | "fo" | "ga" | "gd" | "gl" | "gn" | "gu" | "gv" | "ha" | "he" | "hi" | "ho" | "ht" | "hu" | "hy" | "hz" | "ia" | "ie" | "ig" | "ii" | "ik" | "io" | "it" | "iu" | "ja" | "jv" | "ka" | "kg" | "ki" | "kj" | "kk" | "kl" | "km" | "kn" | "ko" | "kr" | "ks" | "ku" | "kv" | "kw" | "ky" | "la" | "lb" | "lg" | "ln" | "lo" | "lt" | "lu" | "lv" | "mg" | "mh" | "mi" | "mk" | "ml" | "mn" | "mr" | "ms" | "mt" | "my" | "na" | "nb" | "nd" | "ne" | "ng" | "nl" | "nn" | "nr" | "nv" | "ny" | "oc" | "oj" | "om" | "or" | "os" | "pa" | "pi" | "pl" | "ps" | "pt" | "qu" | "rm" | "rn" | "ro" | "ru" | "rw" | "sa" | "sc" | "sd" | "se" | "sg" | "si" | "sk" | "sl" | "sm" | "sn" | "so" | "sq" | "sr" | "ss" | "st" | "su" | "sv" | "sw" | "ta" | "te" | "tg" | "ti" | "tk" | "tl" | "tn" | "ts" | "tt" | "ty" | "ug" | "uk" | "ur" | "uz" | "ve" | "vi" | "vo" | "wa" | "wo" | "xh" | "yi" | "yo" | "za" | "zh" | "zu")[];
+    get collectionGroup(): CollectionGroup | undefined;
+    private set collectionGroup(value);
+    get collection(): Collection | undefined;
+    private set collection(value);
+    load(target: CollectionTarget, forced?: boolean): Promise<void>;
+    reload(): Promise<void>;
+    createLanguage(target: CollectionTarget): Promise<void>;
+    save(): Promise<void>;
+    unpublish(): Promise<void>;
+    private raiseEvent;
+}
+export declare namespace CollectionController {
+    type State = 'uninitialized' | 'initializing' | 'loading' | 'ready' | 'saving' | 'unpublishing' | 'error';
+    interface Event extends EventBus.Event<'CollectionController', Event.Type> {
+        controller: CollectionController;
+    }
+    namespace Event {
+        type Type = 'state.changed' | 'collection.changed' | 'collectionGroup.changed';
+        function filter(event: EventBus.Event): event is Event;
+        function create(event: EventBus.Args<Event>): Event;
+    }
+}

package/dist/collection/hooks/CollectionController.js

@@ -0,0 +1,320 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionController = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const rxjs_1 = require("rxjs");
+const core_1 = require("../../core");
+// class
+class CollectionController {
+    constructor(editorApi) {
+        // initialize instance variables
+        this._eventBus = new funnel_core_1.EventBus();
+        this.repository = new core_1.CollectionRepository(editorApi);
+        this._state = 'uninitialized';
+    }
+    get events$() {
+        return this._eventBus.events$
+            .pipe((0, rxjs_1.filter)(e => CollectionController.Event.filter(e) || core_1.Collection.Event.filter(e)));
+    }
+    get state() {
+        return this._state;
+    }
+    set state(value) {
+        var _a;
+        // skip if unchanged
+        if (this._state === value) {
+            console.debug('[CollectionController/state] skipping redundant update', value);
+            return;
+        }
+        // or update
+        this._state = value;
+        console.debug('[CollectionController/state] updated state', value);
+        // raise event
+        this.raiseEvent('state.changed');
+        // save again if it's queued for the same page
+        if (this._saveQueuedFor && this._saveQueuedFor === ((_a = this._collectionGroup) === null || _a === void 0 ? void 0 : _a.collection)) {
+            console.debug('[CollectionController/setState] initiating queued save');
+            this.save().catch(console.error);
+        }
+    }
+    get ready() {
+        const { _state } = this;
+        return _state !== 'uninitialized' && _state !== 'initializing';
+    }
+    get target() {
+        // throw if there's no target
+        const { _target } = this;
+        if (!_target) {
+            throw new funnel_core_1.InvalidOperationError('Attempt to access CollectionController.target before load');
+        }
+        // return target
+        return _target;
+    }
+    get languages() {
+        const brand = funnel_core_1.AppConfig.brandConfig();
+        return funnel_core_1.RegionsConfig.getLanguages(brand.regionalization);
+    }
+    get collectionGroup() {
+        return this._collectionGroup;
+    }
+    set collectionGroup(collectionGroup) {
+        // skip if group is the same
+        if (this._collectionGroup === collectionGroup) {
+            return;
+        }
+        // update group
+        this._collectionGroup = collectionGroup;
+        // raise event
+        this.raiseEvent('collectionGroup.changed');
+    }
+    get collection() {
+        return this._collection;
+    }
+    set collection(collection) {
+        // skip if collection is the same
+        if (this._collection === collection) {
+            console.debug('[CollectionController] ignoring collection change for', collection);
+            return;
+        }
+        // unbind previous subscription (if any)
+        if (this._subscription) {
+            this._subscription.unsubscribe();
+            delete this._subscription;
+        }
+        console.debug('[CollectionController] updating to new collection', collection);
+        // update collection
+        this._collection = collection;
+        // bind to collection group (should be bound)
+        if (this._collectionGroup) {
+            this._collectionGroup.collection = collection;
+        }
+        // subscribe to collection changes (if there's a page)
+        if (collection) {
+            console.debug('[CollectionController] binding subscription for', collection);
+            // subscribe to events
+            this._subscription = collection.events$
+                .pipe((0, rxjs_1.filter)(e => {
+                // handle collection events
+                if (core_1.Collection.Event.filter(e)) {
+                    return e.type === 'modified';
+                }
+                // or item/object/list events
+                else if (core_1.Item.Event.filter(e)
+                    || core_1.Item.Event.filter(e)
+                    || funnel_core_1.ObjectField.Event.filter(e)
+                    || funnel_core_1.FieldList.Event.filter(e)) {
+                    return e.type === 'changed';
+                }
+                // or field
+                else {
+                    return funnel_core_1.Field.Event.filter(e) && (e.type === 'changed' || e.type === 'reset');
+                }
+            }), (0, rxjs_1.debounce)(e => {
+                if ((core_1.Collection.Event.filter(e) && e.type === 'modified')
+                    || core_1.Item.Event.filter(e)
+                    || funnel_core_1.FieldList.Event.filter(e)
+                    || (funnel_core_1.Field.Event.filter(e) && e.field.isComposite)) {
+                    return (0, rxjs_1.interval)(0);
+                }
+                else {
+                    return (0, rxjs_1.interval)(2000);
+                }
+            }))
+                .subscribe(async () => {
+                var _a;
+                if (collection.modified && ((_a = this._collectionGroup) === null || _a === void 0 ? void 0 : _a.collection) === collection) {
+                    console.debug('[CollectionController] saving modified collection', collection);
+                    await this.save();
+                }
+                else {
+                    console.debug('[CollectionController] ignoring change for zombie collection', collection);
+                }
+            });
+            // save collection immediately if modified (this is a re-entrant call, so we can't await it - trust me)
+            if (collection.modified) {
+                console.debug('[CollectionController] initiating immediate save', collection);
+                this.save().catch(console.error);
+            }
+        }
+        // raise event
+        this.raiseEvent('collection.changed');
+    }
+    async load(target, forced = false) {
+        // skip if target is the same
+        if (!forced && core_1.CollectionTarget.equals(this._target, target)) {
+            return;
+        }
+        // bind target
+        this._target = target;
+        // mark as loading (or initialing if loading for first time)
+        this.state = this._state === 'uninitialized'
+            ? 'initializing'
+            : 'loading';
+        // try to fetch new page
+        try {
+            // load summary/page
+            const collectionGroup = await this.repository.load(Object.assign(Object.assign({}, target), { eventBus: this._eventBus }));
+            console.debug('[CollectionController] loaded', collectionGroup);
+            // (re)bind group
+            this._collectionGroup = collectionGroup;
+            this.collection = collectionGroup === null || collectionGroup === void 0 ? void 0 : collectionGroup.collection;
+            // update state
+            this.state = 'ready';
+        }
+        // handle load error
+        catch (e) {
+            console.error('[CollectionController] failed to load collection', e);
+            // TODO: expose error
+            // set error state
+            this.state = 'error';
+        }
+    }
+    reload() {
+        // mark uninitialized
+        this.state = 'uninitialized';
+        // reload
+        return this.load(this.target, true);
+    }
+    async createLanguage(target) {
+        // make sure there is an existing group
+        const existingGroup = this._collectionGroup;
+        if (!existingGroup) {
+            throw new funnel_core_1.InvalidOperationError('cannot create language without an current group');
+        }
+        // bind target
+        this._target = target;
+        // mark as loading (or initialing if loading for first time)
+        this.state = this._state === 'uninitialized'
+            ? 'initializing'
+            : 'loading';
+        // try to fetch new collection
+        try {
+            // create language in existing group
+            const eventBus = this._eventBus;
+            const { template, language } = target;
+            const result = await this.repository.createLanguage({
+                eventBus,
+                language,
+                template,
+                groupId: existingGroup.groupId,
+                type: existingGroup.template.type,
+                version: 1
+            });
+            console.debug('[CollectionController] created', result);
+            // (re)bind data
+            this.collectionGroup = result;
+            this.collection = result.collection;
+            // update state
+            this.state = 'ready';
+        }
+        // handle load error
+        catch (e) {
+            console.error('[CollectionController] failed to create page', e);
+            // TODO: expose error
+            // set error state
+            this.state = 'error';
+        }
+    }
+    async save() {
+        // throw if there's no collection (shouldn't happen)
+        const { collection } = this;
+        if (collection === undefined) {
+            console.error('[CollectionController/save] cannot resolve collection in "ready" state');
+            throw new funnel_core_1.IllegalStateError('Collection unavailable in "ready" state');
+        }
+        // ignore if not ready
+        else if (this._state !== 'ready') {
+            console.debug(`[CollectionController/save] queuing save while in "${this._state}" state`);
+            this._saveQueuedFor = collection;
+            return;
+        }
+        // clear save if queued
+        delete this._saveQueuedFor;
+        // skip if collection isn't modified
+        if (!collection.modified) {
+            console.debug('[CollectionController/save] ignore unmodified collection');
+            return;
+        }
+        // try to save
+        try {
+            console.debug('[CollectionController/save] starting save');
+            // start sync
+            collection.syncing = true;
+            // update state
+            this.state = 'saving';
+            // save collection
+            this.collection = await this.repository.save(collection);
+            console.debug('[CollectionController/save] collection saved');
+            // update state
+            this.state = 'ready';
+        }
+        // handle error
+        catch (e) {
+            console.error('[CollectionController/save] save failed', e);
+            // update state
+            this.state = 'ready';
+            // TODO: how do we communicate errors to the app?
+        }
+        // end sync
+        finally {
+            collection.syncing = false;
+        }
+    }
+    async unpublish() {
+        // throw if there's no collection (shouldn't happen)
+        const collection = this._collection;
+        if (collection === undefined) {
+            console.error('[CollectionController/unpublish] cannot resolve page');
+            throw new funnel_core_1.IllegalStateError('Collection is not found');
+        }
+        // throw if in an invalid state
+        else if (this._state !== 'ready') {
+            console.error('[CollectionController/unpublish] attempt to unpublish outside of "ready" state');
+            throw new funnel_core_1.IllegalStateError('Collection cannot be unpublished outside of "ready" state');
+        }
+        // try to publish
+        try {
+            console.debug('[CollectionController/unpublish] unpublishing');
+            // start sync
+            collection.syncing = true;
+            // change state
+            this.state = 'unpublishing';
+            // unpublish (and re-bind)
+            await this.repository.unpublish(collection);
+            console.debug('[CollectionController/unpublish] unpublish complete');
+            // mark as ready
+            this.state = 'ready';
+        }
+        // handle error
+        catch (e) {
+            console.error('[CollectionController/unpublish] save failed');
+            // update state
+            this.state = 'ready';
+            // rethrow error
+            throw e;
+        }
+        // end sync
+        finally {
+            collection.syncing = false;
+        }
+    }
+    raiseEvent(type) {
+        this._eventBus.publish(CollectionController.Event.create({ type, controller: this }));
+    }
+}
+exports.CollectionController = CollectionController;
+// extension
+(function (CollectionController) {
+    let Event;
+    (function (Event) {
+        // methods
+        function filter(event) {
+            return event.domain === 'CollectionController';
+        }
+        Event.filter = filter;
+        function create(event) {
+            return funnel_core_1.EventBus.createEvent(Object.assign({ domain: 'CollectionController' }, event));
+        }
+        Event.create = create;
+    })(Event = CollectionController.Event || (CollectionController.Event = {}));
+})(CollectionController || (exports.CollectionController = CollectionController = {}));

package/dist/collection/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './CollectionController';
+export * from './useCollectionController';