@stackbit/sdk 0.3.15 → 0.3.16-alpha.0

package/src/config/config-schema.ts

@@ -16,7 +16,8 @@ import {
     Field,
     FieldObjectProps,
     FieldGroupItem,
-    FieldSpecificProps
+    FieldSpecificProps,
+    FieldCrossReferenceModel
 } from '@stackbit/types';
 
 import { CMS_NAMES, FIELD_TYPES, SSG_NAMES } from './config-consts';
@@ -75,6 +76,21 @@ const validReferenceModelNames = Joi.custom((value, { error, state }) => {
     errors: { wrap: { label: false } }
 });
 
+const validCrossReferenceModelNames = Joi.object<FieldCrossReferenceModel>({
+    modelName: Joi.string().required(),
+    srcType: Joi.string(),
+    srcProjectId: Joi.string()
+}).custom((allowedModels, { error, state }) => {
+    // TODO: implement custom validation logic that checks unambiguous model matching
+    //  similar to how config models are matched to content-source models in content-store.ts
+    return allowedModels;
+}).prefs({
+    messages: {
+        [documentModelNameErrorCode]: '{{#label}} must reference the name of an existing model of type "page" or "data", got "{{#value}}"'
+    },
+    errors: { wrap: { label: false } }
+});
+
 const groupNotFoundErrorCode = 'group.not.found';
 const groupNotObjectModelErrorCode = 'group.not.object.model';
 const validModelFieldGroups = Joi.string()
@@ -152,7 +168,7 @@ const labelFieldSchema = Joi.custom((value, { error, state }) => {
     if (!field) {
         return error(labelFieldNotFoundError);
     }
-    if (['object', 'model', 'reference', 'list'].includes(field.type)) {
+    if (['object', 'model', 'reference', 'cross-reference', 'list'].includes(field.type)) {
         return error(labelFieldNotSimple, { fieldType: field.type });
     }
     return value;
@@ -429,6 +445,11 @@ const referenceFieldPartialSchema = Joi.object({
     groups: Joi.array().items(validReferenceFieldGroups)
 });
 
+const crossReferenceFieldPartialSchema = Joi.object({
+    type: Joi.string().valid('cross-reference').required(),
+    models: Joi.array().items(validCrossReferenceModelNames).required()
+});
+
 const listItemsSchema = Joi.object({
     // 'style' and 'list' are not allowed inside lists
     type: Joi.string()
@@ -441,7 +462,8 @@ const listItemsSchema = Joi.object({
         { is: 'image', then: imageFieldPartialSchema },
         { is: 'object', then: objectFieldPartialSchema },
         { is: 'model', then: modelFieldPartialSchema },
-        { is: 'reference', then: referenceFieldPartialSchema }
+        { is: 'reference', then: referenceFieldPartialSchema },
+        { is: 'cross-reference', then: crossReferenceFieldPartialSchema },
     ]
 });
 
@@ -467,6 +489,7 @@ const fieldSchema: Joi.ObjectSchema<Field> = fieldCommonPropsSchema.when('.type'
         { is: 'object', then: objectFieldPartialSchema },
         { is: 'model', then: modelFieldPartialSchema },
         { is: 'reference', then: referenceFieldPartialSchema },
+        { is: 'cross-reference', then: crossReferenceFieldPartialSchema },
         { is: 'style', then: styleFieldPartialSchema },
         { is: 'list', then: listFieldPartialSchema }
     ]

package/src/config/config-types.ts

@@ -54,6 +54,7 @@ export {
     FieldGroupItem,
     FieldModelProps,
     FieldReferenceProps,
+    FieldCrossReferenceProps,
     StyleProps,
     FieldStyleProps,
     FieldListProps,

package/src/content/content-schema.ts

@@ -21,6 +21,7 @@ import {
     Model,
     StyleProps
 } from '../config/config-types';
+import { FieldCrossReferenceProps } from '@stackbit/types';
 
 type FieldPath = (string | number)[];
 
@@ -147,6 +148,9 @@ function joiSchemaForField(field: Field | FieldListItems, config: Config, fieldP
         case 'reference':
             fieldSchema = referenceFieldValueSchema(field);
             break;
+        case 'cross-reference':
+            fieldSchema = crossReferenceFieldValueSchema(field);
+            break;
         case 'style':
             fieldSchema = styleFieldValueSchema(field);
             break;
@@ -250,6 +254,17 @@ function referenceFieldValueSchema(field: FieldReferenceProps): Joi.Schema {
     return Joi.string();
 }
 
+function crossReferenceFieldValueSchema(field: FieldCrossReferenceProps): Joi.Schema {
+    return Joi.alternatives().try(
+        Joi.string(),
+        Joi.object({
+            srcType: Joi.string(),
+            srcProjectId: Joi.string(),
+            srcDocumentId: Joi.string()
+        })
+    );
+}
+
 function listFieldValueSchema(field: FieldListProps, config: Config, fieldPath: FieldPath): Joi.Schema {
     if (field.items) {
         const childFieldPath = fieldPath.concat('items');

package/src/utils/model-utils.ts

@@ -14,19 +14,16 @@ import {
     YamlDataModelList,
     Field,
     FieldSpecificProps,
-    FieldEnum,
     FieldEnumProps,
     FieldList,
     FieldListItems,
     FieldListModel,
     FieldListObject,
     FieldListReference,
-    FieldModel,
     FieldModelProps,
-    FieldObject,
     FieldObjectProps,
-    FieldReference,
     FieldReferenceProps,
+    FieldCrossReferenceProps,
     DataModelList,
     FieldListProps
 } from '../config/config-types';
@@ -78,6 +75,10 @@ export function isReferenceField(field: FieldSpecificProps): field is FieldRefer
     return field.type === 'reference';
 }
 
+export function isCrossReferenceField(field: FieldSpecificProps): field is FieldCrossReferenceProps {
+    return field.type === 'cross-reference';
+}
+
 export function isCustomModelField(field: FieldSpecificProps, modelsByName: Record<string, Model>) {
     // custom model field types are deprecated
     return !FIELD_TYPES.includes(field.type) && _.has(modelsByName, field.type);