@valbuild/core 0.43.1 → 0.45.0

package/dist/{ops-266faf09.esm.js → ops-117cb796.esm.js}

@@ -1,4 +1,4 @@
-import { e as _typeof, l as isSerializedVal, F as FILE_REF_PROP, V as VAL_EXTENSION, m as convertFileSource, d as _defineProperty, G as GetSchema, k as GetSource, E as Expr, P as Path, S as Schema, _ as _inherits, a as _createSuper, b as _classCallCheck, c as _createClass, h as _slicedToArray, q as _objectSpread2, u as _toConsumableArray, I as ImageSchema } from './index-c83918b8.esm.js';
+import { e as _typeof, k as isSerializedVal, F as FILE_REF_PROP, V as VAL_EXTENSION, l as convertFileSource, d as _defineProperty, G as GetSchema, j as GetSource, E as Expr, P as Path, S as Schema, _ as _inherits, a as _createSuper, b as _classCallCheck, c as _createClass, h as _slicedToArray, p as _objectSpread2, t as _toConsumableArray } from './index-5750c299.esm.js';
 import { _ as _createForOfIteratorHelper } from './result-b96df128.esm.js';
 
 function hasOwn(obj, prop) {
@@ -161,6 +161,8 @@ var ObjectSchema = /*#__PURE__*/function (_Schema) {
     value: function validate(path, src) {
       var _this2 = this;
       var error = false;
+
+      // TODO: src should never be undefined
       if (this.opt && (src === null || src === undefined)) {
         return false;
       }
@@ -326,6 +328,67 @@ var array = function array(schema) {
   return new ArraySchema(schema);
 };
 
+var LiteralSchema = /*#__PURE__*/function (_Schema) {
+  _inherits(LiteralSchema, _Schema);
+  var _super = _createSuper(LiteralSchema);
+  function LiteralSchema(value) {
+    var _this;
+    var opt = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    _classCallCheck(this, LiteralSchema);
+    _this = _super.call(this);
+    _this.value = value;
+    _this.opt = opt;
+    return _this;
+  }
+  _createClass(LiteralSchema, [{
+    key: "validate",
+    value: function validate(path, src) {
+      if (this.opt && (src === null || src === undefined)) {
+        return false;
+      }
+      if (typeof src !== "string") {
+        return _defineProperty({}, path, [{
+          message: "Expected 'string', got '".concat(_typeof(src), "'"),
+          value: src
+        }]);
+      }
+      if (src !== this.value) {
+        return _defineProperty({}, path, [{
+          message: "Expected literal '".concat(this.value, "', got '").concat(src, "'"),
+          value: src
+        }]);
+      }
+      return false;
+    }
+  }, {
+    key: "assert",
+    value: function assert(src) {
+      if (this.opt && (src === null || src === undefined)) {
+        return true;
+      }
+      return typeof src === "string";
+    }
+  }, {
+    key: "optional",
+    value: function optional() {
+      return new LiteralSchema(this.value, true);
+    }
+  }, {
+    key: "serialize",
+    value: function serialize() {
+      return {
+        type: "literal",
+        value: this.value,
+        opt: this.opt
+      };
+    }
+  }]);
+  return LiteralSchema;
+}(Schema);
+var literal = function literal(value) {
+  return new LiteralSchema(value);
+};
+
 var UnionSchema = /*#__PURE__*/function (_Schema) {
   _inherits(UnionSchema, _Schema);
   var _super = _createSuper(UnionSchema);
@@ -342,8 +405,143 @@ var UnionSchema = /*#__PURE__*/function (_Schema) {
   _createClass(UnionSchema, [{
     key: "validate",
     value: function validate(path, src) {
-      // TODO:
-      return false;
+      var unknownSrc = src;
+      var errors = false;
+      if (this.opt && (unknownSrc === null || unknownSrc === undefined)) {
+        // TODO: src should never be undefined
+        return false;
+      }
+      if (!this.key) {
+        return _defineProperty({}, path, [{
+          message: "Missing required first argument in union"
+        }]);
+      }
+      var key = this.key;
+      if (!Array.isArray(this.items)) {
+        return _defineProperty({}, path, [{
+          message: "A union schema must take more than 1 schema arguments",
+          fatal: true
+        }]);
+      }
+      if (typeof key === "string") {
+        // tagged union
+        if (this.items.some(function (item) {
+          return !(item instanceof ObjectSchema);
+        })) {
+          return _defineProperty({}, path, [{
+            message: "Key is a string, so all schema items must be objects",
+            fatal: true
+          }]);
+        }
+        var objectSchemas = this.items;
+        var serializedSchemas = objectSchemas.map(function (schema) {
+          return schema.serialize();
+        });
+        var illegalSchemas = serializedSchemas.filter(function (schema) {
+          return !(schema.type === "object") || !(schema.items[key].type === "literal");
+        });
+        if (illegalSchemas.length > 0) {
+          return _defineProperty({}, path, [{
+            message: "All schema items must be objects with a key: ".concat(key, " that is a literal schema. Found: ").concat(JSON.stringify(illegalSchemas, null, 2)),
+            fatal: true
+          }]);
+        }
+        var serializedObjectSchemas = serializedSchemas;
+        var optionalLiterals = serializedObjectSchemas.filter(function (schema) {
+          return schema.items[key].opt;
+        });
+        if (optionalLiterals.length > 1) {
+          return _defineProperty({}, path, [{
+            message: "Schema cannot have an optional keys: ".concat(key),
+            fatal: true
+          }]);
+        }
+        if (_typeof(unknownSrc) !== "object") {
+          return _defineProperty({}, path, [{
+            message: "Expected an object"
+          }]);
+        }
+        var objectSrc = unknownSrc;
+        if (objectSrc[key] === undefined) {
+          return _defineProperty({}, path, [{
+            message: "Missing required key: ".concat(key)
+          }]);
+        }
+        var foundSchemaLiterals = [];
+        var _iterator = _createForOfIteratorHelper(serializedObjectSchemas),
+          _step;
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var schema = _step.value;
+            var schemaKey = schema.items[key];
+            if (schemaKey.type === "literal") {
+              if (!foundSchemaLiterals.includes(schemaKey.value)) {
+                foundSchemaLiterals.push(schemaKey.value);
+              } else {
+                return _defineProperty({}, path, [{
+                  message: "Found duplicate key in schema: ".concat(schemaKey.value),
+                  fatal: true
+                }]);
+              }
+            }
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+        var objectSchemaAtKey = objectSchemas.find(function (schema) {
+          return !schema.items[key].validate(path, objectSrc[key]);
+        });
+        if (!objectSchemaAtKey) {
+          var keyPath = createValPathOfItem(path, key);
+          if (!keyPath) {
+            throw new Error("Internal error: could not create path at ".concat(!path && typeof path === "string" ? "<empty string>" : path, " at key ").concat(key));
+          }
+          return _defineProperty({}, keyPath, [{
+            message: "Invalid key: \"".concat(key, "\". Value was: \"").concat(objectSrc[key], "\". Valid values: ").concat(serializedObjectSchemas.map(function (schema) {
+              var keySchema = schema.items[key];
+              if (keySchema.type === "literal" && keySchema.value) {
+                return "\"".concat(keySchema.value, "\"");
+              } else {
+                // should not happen here, we already checked this
+                throw new Error("Expected literal schema, got ".concat(JSON.stringify(keySchema, null, 2)));
+              }
+            }).join(", "))
+          }]);
+        }
+        var error = objectSchemaAtKey.validate(path, objectSrc);
+        if (error) {
+          return error;
+        }
+      } else if (key instanceof LiteralSchema) {
+        if (this.items.some(function (item) {
+          return !(item instanceof LiteralSchema);
+        })) {
+          return _defineProperty({}, path, [{
+            message: "Key is a literal schema, so all schema items must be literals",
+            fatal: true
+          }]);
+        }
+        var literalItems = [key].concat(_toConsumableArray(this.items));
+        if (typeof unknownSrc === "string") {
+          var isMatch = literalItems.some(function (item) {
+            return !item.validate(path, unknownSrc);
+          });
+          if (!isMatch) {
+            return _defineProperty({}, path, [{
+              message: "Union must match one of the following: ".concat(literalItems.map(function (item) {
+                return "\"".concat(item.value, "\"");
+              }).join(", "))
+            }]);
+          }
+        }
+      } else {
+        return _defineProperty({}, path, [{
+          message: "Expected a string or literal"
+        }]);
+      }
+      return errors;
     }
   }, {
     key: "assert",
@@ -428,6 +626,85 @@ var richtext = function richtext(options) {
   return new RichTextSchema(options !== null && options !== void 0 ? options : {});
 };
 
+var ImageSchema = /*#__PURE__*/function (_Schema) {
+  _inherits(ImageSchema, _Schema);
+  var _super = _createSuper(ImageSchema);
+  function ImageSchema(options) {
+    var _this;
+    var opt = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    _classCallCheck(this, ImageSchema);
+    _this = _super.call(this);
+    _this.options = options;
+    _this.opt = opt;
+    return _this;
+  }
+  _createClass(ImageSchema, [{
+    key: "validate",
+    value: function validate(path, src) {
+      if (this.opt && (src === null || src === undefined)) {
+        return false;
+      }
+      if (src === null || src === undefined) {
+        return _defineProperty({}, path, [{
+          message: "Non-optional image was null or undefined.",
+          value: src
+        }]);
+      }
+      if (typeof src[FILE_REF_PROP] !== "string") {
+        return _defineProperty({}, path, [{
+          message: "Image did not have a file reference string. Got: ".concat(_typeof(src[FILE_REF_PROP])),
+          value: src
+        }]);
+      }
+      if (src[VAL_EXTENSION] !== "file") {
+        return _defineProperty({}, path, [{
+          message: "Image did not have the valid file extension type. Got: ".concat(src[VAL_EXTENSION]),
+          value: src
+        }]);
+      }
+      if (src.metadata) {
+        return _defineProperty({}, path, [{
+          message: "Found metadata, but it could not be validated. Image metadata must be an object with the required props: width (positive number), height (positive number) and sha256 (string of length 64 of the base16 hash).",
+          // These validation errors will have to be picked up by logic outside of this package and revalidated. Reasons: 1) we have to read files to verify the metadata, which is handled differently in different runtimes (Browser, QuickJS, Node.js); 2) we want to keep this package dependency free.
+          value: src,
+          fixes: ["image:replace-metadata"]
+        }]);
+      }
+      return _defineProperty({}, path, [{
+        message: "Could not validate Image metadata.",
+        value: src,
+        fixes: ["image:add-metadata"]
+      }]);
+    }
+  }, {
+    key: "assert",
+    value: function assert(src) {
+      if (this.opt && (src === null || src === undefined)) {
+        return true;
+      }
+      return (src === null || src === void 0 ? void 0 : src[FILE_REF_PROP]) === "image" && (src === null || src === void 0 ? void 0 : src[VAL_EXTENSION]) === "file";
+    }
+  }, {
+    key: "optional",
+    value: function optional() {
+      return new ImageSchema(this.options, true);
+    }
+  }, {
+    key: "serialize",
+    value: function serialize() {
+      return {
+        type: "image",
+        options: this.options,
+        opt: this.opt
+      };
+    }
+  }]);
+  return ImageSchema;
+}(Schema);
+var image = function image(options) {
+  return new ImageSchema(options);
+};
+
 var RecordSchema = /*#__PURE__*/function (_Schema) {
   _inherits(RecordSchema, _Schema);
   var _super = _createSuper(RecordSchema);
@@ -768,4 +1045,4 @@ var PatchError = /*#__PURE__*/_createClass(function PatchError(message) {
  * NOTE: MAY mutate the input document.
  */
 
-export { PatchError as P, array as a, record as b, content as c, createValPathOfItem as d, resolvePath as e, getSource as g, isSelector as i, newSelectorProxy as n, object as o, richtext as r, splitModuleIdAndModulePath as s, union as u };
+export { PatchError as P, array as a, record as b, content as c, createValPathOfItem as d, isSelector as e, resolvePath as f, getSource as g, image as i, literal as l, newSelectorProxy as n, object as o, richtext as r, splitModuleIdAndModulePath as s, union as u };

package/dist/{ops-d88e99cd.cjs.prod.js → ops-18aded72.cjs.prod.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var index = require('./index-5bdaa229.cjs.prod.js');
+var index = require('./index-7b467ee6.cjs.prod.js');
 var result = require('./result-26f67b40.cjs.prod.js');
 
 function hasOwn(obj, prop) {
@@ -163,6 +163,8 @@ var ObjectSchema = /*#__PURE__*/function (_Schema) {
     value: function validate(path, src) {
       var _this2 = this;
       var error = false;
+
+      // TODO: src should never be undefined
       if (this.opt && (src === null || src === undefined)) {
         return false;
       }
@@ -328,6 +330,67 @@ var array = function array(schema) {
   return new ArraySchema(schema);
 };
 
+var LiteralSchema = /*#__PURE__*/function (_Schema) {
+  index._inherits(LiteralSchema, _Schema);
+  var _super = index._createSuper(LiteralSchema);
+  function LiteralSchema(value) {
+    var _this;
+    var opt = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    index._classCallCheck(this, LiteralSchema);
+    _this = _super.call(this);
+    _this.value = value;
+    _this.opt = opt;
+    return _this;
+  }
+  index._createClass(LiteralSchema, [{
+    key: "validate",
+    value: function validate(path, src) {
+      if (this.opt && (src === null || src === undefined)) {
+        return false;
+      }
+      if (typeof src !== "string") {
+        return index._defineProperty({}, path, [{
+          message: "Expected 'string', got '".concat(index._typeof(src), "'"),
+          value: src
+        }]);
+      }
+      if (src !== this.value) {
+        return index._defineProperty({}, path, [{
+          message: "Expected literal '".concat(this.value, "', got '").concat(src, "'"),
+          value: src
+        }]);
+      }
+      return false;
+    }
+  }, {
+    key: "assert",
+    value: function assert(src) {
+      if (this.opt && (src === null || src === undefined)) {
+        return true;
+      }
+      return typeof src === "string";
+    }
+  }, {
+    key: "optional",
+    value: function optional() {
+      return new LiteralSchema(this.value, true);
+    }
+  }, {
+    key: "serialize",
+    value: function serialize() {
+      return {
+        type: "literal",
+        value: this.value,
+        opt: this.opt
+      };
+    }
+  }]);
+  return LiteralSchema;
+}(index.Schema);
+var literal = function literal(value) {
+  return new LiteralSchema(value);
+};
+
 var UnionSchema = /*#__PURE__*/function (_Schema) {
   index._inherits(UnionSchema, _Schema);
   var _super = index._createSuper(UnionSchema);
@@ -344,8 +407,143 @@ var UnionSchema = /*#__PURE__*/function (_Schema) {
   index._createClass(UnionSchema, [{
     key: "validate",
     value: function validate(path, src) {
-      // TODO:
-      return false;
+      var unknownSrc = src;
+      var errors = false;
+      if (this.opt && (unknownSrc === null || unknownSrc === undefined)) {
+        // TODO: src should never be undefined
+        return false;
+      }
+      if (!this.key) {
+        return index._defineProperty({}, path, [{
+          message: "Missing required first argument in union"
+        }]);
+      }
+      var key = this.key;
+      if (!Array.isArray(this.items)) {
+        return index._defineProperty({}, path, [{
+          message: "A union schema must take more than 1 schema arguments",
+          fatal: true
+        }]);
+      }
+      if (typeof key === "string") {
+        // tagged union
+        if (this.items.some(function (item) {
+          return !(item instanceof ObjectSchema);
+        })) {
+          return index._defineProperty({}, path, [{
+            message: "Key is a string, so all schema items must be objects",
+            fatal: true
+          }]);
+        }
+        var objectSchemas = this.items;
+        var serializedSchemas = objectSchemas.map(function (schema) {
+          return schema.serialize();
+        });
+        var illegalSchemas = serializedSchemas.filter(function (schema) {
+          return !(schema.type === "object") || !(schema.items[key].type === "literal");
+        });
+        if (illegalSchemas.length > 0) {
+          return index._defineProperty({}, path, [{
+            message: "All schema items must be objects with a key: ".concat(key, " that is a literal schema. Found: ").concat(JSON.stringify(illegalSchemas, null, 2)),
+            fatal: true
+          }]);
+        }
+        var serializedObjectSchemas = serializedSchemas;
+        var optionalLiterals = serializedObjectSchemas.filter(function (schema) {
+          return schema.items[key].opt;
+        });
+        if (optionalLiterals.length > 1) {
+          return index._defineProperty({}, path, [{
+            message: "Schema cannot have an optional keys: ".concat(key),
+            fatal: true
+          }]);
+        }
+        if (index._typeof(unknownSrc) !== "object") {
+          return index._defineProperty({}, path, [{
+            message: "Expected an object"
+          }]);
+        }
+        var objectSrc = unknownSrc;
+        if (objectSrc[key] === undefined) {
+          return index._defineProperty({}, path, [{
+            message: "Missing required key: ".concat(key)
+          }]);
+        }
+        var foundSchemaLiterals = [];
+        var _iterator = result._createForOfIteratorHelper(serializedObjectSchemas),
+          _step;
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var schema = _step.value;
+            var schemaKey = schema.items[key];
+            if (schemaKey.type === "literal") {
+              if (!foundSchemaLiterals.includes(schemaKey.value)) {
+                foundSchemaLiterals.push(schemaKey.value);
+              } else {
+                return index._defineProperty({}, path, [{
+                  message: "Found duplicate key in schema: ".concat(schemaKey.value),
+                  fatal: true
+                }]);
+              }
+            }
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+        var objectSchemaAtKey = objectSchemas.find(function (schema) {
+          return !schema.items[key].validate(path, objectSrc[key]);
+        });
+        if (!objectSchemaAtKey) {
+          var keyPath = createValPathOfItem(path, key);
+          if (!keyPath) {
+            throw new Error("Internal error: could not create path at ".concat(!path && typeof path === "string" ? "<empty string>" : path, " at key ").concat(key));
+          }
+          return index._defineProperty({}, keyPath, [{
+            message: "Invalid key: \"".concat(key, "\". Value was: \"").concat(objectSrc[key], "\". Valid values: ").concat(serializedObjectSchemas.map(function (schema) {
+              var keySchema = schema.items[key];
+              if (keySchema.type === "literal" && keySchema.value) {
+                return "\"".concat(keySchema.value, "\"");
+              } else {
+                // should not happen here, we already checked this
+                throw new Error("Expected literal schema, got ".concat(JSON.stringify(keySchema, null, 2)));
+              }
+            }).join(", "))
+          }]);
+        }
+        var error = objectSchemaAtKey.validate(path, objectSrc);
+        if (error) {
+          return error;
+        }
+      } else if (key instanceof LiteralSchema) {
+        if (this.items.some(function (item) {
+          return !(item instanceof LiteralSchema);
+        })) {
+          return index._defineProperty({}, path, [{
+            message: "Key is a literal schema, so all schema items must be literals",
+            fatal: true
+          }]);
+        }
+        var literalItems = [key].concat(index._toConsumableArray(this.items));
+        if (typeof unknownSrc === "string") {
+          var isMatch = literalItems.some(function (item) {
+            return !item.validate(path, unknownSrc);
+          });
+          if (!isMatch) {
+            return index._defineProperty({}, path, [{
+              message: "Union must match one of the following: ".concat(literalItems.map(function (item) {
+                return "\"".concat(item.value, "\"");
+              }).join(", "))
+            }]);
+          }
+        }
+      } else {
+        return index._defineProperty({}, path, [{
+          message: "Expected a string or literal"
+        }]);
+      }
+      return errors;
     }
   }, {
     key: "assert",
@@ -430,6 +628,85 @@ var richtext = function richtext(options) {
   return new RichTextSchema(options !== null && options !== void 0 ? options : {});
 };
 
+var ImageSchema = /*#__PURE__*/function (_Schema) {
+  index._inherits(ImageSchema, _Schema);
+  var _super = index._createSuper(ImageSchema);
+  function ImageSchema(options) {
+    var _this;
+    var opt = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    index._classCallCheck(this, ImageSchema);
+    _this = _super.call(this);
+    _this.options = options;
+    _this.opt = opt;
+    return _this;
+  }
+  index._createClass(ImageSchema, [{
+    key: "validate",
+    value: function validate(path, src) {
+      if (this.opt && (src === null || src === undefined)) {
+        return false;
+      }
+      if (src === null || src === undefined) {
+        return index._defineProperty({}, path, [{
+          message: "Non-optional image was null or undefined.",
+          value: src
+        }]);
+      }
+      if (typeof src[index.FILE_REF_PROP] !== "string") {
+        return index._defineProperty({}, path, [{
+          message: "Image did not have a file reference string. Got: ".concat(index._typeof(src[index.FILE_REF_PROP])),
+          value: src
+        }]);
+      }
+      if (src[index.VAL_EXTENSION] !== "file") {
+        return index._defineProperty({}, path, [{
+          message: "Image did not have the valid file extension type. Got: ".concat(src[index.VAL_EXTENSION]),
+          value: src
+        }]);
+      }
+      if (src.metadata) {
+        return index._defineProperty({}, path, [{
+          message: "Found metadata, but it could not be validated. Image metadata must be an object with the required props: width (positive number), height (positive number) and sha256 (string of length 64 of the base16 hash).",
+          // These validation errors will have to be picked up by logic outside of this package and revalidated. Reasons: 1) we have to read files to verify the metadata, which is handled differently in different runtimes (Browser, QuickJS, Node.js); 2) we want to keep this package dependency free.
+          value: src,
+          fixes: ["image:replace-metadata"]
+        }]);
+      }
+      return index._defineProperty({}, path, [{
+        message: "Could not validate Image metadata.",
+        value: src,
+        fixes: ["image:add-metadata"]
+      }]);
+    }
+  }, {
+    key: "assert",
+    value: function assert(src) {
+      if (this.opt && (src === null || src === undefined)) {
+        return true;
+      }
+      return (src === null || src === void 0 ? void 0 : src[index.FILE_REF_PROP]) === "image" && (src === null || src === void 0 ? void 0 : src[index.VAL_EXTENSION]) === "file";
+    }
+  }, {
+    key: "optional",
+    value: function optional() {
+      return new ImageSchema(this.options, true);
+    }
+  }, {
+    key: "serialize",
+    value: function serialize() {
+      return {
+        type: "image",
+        options: this.options,
+        opt: this.opt
+      };
+    }
+  }]);
+  return ImageSchema;
+}(index.Schema);
+var image = function image(options) {
+  return new ImageSchema(options);
+};
+
 var RecordSchema = /*#__PURE__*/function (_Schema) {
   index._inherits(RecordSchema, _Schema);
   var _super = index._createSuper(RecordSchema);
@@ -570,7 +847,7 @@ function isRichTextSchema(schema) {
   return schema instanceof RichTextSchema || index._typeof(schema) === "object" && "type" in schema && schema.type === "richtext";
 }
 function isImageSchema(schema) {
-  return schema instanceof index.ImageSchema || index._typeof(schema) === "object" && "type" in schema && schema.type === "image";
+  return schema instanceof ImageSchema || index._typeof(schema) === "object" && "type" in schema && schema.type === "image";
 }
 
 // function isOneOfSchema(
@@ -775,7 +1052,9 @@ exports.array = array;
 exports.content = content;
 exports.createValPathOfItem = createValPathOfItem;
 exports.getSource = getSource;
+exports.image = image;
 exports.isSelector = isSelector;
+exports.literal = literal;
 exports.newSelectorProxy = newSelectorProxy;
 exports.object = object;
 exports.record = record;