@nascentdigital/funnel-editor 4.6.7 → 5.0.2

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

@@ -1,5 +1,6 @@
-import { EventBus, Field, FieldList, Language, ObjectField, Schema } from '@nascentdigital/funnel-core';
+import { EventBus, Field, FieldList, FieldModel, Language, ObjectField, Schema } from '@nascentdigital/funnel-core';
 import type { Observable } from 'rxjs';
+import type { Asset } from './Asset';
 import type { Block } from './Block';
 import type { IAssetStore } from './IAssetStore';
 import type { ICollectionStore } from './ICollectionStore';
@@ -7,6 +8,7 @@ import type { IPageRefStore } from './IPageRefStore';
 import type { ITagged } from './ITagged';
 import type { Item } from './Item';
 import type { PageSettings } from './PageSettings';
+import type { PageSummary } from './PageSummary';
 import type { Section } from './Section';
 export interface IPage extends IAssetStore, ICollectionStore, IPageRefStore, ITagged {
     readonly template: Schema.Page;
@@ -24,6 +26,7 @@ export interface IPage extends IAssetStore, ICollectionStore, IPageRefStore, ITa
     readonly url: string;
     readonly createdOn: number;
     readonly updatedOn: number;
+    readonly asRef: IPage.Ref;
     publication: number | undefined;
     slug: string | undefined;
     deleteBlock(area: IPage.Area, key: string): void;
@@ -31,6 +34,7 @@ export interface IPage extends IAssetStore, ICollectionStore, IPageRefStore, ITa
 export declare namespace IPage {
     type Content = ReadonlyArray<Block | Section>;
     type Area = 'discover' | 'content';
+    type Savable = Section | Block | FieldModel;
     type Ref = {
         template: Schema.Page;
         id: Schema.Page.Id;
@@ -42,10 +46,21 @@ export declare namespace IPage {
         slug?: string;
         name: string;
         tags: Schema.Tag[];
+        state: Schema.Page.State;
+        errors: boolean;
         createdOn: number;
         updatedOn: number;
         publishedOn?: number;
     };
+    type References = {
+        pages: Ref[];
+        collections: Schema.Collection.Data.AsLink[];
+        assets: Asset[];
+    };
+    type WithSummary = {
+        summary: PageSummary;
+        page?: IPage;
+    };
     type Events = Event | Item.Event | Field.Event | ObjectField.Event | FieldList.Event;
     interface Event extends EventBus.Event<'Page', Event.Type> {
         page: IPage;

package/dist/core/domain/Page.js

@@ -296,11 +296,11 @@ class Page {
         return this.errors.items.length > 0;
     }
     get asRef() {
-        const { id, groupId, template, brand, region, language, slug, url, name, tags, createdOn, updatedOn, publishedOn } = this;
+        const { id, groupId, template, brand, region, language, slug, url, name, tags, state, hasErrors, createdOn, updatedOn, publishedOn } = this;
         return {
             id, groupId, template,
             brand, region, language, slug, url, name, tags: Array.from(tags),
-            createdOn, updatedOn, publishedOn
+            state, errors: hasErrors, createdOn, updatedOn, publishedOn
         };
     }
     /**

package/dist/core/domain/Pages.js

@@ -57,13 +57,11 @@ class Pages {
                 : 'syncing';
             // load all pages for the region
             const { site, template, pageType, tags } = this;
-            const { brand, region } = site;
-            const { items: pages } = await site.editorApi.searchPages({
-                brand: brand.id,
+            const { region } = site;
+            const { items: pages } = await site.repository.search({
+                template,
                 region: region.id,
-                type: pageType,
                 tags: tags.map(tag => tag.data),
-                version: 'draft',
                 pagination: 'all'
             });
             console.debug(`[PageCollection/sync] fetched ${pages.length} "${pageType}" pages`);
@@ -94,7 +92,7 @@ class Pages {
                     slug: page.slug,
                     name: page.name,
                     url: page.url,
-                    tags: page.tags,
+                    tags: page.tags.map(tag => tag.data),
                     state: page.state,
                     errors: page.errors,
                     createdOn: page.createdOn,

package/dist/core/domain/SectionBlock.js

@@ -66,7 +66,8 @@ class SectionBlock extends ItemBase_1.ItemBase {
         return this.block.errors;
     }
     getConfiguration() {
-        return new BlockConfiguration_1.BlockConfiguration({ block: this, assetStore: this.root });
+        const { root } = this;
+        return new BlockConfiguration_1.BlockConfiguration({ block: this, assetStore: root, collectionStore: root });
     }
     bind(parentContext) {
         // bind base

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

@@ -1,7 +1,7 @@
 import { BrandConfig, EventBus, Language, RegionsConfig, Schema } from '@nascentdigital/funnel-core';
 import { Observable } from 'rxjs';
 import { AppState } from '../app';
-import { EditorApiClient } from '../client';
+import { IPageRepository } from '../repository';
 import { PageOverview } from './PageOverview';
 import { Pages } from './Pages';
 export declare class Site {
@@ -10,7 +10,7 @@ export declare class Site {
     readonly brand: BrandConfig.WithId;
     readonly region: RegionsConfig.RegionConfig.WithId;
     readonly appState: AppState;
-    readonly editorApi: EditorApiClient;
+    readonly repository: IPageRepository;
     private readonly _eventBus;
     private _state;
     private _overviews;
@@ -18,7 +18,7 @@ export declare class Site {
     private readonly _pagesToSync;
     private _syncPromise?;
     private readonly _subscription;
-    constructor({ appState, editorApi, region }: Site.ConstructorArgs);
+    constructor({ appState, repository, region }: Site.ConstructorArgs);
     get events$(): Observable<Site.Event>;
     get state(): Site.State;
     private set state(value);
@@ -38,7 +38,7 @@ export declare namespace Site {
     type State = 'uninitialized' | 'initializing' | 'ready' | 'syncing' | 'error';
     type ConstructorArgs = {
         appState: AppState;
-        editorApi: EditorApiClient;
+        repository: IPageRepository;
         region: string;
     };
     interface Event extends EventBus.Event<'Site', Event.Type> {

package/dist/core/domain/Site.js

@@ -5,7 +5,7 @@ const funnel_core_1 = require("@nascentdigital/funnel-core");
 const Pages_1 = require("./Pages");
 // model
 class Site {
-    constructor({ appState, editorApi, region }) {
+    constructor({ appState, repository, region }) {
         // initialize instance variables
         const site = funnel_core_1.Schema.Site.current();
         const brand = funnel_core_1.AppConfig.brand();
@@ -15,14 +15,12 @@ class Site {
         this.brand = Object.assign(Object.assign({}, brandConfig), { id: brand });
         this.region = Object.assign(Object.assign({}, brandConfig.regionalization.regions[region]), { id: region });
         this.appState = appState;
-        this.editorApi = editorApi;
+        this.repository = repository;
         this._eventBus = new funnel_core_1.EventBus();
         this._state = 'uninitialized';
         this._overviews = [];
         this._pages = new Map();
         this._pagesToSync = new Set();
-        // start initial loading of data
-        this.sync().catch(console.error);
         // listen to app state for page changes
         this._subscription = this.appState.pageEvents$.subscribe(e => this.onPageEvent(e));
     }
@@ -118,7 +116,7 @@ class Site {
                     ? 'initializing'
                     : 'syncing';
                 // load overview
-                this._overviews = await this.editorApi.getPagesOverview({ region: this.region.id, version: 'draft' });
+                this._overviews = await this.repository.getOverview({ region: this.region.id });
                 // mark as ready
                 this.state = 'ready';
             }

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

@@ -9,6 +9,7 @@ export * from './CollectionGroup';
 export * from './CollectionSummary';
 export * from './Collections';
 export * from './IAssetStore';
+export * from './ICollection';
 export * from './ICollectionStore';
 export * from './IPage';
 export * from './IPageRefStore';
@@ -24,6 +25,5 @@ export * from './Pages';
 export * from './Section';
 export * from './SectionBlock';
 export * from './Site';
-export * from './TranslateSchema';
 export * from './UserBrowser';
 export * from './UserValidation';

package/dist/core/domain/index.js

@@ -25,6 +25,7 @@ __exportStar(require("./CollectionGroup"), exports);
 __exportStar(require("./CollectionSummary"), exports);
 __exportStar(require("./Collections"), exports);
 __exportStar(require("./IAssetStore"), exports);
+__exportStar(require("./ICollection"), exports);
 __exportStar(require("./ICollectionStore"), exports);
 __exportStar(require("./IPage"), exports);
 __exportStar(require("./IPageRefStore"), exports);
@@ -40,6 +41,5 @@ __exportStar(require("./Pages"), exports);
 __exportStar(require("./Section"), exports);
 __exportStar(require("./SectionBlock"), exports);
 __exportStar(require("./Site"), exports);
-__exportStar(require("./TranslateSchema"), exports);
 __exportStar(require("./UserBrowser"), exports);
 __exportStar(require("./UserValidation"), exports);

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

@@ -1,3 +1,4 @@
+export * from './useAssetRepository';
 export * from './useAssetStore';
 export * from './useBlock';
 export * from './useBlockConfiguration';
@@ -5,19 +6,19 @@ export * from './useChangeSet';
 export * from './useChangeSetBrowser';
 export * from './useCollection';
 export * from './useCollectionBrowser';
+export * from './useCollectionData';
 export * from './useCollectionFieldProxy';
 export * from './useCollectionRepository';
-export * from './useCollections';
 export * from './useCollectionStore';
-export * from './useCollectionData';
+export * from './useCollections';
 export * from './useField';
 export * from './useHotkeyScopeLock';
 export * from './usePage';
 export * from './usePageCollection';
 export * from './usePageRef';
+export * from './usePageRefStore';
 export * from './usePageRepository';
 export * from './usePages';
-export * from './usePageRefStore';
 export * from './useSite';
 export * from './useTempFields';
 export * from './useUserBrowser';

package/dist/core/hooks/index.js

@@ -14,6 +14,7 @@ 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("./useAssetRepository"), exports);
 __exportStar(require("./useAssetStore"), exports);
 __exportStar(require("./useBlock"), exports);
 __exportStar(require("./useBlockConfiguration"), exports);
@@ -21,19 +22,19 @@ __exportStar(require("./useChangeSet"), exports);
 __exportStar(require("./useChangeSetBrowser"), exports);
 __exportStar(require("./useCollection"), exports);
 __exportStar(require("./useCollectionBrowser"), exports);
+__exportStar(require("./useCollectionData"), exports);
 __exportStar(require("./useCollectionFieldProxy"), exports);
 __exportStar(require("./useCollectionRepository"), exports);
-__exportStar(require("./useCollections"), exports);
 __exportStar(require("./useCollectionStore"), exports);
-__exportStar(require("./useCollectionData"), exports);
+__exportStar(require("./useCollections"), exports);
 __exportStar(require("./useField"), exports);
 __exportStar(require("./useHotkeyScopeLock"), exports);
 __exportStar(require("./usePage"), exports);
 __exportStar(require("./usePageCollection"), exports);
 __exportStar(require("./usePageRef"), exports);
+__exportStar(require("./usePageRefStore"), exports);
 __exportStar(require("./usePageRepository"), exports);
 __exportStar(require("./usePages"), exports);
-__exportStar(require("./usePageRefStore"), exports);
 __exportStar(require("./useSite"), exports);
 __exportStar(require("./useTempFields"), exports);
 __exportStar(require("./useUserBrowser"), exports);

package/dist/core/hooks/useAssetRepository.d.ts

@@ -0,0 +1,3 @@
+import { IAssetRepository } from '../repository';
+export declare function useAssetRepository(): IAssetRepository;
+export declare const AssetRepositoryContext: import("react").Context<IAssetRepository>;

package/dist/core/hooks/useAssetRepository.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetRepositoryContext = void 0;
+exports.useAssetRepository = useAssetRepository;
+const react_1 = require("react");
+// hook
+function useAssetRepository() {
+    return (0, react_1.useContext)(exports.AssetRepositoryContext);
+}
+// context
+exports.AssetRepositoryContext = (0, react_1.createContext)({});

package/dist/core/hooks/useCollection.d.ts

@@ -1,9 +1,9 @@
-import { Collection } from '../domain';
-export declare function usePossibleCollection(): Collection | undefined;
-export declare function useCollection(): Collection;
+import { ICollection } from '../domain';
+export declare function usePossibleCollection(): ICollection | undefined;
+export declare function useCollection(): ICollection;
 export declare const CollectionContext: import("react").Context<CollectionContext.Data>;
 export declare namespace CollectionContext {
     type Data = {
-        collection?: Collection;
+        collection?: ICollection;
     };
 }

package/dist/core/hooks/useCollectionRepository.d.ts

@@ -1,2 +1,3 @@
-import { CollectionRepository } from '../repository';
-export declare function useCollectionRepository(): CollectionRepository;
+import { ICollectionRepository } from '../repository';
+export declare function useCollectionRepository<TRepository extends ICollectionRepository = ICollectionRepository>(): TRepository;
+export declare const CollectionRepositoryContext: import("react").Context<ICollectionRepository>;

package/dist/core/hooks/useCollectionRepository.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionRepositoryContext = void 0;
 exports.useCollectionRepository = useCollectionRepository;
 const react_1 = require("react");
-const client_1 = require("../client");
-const repository_1 = require("../repository");
 // hook
 function useCollectionRepository() {
-    const editorApi = (0, client_1.useEditorApi)();
-    return (0, react_1.useMemo)(() => new repository_1.CollectionRepository(editorApi), [editorApi]);
+    return (0, react_1.useContext)(exports.CollectionRepositoryContext);
 }
+// context
+exports.CollectionRepositoryContext = (0, react_1.createContext)({});

package/dist/core/hooks/useCollections.js

@@ -17,6 +17,10 @@ function usePossibleCollections() {
         if (!collections) {
             return;
         }
+        // sync if it's not ready
+        else if (collections.state === 'uninitialized') {
+            collections.sync().catch(console.error);
+        }
         // subscribe to changes
         const subscription = collections.events$.subscribe(() => touch());
         // unsubscribe on unmount

package/dist/core/hooks/usePageRepository.d.ts

@@ -1,2 +1,3 @@
-import { PageRepository } from '../repository';
-export declare function usePageRepository(): PageRepository;
+import { IPageRepository } from '../repository';
+export declare function usePageRepository<TRepository extends IPageRepository = IPageRepository>(): TRepository;
+export declare const PageRepositoryContext: import("react").Context<IPageRepository>;

package/dist/core/hooks/usePageRepository.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageRepositoryContext = void 0;
 exports.usePageRepository = usePageRepository;
 const react_1 = require("react");
-const client_1 = require("../client");
-const repository_1 = require("../repository");
 // hook
 function usePageRepository() {
-    const editorApi = (0, client_1.useEditorApi)();
-    return (0, react_1.useMemo)(() => new repository_1.PageRepository(editorApi), [editorApi]);
+    return (0, react_1.useContext)(exports.PageRepositoryContext);
 }
+// context
+exports.PageRepositoryContext = (0, react_1.createContext)({});

package/dist/core/hooks/useSite.js

@@ -17,6 +17,10 @@ function usePossibleSite() {
         if (!site) {
             return;
         }
+        // sync if it's not ready
+        else if (site.state === 'uninitialized') {
+            site.sync().catch(console.error);
+        }
         // subscribe to changes
         const subscription = site.events$.subscribe(() => touch());
         // unsubscribe on unmount

package/dist/core/hooks/useTempFields.d.ts

@@ -1,6 +1,5 @@
-import { Schema } from '@nascentdigital/funnel-core';
-import { TranslateSchema } from '../domain';
-export declare function useTempFields<TFields extends Record<string, Schema.Optional.Maybe<Schema.Field.Type>>>(schemasRaw: TFields, dependencies?: any[]): TranslateSchema.Fields<TFields>;
+import { Schema, SchemaToFields } from '@nascentdigital/funnel-core';
+export declare function useTempFields<TFields extends Record<string, Schema.Optional.Maybe<Schema.Field.Type>>>(schemasRaw: TFields, dependencies?: any[]): SchemaToFields<TFields>;
 export declare namespace useTempFields {
     type Args = {
         schemas: Record<string, Schema.Field.Type>;

package/dist/core/index.d.ts

@@ -2,6 +2,7 @@ export * from './app';
 export * from './auth';
 export * from './client';
 export * from './components';
+export * from './containers';
 export * from './domain';
 export * from './hooks';
 export * from './repository';

package/dist/core/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./app"), exports);
 __exportStar(require("./auth"), exports);
 __exportStar(require("./client"), exports);
 __exportStar(require("./components"), exports);
+__exportStar(require("./containers"), exports);
 __exportStar(require("./domain"), exports);
 __exportStar(require("./hooks"), exports);
 __exportStar(require("./repository"), exports);

package/dist/core/repository/AssetRepository.d.ts

@@ -0,0 +1,10 @@
+import { EditorApiClient } from '../client';
+import { IAssetRepository } from './IAssetRepository';
+export declare class AssetRepository implements IAssetRepository {
+    editorApi: EditorApiClient;
+    constructor(editorApi: EditorApiClient);
+    search(args: IAssetRepository.Search.Args): Promise<IAssetRepository.Search.Result>;
+    get(args: IAssetRepository.Get.Args): Promise<IAssetRepository.Get.Result>;
+    update(args: IAssetRepository.Update.Args): Promise<IAssetRepository.Update.Result>;
+    uploadFile(args: IAssetRepository.UploadFile.Args): Promise<IAssetRepository.UploadFile.Result>;
+}

package/dist/core/repository/AssetRepository.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetRepository = void 0;
+// class
+class AssetRepository {
+    constructor(editorApi) {
+        this.editorApi = editorApi;
+    }
+    async search(args) {
+        return this.editorApi.getAssets(args);
+    }
+    async get(args) {
+        return this.editorApi.getAsset(args);
+    }
+    async update(args) {
+        return this.editorApi.updateAsset(args);
+    }
+    async uploadFile(args) {
+        return this.editorApi.uploadFile(args);
+    }
+}
+exports.AssetRepository = AssetRepository;

package/dist/core/repository/CollectionRepository.d.ts

@@ -1,29 +1,30 @@
-import { CollectionClient } from '@nascentdigital/funnel-cms';
-import { EventBus, FieldModel } from '@nascentdigital/funnel-core';
+import { Schema } from '@nascentdigital/funnel-core';
 import { UpdateCollectionCommand } from '../../api/collections';
 import { EditorApiClient } from '../client';
-import { Collection, CollectionFieldProxy } from '../domain';
+import { Collection, CollectionFieldProxy, ICollection } from '../domain';
 import { CollectionTarget } from './CollectionTarget';
-export declare class CollectionRepository {
+import { ICollectionRepository } from './ICollectionRepository';
+export declare class CollectionRepository implements ICollectionRepository {
     readonly editorApi: EditorApiClient;
     constructor(editorApi: EditorApiClient);
-    load(args: CollectionTarget.WithEventBus): Promise<import("../domain").CollectionGroup | undefined>;
-    create({ eventBus, ...args }: CollectionRepository.CreateNewArgs): Promise<import("../domain").CollectionGroup>;
-    createLanguage(args: CollectionRepository.CreateLanguageArgs): Promise<import("../domain").CollectionGroup>;
+    load(args: CollectionTarget.WithEventBus): Promise<{
+        collection: Collection | undefined;
+        group: import("../domain").CollectionGroup;
+    } | undefined>;
+    createRaw(args: ICollectionRepository.CreateRaw.Args): Promise<Schema.Collection.Data.AsGroup>;
+    create({ eventBus, ...args }: ICollectionRepository.Create.Args): Promise<{
+        collection: Collection | undefined;
+        group: import("../domain").CollectionGroup;
+    }>;
+    createLanguage(args: ICollectionRepository.CreateLang.Args): Promise<{
+        collection: Collection | undefined;
+        group: import("../domain").CollectionGroup;
+    }>;
     save(collection: Collection): Promise<Collection>;
     unpublish(collection: Collection): Promise<void>;
-    serializeCollectionUpdate(collection: Collection | CollectionFieldProxy, savables: CollectionRepository.Savable[]): UpdateCollectionCommand.Data;
-    private serializeFieldsUpdate;
-    private serializeObjectFieldUpdate;
-    private serializeFieldUpdate;
-    private serializeListUpdate;
-}
-export declare namespace CollectionRepository {
-    type CreateNewArgs = Omit<CollectionClient.Create.NewArgs, 'brand' | 'type' | 'version'> & Pick<Collection.ConstructorArgs, 'template'> & {
-        eventBus?: EventBus;
-    };
-    type CreateLanguageArgs = Omit<CollectionClient.Create.NewLanguageArgs, 'brand'> & Pick<Collection.ConstructorArgs, 'template'> & {
-        eventBus: EventBus;
-    };
-    type Savable = FieldModel;
+    getOverview(args: ICollectionRepository.GetOverview.Args): Promise<ICollectionRepository.GetOverview.Result>;
+    getItems(args: ICollectionRepository.GetItems.Args): Promise<ICollectionRepository.GetItems.Result>;
+    get(args: ICollectionRepository.Get.Args): Promise<ICollectionRepository.Get.Result>;
+    update(args: ICollectionRepository.Update.Args): Promise<ICollectionRepository.Update.Result>;
+    serializeUpdate(collection: Collection | CollectionFieldProxy, savables: ICollection.Savable[]): UpdateCollectionCommand.Data;
 }