@stackbit/sdk 2.0.8-staging.1 → 2.0.8-staging.2

package/src/config/config-loader.ts

@@ -4,6 +4,7 @@ import chokidar from 'chokidar';
 import semver from 'semver';
 import _ from 'lodash';
 
+import * as StackbitTypes from '@stackbit/types';
 import {
     ModelsSource,
     Field,
@@ -697,7 +698,9 @@ export function mergeConfigModelsWithExternalModels({
                         break;
                 }
 
-                return Object.assign({}, externalFieldProps, fieldSpecificProps, { type: fieldType });
+                const validations = mergeFieldValidations(externalFieldProps, stackbitFieldProps);
+
+                return Object.assign({}, externalFieldProps, fieldSpecificProps, { type: fieldType }, validations ? { validations } : undefined);
             });
 
             const mergedField = Object.assign(
@@ -718,6 +721,14 @@ export function mergeConfigModelsWithExternalModels({
                 ])
             );
 
+            // Merge list field specific properties that weren't merged in mapListItemsPropsOrSelfSpecificProps
+            if (externalField.type === 'list') {
+                const validations = mergeFieldValidations(externalField, stackbitField);
+                if (validations) {
+                    mergedField.validations = validations;
+                }
+            }
+
             const externalActions = 'actions' in externalField && Array.isArray(externalField.actions) ? externalField.actions : [];
             const configActions = 'actions' in stackbitField && Array.isArray(stackbitField.actions) ? stackbitField.actions : [];
             if (externalActions.length || configActions.length) {
@@ -733,6 +744,35 @@ export function mergeConfigModelsWithExternalModels({
     return Object.values(mergedModelsByName);
 }
 
+function mergeFieldValidations<T extends StackbitTypes.FieldSpecificProps>(
+    externalFieldProps: T,
+    stackbitFieldProps: FieldExtension | DistributePartialListItems<FieldListItems>
+): T['validations'] {
+    const externalFieldValidations = externalFieldProps.validations;
+    const configFieldValidation = stackbitFieldProps.validations;
+    if (externalFieldValidations && configFieldValidation) {
+        const extendedValidations: StackbitTypes.FieldValidationsCustom = {};
+        // concatenate custom validation functions
+        if (
+            'validate' in externalFieldValidations &&
+            externalFieldValidations.validate &&
+            'validate' in configFieldValidation &&
+            configFieldValidation.validate
+        ) {
+            const externalFileTypes = Array.isArray(externalFieldValidations.validate)
+                ? externalFieldValidations.validate
+                : [externalFieldValidations.validate];
+            const stackbitFileTypes = Array.isArray(configFieldValidation.validate) ? configFieldValidation.validate : [configFieldValidation.validate];
+            extendedValidations.validate = [...externalFileTypes, ...stackbitFileTypes];
+        }
+        return Object.assign({}, externalFieldValidations, configFieldValidation, extendedValidations);
+    } else if (configFieldValidation) {
+        return configFieldValidation;
+    } else {
+        return externalFieldValidations;
+    }
+}
+
 function normalizeConfig(rawConfig: StackbitConfigWithPaths): Config {
     const stackbitVersion = String(_.get(rawConfig, 'stackbitVersion', LATEST_STACKBIT_VERSION));
     const ver = semver.coerce(stackbitVersion);

package/src/config/config-schema.ts

@@ -34,6 +34,8 @@ function getModelsFromValidationState(state: Joi.State): Model[] {
     return config.models ?? [];
 }
 
+const arrayOfStrings = Joi.array().items(Joi.string());
+
 const fieldNamePattern = /^[a-zA-Z0-9_$]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$/;
 const fieldNameError =
     'Invalid field name "{{#value}}" at "{{#label}}". A field name must contain only alphanumeric characters, ' +
@@ -265,7 +267,7 @@ const importSchema = Joi.alternatives().conditional('.type', {
 
 const presetSourceFilesSchema = Joi.object<PresetSourceFiles>({
     type: Joi.string().valid(Joi.override, 'files').required(),
-    presetDirs: Joi.array().items(Joi.string()).required()
+    presetDirs: arrayOfStrings.required()
 });
 
 const presetSourceSchema = Joi.object<PresetSource>({
@@ -276,7 +278,7 @@ const presetSourceSchema = Joi.object<PresetSource>({
 
 const modelsSourceFilesSchema = Joi.object<ModelsSourceFiles>({
     type: Joi.string().valid(Joi.override, 'files').required(),
-    modelDirs: Joi.array().items(Joi.string()).required()
+    modelDirs: arrayOfStrings.required()
 });
 
 const modelsSourceContentfulSchema = Joi.object<ModelsSourceContentful>({
@@ -400,6 +402,67 @@ const customActionFieldSchema = customActionBaseSchema.concat(
     })
 );
 
+const stringOrNumber = Joi.alternatives().try(Joi.string(), Joi.number());
+
+const fieldValidationSchema = Joi.object({
+    unique: Joi.boolean(),
+    validate: Joi.alternatives().try(Joi.function(), Joi.array().items(Joi.function())),
+
+    // string and text
+    regexp: Joi.string(),
+    regexpNot: Joi.string(),
+    regexpPattern: Joi.string(),
+
+    // ranges
+    min: stringOrNumber,
+    max: stringOrNumber,
+    after: Joi.string(),
+    before: Joi.string(),
+    exact: Joi.number(),
+    step: Joi.number(),
+    lessThan: Joi.number(),
+    greaterThan: Joi.number(),
+
+    // file
+    fileMinSize: Joi.number(),
+    fileMaxSize: Joi.number(),
+    fileTypes: arrayOfStrings,
+    fileTypeGroups: arrayOfStrings,
+
+    // image
+    minWidth: Joi.number(),
+    maxWidth: Joi.number(),
+    minHeight: Joi.number(),
+    maxHeight: Joi.number(),
+    minWidthToHeightRatio: stringOrNumber,
+    maxWidthToHeightRatio: stringOrNumber,
+
+    errors: Joi.object({
+        unique: Joi.string(),
+        regexp: Joi.string(),
+        regexpNot: Joi.string(),
+        regexpPattern: Joi.string(),
+        min: Joi.string(),
+        max: Joi.string(),
+        after: Joi.string(),
+        before: Joi.string(),
+        exact: Joi.string(),
+        step: Joi.string(),
+        lessThan: Joi.string(),
+        greaterThan: Joi.string(),
+        fileMinSize: Joi.string(),
+        fileMaxSize: Joi.string(),
+        fileTypes: Joi.string(),
+        fileTypeGroups: Joi.string(),
+        minWidth: Joi.string(),
+        maxWidth: Joi.string(),
+        minHeight: Joi.string(),
+        maxHeight: Joi.string(),
+        minWidthToHeightRatio: Joi.string(),
+        maxWidthToHeightRatio: Joi.string()
+    })
+});
+
 const customControlTypesSchema = Joi.string().valid('custom-modal-html', 'custom-inline-html', 'custom-modal-script', 'custom-inline-script');
 const fieldCommonPropsSchema = Joi.object({
     type: Joi.string()
@@ -409,6 +472,7 @@ const fieldCommonPropsSchema = Joi.object({
     label: Joi.string(),
     description: Joi.string().allow(''),
     required: Joi.boolean(),
+    validations: fieldValidationSchema,
     default: Joi.any(),
     group: inGroups,
     const: Joi.any(),
@@ -474,7 +538,7 @@ const enumFieldPartialSchema = Joi.object({
                     is: 'palette-colors',
                     then: Joi.array().items(
                         enumFieldBaseOptionSchema.append({
-                            colors: Joi.array().items(Joi.string()).required()
+                            colors: arrayOfStrings.required()
                         })
                     )
                 }
@@ -589,8 +653,8 @@ const contentModelSchema = Joi.object<ContentModel>({
     singleInstance: Joi.boolean(),
     file: Joi.string(),
     folder: Joi.string(),
-    match: Joi.array().items(Joi.string()).single(),
-    exclude: Joi.array().items(Joi.string()).single()
+    match: arrayOfStrings.single(),
+    exclude: arrayOfStrings.single()
 })
     .without('file', ['folder', 'match', 'exclude'])
     .when('.isPage', {
@@ -667,7 +731,7 @@ const baseModelSchema = {
     readOnly: Joi.boolean(),
     labelField: labelFieldSchema,
     variantField: variantFieldSchema,
-    groups: Joi.array().items(Joi.string()),
+    groups: arrayOfStrings,
     context: Joi.any(),
     preview: Joi.alternatives().try(objectPreviewSchema, Joi.function()),
     fieldGroups: fieldGroupsSchema,
@@ -695,8 +759,8 @@ const dataModelSchema: Joi.ObjectSchema<DataModel & { srcType: string; srcProjec
     singleInstance: Joi.boolean(),
     file: Joi.string(),
     folder: Joi.string(),
-    match: Joi.array().items(Joi.string()).single(),
-    exclude: Joi.array().items(Joi.string()).single(),
+    match: arrayOfStrings.single(),
+    exclude: arrayOfStrings.single(),
     isList: Joi.boolean()
 })
     .when('.isList', {
@@ -733,8 +797,8 @@ const pageModelSchema: Joi.ObjectSchema<PageModel & { srcType: string; srcProjec
     singleInstance: Joi.boolean(),
     file: Joi.string(),
     folder: Joi.string(),
-    match: Joi.array().items(Joi.string()).single(),
-    exclude: Joi.array().items(Joi.string()).single(),
+    match: arrayOfStrings.single(),
+    exclude: arrayOfStrings.single(),
     hideContent: Joi.boolean()
 })
     .when('.file', {
@@ -983,9 +1047,9 @@ export const stackbitConfigBaseSchema = Joi.object<StackbitConfigWithPaths>({
     dataDir: Joi.string().allow('', null),
     pageLayoutKey: Joi.string().allow(null),
     objectTypeKey: Joi.string(),
-    excludePages: Joi.array().items(Joi.string()).single(),
+    excludePages: arrayOfStrings.single(),
     styleObjectModelName: Joi.string(),
-    logicFields: Joi.array().items(Joi.string()),
+    logicFields: arrayOfStrings,
     contentModels: Joi.any(), // contentModels should have been already validated by now
     presetSource: presetSourceSchema,
     modelsSource: modelsSourceSchema,
@@ -995,11 +1059,11 @@ export const stackbitConfigBaseSchema = Joi.object<StackbitConfigWithPaths>({
     models: Joi.any(),
     modelExtensions: Joi.array().items(Joi.any()),
     presetReferenceBehavior: Joi.string().valid('copyReference', 'duplicateContents'),
-    nonDuplicatableModels: Joi.array().items(Joi.string()).when('presetReferenceBehavior', {
+    nonDuplicatableModels: arrayOfStrings.when('presetReferenceBehavior', {
         is: 'copyReference',
         then: Joi.forbidden()
     }),
-    duplicatableModels: Joi.array().items(Joi.string()).when('presetReferenceBehavior', {
+    duplicatableModels: arrayOfStrings.when('presetReferenceBehavior', {
         is: 'duplicateContents',
         then: Joi.forbidden()
     }),