@arrirpc/schema 0.77.1 → 0.79.0

package/README.md

@@ -649,7 +649,7 @@ const User = a.object({
  * Resulting type
  * {
  *   id: string;
- *   email: string | undefined;
+ *   email?: string | undefined;
  *   date: Date;
  * }
  */
@@ -697,6 +697,62 @@ const name = a.nullable(a.string());
 }
 ```
 
+### Undefinable
+
+This is similar to `a.optional()` except that when initializing the object the key will still be required.
+
+```ts
+const Foo = a.object({
+    foo: a.undefinable(a.string()),
+});
+type Foo = a.infer<typeof Foo>;
+
+const fooInstance: Foo = {
+    // this field must still be present
+    // while with a.optional() we could omit the key
+    foo: undefined,
+};
+```
+
+As far as parsing and validating goes this functions exactly the same as `a.optional()`.
+
+```ts
+const User = a.object({
+    id: a.string(),
+    email: a.undefinable(a.string()),
+    date: a.timestamp();
+})
+
+/**
+ * Resulting type (Notice how the email key is still required)
+ * {
+ *   id: string;
+ *   email: string | undefined;
+ *   date: Date;
+ * }
+ */
+```
+
+**Outputted ATD**
+
+```json
+{
+    "properties": {
+        "id": {
+            "type": "string"
+        },
+        "date": {
+            "type": "timestamp"
+        }
+    },
+    "optionalProperties": {
+        "email": {
+            "type": "string"
+        }
+    }
+}
+```
+
 ### Clone
 
 Copy another schema without copying it's metadata using the `a.clone()` helper

package/dist/adapters.d.cts

@@ -1,11 +1,11 @@
 import { StandardSchemaV1 } from '@standard-schema/spec';
-import { V as ValidationContext, A as ASchema } from './shared/schema.hMebmI3A.cjs';
+import { m as ValidationContext, A as ASchema } from './shared/schema.CS4qvHhE.cjs';
 import '@arrirpc/type-defs';
 
 declare function createStandardSchemaProperty<T>(validate: (input: unknown) => input is T, parse: (input: unknown, ctx: ValidationContext) => T | undefined, vendor?: string): StandardSchemaV1<T>['~standard'];
 /**
  * Ensure that non ATD compliant properties get hidden when serialized to JSON
  */
-declare function hideInvalidProperties(schema: ASchema): void;
+declare function hideInvalidProperties(schema: ASchema<any, any>): void;
 
 export { createStandardSchemaProperty, hideInvalidProperties };

package/dist/adapters.d.mts

@@ -1,11 +1,11 @@
 import { StandardSchemaV1 } from '@standard-schema/spec';
-import { V as ValidationContext, A as ASchema } from './shared/schema.hMebmI3A.mjs';
+import { m as ValidationContext, A as ASchema } from './shared/schema.CS4qvHhE.mjs';
 import '@arrirpc/type-defs';
 
 declare function createStandardSchemaProperty<T>(validate: (input: unknown) => input is T, parse: (input: unknown, ctx: ValidationContext) => T | undefined, vendor?: string): StandardSchemaV1<T>['~standard'];
 /**
  * Ensure that non ATD compliant properties get hidden when serialized to JSON
  */
-declare function hideInvalidProperties(schema: ASchema): void;
+declare function hideInvalidProperties(schema: ASchema<any, any>): void;
 
 export { createStandardSchemaProperty, hideInvalidProperties };

package/dist/adapters.d.ts

@@ -1,11 +1,11 @@
 import { StandardSchemaV1 } from '@standard-schema/spec';
-import { V as ValidationContext, A as ASchema } from './shared/schema.hMebmI3A.js';
+import { m as ValidationContext, A as ASchema } from './shared/schema.CS4qvHhE.js';
 import '@arrirpc/type-defs';
 
 declare function createStandardSchemaProperty<T>(validate: (input: unknown) => input is T, parse: (input: unknown, ctx: ValidationContext) => T | undefined, vendor?: string): StandardSchemaV1<T>['~standard'];
 /**
  * Ensure that non ATD compliant properties get hidden when serialized to JSON
  */
-declare function hideInvalidProperties(schema: ASchema): void;
+declare function hideInvalidProperties(schema: ASchema<any, any>): void;
 
 export { createStandardSchemaProperty, hideInvalidProperties };