@stackbit/cms-contentstack 0.1.2-develop.1 → 0.1.2-staging.1

package/src/contentstack-content-source.ts

@@ -15,7 +15,7 @@ import {
     convertAssets,
     DocumentWithContext
 } from './contentstack-entries-converter';
-import { createEntryFromOperationFields, updateEntryFromUpdateOperations } from './contentstack-operation-converter';
+import { createEntryFromOperationFields, updateEntryFromUpdateOperations, GetLeanDocumentById } from './contentstack-operation-converter';
 import { getContentstackDashboardUrl, resolvePublishEnvironment, downloadFile, createWebhookIfNeeded, userMissingInMap } from './contentstack-utils';
 import { ContentPoller, getLastUpdatedEntityDate, SyncContext, SyncResult } from './contentstack-content-poller';
 import type { User, Asset, Entry, Environment, WebhookPayload } from './contentstack-types';
@@ -33,13 +33,13 @@ export interface ContentStackSourceOptions {
      * of your organization. If you don't pass the authtoken, some features
      * may not work in Stackbit properly.
      *
-     * To get the authtoken, use the following command:
+     * To get the authtoken, use the following command (replace YOUR_EMAIL and
+     * YOUR_PASSWORD) with your Contentstack credentials:
      * ```
      * curl -X POST \
      *      -H "Content-Type: application/json" \
-     *      -d '{"user":{"email":"simon@stackbit.com","password":"i7rdEiZUt!6tMEUkeFTo"}}' \
-     *      https://api.contentstack.io/v3/user-session \
-     *      | grep -ioE '"authtoken":"([^\"])+"'
+     *      -d '{"user":{"email":"YOUR_EMAIL","password":"YOUR_PASSWORD"}}' \
+     *      https://api.contentstack.io/v3/user-session | grep -ioE '"authtoken":"([^\"])+"'
      * ```
      */
     authtoken?: string;
@@ -85,6 +85,7 @@ export class ContentstackContentSource
     private publishEnvironmentName?: string;
     private publishEnvironment!: Environment;
     private usersById: Record<string, User> = {};
+    private newUnsyncedEntryMap: Record<string, string> = {};
 
     constructor({ apiKey, managementToken, branch, authtoken, masterLocale, publishEnvironmentName, skipFetchOnStartIfCache }: ContentStackSourceOptions) {
         this.apiKey = apiKey;
@@ -164,6 +165,8 @@ export class ContentstackContentSource
     }
 
     async reset(): Promise<void> {
+        this.logger.debug('reset');
+
         const environments = await this.contentStackClient.getEnvironments();
         this.publishEnvironment = resolvePublishEnvironment({
             environments,
@@ -172,6 +175,7 @@ export class ContentstackContentSource
         });
 
         if (this.authtoken) {
+            this.logger.debug('getStack');
             const stack = await this.contentStackClient.getStack(this.authtoken);
             this.masterLocale = stack.master_locale;
             await this.fetchUsers();
@@ -211,6 +215,11 @@ export class ContentstackContentSource
                 } else {
                     const result = await this.convertSyncResult(syncResult);
                     await this.cache.updateContent(result);
+                    for (const document of result.documents) {
+                        if (this.newUnsyncedEntryMap[document.id]) {
+                            delete this.newUnsyncedEntryMap[document.id];
+                        }
+                    }
                 }
             }
         });
@@ -276,6 +285,7 @@ export class ContentstackContentSource
     }
 
     async fetchUsers() {
+        this.logger.debug('fetchUsers');
         if (this.authtoken) {
             const users = await this.contentStackClient.getUsers(this.authtoken);
             this.usersById = _.keyBy(users, 'uid');
@@ -435,11 +445,14 @@ export class ContentstackContentSource
         const entry = createEntryFromOperationFields({
             updateOperationFields: options.updateOperationFields,
             model: options.model,
-            getDocumentById: this.cache.getDocumentById,
+            getDocumentById: this.getCachedDocumentById.bind(this),
             getModelByName: this.cache.getModelByName,
             logger: this.logger
         });
         const newEntry = await this.contentStackClient.createEntry(options.model.name, entry);
+        // cache the created entry's uid and model name until it is received from Contentstack
+        // via onWebhook or contentPoller's notificationCallback methods.
+        this.newUnsyncedEntryMap[newEntry.uid] = options.model.name;
         return { documentId: newEntry.uid };
     }
 
@@ -454,13 +467,28 @@ export class ContentstackContentSource
         const updatedEntry = updateEntryFromUpdateOperations({
             entry,
             updateOperations: operations,
-            getDocumentById: this.cache.getDocumentById,
+            getDocumentById: this.getCachedDocumentById.bind(this),
             getModelByName: this.cache.getModelByName,
             logger: this.logger
         });
         await this.contentStackClient.updateEntry(updatedEntry);
     }
 
+    getCachedDocumentById(documentId: string): ReturnType<GetLeanDocumentById> {
+        const document = this.cache.getDocumentById(documentId);
+        if (document) {
+            return document;
+        }
+        if (this.newUnsyncedEntryMap[documentId]) {
+            this.logger.debug(`the created document ${documentId} was not yet fetched from Contentstack, using the cached document`);
+            return {
+                id: documentId,
+                modelName: this.newUnsyncedEntryMap[documentId]!
+            };
+        }
+        return;
+    }
+
     async deleteDocument(options: { document: StackbitTypes.Document<unknown>; userContext?: UserWithContext }): Promise<void> {
         this.logger.debug('deleteDocument');
         await this.contentStackClient.deleteEntry(options.document.modelName, options.document.id);
@@ -479,7 +507,7 @@ export class ContentstackContentSource
         let asset: Asset;
         try {
             if (options.base64) {
-                // TODO: write to .stackbit/cache folder
+                // TODO: pass the path to .stackbit/cache folder in init() options and use it to write the temp file
                 await writeFile(tempName, Buffer.from(options.base64, 'base64'));
             } else {
                 await downloadFile(options.url!, tempName);
@@ -545,41 +573,31 @@ export class ContentstackContentSource
 
         this.logger.debug(`got webhook for ${webhookData.event} ${webhookData.module}`);
 
+        let unsyncedEntryUid: string | undefined;
+
         if (webhookData.module === 'entry') {
             switch (webhookData.event) {
                 case 'create':
-                case 'update': {
-                    if (userMissingInMap(this.usersById, webhookData.data.entry as Entry)) {
-                        await this.fetchUsers();
-                    }
-                    const document = convertEntry({
-                        entry: {
-                            ...webhookData.data.entry,
-                            content_type_uid: webhookData.data.content_type.uid,
-                            publish_details: [],
-                            _branch: webhookData.data.branch.uid
-                        } as unknown as Entry,
-                        status: webhookData.event === 'create' ? 'added' : 'modified',
-                        apiKey: this.apiKey,
-                        getModelByName: this.cache.getModelByName,
-                        usersById: this.usersById,
-                        publishEnvironment: this.publishEnvironment,
-                        logger: this.logger
-                    });
-                    updates.documents!.push(document);
-                    break;
-                }
+                case 'update':
                 case 'publish': {
-                    if (webhookData.data.environment.uid !== this.publishEnvironment.uid) {
+                    // Generally, entry publish webhooks created by the content source are already configured to filter
+                    // only the publishEnvironment. However, still check for the publish event environment in case the
+                    // webhook was manually changed.
+                    if (webhookData.event === 'publish' && webhookData.data.environment.uid !== this.publishEnvironment.uid) {
                         this.logger.debug(
                             `entry was published in an environment '${webhookData.data.environment.name}' ` +
                                 `different from the publish environment '${this.publishEnvironment.name}', ignoring the webhook'`
                         );
                         break;
                     }
+                    if (webhookData.event === 'create' && webhookData.data.entry.uid in this.newUnsyncedEntryMap) {
+                        unsyncedEntryUid = webhookData.data.entry.uid;
+                    }
                     if (userMissingInMap(this.usersById, webhookData.data.entry as Entry)) {
                         await this.fetchUsers();
                     }
+                    const status: StackbitTypes.DocumentStatus =
+                        webhookData.event === 'publish' ? 'published' : webhookData.event === 'create' ? 'added' : 'modified';
                     const document = convertEntry({
                         entry: {
                             ...webhookData.data.entry,
@@ -587,7 +605,7 @@ export class ContentstackContentSource
                             publish_details: [],
                             _branch: webhookData.data.branch.uid
                         } as unknown as Entry,
-                        status: 'published',
+                        status: status,
                         apiKey: this.apiKey,
                         getModelByName: this.cache.getModelByName,
                         usersById: this.usersById,
@@ -614,25 +632,9 @@ export class ContentstackContentSource
         } else if (webhookData.module === 'asset') {
             switch (webhookData.event) {
                 case 'create':
-                case 'update': {
-                    if (userMissingInMap(this.usersById, webhookData.data.asset as Asset)) {
-                        await this.fetchUsers();
-                    }
-                    const asset = convertAsset({
-                        asset: {
-                            ...webhookData.data.asset,
-                            publish_details: [],
-                            _branch: webhookData.data.branch.uid
-                        } as unknown as Asset,
-                        apiKey: this.apiKey,
-                        usersById: this.usersById,
-                        publishEnvironment: this.publishEnvironment
-                    });
-                    updates.assets!.push(asset);
-                    break;
-                }
+                case 'update':
                 case 'publish': {
-                    if (webhookData.data.environment.uid !== this.publishEnvironment.uid) {
+                    if (webhookData.event === 'publish' && webhookData.data.environment.uid !== this.publishEnvironment.uid) {
                         this.logger.debug(
                             `asset was published in an environment '${webhookData.data.environment.name}' ` +
                                 `different from the publish environment '${this.publishEnvironment.name}', ignoring the webhook'`
@@ -682,6 +684,10 @@ export class ContentstackContentSource
                 `deleted documents: ${updates.deletedDocumentIds?.length}, ` +
                 `deleted assets: ${updates.deletedAssetIds?.length}`
         );
-        this.cache.updateContent(updates);
+        await this.cache.updateContent(updates);
+
+        if (unsyncedEntryUid) {
+            delete this.newUnsyncedEntryMap[unsyncedEntryUid];
+        }
     }
 }

package/src/contentstack-operation-converter.ts

@@ -4,10 +4,9 @@ import * as StackbitTypes from '@stackbit/types';
 import type { EntryData } from '@contentstack/management/types/stack/contentType/entry';
 import type { Entry, Asset } from './contentstack-types';
 import type { ModelWithContext } from './contentstack-schema-converter';
-import type { DocumentWithContext } from './contentstack-entries-converter';
 
 type GetModelByName = (modelName: string) => ModelWithContext | undefined;
-type GetDocumentById = (documentId: string) => DocumentWithContext | undefined;
+export type GetLeanDocumentById = (documentId: string) => { id: string; modelName: string } | undefined;
 
 export function createEntryFromOperationFields({
     updateOperationFields,
@@ -18,7 +17,7 @@ export function createEntryFromOperationFields({
 }: {
     updateOperationFields: Record<string, StackbitTypes.UpdateOperationField>;
     model: ModelWithContext;
-    getDocumentById: GetDocumentById;
+    getDocumentById: GetLeanDocumentById;
     getModelByName: GetModelByName;
     logger: StackbitTypes.Logger;
 }): EntryData {
@@ -55,7 +54,7 @@ export function updateEntryFromUpdateOperations({
 }: {
     entry: Entry;
     updateOperations: StackbitTypes.UpdateOperation[];
-    getDocumentById: GetDocumentById;
+    getDocumentById: GetLeanDocumentById;
     getModelByName: GetModelByName;
     logger: StackbitTypes.Logger;
 }): Entry {
@@ -117,7 +116,7 @@ export function getUpdatedEntryAtFieldPathWithOperation({
     entry: Entry;
     updateOperation: StackbitTypes.UpdateOperation;
     model: ModelWithContext;
-    getDocumentById: GetDocumentById;
+    getDocumentById: GetLeanDocumentById;
     getModelByName: GetModelByName;
     logger: StackbitTypes.Logger;
 }): Entry {
@@ -378,7 +377,7 @@ function getValueForOperation({
     rootModel: ModelWithContext;
     entryFieldPath: (string | number)[];
     modelFieldPath: string[];
-    getDocumentById: GetDocumentById;
+    getDocumentById: GetLeanDocumentById;
     getModelByName: GetModelByName;
     errorPrefix: string;
     logger: StackbitTypes.Logger;
@@ -468,7 +467,7 @@ export function convertOperationFieldValue({
     isInList: boolean;
     entryFieldPath: (string | number)[];
     modelFieldPath: string[];
-    getDocumentById: GetDocumentById;
+    getDocumentById: GetLeanDocumentById;
     getModelByName: GetModelByName;
     errorPrefix: string;
 }): any {

package/dist/contentstack-conversion-utils.d.ts

@@ -1,41 +0,0 @@
-import * as StackbitTypes from '@stackbit/types';
-import { EntryData } from '@contentstack/management/types/stack/contentType/entry';
-import { Entry } from './contentstack-types';
-import { ModelWithContext } from './contentstack-schema-converter';
-import { DocumentWithContext } from './contentstack-entries-converter';
-declare type GetModelByName = (modelName: string) => ModelWithContext | undefined;
-declare type GetDocumentById = (documentId: string) => DocumentWithContext | undefined;
-export declare function createEntryFromOperationFields({ updateOperationFields, model, getDocumentById, getModelByName, logger }: {
-    updateOperationFields: Record<string, StackbitTypes.UpdateOperationField>;
-    model: ModelWithContext;
-    getDocumentById: GetDocumentById;
-    getModelByName: GetModelByName;
-    logger: StackbitTypes.Logger;
-}): EntryData;
-export declare function updateEntryFromUpdateOperations({ entry, updateOperations, getDocumentById, getModelByName, logger }: {
-    entry: Entry;
-    updateOperations: StackbitTypes.UpdateOperation[];
-    getDocumentById: GetDocumentById;
-    getModelByName: GetModelByName;
-    logger: StackbitTypes.Logger;
-}): Entry;
-export declare function getUpdatedEntryAtFieldPathWithOperation({ entry, updateOperation, model, getDocumentById, getModelByName, logger }: {
-    entry: Entry;
-    updateOperation: StackbitTypes.UpdateOperation;
-    model: ModelWithContext;
-    getDocumentById: GetDocumentById;
-    getModelByName: GetModelByName;
-    logger: StackbitTypes.Logger;
-}): Entry;
-export declare function convertOperationFieldValue({ updateOperationField, rootModel, modelField, entryFieldPath, modelFieldPath, getDocumentById, getModelByName, errorPrefix }: {
-    updateOperationField: StackbitTypes.UpdateOperationField;
-    rootModel: ModelWithContext;
-    modelField: StackbitTypes.FieldSpecificProps;
-    entryFieldPath: (string | number)[];
-    modelFieldPath: string[];
-    getDocumentById: GetDocumentById;
-    getModelByName: GetModelByName;
-    errorPrefix: string;
-}): any;
-export {};
-//# sourceMappingURL=contentstack-conversion-utils.d.ts.map

package/dist/contentstack-conversion-utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"contentstack-conversion-utils.d.ts","sourceRoot":"","sources":["../src/contentstack-conversion-utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,wDAAwD,CAAC;AAEnF,OAAO,EAAE,KAAK,EAAS,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,aAAK,cAAc,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,gBAAgB,GAAG,SAAS,CAAC;AAC1E,aAAK,eAAe,GAAG,CAAC,UAAU,EAAE,MAAM,KAAK,mBAAmB,GAAG,SAAS,CAAC;AAE/E,wBAAgB,8BAA8B,CAAC,EAC3C,qBAAqB,EACrB,KAAK,EACL,eAAe,EACf,cAAc,EACd,MAAM,EACT,EAAE;IACC,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;IAC1E,KAAK,EAAE,gBAAgB,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,cAAc,CAAC;IAC/B,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC;CAChC,GAAG,SAAS,CAsBZ;AAED,wBAAgB,+BAA+B,CAAC,EAC5C,KAAK,EACL,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,MAAM,EACT,EAAE;IACC,KAAK,EAAE,KAAK,CAAC;IACb,gBAAgB,EAAE,aAAa,CAAC,eAAe,EAAE,CAAC;IAClD,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,cAAc,CAAC;IAC/B,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC;CAChC,GAAG,KAAK,CA8CR;AAED,wBAAgB,uCAAuC,CAAC,EACpD,KAAK,EACL,eAAe,EACf,KAAK,EACL,eAAe,EACf,cAAc,EACd,MAAM,EACT,EAAE;IACC,KAAK,EAAE,KAAK,CAAC;IACb,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC;IAC/C,KAAK,EAAE,gBAAgB,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,cAAc,CAAC;IAC/B,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC;CAChC,GAAG,KAAK,CA+OR;AA2FD,wBAAgB,0BAA0B,CAAC,EACvC,oBAAoB,EACpB,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,eAAe,EACf,cAAc,EACd,WAAW,EACd,EAAE;IACC,oBAAoB,EAAE,aAAa,CAAC,oBAAoB,CAAC;IACzD,SAAS,EAAE,gBAAgB,CAAC;IAC5B,UAAU,EAAE,aAAa,CAAC,kBAAkB,CAAC;IAC7C,cAAc,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACpC,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,cAAc,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;CACvB,GAAG,GAAG,CA+KN"}