@nascentdigital/funnel-cms 5.0.3 → 6.0.1

package/dist/api/PageClient.d.ts

@@ -169,7 +169,7 @@ export declare namespace PageClient {
         type Result = Schema.Page.Data.AsGroup;
     }
     namespace Get {
-        type Args = (Query.ById | Query.ByDetails) & Query.Select;
+        type Args = Query.ById & Query.Select;
         type Result = Schema.Page.FlattenedData | undefined;
     }
     namespace Create {

package/dist/contentful/ContentfulCollectionClient.d.ts

@@ -6,7 +6,7 @@ export declare class ContentfulCollectionClient implements CollectionClient {
     readonly cms: IContentfulContentClient;
     constructor(cms: IContentfulContentClient);
     getOverview(args: CollectionClient.GetOverview.Args): Promise<CollectionClient.GetOverview.Result>;
-    getItems(args: CollectionClient.GetItems.Args): Promise<CollectionClient.GetItems.Result>;
+    getItems({ language, ...args }: CollectionClient.GetItems.Args): Promise<CollectionClient.GetItems.Result>;
     find(args: CollectionClient.Find.Args): Promise<CollectionClient.Find.Result>;
     getGroup(args: CollectionClient.GetGroup.Args): Promise<ContentfulCollectionClient.GetGroup.Result>;
     get(args: CollectionClient.Get.Args): Promise<ContentfulCollectionClient.Get.Result>;

package/dist/contentful/ContentfulCollectionClient.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.ContentfulCollectionClient = void 0;
 const funnel_core_1 = require("@nascentdigital/funnel-core");
@@ -9,10 +20,68 @@ class ContentfulCollectionClient {
         this.cms = cms;
     }
     async getOverview(args) {
-        throw new funnel_core_1.NotImplementedError();
+        // fetch all collections
+        const { cms } = this;
+        const { entries } = await cms.getEntries(Object.assign({ content_type: models_1.ContentfulCollectionData.contentType, version: args.version, select: getCollectionSelect(funnel_core_1.Schema.Collection.Data.AsRef.props) }, getCollectionQueryParams(args)));
+        // convert entries to collection data
+        const collectionsData = entries.map(entry => models_1.ContentfulCollectionData.deserialize(entry, funnel_core_1.Schema.Collection.Data.AsRef.props));
+        // group by type
+        const collectionsByType = new Map();
+        for (const data of collectionsData) {
+            // get group
+            let group = collectionsByType.get(data.type);
+            if (!group) {
+                collectionsByType.set(data.type, group = []);
+            }
+            // push to group
+            group.push(data);
+        }
+        // return in overview format
+        return funnel_core_1.Schema.Site.current().collections.map(({ type }) => {
+            var _a, _b;
+            return ({
+                type,
+                total: (_b = (_a = collectionsByType.get(type)) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0
+            });
+        });
     }
-    async getItems(args) {
-        throw new funnel_core_1.NotImplementedError();
+    async getItems(_a) {
+        var { language } = _a, args = __rest(_a, ["language"]);
+        // fetch all collections
+        const { cms } = this;
+        const { entries } = await cms.getEntries(Object.assign({ content_type: models_1.ContentfulCollectionData.contentType, version: args.version, select: getCollectionSelect(funnel_core_1.Schema.Collection.Data.AsRef.props) }, getCollectionQueryParams(args)));
+        // convert entries to collection data
+        const collectionsData = entries.map(entry => models_1.ContentfulCollectionData.deserialize(entry, funnel_core_1.Schema.Collection.Data.AsRef.props));
+        // group by group id
+        const collectionsByGroupId = new Map();
+        for (const data of collectionsData) {
+            // get group
+            let group = collectionsByGroupId.get(data.groupId);
+            if (!group) {
+                collectionsByGroupId.set(data.groupId, group = []);
+            }
+            // push to group
+            group.push(data);
+        }
+        // return in correct format
+        return collectionsByGroupId.entries().map(([groupId, refs]) => {
+            var _a;
+            // find ref with specified language
+            const target = (_a = refs.find(ref => ref.language === language)) !== null && _a !== void 0 ? _a : refs[0];
+            // return item
+            return {
+                id: target.id,
+                groupId: target.groupId,
+                type: args.type,
+                name: target.name,
+                refs: refs.reduce((refs, ref) => {
+                    // map ref
+                    refs[ref.language] = ref;
+                    // keep reducing
+                    return refs;
+                }, {})
+            };
+        }).toArray();
     }
     async find(args) {
         throw new funnel_core_1.NotImplementedError();
@@ -59,10 +128,109 @@ class ContentfulCollectionClient {
             entryId: args.id,
             version: args.version
         });
+        // skip if there's no entry
+        if (!entry) {
+            return undefined;
+        }
+        // or return it
         return Object.assign({ data: models_1.ContentfulCollectionData.deserialize(entry) }, models_1.ContentfulCollectionData.deserializeRefs(references));
     }
     async create(args) {
-        throw new funnel_core_1.NotImplementedError();
+        // create a new language of an existing collection
+        if (funnel_core_1.Schema.Collection.Data.AsNewLanguage.filter(args)) {
+            // fetch all collections in group
+            const groupResult = await this.getGroup({
+                version: 'draft',
+                type: args.type,
+                groupId: args.groupId,
+                language: args.language
+            });
+            // throw if group doesn't exist
+            if (!groupResult) {
+                throw new funnel_core_1.ArgumentError(`Collection group "${args.groupId}" no longer exists`);
+            }
+            // return existing collection if it's there
+            if (groupResult.collection) {
+                return groupResult;
+            }
+            // try to create page
+            try {
+                // create entry
+                const { group } = groupResult;
+                const collectionData = await this.cms.createEntry(models_1.ContentfulCollectionData.contentType, {
+                    type: args.type,
+                    brand: args.brand,
+                    version: args.version,
+                    groupId: args.groupId,
+                    language: args.language,
+                    name: group.name,
+                    references: [],
+                    tags: [],
+                    fields: {},
+                    state: 'draft',
+                    errors: true
+                });
+                // return updated group
+                return {
+                    group: Object.assign(Object.assign({}, group), { instances: [
+                            ...group.instances,
+                            models_1.ContentfulCollectionData.deserialize(collectionData, funnel_core_1.Schema.Collection.Data.AsGroup.Instance.props)
+                        ] }),
+                    collection: {
+                        data: models_1.ContentfulCollectionData.deserialize(collectionData),
+                        files: {},
+                        collections: {},
+                        pages: {}
+                    }
+                };
+            }
+            // or throw
+            catch (e) {
+                throw funnel_core_1.IsometricErrorUtils.coerceError(e);
+            }
+        }
+        // or create a net-new collection
+        else {
+            // try to create
+            try {
+                // create entry
+                const collectionData = await this.cms.createEntry(models_1.ContentfulCollectionData.contentType, {
+                    type: args.type,
+                    brand: args.brand,
+                    version: args.version,
+                    groupId: funnel_core_1.Value.uuid(),
+                    language: args.language,
+                    name: args.name,
+                    references: [],
+                    tags: [],
+                    fields: {},
+                    state: 'draft',
+                    errors: true
+                });
+                // return updated group
+                return {
+                    group: {
+                        brand: collectionData.brand,
+                        type: collectionData.type,
+                        groupId: collectionData.groupId,
+                        name: collectionData.name,
+                        instances: [
+                            models_1.ContentfulCollectionData.deserialize(collectionData, funnel_core_1.Schema.Collection.Data.AsGroup.Instance.props)
+                        ]
+                    },
+                    collection: {
+                        data: models_1.ContentfulCollectionData.deserialize(collectionData),
+                        files: {},
+                        collections: {},
+                        pages: {}
+                    }
+                };
+            }
+            // or throw
+            catch (e) {
+                throw funnel_core_1.IsometricErrorUtils.coerceError(e);
+            }
+        }
     }
     async duplicate(args) {
         throw new funnel_core_1.NotImplementedError();

package/dist/contentful/ContentfulContentClient.d.ts

@@ -33,7 +33,7 @@ export declare class ContentfulContentClient implements ContentClient, IContentf
     set token(token: AuthClient.AccessToken);
     clearToken(): void;
     createEntry<T extends ContentfulData>(contentTypeId: string, entry: ContentfulData.Draft<T>): Promise<T>;
-    getEntry<TEntry extends ContentfulData>({ entryId, includeLinks, version }: IContentfulContentClient.GetEntry.Args<TEntry>): Promise<IContentfulContentClient.GetEntry.Result<TEntry>>;
+    getEntry<TEntry extends ContentfulData>({ entryId, includeLinks, version, ...query }: IContentfulContentClient.GetEntry.Args<TEntry>): Promise<IContentfulContentClient.GetEntry.Result<TEntry>>;
     getEntries<TEntry extends ContentfulData>({ pagination, version, includeLinks, ...query }: IContentfulContentClient.GetEntries.Args<TEntry>): Promise<IContentfulContentClient.GetEntries.Result<TEntry>>;
     uploadAsset(args: IContentfulContentClient.UploadAsset.Args): Promise<IContentfulContentClient.UploadAsset.Result>;
     static forEditor(sdk: KnownAppSDK): Promise<ContentfulContentClient>;

package/dist/contentful/ContentfulContentClient.js

@@ -88,23 +88,22 @@ class ContentfulContentClient {
         // transform + return new entry
         return models_2.ContentfulData.fromCmaData(data, locale);
     }
-    async getEntry({ entryId, includeLinks = false, version = 'draft' }) {
-        var _a, _b;
+    async getEntry(_a) {
+        var _b, _c;
+        var { entryId, includeLinks = false, version = 'draft' } = _a, query = __rest(_a, ["entryId", "includeLinks", "version"]);
         // get entry
         const client = version === 'published' ? this.cda : this.cpa;
         const result = await client.entry.getMany({
-            query: {
-                'sys.id': entryId,
-                include: includeLinks === true
+            query: Object.assign(Object.assign({ 'sys.id': entryId }, query), { include: includeLinks === true
                     ? 10
-                    : includeLinks || undefined
-            }
+                    : includeLinks || undefined })
         });
         const { items: [item], includes } = result;
         console.debug('[ContentfulContentClient/getEntry] fetched', result);
+        // skip
         // bind references
-        const entry = models_2.ContentfulData.fromCdaData(item);
-        const references = (_b = (_a = includes === null || includes === void 0 ? void 0 : includes.Entry) === null || _a === void 0 ? void 0 : _a.map(link => models_2.ContentfulData.fromCdaData(link))) !== null && _b !== void 0 ? _b : [];
+        const entry = item ? models_2.ContentfulData.fromCdaData(item) : undefined;
+        const references = (_c = (_b = includes === null || includes === void 0 ? void 0 : includes.Entry) === null || _b === void 0 ? void 0 : _b.map(link => models_2.ContentfulData.fromCdaData(link))) !== null && _c !== void 0 ? _c : [];
         // return normalized item
         return { entry, references };
     }

package/dist/contentful/ContentfulPageClient.d.ts

@@ -21,7 +21,7 @@ export declare class ContentfulPageClient implements PageClient {
     unpublish(args: PageClient.Unpublish.Args): Promise<PageClient.Unpublish.Result>;
     getDependants(args: PageClient.GetDependants.Args): Promise<PageClient.GetDependants.Result>;
     getDependencies(args: PageClient.GetDependencies.Args): Promise<PageClient.GetDependencies.Result>;
-    validateSlug(args: PageClient.ValidateSlug.Args): Promise<PageClient.ValidateSlug.Result>;
+    validateSlug({ brand, type, region, slug, groupId }: PageClient.ValidateSlug.Args): Promise<PageClient.ValidateSlug.Result>;
 }
 export declare namespace ContentfulPageClient {
     type FlattedPageData = Omit<Schema.Page.FlattenedData, 'data'> & {

package/dist/contentful/ContentfulPageClient.js

@@ -119,19 +119,29 @@ class ContentfulPageClient {
         };
     }
     async get(args) {
-        // create args for query
-        const queryArgs = 'id' in args
-            ? { ids: [args.id], version: args.version }
-            : args;
         // fetch entries (should be one entry)
         const { cms } = this;
-        const { entries, references } = await cms.getEntries(Object.assign({ content_type: models_1.ContentfulPageData.contentType, includeLinks: true, version: args.version, pagination: { page: 1, pageSize: 1 } }, getPageQueryParams(queryArgs)));
+        const [{ entries, references }, { entry: entrySnapshot }] = await Promise.all([
+            // query target (could be published/draft)
+            cms.getEntries(Object.assign({ content_type: models_1.ContentfulPageData.contentType, includeLinks: true, version: args.version, pagination: { page: 1, pageSize: 1 }, select: getPageSelect(args.select === 'content'
+                    ? funnel_core_1.Schema.Page.Data.AsContent.props
+                    : funnel_core_1.Schema.Page.Data.Props.all) }, getPageQueryParams({ ids: [args.id] }))),
+            // query published (if pulling draft above)
+            args.version === 'draft'
+                ? cms.getEntry(Object.assign({ content_type: models_1.ContentfulPageData.contentType, entryId: args.id, includeLinks: false, version: 'published', select: getPageSelect(funnel_core_1.Schema.PageSnapshot.props) }, getPageQueryParams({ ids: [args.id] })))
+                : Promise.resolve({ entry: undefined, references: [] })
+        ]);
         // skip if no entries
         if (entries.length === 0) {
             return undefined;
         }
+        // stitch together snapshot with entry (if available
+        const data = models_1.ContentfulPageData.deserialize(entries[0]);
+        const snapshot = entrySnapshot
+            ? models_1.ContentfulPageData.Snapshot.deserialize(entrySnapshot)
+            : undefined;
         // use first entry and deserialize
-        return Object.assign({ data: models_1.ContentfulPageData.deserialize(entries[0]) }, models_1.ContentfulPageData.deserializeRefs(references));
+        return Object.assign({ data: Object.assign(Object.assign({}, data), { snapshotId: snapshot === null || snapshot === void 0 ? void 0 : snapshot.id, snapshot }) }, models_1.ContentfulPageData.deserializeRefs(references));
     }
     async create(args) {
         console.debug('[ContentfulPageClient/create] processing create page request', args);
@@ -353,8 +363,26 @@ class ContentfulPageClient {
     getDependencies(args) {
         throw new funnel_core_1.NotImplementedError();
     }
-    validateSlug(args) {
-        throw new funnel_core_1.NotImplementedError();
+    async validateSlug({ brand, type, region, slug, groupId }) {
+        // fetch items (bail if there are no instances)
+        const { cms } = this;
+        const { entries } = await cms.getEntries(Object.assign({ content_type: models_1.ContentfulPageData.contentType, version: 'draft', select: getPageSelect(funnel_core_1.Schema.Page.Data.AsLink.props) }, getPageQueryParams({ brand, type, region, slug })));
+        const links = entries.map(entry => models_1.ContentfulPageData.deserialize(entry, funnel_core_1.Schema.Page.Data.AsLink.props));
+        // ignore pages in same group (if group specified)
+        const matchedPages = groupId !== undefined
+            ? links.filter(link => link.groupId !== groupId)
+            : links;
+        // available if no pages matched
+        if (matchedPages.length === 0) {
+            return { status: 'available' };
+        }
+        // otherwise not available
+        else {
+            return {
+                status: 'unavailable',
+                takenBy: links[0]
+            };
+        }
     }
 }
 exports.ContentfulPageClient = ContentfulPageClient;

package/dist/contentful/IContentfulContentClient.d.ts

@@ -34,11 +34,11 @@ export declare namespace IContentfulContentClient {
         version?: Environment;
     };
     namespace GetEntry {
-        type Args<TEntry extends ContentfulData> = EntryQueryOptions & {
+        type Args<TEntry extends ContentfulData> = Pick<QueryOptions, 'content_type' | 'select'> & EntryQueryOptions & {
             entryId: ContentfulData.EntryId<TEntry>;
         };
         type Result<TEntry extends ContentfulData> = {
-            entry: TEntry;
+            entry: TEntry | undefined;
             references: ContentfulData[];
         };
     }

package/dist/contentful/models/ContentfulCollectionData.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContentfulCollectionData = void 0;
 const funnel_core_1 = require("@nascentdigital/funnel-core");
 const ContentfulAssetData_1 = require("./ContentfulAssetData");
+const ContentfulPageData_1 = require("./ContentfulPageData");
 // extension
 var ContentfulCollectionData;
 (function (ContentfulCollectionData) {
@@ -71,6 +72,7 @@ var ContentfulCollectionData;
         // setup
         const files = {};
         const collections = {};
+        const pages = {};
         // loop over references and serialize
         for (const ref of refs) {
             switch (ref.__type) {
@@ -86,12 +88,18 @@ var ContentfulCollectionData;
                     collections[collectionRef.id] = ContentfulCollectionData.deserialize(collectionRef, funnel_core_1.Schema.Collection.Data.AsLink.props);
                     break;
                 }
+                // page
+                case ContentfulPageData_1.ContentfulPageData.contentType: {
+                    const pageRef = ref;
+                    pages[pageRef.id] = ContentfulPageData_1.ContentfulPageData.deserialize(pageRef, funnel_core_1.Schema.Page.Data.AsLink.props);
+                }
             }
         }
         // return
         return {
             files,
-            collections
+            collections,
+            pages
         };
     }
     ContentfulCollectionData.deserializeRefs = deserializeRefs;

package/dist/contentful/models/ContentfulPageData.d.ts

@@ -12,6 +12,10 @@ export declare namespace ContentfulPageData {
         readonly asset: "files";
     };
     type ReferencesSpec = typeof referencesSpec;
+    type Snapshot = ContentfulData<ContentfulPageData.ContentType, Schema.PageSnapshot.Id> & Omit<Schema.PageSnapshot, 'id' | 'changeSetId'>;
+    namespace Snapshot {
+        function deserialize(snapshot: Snapshot): Schema.PageSnapshot;
+    }
     type ForSchema = Schema.Page.Data;
     type Potential = RequiredBy<Partial<ContentfulPageData>, keyof ContentfulData<ContentfulPageData.ContentType, Schema.Page.Id>>;
     function deserialize(data: Potential, props?: ReadonlyArray<Schema.Page.Data.Props.All>): ForSchema;

package/dist/contentful/models/ContentfulPageData.js

@@ -9,11 +9,21 @@ var ContentfulPageData;
 (function (ContentfulPageData) {
     // constants
     ContentfulPageData.contentType = 'page';
+    // references
     ContentfulPageData.referencesSpec = {
         'page': 'pages',
         'collection': 'collections',
         'asset': 'files'
     };
+    let Snapshot;
+    (function (Snapshot) {
+        function deserialize(snapshot) {
+            var _a, _b;
+            const data = ContentfulPageData.deserialize(snapshot, funnel_core_1.Schema.PageSnapshot.props);
+            return Object.assign(Object.assign({}, data), { changeSetId: ((_b = (_a = snapshot === null || snapshot === void 0 ? void 0 : snapshot.__version) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : 'unknown') });
+        }
+        Snapshot.deserialize = deserialize;
+    })(Snapshot = ContentfulPageData.Snapshot || (ContentfulPageData.Snapshot = {}));
     function deserialize(data, props = funnel_core_1.Schema.Page.Data.Props.all) {
         var _a;
         // create base page

package/dist/strapi/StrapiPageClient.js

@@ -187,33 +187,16 @@ class StrapiPageClient {
         const resultProps = args.select === 'content'
             ? funnel_core_1.Schema.Page.Data.AsContent.props
             : funnel_core_1.Schema.Page.Data.Props.all;
-        let data;
-        if ('id' in args) {
-            // find entry by document id
-            const { data: rawData } = await collection.findOne(args.id, {
-                fields: serialization_1.PageData.getStrapiFilter(resultProps),
-                status: args.version,
-                populate: serialization_1.PageData.Populate.full
-            });
-            // skip if there's no entry
-            if (!rawData) {
-                console.debug(`[StrapiPageClient/getPage] no "${args.version}" entry found for id ${args.id}`);
-                return undefined;
-            }
-            // or capture it
-            data = rawData;
-        }
-        // or by querying type (including region, and language)
-        else {
-            // lookup entry from collection (might be a miss)
-            const { data: rawData } = await collection.find(Object.assign({ fields: serialization_1.PageData.getStrapiFilter(resultProps), sort: ['updatedAt:desc'], populate: serialization_1.PageData.Populate.full }, getPageQueryParams(args)));
-            // skip if there's no entry
-            if (rawData.length === 0) {
-                console.warn(`[StrapiPageClient/getStaticPage] no "${args.version}" entry found for type ${args.type} in region ${args.region}/${args.language}`);
-                return undefined;
-            }
-            // or capture entry
-            data = rawData[0];
+        // find entry by document id
+        const { data } = await collection.findOne(args.id, {
+            fields: serialization_1.PageData.getStrapiFilter(resultProps),
+            status: args.version,
+            populate: serialization_1.PageData.Populate.full
+        });
+        // skip if there's no entry
+        if (!data) {
+            console.debug(`[StrapiPageClient/getPage] no "${args.version}" entry found for id ${args.id}`);
+            return undefined;
         }
         // convert and return
         return serialization_1.PageData.deserializeFlattened(data, strapiUrl, resultProps);

package/dist/strapi/serialization/CollectionData.js

@@ -181,7 +181,8 @@ var CollectionData;
         // return
         return {
             files,
-            collections
+            collections,
+            pages: {}
         };
     }
     CollectionData.deserializeRefs = deserializeRefs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nascentdigital/funnel-cms",
-  "version": "5.0.3",
+  "version": "6.0.1",
   "repository": {
     "url": "git+https://github.com/nascentdigital/funnel.git",
     "directory": "libs/cms"
@@ -48,5 +48,5 @@
     "ts-jest": "^29",
     "type-fest": "^4"
   },
-  "gitHead": "0d1cc7d78504e8819998d928ffb342d622f75690"
+  "gitHead": "83e335312f91fb90aae73dfc31b3df1ec1895f76"
 }