schematox 0.2.0 → 0.3.0

package/.eslintrc.json

@@ -15,7 +15,15 @@
     "no-async-promise-executor": "off",
     "quotes": "off",
     "semi": "off",
-    "@typescript-eslint/no-var-requires": "off"
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/ban-types": [
+      "error",
+      {
+        "types": {
+          "{}": false
+        }
+      }
+    ]
   },
   "ignorePatterns": ["/dist"]
 }

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [0.3.0](https://github.com/incerta/schematox/compare/v0.2.0...v0.3.0) (2024-05-04)
+
+### Features
+
+- [`8bc2082`](https://github.com/incerta/schematox/commit/8bc208211457901f4f7246f00694f112d56f8d56) [#22](https://github.com/incerta/schematox/issues/22) Ensure optional properties in schemas reflect as optional in object context (@incerta)

package/README.md

@@ -325,8 +325,19 @@ type FromStruct = SubjectType<typeof struct>
 
 ## Schema parameters
 
-- `optional?: boolean` – does `undefined` is valid value
-- `nullable?: boolean` – does `null` is valid value
+- `optional?: boolean` –  unionize with `undefined`: `{ type: 'string', optinoal: true }` result in `string | undefined`
+
+In the context of the object, optional values will be treated as optional properties:
+
+```typescript
+const struct = object({ x: string().optional() })
+
+type ExpectedSubjectType = {
+  x?: string | undefined
+}
+```
+
+- `nullable?: boolean` – unionize with `null`: `{ type: 'string', nullable: true }` result in `string | null`
 - `brand?: [string, string]` – make primitive type nominal "['idFor', 'User'] -> T & { \_\_idFor: 'User' }"
 - `minLength/maxLength/min/max` – schema type dependent limiting characteristics
 - `description?: string` – description of the particular schema property which can be used to provide more detailed information for the user/developer on validation/parse error

package/dist/types/constructors.ts

@@ -32,14 +32,35 @@ type Con_ArraySchema_SubjT<T extends ArraySchema> = T extends { of: infer U }
     : never
   : never
 
+type Prettify<T extends Record<string, unknown>> = {
+  [K in keyof T]: T[K]
+} & {}
+
+/**
+ * ```MakeOptional{ x: T | undefined, y: T }```
+ *
+ * will make:
+ *
+ * ```{ x?: T | undefined, y: T }```
+ *
+ * NOTE: `Exclude<T[K], undefined> will not work
+ *       so we have technical constraint here
+ **/
+type MakeOptional<T> = Prettify<
+  {
+    [K in keyof T as undefined extends T[K] ? K : never]?: T[K]
+  } & {
+    [K in keyof T as undefined extends T[K] ? never : K]: T[K]
+  }
+>
 type Con_ObjectSchema_SubjT<T extends ObjectSchema> = T extends {
   of: infer U
 }
-  ? {
+  ? MakeOptional<{
       -readonly [k in keyof U]: U[k] extends Schema
         ? Con_Schema_SubjT<U[k]>
         : never
-    }
+    }>
   : never
 
 type Con_UnionSchema_SubjT<T extends UnionSchema> = T extends {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "schematox",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Define JSON compatible schema statically/programmatically and parse/validate its subject with typesafety",
   "author": "Konstantin Mazur",
   "license": "MIT",