Merge pull request #5

Merge to main

bundle.js

@@ -38,7 +38,7 @@ files.push(getGzippedSize(fileEsm));
 // copy index.d.ts to index.esm.d.ts
 
 const folder = __dirname + `/validators`;
-let validatorFolders = ["array", "date", "object", "string", "utils"];
+let validatorFolders = ["array", "date", "object", "string", "utils", "number"];
 
 for (const f of validatorFolders) {
     const from = folder + `/${f}/index.js`;

index.esm.d.ts

@@ -8,4 +8,6 @@ import Abolish from "./src/Abolish";
 import { Schema, Rule } from "./src/functions";
 import type { AV } from "./src/validator";
 
+// Export
+export * from "./src/shortcuts";
 export { Abolish, Rule, Schema, AV };

index.esm.js

@@ -3,8 +3,4 @@
  * Esm Custom File.
  * This is not an autogenerated file.
  */
-import AbolishEsm from "./index.esm-bundled.js";
-
-const { Abolish, Schema, Rule } = AbolishEsm;
-
-export { Abolish, Schema, Rule };
+export * from "./index.esm-bundled.js";

index.ts

@@ -2,5 +2,6 @@ import Abolish from "./src/Abolish";
 import { Rule, Schema } from "./src/functions";
 import type { AV } from "./src/validator";
 
-// Export Abolish and Rule generator
+// Export
 export { Abolish, Rule, Schema, AV };
+export * from "./src/shortcuts";

package.json

@@ -1,6 +1,6 @@
 {
   "name": "abolish",
-  "version": "6.7.2",
+  "version": "6.7.3",
   "description": "A javascript object validator.",
   "main": "index.js",
   "module": "index.esm.js",
@@ -34,8 +34,8 @@
   "devDependencies": {
     "@trapcode/benchmark": "^0.1.3",
     "@types/lodash": "^4.17.5",
-    "@types/node": "^20.14.2",
-    "esbuild": "^0.21.5",
+    "@types/node": "^22.5.4",
+    "esbuild": "^0.23.1",
     "japa": "^4.0.0",
     "joi": "^17.13.1",
     "lodash-es": "^4.17.21",
@@ -52,4 +52,4 @@
     "object-validator",
     "async-object-validator"
   ]
-}
+}

src/Abolish.ts

@@ -1,5 +1,3 @@
-// noinspection DuplicatedCode
-
 import type {
     $errorRule,
     $errorsRule,
@@ -31,7 +29,6 @@ import {
     CompiledValidator
 } from "./Compiler";
 import { assertType } from "./types-checker";
-import { string } from "joi";
 
 type Job = {
     $name: string | false;
@@ -851,11 +848,7 @@ class Abolish {
      * @param rules
      * @param abolish
      */
-    static attempt<V = any>(
-        variable: V,
-        rules: AbolishRule | AbolishCompiled,
-        abolish?: typeof Abolish
-    ): V {
+    static attempt<V = any>(variable: V, rules: AbolishRule | AbolishCompiled): V {
         return new this().attempt(variable, rules);
     }
 

src/helpers.ts

@@ -1,4 +1,5 @@
-import type { $skipRule, AbolishInlineValidator } from "./types";
+import type { $skipRule, AbolishInlineValidator, AbolishRule } from "./types";
+import type { AbolishRuleTyped } from "./functions";
 
 /**
  * $inLine object generator
@@ -46,3 +47,37 @@ export function skipIfNotDefined(rule: string | Record<string, any> | any[]) {
  * Optional - alias for skipIfNotDefined
  */
 export const optional = skipIfNotDefined;
+
+/**
+ * Required helper function.
+ * @example
+ * required("string")
+ * // is same as
+ * ["required", "string"]
+ */
+export function required(rule: AbolishRule): AbolishRuleTyped {
+    if (typeof rule === "string") {
+        // add `required` to rule
+        return "required|" + rule;
+    } else if (Array.isArray(rule)) {
+        // add `required` to rule
+        return ["required", ...rule];
+    } else if (typeof rule === "object") {
+        // add `required` to rule
+        return { required: true, ...rule };
+    } else {
+        throw new Error("Required: Invalid Rule");
+    }
+}
+
+/**
+ * Required helper function for typed rules.
+ * @param rule
+ * @example
+ * requiredT("string")
+ * // is same as
+ * ["required", "string"]
+ */
+export function requiredT(rule: AbolishRuleTyped): AbolishRuleTyped {
+    return required(rule);
+}

src/shortcuts.ts

@@ -0,0 +1,45 @@
+/**
+ * Note:
+ * Only functions related to Abolish Should be added here.
+ */
+import type { AbolishSchema } from "./types";
+import Abolish from "./Abolish";
+import type { AbolishSchemaTyped } from "./functions";
+
+/**
+ * Compile a schema object.
+ * @param schema
+ * @param abolish
+ */
+export function compileSchema(schema: AbolishSchema, abolish?: typeof Abolish) {
+    if (!abolish) abolish = Abolish;
+    return abolish.compileObject(schema);
+}
+
+/**
+ * Compile a rule object.
+ * @param rule
+ * @param abolish
+ */
+export function compileRule(rule: any, abolish?: typeof Abolish) {
+    if (!abolish) abolish = Abolish;
+    return abolish.compile(rule);
+}
+
+/**
+ * Compile a schema object typed.
+ * @param schema
+ * @param abolish
+ */
+export function compileSchemaT(schema: AbolishSchemaTyped, abolish?: typeof Abolish) {
+    return compileSchema(schema, abolish);
+}
+
+/**
+ * Compile a rule object typed.
+ * @param rule
+ * @param abolish
+ */
+export function compileRuleT(rule: any, abolish?: typeof Abolish) {
+    return compileRule(rule, abolish);
+}

src/types.ts

@@ -68,10 +68,6 @@ export interface AbolishAsyncValidator extends Omit<AbolishValidator, "isAsync">
 }
 
 export type AbolishRule = string | string[] | Record<string, any> | AbolishRule[];
-// export type AbolishSchema<Keys extends string | number | symbol = string> = Record<
-//     Keys,
-//     AbolishRule
-// >;
 export type AbolishSchema<Keys extends Record<string, any> = Record<string, any>> = Record<
     keyof Keys | string,
     AbolishRule | boolean

src/validator.ts

@@ -20,6 +20,7 @@ export declare module AvailableValidators {
         default: any;
         required: boolean;
         typeof: string | string[] | false;
+        type: string | string[] | false;
         exact: string | boolean | number;
         min: number;
         max: number;