@nascentdigital/funnel-cms 4.4.4

package/dist/strapi/serialization/CollectionData.d.ts

@@ -0,0 +1,57 @@
+import { Language, RequiredBy, Schema } from '@nascentdigital/funnel-core';
+import { StrapiData } from '../models';
+import type { CollectionSnapshotData } from './CollectionSnapshotData';
+import { StrapiAssetData } from './StrapiAssetData';
+export type CollectionData = StrapiData & {
+    groupId: Schema.Collection.GroupId;
+    type: Schema.Collection.Type;
+    brand: string | null;
+    lang: Language;
+    version: number;
+    name: string;
+    tags: string;
+    fields: Schema.Collection.Data.ForFields;
+    assetRefs: StrapiAssetData[];
+    collectionRefs: CollectionData.Link[];
+    pageRefIds: string | null;
+    state: Schema.Collection.State;
+    errors: boolean;
+    changeSetId: Schema.ChangeSet.Id | null;
+    snapshot?: CollectionSnapshotData;
+    publishedOn?: string;
+};
+export declare namespace CollectionData {
+    type Link = Omit<CollectionData, 'snapshot'>;
+    type Ref = Omit<CollectionData, 'fields' | 'assetRefs' | 'collectionRefs' | 'snapshot'>;
+    const populate: {
+        readonly assetRefs: {
+            readonly populate: "*";
+        };
+        readonly collectionRefs: {
+            readonly fields: ("brand" | "type" | "tags" | "name" | "groupId" | "publishedOn" | "errors" | "version" | "fields" | "state" | "changeSetId" | "snapshot" | keyof StrapiData | "lang" | "assetRefs" | "collectionRefs" | "pageRefIds")[];
+            readonly populate: {
+                readonly assetRefs: {
+                    readonly populate: "*";
+                };
+            };
+        };
+        readonly snapshot: {
+            readonly populate: "*";
+        };
+    };
+    function withoutLinks<T extends Schema.Collection.Data.Props.All>(props: ReadonlyArray<T>): Exclude<T, Schema.Collection.Data.Props.Links>[];
+    function getStrapiFields(props: ReadonlyArray<Schema.Collection.Data.Props.All>): Array<keyof CollectionData>;
+    function getStrapiFilter(props: ReadonlyArray<Schema.Collection.Data.Props.All>): Array<keyof CollectionData>;
+    type Potential = RequiredBy<Partial<CollectionData>, StrapiData.Keys>;
+    function deserialize<TCollection extends Schema.Collection.Data>(data: Potential, strapiUrl: string, props?: ReadonlyArray<Schema.Collection.Data.Props.All>): TCollection;
+    function deserializeRef(data: Ref): Schema.Collection.Data.AsRef;
+    type Update = Omit<CollectionData, StrapiData.Keys | 'assetRefs' | 'collectionRefs'> & {
+        assetRefs?: {
+            set: Schema.Asset.Id[];
+        };
+        collectionRefs?: {
+            set: Schema.Collection.Id[];
+        };
+    };
+    function serialize(collection: Schema.Collection.Data.AsDraft | Schema.Collection.Data): Update;
+}

package/dist/strapi/serialization/CollectionData.js

@@ -0,0 +1,258 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionData = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const models_1 = require("../models");
+const StrapiAssetData_1 = require("./StrapiAssetData");
+// extension
+var CollectionData;
+(function (CollectionData) {
+    // constants
+    const collectionRefFields = getStrapiFields(funnel_core_1.Schema.Collection.Data.AsLink.props);
+    CollectionData.populate = {
+        assetRefs: { populate: '*' },
+        collectionRefs: {
+            fields: collectionRefFields,
+            populate: {
+                assetRefs: { populate: '*' }
+            }
+        },
+        snapshot: { populate: '*' }
+    };
+    // strip out any link props (file, collection) from props array
+    function withoutLinks(props) {
+        return props.filter(prop => !funnel_core_1.Schema.Collection.Data.Props.links.includes(prop));
+    }
+    CollectionData.withoutLinks = withoutLinks;
+    // map props
+    function getStrapiFields(props) {
+        return props
+            .filter(prop => prop !== '__root' && prop !== 'createdOn' && prop !== 'updatedOn' && prop !== 'snapshotId')
+            .map(prop => {
+            switch (prop) {
+                case 'language':
+                    return 'lang';
+                case 'files':
+                    return 'assetRefs';
+                case 'collections':
+                    return 'collectionRefs';
+                case 'pageIds':
+                    return 'pageRefIds';
+                default:
+                    return prop;
+            }
+        });
+    }
+    CollectionData.getStrapiFields = getStrapiFields;
+    function getStrapiFilter(props) {
+        // build list
+        const filters = new Set(['createdAt', 'updatedAt', 'publishedAt']);
+        for (const prop of props) {
+            switch (prop) {
+                // special handling
+                case 'language':
+                    filters.add('lang');
+                    break;
+                case 'pageIds':
+                    filters.add('pageRefIds');
+                    break;
+                // parity
+                case 'groupId':
+                case 'type':
+                case 'brand':
+                case 'version':
+                case 'name':
+                case 'tags':
+                case 'fields':
+                case 'state':
+                case 'errors':
+                case 'changeSetId':
+                case 'publishedOn':
+                    filters.add(prop);
+                    break;
+                // ignore the rest
+                default:
+                    break;
+            }
+        }
+        // return filters
+        return Array.from(filters);
+    }
+    CollectionData.getStrapiFilter = getStrapiFilter;
+    function deserialize(data, strapiUrl, props = funnel_core_1.Schema.Collection.Data.Props.all) {
+        var _a, _b;
+        // create output
+        const collection = Object.assign({}, models_1.StrapiData.deserialize(data));
+        const createdOn = Date.parse(data.createdAt);
+        const updatedOn = data.updatedAt ? Date.parse(data.updatedAt) : createdOn;
+        const files = ((_a = data.assetRefs) !== null && _a !== void 0 ? _a : []).map(data => StrapiAssetData_1.StrapiAssetData.deserialize(data, strapiUrl)).filter(funnel_core_1.Value.isDefined);
+        const collections = ((_b = data.collectionRefs) !== null && _b !== void 0 ? _b : []).map(collectionRef => deserialize(collectionRef, strapiUrl, funnel_core_1.Schema.Collection.Data.Props.all));
+        // add root if there's any content props
+        if (funnel_core_1.Schema.Collection.Data.Props.content.some(prop => props.includes(prop))) {
+            collection.__root = 'collection';
+        }
+        // helper
+        const bindProp = (prop, target, transform) => {
+            if (prop in data) {
+                collection[target] = transform(data[prop]);
+            }
+        };
+        // bind required props to page
+        for (const prop of props) {
+            switch (prop) {
+                // handled by base
+                case 'id':
+                    break;
+                // language
+                case 'language':
+                    bindProp('lang', prop, value => value !== null && value !== void 0 ? value : undefined);
+                    break;
+                // direct transforms
+                case 'groupId':
+                case 'type':
+                case 'brand':
+                case 'version':
+                case 'name':
+                case 'state':
+                case 'changeSetId':
+                case 'snapshot':
+                case 'errors':
+                    bindProp(prop, prop, value => value !== null && value !== void 0 ? value : undefined);
+                    break;
+                // snapshot
+                case 'snapshotId':
+                    if ('snapshot' in data && data.snapshot) {
+                        collection.snapshotId = data.snapshot.id;
+                    }
+                    break;
+                // tags
+                case 'tags':
+                    bindProp(prop, prop, value => JSON.parse(value !== null && value !== void 0 ? value : '[]'));
+                    break;
+                // content
+                case 'fields':
+                    bindProp(prop, prop, value => value !== null && value !== void 0 ? value : {});
+                    break;
+                // links
+                case 'files':
+                    collection.files = files;
+                    break;
+                case 'collections':
+                    collection.collections = collections;
+                    break;
+                case 'pageIds':
+                    bindProp('pageRefIds', prop, value => JSON.parse(value !== null && value !== void 0 ? value : '[]'));
+                    break;
+                // timestamps
+                case 'createdOn':
+                    bindProp('createdAt', prop, () => createdOn);
+                    break;
+                case 'updatedOn':
+                    bindProp('updatedAt', prop, value => updatedOn);
+                    break;
+                case 'publishedOn':
+                    bindProp(prop, prop, value => value ? parseInt(value) : undefined);
+                    break;
+                // unhandled
+                default:
+                    throw new funnel_core_1.NotImplementedError(`Missing support for transforming Collection "${prop}" prop`);
+            }
+        }
+        // return collection
+        return collection;
+    }
+    CollectionData.deserialize = deserialize;
+    // deserialize ref
+    function deserializeRef(data) {
+        var _a, _b, _c;
+        // transform directly (easier because we know what we're looking for)
+        const createdOn = Date.parse(data.createdAt);
+        const updatedOn = data.updatedAt ? Date.parse(data.updatedAt) : createdOn;
+        return Object.assign(Object.assign({}, models_1.StrapiData.deserialize(data)), { groupId: data.groupId, type: data.type, tags: JSON.parse((_a = data.tags) !== null && _a !== void 0 ? _a : '[]'), brand: (_b = data.brand) !== null && _b !== void 0 ? _b : undefined, language: (_c = data.lang) !== null && _c !== void 0 ? _c : undefined, version: data.version, name: data.name, state: data.state, errors: data.errors, createdOn,
+            updatedOn, publishedOn: data.publishedOn ? parseInt(data.publishedOn) : undefined });
+    }
+    CollectionData.deserializeRef = deserializeRef;
+    function serialize(collection) {
+        var _a, _b, _c;
+        // serialize base collection data
+        const base = {
+            groupId: collection.groupId,
+            type: collection.type,
+            tags: JSON.stringify(collection.tags),
+            brand: (_a = collection.brand) !== null && _a !== void 0 ? _a : null,
+            lang: collection.language,
+            version: collection.version,
+            name: collection.name,
+            changeSetId: (_b = collection.changeSetId) !== null && _b !== void 0 ? _b : null
+        };
+        // serialize existing collection
+        if ('id' in collection && collection.id !== funnel_core_1.Schema.Collection.Id.draft) {
+            // grab all refs
+            const assets = new Set();
+            const pages = new Set();
+            const collections = new Set();
+            const body = funnel_core_1.ObjectUtils.transform({
+                value: {
+                    fields: collection.fields
+                },
+                recurse: ({ value }) => !funnel_core_1.Schema.Asset.filter(value)
+                    && !funnel_core_1.Schema.Field.Data.InternalLink.filter(value)
+                    && !funnel_core_1.Schema.Field.Data.Collection.Ref.filter(value)
+                    && !funnel_core_1.Schema.Field.Data.Page.filter(value),
+                transform: ({ value }) => {
+                    // transform files
+                    if (funnel_core_1.Schema.Asset.filter(value)) {
+                        // track file (if it's real)
+                        const assetId = funnel_core_1.Schema.Asset.getId(value);
+                        if (assetId) {
+                            assets.add(assetId);
+                        }
+                        // return value (don't transform)
+                        return value;
+                    }
+                    // track page links
+                    else if (funnel_core_1.Schema.Field.Data.InternalLink.filter(value)) {
+                        // track page (only if the id's real)
+                        const pageId = funnel_core_1.Schema.Field.Data.InternalLink.getId(value);
+                        if (pageId && pageId !== funnel_core_1.Schema.Page.Id.draft) {
+                            pages.add(pageId);
+                        }
+                        // return value (don't transform)
+                        return value;
+                    }
+                    // transform collections
+                    else if (funnel_core_1.Schema.Field.Data.Collection.Ref.filter(value)) {
+                        // track collection (only if the id's real)
+                        const collectionId = funnel_core_1.Schema.Field.Data.Collection.Ref.getId(value);
+                        if (collectionId && collectionId !== funnel_core_1.Schema.Collection.Id.draft) {
+                            collections.add(collectionId);
+                        }
+                        // return value (don't transform)
+                        return value;
+                    }
+                    // transform pages
+                    else if (funnel_core_1.Schema.Field.Data.Page.filter(value)) {
+                        // track page (only if the id's real)
+                        const pageId = funnel_core_1.Schema.Field.Data.Page.getId(value);
+                        if (pageId && pageId !== funnel_core_1.Schema.Page.Id.draft) {
+                            pages.add(pageId);
+                        }
+                        // return value (don't transform)
+                        return value;
+                    }
+                    // or ignore
+                    else {
+                        return value;
+                    }
+                }
+            });
+            // bind update
+            return Object.assign(Object.assign(Object.assign({}, base), body), { assetRefs: { set: Array.from(assets) }, collectionRefs: { set: Array.from(collections) }, pageRefIds: JSON.stringify(Array.from(pages)), errors: collection.errors, state: collection.state, publishedOn: (_c = collection.publishedOn) === null || _c === void 0 ? void 0 : _c.toString() });
+        }
+        // or a new one
+        else {
+            return Object.assign(Object.assign({}, base), { fields: {}, errors: true, state: 'draft', changeSetId: null, pageRefIds: null });
+        }
+    }
+    CollectionData.serialize = serialize;
+})(CollectionData || (exports.CollectionData = CollectionData = {}));

package/dist/strapi/serialization/CollectionSnapshotData.d.ts

@@ -0,0 +1,16 @@
+import { Language, Schema } from '@nascentdigital/funnel-core';
+import { StrapiData } from '../models';
+export type CollectionSnapshotData = StrapiData & {
+    groupId: Schema.Collection.GroupId;
+    type: Schema.Collection.Type;
+    brand: string | null;
+    lang: Language;
+    version: number;
+    name: string;
+    tags: string;
+    fields: Schema.Collection.Data.ForFields;
+    changeSetId: Schema.ChangeSet.Id;
+};
+export declare namespace CollectionSnapshotData {
+    function deserialize(data: CollectionSnapshotData): Schema.CollectionSnapshot;
+}

package/dist/strapi/serialization/CollectionSnapshotData.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionSnapshotData = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const models_1 = require("../models");
+// extension
+// extension
+var CollectionSnapshotData;
+(function (CollectionSnapshotData) {
+    // deserialize (handles all cases safely)
+    function deserialize(data) {
+        var _a;
+        // create output
+        const snapshot = Object.assign({}, models_1.StrapiData.deserialize(data));
+        const createdOn = Date.parse(data.createdAt);
+        const updatedOn = data.updatedAt ? Date.parse(data.updatedAt) : createdOn;
+        // helper
+        const bindProp = (prop, target, transform) => {
+            if (prop in data) {
+                snapshot[target] = transform(data[prop]);
+            }
+        };
+        // bind required props to changeset
+        for (const prop of funnel_core_1.Schema.CollectionSnapshot.props) {
+            switch (prop) {
+                // handled by base
+                case 'id':
+                    break;
+                // language
+                case 'language':
+                    bindProp('lang', prop, value => value !== null && value !== void 0 ? value : undefined);
+                    break;
+                // direct transforms
+                case 'groupId':
+                case 'type':
+                case 'brand':
+                case 'version':
+                case 'name':
+                case 'changeSetId':
+                    snapshot[prop] = (_a = data[prop]) !== null && _a !== void 0 ? _a : undefined;
+                    break;
+                // tags
+                case 'tags':
+                    bindProp(prop, prop, value => JSON.parse(value !== null && value !== void 0 ? value : '[]'));
+                    break;
+                // content
+                case 'fields':
+                    bindProp(prop, prop, value => value !== null && value !== void 0 ? value : {});
+                    break;
+                // timestamps
+                case 'createdOn':
+                    snapshot.createdOn = createdOn;
+                    break;
+                case 'updatedOn':
+                    snapshot.updatedOn = updatedOn;
+                    break;
+                // unhandled
+                default:
+                    throw new funnel_core_1.NotImplementedError(`Missing support for transforming CollectionSnapshot "${prop}" prop`);
+            }
+        }
+        // return change set
+        return snapshot;
+    }
+    CollectionSnapshotData.deserialize = deserialize;
+})(CollectionSnapshotData || (exports.CollectionSnapshotData = CollectionSnapshotData = {}));

package/dist/strapi/serialization/PageData.d.ts

@@ -0,0 +1,126 @@
+import { Language, RequiredBy, Schema } from '@nascentdigital/funnel-core';
+import { StrapiData } from '../models';
+import { CollectionData } from './CollectionData';
+import { StrapiAssetData } from './StrapiAssetData';
+import type { PageSnapshotData } from './PageSnapshotData';
+export type PageData = StrapiData & {
+    groupId: Schema.Page.GroupId;
+    type: Schema.Page.Type;
+    brand: string;
+    region: string;
+    lang: Language;
+    tags: string;
+    name: string;
+    slug: string | null;
+    url: string;
+    discover: Schema.Page.Data.Discover;
+    preview: Schema.Page.Data.Preview | null;
+    content: Schema.Page.Data.Content;
+    assetRefs: StrapiAssetData[];
+    pageRefs: PageData.Preview[];
+    collectionRefs: CollectionData[];
+    state: Schema.Page.State;
+    errors: boolean;
+    changeSetId: Schema.ChangeSet.Id | null;
+    snapshot?: PageSnapshotData;
+    publishedOn?: string;
+    publication?: string;
+};
+export declare namespace PageData {
+    type Ref = Omit<PageData, 'discover' | 'preview' | 'content' | 'assetRefs' | 'pageRefs' | 'collectionRefs' | 'snapshot'>;
+    type Preview = Omit<PageData, 'discover' | 'content' | 'snapshot'>;
+    namespace Populate {
+        const full: {
+            assetRefs: {
+                populate: string;
+            };
+            pageRefs: {
+                fields: ("content" | "brand" | "preview" | "type" | "tags" | "name" | "url" | "groupId" | "publishedOn" | "errors" | "state" | "changeSetId" | "snapshot" | "slug" | "region" | "discover" | "publication" | keyof StrapiData | "lang" | "assetRefs" | "collectionRefs" | "pageRefs")[];
+                populate: {
+                    assetRefs: {
+                        populate: string;
+                    };
+                    pageRefs: {
+                        fields: ("content" | "brand" | "preview" | "type" | "tags" | "name" | "url" | "groupId" | "publishedOn" | "errors" | "state" | "changeSetId" | "snapshot" | "slug" | "region" | "discover" | "publication" | keyof StrapiData | "lang" | "assetRefs" | "collectionRefs" | "pageRefs")[];
+                        populate: string;
+                    };
+                    collectionRefs: {
+                        fields: ("brand" | "type" | "tags" | "name" | "groupId" | "publishedOn" | "errors" | "version" | "fields" | "state" | "changeSetId" | "snapshot" | keyof StrapiData | "lang" | "assetRefs" | "collectionRefs" | "pageRefIds")[];
+                        populate: string;
+                    };
+                };
+            };
+            collectionRefs: {
+                readonly fields: ("brand" | "type" | "tags" | "name" | "groupId" | "publishedOn" | "errors" | "version" | "fields" | "state" | "changeSetId" | "snapshot" | keyof StrapiData | "lang" | "assetRefs" | "collectionRefs" | "pageRefIds")[];
+                readonly populate: {
+                    readonly assetRefs: {
+                        readonly populate: "*";
+                    };
+                    readonly collectionRefs: {
+                        readonly fields: ("brand" | "type" | "tags" | "name" | "groupId" | "publishedOn" | "errors" | "version" | "fields" | "state" | "changeSetId" | "snapshot" | keyof StrapiData | "lang" | "assetRefs" | "collectionRefs" | "pageRefIds")[];
+                        readonly populate: {
+                            readonly assetRefs: {
+                                readonly populate: "*";
+                            };
+                        };
+                    };
+                };
+            };
+            snapshot: {
+                populate: string;
+            };
+        };
+        const preview: {
+            assetRefs: {
+                populate: string;
+            };
+            pageRefs: {
+                fields: ("content" | "brand" | "preview" | "type" | "tags" | "name" | "url" | "groupId" | "publishedOn" | "errors" | "state" | "changeSetId" | "snapshot" | "slug" | "region" | "discover" | "publication" | keyof StrapiData | "lang" | "assetRefs" | "collectionRefs" | "pageRefs")[];
+                populate: {
+                    assetRefs: {
+                        populate: string;
+                    };
+                    pageRefs: {
+                        fields: readonly Schema.Page.Data.AsRef.Prop[];
+                    };
+                    collectionRefs: {
+                        fields: ("brand" | "type" | "tags" | "name" | "groupId" | "publishedOn" | "errors" | "version" | "fields" | "state" | "changeSetId" | "snapshot" | keyof StrapiData | "lang" | "assetRefs" | "collectionRefs" | "pageRefIds")[];
+                    };
+                };
+            };
+            collectionRefs: {
+                readonly fields: ("brand" | "type" | "tags" | "name" | "groupId" | "publishedOn" | "errors" | "version" | "fields" | "state" | "changeSetId" | "snapshot" | keyof StrapiData | "lang" | "assetRefs" | "collectionRefs" | "pageRefIds")[];
+                readonly populate: {
+                    readonly assetRefs: {
+                        readonly populate: "*";
+                    };
+                    readonly collectionRefs: {
+                        readonly fields: ("brand" | "type" | "tags" | "name" | "groupId" | "publishedOn" | "errors" | "version" | "fields" | "state" | "changeSetId" | "snapshot" | keyof StrapiData | "lang" | "assetRefs" | "collectionRefs" | "pageRefIds")[];
+                        readonly populate: {
+                            readonly assetRefs: {
+                                readonly populate: "*";
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    }
+    function getStrapiFields(props: ReadonlyArray<Schema.Page.Data.Props.All>): Array<keyof PageData>;
+    function getStrapiFilter(props: ReadonlyArray<Schema.Page.Data.Props.All>): Array<keyof PageData>;
+    type Potential = RequiredBy<Partial<PageData>, StrapiData.Keys>;
+    function deserialize<TPage extends Schema.Page.Data>(data: Potential, strapiUrl: string, props?: ReadonlyArray<Schema.Page.Data.Props.All>): TPage;
+    function deserializeRef(data: Ref): Schema.Page.Data.AsLink;
+    type Update = Omit<PageData, StrapiData.Keys | 'assetRefs' | 'pageRefs' | 'collectionRefs'> & {
+        assetRefs?: {
+            set: Schema.Asset.Id[];
+        };
+        pageRefs?: {
+            set: Schema.Page.Id[];
+        };
+        collectionRefs?: {
+            set: Schema.Collection.Id[];
+        };
+    };
+    function serialize(page: Schema.Page.Data.AsDraft | Schema.Page.Data): Update;
+}