@nascentdigital/funnel-editor-contentful 5.0.1 → 5.0.2

package/dist/{core → collection}/domain/Collection.d.ts

@@ -1,6 +1,7 @@
-import { AssetClient } from '@nascentdigital/funnel-cms';
+import { AssetClient, CollectionClient } from '@nascentdigital/funnel-cms';
+import { ContentfulCollectionData, ContentfulData } from '@nascentdigital/funnel-cms/contentful';
 import { EventBus, Field, FieldModel, Language, Schema } from '@nascentdigital/funnel-core';
-import { Asset, CollectionGroup, ICollection, IPage } from '@nascentdigital/funnel-editor/components';
+import { Asset, CollectionFieldProxy, CollectionGroup, ICollection, IPage } from '@nascentdigital/funnel-editor/components';
 import { Observable } from 'rxjs';
 export declare class Collection implements ICollection {
     readonly template: Schema.Collection;
@@ -27,6 +28,7 @@ export declare class Collection implements ICollection {
     private _initialErrors;
     private _syncing;
     private _savingOn?;
+    readonly references: Readonly<ContentfulData.References>;
     constructor(args: Collection.ConstructorArgs);
     get events$(): Observable<ICollection.Events>;
     get stable$(): Observable<boolean>;
@@ -91,9 +93,16 @@ export declare namespace Collection {
         createdOn: number;
         updatedOn: number;
         publishedOn?: number;
+        references: ContentfulData.References;
     };
     type WithGroup = {
         group: CollectionGroup;
         collection?: Collection;
     };
+    type FromSchemaData = {
+        data: ContentfulCollectionData.ForSchema;
+        references?: Schema.Collection.References;
+    };
+    function fromSchemaData({ data, references }: FromSchemaData): Collection;
+    function toUpdates(collection: Collection | CollectionFieldProxy, savables: ICollection.Savable[]): CollectionClient.Update.Args;
 }

package/dist/{core → collection}/domain/Collection.js

@@ -1,4 +1,15 @@
 "use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Collection = void 0;
 const funnel_core_1 = require("@nascentdigital/funnel-core");
@@ -41,6 +52,7 @@ class Collection {
         this.createdOn = args.createdOn;
         this._updatedOn = args.updatedOn;
         this.publishedOn = args.publishedOn;
+        this.references = args.references;
         this._state = args.state;
         this._initialErrors = args.errors;
         this._syncing = false;
@@ -309,3 +321,66 @@ class Collection {
     }
 }
 exports.Collection = Collection;
+// extension
+(function (Collection) {
+    function fromSchemaData({ data, references }) {
+        // setup
+        const { snapshot, fields, tags } = data, collectionArgs = __rest(data, ["snapshot", "fields", "tags"]);
+        const { files = {}, collections = {} } = references !== null && references !== void 0 ? references : {};
+        const { fields: fieldsSnapshot = {} } = snapshot !== null && snapshot !== void 0 ? snapshot : {};
+        const template = funnel_core_1.Schema.Site.getCollection(data.type);
+        const eventBus = new funnel_core_1.EventBus();
+        // create collection
+        return new Collection(Object.assign(Object.assign({}, collectionArgs), { eventBus,
+            template, tags: components_1.TagSerializer.deserializeTags({
+                groups: template.tags,
+                tagsData: tags !== null && tags !== void 0 ? tags : []
+            }), fields: Object.entries(template.editableFields).map(([id, schema]) => components_1.FieldSerializer.deserializeField({
+                id,
+                eventBus,
+                schema,
+                content: fields[id],
+                snapshot: fieldsSnapshot[id]
+            })), files: Object.values(files), collections: Object.values(collections) }));
+    }
+    Collection.fromSchemaData = fromSchemaData;
+    function toUpdates(collection, savables) {
+        // add name updates
+        const { id, nameField, name, initialTags, tags, fields, initialErrors, valid } = collection;
+        const updates = [];
+        if (nameField.modified) {
+            updates.push({
+                type: 'collection',
+                property: 'name',
+                value: name
+            });
+            // track change
+            savables.push(nameField);
+        }
+        // add tag updates
+        if (initialTags.symmetricDifference(tags).size > 0) {
+            updates.push({
+                type: 'collection',
+                property: 'tags',
+                value: Array.from(tags).map(tag => tag.data)
+            });
+        }
+        // add errors updates
+        if (initialErrors !== !valid) {
+            updates.push({
+                type: 'collection',
+                property: 'errors',
+                value: !valid
+            });
+        }
+        // add fields
+        components_1.SerializeCollectionUpdate.serializeFieldsUpdate(updates, fields, ['fields'], savables);
+        // return updates
+        return {
+            id,
+            updates,
+            updatedOn: Date.now()
+        };
+    }
+    Collection.toUpdates = toUpdates;
+})(Collection || (exports.Collection = Collection = {}));

package/dist/{core → collection}/domain/index.d.ts

@@ -1,2 +1 @@
 export * from './Collection';
-export * from './Page';

package/dist/{core → collection}/domain/index.js

@@ -15,4 +15,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Collection"), exports);
-__exportStar(require("./Page"), exports);

package/dist/collection/index.d.ts

@@ -1,2 +1,3 @@
 export * from './screens';
 export * from './controller';
+export * from './repository';

package/dist/collection/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./screens"), exports);
 __exportStar(require("./controller"), exports);
+__exportStar(require("./repository"), exports);

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

@@ -0,0 +1,49 @@
+import { EditorAppSDK, EntrySys } from '@contentful/app-sdk';
+import { ContentfulContentClient } from '@nascentdigital/funnel-cms/contentful';
+import { Schema } from '@nascentdigital/funnel-core';
+import { CollectionFieldProxy, CollectionGroup, ICollection, ICollectionRepository } from '@nascentdigital/funnel-editor/components';
+import { Collection } from '../domain';
+export declare class CollectionRepository implements ICollectionRepository {
+    readonly sdk: EditorAppSDK;
+    readonly contentfulClient: ContentfulContentClient;
+    constructor(args: CollectionRepository.ConstructorArgs);
+    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>;
+    create(args: ICollectionRepository.Create.Args): Promise<ICollectionRepository.Create.Result>;
+    createRaw(args: ICollectionRepository.CreateRaw.Args): Promise<ICollectionRepository.CreateRaw.Result>;
+    createLanguage(args: ICollectionRepository.CreateLang.Args): Promise<ICollectionRepository.CreateLang.Result>;
+    update(args: ICollectionRepository.Update.Args): Promise<ICollectionRepository.Update.Result>;
+    serializeUpdate(collection: ICollection | CollectionFieldProxy, savables: ICollection.Savable[]): ICollectionRepository.SerializeUpdates.Result;
+    load(sys?: EntrySys): Promise<CollectionRepository.Load.Result>;
+    save(collection: Collection): Promise<Collection>;
+    sync({ collection, sys }: CollectionRepository.Sync.Args): Promise<CollectionRepository.Sync.Result>;
+    unpublish(collection: ICollection): Promise<void>;
+}
+export declare namespace CollectionRepository {
+    type ConstructorArgs = {
+        sdk: EditorAppSDK;
+        contentfulClient: ContentfulContentClient;
+    };
+    namespace Load {
+        type Args = {
+            collectionId?: Schema.Collection.Id;
+        };
+        type Result = {
+            collectionGroup: CollectionGroup;
+            collection: Collection;
+            sys: EntrySys;
+        };
+    }
+    namespace Sync {
+        type Args = {
+            collection: Collection;
+            sys: EntrySys;
+        };
+        type Result = {
+            collectionGroup?: CollectionGroup;
+            collection: Collection;
+            sys: EntrySys;
+        };
+    }
+}

package/dist/collection/repository/CollectionRepository.js

@@ -0,0 +1,210 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionRepository = void 0;
+const contentful_1 = require("@nascentdigital/funnel-cms/contentful");
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const components_1 = require("@nascentdigital/funnel-editor/components");
+const domain_1 = require("../domain");
+// repository
+class CollectionRepository {
+    constructor(args) {
+        // initialize instance
+        this.sdk = args.sdk;
+        this.contentfulClient = args.contentfulClient;
+    }
+    async getOverview(args) {
+        throw new funnel_core_1.NotImplementedError();
+    }
+    async getItems(args) {
+        throw new funnel_core_1.NotImplementedError();
+    }
+    async get(args) {
+        throw new funnel_core_1.NotImplementedError();
+    }
+    async create(args) {
+        throw new funnel_core_1.NotImplementedError();
+    }
+    async createRaw(args) {
+        throw new funnel_core_1.NotImplementedError();
+    }
+    async createLanguage(args) {
+        throw new funnel_core_1.NotImplementedError();
+    }
+    async update(args) {
+        throw new funnel_core_1.NotImplementedError();
+    }
+    serializeUpdate(collection, savables) {
+        throw new funnel_core_1.NotImplementedError();
+    }
+    async load(sys) {
+        // throw if entry isn't a collection (it should be in this case)
+        const { sdk, contentfulClient } = this;
+        const { entry } = sdk;
+        sys = sys !== null && sys !== void 0 ? sys : entry.getSys();
+        const { id: entryId, contentType: { sys: { id: entryType } } } = sys;
+        if (entryType !== contentful_1.ContentfulCollectionData.contentType) {
+            throw new funnel_core_1.ArgumentError(`Cannot load Collection from entry that isn't of "${contentful_1.ContentfulCollectionData.contentType}" type`);
+        }
+        // throw if page doesn't have a group id
+        const collectionId = entryId;
+        const type = entry.fields.type.getValue();
+        const groupId = entry.fields.groupId.getValue();
+        const brand = entry.fields.brand.getValue();
+        const language = funnel_core_1.Language.tryParse(entry.fields.language.getValue());
+        if (!groupId || !type || !brand || !language) {
+            throw new funnel_core_1.ArgumentError(`Collection "${collectionId}" is not configured (missing required fields)`);
+        }
+        // fetch remote data (throw if not found)
+        const result = await contentfulClient.collections.getGroup({ groupId, type, brand, language, version: 'draft' });
+        if (!result) {
+            throw new funnel_core_1.NotFoundError(`Unable to resolve Collection with id "${collectionId}"`);
+        }
+        const _a = result.group, { instances: collections } = _a, group = __rest(_a, ["instances"]), { collection: collectionResult } = result;
+        if (!collectionResult) {
+            throw new funnel_core_1.NotFoundError(`Unable to resolve Collection with id "${collectionId}"`);
+        }
+        // get entry data + remote references
+        const { data: _remote } = collectionResult, references = __rest(collectionResult, ["data"]);
+        const data = entryToCollectionData(entry);
+        // return collection model from data
+        const collection = domain_1.Collection.fromSchemaData(Object.assign({ data }, references));
+        return {
+            collectionGroup: new components_1.CollectionGroup(Object.assign({ template: collection.template, collections }, group)),
+            collection,
+            sys
+        };
+    }
+    async save(collection) {
+        // serialize collection updates (or skip if there are no changes)
+        const savables = [];
+        const updateArgs = domain_1.Collection.toUpdates(collection, savables);
+        if (updateArgs.updates.length === 0) {
+            return collection;
+        }
+        // start all updates
+        collection.onSaveStart();
+        savables.forEach(savable => savable.onSaveStart());
+        // update entry if page is local
+        let updatedOn;
+        const { sdk } = this;
+        const { entry } = sdk;
+        const { id: entryId, contentType: { sys: { id: entryType } } } = entry.getSys();
+        if (entryType === contentful_1.ContentfulCollectionData.contentType && collection.id === entryId) {
+            console.debug('[CollectionRepository/save] saving local entry', { entry, collection, updates: updateArgs.updates });
+            // save updates to entry
+            await saveEntryUpdates({ entry, updates: updateArgs.updates });
+            // capture updated timestamp
+            updatedOn = new Date(entry.getSys().updatedAt).getTime();
+        }
+        // or update remotely
+        else {
+            console.debug('[CollectionRepository/save] saving remote entry', collection);
+            // push updates remotely
+            const result = await this.contentfulClient.collections.update(updateArgs);
+            // capture update timestamp
+            updatedOn = result.updatedOn;
+            // swap to new collection (if update returned new data)
+            if (result.collection) {
+                console.debug('[PageRepository/save] switching to new page data', result.collection);
+                collection = domain_1.Collection.fromSchemaData(result.collection);
+            }
+        }
+        console.debug('[PageRepository/save] finalizing save');
+        // complete updates
+        savables.forEach(savable => savable.onSaveComplete());
+        collection.onSaveComplete(updatedOn);
+        console.debug('[PageRepository/save] save complete', collection);
+        // return collection
+        return collection;
+    }
+    async sync({ collection, sys }) {
+        // skip if entity version and updated sys are same
+        const { sdk } = this;
+        const { entry } = sdk;
+        const entrySys = entry.getSys();
+        if (sys.version === entrySys.version) {
+            console.debug('[ContentfulCollectionRepository/sync] ignoring unchanged entity');
+            return { collection, sys };
+        }
+        // force reload if entry references changed
+        const entryReferences = entry.fields.references.getValue();
+        const entryRefs = new Set(entryReferences.map(link => `${link.sys.linkType}.${link.sys.id}`));
+        const { references: collectionReferences } = collection;
+        const collectionRefs = new Set(collectionReferences.map(link => `${link.sys.linkType}.${link.sys.id}`));
+        if (!collectionRefs.isSupersetOf(entryRefs)) {
+            console.debug('[ContentfulCollectionRepository/sync] references changed - triggering reload');
+            return this.load(sys);
+        }
+        console.debug('[ContentfulCollectionRepository/sync] reusing stable references - merging entity');
+        // or load page data, but use old references in store
+        const data = entryToCollectionData(entry);
+        const references = {
+            files: collection.assets.reduce((files, file) => {
+                files[file.value.id] = file;
+                return files;
+            }, {}),
+            collections: collection.collections.reduce((collections, collection) => {
+                collections[collection.id] = collection;
+                return collections;
+            }, {}),
+        };
+        // create new page (use existing sys)
+        return {
+            collection: domain_1.Collection.fromSchemaData(Object.assign({ data }, references)),
+            sys
+        };
+    }
+    async unpublish(collection) {
+        throw new funnel_core_1.NotImplementedError();
+    }
+}
+exports.CollectionRepository = CollectionRepository;
+// helpers
+function entryToCollectionData(entry) {
+    // throw if it's not a page
+    const entryType = entry.getSys().contentType.sys.id;
+    if (entryType !== contentful_1.ContentfulCollectionData.contentType) {
+        throw new funnel_core_1.ArgumentError(`Expected entry to be "${contentful_1.ContentfulCollectionData.contentType}", but found "${entryType}"`);
+    }
+    // serialize entry (this is the latest data)
+    const entryData = contentful_1.ContentfulData.fromEntryData(entry);
+    return contentful_1.ContentfulCollectionData.deserialize(entryData);
+}
+async function saveEntryUpdates({ entry, updates }) {
+    var _a;
+    // serialize entry (this is the latest data)
+    const entryData = contentful_1.ContentfulData.fromEntryData(entry);
+    const collectionData = contentful_1.ContentfulCollectionData.deserialize(entryData);
+    // create model and apply updates
+    const collectionModel = new funnel_core_1.Schema.CollectionModel(collectionData);
+    collectionModel.update(updates);
+    collectionModel.sync();
+    // resolve references
+    const references = contentful_1.ContentfulData.findReferences([collectionData.fields]);
+    // update fields
+    const { fields } = entry;
+    await Promise.all([
+        // required updates
+        fields.name.setValue(collectionData.name),
+        fields.state.setValue(collectionData.state),
+        fields.errors.setValue(collectionData.errors),
+        fields.references.setValue(references),
+        // TODO: save only fields that changed
+        // conditional updates
+        fields.tags.setValue((_a = collectionData.tags) !== null && _a !== void 0 ? _a : []),
+        fields.fields.setValue(collectionData.fields),
+    ]);
+    // save entry
+    await entry.save();
+}

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

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

package/dist/collection/repository/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("./CollectionRepository"), exports);

package/dist/collection/screens/CollectionEditor.js

@@ -2,24 +2,41 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CollectionEditor = CollectionEditor;
 const jsx_runtime_1 = require("react/jsx-runtime");
+const funnel_core_1 = require("@nascentdigital/funnel-core");
 const components_1 = require("@nascentdigital/funnel-editor/components");
 const react_1 = require("react");
 const controller_1 = require("../controller");
 // component
 function CollectionEditor() {
     // hooks
-    const controllerContext = (0, controller_1.useLocalCollectionController)();
-    const { controller } = controllerContext;
-    const { collection } = controller;
+    const splash = (0, components_1.useSplash)();
+    const controller = (0, controller_1.useContentfulCollectionController)();
+    const { ready, collection } = controller;
     const collectionContext = (0, react_1.useMemo)(() => ({ collection }), [collection]);
     // sync with controller
     (0, components_1.useCollectionController)(controller);
     // load
     (0, react_1.useEffect)(() => {
-        controller.load().catch(console.error);
-    }, [controller]);
+        controller.load().catch(e => {
+            // transform error
+            const error = funnel_core_1.IsometricErrorUtils.coerceError(e);
+            // TODO: come up with an appropriate message
+            const message = error.message;
+            // show error via splash
+            splash.showError({ message, onRetry: () => controller.reload() });
+        });
+    }, [controller, splash]);
+    // dismiss splash when ready
+    (0, react_1.useEffect)(() => {
+        if (ready) {
+            splash.dismiss();
+        }
+        else {
+            splash.showLoading('Fetching content');
+        }
+    }, [splash, ready]);
     // render
-    return ((0, jsx_runtime_1.jsx)(components_1.CollectionControllerContext.Provider, { value: controllerContext, children: (0, jsx_runtime_1.jsx)(components_1.CollectionContext.Provider, { value: collectionContext, children: (0, jsx_runtime_1.jsx)(components_1.AssetStoreContext.Provider, { value: collection, children: (0, jsx_runtime_1.jsx)(components_1.CollectionStoreContext.Provider, { value: collection, children: (0, jsx_runtime_1.jsx)("div", { className: "w-dvw h-dvh flex flex-col bg-background", children: (0, jsx_runtime_1.jsx)("div", { className: "relative flex-1", children: (0, jsx_runtime_1.jsx)("div", { className: "absolute inset-0 flex", children: (0, jsx_runtime_1.jsx)("section", { className: "flex-1 h-full max-h-full max-w-[1000px] mx-auto", children: renderContent({ controller }) }) }) }) }) }) }) }) }));
+    return ((0, jsx_runtime_1.jsx)(components_1.CollectionContext.Provider, { value: collectionContext, children: (0, jsx_runtime_1.jsx)(components_1.AssetStoreContext.Provider, { value: collection, children: (0, jsx_runtime_1.jsx)(components_1.CollectionStoreContext.Provider, { value: collection, children: (0, jsx_runtime_1.jsx)("div", { className: "w-dvw h-dvh flex flex-col bg-background", children: (0, jsx_runtime_1.jsx)("div", { className: "relative flex-1", children: (0, jsx_runtime_1.jsx)("div", { className: "absolute inset-0 flex", children: (0, jsx_runtime_1.jsx)("section", { className: "flex-1 h-full max-h-full max-w-[1000px] mx-auto", children: renderContent({ controller }) }) }) }) }) }) }) }));
 }
 function renderContent({ controller }) {
     // render loader if not ready

package/dist/core/client/ContentfulClientContainer.d.ts

@@ -0,0 +1,8 @@
+import { KnownAppSDK } from '@contentful/app-sdk';
+import { PropsWithChildren } from 'react';
+export declare function ContentfulClientContainer({ sdk, children }: ContentfulClientContainer.Props): import("react/jsx-runtime").JSX.Element;
+export declare namespace ContentfulClientContainer {
+    type Props = PropsWithChildren & {
+        sdk: KnownAppSDK;
+    };
+}

package/dist/core/client/ContentfulClientContainer.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentfulClientContainer = ContentfulClientContainer;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const contentful_1 = require("@nascentdigital/funnel-cms/contentful");
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const react_1 = require("react");
+const ContentfulClientContext_1 = require("./ContentfulClientContext");
+// container
+function ContentfulClientContainer({ sdk, children }) {
+    // bind state
+    const [client, setClient] = (0, react_1.useState)(() => ({ __type: 'pending' }));
+    const context = (0, react_1.useMemo)(() => ({ client }), [client]);
+    // create client on mount
+    (0, react_1.useEffect)(() => {
+        // fetch client
+        let cancelled = false;
+        const mount = async () => {
+            // try to create
+            try {
+                // create editor
+                const client = await contentful_1.ContentfulContentClient.forEditor(sdk);
+                // bind if not cancelled
+                if (!cancelled) {
+                    setClient({ __type: 'success', result: client });
+                }
+            }
+            // or handle error (if not cancelled)
+            catch (e) {
+                if (!cancelled) {
+                    setClient({ __type: 'failure', error: funnel_core_1.IsometricErrorUtils.coerceError(e) });
+                }
+            }
+        };
+        mount().catch(console.error);
+        // cancel on unmount
+        return () => {
+            cancelled = true;
+        };
+    }, [sdk]);
+    // render
+    return ((0, jsx_runtime_1.jsx)(ContentfulClientContext_1.ContentfulClientContext.Provider, { value: context, children: client.__type === 'success' && children }));
+}

package/dist/core/client/ContentfulClientContext.d.ts

@@ -0,0 +1,8 @@
+import { ContentfulContentClient } from '@nascentdigital/funnel-cms/contentful';
+import { Result } from '@nascentdigital/funnel-core';
+export declare const ContentfulClientContext: import("react").Context<ContentfulClientContext.Data>;
+export declare namespace ContentfulClientContext {
+    type Data = {
+        client: Result<ContentfulContentClient>;
+    };
+}

package/dist/core/client/ContentfulClientContext.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentfulClientContext = void 0;
+const react_1 = require("react");
+// context
+exports.ContentfulClientContext = (0, react_1.createContext)({
+    client: { __type: 'pending' }
+});

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

@@ -0,0 +1,3 @@
+export * from './ContentfulClientContainer';
+export * from './ContentfulClientContext';
+export * from './useContentfulClient';

package/dist/core/client/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("./ContentfulClientContainer"), exports);
+__exportStar(require("./ContentfulClientContext"), exports);
+__exportStar(require("./useContentfulClient"), exports);

package/dist/core/client/useContentfulClient.d.ts

@@ -0,0 +1,4 @@
+import { ContentfulContentClient } from '@nascentdigital/funnel-cms/contentful';
+import { Result } from '@nascentdigital/funnel-core';
+export declare function usePossibleContentfulClient(): Result<ContentfulContentClient>;
+export declare function useContentfulClient(): ContentfulContentClient;

package/dist/core/client/useContentfulClient.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePossibleContentfulClient = usePossibleContentfulClient;
+exports.useContentfulClient = useContentfulClient;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const react_1 = require("react");
+const ContentfulClientContext_1 = require("./ContentfulClientContext");
+// hooks
+function usePossibleContentfulClient() {
+    // bind context
+    const { client } = (0, react_1.useContext)(ContentfulClientContext_1.ContentfulClientContext);
+    // return result
+    return client;
+}
+function useContentfulClient() {
+    // bind context
+    const { client } = (0, react_1.useContext)(ContentfulClientContext_1.ContentfulClientContext);
+    // throw if unavailable (shouldn't happen - see ContentfulClientContainer)
+    if (client.__type !== 'success') {
+        throw new funnel_core_1.IllegalStateError('ContentfulContentClient isn\'t available');
+    }
+    // return result
+    return client.result;
+}

package/dist/core/contentful/ContentfulAsset.d.ts

@@ -8,12 +8,12 @@ export type ContentfulAsset = Contentful.Base & {
     description?: string | null;
     brand?: string | null;
     type: string;
-    media: Contentful.Link.Asset;
-    metadata: object;
     scope: string;
-    tags?: string | null;
+    tags?: string[];
     url: string;
     size: number;
+    metadata: object;
+    media: Contentful.Link.Asset;
 };
 export declare namespace ContentfulAsset {
     const contentTypeId: "asset";