@stackbit/cms-core 1.0.18-develop.1 → 1.0.18-feature-clac.0

package/src/utils/filtered-entities.ts

@@ -3,40 +3,33 @@ import _ from 'lodash';
 import { ContentStoreTypes } from '../';
 import { STACKBIT_PRESET_MODEL_NAME } from '../consts';
 import { getContentSourceDataByIdOrThrow, getContentSourceId } from '../content-store-utils';
-import { mapCSIAssetsToStoreAssets, mapCSIDocumentsToStoreDocuments } from './csi-to-store-docs-converter';
+import { mapCSIAssetsToStoreAssets } from './csi-to-store-docs-converter';
 import { getAllModelsFromCSIDocument } from './document-utils';
+import { DocumentPermissions } from '@stackbit/types';
 
 export const getFilteredDocumentsForUser = ({
     user,
     documents,
-    filterModel,
-    filterDocument,
+    permissionsForModel,
+    permissionsForDocument,
     contentSourceDataById,
-    assetSources,
     createConfigDelegate,
-    customActionRunStateMap,
     logger
 }: {
     user?: ContentStoreTypes.User;
-    filterModel: CSITypes.StackbitConfig['filterModel'];
-    filterDocument: CSITypes.StackbitConfig['filterDocument'];
+    permissionsForModel: CSITypes.StackbitConfig['permissionsForModel'];
+    permissionsForDocument: CSITypes.StackbitConfig['permissionsForDocument'];
     documents: ContentStoreTypes.Document[];
     contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
-    assetSources: CSITypes.AssetSource[];
     createConfigDelegate: () => CSITypes.ConfigDelegate;
-    customActionRunStateMap: ContentStoreTypes.CustomActionRunStateMap;
     logger: CSITypes.Logger;
 }): ContentStoreTypes.Document[] => {
-    if (!user || (!filterDocument && !filterModel)) {
+    if (!user) {
         return documents;
     }
 
     const documentsBySourceId = _.groupBy(documents, (object) => getContentSourceId(object.srcType, object.srcProjectId));
-
-    const transformedCsiDocuments: CSITypes.DocumentWithSource[] = [];
-
     const resultDocuments: ContentStoreTypes.Document[] = [];
-
     const configDelegate = createConfigDelegate();
 
     for (const [contentSourceId, contentSourceDocuments] of Object.entries(documentsBySourceId)) {
@@ -56,7 +49,7 @@ export const getFilteredDocumentsForUser = ({
                         name: modelName,
                         contentSourceData,
                         configDelegate,
-                        filterModel
+                        permissionsForModel
                     });
                     filteredModelsMap[modelName] = filteredModel;
                 }
@@ -67,55 +60,25 @@ export const getFilteredDocumentsForUser = ({
                     `Can't find model with name '${document.srcModelName}' for object with id '${document.srcObjectId}' in content source '${contentSourceId}'`
                 );
             }
-            if (documentModel.hidden) {
-                // model is hidden - return csiDocument right away as hidden
-                resultDocuments.push({
-                    ...document,
-                    hidden: true
-                });
-                return;
-            }
-
-            if (!filterDocument) {
-                // no filter function is defined, but the model is not hidden - just add this document as is
-                resultDocuments.push(document);
-                return;
-            }
-
-            const csiDocWithSource: CSITypes.DocumentWithSource = {
-                ..._.cloneDeep(csiDoc),
-                srcType: contentSourceData.srcType,
-                srcProjectId: contentSourceData.srcProjectId
-            };
-            const shouldIncludeDoc = filterDocument({
-                ...configDelegate,
-                document: csiDocWithSource,
-                userContext: user
+            const docPermissions = csiDoc.permissions ?? (documentModel.permissions as DocumentPermissions | undefined);
+            const permissions =
+                permissionsForDocument?.({
+                    ...configDelegate,
+                    document: {
+                        ...csiDoc,
+                        permissions: docPermissions,
+                        srcType: contentSourceData.srcType,
+                        srcProjectId: contentSourceData.srcProjectId
+                    },
+                    userContext: user
+                }) ?? docPermissions;
+            resultDocuments.push({
+                ...document,
+                permissions,
+                hidden: documentModel.hidden || document.hidden || permissions?.canView === false
             });
-            if (typeof shouldIncludeDoc === 'undefined') {
-                transformedCsiDocuments.push(csiDocWithSource);
-            } else {
-                transformedCsiDocuments.push({
-                    ...csiDocWithSource,
-                    hidden: !shouldIncludeDoc
-                });
-            }
+            return;
         });
-
-        if (transformedCsiDocuments.length) {
-            const csResultDocuments = mapCSIDocumentsToStoreDocuments({
-                csiDocuments: transformedCsiDocuments,
-                contentSourceInstance: contentSourceData.instance,
-                modelMap: filteredModelsMap,
-                defaultLocaleCode: contentSourceData.defaultLocaleCode,
-                assetSources,
-                customActionRunStateMap,
-                createConfigDelegate,
-                logger
-            });
-
-            resultDocuments.push(...(csResultDocuments ?? []));
-        }
     }
 
     return resultDocuments;
@@ -191,12 +154,12 @@ export const getContentSourceFilteredModelsForUser = ({
     user,
     configDelegate,
     contentSourceData,
-    filterModel
+    permissionsForModel
 }: {
     user?: ContentStoreTypes.User;
     configDelegate: CSITypes.ConfigDelegate;
     contentSourceData: ContentStoreTypes.ContentSourceData;
-    filterModel: CSITypes.StackbitConfig['filterModel'];
+    permissionsForModel: CSITypes.StackbitConfig['permissionsForModel'];
 }): CSITypes.Model[] => {
     const filteredModels = contentSourceData.models.map((model) => {
         return getFilteredModelForUser({
@@ -204,7 +167,7 @@ export const getContentSourceFilteredModelsForUser = ({
             configDelegate,
             name: model.name,
             contentSourceData,
-            filterModel
+            permissionsForModel
         });
     });
     const cleanModels = filteredModels.filter((model) => model.name !== STACKBIT_PRESET_MODEL_NAME);
@@ -216,19 +179,21 @@ export const getFilteredModelForUser = ({
     name,
     configDelegate,
     contentSourceData,
-    filterModel
+    permissionsForModel
 }: {
     user?: ContentStoreTypes.User;
     name: string;
     configDelegate: CSITypes.ConfigDelegate;
     contentSourceData: ContentStoreTypes.ContentSourceData;
-    filterModel: CSITypes.StackbitConfig['filterModel'];
+    permissionsForModel: CSITypes.StackbitConfig['permissionsForModel'];
 }): CSITypes.Model => {
     const model = contentSourceData.modelMap[name];
     if (!model) {
         throw new Error(`Model with name ${name} not found in source`);
     }
-    if (!user || !filterModel) {
+
+    const shouldResolvePermissions = permissionsForModel || typeof model?.permissions === 'function';
+    if (!user || !shouldResolvePermissions) {
         return model;
     }
     const modelWithSource = {
@@ -236,12 +201,21 @@ export const getFilteredModelForUser = ({
         srcType: contentSourceData.srcType,
         srcProjectId: contentSourceData.srcProjectId
     };
-    const shouldIncludeModel = filterModel({ ...configDelegate, model: modelWithSource, userContext: user });
-    if (typeof shouldIncludeModel === 'undefined') {
-        return model;
-    }
+
+    const permissionsResult =
+        typeof model.permissions === 'function' ? model.permissions?.({ ...configDelegate, model: modelWithSource, userContext: user }) : model.permissions;
+    const permissionsHookResult =
+        permissionsForModel?.({
+            ...configDelegate,
+            model: { ...modelWithSource, permissions: permissionsResult },
+            userContext: user
+        }) ?? permissionsResult;
+    const permissions = _.isEmpty(permissionsHookResult) ? undefined : permissionsHookResult;
+
+    const shouldHideModel = permissions?.canView === false;
     return {
         ...model,
-        hidden: !shouldIncludeModel
+        permissions,
+        hidden: shouldHideModel
     };
 };

package/dist/connector/model-converter.d.mts

@@ -1,3 +0,0 @@
-import * as CSITypes from '@stackbit/types';
-export declare function convertModels(models: Map<string, any>): (CSITypes.ObjectModel<unknown> | CSITypes.DataModel<unknown>)[];
-//# sourceMappingURL=model-converter.d.mts.map

package/dist/connector/model-converter.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"model-converter.d.mts","sourceRoot":"","sources":["../../src/connector/model-converter.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAE5C,wBAAgB,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,mEAYrD"}

package/dist/connector/model-converter.mjs

@@ -1,138 +0,0 @@
-export function convertModels(models) {
-    const createModels = [];
-    models.forEach((model) => {
-        if (model.getTypeName() === `Image`) {
-            return;
-        }
-        const createModel = convertModel(model, models);
-        if (createModel) {
-            createModels.push(createModel);
-        }
-    });
-    return createModels;
-}
-function convertModel(model, models) {
-    let fieldGroups = model.fieldGroups;
-    if (model.devOnlyFieldGroup) {
-        fieldGroups || (fieldGroups = []);
-        fieldGroups.push(model.devOnlyFieldGroup);
-    }
-    // Create doesn't have named union types
-    if (model.isUnionType) {
-        return false;
-    }
-    const name = model.originalName || model.typeName;
-    const csiModel = {
-        name: name,
-        label: model.label || model.name,
-        type: model.isObjectType ? `object` : `data`,
-        fieldGroups,
-        fields: sdkFieldsToStackbitFields(model.fields, models)
-    };
-    return csiModel;
-}
-function sdkFieldsToStackbitFields(fields, models) {
-    return fields.map((field) => {
-        const definedTypename = field.type;
-        const fieldModel = models.get(definedTypename);
-        const typename = fieldModel?.originalName || definedTypename;
-        const isObject = fieldModel?.isObjectType;
-        const scalarTypename = isObject
-            ? `object`
-            : {
-                // create only has a number field
-                float: 'number',
-                int: 'number'
-            }[typename.toLowerCase()] ||
-                // all other scalar types are supported as lowercase typenames
-                typename.toLowerCase();
-        const isImage = typename === `Image`;
-        const isReference = !isImage && fieldModel?.isNodeType;
-        const isUnion = fieldModel?.isUnionType;
-        const firstUnionType = isUnion && fieldModel?.compositeTypes && models.get(fieldModel.compositeTypes[0]);
-        const isObjectUnion = firstUnionType && firstUnionType.isObjectType;
-        const isReferenceUnion = firstUnionType && firstUnionType.isNodeType;
-        const type = (() => {
-            if ( /*isObject || */isObjectUnion) {
-                return `model`;
-            }
-            if (isReference || isReferenceUnion) {
-                return `reference`;
-            }
-            if (isUnion) {
-                // throw new ModelError(`Unhandled union type for model ${typename}. This is a bug in the Netlify SDK.`);
-            }
-            if (isImage) {
-                return `image`;
-            }
-            return scalarTypename;
-        })();
-        const stackbitField = {
-            type,
-            name: field.name
-        };
-        if (typename.toLowerCase() === `float`) {
-            stackbitField.subtype = `float`;
-        }
-        //TODO
-        if (isObject) {
-            stackbitField.fields = fieldModel.sdkFieldsToStackbitFields();
-        }
-        // if (isObject) {
-        //     (stackbitField as CSITypes.FieldModelProps).models = [typename];
-        // }
-        // if (isObjectUnion) {
-        //     (stackbitField as CSITypes.FieldModelProps).models = fieldModel.compositeTypes.map((ct: any) => {
-        //         const fullType = models.get(ct);
-        //         return fullType!.getOriginalName();
-        //     });
-        // }
-        // any field names starting with _ are internal mandatory fields.
-        // they shouldn't be set as required in the Create UI as content admins
-        // don't need to set these fields, connector authors do.
-        if (`required` in field && !field.name.startsWith(`_`)) {
-            stackbitField.required = field.required;
-        }
-        if (`label` in field) {
-            stackbitField.label = field.label;
-        }
-        if (`hidden` in field) {
-            stackbitField.hidden = field.hidden;
-        }
-        if (`readOnly` in field) {
-            stackbitField.readOnly = field.readOnly;
-        }
-        if (`localized` in field) {
-            stackbitField.localized = field.localized;
-        }
-        if (`defaultValue` in field) {
-            stackbitField.default = field.defaultValue;
-        }
-        if (`group` in field) {
-            stackbitField.group = field.group;
-        }
-        if (isUnion) {
-            stackbitField.models = (fieldModel.compositeTypes || []).map((ct) => {
-                const fullType = models.get(ct);
-                return fullType.getOriginalName();
-            });
-        }
-        else if (isReference) {
-            stackbitField.models = [fieldModel.getOriginalName()];
-        }
-        if (field.list) {
-            const { name, required, hidden, ...items } = stackbitField;
-            return {
-                name,
-                required,
-                hidden,
-                type: `list`,
-                items
-            };
-        }
-        else {
-            return stackbitField;
-        }
-    });
-}
-//# sourceMappingURL=model-converter.mjs.map

package/dist/connector/model-converter.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"model-converter.mjs","sourceRoot":"","sources":["../../src/connector/model-converter.mts"],"names":[],"mappings":"AAEA,MAAM,UAAU,aAAa,CAAC,MAAwB;IAClD,MAAM,YAAY,GAAkD,EAAE,CAAC;IACvE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,EAAE;QAC1B,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE;YACjC,OAAO;SACV;QACD,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAChD,IAAI,WAAW,EAAE;YACb,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAClC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,YAAY,CAAC;AACxB,CAAC;AAED,SAAS,YAAY,CAAC,KAAU,EAAE,MAAW;IACzC,IAAI,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IAEpC,IAAI,KAAK,CAAC,iBAAiB,EAAE;QACzB,WAAW,KAAX,WAAW,GAAK,EAAE,EAAC;QACnB,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;KAC7C;IAED,wCAAwC;IACxC,IAAI,KAAK,CAAC,WAAW,EAAE;QACnB,OAAO,KAAK,CAAC;KAChB;IACD,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,QAAQ,CAAC;IAClD,MAAM,QAAQ,GAAG;QACb,IAAI,EAAE,IAAI;QACV,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI;QAChC,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAE,QAAkB,CAAC,CAAC,CAAE,MAAgB;QAClE,WAAW;QACX,MAAM,EAAE,yBAAyB,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC;KAC1D,CAAC;IAEF,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED,SAAS,yBAAyB,CAAC,MAAa,EAAE,MAAW;IACzD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAuC,EAAE;QAC7D,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC;QACnC,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,UAAU,EAAE,YAAY,IAAI,eAAe,CAAC;QAE7D,MAAM,QAAQ,GAAG,UAAU,EAAE,YAAY,CAAC;QAE1C,MAAM,cAAc,GAAG,QAAQ;YAC3B,CAAC,CAAC,QAAQ;YACV,CAAC,CAAE;gBACG,iCAAiC;gBACjC,KAAK,EAAE,QAAQ;gBACf,GAAG,EAAE,QAAQ;aACuC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;gBAChF,8DAA8D;gBAC7D,QAAQ,CAAC,WAAW,EAA6B,CAAC;QAEzD,MAAM,OAAO,GAAG,QAAQ,KAAK,OAAO,CAAC;QACrC,MAAM,WAAW,GAAG,CAAC,OAAO,IAAI,UAAU,EAAE,UAAU,CAAC;QACvD,MAAM,OAAO,GAAG,UAAU,EAAE,WAAW,CAAC;QACxC,MAAM,cAAc,GAAG,OAAO,IAAI,UAAU,EAAE,cAAc,IAAI,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAEzG,MAAM,aAAa,GAAG,cAAc,IAAI,cAAc,CAAC,YAAY,CAAC;QACpE,MAAM,gBAAgB,GAAG,cAAc,IAAI,cAAc,CAAC,UAAU,CAAC;QAErE,MAAM,IAAI,GAAuB,CAAC,GAAG,EAAE;YACnC,KAAI,gBAAgB,aAAa,EAAE;gBAC/B,OAAO,OAAO,CAAC;aAClB;YACD,IAAI,WAAW,IAAI,gBAAgB,EAAE;gBACjC,OAAO,WAAW,CAAC;aACtB;YACD,IAAI,OAAO,EAAE;gBACT,yGAAyG;aAC5G;YAED,IAAI,OAAO,EAAE;gBACT,OAAO,OAAO,CAAC;aAClB;YACD,OAAO,cAAc,CAAC;QAC1B,CAAC,CAAC,EAAE,CAAC;QAEL,MAAM,aAAa,GAA4B;YAC3C,IAAI;YACJ,IAAI,EAAE,KAAK,CAAC,IAAI;SACnB,CAAC;QAEF,IAAI,QAAQ,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE;YACnC,aAA2C,CAAC,OAAO,GAAG,OAAO,CAAC;SAClE;QAED,MAAM;QACN,IAAI,QAAQ,EAAE;YACT,aAAsC,CAAC,MAAM,GAAG,UAAU,CAAC,yBAAyB,EAAE,CAAC;SAC3F;QAED,kBAAkB;QAClB,uEAAuE;QACvE,IAAI;QAEJ,uBAAuB;QACvB,wGAAwG;QACxG,2CAA2C;QAC3C,8CAA8C;QAC9C,UAAU;QACV,IAAI;QAEJ,iEAAiE;QACjE,uEAAuE;QACvE,wDAAwD;QACxD,IAAI,UAAU,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACpD,aAAa,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;SAC3C;QAED,IAAI,OAAO,IAAI,KAAK,EAAE;YAClB,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;SACrC;QAED,IAAI,QAAQ,IAAI,KAAK,EAAE;YACnB,aAAa,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;SACvC;QAED,IAAI,UAAU,IAAI,KAAK,EAAE;YACrB,aAAa,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;SAC3C;QAED,IAAI,WAAW,IAAI,KAAK,EAAE;YACtB,aAAa,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;SAC7C;QAED,IAAI,cAAc,IAAI,KAAK,EAAE;YACzB,aAAa,CAAC,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC;SAC9C;QAED,IAAI,OAAO,IAAI,KAAK,EAAE;YAClB,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;SACrC;QAED,IAAI,OAAO,EAAE;YACR,aAA8C,CAAC,MAAM,GAAG,CAAC,UAAU,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAO,EAAE,EAAE;gBACvG,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAChC,OAAO,QAAS,CAAC,eAAe,EAAE,CAAC;YACvC,CAAC,CAAC,CAAC;SACN;aAAM,IAAI,WAAW,EAAE;YACnB,aAA8C,CAAC,MAAM,GAAG,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC;SAC3F;QAED,IAAI,KAAK,CAAC,IAAI,EAAE;YACZ,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,aAAa,CAAC;YAC3D,OAAO;gBACH,IAAI;gBACJ,QAAQ;gBACR,MAAM;gBACN,IAAI,EAAE,MAAM;gBACZ,KAAK;aACc,CAAC;SAC3B;aAAM;YACH,OAAO,aAA+B,CAAC;SAC1C;IACL,CAAC,CAAC,CAAC;AACP,CAAC"}