@takeshape/schema 8.66.2 → 8.68.4

package/lib/schema-util.js

@@ -10,8 +10,6 @@ exports.arraySchemaKeys = void 0;
 exports.collectReferencedShapeNames = collectReferencedShapeNames;
 exports.createSchemaPropertyList = exports.createSchemaPropertyAccessor = exports.commonSchemaKeys = void 0;
 exports.createShape = createShape;
-exports.dereferenceObjectSchema = dereferenceObjectSchema;
-exports.dereferenceSchema = dereferenceSchema;
 exports.emptySchema = emptySchema;
 exports.ensureQuery = exports.ensureMutation = void 0;
 exports.filterGraphQLServiceMap = filterGraphQLServiceMap;
@@ -51,8 +49,6 @@ exports.isBuiltinShape = isBuiltinShape;
 exports.isBuiltinType = isBuiltinType;
 exports.isIndexedRemoteShape = void 0;
 exports.isModelShape = isModelShape;
-exports.mergeFormProperties = mergeFormProperties;
-exports.mergeSchemaProperties = mergeSchemaProperties;
 exports.objectSchemaKeys = exports.nonStructuralSchemaKeys = exports.multipleRelationshipSchemaKeys = void 0;
 exports.parseMapping = parseMapping;
 exports.parseQueryResolver = parseQueryResolver;
@@ -72,20 +68,12 @@ var _mapValues = _interopRequireDefault(require("lodash/mapValues"));
 
 var _omitBy = _interopRequireDefault(require("lodash/omitBy"));
 
-var _omit = _interopRequireDefault(require("lodash/fp/omit"));
-
-var _assign = _interopRequireDefault(require("lodash/fp/assign"));
-
 var _pickBy = _interopRequireDefault(require("lodash/pickBy"));
 
 var _get = _interopRequireDefault(require("lodash/get"));
 
-var _union = _interopRequireDefault(require("lodash/union"));
-
 var _keyBy = _interopRequireDefault(require("lodash/keyBy"));
 
-var _isEmpty = _interopRequireDefault(require("lodash/isEmpty"));
-
 var _isObject = _interopRequireDefault(require("lodash/isObject"));
 
 var _curry = _interopRequireDefault(require("lodash/fp/curry"));
@@ -114,6 +102,8 @@ var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 
 var _unions = require("./unions");
 
+var _merge = require("./util/merge");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const SERVICE_OBJECT_PATTERN_NAME = 'pattern:service-object';
@@ -423,7 +413,7 @@ exports.getBuiltInPropertyNames = getBuiltInPropertyNames;
 function applyBuiltinPropertiesToShape(projectSchema, shape) {
   return { ...shape,
     schema: { ...shape.schema,
-      properties: { ...(0, _omitBy.default)(dereferenceObjectSchema(projectSchema, shape.schema).properties, (_, name) => name.startsWith('_')),
+      properties: { ...(0, _omitBy.default)((0, _refs.dereferenceObjectSchema)(projectSchema, shape.schema).properties, (_, name) => name.startsWith('_')),
         ...getBuiltInProperties(projectSchema.apiVersion),
         ...((0, _apiVersion.workflowsEnabled)(projectSchema.apiVersion) && {
           _status: (0, _workflows.getStatusField)(projectSchema.workflows, shape)
@@ -431,36 +421,6 @@ function applyBuiltinPropertiesToShape(projectSchema, shape) {
       }
     }
   };
-}
-
-function mergeSchemaProperties(base, overrides) {
-  const result = { ...base,
-    properties: { ...base.properties,
-      ...overrides.properties
-    }
-  };
-  const required = (0, _union.default)(base.required, overrides.required);
-
-  if (required.length) {
-    result.required = required;
-  }
-
-  return result;
-}
-
-function mergeFormProperties(base, overrides) {
-  const result = { ...base,
-    properties: { ...base.properties,
-      ...overrides.properties
-    }
-  };
-  const order = (0, _union.default)(base.order, overrides.order);
-
-  if (order.length) {
-    result.order = order;
-  }
-
-  return result;
 } // Dependencies of these built-in shapes are automatically added by getBuiltinsUsed
 
 
@@ -506,7 +466,7 @@ function applyDefaultsToSchema(projectSchema) {
 
       if (builtInShape && builtInShape !== shape) {
         shape = { ...shape,
-          schema: mergeSchemaProperties(dereferenceObjectSchema(projectSchema, shape.schema), dereferenceObjectSchema(projectSchema, builtInShape.schema))
+          schema: (0, _merge.mergeSchemaProperties)((0, _refs.dereferenceObjectSchema)(projectSchema, shape.schema), (0, _refs.dereferenceObjectSchema)(projectSchema, builtInShape.schema))
         };
       }
 
@@ -519,7 +479,7 @@ function applyDefaultsToSchema(projectSchema) {
 
       if (builtInFormsConfig && builtInFormsConfig !== formsConfig) {
         formsConfig = { ...formsConfig,
-          default: mergeFormProperties(formsConfig.default, builtInFormsConfig.default)
+          default: (0, _merge.mergeFormProperties)(formsConfig.default, builtInFormsConfig.default)
         };
       }
 
@@ -681,12 +641,6 @@ function getArgsShapeSchema(context, argsSchema) {
     return args;
   }
 }
-/**
- * Helper fn to omit `allOf` props from the target schema, and then extend it with the source schema.
- */
-
-
-const omitAllOfAndExtend = (targetSchema, sourceSchema) => (0, _assign.default)((0, _omit.default)(['allOf'], targetSchema), sourceSchema);
 
 const createShapeToPropertySchema = (projectSchema, definitions, definitionNames, useShapeIdDiscriminator = true) => {
   const rewriteRefs = (shape, addDiscriminator = false) => {
@@ -740,7 +694,7 @@ const createShapeToPropertySchema = (projectSchema, definitions, definitionNames
       return shapeSchema;
     }
 
-    const shapeSchemaCopy = dereferenceObjectSchema(projectSchema, shapeSchema);
+    const shapeSchemaCopy = (0, _refs.dereferenceObjectSchema)(projectSchema, shapeSchema);
 
     if (useShapeIdDiscriminator) {
       if (addDiscriminator && shapeSchemaCopy.properties) {
@@ -802,7 +756,7 @@ function getShapeDependencies(projectSchema, shape, predicate) {
 
         if (refShape && !shapeNames.has(refShape.name)) {
           shapeNames.add(refShape.name);
-          findDependencies(dereferenceSchema(projectSchema, refShape.schema));
+          findDependencies((0, _refs.dereferenceSchema)(projectSchema, refShape.schema));
         }
       } else if ((0, _utils.isObjectSchema)(schema) || (0, _utils.isAllOfSchema)(schema) || (0, _utils.isOneOfSchema)(schema)) {
         visitSchemaProperties(schema, [], findDependencies);
@@ -844,34 +798,26 @@ function getRelevantShapes(projectSchema, params) {
   return {};
 }
 
-function visitSchemaProperties(schema, path, callback) {
-  if ((0, _utils.isObjectSchema)(schema)) {
-    for (const [name, propSchema] of Object.entries(schema.properties)) {
-      const newPath = [...path, 'properties', name];
-      callback(propSchema, newPath);
+function visitSchemaPropertiesHelper(entries, path, callback) {
+  for (const [name, propSchema] of entries) {
+    const newPath = [...path, name];
+    callback(propSchema, newPath);
 
-      if ((0, _utils.isObjectSchema)(propSchema) || (0, _utils.isAllOfSchema)(propSchema) || (0, _utils.isOneOfSchema)(propSchema)) {
-        visitSchemaProperties(propSchema, newPath, callback);
-      }
+    if ((0, _utils.isObjectSchema)(propSchema) || (0, _utils.isExtendsSchema)(propSchema) || (0, _utils.isAllOfSchema)(propSchema) || (0, _utils.isOneOfSchema)(propSchema)) {
+      visitSchemaProperties(propSchema, newPath, callback);
     }
-  } else if ((0, _utils.isAllOfSchema)(schema)) {
-    for (const [index, propSchema] of Object.entries(schema.allOf)) {
-      const newPath = [...path, 'allOf', index];
-      callback(propSchema, newPath);
+  }
+}
 
-      if ((0, _utils.isObjectSchema)(propSchema) || (0, _utils.isAllOfSchema)(propSchema) || (0, _utils.isOneOfSchema)(propSchema)) {
-        visitSchemaProperties(propSchema, newPath, callback);
-      }
-    }
+function visitSchemaProperties(schema, path, callback) {
+  if ((0, _utils.isObjectSchema)(schema)) {
+    visitSchemaPropertiesHelper(Object.entries(schema.properties), [...path, 'properties'], callback);
+  } else if ((0, _utils.isExtendsSchema)(schema)) {
+    visitSchemaPropertiesHelper(Object.entries(schema.extends), [...path, 'extends'], callback);
+  } else if ((0, _utils.isAllOfSchema)(schema)) {
+    visitSchemaPropertiesHelper(Object.entries(schema.allOf), [...path, 'allOf'], callback);
   } else if ((0, _utils.isOneOfSchema)(schema)) {
-    for (const [index, propSchema] of Object.entries(schema.oneOf)) {
-      const newPath = [...path, 'oneOf', index];
-      callback(propSchema, newPath);
-
-      if ((0, _utils.isObjectSchema)(propSchema) || (0, _utils.isAllOfSchema)(propSchema) || (0, _utils.isOneOfSchema)(propSchema)) {
-        visitSchemaProperties(propSchema, newPath, callback);
-      }
-    }
+    visitSchemaPropertiesHelper(Object.entries(schema.oneOf), [...path, 'oneOf'], callback);
   } else {
     callback(schema, path);
   }
@@ -937,7 +883,7 @@ function getAllRefsInQuery(projectSchema, queryPath, query, predicate) {
   }
 
   if (query.args && typeof query.args === 'object') {
-    visitSchemaProperties(dereferenceObjectSchema(projectSchema, query.args), queryPath, propertyVisitor);
+    visitSchemaProperties((0, _refs.dereferenceObjectSchema)(projectSchema, query.args), queryPath, propertyVisitor);
   }
 
   if (query.shape) {
@@ -1164,66 +1110,15 @@ function getProtectedSchema(schema) {
     })
   };
 }
-/**
- * Given a schema, will resolve any `allOf` or `ref` objects. This function has
- * to fully resolve all refs, because attempting to extend an object schema with
- * a ref property would create an invalid schema, potentially containing both
- * a ref and properties.
- *
- * If it can't create a valid schema it returns the input.
- */
-
-
-function dereferenceSchema(context, shapeOrFieldSchema, schemaPath = []) {
-  const resolveAll = (resolveSchema, resolvePath) => {
-    try {
-      if ((0, _utils.isAllOfSchema)(resolveSchema)) {
-        const allOfSchema = resolveSchema.allOf.map((stub, index) => resolveAll(stub, [...resolvePath, 'allOf', index])).reduce((prev, curr) => (0, _util.mergeWithArrayConcat)(prev, curr), {});
-        return (0, _isEmpty.default)(allOfSchema) ? undefined : omitAllOfAndExtend(resolveSchema, allOfSchema);
-      }
-
-      if ((0, _utils.isRefSchema)(resolveSchema)) {
-        const refItem = (0, _refs.getRefWithPath)(context, resolveSchema);
-
-        if (!refItem) {
-          throw new Error('ref could not be parsed');
-        }
-
-        const refSchema = (0, _refs.refItemToShapeSchema)(context, refItem);
-
-        if (refSchema) {
-          return resolveAll((0, _refs.omitRefAndExtend)(resolveSchema, refSchema), refItem.path);
-        }
-
-        return;
-      }
-
-      return resolveSchema;
-    } catch (err) {
-      throw new Error(`error at '${resolvePath.join('.')}', ${err.message}`);
-    }
-  };
-
-  return resolveAll(shapeOrFieldSchema, schemaPath) ?? shapeOrFieldSchema;
-}
-
-function dereferenceObjectSchema(context, shapeOrFieldSchema, schemaPath = []) {
-  const schema = dereferenceSchema(context, shapeOrFieldSchema, schemaPath);
-
-  if (!(0, _utils.isObjectSchema)(schema)) {
-    throw new Error(`provided schema at '${schemaPath.join('.')}' could not be resolved to an object schema`);
-  }
-
-  return schema;
-}
 /**
  * Creates a schema property list chainable fn, allowing you to manipulate and
  * iterate the properties in a schema.
  */
 
 
-const createSchemaPropertyList = (0, _curry.default)((context, shapeOrFieldSchema) => {
-  const schema = dereferenceSchema(context, shapeOrFieldSchema);
+const createSchemaPropertyList = (0, _curry.default)((context, shapeOrSchema) => {
+  const propSchema = isShape(shapeOrSchema) ? shapeOrSchema.schema : shapeOrSchema;
+  const schema = (0, _refs.dereferenceSchema)(context, propSchema, isShape(shapeOrSchema) ? ['shapes', shapeOrSchema.name] : undefined);
   const propertyIterator = new Map((0, _utils.isObjectSchema)(schema) ? Object.entries(schema.properties) : undefined);
   const defaultOrderByIteratees = [n => n[0]];
   const defaultOrderByOrders = ['asc'];
@@ -1293,14 +1188,20 @@ const createSchemaPropertyList = (0, _curry.default)((context, shapeOrFieldSchem
   };
   return self;
 });
+exports.createSchemaPropertyList = createSchemaPropertyList;
+
+function isShape(shapeOrSchema) {
+  return 'schema' in shapeOrSchema;
+}
 /**
  * Creates a schema property accessor, allowing you to safely access schema
  * properties.
  */
 
-exports.createSchemaPropertyList = createSchemaPropertyList;
-const createSchemaPropertyAccessor = (0, _curry.default)((context, shapeOrFieldSchema) => {
-  const schema = dereferenceSchema(context, shapeOrFieldSchema);
+
+const createSchemaPropertyAccessor = (0, _curry.default)((context, shapeOrSchema) => {
+  const propSchema = isShape(shapeOrSchema) ? shapeOrSchema.schema : shapeOrSchema;
+  const schema = (0, _refs.dereferenceSchema)(context, propSchema, isShape(shapeOrSchema) ? ['shapes', shapeOrSchema.name] : undefined);
   const propertyIterator = new Map((0, _utils.isObjectSchema)(schema) ? Object.entries(schema.properties) : undefined);
 
   const _getValue = propertyName => {