effect 3.11.8 → 3.11.10

package/dist/cjs/SchemaAST.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isComposeTransformation = exports.isBooleanKeyword = exports.isBigIntKeyword = exports.isAnyKeyword = exports.hasStableFilter = exports.getTransformationFrom = exports.getTitleAnnotation = exports.getTemplateLiteralRegExp = exports.getTemplateLiteralCapturingRegExp = exports.getSurrogateAnnotation = exports.getPropertySignatures = exports.getPropertyKeyIndexedAccess = exports.getParseOptionsAnnotation = exports.getParseIssueTitleAnnotation = exports.getParameterBase = exports.getNumberIndexedAccess = exports.getMissingMessageAnnotation = exports.getMessageAnnotation = exports.getJSONSchemaAnnotation = exports.getJSONIdentifierAnnotation = exports.getJSONIdentifier = exports.getIdentifierAnnotation = exports.getExamplesAnnotation = exports.getDocumentationAnnotation = exports.getDescriptionAnnotation = exports.getDefaultAnnotation = exports.getDecodingFallbackAnnotation = exports.getConcurrencyAnnotation = exports.getCompiler = exports.getBrandAnnotation = exports.getBatchingAnnotation = exports.getAutoTitleAnnotation = exports.getAnnotation = exports.flatten = exports.equals = exports.encodedBoundAST = exports.encodedAST = exports.defaultParseOption = exports.composeTransformation = exports.compose = exports.booleanKeyword = exports.blackListAnnotations = exports.bigIntKeyword = exports.anyKeyword = exports.annotations = exports.VoidKeyword = exports.UnknownKeyword = exports.UniqueSymbol = exports.Union = exports.UndefinedKeyword = exports.TypeLiteralTransformation = exports.TypeLiteral = exports.Type = exports.TupleType = exports.Transformation = exports.TitleAnnotationId = exports.TemplateLiteralSpan = exports.TemplateLiteral = exports.SymbolKeyword = exports.Suspend = exports.SurrogateAnnotationId = exports.StringKeyword = exports.StableFilterAnnotationId = exports.SchemaIdAnnotationId = exports.Refinement = exports.PropertySignatureTransformation = exports.PropertySignature = exports.PrettyAnnotationId = exports.ParseOptionsAnnotationId = exports.ParseJsonSchemaId = exports.ParseIssueTitleAnnotationId = exports.OptionalType = exports.ObjectKeyword = exports.NumberKeyword = exports.NeverKeyword = exports.MissingMessageAnnotationId = exports.MessageAnnotationId = exports.Literal = exports.JSONSchemaAnnotationId = exports.JSONIdentifierAnnotationId = exports.IndexSignature = exports.IdentifierAnnotationId = exports.FinalTransformation = exports.ExamplesAnnotationId = exports.EquivalenceAnnotationId = exports.Enums = exports.DocumentationAnnotationId = exports.DescriptionAnnotationId = exports.DefaultAnnotationId = exports.DecodingFallbackAnnotationId = exports.Declaration = exports.ConcurrencyAnnotationId = exports.ComposeTransformation = exports.BrandAnnotationId = exports.BooleanKeyword = exports.BigIntKeyword = exports.BatchingAnnotationId = exports.AutoTitleAnnotationId = exports.ArbitraryAnnotationId = exports.AnyKeyword = void 0;
-exports.whiteListAnnotations = exports.voidKeyword = exports.unknownKeyword = exports.unify = exports.undefinedKeyword = exports.typeAST = exports.symbolKeyword = exports.stringKeyword = exports.required = exports.rename = exports.record = exports.pick = exports.partial = exports.orUndefined = exports.omit = exports.objectKeyword = exports.numberKeyword = exports.null = exports.neverKeyword = exports.mutable = exports.mapMembers = exports.keyof = exports.isVoidKeyword = exports.isUnknownKeyword = exports.isUniqueSymbol = exports.isUnion = exports.isUndefinedKeyword = exports.isTypeLiteralTransformation = exports.isTypeLiteral = exports.isTupleType = exports.isTransformation = exports.isTemplateLiteral = exports.isSymbolKeyword = exports.isSuspend = exports.isStringKeyword = exports.isRefinement = exports.isParameter = exports.isObjectKeyword = exports.isNumberKeyword = exports.isNeverKeyword = exports.isMembers = exports.isLiteral = exports.isFinalTransformation = exports.isEnums = exports.isDeclaration = void 0;
+exports.whiteListAnnotations = exports.voidKeyword = exports.unknownKeyword = exports.unify = exports.undefinedKeyword = exports.typeAST = exports.symbolKeyword = exports.stringKeyword = exports.required = exports.rename = exports.record = exports.pruneUndefined = exports.pick = exports.partial = exports.orUndefined = exports.omit = exports.objectKeyword = exports.numberKeyword = exports.null = exports.neverKeyword = exports.mutable = exports.mapMembers = exports.keyof = exports.isVoidKeyword = exports.isUnknownKeyword = exports.isUniqueSymbol = exports.isUnion = exports.isUndefinedKeyword = exports.isTypeLiteralTransformation = exports.isTypeLiteral = exports.isTupleType = exports.isTransformation = exports.isTemplateLiteral = exports.isSymbolKeyword = exports.isSuspend = exports.isStringKeyword = exports.isRefinement = exports.isParameter = exports.isObjectKeyword = exports.isNumberKeyword = exports.isNeverKeyword = exports.isMembers = exports.isLiteral = exports.isFinalTransformation = exports.isEnums = exports.isDeclaration = void 0;
 var Arr = _interopRequireWildcard(require("./Array.js"));
 var _Function = require("./Function.js");
 var _GlobalValue = require("./GlobalValue.js");
@@ -871,6 +871,7 @@ const isTemplateLiteralSpanType = ast => {
     case "Literal":
     case "NumberKeyword":
     case "StringKeyword":
+    case "TemplateLiteral":
       return true;
     case "Union":
       return ast.types.every(isTemplateLiteralSpanType);
@@ -885,6 +886,8 @@ const templateLiteralSpanUnionTypeToString = type => {
       return "string";
     case "NumberKeyword":
       return "number";
+    case "TemplateLiteral":
+      return String(type);
     case "Union":
       return type.types.map(templateLiteralSpanUnionTypeToString).join(" | ");
   }
@@ -897,6 +900,8 @@ const templateLiteralSpanTypeToString = type => {
       return "${string}";
     case "NumberKeyword":
       return "${number}";
+    case "TemplateLiteral":
+      return "${" + String(type) + "}";
     case "Union":
       return "${" + type.types.map(templateLiteralSpanUnionTypeToString).join(" | ") + "}";
   }
@@ -1533,7 +1538,10 @@ class Refinement {
    * @since 3.10.0
    */
   toString() {
-    return Option.getOrElse(getExpected(this), () => `{ ${this.from} | filter }`);
+    return getIdentifierAnnotation(this).pipe(Option.getOrElse(() => Option.match(getOrElseExpected(this), {
+      onNone: () => `{ ${this.from} | filter }`,
+      onSome: expected => isRefinement(this.from) ? String(this.from) + " & " + expected : expected
+    })));
   }
   /**
    * @since 3.10.0
@@ -1738,66 +1746,63 @@ const keyof = ast => Union.unify(_keyof(ast));
 exports.keyof = keyof;
 const STRING_KEYWORD_PATTERN = ".*";
 const NUMBER_KEYWORD_PATTERN = "[+-]?\\d*\\.?\\d+(?:[Ee][+-]?\\d+)?";
-const getTemplateLiteralPattern = type => {
+const getTemplateLiteralSpanTypePattern = (type, capture) => {
   switch (type._tag) {
+    case "Literal":
+      return regexp.escape(String(type.literal));
     case "StringKeyword":
       return STRING_KEYWORD_PATTERN;
     case "NumberKeyword":
       return NUMBER_KEYWORD_PATTERN;
-    case "Literal":
-      return regexp.escape(String(type.literal));
+    case "TemplateLiteral":
+      return getTemplateLiteralPattern(type, capture, false);
     case "Union":
-      return type.types.map(getTemplateLiteralPattern).join("|");
+      return type.types.map(type => getTemplateLiteralSpanTypePattern(type, capture)).join("|");
   }
 };
-/**
- * @since 3.10.0
- */
-const getTemplateLiteralRegExp = ast => {
-  let pattern = `^`;
-  if (ast.head !== "") {
-    pattern += regexp.escape(ast.head);
-  }
-  for (const span of ast.spans) {
-    const p = getTemplateLiteralPattern(span.type);
-    pattern += isUnion(span.type) ? `(${p})` : p;
-    if (span.literal !== "") {
-      pattern += regexp.escape(span.literal);
+const handleTemplateLiteralSpanTypeParens = (type, s, capture, top) => {
+  if (isUnion(type)) {
+    if (capture && !top) {
+      return `(?:${s})`;
     }
+  } else if (!capture || !top) {
+    return s;
   }
-  pattern += "$";
-  return new RegExp(pattern);
-};
-exports.getTemplateLiteralRegExp = getTemplateLiteralRegExp;
-const getTemplateLiteralCapturingPattern = type => {
-  switch (type._tag) {
-    case "StringKeyword":
-      return STRING_KEYWORD_PATTERN;
-    case "NumberKeyword":
-      return NUMBER_KEYWORD_PATTERN;
-    case "Literal":
-      return regexp.escape(String(type.literal));
-    case "Union":
-      return type.types.map(getTemplateLiteralCapturingPattern).join("|");
-  }
+  return `(${s})`;
 };
-/**
- * @since 3.10.0
- */
-const getTemplateLiteralCapturingRegExp = ast => {
-  let pattern = `^`;
+const getTemplateLiteralPattern = (ast, capture, top) => {
+  let pattern = ``;
   if (ast.head !== "") {
-    pattern += `(${regexp.escape(ast.head)})`;
+    const head = regexp.escape(ast.head);
+    pattern += capture && top ? `(${head})` : head;
   }
   for (const span of ast.spans) {
-    pattern += `(${getTemplateLiteralCapturingPattern(span.type)})`;
+    const spanPattern = getTemplateLiteralSpanTypePattern(span.type, capture);
+    pattern += handleTemplateLiteralSpanTypeParens(span.type, spanPattern, capture, top);
     if (span.literal !== "") {
-      pattern += `(${regexp.escape(span.literal)})`;
+      const literal = regexp.escape(span.literal);
+      pattern += capture && top ? `(${literal})` : literal;
     }
   }
-  pattern += "$";
-  return new RegExp(pattern);
+  return pattern;
 };
+/**
+ * Generates a regular expression from a `TemplateLiteral` AST node.
+ *
+ * @see {@link getTemplateLiteralCapturingRegExp} for a variant that captures the pattern.
+ *
+ * @since 3.10.0
+ */
+const getTemplateLiteralRegExp = ast => new RegExp(`^${getTemplateLiteralPattern(ast, false, true)}$`);
+/**
+ * Generates a regular expression that captures the pattern defined by the given `TemplateLiteral` AST.
+ *
+ * @see {@link getTemplateLiteralRegExp} for a variant that does not capture the pattern.
+ *
+ * @since 3.10.0
+ */
+exports.getTemplateLiteralRegExp = getTemplateLiteralRegExp;
+const getTemplateLiteralCapturingRegExp = ast => new RegExp(`^${getTemplateLiteralPattern(ast, true, true)}$`);
 /**
  * @since 3.10.0
  */
@@ -1846,7 +1851,7 @@ const getNumberIndexedAccess = ast => {
     case "Suspend":
       return getNumberIndexedAccess(ast.f());
   }
-  throw new Error(errors_.getASTUnsupportedSchema(ast));
+  throw new Error(errors_.getASTUnsupportedSchemaErrorMessage(ast));
 };
 exports.getNumberIndexedAccess = getNumberIndexedAccess;
 const getTypeLiteralPropertySignature = (ast, name) => {
@@ -1911,7 +1916,7 @@ const getPropertyKeyIndexedAccess = (ast, name) => {
     case "Refinement":
       return getPropertyKeyIndexedAccess(ast.from, name);
   }
-  throw new Error(errors_.getASTUnsupportedSchema(ast));
+  throw new Error(errors_.getASTUnsupportedSchemaErrorMessage(ast));
 };
 exports.getPropertyKeyIndexedAccess = getPropertyKeyIndexedAccess;
 const getPropertyKeys = ast => {
@@ -1949,7 +1954,7 @@ const record = (key, value) => {
         if (Predicate.isString(key.literal) || Predicate.isNumber(key.literal)) {
           propertySignatures.push(new PropertySignature(key.literal, value, false, true));
         } else {
-          throw new Error(errors_.getASTUnsupportedLiteral(key.literal));
+          throw new Error(errors_.getASTUnsupportedLiteralErrorMessage(key.literal));
         }
         break;
       case "Enums":
@@ -1966,7 +1971,7 @@ const record = (key, value) => {
         key.types.forEach(go);
         break;
       default:
-        throw new Error(errors_.getASTUnsupportedKeySchema(key));
+        throw new Error(errors_.getASTUnsupportedKeySchemaErrorMessage(key));
     }
   };
   go(key);
@@ -2036,7 +2041,7 @@ const pick = (ast, keys) => {
         }
       }
   }
-  throw new Error(errors_.getASTUnsupportedSchema(ast));
+  throw new Error(errors_.getASTUnsupportedSchemaErrorMessage(ast));
 };
 /**
  * Equivalent at runtime to the built-in TypeScript utility type `Omit`.
@@ -2069,15 +2074,14 @@ const partial = (ast, options) => {
     case "Suspend":
       return new Suspend(() => partial(ast.f(), options));
     case "Declaration":
-      throw new Error(errors_.getASTUnsupportedSchema(ast));
     case "Refinement":
-      throw new Error(errors_.getASTUnsupportedSchema(ast));
+      throw new Error(errors_.getASTUnsupportedSchemaErrorMessage(ast));
     case "Transformation":
       {
         if (isTypeLiteralTransformation(ast.transformation) && ast.transformation.propertySignatureTransformations.every(isRenamingPropertySignatureTransformation)) {
           return new Transformation(partial(ast.from, options), partial(ast.to, options), ast.transformation);
         }
-        throw new Error(errors_.getASTUnsupportedSchema(ast));
+        throw new Error(errors_.getASTUnsupportedSchemaErrorMessage(ast));
       }
   }
   return ast;
@@ -2099,15 +2103,14 @@ const required = ast => {
     case "Suspend":
       return new Suspend(() => required(ast.f()));
     case "Declaration":
-      throw new Error(errors_.getASTUnsupportedSchema(ast));
     case "Refinement":
-      throw new Error(errors_.getASTUnsupportedSchema(ast));
+      throw new Error(errors_.getASTUnsupportedSchemaErrorMessage(ast));
     case "Transformation":
       {
         if (isTypeLiteralTransformation(ast.transformation) && ast.transformation.propertySignatureTransformations.every(isRenamingPropertySignatureTransformation)) {
           return new Transformation(required(ast.from), required(ast.to), ast.transformation);
         }
-        throw new Error(errors_.getASTUnsupportedSchema(ast));
+        throw new Error(errors_.getASTUnsupportedSchemaErrorMessage(ast));
       }
   }
   return ast;
@@ -2421,7 +2424,7 @@ const _keyof = ast => {
     case "Transformation":
       return _keyof(ast.to);
   }
-  throw new Error(errors_.getASTUnsupportedSchema(ast));
+  throw new Error(errors_.getASTUnsupportedSchemaErrorMessage(ast));
 };
 /** @internal */
 const compose = (ab, cd) => new Transformation(ab, cd, composeTransformation);
@@ -2453,11 +2456,48 @@ const rename = (ast, mapping) => {
     case "Transformation":
       return compose(ast, rename(typeAST(ast), mapping));
   }
-  throw new Error(errors_.getASTUnsupportedRenameSchema(ast));
+  throw new Error(errors_.getASTUnsupportedRenameSchemaErrorMessage(ast));
 };
 exports.rename = rename;
 const formatKeyword = ast => Option.getOrElse(getExpected(ast), () => ast._tag);
-const getExpected = ast => {
-  return getIdentifierAnnotation(ast).pipe(Option.orElse(() => getTitleAnnotation(ast)), Option.orElse(() => getDescriptionAnnotation(ast)), Option.orElse(() => getAutoTitleAnnotation(ast)));
+function getBrands(ast) {
+  return Option.match(getBrandAnnotation(ast), {
+    onNone: () => "",
+    onSome: brands => brands.map(brand => ` & Brand<${util_.formatUnknown(brand)}>`).join("")
+  });
+}
+const getOrElseExpected = ast => getTitleAnnotation(ast).pipe(Option.orElse(() => getDescriptionAnnotation(ast)), Option.orElse(() => getAutoTitleAnnotation(ast)), Option.map(s => s + getBrands(ast)));
+const getExpected = ast => Option.orElse(getIdentifierAnnotation(ast), () => getOrElseExpected(ast));
+/** @internal */
+const pruneUndefined = (ast, self, onTransformation) => {
+  switch (ast._tag) {
+    case "UndefinedKeyword":
+      return neverKeyword;
+    case "Union":
+      {
+        const types = [];
+        let hasUndefined = false;
+        for (const type of ast.types) {
+          const pruned = self(type);
+          if (pruned) {
+            hasUndefined = true;
+            if (!isNeverKeyword(pruned)) {
+              types.push(pruned);
+            }
+          } else {
+            types.push(type);
+          }
+        }
+        if (hasUndefined) {
+          return Union.make(types);
+        }
+        break;
+      }
+    case "Suspend":
+      return self(ast.f());
+    case "Transformation":
+      return onTransformation(ast);
+  }
 };
+exports.pruneUndefined = pruneUndefined;
 //# sourceMappingURL=SchemaAST.js.map