bguard 0.0.4 → 0.0.5

package/lib/schemas/StringSchema.mjs

@@ -0,0 +1,80 @@
+// src/exceptions.ts
+var ValidationError = class extends Error {
+  expected;
+  received;
+  pathToError;
+  message;
+  constructor(expected, received, pathToError, message) {
+    super();
+    this.expected = expected;
+    this.received = received;
+    this.pathToError = pathToError;
+    this.message = message;
+  }
+};
+function throwException(expected, received, pathToError, message) {
+  throw new ValidationError(expected, received, pathToError, message);
+}
+
+// src/asserts/common/equalTo.ts
+var equalTo = (expected) => (received, pathToError) => {
+  if (expected !== received)
+    throwException(expected, received, pathToError, "The received value is not equal to expected");
+};
+
+// src/core.ts
+var ctxSymbol = Symbol("contextSymbol");
+
+// src/schemas/CommonSchema.ts
+var CommonSchema = class {
+  [ctxSymbol];
+  constructor(ctx) {
+    this[ctxSymbol] = ctx;
+  }
+  /**
+   * @param validators - One or more custom validation functions.
+   * @returns {this} The schema instance with the added custom validation.
+   */
+  custom(...validators) {
+    this[ctxSymbol].requiredValidations.push(...validators);
+    return this;
+  }
+  /**
+   * Marks the schema as nullable, allowing the value to be `null`.
+   *
+   * @returns {WithNull<this>} The schema instance marked as nullable.
+   */
+  nullable() {
+    this[ctxSymbol].isNullable = true;
+    return this;
+  }
+  /**
+   * Marks the schema as optional, allowing the value to be `undefined`.
+   *
+   * @returns {WithUndefined<this>}} The schema instance marked as optional.
+   */
+  optional() {
+    this[ctxSymbol].isOptional = true;
+    return this;
+  }
+};
+
+// src/schemas/StringSchema.ts
+var StringSchema = class extends CommonSchema {
+  _string = 1;
+  /**
+   * Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.
+   *
+   * @param expectedValue - The value that the schema must exactly match.
+   * @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type
+   *
+   * @example - string().equalTo('hello'); // Infers the type 'hello'
+   */
+  equalTo(expectedValue) {
+    return this.custom(equalTo(expectedValue));
+  }
+};
+export {
+  StringSchema
+};
+//# sourceMappingURL=StringSchema.mjs.map

package/lib/schemas/StringSchema.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/exceptions.ts","../../src/asserts/common/equalTo.ts","../../src/core.ts","../../src/schemas/CommonSchema.ts","../../src/schemas/StringSchema.ts"],"sourcesContent":["export class ValidationError extends Error {\n  expected: unknown;\n  received: unknown;\n  pathToError: string;\n  message: string;\n  constructor(expected: unknown, received: unknown, pathToError: string, message: string) {\n    super();\n    this.expected = expected;\n    this.received = received;\n    this.pathToError = pathToError;\n    this.message = message;\n  }\n}\n\nexport class BuildSchemaError extends Error {}\n\nexport function throwException(expected: unknown, received: unknown, pathToError: string, message: string): never {\n  throw new ValidationError(expected, received, pathToError, message);\n}\n","import { throwException } from '../../exceptions';\nimport { RequiredValidation } from '../../schemas/CommonSchema';\n\n/**\n * Creates a custom assertion that checks if a value is equal to the expected value.\n *\n * This assertion can be used within a `.custom` method to enforce that a value strictly matches the expected value.\n * It will throw a `ValidationError` if the values are not equal.\n *\n * @param {unknown} expected - The value that the received value is expected to match.\n * @returns {RequiredValidation} A function that takes the received value and the path to the error,\n * and throws a `ValidationError` if the received value does not equal the expected value.\n *\n * @throws {ValidationError} If the received value does not match the expected value.\n *\n * @example\n * import { number, equalTo } from 'bguard';\n *\n * // Define a schema with a custom assertion\n * const schema = number().custom(equalTo(5));\n *\n * // This will pass\n * parseSchema(schema, 5);\n *\n * // This will throw a ValidationError\n * parseSchema(schema, 3);\n */\nexport const equalTo =\n  (expected: unknown): RequiredValidation =>\n  (received: number, pathToError: string) => {\n    if (expected !== received)\n      throwException(expected, received, pathToError, 'The received value is not equal to expected');\n  };\n","export const ctxSymbol = Symbol('contextSymbol');\n\nimport { throwException } from './exceptions';\nimport type { CommonSchema } from './schemas/CommonSchema';\n\nexport function innerCheck(schema: CommonSchema, receivedValue: unknown, pathToError: string) {\n  const ctx = schema[ctxSymbol];\n  if (receivedValue === undefined) {\n    if (!ctx.isOptional) throwException('Required', receivedValue, pathToError, 'The required value is missing');\n    return receivedValue;\n  }\n\n  if (receivedValue === null) {\n    if (!ctx.isNullable) throwException('Not null', receivedValue, pathToError, 'Value should not be null');\n    return receivedValue;\n  }\n\n  if (ctx.array) {\n    if (!Array.isArray(receivedValue))\n      throwException('Array', receivedValue, pathToError, 'Expected an array but received a different type');\n    const schema = ctx.array;\n\n    receivedValue.forEach((elem, i) => {\n      innerCheck(schema, elem, `${pathToError}[${i}]`);\n    });\n\n    return receivedValue;\n  }\n\n  const typeOfVal = typeof receivedValue;\n\n  if (ctx.object) {\n    if (typeOfVal !== 'object')\n      throwException('Object', receivedValue, pathToError, 'Expected an object but received a different type');\n    if (Array.isArray(receivedValue))\n      throwException(\n        'Object',\n        receivedValue,\n        pathToError,\n        'Expected an object but received an array. Invalid type of data',\n      );\n    const shapeSchema = ctx.object;\n    for (const keyPerReceivedValue of Object.keys(receivedValue)) {\n      if (shapeSchema[keyPerReceivedValue] === undefined)\n        throwException('Not allowed', keyPerReceivedValue, pathToError, 'This key is not allowed in the object');\n    }\n\n    for (const [keyOfSchema, valueOfSchema] of Object.entries(shapeSchema)) {\n      const receivedObjectValuePropery = (receivedValue as Record<string, unknown>)[keyOfSchema];\n      if (receivedObjectValuePropery === undefined) {\n        if (!valueOfSchema[ctxSymbol].isOptional)\n          throwException(\n            'Required',\n            receivedObjectValuePropery,\n            pathToError,\n            'Missing required property in the object',\n          );\n      }\n      innerCheck(valueOfSchema, receivedObjectValuePropery, `${pathToError}.${keyOfSchema}`);\n    }\n\n    return receivedValue;\n  }\n\n  if (ctx.type.length) {\n    if (!ctx.type.includes(typeOfVal)) throwException(ctx.type, typeOfVal, pathToError, 'Invalid type of data');\n  }\n\n  ctx.requiredValidations.forEach((requiredValidation) => {\n    requiredValidation(receivedValue, pathToError);\n  });\n\n  return receivedValue;\n}\n","import { ctxSymbol } from '../core';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type RequiredValidation = (received: any, pathToError: string) => void;\nexport type ObjectShapeSchemaType = Record<string, CommonSchema>;\n\nexport type PrimitiveType = 'number' | 'string' | 'boolean' | 'undefined' | 'object' | 'function' | 'symbol' | 'bigint';\nexport interface ValidatorContext {\n  type: PrimitiveType[];\n  isNullable?: boolean;\n  isOptional?: boolean;\n  requiredValidations: RequiredValidation[];\n  array?: CommonSchema;\n  object?: ObjectShapeSchemaType;\n}\n\nexport class CommonSchema {\n  [ctxSymbol]: ValidatorContext;\n  constructor(ctx: ValidatorContext) {\n    this[ctxSymbol] = ctx;\n  }\n\n  /**\n   * @param validators - One or more custom validation functions.\n   * @returns {this} The schema instance with the added custom validation.\n   */\n  custom(...validators: RequiredValidation[]): this {\n    this[ctxSymbol].requiredValidations.push(...validators);\n    return this;\n  }\n\n  /**\n   * Marks the schema as nullable, allowing the value to be `null`.\n   *\n   * @returns {WithNull<this>} The schema instance marked as nullable.\n   */\n  nullable(): WithNull<this> {\n    this[ctxSymbol].isNullable = true;\n    return this as WithNull<this>;\n  }\n\n  /**\n   * Marks the schema as optional, allowing the value to be `undefined`.\n   *\n   * @returns {WithUndefined<this>}} The schema instance marked as optional.\n   */\n  optional(): WithUndefined<this> {\n    this[ctxSymbol].isOptional = true;\n    return this as WithUndefined<this>;\n  }\n}\n\nexport type WithNull<T extends CommonSchema> = T & { validation_null: true };\nexport type WithUndefined<T extends CommonSchema> = T & { validation_undefined: true };\n\ntype TypeMapping = {\n  number: number;\n  string: string;\n  boolean: boolean;\n  undefined: undefined;\n  object: object;\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type\n  function: Function;\n  symbol: symbol;\n  bigint: bigint;\n};\n\nexport type WithMix<Y = unknown> = CommonSchema & { validation_mix: Y };\nexport type ExtractFromMix<T> = T extends WithMix<infer X> ? X : never;\n\nexport type MapMixTypes<T extends PrimitiveType[]> = T extends (infer U)[]\n  ? U extends keyof TypeMapping\n    ? TypeMapping[U]\n    : never\n  : never;\n","import { equalTo } from '../asserts/common/equalTo';\nimport { CommonSchema } from './CommonSchema';\n\nexport class StringSchema extends CommonSchema {\n  _string = 1;\n\n  /**\n   * Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.\n   *\n   * @param expectedValue - The value that the schema must exactly match.\n   * @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type\n   *\n   * @example - string().equalTo('hello'); // Infers the type 'hello'\n   */\n  equalTo<Y extends string>(expectedValue: Y): WithString<this, Y> {\n    return this.custom(equalTo(expectedValue)) as WithString<this, Y>;\n  }\n}\n\nexport type WithString<T extends StringSchema, Y = string> = T & { validation_string: Y };\nexport type ExtractFromString<T> = T extends WithString<StringSchema, infer Y> ? Y : never;\n"],"mappings":";AAAO,IAAM,kBAAN,cAA8B,MAAM;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,YAAY,UAAmB,UAAmB,aAAqB,SAAiB;AACtF,UAAM;AACN,SAAK,WAAW;AAChB,SAAK,WAAW;AAChB,SAAK,cAAc;AACnB,SAAK,UAAU;AAAA,EACjB;AACF;AAIO,SAAS,eAAe,UAAmB,UAAmB,aAAqB,SAAwB;AAChH,QAAM,IAAI,gBAAgB,UAAU,UAAU,aAAa,OAAO;AACpE;;;ACSO,IAAM,UACX,CAAC,aACD,CAAC,UAAkB,gBAAwB;AACzC,MAAI,aAAa;AACf,mBAAe,UAAU,UAAU,aAAa,6CAA6C;AACjG;;;AChCK,IAAM,YAAY,OAAO,eAAe;;;ACgBxC,IAAM,eAAN,MAAmB;AAAA,EACxB,CAAC,SAAS;AAAA,EACV,YAAY,KAAuB;AACjC,SAAK,SAAS,IAAI;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAU,YAAwC;AAChD,SAAK,SAAS,EAAE,oBAAoB,KAAK,GAAG,UAAU;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAA2B;AACzB,SAAK,SAAS,EAAE,aAAa;AAC7B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAgC;AAC9B,SAAK,SAAS,EAAE,aAAa;AAC7B,WAAO;AAAA,EACT;AACF;;;AC/CO,IAAM,eAAN,cAA2B,aAAa;AAAA,EAC7C,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUV,QAA0B,eAAuC;AAC/D,WAAO,KAAK,OAAO,QAAQ,aAAa,CAAC;AAAA,EAC3C;AACF;","names":[]}

package/package.json

@@ -2,7 +2,7 @@
   "name": "bguard",
   "private": false,
   "license": "MIT",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "main": "lib/index.js",
   "module": "lib/index.mjs",
   "types": "lib/index.d.ts",
@@ -78,13 +78,7 @@
   },
   "tsup": {
     "entry": [
-      "src/index.ts",
-      "src/asserts/common/*",
-      "src/asserts/array/*",
-      "src/asserts/object/*",
-      "src/asserts/boolean/*",
-      "src/asserts/string/*",
-      "src/asserts/number/*"
+      "src/**"
     ],
     "splitting": false,
     "sourcemap": true,
@@ -99,31 +93,38 @@
   "exports": {
     ".": {
       "import": "./lib/index.mjs",
-      "require": "./lib/index.js"
+      "require": "./lib/index.js",
+      "types": "./lib/index.d.ts"
     },
-    "./asserts/string/*": {
-      "import": "./lib/asserts/string/*",
-      "require": "./lib/asserts/string/*"
+    "./string/*": {
+      "import": "./lib/asserts/string/*.js",
+      "require": "./lib/asserts/string/*.js",
+      "types": "./lib/asserts/common/*.d.ts"
     },
-    "./asserts/boolean/*": {
-      "import": "./lib/asserts/boolean/*",
-      "require": "./lib/asserts/boolean/*"
+    "./boolean/*": {
+      "import": "./lib/asserts/boolean/*.js",
+      "require": "./lib/asserts/boolean/*.js",
+      "types": "./lib/index.d.ts"
     },
-    "./asserts/number/*": {
-      "import": "./lib/asserts/number/*",
-      "require": "./lib/asserts/number/*"
+    "./number/*": {
+      "import": "./lib/asserts/number/*.js",
+      "require": "./lib/asserts/number/*.js",
+      "types": "./lib/asserts/common/*.d.ts"
     },
-    "./asserts/array/*": {
-      "import": "./lib/asserts/array/*",
-      "require": "./lib/asserts/array/*"
+    "./array/*": {
+      "import": "./lib/asserts/array/*.js",
+      "require": "./lib/asserts/array/*.js",
+      "types": "./lib/asserts/common/*.d.ts"
     },
-    "./asserts/object/*": {
-      "import": "./lib/asserts/object/*",
-      "require": "./lib/asserts/object/*"
+    "./object/*": {
+      "import": "./lib/asserts/object/*.js",
+      "require": "./lib/asserts/object/*.js",
+      "types": "./lib/asserts/common/*.d.ts"
     },
-    "./asserts/common/*": {
-      "import": "./lib/asserts/common/*",
-      "require": "./lib/asserts/common/*"
+    "./common/*": {
+      "import": "./lib/asserts/common/*.js",
+      "require": "./lib/asserts/common/*.js",
+      "types": "./lib/asserts/common/*.d.ts"
     }
   }
 }

package/lib/index-D3R2euaT.d.mts

@@ -1,29 +0,0 @@
-import { C as CommonSchema, V as ValidatorContext, O as ObjectShapeSchemaType } from './CommonSchema-DeTBsQhn.mjs';
-
-declare class ObjectSchema extends CommonSchema {
-    _object: number;
-    constructor(ctx: ValidatorContext, shapeSchema: ObjectShapeSchemaType);
-    private validateObjectEntry;
-}
-type WithObject<Y extends ObjectShapeSchemaType> = ObjectSchema & {
-    validation_object: Y;
-};
-
-/**
- * Creates a new schema for validating objects where each property must match the specified schema.
- *
- * @template T
- * @param {T} shapeSchema - The schema that each property of the object must match.
- * @returns {WithObject<T>} A new instance of `ObjectSchema` for validating objects with properties matching the specified schema.
- *
- * @example
- * const schema = object({
- *   name: string(),
- *   age: number()
- * });
- * parseSchema(schema, { name: 'John', age: 30 }); // Validates successfully
- * parseSchema(schema, { name: 'John', age: '30' }); // Throws a validation error
- */
-declare function object<T extends ObjectShapeSchemaType>(shapeSchema: T): WithObject<T>;
-
-export { ObjectSchema as O, type WithObject as W, object as o };

package/lib/index-DPkImfCy.d.ts

@@ -1,29 +0,0 @@
-import { C as CommonSchema, V as ValidatorContext, O as ObjectShapeSchemaType } from './CommonSchema-DeTBsQhn.js';
-
-declare class ObjectSchema extends CommonSchema {
-    _object: number;
-    constructor(ctx: ValidatorContext, shapeSchema: ObjectShapeSchemaType);
-    private validateObjectEntry;
-}
-type WithObject<Y extends ObjectShapeSchemaType> = ObjectSchema & {
-    validation_object: Y;
-};
-
-/**
- * Creates a new schema for validating objects where each property must match the specified schema.
- *
- * @template T
- * @param {T} shapeSchema - The schema that each property of the object must match.
- * @returns {WithObject<T>} A new instance of `ObjectSchema` for validating objects with properties matching the specified schema.
- *
- * @example
- * const schema = object({
- *   name: string(),
- *   age: number()
- * });
- * parseSchema(schema, { name: 'John', age: 30 }); // Validates successfully
- * parseSchema(schema, { name: 'John', age: '30' }); // Throws a validation error
- */
-declare function object<T extends ObjectShapeSchemaType>(shapeSchema: T): WithObject<T>;
-
-export { ObjectSchema as O, type WithObject as W, object as o };

package/lib/index-DitgsWDO.d.ts

@@ -1,27 +0,0 @@
-import { C as CommonSchema, V as ValidatorContext } from './CommonSchema-DeTBsQhn.js';
-
-declare class ArraySchema extends CommonSchema {
-    _array: number;
-    constructor(ctx: ValidatorContext, arraySchema: CommonSchema);
-    private validateArrayEntry;
-}
-type WithArray<Y extends CommonSchema> = ArraySchema & {
-    validation_array: Y;
-};
-type ExtractFromArray<T> = T extends WithArray<infer X> ? X : never;
-
-/**
- * Creates a new schema for validating arrays where each element must match the specified schema.
- *
- * @template T
- * @param {T} arraySchema - The schema that each element of the array must match.
- * @returns {WithArray<T>} A new instance of `ArraySchema` for validating arrays of elements that match the specified schema.
- *
- * @example
- * const schema = array(string());
- * parseSchema(schema, ['hello', 'world']); // Validates successfully
- * parseSchema(schema, ['hello', 123]); // Throws a validation error
- */
-declare function array<T extends CommonSchema>(arraySchema: T): WithArray<T>;
-
-export { ArraySchema as A, type ExtractFromArray as E, array as a };

package/lib/index-T3KBmyyn.d.mts

@@ -1,27 +0,0 @@
-import { C as CommonSchema, V as ValidatorContext } from './CommonSchema-DeTBsQhn.mjs';
-
-declare class ArraySchema extends CommonSchema {
-    _array: number;
-    constructor(ctx: ValidatorContext, arraySchema: CommonSchema);
-    private validateArrayEntry;
-}
-type WithArray<Y extends CommonSchema> = ArraySchema & {
-    validation_array: Y;
-};
-type ExtractFromArray<T> = T extends WithArray<infer X> ? X : never;
-
-/**
- * Creates a new schema for validating arrays where each element must match the specified schema.
- *
- * @template T
- * @param {T} arraySchema - The schema that each element of the array must match.
- * @returns {WithArray<T>} A new instance of `ArraySchema` for validating arrays of elements that match the specified schema.
- *
- * @example
- * const schema = array(string());
- * parseSchema(schema, ['hello', 'world']); // Validates successfully
- * parseSchema(schema, ['hello', 123]); // Throws a validation error
- */
-declare function array<T extends CommonSchema>(arraySchema: T): WithArray<T>;
-
-export { ArraySchema as A, type ExtractFromArray as E, array as a };