@nascentdigital/funnel-cms 6.0.1 → 6.1.0

package/dist/contentful/ContentfulCollectionClient.d.ts

@@ -10,7 +10,7 @@ export declare class ContentfulCollectionClient implements CollectionClient {
     find(args: CollectionClient.Find.Args): Promise<CollectionClient.Find.Result>;
     getGroup(args: CollectionClient.GetGroup.Args): Promise<ContentfulCollectionClient.GetGroup.Result>;
     get(args: CollectionClient.Get.Args): Promise<ContentfulCollectionClient.Get.Result>;
-    create(args: CollectionClient.Create.Args): Promise<CollectionClient.Create.Result>;
+    create(args: CollectionClient.Create.Args): Promise<ContentfulCollectionClient.Create.Result>;
     duplicate(args: CollectionClient.Duplicate.Args): Promise<CollectionClient.Duplicate.Result>;
     update(args: CollectionClient.Update.Args): Promise<ContentfulCollectionClient.Update.Result>;
     replace(args: CollectionClient.Replace.Args): Promise<CollectionClient.Replace.Result>;
@@ -30,6 +30,11 @@ export declare namespace ContentfulCollectionClient {
     namespace Get {
         type Result = FlattenedCollectionData | undefined;
     }
+    namespace Create {
+        type Result = Omit<CollectionClient.Create.Result, 'collection'> & {
+            collection?: FlattenedCollectionData;
+        };
+    }
     namespace Update {
         type Result = Omit<CollectionClient.Update.Result, 'collection'> & {
             collection?: FlattenedCollectionData;

package/dist/contentful/ContentfulCollectionClient.js

@@ -167,7 +167,6 @@ class ContentfulCollectionClient {
                     references: [],
                     tags: [],
                     fields: {},
-                    state: 'draft',
                     errors: true
                 });
                 // return updated group
@@ -204,7 +203,6 @@ class ContentfulCollectionClient {
                     references: [],
                     tags: [],
                     fields: {},
-                    state: 'draft',
                     errors: true
                 });
                 // return updated group
@@ -236,7 +234,35 @@ class ContentfulCollectionClient {
         throw new funnel_core_1.NotImplementedError();
     }
     async update(args) {
-        throw new funnel_core_1.NotImplementedError();
+        var _a;
+        // fetch latest
+        const entryData = await this.cms.getEntryData(args.id);
+        const data = models_1.ContentfulCollectionData.deserialize(entryData);
+        // apply updates
+        const model = new funnel_core_1.Schema.CollectionModel(data);
+        model.update(args.updates);
+        model.sync();
+        // resolve references
+        const references = models_1.ContentfulData.findReferences([data.fields]);
+        // update entry
+        const entry = await this.cms.updateEntry({
+            id: data.id,
+            __version: data.__version,
+            // always update
+            name: data.name,
+            errors: data.errors,
+            references,
+            // TODO: only update if changed
+            // optional
+            tags: (_a = data.tags) !== null && _a !== void 0 ? _a : [],
+            fields: data.fields
+        });
+        // return
+        // TODO: return collection if there was an update from the outside
+        return {
+            updatedOn: entry.updatedOn,
+            changeSetId: ''
+        };
     }
     async replace(args) {
         throw new funnel_core_1.NotImplementedError();

package/dist/contentful/ContentfulContentClient.d.ts

@@ -32,11 +32,13 @@ export declare class ContentfulContentClient implements ContentClient, IContentf
     get token(): AuthClient.AccessToken;
     set token(token: AuthClient.AccessToken);
     clearToken(): void;
+    getEntryData<TEntry extends ContentfulData>(entryId: ContentfulData.EntryId<TEntry>): Promise<TEntry>;
     createEntry<T extends ContentfulData>(contentTypeId: string, entry: ContentfulData.Draft<T>): Promise<T>;
     getEntry<TEntry extends ContentfulData>({ entryId, includeLinks, version, ...query }: IContentfulContentClient.GetEntry.Args<TEntry>): Promise<IContentfulContentClient.GetEntry.Result<TEntry>>;
     getEntries<TEntry extends ContentfulData>({ pagination, version, includeLinks, ...query }: IContentfulContentClient.GetEntries.Args<TEntry>): Promise<IContentfulContentClient.GetEntries.Result<TEntry>>;
+    updateEntry<TEntry extends ContentfulData>(entry: ContentfulData.Update<TEntry>): Promise<TEntry>;
     uploadAsset(args: IContentfulContentClient.UploadAsset.Args): Promise<IContentfulContentClient.UploadAsset.Result>;
-    static forEditor(sdk: KnownAppSDK): Promise<ContentfulContentClient>;
+    static forEditor({ sdk, contentApiPath }: ContentfulContentClient.ForEditorArgs): Promise<ContentfulContentClient>;
 }
 export declare namespace ContentfulContentClient {
     type ConstructorArgs = ConstructorArgs.ForServer | ConstructorArgs.ForEditor;
@@ -57,4 +59,8 @@ export declare namespace ContentfulContentClient {
         function isForServer(args: ConstructorArgs): args is ForServer;
         function isForEditor(args: ConstructorArgs): args is ForEditor;
     }
+    type ForEditorArgs = {
+        sdk: KnownAppSDK;
+        contentApiPath: string;
+    };
 }

package/dist/contentful/ContentfulContentClient.js

@@ -30,7 +30,6 @@ class ContentfulContentClient {
     constructor(args) {
         var _a;
         // initialize instance variables
-        let sp;
         if (ContentfulContentClient.ConstructorArgs.isForServer(args)) {
             this.user = models_1.User.UNAUTHENTICATED;
             this.locale = args.locale;
@@ -79,6 +78,13 @@ class ContentfulContentClient {
     clearToken() {
         throw new funnel_core_1.NotImplementedError();
     }
+    async getEntryData(entryId) {
+        // create entry
+        const { locale, cma } = this;
+        const data = await cma.entry.get({ entryId });
+        // transform + return new entry
+        return models_2.ContentfulData.fromCmaData(data, locale);
+    }
     async createEntry(contentTypeId, entry) {
         // create entry
         const { locale, cma } = this;
@@ -154,6 +160,30 @@ class ContentfulContentClient {
             totalItemCount: totalItems
         };
     }
+    async updateEntry(entry) {
+        // create entry
+        const { locale, cma } = this;
+        // create patch operations
+        const ops = [];
+        Object.entries(entry).forEach(([key, value]) => {
+            // skip over these keys
+            if (key === 'id' || key === '__version') {
+                return;
+            }
+            // create add op
+            ops.push({
+                op: 'add',
+                path: `/fields/${key}`,
+                value: {
+                    [locale]: value
+                }
+            });
+        });
+        // execute patch operations
+        const data = await cma.entry.patch({ entryId: entry.id, version: entry.__version }, ops);
+        // transform + return new entry
+        return models_2.ContentfulData.fromCmaData(data, locale);
+    }
     async uploadAsset(args) {
         var _a;
         // upload file
@@ -205,7 +235,7 @@ class ContentfulContentClient {
         // return asset
         return models_2.ContentfulData.fromCmaData(entry, locale);
     }
-    static async forEditor(sdk) {
+    static async forEditor({ sdk, contentApiPath }) {
         var _a;
         // get current site config (throw if we can't)
         const { user, cma, locales: { default: locale } } = sdk;
@@ -236,7 +266,7 @@ class ContentfulContentClient {
             userId: access.userId,
             token: access.token
         };
-        const response = await fetch('/api/contentful', {
+        const response = await fetch(contentApiPath, {
             method: 'POST',
             body: JSON.stringify(command)
         });

package/dist/contentful/ContentfulPageClient.js

@@ -187,7 +187,6 @@ class ContentfulPageClient {
                     preview: draftData.preview,
                     discover: draftData.discover,
                     content: draftData.content,
-                    state: 'draft',
                     errors: true,
                     references
                 });
@@ -296,7 +295,6 @@ class ContentfulPageClient {
                     preview: draftData.preview,
                     discover: draftData.discover,
                     content: draftData.content,
-                    state: 'draft',
                     errors: true,
                     references
                 });

package/dist/contentful/IContentfulContentClient.d.ts

@@ -24,8 +24,16 @@ export interface IContentfulContentClient {
     readonly users: ContentfulUserClient;
     readonly siteConfig: ContentfulSiteConfigClient;
     createEntry<TEntry extends ContentfulData>(contentType: string, entry: ContentfulData.Draft<TEntry>): Promise<TEntry>;
+    /**
+     * Get entry by id without any references
+     */
+    getEntryData<TEntry extends ContentfulData>(entryId: ContentfulData.EntryId<TEntry>): Promise<TEntry>;
+    /**
+     * Get entry with references
+     */
     getEntry<TEntry extends ContentfulData>(args: IContentfulContentClient.GetEntry.Args<TEntry>): Promise<IContentfulContentClient.GetEntry.Result<TEntry>>;
     getEntries<TEntry extends ContentfulData>(args: IContentfulContentClient.GetEntries.Args<TEntry>): Promise<IContentfulContentClient.GetEntries.Result<TEntry>>;
+    updateEntry<TEntry extends ContentfulData>(entry: ContentfulData.Update<TEntry>): Promise<TEntry>;
     uploadAsset(args: IContentfulContentClient.UploadAsset.Args): Promise<IContentfulContentClient.UploadAsset.Result>;
 }
 export declare namespace IContentfulContentClient {

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

@@ -1,13 +1,15 @@
 import { RequiredBy, Schema } from '@nascentdigital/funnel-core';
 import { ContentfulData } from './ContentfulData';
-export type ContentfulCollectionData = ContentfulData<ContentfulCollectionData.ContentType, Schema.Collection.Id> & Omit<Schema.Collection.Data, 'id' | 'changeSetId' | 'snapshotId' | 'snapshot'> & {
+export type ContentfulCollectionData = ContentfulData<ContentfulCollectionData.ContentType, Schema.Collection.Id, Schema.Collection.State> & Omit<Schema.Collection.Data, 'id' | 'changeSetId' | 'snapshotId' | 'snapshot'> & {
     references: ContentfulData.References;
 };
 export declare namespace ContentfulCollectionData {
     const contentType: "collection";
     type ContentType = typeof contentType;
-    type ForSchema = Schema.Collection.Data;
-    type Potential = RequiredBy<Partial<ContentfulCollectionData>, keyof ContentfulData<ContentfulCollectionData.ContentType, Schema.Collection.Id>>;
+    type ForSchema = Schema.Collection.Data & {
+        __version: number;
+    };
+    type Potential = RequiredBy<Partial<ContentfulCollectionData>, '__type' | '__version' | 'id' | 'createdOn' | 'updatedOn' | 'state'>;
     function deserialize(data: Potential, props?: ReadonlyArray<Schema.Collection.Data.Props.All>): ForSchema;
     function deserializeRefs(refs: ContentfulData[]): Schema.Collection.References;
 }

package/dist/contentful/models/ContentfulCollectionData.js

@@ -14,9 +14,12 @@ var ContentfulCollectionData;
         // create base collection
         const collection = {
             __root: 'collection',
+            __version: data.__version,
             id: data.id,
             createdOn: data.createdOn,
             updatedOn: data.updatedOn,
+            publishedOn: data.publishedOn,
+            state: data.state,
             references: (_a = data.references) !== null && _a !== void 0 ? _a : []
         };
         // helper
@@ -32,6 +35,8 @@ var ContentfulCollectionData;
                 case 'id':
                 case 'createdOn':
                 case 'updatedOn':
+                case 'publishedOn':
+                case 'state':
                     break;
                 // direct transforms
                 case 'groupId':
@@ -40,11 +45,9 @@ var ContentfulCollectionData;
                 case 'language':
                 case 'version':
                 case 'name':
-                case 'state':
                 case 'errors':
                 case 'pageIds':
                 case 'tags':
-                case 'publishedOn':
                     bindProp(prop, prop, value => value !== null && value !== void 0 ? value : undefined);
                     break;
                 // content

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

@@ -1,18 +1,21 @@
 import type { EntryAPI } from '@contentful/app-sdk';
 import type { Entry } from 'contentful';
 import type { EntryProps } from 'contentful-management';
-export type ContentfulData<TType extends string = string, TId extends string = string> = {
+export type ContentfulData<TType extends string = string, TId extends string = string, TState extends string = string> = {
     __type: TType;
     __version: number;
     id: TId;
     createdOn: number;
     updatedOn: number;
+    publishedOn?: number;
+    state: TState;
 };
 export declare namespace ContentfulData {
     type ContentType<T extends ContentfulData> = T['__type'];
     type EntryId<T extends ContentfulData> = T['id'];
     type References = Array<Link.Entry | Link.Asset>;
     type Draft<T extends ContentfulData> = Omit<T, keyof ContentfulData | '__root'>;
+    type Update<T extends ContentfulData> = Pick<ContentfulData, 'id' | '__version'> & Partial<Draft<T>>;
     type Link<TType extends Link.Type = Link.Type> = {
         sys: {
             type: 'Link';
@@ -31,6 +34,7 @@ export declare namespace ContentfulData {
             [locale: string]: TData[TKey];
         };
     };
+    function calcState<TState extends string = string>({ updatedOn, publishedOn }: Pick<ContentfulData, 'updatedOn' | 'publishedOn'>): TState;
     function toEntryData<T extends Record<string, any>>(entry: T, locale: string): Fields<T>;
     function fromEntryData<T extends ContentfulData>(entry: EntryAPI): T;
     function fromCdaData<T extends ContentfulData>({ sys, fields }: Entry): T;

package/dist/contentful/models/ContentfulData.js

@@ -19,6 +19,14 @@ var ContentfulData;
         Link.create = create;
     })(Link = ContentfulData.Link || (ContentfulData.Link = {}));
     // helpers
+    function calcState({ updatedOn, publishedOn }) {
+        return (publishedOn
+            ? publishedOn === updatedOn
+                ? 'published'
+                : 'unpublished'
+            : 'draft');
+    }
+    ContentfulData.calcState = calcState;
     function toEntryData(entry, locale) {
         return Object.entries(entry).reduce((entryData, [keyRaw, value]) => {
             // map entry (bucket under locale)
@@ -37,8 +45,16 @@ var ContentfulData;
         for (const key in entry.fields) {
             normalizedFields[key] = entry.fields[key].getValue();
         }
+        // parse date strings
+        const createdOn = Date.parse(sys.createdAt);
+        const updatedOn = Date.parse(sys.updatedAt);
+        const publishedOn = sys.publishedAt === undefined
+            ? undefined
+            : Date.parse(sys.publishedAt);
         // return normalized form
-        return Object.assign({ __type: sys.contentType.sys.id, __version: sys.version, id: sys.id, createdOn: new Date(sys.createdAt).getTime(), updatedOn: new Date(sys.updatedAt).getTime() }, normalizedFields);
+        return Object.assign(Object.assign({}, normalizedFields), { __type: sys.contentType.sys.id, __version: sys.version, id: sys.id, createdOn,
+            updatedOn,
+            publishedOn, state: calcState({ updatedOn, publishedOn }) });
     }
     ContentfulData.fromEntryData = fromEntryData;
     function fromCdaData({ sys, fields }) {
@@ -48,7 +64,9 @@ var ContentfulData;
             normalizedFields[key] = fields[key];
         }
         // return normalized form
-        return Object.assign({ __type: sys.contentType.sys.id, __version: sys.revision, id: sys.id, createdOn: new Date(sys.createdAt).getTime(), updatedOn: new Date(sys.updatedAt).getTime() }, normalizedFields);
+        return Object.assign(Object.assign({}, normalizedFields), { __type: sys.contentType.sys.id, __version: sys.revision, id: sys.id, createdOn: Date.parse(sys.createdAt), updatedOn: Date.parse(sys.updatedAt), 
+            // using updatedAt since it has to be published for delivery api
+            publishedOn: Date.parse(sys.updatedAt), state: 'published' });
     }
     ContentfulData.fromCdaData = fromCdaData;
     function fromCmaData({ sys, fields }, locale) {
@@ -57,8 +75,16 @@ var ContentfulData;
         for (const key in fields) {
             normalizedFields[key] = fields[key][locale];
         }
+        // parse date strings
+        const createdOn = Date.parse(sys.createdAt);
+        const updatedOn = Date.parse(sys.updatedAt);
+        const publishedOn = sys.publishedAt === undefined
+            ? undefined
+            : Date.parse(sys.publishedAt);
         // return normalized form
-        return Object.assign({ __type: sys.contentType.sys.id, __version: sys.version, id: sys.id, createdOn: new Date(sys.createdAt).getTime(), updatedOn: new Date(sys.updatedAt).getTime() }, normalizedFields);
+        return Object.assign(Object.assign({}, normalizedFields), { __type: sys.contentType.sys.id, __version: sys.version, id: sys.id, createdOn,
+            updatedOn,
+            publishedOn, state: calcState({ updatedOn, publishedOn }) });
     }
     ContentfulData.fromCmaData = fromCmaData;
     function findReferences(source) {

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

@@ -1,6 +1,6 @@
 import { RequiredBy, Schema } from '@nascentdigital/funnel-core';
 import { ContentfulData } from './ContentfulData';
-export type ContentfulPageData = ContentfulData<ContentfulPageData.ContentType, Schema.Page.Id> & Omit<Schema.Page.Data, 'id' | 'changeSetId' | 'snapshotId' | 'snapshot'> & {
+export type ContentfulPageData = ContentfulData<ContentfulPageData.ContentType, Schema.Page.Id, Schema.Page.State> & Omit<Schema.Page.Data, 'id' | 'changeSetId' | 'snapshotId' | 'snapshot'> & {
     references: ContentfulData.References;
 };
 export declare namespace ContentfulPageData {
@@ -17,7 +17,7 @@ export declare namespace ContentfulPageData {
         function deserialize(snapshot: Snapshot): Schema.PageSnapshot;
     }
     type ForSchema = Schema.Page.Data;
-    type Potential = RequiredBy<Partial<ContentfulPageData>, keyof ContentfulData<ContentfulPageData.ContentType, Schema.Page.Id>>;
+    type Potential = RequiredBy<Partial<ContentfulPageData>, '__type' | '__version' | 'id' | 'createdOn' | 'updatedOn' | 'state'>;
     function deserialize(data: Potential, props?: ReadonlyArray<Schema.Page.Data.Props.All>): ForSchema;
     function deserializeRefs(refs: ContentfulData[]): Schema.Page.References;
 }

package/dist/contentful/models/ContentfulPageData.js

@@ -32,6 +32,8 @@ var ContentfulPageData;
             id: data.id,
             createdOn: data.createdOn,
             updatedOn: data.updatedOn,
+            publishedOn: data.publishedOn,
+            state: data.state,
             references: (_a = data.references) !== null && _a !== void 0 ? _a : []
         };
         // helper
@@ -47,6 +49,8 @@ var ContentfulPageData;
                 case 'id':
                 case 'createdOn':
                 case 'updatedOn':
+                case 'publishedOn':
+                case 'state':
                     break;
                 // direct transforms
                 case 'groupId':
@@ -58,10 +62,8 @@ var ContentfulPageData;
                 case 'url':
                 case 'name':
                 case 'preview':
-                case 'state':
                 case 'errors':
                 case 'tags':
-                case 'publishedOn':
                 case 'publication':
                     bindProp(prop, prop, value => value !== null && value !== void 0 ? value : undefined);
                     break;

package/package.json

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