@takeshape/schema 9.80.3 → 9.81.0

package/dist/layers/refs.js

@@ -20,20 +20,22 @@ exports.refExpressionToShape = refExpressionToShape;
 exports.refItemToShape = refItemToShape;
 exports.refItemToString = refItemToString;
 exports.splitAtRef = splitAtRef;
-
 var _typeUtils = require("./type-utils");
-
 var _refs = require("../refs");
-
 var _assign = _interopRequireDefault(require("lodash/fp/assign"));
-
 var _omit = _interopRequireDefault(require("lodash/fp/omit"));
-
 var _util = require("@takeshape/util");
-
 var _isEmpty = _interopRequireDefault(require("lodash/isEmpty"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * This interface describes a parsed `@ref` or `$ref`.
+ * The intended usage is to convert a schema with a ref to a RefItem which can then
+ * be passed to the various rich utilities in this file.
+ */
+
+/**
+ * Adds a schema path, needed when visiting a whole schema to report errors.
+ */
 
 /**
  * Safely turn a "template" shape reference (`@args`, `args`, `shape`) into a `RefItem`
@@ -50,6 +52,7 @@ function refExpressionToRefItem(refExpression) {
   } = (0, _refs.parseTemplateShape)(refExpression);
   return atRefToRefItem(shapeName, template);
 }
+
 /**
  * Sugar for converting a `refExpression` directly into a shape, without the
  * intermediate `refItem`.
@@ -59,11 +62,10 @@ function refExpressionToRefItem(refExpression) {
  * A ref expression might include "template" name and refer to a local or remote
  * shape, `Foo` or `CreateArgs<Foo>` or `CreateArgs<remote:Foo>`.
  */
-
-
 function refExpressionToShape(shapes, refExpression) {
   return refItemToShape(shapes, refExpressionToRefItem(refExpression));
 }
+
 /**
  * Provided a service name and a referenced type. Supports 2 or 3 part
  * references, e.g., `shopify:my-store:ProductInput` or `my-store:ProductInput`.
@@ -71,27 +73,21 @@ function refExpressionToShape(shapes, refExpression) {
  * @returns
  * A 2 member array, where 0 is the service name, 1 is the referenced type.
  */
-
-
 function splitAtRef(atRef) {
   const refParts = atRef.split(':');
-
   if (refParts.length === 1) {
     return ['local', atRef];
   }
-
   if (refParts.length === 2) {
     return [refParts[0], refParts[1]];
   }
-
   throw new Error(`Invalid ref string ${atRef}`);
 }
+
 /**
  * Parses and returns a typeName, serviceKey, and potentially a namespace for
  * the type.
  */
-
-
 function atRefToRefItem(atRef, template) {
   const [serviceKey, typeName] = splitAtRef(atRef);
   return {
@@ -100,159 +96,133 @@ function atRefToRefItem(atRef, template) {
     template
   };
 }
+
 /**
  * Given a content schema and project schema, finds a `@ref` or `$ref` and
  * returns a `RefItem` suitable for loading a referenced schema...
  */
-
-
 function getRef(refSchema) {
   if (refSchema['@ref']) {
     // @ref: my-service:ShapeName
     return atRefToRefItem(refSchema['@ref']);
   }
 }
-
 function getRefWithPath(refSchema, schemaPath = []) {
   const refItem = getRef(refSchema);
-
   if (refItem) {
-    return { ...refItem,
+    return {
+      ...refItem,
       path: schemaPath.concat(['@ref'])
     };
   }
 }
+
 /**
  * Tests for a `@ref` or `$ref` property directly on the passed schema.
  *
  * @param schema Any schema that might could have a ref property.
  */
-
-
 function hasRefProperty(schema) {
   return Boolean(schema['@ref'] ?? schema.$ref);
 }
+
 /**
  * From a schema with a ref, will return the top-level ref, and potentially
  * a ref item from a nested `items` property.
  */
-
-
 function getRefOrItemsRef(refSchema, schemaPath = []) {
   const refItem = getRefWithPath(refSchema, schemaPath);
-
   if (refItem) {
     return refItem;
   }
-
   if (refSchema.items) {
     return getRefOrItemsRef(refSchema.items, schemaPath.concat(['items']));
   }
 }
+
 /**
  * Turns a `RefItem` into an `@ref`.
  */
-
-
 function refItemToString(refItem) {
   return `${refItem.layerId}:${refItem.typeName}`;
 }
+
 /**
  * Get a Shape referenced by a `RefItem`.
  */
-
-
 function refItemToShape(shapes, refItem) {
   return shapes[refItemToString(refItem)];
 }
+
 /**
  * Helper fn to omit `ref` props from the target schema, and then extend it with the source schema.
  */
-
-
 const omitRefAndExtend = (targetSchema, sourceSchema) => (0, _assign.default)((0, _omit.default)(['@ref', '$ref'], targetSchema), sourceSchema);
+
 /**
  * If there is a $ref, this will insert a content schema from the top level
  * in place of the reference.
  */
-
-
 exports.omitRefAndExtend = omitRefAndExtend;
-
 function followRef(shapes, contentSchema) {
   const refItem = getRef(contentSchema);
-
   if (refItem) {
     var _refItemToShape;
-
     const referencedSchema = (_refItemToShape = refItemToShape(shapes, refItem)) === null || _refItemToShape === void 0 ? void 0 : _refItemToShape.schema;
-
     if (referencedSchema) {
       return omitRefAndExtend(contentSchema, referencedSchema);
     }
   }
-
   return contentSchema;
 }
+
 /**
  * Returns whether a schema has refs.
  */
-
-
 function hasRef(contentSchema) {
   if ((0, _typeUtils.isRefSchema)(contentSchema)) {
     return true;
   }
-
   if ((0, _typeUtils.isAllOfSchema)(contentSchema)) {
     return Boolean(contentSchema.allOf.find(hasRef));
   }
-
   if ((0, _typeUtils.isOneOfSchema)(contentSchema)) {
     return Boolean(contentSchema.oneOf.find(hasRef));
   }
-
   return false;
 }
+
 /**
  * Returns whether a schema has refs which can be followed.
  */
-
-
 function hasResolvableRef(shapes, contentSchema) {
   if ((0, _typeUtils.isRefSchema)(contentSchema)) {
     return Boolean(refItemToShape(shapes, getRef(contentSchema)));
   }
-
   if ((0, _typeUtils.isAllOfSchema)(contentSchema)) {
     return Boolean(contentSchema.allOf.find(s => hasResolvableRef(shapes, s)));
   }
-
   if ((0, _typeUtils.isOneOfSchema)(contentSchema)) {
     return Boolean(contentSchema.oneOf.find(s => hasResolvableRef(shapes, s)));
   }
-
   return false;
 }
-
 function getArgsReferenceWithPath(argsSchema, schemaPath = []) {
   const isQuery = ('args' in argsSchema);
   const args = isQuery ? argsSchema.args : argsSchema['@args'];
   const refItem = typeof args === 'string' ? refExpressionToRefItem(args) : undefined;
-
   if (refItem) {
-    return { ...refItem,
+    return {
+      ...refItem,
       path: schemaPath.concat([isQuery ? 'args' : '@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);
-
 function dereferenceSchema(shapes, shapeOrFieldSchema, schemaPath = []) {
   const resolveAll = (resolveSchema, resolvePath) => {
     try {
@@ -260,58 +230,45 @@ function dereferenceSchema(shapes, shapeOrFieldSchema, schemaPath = []) {
         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, _typeUtils.isRefSchema)(resolveSchema)) {
         const refItem = getRefWithPath(resolveSchema);
-
         if (!refItem) {
           throw new Error('ref could not be parsed');
         }
-
         const refSchema = refItemToShape(shapes, refItem);
-
         if (refSchema) {
           return resolveAll(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 parseReturnShape(shape) {
   if (typeof shape === 'object') {
     if ((0, _typeUtils.isRefSchema)(shape.items)) {
       const ref = getRef(shape.items);
-
       if (!ref) {
         throw new Error(`Could not parse ${JSON.stringify(shape.items)}: invalid ref`);
       }
-
       return {
         isArray: true,
         ref,
         shapeName: refItemToString(ref)
       };
     }
-
     if (typeof shape.items.type !== 'string') {
       throw new Error(`Could not parse ${JSON.stringify(shape.items)}: invalid type`);
     }
-
     return {
       isArray: true,
       shapeName: shape.items.type
     };
   }
-
   const ref = refExpressionToRefItem(shape);
   const shapeName = refItemToString(ref);
   return {

package/dist/layers/type-utils.js

@@ -25,19 +25,12 @@ exports.isRefSchema = isRefSchema;
 exports.isRestResolver = isRestResolver;
 exports.isTakeshapeResolver = isTakeshapeResolver;
 exports.isUtilResolver = isUtilResolver;
-
 var _util = require("@takeshape/util");
-
 var _isPlainObject = _interopRequireDefault(require("lodash/isPlainObject"));
-
 var _isString = _interopRequireDefault(require("lodash/isString"));
-
 var _isArray = _interopRequireDefault(require("lodash/isArray"));
-
 var _schemas = require("../schemas");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /** Resolver Type Utils **/
 
 /**
@@ -46,11 +39,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 function isBasicResolver(resolver) {
   return (0, _isString.default)(resolver === null || resolver === void 0 ? void 0 : resolver.name) && (0, _isString.default)(resolver.service);
 }
-
 function isComposeResolver(resolver) {
   return Boolean((0, _isArray.default)(resolver === null || resolver === void 0 ? void 0 : resolver.compose) && resolver.compose.length && resolver.compose.every(isBasicResolver));
 }
-
 const {
   definitions: {
     takeshapeResolver,
@@ -60,139 +51,116 @@ const {
     awsLambdaResolver
   }
 } = _schemas.latestSchemaJson;
-
 function isTakeshapeResolver(resolver) {
   return takeshapeResolver.properties.name.enum.includes(resolver.name);
 }
-
 function isGraphqlResolver(resolver) {
   return graphqlResolver.properties.name.enum.includes(resolver.name);
 }
-
 function isRestResolver(resolver) {
   return restResolver.properties.name.enum.includes(resolver.name);
 }
-
 function isAwsLambdaResolver(resolver) {
   return awsLambdaResolver.properties.name.enum.includes(resolver.name);
 }
-
 function isUtilResolver(resolver) {
   return utilResolver.properties.name.enum.includes(resolver.name);
 }
+
 /** Directive Mapping Utils **/
 
 /**
  * Determine whether the ambiguous Directive structure is a DirectiveMappingMap
  */
-
-
 function isDirectiveMappingMap(maybeMap) {
   return (0, _isPlainObject.default)(maybeMap) && Object.keys(maybeMap).length > 0;
 }
+
 /**
  * Determine whether the ambiguous Directive structure is a DirectiveMappingArray
  */
-
-
 function isDirectiveMappingArray(maybeArray) {
   return (0, _isArray.default)(maybeArray) && (0, _isArray.default)(maybeArray[0]) && (0, _isString.default)(maybeArray[0][0]) && (0, _isArray.default)(maybeArray[0][1]);
 }
+
 /**
  * Determine whether the ambiguous Directive structure is a DirectiveConfig array
  */
-
-
 function isDirectiveConfig(maybeConfig) {
   return (0, _isArray.default)(maybeConfig) && (0, _isArray.default)(maybeConfig[0]) && (0, _isString.default)(maybeConfig[0][0]) && (0, _util.isRecord)(maybeConfig[0][1]);
 }
+
 /**
  * Determine whether a ParameterSerializeOption is a content type serializer
  */
-
-
 function isParameterSerializeContentOptions(maybeContent) {
   return Boolean('contentType' in maybeContent && maybeContent.contentType);
 }
+
 /**
  * Determine whether an unknown variable is a `ParameterOp`
  */
-
-
 function isParameterOp(maybeOp) {
   const op = maybeOp;
-
   if (!op.path) {
     return false;
   }
-
   return isParameterOpNested(op) || isParameterOpMapping(op) || isParameterOpValue(op) || isParameterOpOp(op);
 }
+
 /**
  * Determine whether a `ParameterOp` is a `ParameterOpNested`
  */
-
-
 function isParameterOpNested(maybeOp) {
   return Boolean('ops' in maybeOp && maybeOp.ops);
 }
+
 /**
  * Determine whether a `ParameterOp` is a `ParameterOpMapping`
  */
-
-
 function isParameterOpMapping(maybeOp) {
   return Boolean('mapping' in maybeOp && maybeOp.mapping);
 }
+
 /**
  * Determine whether a `ParameterOp` is a `ParameterOpMapping`
  */
-
-
 function isParameterOpValue(maybeOp) {
   return Boolean('value' in maybeOp && maybeOp.value);
 }
+
 /**
  * Determine whether a `ParameterOp` is a `ParameterOpOp`
  */
-
-
 function isParameterOpOp(maybeOp) {
   const op = maybeOp;
-
   if (!op.op) {
     return false;
   }
-
   return !(isParameterOpNested(op) || isParameterOpMapping(op) || isParameterOpValue(op));
 }
+
 /**
  * Determine whether a ParameterSerializeOption is a style serializer
  */
-
-
 function isParameterSerializeStyleOptions(maybeStyle) {
   return Boolean('style' in maybeStyle && maybeStyle.style);
 }
-/** Typeguards for different types of shape schemas **/
 
+/** Typeguards for different types of shape schemas **/
 
 function isRefSchema(maybeRefSchema) {
   return (0, _isString.default)(maybeRefSchema['@ref']) || (0, _isString.default)(maybeRefSchema.$ref);
 }
-
 function isAllOfSchema(schema) {
   return (0, _isArray.default)(schema.allOf);
 }
-
 function isOneOfSchema(schema) {
   return (0, _isArray.default)(schema.oneOf);
 }
-
 function isArraySchema(schema) {
   return schema.type === 'array' && (0, _util.isRecord)(schema.items);
 }
-
 function isObjectSchema(schema) {
   return schema.type === 'object' && (0, _util.isRecord)(schema.properties);
 }

package/dist/layers/visitor.js

@@ -5,15 +5,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.visitSchemaProperties = visitSchemaProperties;
 exports.visitShapeProperties = visitShapeProperties;
-
 var _typeUtils = require("./type-utils");
-
 function visitSchemaProperties(schema, path, callback) {
   if ((0, _typeUtils.isObjectSchema)(schema)) {
     for (const [name, propSchema] of Object.entries(schema.properties)) {
       const newPath = [...path, 'properties', name];
       callback(propSchema, newPath);
-
       if ((0, _typeUtils.isObjectSchema)(propSchema) || (0, _typeUtils.isAllOfSchema)(propSchema) || (0, _typeUtils.isOneOfSchema)(propSchema)) {
         visitSchemaProperties(propSchema, newPath, callback);
       }
@@ -22,7 +19,6 @@ function visitSchemaProperties(schema, path, callback) {
     for (const [index, propSchema] of Object.entries(schema.allOf)) {
       const newPath = [...path, 'allOf', index];
       callback(propSchema, newPath);
-
       if ((0, _typeUtils.isObjectSchema)(propSchema) || (0, _typeUtils.isAllOfSchema)(propSchema) || (0, _typeUtils.isOneOfSchema)(propSchema)) {
         visitSchemaProperties(propSchema, newPath, callback);
       }
@@ -31,7 +27,6 @@ function visitSchemaProperties(schema, path, callback) {
     for (const [index, propSchema] of Object.entries(schema.oneOf)) {
       const newPath = [...path, 'oneOf', index];
       callback(propSchema, newPath);
-
       if ((0, _typeUtils.isObjectSchema)(propSchema) || (0, _typeUtils.isAllOfSchema)(propSchema) || (0, _typeUtils.isOneOfSchema)(propSchema)) {
         visitSchemaProperties(propSchema, newPath, callback);
       }
@@ -40,7 +35,6 @@ function visitSchemaProperties(schema, path, callback) {
     callback(schema, path);
   }
 }
-
 function visitShapeProperties(shapes, callback) {
   for (const [shapeName, shape] of Object.entries(shapes)) {
     visitSchemaProperties(shape.schema, ['shapes', shapeName, 'schema'], callback);

package/dist/migration/index.js

@@ -8,103 +8,54 @@ var _exportNames = {
   listTypePrefix: true
 };
 exports.migrateTo = exports.listTypePrefix = void 0;
-
 var _v = _interopRequireDefault(require("./to/v3.0.0"));
-
 var _v2 = _interopRequireDefault(require("./to/v3.1.0"));
-
 var _v3 = _interopRequireDefault(require("./to/v3.2.0"));
-
 var _v4 = _interopRequireDefault(require("./to/v3.3.0"));
-
 var _v5 = _interopRequireDefault(require("./to/v3.4.0"));
-
 var _v6 = _interopRequireDefault(require("./to/v3.5.0"));
-
 var _v7 = _interopRequireDefault(require("./to/v3.5.1"));
-
 var _v8 = _interopRequireDefault(require("./to/v3.6.0"));
-
 var _v9 = _interopRequireDefault(require("./to/v3.7.0"));
-
 var _v10 = _interopRequireDefault(require("./to/v3.8.0"));
-
 var _v11 = _interopRequireDefault(require("./to/v3.9.0"));
-
 var _v12 = _interopRequireDefault(require("./to/v3.10.0"));
-
 var _v13 = _interopRequireDefault(require("./to/v3.11.0"));
-
 var _v14 = _interopRequireDefault(require("./to/v3.12.0"));
-
 var _v15 = _interopRequireDefault(require("./to/v3.12.1"));
-
 var _v16 = _interopRequireDefault(require("./to/v3.12.2"));
-
 var _v17 = _interopRequireDefault(require("./to/v3.12.3"));
-
 var _v18 = _interopRequireDefault(require("./to/v3.13.0"));
-
 var _v19 = _interopRequireDefault(require("./to/v3.14.0"));
-
 var _v20 = _interopRequireDefault(require("./to/v3.15.0"));
-
 var _v21 = _interopRequireDefault(require("./to/v3.16.0"));
-
 var _v22 = _interopRequireDefault(require("./to/v3.17.0"));
-
 var _v23 = _interopRequireDefault(require("./to/v3.17.1"));
-
 var _v24 = _interopRequireDefault(require("./to/v3.18.0"));
-
 var _v25 = _interopRequireDefault(require("./to/v3.18.1"));
-
 var _v26 = _interopRequireDefault(require("./to/v3.18.2"));
-
 var _v27 = _interopRequireDefault(require("./to/v3.19.0"));
-
 var _v28 = _interopRequireDefault(require("./to/v3.20.0"));
-
 var _v29 = _interopRequireDefault(require("./to/v3.21.0"));
-
 var _v30 = _interopRequireDefault(require("./to/v3.22.0"));
-
 var _v31 = _interopRequireDefault(require("./to/v3.23.0"));
-
 var _v32 = _interopRequireDefault(require("./to/v3.24.0"));
-
 var _v33 = _interopRequireDefault(require("./to/v3.25.0"));
-
 var _v34 = _interopRequireDefault(require("./to/v3.26.0"));
-
 var _v35 = _interopRequireDefault(require("./to/v3.27.0"));
-
 var _v36 = _interopRequireDefault(require("./to/v3.28.0"));
-
 var _v37 = _interopRequireDefault(require("./to/v3.29.0"));
-
 var _v38 = _interopRequireDefault(require("./to/v3.30.0"));
-
 var _v39 = _interopRequireDefault(require("./to/v3.31.0"));
-
 var _v40 = _interopRequireDefault(require("./to/v3.32.0"));
-
 var _v41 = _interopRequireDefault(require("./to/v3.33.0"));
-
 var _v42 = _interopRequireDefault(require("./to/v3.34.0"));
-
 var _v43 = _interopRequireDefault(require("./to/v3.35.0"));
-
 var _v44 = _interopRequireDefault(require("./to/v3.36.0"));
-
 var _v45 = _interopRequireDefault(require("./to/v3.37.0"));
-
 var _v46 = _interopRequireDefault(require("./to/v3.38.0"));
-
 var _v47 = _interopRequireDefault(require("./to/v3.39.0"));
-
 var _utils = require("./utils");
-
 Object.keys(_utils).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -116,9 +67,7 @@ Object.keys(_utils).forEach(function (key) {
     }
   });
 });
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const migrateTo = {
   'v3.0.0': _v.default,
   'v3.1.0': _v2.default,