schematox 0.0.2 → 0.0.3

package/README.md

@@ -169,7 +169,6 @@ import {
   string,
   number,
   boolean,
-  buffer,
   stringUnion,
   numberUnion,
 } from 'schematox'
@@ -243,28 +242,6 @@ const programmaticBoolean = boolean()
   .brand('x', 'y')
   .description('y')
 
-// buffer
-// The default value is not supported because Buffer is not compatible with JSON
-
-const staticShortBufferRequired = 'buffer' satisfies Schema
-const staticShortBufferOptional = 'buffer?' satisfies Schema
-
-const staticDetailedBuffer = {
-  type: 'buffer',
-  optional: true,
-  brand: ['x', 'y'],
-  minLength: 1,
-  maxLength: 1,
-  description: 'x',
-} as const satisfies Schema
-
-const programmaticBuffer = buffer()
-  .optional()
-  .minLength(1)
-  .maxLength(1)
-  .brand('x', 'y')
-  .description('y')
-
 // stringUnion
 
 const staticStringUnion = {
@@ -359,7 +336,7 @@ The `result.error` will be:
 
 ## Parse/validate differences
 
-The parser provides a new object/primitive without references to the evaluated subject, except in the case of `Buffer` for better performance. This functionality is responsible for clearing the `array` schema result value from `undefined` optional schema values.
+The parser provides a new object/primitive without references to the evaluated subject. This functionality is responsible for clearing the `array` schema result value from `undefined` optional schema values.
 
 Moreover, the parser manages the `null` value as `undefined` and subsequently replaces it with `undefined`. It also swaps `optional` values with the `default` value, provided that the default values are explicitly stated in the schema.
 

package/dist/base-schema-parser.d.ts

@@ -1,6 +1,5 @@
-/// <reference types="node" />
 import type { EitherError } from './utils/fp';
 import type { BaseSchema, Con_Schema_SubjT_P } from './types/compound-schema-types';
 import type { BaseSchemaParseError } from './error';
-export type BaseSchemaSubjectType = string | number | boolean | Buffer | undefined;
+export type BaseSchemaSubjectType = string | number | boolean | undefined;
 export declare function parseBaseSchemaSubject<T extends BaseSchema>(schema: T, schemaSubject: unknown): EitherError<BaseSchemaParseError, Con_Schema_SubjT_P<T>>;

package/dist/base-schema-parser.js

@@ -68,22 +68,6 @@ function parseBaseSchemaSubject(schema, subject) {
                 }
                 return (0, fp_1.data)(subject);
             }
-            case 'buffer?':
-            case 'buffer': {
-                if (Buffer.isBuffer(subject) === false) {
-                    if (subject === null || subject === undefined) {
-                        if (schema === 'buffer?') {
-                            return (0, fp_1.data)(undefined);
-                        }
-                    }
-                    return (0, fp_1.error)({
-                        code: error_1.PARSE_ERROR_CODE.invalidType,
-                        schema: schema,
-                        subject: subject,
-                    });
-                }
-                return (0, fp_1.data)(subject);
-            }
         }
     }
     switch (schema.type) {
@@ -171,39 +155,6 @@ function parseBaseSchemaSubject(schema, subject) {
             }
             return (0, fp_1.data)(subject);
         }
-        case 'buffer': {
-            if (Buffer.isBuffer(subject) === false) {
-                if (subject === undefined || subject === null) {
-                    if (schema.optional) {
-                        return (0, fp_1.data)(undefined);
-                    }
-                }
-                return (0, fp_1.error)({
-                    code: error_1.PARSE_ERROR_CODE.invalidType,
-                    schema: schema,
-                    subject: subject,
-                });
-            }
-            if (typeof schema.minLength === 'number') {
-                if (subject.length < schema.minLength) {
-                    return (0, fp_1.error)({
-                        code: error_1.PARSE_ERROR_CODE.minRange,
-                        schema: schema,
-                        subject: subject,
-                    });
-                }
-            }
-            if (typeof schema.maxLength === 'number') {
-                if (subject.length > schema.maxLength) {
-                    return (0, fp_1.error)({
-                        code: error_1.PARSE_ERROR_CODE.maxRange,
-                        schema: schema,
-                        subject: subject,
-                    });
-                }
-            }
-            return (0, fp_1.data)(subject);
-        }
         case 'stringUnion': {
             if (typeof subject !== 'string') {
                 if (subject === undefined || subject === null) {

package/dist/base-schema-validator.d.ts

@@ -1,6 +1,5 @@
-/// <reference types="node" />
 import type { EitherError } from './utils/fp';
 import type { BaseSchema, Con_Schema_SubjT_V } from './types/compound-schema-types';
 import type { BaseSchemaValidateError } from './error';
-export type BaseSchemaSubjectType = string | number | boolean | Buffer | undefined;
+export type BaseSchemaSubjectType = string | number | boolean | undefined;
 export declare function validateBaseSchemaSubject<T extends BaseSchema>(schema: T, schemaSubject: unknown): EitherError<BaseSchemaValidateError, Con_Schema_SubjT_V<T>>;

package/dist/base-schema-validator.js

@@ -62,20 +62,6 @@ function validateBaseSchemaSubject(schema, subject) {
                 }
                 return (0, fp_1.data)(subject);
             }
-            case 'buffer?':
-            case 'buffer': {
-                if (Buffer.isBuffer(subject) === false) {
-                    if (subject === undefined && schema === 'buffer?') {
-                        return (0, fp_1.data)(undefined);
-                    }
-                    return (0, fp_1.error)({
-                        code: error_1.VALIDATE_ERROR_CODE.invalidType,
-                        schema: schema,
-                        subject: subject,
-                    });
-                }
-                return (0, fp_1.data)(subject);
-            }
         }
     }
     switch (schema.type) {
@@ -168,37 +154,6 @@ function validateBaseSchemaSubject(schema, subject) {
             }
             return (0, fp_1.data)(subject);
         }
-        case 'buffer': {
-            if (Buffer.isBuffer(subject) === false) {
-                if (subject === undefined && schema.optional) {
-                    return (0, fp_1.data)(undefined);
-                }
-                return (0, fp_1.error)({
-                    code: error_1.VALIDATE_ERROR_CODE.invalidType,
-                    schema: schema,
-                    subject: subject,
-                });
-            }
-            if (typeof schema.minLength === 'number') {
-                if (subject.length < schema.minLength) {
-                    return (0, fp_1.error)({
-                        code: error_1.VALIDATE_ERROR_CODE.minRange,
-                        schema: schema,
-                        subject: subject,
-                    });
-                }
-            }
-            if (typeof schema.maxLength === 'number') {
-                if (subject.length > schema.maxLength) {
-                    return (0, fp_1.error)({
-                        code: error_1.VALIDATE_ERROR_CODE.maxRange,
-                        schema: schema,
-                        subject: subject,
-                    });
-                }
-            }
-            return (0, fp_1.data)(subject);
-        }
         case 'stringUnion': {
             if (typeof subject !== 'string') {
                 if (subject === undefined && schema.optional) {

package/dist/general-schema-parser.js

@@ -45,7 +45,6 @@ function parse(schema, subject) {
         schema.type === 'string' ||
         schema.type === 'number' ||
         schema.type === 'boolean' ||
-        schema.type === 'buffer' ||
         schema.type === 'stringUnion' ||
         schema.type === 'numberUnion') {
         var parsed = (0, base_schema_parser_1.parseBaseSchemaSubject)(schema, subject);

package/dist/general-schema-validator.js

@@ -45,7 +45,6 @@ function validate(schema, subject) {
         schema.type === 'string' ||
         schema.type === 'number' ||
         schema.type === 'boolean' ||
-        schema.type === 'buffer' ||
         schema.type === 'stringUnion' ||
         schema.type === 'numberUnion') {
         var validated = (0, base_schema_validator_1.validateBaseSchemaSubject)(schema, subject);

package/dist/index.js

@@ -8,7 +8,7 @@
  * but only with a MINOR version update.
  **/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.x = exports.validate = exports.parse = exports.object = exports.array = exports.numberUnion = exports.stringUnion = exports.buffer = exports.boolean = exports.number = exports.string = void 0;
+exports.x = exports.validate = exports.parse = exports.object = exports.array = exports.numberUnion = exports.stringUnion = exports.boolean = exports.number = exports.string = void 0;
 /* Programmatically base schema definition */
 var string_1 = require("./programmatic-schema/string");
 Object.defineProperty(exports, "string", { enumerable: true, get: function () { return string_1.string; } });
@@ -16,8 +16,6 @@ var number_1 = require("./programmatic-schema/number");
 Object.defineProperty(exports, "number", { enumerable: true, get: function () { return number_1.number; } });
 var boolean_1 = require("./programmatic-schema/boolean");
 Object.defineProperty(exports, "boolean", { enumerable: true, get: function () { return boolean_1.boolean; } });
-var buffer_1 = require("./programmatic-schema/buffer");
-Object.defineProperty(exports, "buffer", { enumerable: true, get: function () { return buffer_1.buffer; } });
 var string_union_1 = require("./programmatic-schema/string-union");
 Object.defineProperty(exports, "stringUnion", { enumerable: true, get: function () { return string_union_1.stringUnion; } });
 var number_union_1 = require("./programmatic-schema/number-union");

package/dist/index.ts

@@ -18,7 +18,6 @@ import type {
 export { string } from './programmatic-schema/string'
 export { number } from './programmatic-schema/number'
 export { boolean } from './programmatic-schema/boolean'
-export { buffer } from './programmatic-schema/buffer'
 export { stringUnion } from './programmatic-schema/string-union'
 export { numberUnion } from './programmatic-schema/number-union'
 

package/dist/types/base-detailed-schema-types.ts

@@ -36,17 +36,6 @@ export type BD_Boolean = {
   brand?: BrandSchema
 }
 
-export type BD_Buffer = {
-  type: 'buffer'
-  optional?: boolean
-
-  description?: string
-  brand?: BrandSchema
-
-  minLength?: number /* >= */
-  maxLength?: number /* <= */
-}
-
 export type BD_StringUnion<T extends string = string> = {
   type: 'stringUnion'
   of: Readonly<Array<T>>
@@ -71,7 +60,6 @@ export type BD_Schema =
   | BD_String
   | BD_Number
   | BD_Boolean
-  | BD_Buffer
   | BD_StringUnion
   | BD_NumberUnion
 
@@ -82,13 +70,11 @@ export type Con_BD_Schema_TypeOnly_SubjT<T extends BD_Schema> =
       ? number
       : T extends BD_Boolean
         ? boolean
-        : T extends BD_Buffer
-          ? Buffer
-          : T extends BD_StringUnion<infer U>
-            ? U
-            : T extends BD_NumberUnion<infer V>
-              ? V
-              : never
+        : T extends BD_StringUnion<infer U>
+          ? U
+          : T extends BD_NumberUnion<infer V>
+            ? V
+            : never
 
 export type Con_BrandSchema_SubjT<T extends BrandSchema> = T extends Readonly<
   [infer U, infer V]

package/dist/types/base-short-schema-types.ts

@@ -7,20 +7,9 @@ export type BS_Number_Opt = 'number?'
 export type BS_Boolean_Req = 'boolean'
 export type BS_Boolean_Opt = 'boolean?'
 
-export type BS_Buffer_Req = 'buffer'
-export type BS_Buffer_Opt = 'buffer?'
+export type BS_Schema_Req = BS_String_Req | BS_Number_Req | BS_Boolean_Req
 
-export type BS_Schema_Req =
-  | BS_String_Req
-  | BS_Number_Req
-  | BS_Boolean_Req
-  | BS_Buffer_Req
-
-export type BS_Schema_Opt =
-  | BS_String_Opt
-  | BS_Number_Opt
-  | BS_Boolean_Opt
-  | BS_Buffer_Opt
+export type BS_Schema_Opt = BS_String_Opt | BS_Number_Opt | BS_Boolean_Opt
 
 export type BS_Schema = BS_Schema_Req | BS_Schema_Opt
 
@@ -31,9 +20,7 @@ export type Con_BS_Schema_Req_SubjT<T extends BS_Schema_Req> =
       ? number
       : T extends BS_Boolean_Req
         ? boolean
-        : T extends BS_Buffer_Req
-          ? Buffer
-          : never
+        : never
 
 export type Con_BS_Schema_Opt_SubjT<T extends BS_Schema_Opt> =
   T extends BS_String_Opt
@@ -42,9 +29,7 @@ export type Con_BS_Schema_Opt_SubjT<T extends BS_Schema_Opt> =
       ? number | undefined
       : T extends BS_Boolean_Opt
         ? boolean | undefined
-        : T extends BS_Buffer_Opt
-          ? Buffer | undefined
-          : never
+        : never
 
 export type Con_BS_Schema_SubjT<T extends BS_Schema> = T extends BS_Schema_Req
   ? Con_BS_Schema_Req_SubjT<T>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "schematox",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Define JSON compatible schema statically/programmatically and parse/validate its subject with typesafety",
   "author": "Konstantin Mazur",
   "license": "MIT",
@@ -34,7 +34,6 @@
   },
   "devDependencies": {
     "@types/jest": "^29.5.1",
-    "@types/node": "^20.1.4",
     "@typescript-eslint/eslint-plugin": "^5.59.5",
     "@typescript-eslint/parser": "^5.59.5",
     "eslint": "^8.40.0",
@@ -42,7 +41,6 @@
     "jest": "^29.5.0",
     "prettier": "^3.1.1",
     "ts-jest": "^29.1.0",
-    "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   }
 }