@nascentdigital/funnel-cms 4.4.4

package/dist/strapi/serialization/VersionData.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionData = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+// extension
+var VersionData;
+(function (VersionData) {
+    /**
+     * 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, available, dbReady) {
+        var _a, _b, _c;
+        // return uninitialized if there's no data
+        const [latestVersion] = available;
+        if (versionsData.length === 0) {
+            return {
+                status: 'pending',
+                available,
+                dbReady
+            };
+        }
+        // return error status if latest version failed
+        const [latestData, ...previousData] = versionsData;
+        switch (latestData.state) {
+            case 'upgrading':
+                return {
+                    status: 'upgrading',
+                    id: latestData.documentId,
+                    current: (_a = funnel_core_1.ArrayUtils.first(previousData)) === null || _a === void 0 ? void 0 : _a.version,
+                    active: latestData.version
+                };
+            case 'failed':
+                return {
+                    status: 'failed',
+                    id: latestData.documentId,
+                    current: (_b = funnel_core_1.ArrayUtils.first(previousData)) === null || _b === void 0 ? void 0 : _b.version,
+                    failed: latestData.version,
+                    failure: (_c = latestData.message) !== null && _c !== void 0 ? _c : 'Upgrade failed for unknown reasons',
+                    dbReady
+                };
+            case 'ready': {
+                // mark up-to-date if on latest
+                if (latestData.version === latestVersion) {
+                    return {
+                        status: 'up-to-date',
+                        current: latestVersion
+                    };
+                }
+                // or mark as pending
+                else {
+                    return {
+                        status: 'pending',
+                        current: latestData.version,
+                        available: available.filter(version => version > latestData.version),
+                        dbReady
+                    };
+                }
+            }
+        }
+    }
+    VersionData.deserialize = deserialize;
+    function serializeCreate({ version, status, message }) {
+        switch (status) {
+            case 'upgrading':
+                return { version, state: 'upgrading', message: message !== null && message !== void 0 ? message : 'Upgrade in progress' };
+            case 'failed':
+                return { version, state: 'failed', message: message !== null && message !== void 0 ? message : 'Upgrade failed' };
+            case 'up-to-date':
+                return { version, state: 'ready', message: message !== null && message !== void 0 ? message : 'Upgrade complete' };
+        }
+    }
+    VersionData.serializeCreate = serializeCreate;
+    function serializeUpdate({ status, message }) {
+        switch (status) {
+            case 'upgrading':
+                return { state: 'upgrading', message: message !== null && message !== void 0 ? message : 'Upgrade in progress' };
+            case 'failed':
+                return { state: 'failed', message: message !== null && message !== void 0 ? message : 'Upgrade failed' };
+            case 'up-to-date':
+                return { state: 'ready', message: message !== null && message !== void 0 ? message : 'Upgrade complete' };
+        }
+    }
+    VersionData.serializeUpdate = serializeUpdate;
+})(VersionData || (exports.VersionData = VersionData = {}));

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

@@ -0,0 +1,10 @@
+export * from './ChangeSetData';
+export * from './CollectionData';
+export * from './CollectionSnapshotData';
+export * from './PageData';
+export * from './PageSnapshotData';
+export * from './RoleData';
+export * from './SiteConfigData';
+export * from './StrapiAssetData';
+export * from './UserData';
+export * from './VersionData';

package/dist/strapi/serialization/index.js

@@ -0,0 +1,26 @@
+"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("./ChangeSetData"), exports);
+__exportStar(require("./CollectionData"), exports);
+__exportStar(require("./CollectionSnapshotData"), exports);
+__exportStar(require("./PageData"), exports);
+__exportStar(require("./PageSnapshotData"), exports);
+__exportStar(require("./RoleData"), exports);
+__exportStar(require("./SiteConfigData"), exports);
+__exportStar(require("./StrapiAssetData"), exports);
+__exportStar(require("./UserData"), exports);
+__exportStar(require("./VersionData"), exports);

package/dist/strapi/test.d.ts

@@ -0,0 +1,563 @@
+export declare const test: {
+    groupId: string;
+    type: string;
+    tags: string;
+    brand: string;
+    lang: string;
+    slug: string;
+    url: string;
+    region: string;
+    name: string;
+    discover: {
+        seo: {
+            id: string;
+            type: string;
+            fields: {
+                title: {
+                    type: string;
+                    value: string;
+                };
+                keywords: {
+                    type: string;
+                    value: never[];
+                };
+                description: {
+                    type: string;
+                    value: string;
+                };
+            };
+            version: number;
+        };
+    };
+    content: {
+        cta: {
+            id: string;
+            type: string;
+            config: {
+                theme: {
+                    type: string;
+                    value: string;
+                };
+                variant: {
+                    type: string;
+                    value: string;
+                };
+                fullbleed: {
+                    type: string;
+                    value: boolean;
+                };
+                copyLayout: {
+                    type: string;
+                    value: string;
+                };
+                visualLayout: {
+                    type: string;
+                    value: string;
+                };
+            };
+            fields: {
+                ctas: {
+                    type: string;
+                    value: {
+                        id: string;
+                        type: string;
+                        value: {
+                            page: {
+                                type: string;
+                                __ref: string;
+                                value: {
+                                    id: string;
+                                    type: string;
+                                    scope: string;
+                                };
+                            };
+                            type: string;
+                            label: string;
+                        };
+                        schema: string;
+                    }[];
+                };
+                caption: {
+                    type: string;
+                    value: {
+                        hash: string;
+                        editorState: {
+                            root: {
+                                type: string;
+                                format: string;
+                                indent: number;
+                                version: number;
+                                children: {
+                                    type: string;
+                                    format: string;
+                                    indent: number;
+                                    version: number;
+                                    children: {
+                                        mode: string;
+                                        text: string;
+                                        type: string;
+                                        style: string;
+                                        detail: number;
+                                        format: number;
+                                        version: number;
+                                    }[];
+                                    direction: null;
+                                    textStyle: string;
+                                    textFormat: number;
+                                }[];
+                                direction: null;
+                            };
+                        };
+                    };
+                };
+                headline: {
+                    type: string;
+                    value: {
+                        hash: string;
+                        editorState: {
+                            root: {
+                                type: string;
+                                format: string;
+                                indent: number;
+                                version: number;
+                                children: {
+                                    type: string;
+                                    format: string;
+                                    indent: number;
+                                    version: number;
+                                    children: {
+                                        mode: string;
+                                        text: string;
+                                        type: string;
+                                        style: string;
+                                        detail: number;
+                                        format: number;
+                                        version: number;
+                                    }[];
+                                    direction: null;
+                                    textStyle: string;
+                                    textFormat: number;
+                                }[];
+                                direction: null;
+                            };
+                        };
+                    };
+                };
+            };
+            version: number;
+        };
+        hero: {
+            id: string;
+            type: string;
+            config: {
+                theme: {
+                    type: string;
+                    value: string;
+                };
+                variant: {
+                    type: string;
+                    value: string;
+                };
+                fullbleed: {
+                    type: string;
+                    value: boolean;
+                };
+                copyLayout: {
+                    type: string;
+                    value: string;
+                };
+                visualLayout: {
+                    type: string;
+                    value: string;
+                };
+            };
+            fields: {
+                ctas: {
+                    type: string;
+                    value: {
+                        id: string;
+                        type: string;
+                        value: {
+                            page: {
+                                type: string;
+                                __ref: string;
+                                value: {
+                                    id: string;
+                                    type: string;
+                                    scope: string;
+                                };
+                            };
+                            type: string;
+                            label: string;
+                        };
+                        schema: string;
+                    }[];
+                };
+                title: {
+                    type: string;
+                    value: string;
+                };
+                caption: {
+                    type: string;
+                    value: {
+                        hash: string;
+                        editorState: {
+                            root: {
+                                type: string;
+                                format: string;
+                                indent: number;
+                                version: number;
+                                children: {
+                                    type: string;
+                                    format: string;
+                                    indent: number;
+                                    version: number;
+                                    children: {
+                                        mode: string;
+                                        text: string;
+                                        type: string;
+                                        style: string;
+                                        detail: number;
+                                        format: number;
+                                        version: number;
+                                    }[];
+                                    direction: null;
+                                    textStyle: string;
+                                    textFormat: number;
+                                }[];
+                                direction: null;
+                            };
+                        };
+                    };
+                };
+                headline: {
+                    type: string;
+                    value: {
+                        hash: string;
+                        editorState: {
+                            root: {
+                                type: string;
+                                format: string;
+                                indent: number;
+                                version: number;
+                                children: {
+                                    type: string;
+                                    format: string;
+                                    indent: number;
+                                    version: number;
+                                    children: {
+                                        mode: string;
+                                        text: string;
+                                        type: string;
+                                        style: string;
+                                        detail: number;
+                                        format: number;
+                                        version: number;
+                                    }[];
+                                    direction: null;
+                                    textStyle: string;
+                                    textFormat: number;
+                                }[];
+                                direction: null;
+                            };
+                        };
+                    };
+                };
+            };
+            version: number;
+        };
+        "_nd-nav": {
+            id: string;
+            type: string;
+            fields: {
+                footer: {
+                    type: string;
+                    __ref: string;
+                    value: {
+                        id: string;
+                        type: string;
+                    };
+                };
+                header: {
+                    type: string;
+                    __ref: string;
+                    value: {
+                        id: string;
+                        type: string;
+                    };
+                };
+                footerTheme: {
+                    type: string;
+                    value: string;
+                };
+                headerTheme: {
+                    type: string;
+                    value: string;
+                };
+            };
+            version: number;
+        };
+        valueProps: {
+            type: string;
+            blocks: ({
+                id: string;
+                type: string;
+                config: {
+                    name: string;
+                    theme: {
+                        type: string;
+                        value: string;
+                    };
+                    layout: {
+                        type: string;
+                        value: string;
+                    };
+                };
+                fields: {
+                    ctas: {
+                        type: string;
+                        value: never[];
+                    };
+                    items: {
+                        type: string;
+                        value: {
+                            id: string;
+                            type: string;
+                            value: {
+                                name: string;
+                                tags: never[];
+                                type: string;
+                                fields: {
+                                    caption: {
+                                        type: string;
+                                        value: {
+                                            hash: string;
+                                            editorState: {
+                                                root: {
+                                                    type: string;
+                                                    format: string;
+                                                    indent: number;
+                                                    version: number;
+                                                    children: {
+                                                        type: string;
+                                                        format: string;
+                                                        indent: number;
+                                                        version: number;
+                                                        children: {
+                                                            mode: string;
+                                                            text: string;
+                                                            type: string;
+                                                            style: string;
+                                                            detail: number;
+                                                            format: number;
+                                                            version: number;
+                                                        }[];
+                                                        direction: null;
+                                                        textStyle: string;
+                                                        textFormat: number;
+                                                    }[];
+                                                    direction: null;
+                                                };
+                                            };
+                                        };
+                                    };
+                                    headline: {
+                                        type: string;
+                                        value: {
+                                            hash: string;
+                                            editorState: {
+                                                root: {
+                                                    type: string;
+                                                    format: string;
+                                                    indent: number;
+                                                    version: number;
+                                                    children: {
+                                                        type: string;
+                                                        format: string;
+                                                        indent: number;
+                                                        version: number;
+                                                        children: {
+                                                            mode: string;
+                                                            text: string;
+                                                            type: string;
+                                                            style: string;
+                                                            detail: number;
+                                                            format: number;
+                                                            version: number;
+                                                        }[];
+                                                        direction: null;
+                                                        textStyle: string;
+                                                        textFormat: number;
+                                                    }[];
+                                                    direction: null;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                                version: number;
+                            };
+                            schema: string;
+                        }[];
+                    };
+                    title: {
+                        type: string;
+                        value: string;
+                    };
+                    headline: {
+                        type: string;
+                        value: {
+                            hash: string;
+                            editorState: {
+                                root: {
+                                    type: string;
+                                    format: string;
+                                    indent: number;
+                                    version: number;
+                                    children: {
+                                        type: string;
+                                        format: string;
+                                        indent: number;
+                                        version: number;
+                                        children: {
+                                            mode: string;
+                                            text: string;
+                                            type: string;
+                                            style: string;
+                                            detail: number;
+                                            format: number;
+                                            version: number;
+                                        }[];
+                                        direction: null;
+                                        textStyle: string;
+                                        textFormat: number;
+                                    }[];
+                                    direction: null;
+                                };
+                            };
+                        };
+                    };
+                    caption?: undefined;
+                };
+                section: {
+                    id: string;
+                    block: string;
+                };
+                version: number;
+            } | {
+                id: string;
+                type: string;
+                config: {
+                    name: string;
+                    theme: {
+                        type: string;
+                        value: string;
+                    };
+                    layout: {
+                        type: string;
+                        value: string;
+                    };
+                };
+                fields: {
+                    ctas: {
+                        type: string;
+                        value: never[];
+                    };
+                    items: {
+                        type: string;
+                        value: never[];
+                    };
+                    title: {
+                        type: string;
+                        value: string;
+                    };
+                    caption: {
+                        type: string;
+                        value: {
+                            hash: string;
+                            editorState: {
+                                root: {
+                                    type: string;
+                                    format: string;
+                                    indent: number;
+                                    version: number;
+                                    children: {
+                                        type: string;
+                                        format: string;
+                                        indent: number;
+                                        version: number;
+                                        children: {
+                                            mode: string;
+                                            text: string;
+                                            type: string;
+                                            style: string;
+                                            detail: number;
+                                            format: number;
+                                            version: number;
+                                        }[];
+                                        direction: null;
+                                        textStyle: string;
+                                        textFormat: number;
+                                    }[];
+                                    direction: null;
+                                };
+                            };
+                        };
+                    };
+                    headline: {
+                        type: string;
+                        value: {
+                            hash: string;
+                            editorState: {
+                                root: {
+                                    type: string;
+                                    format: string;
+                                    indent: number;
+                                    version: number;
+                                    children: {
+                                        type: string;
+                                        format: string;
+                                        indent: number;
+                                        version: number;
+                                        children: {
+                                            mode: string;
+                                            text: string;
+                                            type: string;
+                                            style: string;
+                                            detail: number;
+                                            format: number;
+                                            version: number;
+                                        }[];
+                                        direction: null;
+                                        textStyle: string;
+                                        textFormat: number;
+                                    }[];
+                                    direction: null;
+                                };
+                            };
+                        };
+                    };
+                };
+                section: {
+                    id: string;
+                    block: string;
+                };
+                version: number;
+            })[];
+            version: number;
+        };
+    };
+    preview: null;
+    assetRefs: {
+        set: never[];
+    };
+    pageRefs: {
+        set: string[];
+    };
+    collectionRefs: {
+        set: string[];
+    };
+    errors: boolean;
+    state: string;
+    changeSetId: string;
+};