@nascentdigital/funnel-cms 4.5.6 → 4.6.0

package/dist/api/CollectionClient.d.ts

@@ -96,11 +96,11 @@ export declare namespace CollectionClient {
     };
     namespace Replace {
         type Args = {
-            updatedCollection: Schema.Collection.Data;
+            updatedCollection: Schema.Collection.LegacyData;
             version: Environment;
             skipSync?: boolean;
         };
-        type Result = Schema.Collection.Data;
+        type Result = Schema.Collection.LegacyData;
     }
     namespace GetOverview {
         type Args = Query.ByBrand;
@@ -127,7 +127,7 @@ export declare namespace CollectionClient {
     }
     namespace Find {
         type Args = Query.Paginated;
-        type Result = Pagination.Paginated<Schema.Collection.Data>;
+        type Result = Pagination.Paginated<Schema.Collection.LegacyData>;
     }
     namespace GetGroup {
         type Args = Query.ByGroupId & {
@@ -139,7 +139,7 @@ export declare namespace CollectionClient {
     }
     namespace Get {
         type Args = Query.ById;
-        type Result = Schema.Collection.Data | undefined;
+        type Result = Schema.Collection.FlattenedData | undefined;
     }
     namespace Create {
         type Args = NewArgs | NewLanguageArgs;
@@ -162,7 +162,7 @@ export declare namespace CollectionClient {
         type Result = {
             updatedOn: number;
             changeSetId: Schema.ChangeSet.Id;
-            collection?: Schema.Collection.Data;
+            collection?: Schema.Collection.FlattenedData;
         };
     }
     namespace Unpublish {

package/dist/api/PageClient.d.ts

@@ -119,6 +119,9 @@ export declare namespace PageClient {
         export namespace Criteria {
             type Key = keyof Criteria;
         }
+        export type Select = {
+            select?: 'all' | 'content';
+        };
         export {};
     }
     namespace GetOverview {
@@ -162,12 +165,12 @@ export declare namespace PageClient {
         type Result = Pagination.Paginated<Schema.Page.Data>;
     }
     namespace GetGroup {
-        type Args = Query.ByDetails;
+        type Args = Query.ByDetails & Query.Select;
         type Result = Schema.Page.Data.AsGroup;
     }
     namespace Get {
-        type Args = Query.ById | Query.ByDetails;
-        type Result = Schema.Page.Data | undefined;
+        type Args = (Query.ById | Query.ByDetails) & Query.Select;
+        type Result = Schema.Page.FlattenedData | undefined;
     }
     namespace Create {
         type Args = NewArgs | NewLanguageArgs;
@@ -207,12 +210,12 @@ export declare namespace PageClient {
         type Result = {
             updatedOn: number;
             changeSetId: Schema.ChangeSet.Id;
-            page?: Schema.Page.Data;
+            page?: Schema.Page.FlattenedData;
         };
     }
     namespace Replace {
         type Args = {
-            page: Schema.Page.Data;
+            page: Schema.Page.LegacyData;
             version: Environment;
             skipSync?: boolean;
         };

package/dist/strapi/StrapiCollectionClient.js

@@ -65,7 +65,7 @@ class StrapiCollectionClient {
                 ? ['publishedOn:desc', 'updatedAt:desc']
                 : ['updatedAt:desc'], populate: serialization_1.CollectionData.populate }, getCollectionQueryParams(args))), { items } = _b, paginated = __rest(_b, ["items"]);
         // transform to DTOs
-        return Object.assign({ items: items.map(item => serialization_1.CollectionData.deserialize(item, strapiUrl, resultProps)) }, paginated);
+        return Object.assign({ items: items.map(item => serialization_1.CollectionData.deserializeLegacy(item, strapiUrl, resultProps)) }, paginated);
     }
     async getGroup({ version, type, brand, groupId, language }) {
         var _a, _b;
@@ -96,7 +96,7 @@ class StrapiCollectionClient {
             result.collection = await this.get({ version, id: target.id });
             // sync name if collection was found
             if (result.collection) {
-                result.group.name = result.collection.name;
+                result.group.name = result.collection.data.name;
             }
         }
         // return result
@@ -113,7 +113,7 @@ class StrapiCollectionClient {
         });
         // deserialize and return
         return data
-            ? serialization_1.CollectionData.deserialize(data, client.baseURL, resultProps)
+            ? serialization_1.CollectionData.deserializeFlattened(data, client.baseURL, resultProps)
             : undefined;
     }
     async create(args) {
@@ -163,7 +163,7 @@ class StrapiCollectionClient {
                     populate: serialization_1.CollectionData.populate
                 });
                 // transform the deserialized entry
-                const collection = serialization_1.CollectionData.deserialize(data, strapiUrl, funnel_core_1.Schema.Collection.Data.Props.all);
+                const collection = serialization_1.CollectionData.deserializeFlattened(data, strapiUrl, funnel_core_1.Schema.Collection.Data.Props.all);
                 // add collection to changeset
                 await provider.changeSets.update({
                     id: changeSet.id,
@@ -172,12 +172,12 @@ class StrapiCollectionClient {
                         {
                             __type: 'collection',
                             type: 'create',
-                            schema: collection.type,
-                            id: collection.id,
-                            groupId: collection.groupId,
-                            name: collection.name,
-                            language: collection.language,
-                            errors: collection.errors,
+                            schema: collection.data.type,
+                            id: collection.data.id,
+                            groupId: collection.data.groupId,
+                            name: collection.data.name,
+                            language: collection.data.language,
+                            errors: collection.data.errors,
                             attribution: [
                                 { userId: user.id, updatedOn: Date.now() }
                             ]
@@ -186,10 +186,10 @@ class StrapiCollectionClient {
                 });
                 // add collection to group
                 group.instances.push({
-                    id: collection.id,
-                    language: collection.language,
-                    version: collection.version,
-                    tags: collection.tags
+                    id: collection.data.id,
+                    language: collection.data.language,
+                    version: collection.data.version,
+                    tags: collection.data.tags
                 });
                 // return updated group
                 return {
@@ -227,7 +227,7 @@ class StrapiCollectionClient {
                     populate: serialization_1.CollectionData.populate
                 });
                 // transform the deserialized entry
-                const collection = serialization_1.CollectionData.deserialize(data, strapiUrl, funnel_core_1.Schema.Collection.Data.Props.all);
+                const collection = serialization_1.CollectionData.deserializeFlattened(data, strapiUrl, funnel_core_1.Schema.Collection.Data.Props.all);
                 // add collection to changeset
                 await provider.changeSets.update({
                     id: changeSet.id,
@@ -236,12 +236,12 @@ class StrapiCollectionClient {
                         {
                             __type: 'collection',
                             type: 'create',
-                            schema: collection.type,
-                            id: collection.id,
-                            groupId: collection.groupId,
-                            name: collection.name,
-                            language: collection.language,
-                            errors: collection.errors,
+                            schema: collection.data.type,
+                            id: collection.data.id,
+                            groupId: collection.data.groupId,
+                            name: collection.data.name,
+                            language: collection.data.language,
+                            errors: collection.data.errors,
                             attribution: [
                                 { userId: user.id, updatedOn: Date.now() }
                             ]
@@ -251,15 +251,15 @@ class StrapiCollectionClient {
                 // return collection
                 return {
                     group: {
-                        groupId: collection.groupId,
-                        brand: collection.brand,
-                        type: collection.type,
-                        name: collection.name,
+                        groupId: collection.data.groupId,
+                        brand: collection.data.brand,
+                        type: collection.data.type,
+                        name: collection.data.name,
                         instances: [{
-                                id: collection.id,
-                                language: collection.language,
-                                version: collection.version,
-                                tags: collection.tags
+                                id: collection.data.id,
+                                language: collection.data.language,
+                                version: collection.data.version,
+                                tags: collection.data.tags
                             }]
                     },
                     collection
@@ -342,7 +342,7 @@ class StrapiCollectionClient {
             const dupCollectionData = dupData;
             console.debug('[StrapiCollectionClient] duplicate: created duplicate collection', { dupCollectionData });
             // touch new duplicated collection
-            let dupCollection = serialization_1.CollectionData.deserialize(dupCollectionData, strapiUrl, funnel_core_1.Schema.Collection.Data.Props.all);
+            let dupCollection = serialization_1.CollectionData.deserializeLegacy(dupCollectionData, strapiUrl, funnel_core_1.Schema.Collection.Data.Props.all);
             const dupCollectionModel = funnel_core_1.Schema.CollectionModel.from(dupCollection);
             dupCollectionModel.sync();
             // connect collection to changeset
@@ -350,7 +350,7 @@ class StrapiCollectionClient {
             // update duplicate collection with updated data from sync
             const update = serialization_1.CollectionData.serialize(dupCollection);
             const { data: updatedData } = await collectionCollection.update(dupCollection.id, update, { status: 'draft' });
-            dupCollection = serialization_1.CollectionData.deserialize(updatedData, strapiUrl, funnel_core_1.Schema.Collection.Data.Props.all);
+            dupCollection = serialization_1.CollectionData.deserializeLegacy(updatedData, strapiUrl, funnel_core_1.Schema.Collection.Data.Props.all);
             console.debug('[StrapiCollectionClient] duplicate: touched duplicated collection');
             // add collection to changeset
             await provider.changeSets.update({
@@ -423,7 +423,7 @@ class StrapiCollectionClient {
         });
         console.debug(`[StrapiCollectionClient/replace] returning final collection`);
         // return collection
-        return serialization_1.CollectionData.deserialize(updatedData, strapiUrl);
+        return serialization_1.CollectionData.deserializeLegacy(updatedData, strapiUrl);
     }
     async unpublish(collectionId) {
         // get collection
@@ -433,7 +433,7 @@ class StrapiCollectionClient {
             throw new funnel_core_1.NotFoundError('Unable to resolve collection');
         }
         // or throw if it's already draft
-        else if (!collection.publishedOn) {
+        else if (!collection.data.publishedOn) {
             throw new funnel_core_1.InvalidOperationError('Collection is not published');
         }
         // unpublish the document
@@ -442,7 +442,7 @@ class StrapiCollectionClient {
             command: 'unpublish',
             data: JSON.stringify({
                 collection: 'collection',
-                documentId: collection.id
+                documentId: collection.data.id
             }),
             onError: ({ pageRefs, collectionRefs }) => {
                 // throw dependants error if we got any refs
@@ -451,8 +451,8 @@ class StrapiCollectionClient {
                     const strapiUrl = client.baseURL;
                     throw new errors_1.LinkedDependantsError({
                         message: 'This collection cannot be unpublished because it would break dependencies',
-                        pages: pageRefs.map(data => serialization_1.PageData.deserialize(data, strapiUrl, funnel_core_1.Schema.Page.Data.AsLink.props)),
-                        collections: collectionRefs.map(data => serialization_1.CollectionData.deserialize(data, strapiUrl, funnel_core_1.Schema.Collection.Data.AsLink.props))
+                        pages: pageRefs.map(data => serialization_1.PageData.deserializeLegacy(data, strapiUrl, funnel_core_1.Schema.Page.Data.AsLink.props)),
+                        collections: collectionRefs.map(data => serialization_1.CollectionData.deserializeLegacy(data, strapiUrl, funnel_core_1.Schema.Collection.Data.AsLink.props))
                     });
                 }
                 // or assume the page isn't published
@@ -486,8 +486,8 @@ class StrapiCollectionClient {
         ]);
         // return
         return {
-            pages: pages.map(page => serialization_1.PageData.deserialize(page, strapiUrl, funnel_core_1.Schema.Page.Data.AsRef.props)),
-            collections: collections.map(collection => serialization_1.CollectionData.deserialize(collection, strapiUrl, funnel_core_1.Schema.Collection.Data.AsRef.props))
+            pages: pages.map(page => serialization_1.PageData.deserializeLegacy(page, strapiUrl, funnel_core_1.Schema.Page.Data.AsRef.props)),
+            collections: collections.map(collection => serialization_1.CollectionData.deserializeLegacy(collection, strapiUrl, funnel_core_1.Schema.Collection.Data.AsRef.props))
         };
     }
     async getDependencies({ id: collectionId, version }) {
@@ -506,7 +506,7 @@ class StrapiCollectionClient {
         }
         // return
         return {
-            collections: collectionData.collectionRefs.map(collectionRef => serialization_1.CollectionData.deserialize(collectionRef, strapiUrl, funnel_core_1.Schema.Collection.Data.AsRef.props))
+            collections: collectionData.collectionRefs.map(collectionRef => serialization_1.CollectionData.deserializeLegacy(collectionRef, strapiUrl, funnel_core_1.Schema.Collection.Data.AsRef.props))
         };
     }
 }

package/dist/strapi/StrapiPageClient.d.ts

@@ -9,7 +9,7 @@ export declare class StrapiPageClient implements PageClient {
     search({ pagination, ...args }: PageClient.Search.Args): Promise<PageClient.Search.Result>;
     query({ pagination, ...args }: PageClient.Query.Args): Promise<PageClient.Query.Result>;
     find({ pagination, ...args }: PageClient.Find.Args): Promise<PageClient.Find.Result>;
-    getGroup({ brand, groupId, type, slug, region, language, version }: PageClient.GetGroup.Args): Promise<PageClient.GetGroup.Result>;
+    getGroup({ brand, groupId, type, slug, region, language, version, select }: PageClient.GetGroup.Args): Promise<PageClient.GetGroup.Result>;
     get(args: PageClient.Get.Args): Promise<PageClient.Get.Result>;
     create(args: PageClient.Create.Args): Promise<PageClient.Create.Result>;
     duplicate({ source: pageId, targetPage, targetLanguage, targetSlug }: PageClient.Duplicate.Args): Promise<PageClient.Duplicate.Result>;

package/dist/strapi/StrapiPageClient.js

@@ -50,7 +50,7 @@ class StrapiPageClient {
                 ? ['type', 'publishedOn:desc', 'updatedAt:desc']
                 : ['type', 'updatedAt:desc'] }, getPageQueryParams(args)));
         // transform to dtos
-        return entries.items.map(item => serialization_1.PageData.deserialize(item, strapiUrl, resultProps));
+        return entries.items.map(item => serialization_1.PageData.deserializeLegacy(item, strapiUrl, resultProps));
     }
     async getPreviews(_a) {
         var { pagination } = _a, args = __rest(_a, ["pagination"]);
@@ -77,7 +77,7 @@ class StrapiPageClient {
             status
         }), { items } = _b, paginated = __rest(_b, ["items"]);
         // transform and return items
-        return Object.assign({ items: items.map(item => serialization_1.PageData.deserialize(item, strapiUrl, resultProps)) }, paginated);
+        return Object.assign({ items: items.map(item => serialization_1.PageData.deserializeLegacy(item, strapiUrl, resultProps)) }, paginated);
     }
     async search(_a) {
         var { pagination } = _a, args = __rest(_a, ["pagination"]);
@@ -91,7 +91,7 @@ class StrapiPageClient {
                 ? ['publishedOn:desc', 'updatedAt:desc']
                 : ['updatedAt:desc'] }, getPageQueryParams(args))), { items } = _b, paginated = __rest(_b, ["items"]);
         // transform and return items
-        return Object.assign({ items: items.map(item => serialization_1.PageData.deserialize(item, strapiUrl, resultProps)) }, paginated);
+        return Object.assign({ items: items.map(item => serialization_1.PageData.deserializeLegacy(item, strapiUrl, resultProps)) }, paginated);
     }
     async query(_a) {
         var { pagination } = _a, args = __rest(_a, ["pagination"]);
@@ -127,7 +127,7 @@ class StrapiPageClient {
         });
         // deserialize pages and return
         return {
-            items: rankedPages.map(page => serialization_1.PageData.deserialize(page, strapiUrl, resultProps)),
+            items: rankedPages.map(page => serialization_1.PageData.deserializeLegacy(page, strapiUrl, resultProps)),
             page: pagination === 'all' ? 1 : pagination.page,
             pageCount: pagination === 'all' ? 1 : Math.ceil(filteredRankedPageIds.length / pagination.pageSize),
             totalItemCount: filteredRankedPageIds.length
@@ -145,9 +145,9 @@ class StrapiPageClient {
                 ? ['publishedOn:desc', 'updatedAt:desc']
                 : ['updatedAt:desc'], populate: serialization_1.PageData.Populate.full }, getPageQueryParams(args))), { items } = _b, paginated = __rest(_b, ["items"]);
         // transform to DTOs
-        return Object.assign({ items: items.map(item => serialization_1.PageData.deserialize(item, strapiUrl, resultProps)) }, paginated);
+        return Object.assign({ items: items.map(item => serialization_1.PageData.deserializeLegacy(item, strapiUrl, resultProps)) }, paginated);
     }
-    async getGroup({ brand, groupId, type, slug, region, language, version }) {
+    async getGroup({ brand, groupId, type, slug, region, language, version, select }) {
         // create base result
         const result = {
             group: { groupId: groupId !== null && groupId !== void 0 ? groupId : funnel_core_1.Schema.Page.GroupId.empty, brand, type, slug, region, instances: [] }
@@ -169,11 +169,11 @@ class StrapiPageClient {
             // connect groupId + preset (should all be the same, so it's ok to pave over)
             group.groupId = item.groupId;
             // add instance
-            const instance = serialization_1.PageData.deserialize(item, client.baseURL, funnel_core_1.Schema.Page.Data.AsGroup.Instance.props);
+            const instance = serialization_1.PageData.deserializeLegacy(item, client.baseURL, funnel_core_1.Schema.Page.Data.AsGroup.Instance.props);
             group.instances.push(instance);
             // set page if language matches
             if (instance.language === language) {
-                result.page = await this.get({ id: instance.id, version });
+                result.page = await this.get({ id: instance.id, version, select });
             }
         }
         // return result
@@ -184,7 +184,9 @@ class StrapiPageClient {
         const client = this.provider.client;
         const strapiUrl = client.baseURL;
         const collection = client.collection('pages');
-        const resultProps = funnel_core_1.Schema.Page.Data.Props.all;
+        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
@@ -214,7 +216,7 @@ class StrapiPageClient {
             data = rawData[0];
         }
         // convert and return
-        return serialization_1.PageData.deserialize(data, strapiUrl, resultProps);
+        return serialization_1.PageData.deserializeFlattened(data, strapiUrl, resultProps);
     }
     async create(args) {
         // resolve current user (or throw)
@@ -259,7 +261,8 @@ class StrapiPageClient {
                     populate: serialization_1.PageData.Populate.full
                 });
                 // transform the deserialized entry
-                const page = serialization_1.PageData.deserialize(data, strapiUrl, funnel_core_1.Schema.Page.Data.Props.all);
+                const flattenedPage = serialization_1.PageData.deserializeFlattened(data, strapiUrl, funnel_core_1.Schema.Page.Data.Props.all);
+                const page = flattenedPage.data;
                 // add page to changeset
                 await provider.changeSets.update({
                     id: changeSet.id,
@@ -306,7 +309,7 @@ class StrapiPageClient {
                             }
                         ]
                     },
-                    page
+                    page: flattenedPage
                 };
             }
             // remove
@@ -368,7 +371,8 @@ class StrapiPageClient {
                     populate: serialization_1.PageData.Populate.full
                 });
                 // transform the deserialized entry
-                const page = serialization_1.PageData.deserialize(data, strapiUrl, funnel_core_1.Schema.Page.Data.Props.all);
+                const flattenedPage = serialization_1.PageData.deserializeFlattened(data, strapiUrl, funnel_core_1.Schema.Page.Data.Props.all);
+                const page = flattenedPage.data;
                 // add page to changeset
                 await provider.changeSets.update({
                     id: changeSet.id,
@@ -415,7 +419,7 @@ class StrapiPageClient {
                             }
                         ]
                     },
-                    page
+                    page: flattenedPage
                 };
             }
             // remove
@@ -533,7 +537,7 @@ class StrapiPageClient {
             const dupPageData = dupData;
             console.debug('[StrapiPageClient] duplicate: created duplicate page', { dupPageData });
             // touch new duplicated page to update url/name
-            let dupPage = serialization_1.PageData.deserialize(dupPageData, strapiUrl, funnel_core_1.Schema.Page.Data.Props.all);
+            let dupPage = serialization_1.PageData.deserializeLegacy(dupPageData, strapiUrl, funnel_core_1.Schema.Page.Data.Props.all);
             const dupPageModel = funnel_core_1.Schema.PageModel.from(dupPage);
             dupPageModel.sync();
             // connect page to changeset
@@ -541,7 +545,7 @@ class StrapiPageClient {
             // update duplicate page with updated url/name
             const update = serialization_1.PageData.serialize(dupPage);
             const { data: updatedData } = await pageCollection.update(dupPage.id, update, { status: 'draft' });
-            dupPage = serialization_1.PageData.deserialize(updatedData, strapiUrl, funnel_core_1.Schema.Page.Data.Props.all);
+            dupPage = serialization_1.PageData.deserializeLegacy(updatedData, strapiUrl, funnel_core_1.Schema.Page.Data.Props.all);
             console.debug('[StrapiPageClient] duplicate: touched duplicated page');
             // add page to changeset
             await provider.changeSets.update({
@@ -601,7 +605,7 @@ class StrapiPageClient {
             throw new funnel_core_1.NotFoundError();
         }
         // deserialize page (we'll be updating this version)
-        const page = serialization_1.PageData.deserialize(currentData, strapiUrl, resultProps);
+        const page = serialization_1.PageData.deserializeLegacy(currentData, strapiUrl, resultProps);
         // merge changes (the original page will have changed)
         const model = funnel_core_1.Schema.PageModel.from(page);
         model.sync();
@@ -642,11 +646,12 @@ class StrapiPageClient {
         });
         console.debug(`[StrapiPageClient/replace] returning final page`);
         // return page
-        return serialization_1.PageData.deserialize(updatedData, strapiUrl);
+        return serialization_1.PageData.deserializeLegacy(updatedData, strapiUrl);
     }
     async unpublish(pageId) {
         // get page
-        const page = await this.get({ id: pageId, version: 'draft' });
+        const flattenedPage = await this.get({ id: pageId, version: 'draft' });
+        const page = flattenedPage === null || flattenedPage === void 0 ? void 0 : flattenedPage.data;
         // throw if there's no page
         if (!page) {
             throw new funnel_core_1.NotFoundError('Unable to resolve page');
@@ -670,8 +675,8 @@ class StrapiPageClient {
                     const strapiUrl = client.baseURL;
                     throw new errors_1.LinkedDependantsError({
                         message: 'This collection cannot be unpublished because it would break dependencies',
-                        pages: pageRefs.map(data => serialization_1.PageData.deserialize(data, strapiUrl, funnel_core_1.Schema.Page.Data.AsLink.props)),
-                        collections: collectionRefs.map(data => serialization_1.CollectionData.deserialize(data, strapiUrl, funnel_core_1.Schema.Collection.Data.AsLink.props))
+                        pages: pageRefs.map(data => serialization_1.PageData.deserializeLegacy(data, strapiUrl, funnel_core_1.Schema.Page.Data.AsLink.props)),
+                        collections: collectionRefs.map(data => serialization_1.CollectionData.deserializeLegacy(data, strapiUrl, funnel_core_1.Schema.Collection.Data.AsLink.props))
                     });
                 }
                 // or assume the page isn't published
@@ -701,7 +706,7 @@ class StrapiPageClient {
         });
         // return
         return {
-            pages: pages.map(page => serialization_1.PageData.deserialize(page, strapiUrl, funnel_core_1.Schema.Page.Data.AsLink.props))
+            pages: pages.map(page => serialization_1.PageData.deserializeLegacy(page, strapiUrl, funnel_core_1.Schema.Page.Data.AsLink.props))
         };
     }
     async getDependencies({ id: pageId, version }) {
@@ -720,8 +725,8 @@ class StrapiPageClient {
         }
         // return
         return {
-            pages: page.pageRefs.map(pageRef => serialization_1.PageData.deserialize(pageRef, strapiUrl, funnel_core_1.Schema.Page.Data.AsLink.props)),
-            collections: page.collectionRefs.map(collectionRef => serialization_1.CollectionData.deserialize(collectionRef, strapiUrl, funnel_core_1.Schema.Collection.Data.AsLink.props))
+            pages: page.pageRefs.map(pageRef => serialization_1.PageData.deserializeLegacy(pageRef, strapiUrl, funnel_core_1.Schema.Page.Data.AsLink.props)),
+            collections: page.collectionRefs.map(collectionRef => serialization_1.CollectionData.deserializeLegacy(collectionRef, strapiUrl, funnel_core_1.Schema.Collection.Data.AsLink.props))
         };
     }
     async validateSlug({ brand, type, region, slug, groupId }) {

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

@@ -43,7 +43,10 @@ export declare namespace CollectionData {
     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 deserialize<TCollection extends Schema.Collection.Data>(data: Potential, props?: ReadonlyArray<Schema.Collection.Data.Props.All>): TCollection;
+    function deserializeRefs(data: Potential, strapiUrl: string): Schema.Collection.References;
+    function deserializeFlattened<TCollection extends Schema.Collection>(data: Potential, strapiUrl: string, props?: ReadonlyArray<Schema.Collection.Data.Props.All>): Schema.Collection.FlattenedData<TCollection>;
+    function deserializeLegacy<TCollection extends Schema.Collection.LegacyData>(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?: {
@@ -53,5 +56,5 @@ export declare namespace CollectionData {
             set: Schema.Collection.Id[];
         };
     };
-    function serialize(collection: Schema.Collection.Data.AsDraft | Schema.Collection.Data): Update;
+    function serialize(collection: Schema.Collection.Data.AsDraft | Schema.Collection.LegacyData): Update;
 }

package/dist/strapi/serialization/CollectionData.js

@@ -79,14 +79,125 @@ var CollectionData;
         return Array.from(filters);
     }
     CollectionData.getStrapiFilter = getStrapiFilter;
-    function deserialize(data, strapiUrl, props = funnel_core_1.Schema.Collection.Data.Props.all) {
+    function deserialize(data, props = funnel_core_1.Schema.Collection.Data.Props.all) {
+        // 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;
+        // 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 '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;
+                // ignore
+                case 'files':
+                case 'collections':
+                    break;
+                // unhandled
+                default:
+                    throw new funnel_core_1.NotImplementedError(`Missing support for transforming Collection "${prop}" prop`);
+            }
+        }
+        // return collection
+        return collection;
+    }
+    CollectionData.deserialize = deserialize;
+    function deserializeRefs(data, strapiUrl) {
+        // extract reference fields
+        const { assetRefs = [], collectionRefs = [] } = data;
+        // files
+        let files = assetRefs
+            .map(data => StrapiAssetData_1.StrapiAssetData.deserialize(data, strapiUrl))
+            .reduce((files, asset) => {
+            files[asset.value.id] = asset;
+            return files;
+        }, {});
+        // collections
+        let collections = {};
+        for (const collectionRef of collectionRefs) {
+            // deserialize collection refs
+            const deserializedCollection = deserialize(collectionRef, funnel_core_1.Schema.Collection.Data.AsLink.props);
+            collections[deserializedCollection.id] = deserializedCollection;
+            // extract and combine this ref's refs
+            const collectionRefs = deserializeRefs(collectionRef, strapiUrl);
+            files = Object.assign(Object.assign({}, files), collectionRefs.files);
+            collections = Object.assign(Object.assign({}, collections), collectionRefs.collections);
+        }
+        // return
+        return {
+            files,
+            collections
+        };
+    }
+    CollectionData.deserializeRefs = deserializeRefs;
+    function deserializeFlattened(data, strapiUrl, props = funnel_core_1.Schema.Collection.Data.Props.all) {
+        // return flattened
+        return Object.assign({ data: deserialize(data, props) }, deserializeRefs(data, strapiUrl));
+    }
+    CollectionData.deserializeFlattened = deserializeFlattened;
+    function deserializeLegacy(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));
+        const collections = ((_b = data.collectionRefs) !== null && _b !== void 0 ? _b : []).map(collectionRef => deserializeLegacy(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';
@@ -161,7 +272,7 @@ var CollectionData;
         // return collection
         return collection;
     }
-    CollectionData.deserialize = deserialize;
+    CollectionData.deserializeLegacy = deserializeLegacy;
     // deserialize ref
     function deserializeRef(data) {
         var _a, _b, _c;

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

@@ -109,7 +109,10 @@ export declare namespace PageData {
     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 deserialize<TPage extends Schema.Page.Data>(data: Potential, props?: ReadonlyArray<Schema.Page.Data.Props.All>): TPage;
+    function deserializeRefs(data: Potential, strapiUrl: string): Schema.Page.References;
+    function deserializeFlattened<TPage extends Schema.Page>(data: Potential, strapiUrl: string, props?: ReadonlyArray<Schema.Page.Data.Props.All>): Schema.Page.FlattenedData<TPage>;
+    function deserializeLegacy<TPage extends Schema.Page.LegacyData>(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?: {

package/dist/strapi/serialization/PageData.js

@@ -125,7 +125,133 @@ var PageData;
         return Array.from(filters);
     }
     PageData.getStrapiFilter = getStrapiFilter;
-    function deserialize(data, strapiUrl, props = funnel_core_1.Schema.Page.Data.Props.all) {
+    function deserialize(data, props = funnel_core_1.Schema.Page.Data.Props.all) {
+        // 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;
+        // 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;
+                // 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;
+                // ignore
+                case 'files':
+                case 'pages':
+                case 'collections':
+                    break;
+                // unhandled
+                default:
+                    throw new funnel_core_1.NotImplementedError(`Missing support for transforming page "${prop}" prop`);
+            }
+        }
+        // return page
+        return page;
+    }
+    PageData.deserialize = deserialize;
+    function deserializeRefs(data, strapiUrl) {
+        // extract reference fields
+        const { assetRefs = [], pageRefs = [], collectionRefs = [] } = data;
+        // files
+        let files = assetRefs
+            .map(data => StrapiAssetData_1.StrapiAssetData.deserialize(data, strapiUrl))
+            .reduce((files, asset) => {
+            files[asset.value.id] = asset;
+            return files;
+        }, {});
+        // pages
+        let pages = {};
+        let collections = {};
+        for (const pageRef of pageRefs) {
+            // deserialize page refs
+            const deserializedPage = deserialize(pageRef, funnel_core_1.Schema.Page.Data.AsPreview.props);
+            pages[deserializedPage.id] = deserializedPage;
+            // extract and combine this ref's refs
+            const pageRefs = deserializeRefs(pageRef, strapiUrl);
+            files = Object.assign(Object.assign({}, files), pageRefs.files);
+            pages = Object.assign(Object.assign({}, pages), pageRefs.pages);
+            collections = Object.assign(Object.assign({}, collections), pageRefs.collections);
+        }
+        // collections
+        for (const collectionRef of collectionRefs) {
+            // deserialize collection refs
+            const deserializedCollection = CollectionData_1.CollectionData.deserialize(collectionRef, funnel_core_1.Schema.Collection.Data.AsLink.props);
+            collections[deserializedCollection.id] = deserializedCollection;
+            // extract and combine this ref's refs
+            const collectionRefs = CollectionData_1.CollectionData.deserializeRefs(collectionRef, strapiUrl);
+            files = Object.assign(Object.assign({}, files), collectionRefs.files);
+            collections = Object.assign(Object.assign({}, collections), collectionRefs.collections);
+        }
+        // return
+        return {
+            files,
+            pages,
+            collections
+        };
+    }
+    PageData.deserializeRefs = deserializeRefs;
+    function deserializeFlattened(data, strapiUrl, props = funnel_core_1.Schema.Page.Data.Props.all) {
+        // return flattened
+        return Object.assign({ data: deserialize(data, props) }, deserializeRefs(data, strapiUrl));
+    }
+    PageData.deserializeFlattened = deserializeFlattened;
+    function deserializeLegacy(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));
@@ -135,10 +261,10 @@ var PageData;
             .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))
+            .map(data => deserializeLegacy(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))
+            .map(data => CollectionData_1.CollectionData.deserializeLegacy(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))) {
@@ -219,7 +345,7 @@ var PageData;
         // return page
         return page;
     }
-    PageData.deserialize = deserialize;
+    PageData.deserializeLegacy = deserializeLegacy;
     // deserialize ref
     function deserializeRef(data) {
         var _a, _b, _c, _d;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nascentdigital/funnel-cms",
-  "version": "4.5.6",
+  "version": "4.6.0",
   "repository": {
     "url": "git+https://github.com/nascentdigital/funnel.git",
     "directory": "libs/cms"
@@ -42,5 +42,5 @@
     "ts-jest": "^29",
     "type-fest": "^4"
   },
-  "gitHead": "e5899ba807b2c7241f493c850a98c1607df6771b"
+  "gitHead": "7fba18243bc79f94b3bd665db21f37bc7f3afd4c"
 }