convex 1.45.0 → 1.46.0

package/src/values/validators.ts

@@ -59,6 +59,8 @@ abstract class BaseValidator<
   abstract get json(): ValidatorJSON;
   /** @internal */
   abstract asOptional(): Validator<Type | undefined, "optional", FieldPaths>;
+  /** Allow this validated field to be absent. */
+  abstract optional(): Validator<Type | undefined, "optional", FieldPaths>;
 }
 
 /**
@@ -98,13 +100,17 @@ export class VId<
   get json(): ValidatorJSON {
     return { type: "id", tableName: this.tableName };
   }
-  /** @internal */
-  asOptional() {
+  /** Allow this field to be validated as absent. */
+  optional() {
     return new VId<Type | undefined, "optional">({
       isOptional: "optional",
       tableName: this.tableName,
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 }
 
 /**
@@ -124,12 +130,16 @@ export class VFloat64<
     // Server expects the old name `number` string instead of `float64`.
     return { type: "number" };
   }
-  /** @internal */
-  asOptional() {
+  /** Allow this field to be validated as absent. */
+  optional() {
     return new VFloat64<Type | undefined, "optional">({
       isOptional: "optional",
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 }
 
 /**
@@ -149,9 +159,13 @@ export class VInt64<
     // Server expects the old name `bigint`.
     return { type: "bigint" };
   }
+  /** Allow this validated field to be absent. */
+  optional() {
+    return new VInt64<Type | undefined, "optional">({ isOptional: "optional" });
+  }
   /** @internal */
   asOptional() {
-    return new VInt64<Type | undefined, "optional">({ isOptional: "optional" });
+    return this.optional();
   }
 }
 
@@ -171,12 +185,16 @@ export class VCommitTs<
   get json(): ValidatorJSON {
     return { type: this.kind };
   }
-  /** @internal */
-  asOptional() {
+  /** Allow this validated field to be absent. */
+  optional() {
     return new VCommitTs<Type | undefined, "optional">({
       isOptional: "optional",
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 }
 
 /**
@@ -195,12 +213,16 @@ export class VBoolean<
   get json(): ValidatorJSON {
     return { type: this.kind };
   }
-  /** @internal */
-  asOptional() {
+  /** Allow this validated field to be absent. */
+  optional() {
     return new VBoolean<Type | undefined, "optional">({
       isOptional: "optional",
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 }
 
 /**
@@ -219,9 +241,13 @@ export class VBytes<
   get json(): ValidatorJSON {
     return { type: this.kind };
   }
+  /** Allow this validated field to be absent. */
+  optional() {
+    return new VBytes<Type | undefined, "optional">({ isOptional: "optional" });
+  }
   /** @internal */
   asOptional() {
-    return new VBytes<Type | undefined, "optional">({ isOptional: "optional" });
+    return this.optional();
   }
 }
 
@@ -241,12 +267,16 @@ export class VString<
   get json(): ValidatorJSON {
     return { type: this.kind };
   }
-  /** @internal */
-  asOptional() {
+  /** Allow this validated field to be absent. */
+  optional() {
     return new VString<Type | undefined, "optional">({
       isOptional: "optional",
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 }
 
 /**
@@ -265,9 +295,13 @@ export class VNull<
   get json(): ValidatorJSON {
     return { type: this.kind };
   }
+  /** Allow this validated field to be absent. */
+  optional() {
+    return new VNull<Type | undefined, "optional">({ isOptional: "optional" });
+  }
   /** @internal */
   asOptional() {
-    return new VNull<Type | undefined, "optional">({ isOptional: "optional" });
+    return this.optional();
   }
 }
 
@@ -290,12 +324,16 @@ export class VAny<
       type: this.kind,
     };
   }
-  /** @internal */
-  asOptional() {
+  /** Allow this validated field to be absent. */
+  optional() {
     return new VAny<Type | undefined, "optional", FieldPaths>({
       isOptional: "optional",
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 }
 
 /**
@@ -358,13 +396,17 @@ export class VObject<
       ),
     };
   }
-  /** @internal */
-  asOptional() {
+  /** Allow this validated field to be absent. */
+  optional() {
     return new VObject<Type | undefined, Fields, "optional", FieldPaths>({
       isOptional: "optional",
       fields: this.fields,
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 
   /**
    * Create a new VObject with the specified fields omitted.
@@ -481,13 +523,17 @@ export class VLiteral<
       value: convexToJson(this.value as string | boolean | number | bigint),
     };
   }
-  /** @internal */
-  asOptional() {
+  /** Allow this validated field to be absent. */
+  optional() {
     return new VLiteral<Type | undefined, "optional">({
       isOptional: "optional",
       value: this.value,
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 }
 
 /**
@@ -531,13 +577,17 @@ export class VArray<
       value: this.element.json,
     };
   }
-  /** @internal */
-  asOptional() {
+  /** Allow this validated field to be absent. */
+  optional() {
     return new VArray<Type | undefined, Element, "optional">({
       isOptional: "optional",
       element: this.element,
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 }
 
 /**
@@ -608,14 +658,18 @@ export class VRecord<
       },
     };
   }
-  /** @internal */
-  asOptional() {
+  /** Allow this validated field to be absent. */
+  optional() {
     return new VRecord<Type | undefined, Key, Value, "optional", FieldPaths>({
       isOptional: "optional",
       key: this.key,
       value: this.value,
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 }
 
 /**
@@ -659,13 +713,17 @@ export class VUnion<
       value: this.members.map((v) => v.json),
     };
   }
-  /** @internal */
-  asOptional() {
-    return new VUnion<Type | undefined, T, "optional">({
+  /** Allow this validated field to be absent. */
+  optional() {
+    return new VUnion<Type | undefined, T, "optional", FieldPaths>({
       isOptional: "optional",
       members: this.members,
     });
   }
+  /** @internal */
+  asOptional() {
+    return this.optional();
+  }
 }
 
 // prettier-ignore