@nascentdigital/funnel-cms 4.4.4

package/dist/strapi/serialization/PageData.js

@@ -0,0 +1,335 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageData = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const models_1 = require("../models");
+const CollectionData_1 = require("./CollectionData");
+const StrapiAssetData_1 = require("./StrapiAssetData");
+// extension
+var PageData;
+(function (PageData) {
+    // populate constants
+    let Populate;
+    (function (Populate) {
+        // populating collections doesn't change based on context used
+        const pageRefPreviewFields = getStrapiFields(withoutLinks(funnel_core_1.Schema.Page.Data.AsPreview.props));
+        const collectionRefFields = CollectionData_1.CollectionData.getStrapiFields(funnel_core_1.Schema.Collection.Data.AsLink.props);
+        const populateCollectionRefs = {
+            fields: collectionRefFields,
+            populate: {
+                assetRefs: { populate: '*' },
+                collectionRefs: {
+                    fields: collectionRefFields,
+                    populate: {
+                        assetRefs: { populate: '*' }
+                    }
+                }
+            }
+        };
+        // full page populate
+        Populate.full = {
+            assetRefs: { populate: '*' },
+            pageRefs: {
+                fields: pageRefPreviewFields,
+                populate: {
+                    assetRefs: { populate: '*' },
+                    pageRefs: {
+                        fields: pageRefPreviewFields,
+                        populate: '*'
+                    },
+                    collectionRefs: {
+                        fields: collectionRefFields,
+                        populate: '*'
+                    }
+                }
+            },
+            collectionRefs: populateCollectionRefs,
+            snapshot: { populate: '*' }
+        };
+        // preview page populate
+        Populate.preview = {
+            assetRefs: { populate: '*' },
+            pageRefs: {
+                fields: pageRefPreviewFields,
+                populate: {
+                    assetRefs: { populate: '*' },
+                    pageRefs: {
+                        fields: funnel_core_1.Schema.Page.Data.AsRef.props,
+                    },
+                    collectionRefs: {
+                        fields: collectionRefFields
+                    }
+                }
+            },
+            collectionRefs: populateCollectionRefs
+        };
+    })(Populate = PageData.Populate || (PageData.Populate = {}));
+    // strip out any link props (file, page, collection) from props array
+    function withoutLinks(props) {
+        return props.filter(prop => !funnel_core_1.Schema.Page.Data.Props.links.includes(prop));
+    }
+    // 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 'pages':
+                    return 'pageRefs';
+                case 'collections':
+                    return 'collectionRefs';
+                default:
+                    return prop;
+            }
+        });
+    }
+    PageData.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;
+                // parity
+                case 'groupId':
+                case 'brand':
+                case 'type':
+                case 'slug':
+                case 'url':
+                case 'region':
+                case 'name':
+                case 'tags':
+                case 'discover':
+                case 'preview':
+                case 'content':
+                case 'state':
+                case 'changeSetId':
+                case 'errors':
+                case 'publishedOn':
+                case 'publication':
+                    filters.add(prop);
+                    break;
+                // ignore the rest
+                default:
+                    break;
+            }
+        }
+        // return filters
+        return Array.from(filters);
+    }
+    PageData.getStrapiFilter = getStrapiFilter;
+    function deserialize(data, strapiUrl, props = funnel_core_1.Schema.Page.Data.Props.all) {
+        var _a, _b, _c;
+        // create output
+        const page = 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 pages = ((_b = data.pageRefs) !== null && _b !== void 0 ? _b : [])
+            .map(data => deserialize(data, strapiUrl))
+            .filter(funnel_core_1.Value.isDefined);
+        const collections = ((_c = data.collectionRefs) !== null && _c !== void 0 ? _c : [])
+            .map(data => CollectionData_1.CollectionData.deserialize(data, strapiUrl))
+            .filter(funnel_core_1.Value.isDefined);
+        // add root if there's any content props
+        if (funnel_core_1.Schema.Page.Data.Props.content.some(prop => props.includes(prop))) {
+            page.__root = 'page';
+        }
+        // helper
+        const bindProp = (prop, target, transform) => {
+            if (prop in data) {
+                page[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 'brand':
+                case 'region':
+                case 'type':
+                case 'slug':
+                case 'url':
+                case 'name':
+                case 'preview':
+                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) {
+                        page.snapshotId = data.snapshot.id;
+                    }
+                    break;
+                // tags
+                case 'tags':
+                    bindProp(prop, prop, value => JSON.parse(value !== null && value !== void 0 ? value : '[]'));
+                    break;
+                // content
+                case 'discover':
+                case 'content':
+                    bindProp(prop, prop, value => value !== null && value !== void 0 ? value : {});
+                    break;
+                // links
+                case 'files':
+                    page.files = files;
+                    break;
+                case 'pages':
+                    page.pages = pages;
+                    break;
+                case 'collections':
+                    page.collections = collections;
+                    break;
+                // timestamps
+                case 'createdOn':
+                    bindProp('createdAt', prop, () => createdOn);
+                    break;
+                case 'updatedOn':
+                    bindProp('updatedAt', prop, () => updatedOn);
+                    break;
+                case 'publishedOn':
+                case 'publication':
+                    bindProp(prop, prop, value => value ? parseInt(value) : undefined);
+                    break;
+                // unhandled
+                default:
+                    throw new funnel_core_1.NotImplementedError(`Missing support for transforming page "${prop}" prop`);
+            }
+        }
+        // return page
+        return page;
+    }
+    PageData.deserialize = deserialize;
+    // deserialize ref
+    function deserializeRef(data) {
+        var _a, _b, _c, _d;
+        // 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)), { type: data.type, tags: JSON.parse((_a = data.tags) !== null && _a !== void 0 ? _a : '[]'), region: data.region, language: (_b = data.lang) !== null && _b !== void 0 ? _b : undefined, groupId: data.groupId, brand: data.brand, slug: (_c = data.slug) !== null && _c !== void 0 ? _c : undefined, url: data.url, name: data.name, state: data.state, changeSetId: (_d = data.changeSetId) !== null && _d !== void 0 ? _d : undefined, errors: data.errors, createdOn,
+            updatedOn, publishedOn: data.publishedOn ? parseInt(data.publishedOn) : undefined, publication: data.publication ? parseInt(data.publication) : undefined });
+    }
+    PageData.deserializeRef = deserializeRef;
+    function serialize(page) {
+        var _a, _b, _c, _d, _e;
+        // serialize base page data
+        const base = {
+            groupId: page.groupId,
+            type: page.type,
+            tags: JSON.stringify(page.tags),
+            brand: page.brand,
+            lang: page.language,
+            slug: (_a = page.slug) !== null && _a !== void 0 ? _a : null,
+            url: page.url,
+            region: page.region,
+            name: page.name,
+            changeSetId: (_b = page.changeSetId) !== null && _b !== void 0 ? _b : null
+        };
+        // serialize existing page
+        if ('id' in page && page.id !== funnel_core_1.Schema.Page.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: {
+                    discover: page.discover,
+                    content: page.content
+                },
+                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 }) => {
+                    // track assets
+                    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 collection refs
+                    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 page refs
+                    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), { preview: (_c = page.preview) !== null && _c !== void 0 ? _c : null, assetRefs: { set: Array.from(assets) }, pageRefs: { set: Array.from(pages) }, collectionRefs: { set: Array.from(collections) }, errors: page.errors, state: page.state, publishedOn: (_d = page.publishedOn) === null || _d === void 0 ? void 0 : _d.toString(), publication: page.publication === undefined
+                    ? undefined
+                    : page.publication < 0
+                        ? null
+                        : page.publication.toString() });
+        }
+        // or a new one
+        else {
+            const seo = funnel_core_1.Schema.Seo;
+            const discover = (_e = page.discover) !== null && _e !== void 0 ? _e : {
+                seo: {
+                    type: 'block',
+                    id: seo.id,
+                    version: seo.version,
+                    config: {},
+                    fields: {
+                        title: funnel_core_1.Schema.TextField.Value.toData(page.name)
+                    }
+                }
+            };
+            return Object.assign(Object.assign({}, base), { discover, preview: null, content: {}, assetRefs: { set: [] }, pageRefs: { set: [] }, collectionRefs: { set: [] }, errors: true, state: 'draft' });
+        }
+    }
+    PageData.serialize = serialize;
+})(PageData || (exports.PageData = PageData = {}));

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

@@ -0,0 +1,20 @@
+import { Language, Schema } from '@nascentdigital/funnel-core';
+import { StrapiData } from '../models';
+export type PageSnapshotData = 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;
+    changeSetId: Schema.ChangeSet.Id;
+};
+export declare namespace PageSnapshotData {
+    function deserialize(data: PageSnapshotData): Schema.PageSnapshot;
+}

package/dist/strapi/serialization/PageSnapshotData.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageSnapshotData = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const models_1 = require("../models");
+// extension
+var PageSnapshotData;
+(function (PageSnapshotData) {
+    // 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 snapshot
+        for (const prop of funnel_core_1.Schema.PageSnapshot.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 'brand':
+                case 'region':
+                case 'type':
+                case 'slug':
+                case 'url':
+                case 'name':
+                case 'preview':
+                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 'discover':
+                case 'content':
+                    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 PageSnapshot "${prop}" prop`);
+            }
+        }
+        // return change set
+        return snapshot;
+    }
+    PageSnapshotData.deserialize = deserialize;
+})(PageSnapshotData || (exports.PageSnapshotData = PageSnapshotData = {}));

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

@@ -0,0 +1,5 @@
+import { StrapiData } from '../models';
+export type RoleData = StrapiData & {
+    type: string;
+    name: string;
+};

package/dist/strapi/serialization/RoleData.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,11 @@
+import { SiteConfig } from '../../models';
+import { StrapiData } from '../models';
+export type SiteConfigData = StrapiData & {
+    brand: string;
+    lockdownEditor: boolean;
+};
+export declare namespace SiteConfigData {
+    function deserialize(siteConfigData: SiteConfigData): SiteConfig.Data;
+    type Update = Omit<Partial<SiteConfigData>, StrapiData.Keys>;
+    function serialize(data: SiteConfig.Data.AsDraft | SiteConfig.Data.Update): Update;
+}

package/dist/strapi/serialization/SiteConfigData.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SiteConfigData = void 0;
+// extension
+var SiteConfigData;
+(function (SiteConfigData) {
+    function deserialize(siteConfigData) {
+        return {
+            id: siteConfigData.documentId,
+            brand: siteConfigData.brand,
+            lockdownEditor: siteConfigData.lockdownEditor
+        };
+    }
+    SiteConfigData.deserialize = deserialize;
+    function serialize(data) {
+        // serialize base config data
+        return {
+            brand: data.brand,
+            lockdownEditor: data.lockdownEditor
+        };
+    }
+    SiteConfigData.serialize = serialize;
+})(SiteConfigData || (exports.SiteConfigData = SiteConfigData = {}));

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

@@ -0,0 +1,17 @@
+import { MimeType, Schema } from '@nascentdigital/funnel-core';
+import { StrapiData, StrapiFile } from '../models';
+export type StrapiAssetData = StrapiData & {
+    brand?: string;
+    type: MimeType.Image | MimeType.Video;
+    url: string;
+    size: number;
+    name: string;
+    description?: string;
+    scope: string;
+    tags?: string;
+    metadata: Schema.AssetField.LinkedValue.Image.Metadata | Schema.AssetField.LinkedValue.Video.Metadata;
+    file?: StrapiFile;
+};
+export declare namespace StrapiAssetData {
+    function deserialize(data: StrapiAssetData, strapiUrl: string): Schema.Asset.Linked;
+}

package/dist/strapi/serialization/StrapiAssetData.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StrapiAssetData = void 0;
+// extension
+var StrapiAssetData;
+(function (StrapiAssetData) {
+    // methods
+    function deserialize(data, strapiUrl) {
+        // create base asset (works for most types)
+        const { id, documentId, url, type, size, name, description, scope, tags, metadata, file } = data;
+        // normalize metadata urls
+        if ('thumbUrl' in metadata && typeof metadata.thumbUrl === 'string') {
+            metadata.thumbUrl = new URL(metadata.thumbUrl, strapiUrl).href;
+        }
+        // return asset
+        return {
+            __root: 'asset',
+            type: 'asset',
+            value: {
+                __internal: {
+                    assetId: id,
+                    fileId: file === null || file === void 0 ? void 0 : file.id
+                },
+                id: documentId,
+                url: url
+                    ? new URL(url, strapiUrl).href
+                    : '',
+                type: type,
+                size,
+                name,
+                description,
+                scope: scope,
+                tags: JSON.parse(tags !== null && tags !== void 0 ? tags : '[]'),
+                metadata
+            }
+        };
+    }
+    StrapiAssetData.deserialize = deserialize;
+})(StrapiAssetData || (exports.StrapiAssetData = StrapiAssetData = {}));

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

@@ -0,0 +1,18 @@
+import type { User } from '../../models';
+import { StrapiData } from '../models';
+import type { RoleData } from './RoleData';
+export type UserData = StrapiData & {
+    username: string;
+    email: string;
+    confirmed: boolean;
+    blocked: boolean;
+    role: RoleData;
+    brands: string;
+};
+export declare namespace UserData {
+    type Update = Omit<Partial<UserData>, keyof StrapiData | 'role'> & {
+        role?: number;
+    };
+    function deserialize(data: UserData): User.Data;
+    function serialize(data: Omit<Partial<User.Data>, 'id'>, roles: ReadonlyArray<RoleData>): Update;
+}

package/dist/strapi/serialization/UserData.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserData = void 0;
+// extension
+var UserData;
+(function (UserData) {
+    function deserialize(data) {
+        var _a;
+        return {
+            id: data.documentId,
+            email: data.email,
+            username: data.username,
+            blocked: data.blocked,
+            role: data.role.type,
+            brands: JSON.parse((_a = data.brands) !== null && _a !== void 0 ? _a : '[]')
+        };
+    }
+    UserData.deserialize = deserialize;
+    function serialize(data, roles) {
+        const serializedData = {};
+        if (data.email !== undefined) {
+            serializedData.email = data.email;
+        }
+        if (data.username !== undefined) {
+            serializedData.username = data.username;
+        }
+        if (data.blocked !== undefined) {
+            serializedData.blocked = data.blocked;
+        }
+        if (data.brands !== undefined) {
+            serializedData.brands = JSON.stringify(data.brands);
+        }
+        if (data.role !== undefined) {
+            const roleData = roles.find((role) => role.type === data.role);
+            if (roleData) {
+                serializedData.role = roleData.id;
+            }
+        }
+        return serializedData;
+    }
+    UserData.serialize = serialize;
+})(UserData || (exports.UserData = UserData = {}));

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

@@ -0,0 +1,26 @@
+import { Upgrade } from '../../models';
+import { StrapiData } from '../models';
+export type VersionData = StrapiData & {
+    version: Upgrade.Version;
+    state: VersionData.State;
+    message: string | null;
+};
+export declare namespace VersionData {
+    type State = 'upgrading' | 'failed' | 'ready';
+    /**
+     * Converts a {@link VersionData} array to an {@link Upgrade.Status} model.
+     *
+     * @param versionsData - an array of `VersionData`, sorted in descending order.
+     * @param available - all available versions, sorted in ascending order.
+     * @param dbReady - `true` if the underling CMS db is at the correct version
+     */
+    function deserialize(versionsData: ReadonlyArray<VersionData>, available: ReadonlyArray<Upgrade.Version>, dbReady: boolean): Upgrade.Status;
+    type CreateArgs = {
+        version: Upgrade.Version;
+        status: Exclude<Upgrade.Status['status'], 'pending'>;
+        message?: string;
+    };
+    function serializeCreate({ version, status, message }: CreateArgs): Omit<VersionData, StrapiData.Keys>;
+    type UpdateArgs = Omit<CreateArgs, 'version'>;
+    function serializeUpdate({ status, message }: UpdateArgs): Partial<Omit<VersionData, StrapiData.Keys>>;
+}