@stackbit/cms-core 1.0.20-develop.1 → 1.0.20-develop.2

package/src/content-store.ts

@@ -46,7 +46,8 @@ import {
     contentChangeResultCounts,
     updateOperationValueFieldWithCrossReference,
     getErrorAtLine,
-    findContentSourcesDataForTypeOrId
+    findContentSourcesDataForTypeOrId,
+    getDocumentFieldForLocale
 } from './content-store-utils';
 import {
     getSiteMapEntriesFromStackbitConfig,
@@ -1986,6 +1987,122 @@ export class ContentStore {
         }
     }
 
+    async getStagedChanges({
+        scope,
+        locale,
+        shallow,
+        objects
+    }: {
+        scope: 'all' | 'code' | 'content';
+        locale?: string;
+        shallow?: boolean;
+        objects: { srcObjectId: string; srcProjectId: string; srcType: string; srcEnvironment?: string }[];
+    }): Promise<ContentStoreTypes.StagedChange[]> {
+        const getObjectStrId = (srcType: string, srcProjectId: string, srcObjectId: string) => `${srcType}:${srcProjectId}:${srcObjectId}`;
+
+        const documents = this.getDocuments({ locale });
+        const assets = this.getAssets({ locale });
+        const allObjects = [...documents, ...assets];
+
+        const isPublishingSpecificDocuments = scope === 'content' && objects.length;
+
+        let publishableObjects: (ContentStoreTypes.Document | ContentStoreTypes.Asset)[];
+        // filter content only if scope is content, if scope is all ignore objects
+        if (isPublishingSpecificDocuments) {
+            const objectIds = objects.map((object) => object.srcObjectId);
+            publishableObjects = [
+                ..._.filter(documents, (document) => objectIds.includes(document.srcObjectId)),
+                ..._.filter(assets, (asset) => objectIds.includes(asset.srcObjectId))
+            ];
+        } else {
+            // scope === 'all' or scope === 'content' with empty objects
+            publishableObjects = allObjects;
+        }
+
+        const visited: string[] = publishableObjects.map((object) => getObjectStrId(object.srcType, object.srcProjectId, object.srcObjectId));
+
+        const findUsedChangedObjects = (
+            rootObject: ContentStoreTypes.Document,
+            fields: ContentStoreTypes.DocumentField[]
+        ): Array<ContentStoreTypes.Document | ContentStoreTypes.Asset> => {
+            return _.flatMap(fields, (field) => {
+                const localizedField = getDocumentFieldForLocale(field, locale);
+
+                if (localizedField?.type === 'list') {
+                    return findUsedChangedObjects(rootObject, localizedField.items);
+                } else if (localizedField?.type === 'object' || localizedField?.type === 'model') {
+                    return localizedField.isUnset ? [] : findUsedChangedObjects(rootObject, Object.values(localizedField.fields));
+                } else if (localizedField?.type === 'reference') {
+                    if (localizedField.isUnset) {
+                        return [];
+                    }
+
+                    const { refId } = localizedField;
+
+                    const objectStrId = getObjectStrId(rootObject.srcType, rootObject.srcProjectId, refId);
+                    if (visited.includes(objectStrId)) {
+                        return [];
+                    }
+
+                    visited.push(objectStrId);
+
+                    const refObject = _.find(allObjects, {
+                        srcObjectId: refId,
+                        srcType: rootObject.srcType,
+                        srcProjectId: rootObject.srcProjectId
+                    });
+                    if (refObject) {
+                        if (refObject.type === 'asset') {
+                            return refObject.isChanged ? [refObject] : [];
+                        }
+                        return [...(refObject.isChanged ? [refObject] : []), ...findUsedChangedObjects(refObject, Object.values(refObject.fields))];
+                    }
+                }
+
+                return [];
+            });
+        };
+
+        const changes = publishableObjects.reduce((result: ContentStoreTypes.StagedChange[], object: ContentStoreTypes.Document | ContentStoreTypes.Asset) => {
+            const changedObjects = [];
+
+            if (object.isChanged) {
+                changedObjects.push(object);
+            }
+
+            if (isPublishingSpecificDocuments && object.type !== 'asset' && !shallow) {
+                // when publishing specific documents, go over changed fields and see if their reference objects are not changed in case
+                // it's not already in the publishableObjects list;
+                changedObjects.push(...findUsedChangedObjects(object, Object.values(object.fields)));
+            }
+
+            result.push(
+                ...changedObjects.map(
+                    (object): ContentStoreTypes.StagedChange => ({
+                        changeId: object.srcObjectId,
+                        changeType: object.type === 'document' ? 'content' : 'asset',
+                        label: object.type === 'asset' ? object.srcObjectLabel : object.getPreview({ locale }).previewTitle,
+                        status: object.status,
+                        srcModelName: object.srcModelName,
+                        srcObjectId: object.srcObjectId,
+                        srcProjectId: object.srcProjectId,
+                        srcEnvironment: object.srcEnvironment,
+                        srcType: object.srcType,
+                        createdAt: object.createdAt,
+                        createdBy: object.createdBy,
+                        updatedAt: object.updatedAt,
+                        updatedBy: object.updatedBy || [],
+                        locale: object.locale
+                    })
+                )
+            );
+
+            return result;
+        }, []);
+
+        return changes;
+    }
+
     getAsset({ srcAssetId, srcProjectId, srcType }: { srcAssetId: string; srcProjectId: string; srcType: string }): ContentStoreTypes.Asset | undefined {
         const contentSourceId = getContentSourceId(srcType, srcProjectId);
         const contentSourceData = this.getContentSourceDataByIdOrThrow(contentSourceId);

package/src/types/content-store-types.ts

@@ -81,6 +81,7 @@ export interface ContentChangeResult {
 export interface User {
     name: string;
     email: string;
+    role?: string;
     sso?: StackbitTypes.UserSSOProfile;
     connections: {
         type: string;

package/src/types/index.ts

@@ -5,3 +5,4 @@ export * from './content-store-api-document-fields';
 export * from './content-store-update-operation';
 export * from './search-filter';
 export * from './custom-actions';
+export * from './publish-types';

package/src/types/publish-types.ts

@@ -0,0 +1,25 @@
+import { DocumentStatus } from '@stackbit/types/src/content-source-document';
+
+export type StagedChange = {
+    changeId: string;
+    isStaged?: boolean;
+    filepath?: string;
+    changeType: 'content' | 'asset' | 'schema';
+    label: string;
+    updatedBy: string[];
+    updatedAt?: string;
+    createdAt?: string;
+    createdBy?: string;
+    status: DocumentStatus;
+    srcObjectId: string;
+    srcModelName?: string;
+    srcProjectId: string;
+    srcEnvironment?: string;
+    srcType: string;
+    locale?: string;
+};
+
+export enum PublishProjectScope {
+    All = 'all',
+    Content = 'content'
+}

package/src/utils/filtered-entities.ts

@@ -187,7 +187,7 @@ export const getFilteredModelForUser = ({
         throw new Error(`Model with name ${name} not found in source`);
     }
 
-    const shouldResolvePermissions = permissionsForModel || typeof model?.permissions === 'function';
+    const shouldResolvePermissions = permissionsForModel || model?.permissions;
     if (!user || !shouldResolvePermissions) {
         return model;
     }
@@ -207,7 +207,7 @@ export const getFilteredModelForUser = ({
         }) ?? permissionsResult;
     const permissions = _.isEmpty(permissionsHookResult) ? undefined : permissionsHookResult;
 
-    const shouldHideModel = permissions?.canView === false;
+    const shouldHideModel = model.hidden || permissions?.canView === false;
     return {
         ...model,
         permissions,

package/dist/utils/custom-search-filters.d.ts

@@ -1,12 +0,0 @@
-import * as ContentStoreTypes from '../types';
-import { SearchFilterItem } from '../types';
-import { ScheduledAction } from '@stackbit/types';
-import { SchemaForSearch } from './search-utils';
-declare type CustomFilterMethod = (filter: SearchFilterItem, document: ContentStoreTypes.Document, opts: {
-    locale?: string;
-    schema: SchemaForSearch;
-    activeScheduledActionsByDocumentId: Record<string, ScheduledAction[]>;
-}) => boolean;
-export declare const CUSTOM_FILTERS: Record<string, CustomFilterMethod>;
-export {};
-//# sourceMappingURL=custom-search-filters.d.ts.map

package/dist/utils/custom-search-filters.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"custom-search-filters.d.ts","sourceRoot":"","sources":["../../src/utils/custom-search-filters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,iBAAiB,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAqB,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,EAAiE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEhH,aAAK,kBAAkB,GAAG,CACtB,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,EACpC,IAAI,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,eAAe,CAAC;IAAC,kCAAkC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,EAAE,CAAC,CAAA;CAAE,KACxH,OAAO,CAAC;AAEb,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAwC7D,CAAC"}

package/dist/utils/custom-search-filters.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CUSTOM_FILTERS = void 0;
-const search_utils_1 = require("./search-utils");
-exports.CUSTOM_FILTERS = {
-    hasSchedules: (filter, document, opts) => {
-        var _a;
-        const field = {
-            type: 'boolean',
-            value: !!((_a = opts.activeScheduledActionsByDocumentId[document.srcObjectId]) === null || _a === void 0 ? void 0 : _a.length)
-        };
-        return (0, search_utils_1.isBooleanFieldMatches)({ field, filter, locale: opts.locale });
-    },
-    scheduledActionId: (filter, document, opts) => {
-        var _a, _b;
-        const field = {
-            type: 'list',
-            items: (_b = (_a = opts.activeScheduledActionsByDocumentId[document.srcObjectId]) === null || _a === void 0 ? void 0 : _a.map((scheduledAction) => ({
-                type: 'string',
-                value: scheduledAction.id
-            }))) !== null && _b !== void 0 ? _b : []
-        };
-        const model = {
-            type: 'object',
-            name: '',
-            fields: [
-                {
-                    name: '',
-                    type: 'list',
-                    items: {
-                        type: 'string'
-                    }
-                }
-            ]
-        };
-        return (0, search_utils_1.isListFieldMatches)({ field, filter, model, locale: opts.locale, document });
-    },
-    scheduledActionDate: (filter, document, opts) => {
-        var _a, _b;
-        return ((_b = (_a = opts.activeScheduledActionsByDocumentId[document.srcObjectId]) === null || _a === void 0 ? void 0 : _a.some((scheduledAction) => {
-            const field = { type: 'date', value: scheduledAction.executeAt };
-            return (0, search_utils_1.isDateFieldMatches)({ field, filter, locale: opts.locale });
-        })) !== null && _b !== void 0 ? _b : false);
-    }
-};
-//# sourceMappingURL=custom-search-filters.js.map

package/dist/utils/custom-search-filters.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"custom-search-filters.js","sourceRoot":"","sources":["../../src/utils/custom-search-filters.ts"],"names":[],"mappings":";;;AAIA,iDAAgH;AAQnG,QAAA,cAAc,GAAuC;IAC9D,YAAY,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;;QACrC,MAAM,KAAK,GAAG;YACV,IAAI,EAAE,SAAkB;YACxB,KAAK,EAAE,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,kCAAkC,CAAC,QAAQ,CAAC,WAAW,CAAC,0CAAE,MAAM,CAAA;SACjF,CAAC;QACF,OAAO,IAAA,oCAAqB,EAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,iBAAiB,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;;QAC1C,MAAM,KAAK,GAAsB;YAC7B,IAAI,EAAE,MAAM;YACZ,KAAK,EACD,MAAA,MAAA,IAAI,CAAC,kCAAkC,CAAC,QAAQ,CAAC,WAAW,CAAC,0CAAE,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;gBACrF,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,eAAe,CAAC,EAAE;aAC5B,CAAC,CAAC,mCAAI,EAAE;SAChB,CAAC;QACF,MAAM,KAAK,GAAU;YACjB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,EAAE;YACR,MAAM,EAAE;gBACJ;oBACI,IAAI,EAAE,EAAE;oBACR,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE;wBACH,IAAI,EAAE,QAAQ;qBACjB;iBACJ;aACJ;SACJ,CAAC;QACF,OAAO,IAAA,iCAAkB,EAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IACvF,CAAC;IACD,mBAAmB,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;;QAC5C,OAAO,CACH,MAAA,MAAA,IAAI,CAAC,kCAAkC,CAAC,QAAQ,CAAC,WAAW,CAAC,0CAAE,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE;YACpF,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,MAAe,EAAE,KAAK,EAAE,eAAe,CAAC,SAAS,EAAE,CAAC;YAC1E,OAAO,IAAA,iCAAkB,EAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACtE,CAAC,CAAC,mCAAI,KAAK,CACd,CAAC;IACN,CAAC;CACJ,CAAC"}