@cleverbrush/schema 1.1.2 → 1.1.4

package/dist/builders/StringSchemaBuilder.d.ts

@@ -3,7 +3,8 @@ type StringSchemaBuilderCreateProps<T = string, R extends boolean = true> = Part
 /**
  * Allows to define a schema for a string. It can be: required or optional,
  * restricted to be equal to a certain value, restricted to have a certain
- * length.
+ * length, restricted to start with a certain value, restricted to end with
+ * a certain value, restricted to match a certain regular expression.
  *
  * **NOTE** this class is exported only to give opportunity to extend it
  * by inheriting. It is not recommended to create an instance of this class
@@ -70,6 +71,18 @@ export declare class StringSchemaBuilder<TResult = string, TRequired extends boo
          * If set, restrict object to be equal to a certain value.
          */
         equalsTo: string | undefined;
+        /**
+         * If set, restrict string to start with a certain value.
+         */
+        startsWith: string | undefined;
+        /**
+         * If set, restrict string to end with a certain value.
+         */
+        endsWith: string | undefined;
+        /**
+         * If set, restrict string to match a certain regular expression.
+         */
+        matches: RegExp | undefined;
         /**
          * Array of preprocessor functions
          */
@@ -129,6 +142,30 @@ export declare class StringSchemaBuilder<TResult = string, TRequired extends boo
      * cancel `maxLength()` call.
      */
     clearMaxLength(): StringSchemaBuilder<TResult, TRequired>;
+    /**
+     * Restricts string to start with `val`.
+     */
+    startsWith(val: string): StringSchemaBuilder<TResult, TRequired>;
+    /**
+     * Cancels `startsWith()` call.
+     */
+    clearStartsWith(): StringSchemaBuilder<TResult, TRequired>;
+    /**
+     * Restricts string to end with `val`.
+     */
+    endsWith(val: string): StringSchemaBuilder<TResult, TRequired>;
+    /**
+     * Cancels `endsWith()` call.
+     */
+    clearEndsWith(): StringSchemaBuilder<TResult, TRequired>;
+    /**
+     * Restricts string to match `regexp`.
+     */
+    matches(regexp: RegExp): StringSchemaBuilder<TResult, TRequired>;
+    /**
+     * Cancels `matches()` call.
+     */
+    clearMatches(): StringSchemaBuilder<TResult, TRequired>;
 }
 /**
  * Creates a string schema restricted to be equal to `equals`.

package/dist/builders/StringSchemaBuilder.js

@@ -2,7 +2,8 @@ import { SchemaBuilder } from './SchemaBuilder.js';
 /**
  * Allows to define a schema for a string. It can be: required or optional,
  * restricted to be equal to a certain value, restricted to have a certain
- * length.
+ * length, restricted to start with a certain value, restricted to end with
+ * a certain value, restricted to match a certain regular expression.
  *
  * **NOTE** this class is exported only to give opportunity to extend it
  * by inheriting. It is not recommended to create an instance of this class
@@ -56,6 +57,9 @@ export class StringSchemaBuilder extends SchemaBuilder {
     #minLength;
     #maxLength;
     #equalsTo;
+    #startsWith;
+    #endsWith;
+    #matches;
     static create(props) {
         return new StringSchemaBuilder({
             type: 'string',
@@ -74,6 +78,16 @@ export class StringSchemaBuilder extends SchemaBuilder {
             typeof props.equalsTo === 'undefined') {
             this.#equalsTo = props.equalsTo;
         }
+        if (typeof props.startsWith === 'string' &&
+            props.startsWith.length > 0) {
+            this.#startsWith = props.startsWith;
+        }
+        if (typeof props.endsWith === 'string' && props.endsWith.length > 0) {
+            this.#endsWith = props.endsWith;
+        }
+        if (props.matches instanceof RegExp) {
+            this.#matches = props.matches;
+        }
     }
     introspect() {
         return {
@@ -90,6 +104,18 @@ export class StringSchemaBuilder extends SchemaBuilder {
              * If set, restrict object to be equal to a certain value.
              */
             equalsTo: this.#equalsTo,
+            /**
+             * If set, restrict string to start with a certain value.
+             */
+            startsWith: this.#startsWith,
+            /**
+             * If set, restrict string to end with a certain value.
+             */
+            endsWith: this.#endsWith,
+            /**
+             * If set, restrict string to match a certain regular expression.
+             */
+            matches: this.#matches,
             /**
              * Array of preprocessor functions
              */
@@ -161,6 +187,32 @@ export class StringSchemaBuilder extends SchemaBuilder {
                 ]
             };
         }
+        if (typeof this.#startsWith === 'string' &&
+            this.#startsWith.length > 0 &&
+            !objToValidate.startsWith(this.#startsWith)) {
+            return {
+                valid: false,
+                errors: [
+                    {
+                        message: `is expected to start with '${this.#startsWith}'`,
+                        path: path
+                    }
+                ]
+            };
+        }
+        if (typeof this.#endsWith === 'string' &&
+            this.#endsWith.length > 0 &&
+            !objToValidate.endsWith(this.#endsWith)) {
+            return {
+                valid: false,
+                errors: [
+                    {
+                        message: `is expected to end with '${this.#endsWith}'`,
+                        path: path
+                    }
+                ]
+            };
+        }
         if (typeof this.#minLength !== 'undefined') {
             if (objToValidate.length < this.#minLength)
                 return {
@@ -185,6 +237,19 @@ export class StringSchemaBuilder extends SchemaBuilder {
                     ]
                 };
         }
+        if (this.#matches instanceof RegExp) {
+            if (!this.#matches.test(objToValidate)) {
+                return {
+                    valid: false,
+                    errors: [
+                        {
+                            message: `does not match to ${this.#matches}`,
+                            path: path
+                        }
+                    ]
+                };
+            }
+        }
         return {
             valid: true,
             object: objToValidate
@@ -269,6 +334,69 @@ export class StringSchemaBuilder extends SchemaBuilder {
             ...schema
         });
     }
+    /**
+     * Restricts string to start with `val`.
+     */
+    startsWith(val) {
+        if (typeof val !== 'string' || !val)
+            throw new Error('non empty string expected');
+        return this.createFromProps({
+            ...this.introspect(),
+            startsWith: val
+        });
+    }
+    /**
+     * Cancels `startsWith()` call.
+     */
+    clearStartsWith() {
+        const schema = this.introspect();
+        delete schema.startsWith;
+        return this.createFromProps({
+            ...schema
+        });
+    }
+    /**
+     * Restricts string to end with `val`.
+     */
+    endsWith(val) {
+        if (typeof val !== 'string' || !val)
+            throw new Error('non empty string expected');
+        return this.createFromProps({
+            ...this.introspect(),
+            endsWith: val
+        });
+    }
+    /**
+     * Cancels `endsWith()` call.
+     */
+    clearEndsWith() {
+        const schema = this.introspect();
+        delete schema.endsWith;
+        return this.createFromProps({
+            ...schema
+        });
+    }
+    /**
+     * Restricts string to match `regexp`.
+     */
+    matches(regexp) {
+        if (!(regexp instanceof RegExp))
+            throw new Error('regexp expected');
+        return this.createFromProps({
+            ...this.introspect(),
+            matches: regexp
+        });
+    }
+    /**
+     * Cancels `matches()` call.
+     */
+    clearMatches() {
+        const schema = this.introspect();
+        delete schema.matches;
+        return this.createFromProps({
+            ...schema
+        });
+    }
 }
 /**
  * Creates a string schema.

package/package.json

@@ -35,8 +35,8 @@
         "displayName": "Schema Definition And Validation",
         "tsconfig": "./tsconfig.json"
     },
-    "version": "1.1.2",
+    "version": "1.1.4",
     "devDependencies": {
-        "@cleverbrush/deep": "1.1.2"
+        "@cleverbrush/deep": "1.1.4"
     }
 }