@nascentdigital/funnel-editor 4.4.18

package/dist/core/domain/Collection.js

@@ -0,0 +1,348 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Collection = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const rxjs_1 = require("rxjs");
+// model
+class Collection {
+    constructor(args) {
+        var _a, _b, _c, _d;
+        // initialize instance variables
+        this.template = args.template;
+        this.eventBus = args.eventBus;
+        this.id = args.id;
+        this.groupId = args.groupId;
+        this.brand = args.brand;
+        this.language = args.language;
+        this.version = args.version;
+        this.nameField = new funnel_core_1.Field({
+            id: 'name',
+            name: 'Name',
+            schema: funnel_core_1.Schema.Field.text({
+                name: 'Name',
+                description: `This is the name used to identify this ${args.template.name}.`,
+                hint: 'Please provide a name',
+                semantics: 'short',
+                required: true
+            }),
+            eventBus: args.eventBus,
+            initialValue: funnel_core_1.Schema.TextField.Value.toData(args.name),
+            publishedValue: funnel_core_1.Schema.TextField.Value.coerceData((_a = args.snapshot) === null || _a === void 0 ? void 0 : _a.name),
+            required: true
+        });
+        this._initialTags = new Set(args.tags);
+        this.pageIds = (_b = args.pageIds) !== null && _b !== void 0 ? _b : [];
+        this._tags = new Set(args.tags);
+        this.fields = args.fields;
+        this._assets = (_c = args.files) !== null && _c !== void 0 ? _c : [];
+        this._collections = (_d = args.collections) !== null && _d !== void 0 ? _d : [];
+        this._pages = [];
+        this._state = args.state;
+        this._initialErrors = args.errors;
+        this._changeSetId = args.changeSetId;
+        this.snapshotId = args.snapshotId;
+        this.snapshot = args.snapshot;
+        this.createdOn = args.createdOn;
+        this._updatedOn = args.updatedOn;
+        this.publishedOn = args.publishedOn;
+        this._syncing = false;
+    }
+    get asRef() {
+        const { template, brand, groupId, id, language, version, name, tags, state, valid, createdOn, updatedOn, publishedOn } = this;
+        return {
+            template, brand, groupId, id, language, version, name, tags: tags.values().toArray(),
+            state, errors: !valid, createdOn, updatedOn, publishedOn
+        };
+    }
+    get events$() {
+        return this.eventBus.events$;
+    }
+    get stable$() {
+        return this.eventBus.events$
+            .pipe((0, rxjs_1.map)(() => !this._syncing && !this.modified), (0, rxjs_1.distinctUntilChanged)());
+    }
+    get state() {
+        return this._state;
+    }
+    set state(state) {
+        // skip if unchanged
+        if (this._state === state) {
+            return;
+        }
+        // update state
+        this._state = state;
+        this._modifiedOn = Date.now();
+        // raise change
+        this.raiseEvent('changed');
+    }
+    get assets() {
+        return this._assets;
+    }
+    get collections() {
+        return this._collections;
+    }
+    get syncing() {
+        return this._syncing;
+    }
+    set syncing(syncing) {
+        this._syncing = syncing;
+        this.raiseEvent('changed');
+    }
+    get type() {
+        return this.template.type;
+    }
+    get allFields() {
+        const { nameField, fields } = this;
+        return [nameField, ...fields];
+    }
+    get name() {
+        var _a;
+        return (_a = funnel_core_1.Schema.TextField.Value.fromData(this.nameField.value)) !== null && _a !== void 0 ? _a : '';
+    }
+    set name(name) {
+        this.nameField.value = funnel_core_1.Schema.TextField.Value.toData(name);
+    }
+    get initialTags() {
+        return this._initialTags;
+    }
+    get tagGroups() {
+        return this.template.tags;
+    }
+    get tags() {
+        return this._tags;
+    }
+    addTag(tag) {
+        // skip if page has tag
+        const { _tags } = this;
+        if (_tags.has(tag)) {
+            return;
+        }
+        // add tag
+        _tags.add(tag);
+        this._modifiedOn = Date.now();
+        // raise event
+        this.raiseEvent('modified');
+    }
+    removeTag(tag) {
+        // skip if tag isn't there
+        const { _tags } = this;
+        if (!_tags.has(tag)) {
+            return;
+        }
+        // add tag
+        _tags.delete(tag);
+        this._modifiedOn = Date.now();
+        // raise event
+        this.raiseEvent('modified');
+    }
+    get published() {
+        return this.publishedOn !== undefined;
+    }
+    get updatedOn() {
+        return this._updatedOn;
+    }
+    get changeSetId() {
+        return this._changeSetId;
+    }
+    get valid() {
+        return this.errors.fields.length === 0;
+    }
+    get modified() {
+        const { nameField, initialTags, _tags, fields, initialErrors } = this;
+        return nameField.modified
+            || initialTags.symmetricDifference(_tags).size > 0
+            || fields.some(field => field.modified)
+            || initialErrors !== (this.errors.fields.length > 0);
+    }
+    get changes() {
+        return {
+            collection: this,
+            fields: this.allFields.filter(field => field.changed)
+        };
+    }
+    get initialErrors() {
+        return this._initialErrors;
+    }
+    get errors() {
+        return {
+            collection: this,
+            fields: this.allFields.filter(field => !field.valid)
+        };
+    }
+    getField(fieldId) {
+        // return name if matching
+        const { nameField, fields } = this;
+        if (fieldId === nameField.id) {
+            return nameField;
+        }
+        // get field (or throw)
+        const field = fields.find(field => field.id === fieldId);
+        if (!field) {
+            throw new funnel_core_1.IllegalStateError(`Unable to resolve field ${this.name}/${fieldId}`);
+        }
+        // return field
+        return field;
+    }
+    getTextField(fieldId) {
+        const field = this.getField(fieldId);
+        return field.schema instanceof funnel_core_1.Schema.TextField
+            ? field
+            : undefined;
+    }
+    getAssetScope(range) {
+        switch (range) {
+            case 'global':
+                return funnel_core_1.Schema.AssetScope.global;
+            case 'type':
+                return new funnel_core_1.Schema.CollectionTypeAssetScope(this.type);
+            case 'instance':
+                return new funnel_core_1.Schema.CollectionInstanceAssetScope(this.groupId);
+        }
+    }
+    getSearchScope() {
+        return {
+            target: 'collection',
+            type: this.type,
+            groupId: this.groupId
+        };
+    }
+    getAsset(id) {
+        return this._assets.find(asset => asset.value.id === id);
+    }
+    addAsset(asset) {
+        // replace asset if it exists
+        const { _assets } = this;
+        const { id } = asset.value;
+        const assetIndex = _assets.findIndex(asset => asset.value.id === id);
+        if (assetIndex >= 0) {
+            _assets[assetIndex] = asset;
+        }
+        // or add asset
+        else {
+            _assets.push(asset);
+        }
+        // raise event
+        this.raiseEvent('changed');
+    }
+    removeAsset(assetId) {
+        // skip if asset isn't there
+        const { _assets } = this;
+        const assetIndex = _assets.findIndex(asset => asset.value.id === assetId);
+        if (assetIndex < 0) {
+            return false;
+        }
+        // remove asset
+        _assets.splice(assetIndex, 1);
+        // raise event
+        this.raiseEvent('changed');
+        // indicate success
+        return true;
+    }
+    getCollection(collectionId) {
+        return this._collections.find(collection => collection.id === collectionId);
+    }
+    addCollection(collection) {
+        // replace collection if it exists
+        const { _collections } = this;
+        const collectionId = collection.id;
+        const collectionIndex = _collections.findIndex(collection => collection.id === collectionId);
+        if (collectionIndex >= 0) {
+            _collections[collectionIndex] = collection;
+        }
+        // or add collection
+        else {
+            _collections.push(collection);
+        }
+        // raise event
+        this.raiseEvent('changed');
+    }
+    removeCollection(collectionId) {
+        // skip if collection isn't there
+        const { _collections } = this;
+        const collectionIndex = _collections.findIndex(collection => collection.id === collectionId);
+        if (collectionIndex < 0) {
+            return false;
+        }
+        // remove collection
+        _collections.splice(collectionIndex, 1);
+        // raise event
+        this.raiseEvent('changed');
+        // indicate success
+        return true;
+    }
+    getPageRef(pageId) {
+        return pageId && pageId !== funnel_core_1.Schema.Page.Id.draft
+            ? this._pages.find(ref => ref.id === pageId)
+            : undefined;
+    }
+    addPageRef(page) {
+        // throw if page is a draft
+        if (page.id === funnel_core_1.Schema.Page.Id.draft) {
+            throw new funnel_core_1.InvalidOperationError('Cannot add draft Page as reference');
+        }
+        // replace ref if it exists
+        const { _pages } = this;
+        const pageId = page.id;
+        const refIndex = _pages.findIndex(ref => ref.id === pageId);
+        if (refIndex >= 0) {
+            _pages[refIndex] = page;
+        }
+        // or add ref
+        else {
+            _pages.push(page);
+        }
+        // raise event
+        this.raiseEvent('changed');
+    }
+    removePageRef(pageId) {
+        // skip if file isn't there
+        const { _pages } = this;
+        const refIndex = _pages.findIndex(ref => ref.id === pageId);
+        if (refIndex < 0) {
+            return false;
+        }
+        // remove file
+        _pages.splice(refIndex, 1);
+        // raise event
+        this.raiseEvent('changed');
+        // indicate success
+        return true;
+    }
+    onSaveStart() {
+        this._savingOn = Date.now();
+    }
+    onSaveComplete(updatedOn, changeSetId) {
+        // update fundamentals
+        this._updatedOn = updatedOn;
+        this._changeSetId = changeSetId;
+        this._state = 'draft';
+        // reset to values to match save
+        const { _modifiedOn, _savingOn } = this;
+        if (_savingOn && (!_modifiedOn || _savingOn >= _modifiedOn)) {
+            // sync data
+            this._initialErrors = !this.valid;
+            this._initialTags = new Set(this._tags);
+        }
+        // clear saving flag
+        delete this._savingOn;
+    }
+    raiseEvent(type) {
+        this.eventBus.publish(Collection.Event.create({ type, collection: this }));
+    }
+}
+exports.Collection = Collection;
+// extension
+(function (Collection) {
+    let Event;
+    (function (Event) {
+        // methods
+        function filter(event) {
+            return event.domain === 'Collection';
+        }
+        Event.filter = filter;
+        function create(event) {
+            return funnel_core_1.EventBus.createEvent(Object.assign({ domain: 'Collection' }, event));
+        }
+        Event.create = create;
+    })(Event = Collection.Event || (Collection.Event = {}));
+})(Collection || (exports.Collection = Collection = {}));

package/dist/core/domain/CollectionBrowser.d.ts

@@ -0,0 +1,40 @@
+import { EventBus, Schema } from '@nascentdigital/funnel-core';
+import { Observable } from 'rxjs';
+import { EditorApiClient } from '../client';
+import { CollectionSummary } from './CollectionSummary';
+export declare class CollectionBrowser {
+    readonly editorApi: EditorApiClient;
+    readonly overview: EditorApiClient.CollectionOverview;
+    private readonly _eventBus;
+    private _state;
+    private _items?;
+    private _syncPromise?;
+    constructor(args: CollectionBrowser.ConstructorArgs);
+    get events$(): Observable<CollectionBrowser.Event>;
+    get state(): CollectionBrowser.State;
+    private set state(value);
+    get ready(): boolean;
+    get type(): Schema.Collection.Type;
+    get template(): Schema.Collection;
+    get count(): number;
+    get items(): readonly CollectionSummary[];
+    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 defaultLanguage(): "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";
+    sync(): Promise<void>;
+    private raiseEvent;
+}
+export declare namespace CollectionBrowser {
+    type State = 'uninitialized' | 'initializing' | 'ready' | 'syncing' | 'error';
+    type ConstructorArgs = {
+        editorApi: EditorApiClient;
+        overview: EditorApiClient.CollectionOverview;
+    };
+    interface Event extends EventBus.Event<'CollectionBrowser', Event.Type> {
+        browser: CollectionBrowser;
+    }
+    namespace Event {
+        type Type = 'changed';
+        function filter(event: EventBus.Event): event is Event;
+        function create(event: EventBus.Args<Event>): Event;
+    }
+}

package/dist/core/domain/CollectionBrowser.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionBrowser = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const CollectionSummary_1 = require("./CollectionSummary");
+// class
+class CollectionBrowser {
+    constructor(args) {
+        // initialize instance variables
+        this.editorApi = args.editorApi;
+        this.overview = args.overview;
+        this._eventBus = new funnel_core_1.EventBus();
+        this._state = 'uninitialized';
+    }
+    get events$() {
+        return this._eventBus.events$;
+    }
+    get state() {
+        return this._state;
+    }
+    set state(state) {
+        // ignore if unchanged
+        if (this._state === state) {
+            return;
+        }
+        // update state
+        this._state = state;
+        // raise event
+        this.raiseEvent('changed');
+    }
+    get ready() {
+        return this._state === 'ready';
+    }
+    get type() {
+        return this.overview.type;
+    }
+    get template() {
+        return this.overview.template;
+    }
+    get count() {
+        return this.overview.count;
+    }
+    get items() {
+        var _a;
+        return (_a = this._items) !== null && _a !== void 0 ? _a : [];
+    }
+    get languages() {
+        return funnel_core_1.RegionsConfig.getLanguages(funnel_core_1.AppConfig.brandConfig().regionalization);
+    }
+    get defaultLanguage() {
+        return funnel_core_1.RegionsConfig.getDefaultLanguage(funnel_core_1.AppConfig.brandConfig().regionalization);
+    }
+    async sync() {
+        // return in-flight sync (if any)
+        if (this._syncPromise) {
+            return this._syncPromise;
+        }
+        // create sync
+        const onSync = async () => {
+            // get site map
+            try {
+                // mark as syncing
+                this.state = this._state === 'uninitialized'
+                    ? 'initializing'
+                    : 'syncing';
+                // load collections
+                const { editorApi, type, template, defaultLanguage } = this;
+                const brand = funnel_core_1.AppConfig.brand();
+                const language = funnel_core_1.RegionsConfig.getDefaultLanguage(funnel_core_1.AppConfig.brandConfig().regionalization);
+                this._items = (await editorApi.getCollectionItems({ version: 'draft', type, language }))
+                    .filter(({ refs }) => Object.keys(refs).length > 0)
+                    .map(({ groupId, name, refs }) => new CollectionSummary_1.CollectionSummary({
+                    template,
+                    brand,
+                    groupId,
+                    name,
+                    collections: Object.values(refs),
+                    defaultLanguage
+                }))
+                    .sort((lhs, rhs) => lhs.name.localeCompare(rhs.name));
+                // mark as ready
+                this.state = 'ready';
+            }
+            // TODO: handle error
+            catch (e) {
+                console.error('[CollectionBrowser/sync] refresh failed', e);
+                // move to error state
+                this.state = 'error';
+            }
+            // clear sync when complete
+            finally {
+                delete this._syncPromise;
+            }
+        };
+        // start sync (and capture)
+        this._syncPromise = onSync();
+        // return sync
+        return this._syncPromise;
+    }
+    raiseEvent(type) {
+        this._eventBus.publish(CollectionBrowser.Event.create({ type, browser: this }));
+    }
+}
+exports.CollectionBrowser = CollectionBrowser;
+// extension
+(function (CollectionBrowser) {
+    let Event;
+    (function (Event) {
+        // methods
+        function filter(event) {
+            return event.domain === 'CollectionBrowser';
+        }
+        Event.filter = filter;
+        function create(event) {
+            return funnel_core_1.EventBus.createEvent(Object.assign({ domain: 'CollectionBrowser' }, event));
+        }
+        Event.create = create;
+    })(Event = CollectionBrowser.Event || (CollectionBrowser.Event = {}));
+})(CollectionBrowser || (exports.CollectionBrowser = CollectionBrowser = {}));

package/dist/core/domain/CollectionFieldProxy.d.ts

@@ -0,0 +1,87 @@
+import { AssetClient } from '@nascentdigital/funnel-cms';
+import { EventBus, Field, FieldList, FieldModel, Language, ObjectField, Schema } from '@nascentdigital/funnel-core';
+import { Observable } from 'rxjs';
+import { type CollectionRepository } from '../repository';
+import { Asset } from './Asset';
+import { IAssetStore } from './IAssetStore';
+import { ICollectionStore } from './ICollectionStore';
+import { ITagged } from './ITagged';
+import { Item } from './Item';
+export declare class CollectionFieldProxy implements IAssetStore, ICollectionStore, ITagged {
+    readonly collectionRepository: CollectionRepository;
+    readonly collectionStore: ICollectionStore;
+    readonly assetStore: IAssetStore;
+    readonly schema: Schema.CollectionField;
+    readonly collectionSchema: Schema.Collection;
+    readonly language: Language;
+    readonly eventBus: EventBus;
+    private _initialValue?;
+    private _initialData?;
+    readonly nameField: Field<Schema.TextField>;
+    private _initialTags;
+    private readonly _tags;
+    readonly fields: ReadonlyArray<FieldModel>;
+    private _initialErrors;
+    private _syncing;
+    private _savingOn?;
+    private constructor();
+    get events$(): Observable<CollectionFieldProxy.Events>;
+    get stable$(): Observable<boolean>;
+    get id(): Schema.Collection.Id;
+    get type(): Schema.Collection.Type;
+    get assets(): ReadonlyArray<Asset>;
+    get collections(): ReadonlyArray<Schema.Collection.Data.AsLink>;
+    get groupId(): Schema.Collection.GroupId | undefined;
+    get isNew(): boolean;
+    get isRef(): boolean;
+    get allFields(): FieldModel[];
+    get name(): string;
+    set name(name: string);
+    get initialTags(): ReadonlySet<Schema.Tag<string, string>>;
+    get tagGroups(): ReadonlyArray<Schema.TagGroup>;
+    get tags(): ReadonlySet<Schema.Tag>;
+    addTag(tag: Schema.Tag): void;
+    removeTag(tag: Schema.Tag): void;
+    get syncing(): boolean;
+    private set syncing(value);
+    get valid(): boolean;
+    get initialErrors(): boolean;
+    get modified(): boolean;
+    get value(): Schema.CollectionField.Value;
+    getInlineData(): Schema.Collection.Data.AsInline;
+    getAssetScope(range: Schema.AssetScope.Range): Schema.AssetScope;
+    getSearchScope(): AssetClient.GetAssets.Scope;
+    getAsset(id: Asset.Id): Asset | undefined;
+    addAsset(asset: Asset): void;
+    removeAsset(assetId: Asset.Id): boolean;
+    getCollection(collectionId: Schema.Collection.Id): Schema.Collection.Data.AsLink | undefined;
+    addCollection(collection: Schema.Collection.Data.AsLink): void;
+    removeCollection(collectionId: Schema.Collection.Id): boolean;
+    onSaveStart(): void;
+    onSaveComplete(): void;
+    save(shared?: boolean): Promise<void>;
+    private raiseEvent;
+    static create(args: CollectionFieldProxy.CreateArgs): Promise<CollectionFieldProxy>;
+}
+export declare namespace CollectionFieldProxy {
+    type ConstructorArgs = {
+        collectionRepository: CollectionRepository;
+        collectionStore: ICollectionStore;
+        assetStore: IAssetStore;
+        schema: Schema.CollectionField;
+        collectionSchema: Schema.Collection;
+        language: Language;
+        initialValue?: Schema.CollectionField.Value;
+        initialData?: Schema.Collection.Data | Schema.Collection.Data.AsInline;
+    };
+    type CreateArgs = Omit<ConstructorArgs, 'initialData'>;
+    type Events = Event | Item.Event | Field.Event | ObjectField.Event | FieldList.Event;
+    interface Event extends EventBus.Event<'CollectionFieldProxy', Event.Type> {
+        collection: CollectionFieldProxy;
+    }
+    namespace Event {
+        type Type = 'changed' | 'modified';
+        function filter(event: EventBus.Event): event is Event;
+        function create(event: EventBus.Args<Event>): Event;
+    }
+}