schematox 0.1.2 → 0.3.0-beta.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/README.md

@@ -83,19 +83,19 @@ const subject = {
 
 const parsed = parse(userSchema, subject)
 
-if (parsed.error) {
+if (parsed.left) {
   throw Error('Not expected')
 }
 
-console.log(parsed.data) // { id: '1', name: 'John' }
+console.log(parsed.right) // { id: '1', name: 'John' }
 
 const validated = validate(userSchema, subject)
 
-if (validated.error) {
+if (validated.left) {
   throw Error('Not expected')
 }
 
-console.log(validated.data) // { id: '1', name: 'John' }
+console.log(validated.right) // { id: '1', name: 'John' }
 
 if (guard(userSchema, subject)) {
   // { id: string & { __idFor: 'User' }; name: string }
@@ -120,19 +120,19 @@ const subject = { id: '1', name: 'John' } as unknown
 
 const parsed = struct.parse(subject)
 
-if (parsed.error) {
+if (parsed.left) {
   throw Error('Not expected')
 }
 
-console.log(parsed.data) // { id: '1', name: 'John' }
+console.log(parsed.right) // { id: '1', name: 'John' }
 
 const validated = struct.validate(subject)
 
-if (validated.error) {
+if (validated.left) {
   throw Error('Not expected')
 }
 
-console.log(validated.data) // { id: '1', name: 'John' }
+console.log(validated.right) // { id: '1', name: 'John' }
 
 if (struct.guard(subject)) {
   // { id: string & { __idFor: 'User' }; name: string }
@@ -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
@@ -351,7 +362,7 @@ const struct = object({
 const result = struct.parse({ x: { y: [{ z: 0 }] } })
 ```
 
-The `result.error` shape is:
+The `result.left` shape is:
 
 ```json
 [

package/dist/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.guard = exports.validate = exports.parse = exports.data = exports.error = exports.object = exports.array = exports.union = exports.literal = exports.boolean = exports.number = exports.string = exports.ERROR_CODE = void 0;
+exports.guard = exports.validate = exports.parse = exports.right = exports.left = exports.object = exports.array = exports.union = exports.literal = exports.boolean = exports.number = exports.string = exports.makeStruct = exports.ERROR_CODE = void 0;
 var error_1 = require("./error");
 Object.defineProperty(exports, "ERROR_CODE", { enumerable: true, get: function () { return error_1.ERROR_CODE; } });
 var struct_1 = require("./struct");
+Object.defineProperty(exports, "makeStruct", { enumerable: true, get: function () { return struct_1.makeStruct; } });
 Object.defineProperty(exports, "string", { enumerable: true, get: function () { return struct_1.string; } });
 Object.defineProperty(exports, "number", { enumerable: true, get: function () { return struct_1.number; } });
 Object.defineProperty(exports, "boolean", { enumerable: true, get: function () { return struct_1.boolean; } });
@@ -12,8 +13,8 @@ Object.defineProperty(exports, "union", { enumerable: true, get: function () { r
 Object.defineProperty(exports, "array", { enumerable: true, get: function () { return struct_1.array; } });
 Object.defineProperty(exports, "object", { enumerable: true, get: function () { return struct_1.object; } });
 var fp_1 = require("./utils/fp");
-Object.defineProperty(exports, "error", { enumerable: true, get: function () { return fp_1.error; } });
-Object.defineProperty(exports, "data", { enumerable: true, get: function () { return fp_1.data; } });
+Object.defineProperty(exports, "left", { enumerable: true, get: function () { return fp_1.left; } });
+Object.defineProperty(exports, "right", { enumerable: true, get: function () { return fp_1.right; } });
 var parse_1 = require("./parse");
 Object.defineProperty(exports, "parse", { enumerable: true, get: function () { return parse_1.parse; } });
 var validate_1 = require("./validate");

package/dist/index.ts

@@ -1,6 +1,7 @@
 export { ERROR_CODE } from './error'
 
 export {
+  makeStruct,
   string,
   number,
   boolean,
@@ -10,11 +11,25 @@ export {
   object,
 } from './struct'
 
-export { error, data } from './utils/fp'
+export { left, right } from './utils/fp'
 export { parse } from './parse'
 export { validate, guard } from './validate'
 
-export type { Schema } from './types/compounds'
+export type {
+  StringSchema,
+  NumberSchema,
+  BooleanSchema,
+  LiteralSchema,
+  PrimitiveSchema,
+} from './types/primitives'
+
+export type {
+  Schema,
+  BaseArraySchema,
+  BaseObjectSchema,
+  BaseUnionSchema,
+} from './types/compounds'
+
 export type { SubjectType } from './types/constructors'
 
 export type { InvalidSubject, ErrorPath, ErrorCode } from './error'

package/dist/parse.js

@@ -44,16 +44,16 @@ function parse(schema, subject) {
     var e_1, _a;
     var errors = [];
     if (schema.optional === true && subject === undefined) {
-        return (0, fp_1.data)(undefined);
+        return (0, fp_1.right)(undefined);
     }
     if (schema.nullable === true && subject === null) {
-        return (0, fp_1.data)(null);
+        return (0, fp_1.right)(null);
     }
     if (schema.type === 'object') {
         if (typeof subject !== 'object' ||
             subject === null ||
             subject.constructor !== Object) {
-            return (0, fp_1.error)([
+            return (0, fp_1.left)([
                 {
                     code: error_1.ERROR_CODE.invalidType,
                     path: this || [],
@@ -67,20 +67,20 @@ function parse(schema, subject) {
             var nestedSchema = schema.of[key];
             var nestedValue = subject[key];
             var parsed = parse.bind(__spreadArray(__spreadArray([], __read((this || [])), false), [key], false))(nestedSchema, nestedValue);
-            if (parsed.error) {
-                parsed.error.forEach(function (err) { return errors.push(err); });
+            if (parsed.left) {
+                parsed.left.forEach(function (err) { return errors.push(err); });
                 continue;
             }
-            result[key] = parsed.data;
+            result[key] = parsed.right;
         }
         if (errors.length) {
-            return (0, fp_1.error)(errors);
+            return (0, fp_1.left)(errors);
         }
-        return (0, fp_1.data)(result);
+        return (0, fp_1.right)(result);
     }
     if (schema.type === 'array') {
         if (Array.isArray(subject) === false) {
-            return (0, fp_1.error)([
+            return (0, fp_1.left)([
                 {
                     code: error_1.ERROR_CODE.invalidType,
                     path: this || [],
@@ -94,18 +94,18 @@ function parse(schema, subject) {
             var nestedSchema = schema.of;
             var nestedValue = subject[i];
             var parsed = parse.bind(__spreadArray(__spreadArray([], __read((this || [])), false), [i], false))(nestedSchema, nestedValue);
-            if (parsed.error) {
-                parsed.error.forEach(function (err) { return errors.push(err); });
+            if (parsed.left) {
+                parsed.left.forEach(function (err) { return errors.push(err); });
                 continue;
             }
-            result.push(parsed.data);
+            result.push(parsed.right);
         }
         if (errors.length) {
-            return (0, fp_1.error)(errors);
+            return (0, fp_1.left)(errors);
         }
         if (typeof schema.minLength === 'number' &&
             result.length < schema.minLength) {
-            return (0, fp_1.error)([
+            return (0, fp_1.left)([
                 {
                     code: error_1.ERROR_CODE.invalidRange,
                     path: this || [],
@@ -116,7 +116,7 @@ function parse(schema, subject) {
         }
         if (typeof schema.maxLength === 'number' &&
             result.length > schema.maxLength) {
-            return (0, fp_1.error)([
+            return (0, fp_1.left)([
                 {
                     code: error_1.ERROR_CODE.invalidRange,
                     path: this || [],
@@ -125,15 +125,15 @@ function parse(schema, subject) {
                 },
             ]);
         }
-        return (0, fp_1.data)(result);
+        return (0, fp_1.right)(result);
     }
     if (schema.type === 'union') {
         try {
             for (var _b = __values(schema.of), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var subSchema = _c.value;
                 var parsed = parse(subSchema, subject);
-                if (parsed.error === undefined) {
-                    return (0, fp_1.data)(parsed.data);
+                if (parsed.left === undefined) {
+                    return (0, fp_1.right)(parsed.right);
                 }
             }
         }
@@ -144,7 +144,7 @@ function parse(schema, subject) {
             }
             finally { if (e_1) throw e_1.error; }
         }
-        return (0, fp_1.error)([
+        return (0, fp_1.left)([
             {
                 code: error_1.ERROR_CODE.invalidType,
                 path: this || [],
@@ -155,9 +155,9 @@ function parse(schema, subject) {
     }
     var verified = (0, verify_primitive_1.verifyPrimitive)(schema, subject);
     if (verified === true) {
-        return (0, fp_1.data)(subject);
+        return (0, fp_1.right)(subject);
     }
-    return (0, fp_1.error)([
+    return (0, fp_1.left)([
         {
             code: verified,
             path: this || [],

package/dist/struct.js

@@ -33,7 +33,7 @@ function makeStruct(schema) {
         parse: function (subj) { return (0, parse_1.parse)(schema, subj); },
         validate: function (subj) { return (0, validate_1.validate)(schema, subj); },
         guard: function (subj) {
-            return (0, validate_1.validate)(schema, subj).error === undefined;
+            return (0, validate_1.validate)(schema, subj).left === undefined;
         },
     };
     if (params.has('optional')) {

package/dist/types/compounds.ts

@@ -1,6 +1,6 @@
 import type { PrimitiveSchema } from './primitives'
 
-type BaseObjectSchema<T> = {
+export type BaseObjectSchema<T> = {
   type: 'object'
   of: Record<string, T>
 
@@ -10,7 +10,7 @@ type BaseObjectSchema<T> = {
   description?: string
 }
 
-type BaseArraySchema<T> = {
+export type BaseArraySchema<T> = {
   type: 'array'
   of: T
 
@@ -23,7 +23,7 @@ type BaseArraySchema<T> = {
 }
 
 // TODO: `discriminant` key as performance optimization measure
-type BaseUnionSchema<T> = {
+export type BaseUnionSchema<T> = {
   type: 'union'
   of: Readonly<Array<T>>
 

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/dist/utils/fp.d.ts

@@ -1,11 +1,11 @@
 export type Error<T> = {
-    error: T;
-    data?: never;
+    left: T;
+    right?: never;
 };
 export type Data<U> = {
-    error?: never;
-    data: U;
+    left?: never;
+    right: U;
 };
 export type EitherError<T, U> = NonNullable<Error<T> | Data<U>>;
-export declare const error: <T>(value: T) => Error<T>;
-export declare const data: <U>(value: U) => Data<U>;
+export declare const left: <T>(value: T) => Error<T>;
+export declare const right: <U>(value: U) => Data<U>;

package/dist/utils/fp.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.data = exports.error = void 0;
-var error = function (value) { return ({ error: value }); };
-exports.error = error;
-var data = function (value) { return ({ data: value }); };
-exports.data = data;
+exports.right = exports.left = void 0;
+var left = function (value) { return ({ left: value }); };
+exports.left = left;
+var right = function (value) { return ({ right: value }); };
+exports.right = right;

package/dist/validate.js

@@ -44,16 +44,16 @@ function validate(schema, subject) {
     var e_1, _a;
     var errors = [];
     if (schema.optional === true && subject === undefined) {
-        return (0, fp_1.data)(undefined);
+        return (0, fp_1.right)(undefined);
     }
     if (schema.nullable === true && subject === null) {
-        return (0, fp_1.data)(null);
+        return (0, fp_1.right)(null);
     }
     if (schema.type === 'object') {
         if (typeof subject !== 'object' ||
             subject === null ||
             subject.constructor !== Object) {
-            return (0, fp_1.error)([
+            return (0, fp_1.left)([
                 {
                     code: error_1.ERROR_CODE.invalidType,
                     path: this || [],
@@ -68,13 +68,13 @@ function validate(schema, subject) {
             var nestedValue = subject[key];
             var nestedSchema = schema.of[key];
             var validated = validate.bind(__spreadArray(__spreadArray([], __read((this || [])), false), [key], false))(nestedSchema, nestedValue);
-            if (validated.error) {
-                validated.error.forEach(function (err) { return errors.push(err); });
+            if (validated.left) {
+                validated.left.forEach(function (err) { return errors.push(err); });
                 continue;
             }
         }
         if (errors.length) {
-            return (0, fp_1.error)(errors);
+            return (0, fp_1.left)(errors);
         }
         if (subjectKeySet.size !== 0) {
             errors.push({
@@ -83,13 +83,13 @@ function validate(schema, subject) {
                 schema: schema,
                 path: this || [],
             });
-            return (0, fp_1.error)(errors);
+            return (0, fp_1.left)(errors);
         }
-        return (0, fp_1.data)(subject);
+        return (0, fp_1.right)(subject);
     }
     if (schema.type === 'array') {
         if (Array.isArray(subject) === false) {
-            return (0, fp_1.error)([
+            return (0, fp_1.left)([
                 {
                     code: error_1.ERROR_CODE.invalidType,
                     path: this || [],
@@ -102,17 +102,17 @@ function validate(schema, subject) {
             var nestedSchema = schema.of;
             var nestedValue = subject[i];
             var validated = validate.bind(__spreadArray(__spreadArray([], __read((this || [])), false), [i], false))(nestedSchema, nestedValue);
-            if (validated.error) {
-                validated.error.forEach(function (err) { return errors.push(err); });
+            if (validated.left) {
+                validated.left.forEach(function (err) { return errors.push(err); });
                 continue;
             }
         }
         if (errors.length) {
-            return (0, fp_1.error)(errors);
+            return (0, fp_1.left)(errors);
         }
         if (typeof schema.minLength === 'number' &&
             subject.length < schema.minLength) {
-            return (0, fp_1.error)([
+            return (0, fp_1.left)([
                 {
                     code: error_1.ERROR_CODE.invalidRange,
                     path: this || [],
@@ -123,7 +123,7 @@ function validate(schema, subject) {
         }
         if (typeof schema.maxLength === 'number' &&
             subject.length > schema.maxLength) {
-            return (0, fp_1.error)([
+            return (0, fp_1.left)([
                 {
                     code: error_1.ERROR_CODE.invalidRange,
                     path: this || [],
@@ -132,14 +132,14 @@ function validate(schema, subject) {
                 },
             ]);
         }
-        return (0, fp_1.data)(subject);
+        return (0, fp_1.right)(subject);
     }
     if (schema.type === 'union') {
         try {
             for (var _b = __values(schema.of), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var subSchema = _c.value;
-                if (validate(subSchema, subject).error === undefined) {
-                    return (0, fp_1.data)(subject);
+                if (validate(subSchema, subject).left === undefined) {
+                    return (0, fp_1.right)(subject);
                 }
             }
         }
@@ -150,7 +150,7 @@ function validate(schema, subject) {
             }
             finally { if (e_1) throw e_1.error; }
         }
-        return (0, fp_1.error)([
+        return (0, fp_1.left)([
             {
                 code: error_1.ERROR_CODE.invalidType,
                 path: this || [],
@@ -161,9 +161,9 @@ function validate(schema, subject) {
     }
     var verified = (0, verify_primitive_1.verifyPrimitive)(schema, subject);
     if (verified === true) {
-        return (0, fp_1.data)(subject);
+        return (0, fp_1.right)(subject);
     }
-    return (0, fp_1.error)([
+    return (0, fp_1.left)([
         {
             code: verified,
             path: this || [],
@@ -174,6 +174,6 @@ function validate(schema, subject) {
 }
 exports.validate = validate;
 function guard(schema, subject) {
-    return validate(schema, subject).error === undefined;
+    return validate(schema, subject).left === undefined;
 }
 exports.guard = guard;

package/package.json

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