@takeshape/schema 8.214.0 → 8.215.3

package/es/schemas/project-schema.json

@@ -90,6 +90,9 @@
     {
       "$ref": "https://schema.takeshape.io/project-schema/v3.20.0#"
     },
+    {
+      "$ref": "https://schema.takeshape.io/project-schema/v3.21.0#"
+    },
     {
       "$ref": "https://schema.takeshape.io/project-schema/v4.0.0#"
     }

package/es/validate.js

@@ -15,7 +15,7 @@ import authSchemas from './schemas/auth-schemas.json';
 import { getAllNamespaceShapes, getAllRefsInShapes } from './schema-util';
 import { builtInShapes } from './builtin-schema';
 import { isValidTemplate } from './template-shapes';
-import { isBasicResolver, isComposeResolver } from './types/utils';
+import { isBasicResolver, isComposeResolver, isExtendsSchema, isObjectSchema } from './types/utils';
 import { refItemToAtRef, refItemToShapeName, parseReturnShape, getRefShapeName } from './refs';
 import { scalars } from './scalars';
 import { isUnionSchema } from './unions';
@@ -28,6 +28,10 @@ import initial from 'lodash/initial';
 import last from 'lodash/last';
 import { getRelationship } from './relationships';
 import get from 'lodash/get';
+import gte from 'semver/functions/gte';
+import size from 'lodash/size';
+import isEqual from 'lodash/isEqual';
+import pick from 'lodash/pick';
 
 function findDuplicates(items) {
   const seen = {};
@@ -158,6 +162,10 @@ function validateWorkflowsV3(projectSchema) {
   return errors;
 }
 
+function getSemver(schemaVersion) {
+  return coerce(schemaVersion) ?? LEGACY_SCHEMA_VERSION;
+}
+
 function validateResolver(projectSchema, basePath, resolver) {
   const errors = [];
   /**
@@ -185,7 +193,7 @@ function validateResolver(projectSchema, basePath, resolver) {
     return Boolean((modelShape === null || modelShape === void 0 ? void 0 : modelShape.model) || shapeName && ((_indexedShapes = projectSchema.indexedShapes) === null || _indexedShapes === void 0 ? void 0 : _indexedShapes[shapeName]));
   };
 
-  const isLessThanV3_9_0 = lt(coerce(projectSchema.schemaVersion) ?? LEGACY_SCHEMA_VERSION, '3.9.0');
+  const isLessThanV3_9_0 = lt(getSemver(projectSchema.schemaVersion), '3.9.0');
 
   const validateBasicResolver = resolver => {
     if (isBasicResolver(resolver)) {
@@ -321,7 +329,7 @@ function validateIndexedShapeConfig(projectSchema, shapeName, config) {
 function validateIndexedShapes(projectSchema) {
   let errors = [];
 
-  if (gt(coerce(projectSchema.schemaVersion) ?? LEGACY_SCHEMA_VERSION, '3.12.0')) {
+  if (gt(getSemver(projectSchema.schemaVersion), '3.12.0')) {
     const {
       indexedShapes
     } = projectSchema;
@@ -406,7 +414,7 @@ function visitShapePropertiesJson(projectSchema, callback) {
 function validateDirectives(projectSchema, additionalShapeIds = builtInModelShapeIds) {
   const errors = [];
   const projectShapeIds = new Set([...getModelShapeIds(projectSchema.shapes), ...additionalShapeIds]);
-  const isLessThanV3_18_0 = lt(coerce(projectSchema.schemaVersion) ?? LEGACY_SCHEMA_VERSION, '3.18.0');
+  const isLessThanV3_18_0 = lt(getSemver(projectSchema.schemaVersion), '3.18.0');
   visitShapePropertiesJson(projectSchema, (property, propertyPath) => {
     if (isLessThanV3_18_0) {
       const propSchema = property;
@@ -487,6 +495,151 @@ function validateLocales(projectSchema) {
   return errors;
 }
 
+const importantFields = ['type', '@ref', 'allOf', 'oneOf', 'anyOf', 'extends', 'items', '@tag'];
+
+function isSchemaEqual(a, b) {
+  return isEqual(pick(a, importantFields), pick(b, importantFields));
+}
+
+function matchesInterface(shape, interfaceShape, path) {
+  const errors = [];
+  const {
+    schema
+  } = shape;
+  const interfaceSchema = interfaceShape.schema;
+
+  for (const name of Object.keys(interfaceSchema.properties)) {
+    const propSchema = schema.properties[name];
+    const interfacePropSchema = interfaceSchema.properties[name];
+
+    if (!propSchema) {
+      errors.push({
+        type: 'notFound',
+        path,
+        message: `"${shape.name}" is missing property "${name}" required by interface "${interfaceShape.name}"`
+      });
+    } else if (!isSchemaEqual(propSchema, interfacePropSchema)) {
+      errors.push({
+        type: 'conflict',
+        path: [...path, name],
+        message: `"${shape.name}.${name}" must match "${interfaceShape.name}.${name}"`
+      });
+    } else {
+      var _schema$required, _interfaceSchema$requ;
+
+      const propRequired = Boolean((_schema$required = schema.required) === null || _schema$required === void 0 ? void 0 : _schema$required.includes(name));
+      const interfacePropRequired = Boolean((_interfaceSchema$requ = interfaceSchema.required) === null || _interfaceSchema$requ === void 0 ? void 0 : _interfaceSchema$requ.includes(name));
+
+      if (interfacePropRequired !== propRequired) {
+        errors.push({
+          type: 'conflict',
+          path: [...path, name],
+          message: `"${shape.name}.${name}" must ${interfacePropRequired ? '' : 'not '}be required to  match "${interfaceShape.name}.${name}"`
+        });
+      }
+    }
+  }
+
+  return errors;
+}
+
+function validateShapeImplementsInterface(projectSchema, shape, interfaceShapeName, path) {
+  const errors = [];
+  const interfaceShape = projectSchema.shapes[interfaceShapeName];
+
+  if (!interfaceShape) {
+    errors.push({
+      type: 'notFound',
+      path,
+      message: `Invalid interface "${interfaceShapeName}" not found`
+    });
+  } else if (interfaceShape.type !== 'interface') {
+    errors.push({
+      type: 'conflict',
+      path,
+      message: `"${shape.name}" cannot implement non-interface "${interfaceShape.name}"`
+    });
+  } else if (isExtendsSchema(shape.schema)) {// TODO stricter extends validation needs https://app.shortcut.com/takeshape/story/9783/use-service-schemas-during-schema-validation
+  } else if (isObjectSchema(shape.schema) && isObjectSchema(interfaceShape.schema)) {
+    const matchErrors = matchesInterface(shape, interfaceShape, ['shapes', shape.name, 'schema', 'properties']);
+
+    if (matchErrors.length) {
+      errors.push(...matchErrors);
+    }
+  }
+
+  return errors;
+}
+
+function validateInterfaceImplementations(projectSchema) {
+  if (!gte(getSemver(projectSchema.schemaVersion), '3.21.0')) {
+    return [];
+  }
+
+  const errors = [];
+
+  for (const shape of Object.values(projectSchema.shapes)) {
+    var _shape$interfaces;
+
+    if ((_shape$interfaces = shape.interfaces) !== null && _shape$interfaces !== void 0 && _shape$interfaces.length) {
+      if (!isObjectSchema(shape.schema) && !isExtendsSchema(shape.schema)) {
+        return [{
+          path: ['shapes', shape.name, 'schema'],
+          type: 'conflict',
+          message: `"${shape.name}" must have an object or extends schema to implement interfaces`
+        }];
+      }
+
+      for (let i = 0; i < shape.interfaces.length; i++) {
+        const path = ['shapes', shape.name, 'interfaces', i];
+        const interfaceErrors = validateShapeImplementsInterface(projectSchema, shape, shape.interfaces[i], path);
+
+        if (interfaceErrors.length) {
+          errors.push(...interfaceErrors);
+        }
+      }
+    }
+  }
+
+  return errors;
+}
+
+function validateInterfaces(projectSchema) {
+  if (!gte(getSemver(projectSchema.schemaVersion), '3.21.0')) {
+    return [];
+  }
+
+  const errors = []; // Validate interface shapes must be an object schema with at least one property
+
+  for (const shape of Object.values(projectSchema.shapes)) {
+    if (shape.type === 'interface') {
+      if (shape.model) {
+        errors.push({
+          path: ['shapes', shape.name, 'model'],
+          type: 'conflict',
+          message: `"${shape.name}" may not be both an interface and model. Create a separate model shape which implements this interface.`
+        });
+      } else if (isObjectSchema(shape.schema)) {
+        if (size(shape.schema.properties) === 0) {
+          errors.push({
+            path: ['shapes', shape.name, 'schema', 'properties'],
+            type: 'conflict',
+            message: `Interface "${shape.name}" must define at least one property`
+          });
+        }
+      } else {
+        errors.push({
+          path: ['shapes', shape.name, 'schema'],
+          type: 'conflict',
+          message: `Interface "${shape.name}" must define an object schema`
+        });
+      }
+    }
+  }
+
+  return errors;
+}
+
 export function formatError(error) {
   let pathStr = error.instancePath;
   let message = error.message ?? '';
@@ -562,7 +715,7 @@ function validateV3X(version, obj, options) {
   const namespaceShapes = getAllNamespaceShapes(schema);
   const additionalShapeNames = (options !== null && options !== void 0 && options.additionalShapeNames ? builtInShapeNames.concat(options.additionalShapeNames) : builtInShapeNames).concat(namespaceShapes);
   const additionalModelShapeIds = options !== null && options !== void 0 && options.additionalModelShapeIds ? builtInModelShapeIds.concat(options.additionalModelShapeIds) : builtInModelShapeIds;
-  errors = errors.concat(checkShapeNames(schema.shapes)).concat(checkShapeIds(schema.shapes)).concat(validateWorkflowsV3(schema)).concat(validateQueryConfigs(schema, additionalShapeNames)).concat(validateRefs(schema, additionalShapeNames)).concat(validateDirectives(schema, additionalModelShapeIds)).concat(validateLocales(schema)).concat(checkWorkflowStepNames(schema.workflows)).concat(checkWorkflowStepKeys(schema.workflows)).concat(validateOneOfs(schema)).concat(validateIndexedShapes(schema));
+  errors = errors.concat(checkShapeNames(schema.shapes)).concat(checkShapeIds(schema.shapes)).concat(validateWorkflowsV3(schema)).concat(validateQueryConfigs(schema, additionalShapeNames)).concat(validateRefs(schema, additionalShapeNames)).concat(validateDirectives(schema, additionalModelShapeIds)).concat(validateLocales(schema)).concat(checkWorkflowStepNames(schema.workflows)).concat(checkWorkflowStepKeys(schema.workflows)).concat(validateOneOfs(schema)).concat(validateIndexedShapes(schema)).concat(validateInterfaces(schema)).concat(validateInterfaceImplementations(schema));
   const suppressErrorPaths = options === null || options === void 0 ? void 0 : options.suppressErrorPaths;
 
   if (suppressErrorPaths) {

package/examples/latest/betzino.json

@@ -52529,6 +52529,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/blog-schema.json

@@ -403,6 +403,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/brewery-schema.json

@@ -386,6 +386,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/complex-project-schema.json

@@ -4189,6 +4189,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/complex-schema.json

@@ -17,7 +17,7 @@
   "apiVersion": "1",
   "queries": {},
   "mutations": {},
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "created": "2019-06-20T12:58:43.119Z",
   "updated": "2020-04-29T10:10:28.182Z",
   "shapes": {

package/examples/latest/fabric-ecommerce.json

@@ -10509,5 +10509,5 @@
       }
     }
   },
-  "schemaVersion": "3.20.0"
+  "schemaVersion": "3.21.0"
 }

package/examples/latest/frank-and-fred-schema.json

@@ -23255,6 +23255,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/klirr-schema.json

@@ -34790,6 +34790,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/massive-schema.json

@@ -7841,6 +7841,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/mill-components-schema.json

@@ -1888,6 +1888,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/one-earth.json

@@ -14220,6 +14220,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/pet-oneof-array.json

@@ -392,6 +392,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/post-schema.json

@@ -230,6 +230,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/pruned-shopify-product-schema.json

@@ -9760,5 +9760,5 @@
       }
     }
   },
-  "schemaVersion": "3.20.0"
+  "schemaVersion": "3.21.0"
 }

package/examples/latest/real-world-schema.json

@@ -1045,6 +1045,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/recursive-repeater-schema.json

@@ -146,6 +146,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/recursive-schema.json

@@ -153,6 +153,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/rick-and-morty-ast.json

@@ -2824,5 +2824,5 @@
       }
     }
   },
-  "schemaVersion": "3.20.0"
+  "schemaVersion": "3.21.0"
 }

package/examples/latest/rick-and-morty-graphql.json

@@ -2296,5 +2296,5 @@
       }
     }
   },
-  "schemaVersion": "3.20.0"
+  "schemaVersion": "3.21.0"
 }

package/examples/latest/rick-and-morty-rest.json

@@ -95,5 +95,5 @@
       }
     }
   },
-  "schemaVersion": "3.20.0"
+  "schemaVersion": "3.21.0"
 }

package/examples/latest/schema-with-repeater-draftjs.json

@@ -401,6 +401,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/shape-books-v3_2_0.json

@@ -1128,6 +1128,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/shape-books.json

@@ -1128,6 +1128,6 @@
       }
     }
   },
-  "schemaVersion": "3.20.0",
+  "schemaVersion": "3.21.0",
   "services": {}
 }

package/examples/latest/shopify-lookbook.json

@@ -1181,5 +1181,5 @@
       }
     }
   },
-  "schemaVersion": "3.20.0"
+  "schemaVersion": "3.21.0"
 }