@availity/yup 5.1.2 → 5.1.3

package/CHANGELOG.md

@@ -2,6 +2,57 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [5.1.3](https://github.com/Availity/sdk-js/compare/@availity/yup@5.1.2...@availity/yup@5.1.3) (2023-08-23)
+
+
+
+# 1.0.0 (2023-08-23)
+
+
+### Bug Fixes
+
+* add browser field for output ([0ce7170](https://github.com/Availity/sdk-js/commit/0ce717075a82675b8707e4db0cc07cd4af370f3d))
+* **yup:** avDate fix for edge case invalid date length ([55f8b78](https://github.com/Availity/sdk-js/commit/55f8b781595a1f5aa610d63da53c4ffe3c7710e4))
+* **yup:** avDate fix handles undefined correctly now ([85d25b7](https://github.com/Availity/sdk-js/commit/85d25b751b340273de8396abc310e5a27934376c))
+* **yup:** avDate.typeError should not display for empty fields ([8bf47fb](https://github.com/Availity/sdk-js/commit/8bf47fb3a64f5b956b8ce0d4b27dbac46e08c864))
+* **yup:** conditional logic fix ([3679957](https://github.com/Availity/sdk-js/commit/36799574f86674e1a41228c10bfba8d303958e02))
+* **yup:** fix issue with exports not being found if yup and @availity/yup not imported in right order ([fa24f1d](https://github.com/Availity/sdk-js/commit/fa24f1d6f43bcf1371ca7b0613cacc2f3a0d3b01))
+* **yup:** fixed bug in daterange causing to validate improperly ([5e90f3e](https://github.com/Availity/sdk-js/commit/5e90f3e8cd25c8aaebfbbf4b03868c3f1e77ecbe))
+* **yup:** fixes duplicate name key preventing some validation tests for running, changes wording of validation messages ([ef144eb](https://github.com/Availity/sdk-js/commit/ef144eb972f821dc2c180ee74e7f9b5a0ae019bc))
+* **yup:** fixes start date before end date logic ([6cc0ff7](https://github.com/Availity/sdk-js/commit/6cc0ff736358bc5aaf738a84d8abb258e85f57f4))
+* **yup:** fixes type resolution bug where internal yup.date was no longer being overridden ([01ba375](https://github.com/Availity/sdk-js/commit/01ba3752455b98ebd701d5cfddeb4ab79af3c1a3))
+* **yup:** fixes unhandled error for when value === undefined in avDate().between() validation ([d779f59](https://github.com/Availity/sdk-js/commit/d779f591cadeba3184faec13034e7b12a66d697a))
+* **yup:** package change for major version update ([9ad040f](https://github.com/Availity/sdk-js/commit/9ad040ff7a4f7cbe7d5fdd37932d953287db805c)), closes [/github.com/jquense/yup/blob/375f1b9ed41f5043e123ea87a01a2dfe333c3927/CHANGELOG.md#0320-2020-12-03](https://github.com//github.com/jquense/yup/blob/375f1b9ed41f5043e123ea87a01a2dfe333c3927/CHANGELOG.md/issues/0320-2020-12-03)
+* **yup:** refactor typeError, use _typeCheck ([24cea5e](https://github.com/Availity/sdk-js/commit/24cea5e2140d72ecec169dfde9fd94eb18956e66))
+
+
+* build!: switch from lerna to nx and compile to esm with tsup ([c586085](https://github.com/Availity/sdk-js/commit/c5860856ca96b743a0653d335ea00f0889132f7f))
+
+
+### Features
+
+* add npi method ([b1ac1a2](https://github.com/Availity/sdk-js/commit/b1ac1a258b32a74d7cce409304660a08089ddc46))
+* **yup:** add phone validation schema ([98c3e29](https://github.com/Availity/sdk-js/commit/98c3e2968efe5f852872fda72839bda28dc7e38c))
+* **yup:** add type definitions for phone schema ([319ca88](https://github.com/Availity/sdk-js/commit/319ca884a9fdd400c3983f751199263487dda8f6))
+* **yup:** added yup validation library methods ([690f0c7](https://github.com/Availity/sdk-js/commit/690f0c7940748025a0d2c935fd4b8cbf81b29c28))
+* **yup:** allow custom type error message for dateRange ([cc36cde](https://github.com/Availity/sdk-js/commit/cc36cde7d403f9787343fcecbf1d0fd9d8ac6bf7))
+* **yup:** convert to ts and fix undefined class property ([f5a3a4f](https://github.com/Availity/sdk-js/commit/f5a3a4f944a0ae281e0eaabf3b6a38659a2acc71))
+* **yup:** support inclusivity option ([94b1283](https://github.com/Availity/sdk-js/commit/94b1283c29e00f0db49ea58ae62d1cf16beef678))
+* **yup:** switch to lodash from merge-options-es5 ([06456c9](https://github.com/Availity/sdk-js/commit/06456c90ac6ef7523c4ed0d2e4dc9af8c4a6dee5))
+* **yup:** unit test for inclusivity ([25bf64b](https://github.com/Availity/sdk-js/commit/25bf64bd1fbd9b03ff609d8b8614ce40b7a4f4be))
+* **yup:** update how accepted formats are handled for dates ([91006e5](https://github.com/Availity/sdk-js/commit/91006e564766e2bb66cdabc24dd2cdd69bc8b150))
+
+
+### BREAKING CHANGES
+
+* Drop Internet Explorer support
+* **yup:** the version of yup this package requires contains breaking changes from 0.32.0 onward
+* **yup:** avDate and dateRange should now be imported directly from @availity/yup, eliminating the need for a 'magic' import from moment.js that depends on import order
+* **yup:** Fixes TypeError: Cannot set property date of #<Object> by renaming 'date' and 'DateSchema' to 'avDa
+te' and 'AvDateSchema'.
+
+
+
 ## [5.1.2](https://github.com/Availity/sdk-js/compare/@availity/yup@5.1.1...@availity/yup@5.1.2) (2022-06-15)
 
 

package/dist/index.d.mts

@@ -0,0 +1,116 @@
+import { Maybe, AnyObject, Optionals } from 'yup/lib/types';
+import BaseSchema, { AnySchema } from 'yup/lib/schema';
+import { TypeOf, Asserts } from 'yup/lib/util/types';
+import { ObjectShape, TypeOfShape, AssertsShape } from 'yup/lib/object';
+import Lazy from 'yup/lib/Lazy';
+import { MixedSchema } from 'yup';
+import moment, { Moment, unitOfTime } from 'moment';
+
+declare class MomentDateSchema extends MixedSchema<Moment> {
+    _validFormats: string[];
+    constructor({ format, typeError }?: Options$1);
+    _typeCheck(value: unknown): value is Moment;
+    /**
+     * Validate if the date is on or after a specified min
+     */
+    min(min: string, message?: string): this;
+    /**
+     * Validate if the date is on or before a specified max
+     */
+    max(max: string, message?: string): this;
+    /**
+     * Validate if the date is between a specified min or max
+     *
+     * For Inlcusivity: `[]` === include & `()` === exclude
+     */
+    between(min: string, max: string, message?: string, inclusivity?: Inclusivity): this;
+    /**
+     * Set if the field is required and add a custom message
+     */
+    isRequired(isRequired?: boolean, message?: string): this;
+}
+type Inclusivity = '()' | '[)' | '(]' | '[]';
+type Options$1 = {
+    format?: string | string[];
+    typeError?: string;
+};
+declare const avDate: (options?: Options$1) => MomentDateSchema;
+
+declare class DateRangeSchema extends MixedSchema<DateRange> {
+    startKey: string;
+    endKey: string;
+    format: string;
+    constructor(options?: Options);
+    /**
+     * Convert the string to a moment object
+     */
+    getValidDate(value: string | Date | Moment): moment.Moment;
+    /**
+     * Validate based on min and max distance between dates
+     */
+    distance({ min: { value: minValue, units: minUnits, errorMessage: minErrorMessage }, max: { value: maxValue, units: maxUnits, errorMessage: maxErrorMessage }, }?: DistanceOptions): this;
+    /**
+     * Validate start date is after given min
+     */
+    min(min: string, message?: string): this;
+    /**
+     * Validate end date is before given max
+     */
+    max(max: string, message?: string): this;
+    /**
+     * Validate dates are between the set min and max
+     */
+    between(min: string, max: string, message?: string): this;
+    /**
+     * Set the field to be required or not
+     */
+    isRequired(isRequired?: boolean, msg?: string): this;
+    typeError({ message }: {
+        message: string;
+    }): this;
+    _typeCheck(range?: {
+        startDate?: Moment;
+        endDate?: Moment;
+    }): range is DateRange;
+}
+type Options = {
+    startKey?: string;
+    endKey?: string;
+    format?: string;
+};
+type DateRange = {
+    startDate?: Moment;
+    endDate?: Moment;
+    supportedFormats?: string[];
+};
+type DistanceValue = {
+    value: number;
+    units?: unitOfTime.DurationConstructor;
+    errorMessage?: string;
+};
+type DistanceOptions = {
+    min?: DistanceValue;
+    max?: DistanceValue;
+};
+declare const dateRange: (opts?: Options) => DateRangeSchema;
+
+declare module 'yup' {
+    interface StringSchema<TType extends Maybe<string> = string | undefined, TContext extends AnyObject = AnyObject, TOut extends TType = TType> extends BaseSchema<TType, TContext, TOut> {
+        isRequired(required?: boolean, errorMessage?: string): StringSchema<TType, TContext>;
+        npi(errorMessage?: string): StringSchema<TType, TContext>;
+        phone(errorMessage?: string): StringSchema<TType, TContext>;
+    }
+    interface NumberSchema<TType extends Maybe<number> = number | undefined, TContext extends AnyObject = AnyObject, TOut extends TType = TType> extends BaseSchema<TType, TContext, TOut> {
+        isRequired(required?: boolean, errorMessage?: string): NumberSchema<TType, TContext, TOut>;
+        npi(errorMessage?: string): NumberSchema<TType, TContext, TOut>;
+        phone(errorMessage?: string): NumberSchema<TType, TContext, TOut>;
+    }
+    interface ArraySchema<T extends AnySchema | Lazy<any, any>, C extends AnyObject = AnyObject, TIn extends Maybe<TypeOf<T>[]> = TypeOf<T>[] | undefined, TOut extends Maybe<Asserts<T>[]> = Asserts<T>[] | Optionals<TIn>> extends BaseSchema<TIn, C, TOut> {
+        isRequired(required?: boolean, errorMessage?: string): ArraySchema<T, C, TIn, TOut>;
+    }
+    interface ObjectSchema<TShape extends ObjectShape, TContext extends AnyObject = AnyObject, TIn extends Maybe<TypeOfShape<TShape>> = TypeOfShape<TShape>, TOut extends Maybe<AssertsShape<TShape>> = AssertsShape<TShape> | Optionals<TIn>> extends BaseSchema<TIn, TContext, TOut> {
+        isRequired(required?: boolean, errorMessage?: string): ObjectSchema<TShape, TContext, TIn, TOut>;
+    }
+}
+
+export { avDate, dateRange };

package/dist/index.d.ts

@@ -29,12 +29,12 @@ declare class MomentDateSchema extends MixedSchema<Moment> {
      */
     isRequired(isRequired?: boolean, message?: string): this;
 }
-declare type Inclusivity = '()' | '[)' | '(]' | '[]';
-declare type Options$1 = {
+type Inclusivity = '()' | '[)' | '(]' | '[]';
+type Options$1 = {
     format?: string | string[];
     typeError?: string;
 };
-declare const avDate: (options?: Options$1 | undefined) => MomentDateSchema;
+declare const avDate: (options?: Options$1) => MomentDateSchema;
 
 declare class DateRangeSchema extends MixedSchema<DateRange> {
     startKey: string;
@@ -73,26 +73,26 @@ declare class DateRangeSchema extends MixedSchema<DateRange> {
         endDate?: Moment;
     }): range is DateRange;
 }
-declare type Options = {
+type Options = {
     startKey?: string;
     endKey?: string;
     format?: string;
 };
-declare type DateRange = {
+type DateRange = {
     startDate?: Moment;
     endDate?: Moment;
     supportedFormats?: string[];
 };
-declare type DistanceValue = {
+type DistanceValue = {
     value: number;
     units?: unitOfTime.DurationConstructor;
     errorMessage?: string;
 };
-declare type DistanceOptions = {
+type DistanceOptions = {
     min?: DistanceValue;
     max?: DistanceValue;
 };
-declare const dateRange: (opts?: Options | undefined) => DateRangeSchema;
+declare const dateRange: (opts?: Options) => DateRangeSchema;
 
 declare module 'yup' {
     interface StringSchema<TType extends Maybe<string> = string | undefined, TContext extends AnyObject = AnyObject, TOut extends TType = TType> extends BaseSchema<TType, TContext, TOut> {

package/dist/index.js

@@ -1,3 +1,4 @@
+"use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -16,7 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -47,9 +55,13 @@ var MomentDateSchema = class extends import_yup.MixedSchema {
       });
     });
   }
+  // Check if the date is a valid moment object or an empty string
   _typeCheck(value) {
     return import_moment.default.isMoment(value) && (value.isValid() || value._i === "");
   }
+  /**
+   * Validate if the date is on or after a specified min
+   */
   min(min, message) {
     return this.test({
       message: ({ min: minDate }) => message || `Date must be ${minDate} or later.`,
@@ -64,6 +76,9 @@ var MomentDateSchema = class extends import_yup.MixedSchema {
       }
     });
   }
+  /**
+   * Validate if the date is on or before a specified max
+   */
   max(max, message) {
     return this.test({
       message: ({ max: maxDate }) => message || `Date must be ${maxDate} or earlier.`,
@@ -78,6 +93,11 @@ var MomentDateSchema = class extends import_yup.MixedSchema {
       }
     });
   }
+  /**
+   * Validate if the date is between a specified min or max
+   *
+   * For Inlcusivity: `[]` === include & `()` === exclude
+   */
   between(min, max, message, inclusivity = "()") {
     return this.test({
       name: "between",
@@ -92,6 +112,9 @@ var MomentDateSchema = class extends import_yup.MixedSchema {
       }
     });
   }
+  /**
+   * Set if the field is required and add a custom message
+   */
   isRequired(isRequired2 = true, message) {
     return this.test({
       name: "isRequired",
@@ -140,9 +163,15 @@ var DateRangeSchema = class extends import_yup2.MixedSchema {
       });
     });
   }
+  /**
+   * Convert the string to a moment object
+   */
   getValidDate(value) {
     return (0, import_moment2.default)(value, [this.format, ...formats], true);
   }
+  /**
+   * Validate based on min and max distance between dates
+   */
   distance({
     min: { value: minValue, units: minUnits = "day", errorMessage: minErrorMessage } = { value: 0 },
     max: { value: maxValue, units: maxUnits = "day", errorMessage: maxErrorMessage } = { value: 0 }
@@ -154,18 +183,29 @@ var DateRangeSchema = class extends import_yup2.MixedSchema {
         if (!minValue && !maxValue || !startDate || !endDate)
           return true;
         if (maxValue && endDate.isAfter(startDate.add(maxValue, maxUnits), "day")) {
-          return new import_yup2.ValidationError(maxErrorMessage || `The end date must be within ${maxValue} ${maxUnits}${maxValue > 1 ? "s" : ""} of the start date`, {
-            startDate,
-            endDate
-          }, this.path);
+          return new import_yup2.ValidationError(
+            maxErrorMessage || `The end date must be within ${maxValue} ${maxUnits}${maxValue > 1 ? "s" : ""} of the start date`,
+            {
+              startDate,
+              endDate
+            },
+            this.path
+          );
         }
         if (minValue && endDate.isBefore(startDate.add(minValue, minUnits), "day")) {
-          return new import_yup2.ValidationError(minErrorMessage || `The end date must be greater than ${minValue} ${minUnits}${minValue > 1 ? "s" : ""} of the start date`, { startDate, endDate }, this.path);
+          return new import_yup2.ValidationError(
+            minErrorMessage || `The end date must be greater than ${minValue} ${minUnits}${minValue > 1 ? "s" : ""} of the start date`,
+            { startDate, endDate },
+            this.path
+          );
         }
         return true;
       }
     });
   }
+  /**
+   * Validate start date is after given min
+   */
   min(min, message) {
     return this.test({
       message: message || (({ min: min2 }) => `Date Range must start on or after ${min2}`),
@@ -180,6 +220,9 @@ var DateRangeSchema = class extends import_yup2.MixedSchema {
       }
     });
   }
+  /**
+   * Validate end date is before given max
+   */
   max(max, message) {
     return this.test({
       message: message || (({ max: max2 }) => `Date Range must end on or before ${max2}`),
@@ -194,6 +237,9 @@ var DateRangeSchema = class extends import_yup2.MixedSchema {
       }
     });
   }
+  /**
+   * Validate dates are between the set min and max
+   */
   between(min, max, message) {
     return this.test({
       message: message || (({ min: min2, max: max2 }) => `Date Range must be between ${min2} and ${max2}`),
@@ -209,6 +255,9 @@ var DateRangeSchema = class extends import_yup2.MixedSchema {
       }
     });
   }
+  /**
+   * Set the field to be required or not
+   */
   isRequired(isRequired2 = true, msg) {
     return this.test({
       name: "isRequired",

package/dist/index.mjs

@@ -20,9 +20,13 @@ var MomentDateSchema = class extends MixedSchema {
       });
     });
   }
+  // Check if the date is a valid moment object or an empty string
   _typeCheck(value) {
     return moment.isMoment(value) && (value.isValid() || value._i === "");
   }
+  /**
+   * Validate if the date is on or after a specified min
+   */
   min(min, message) {
     return this.test({
       message: ({ min: minDate }) => message || `Date must be ${minDate} or later.`,
@@ -37,6 +41,9 @@ var MomentDateSchema = class extends MixedSchema {
       }
     });
   }
+  /**
+   * Validate if the date is on or before a specified max
+   */
   max(max, message) {
     return this.test({
       message: ({ max: maxDate }) => message || `Date must be ${maxDate} or earlier.`,
@@ -51,6 +58,11 @@ var MomentDateSchema = class extends MixedSchema {
       }
     });
   }
+  /**
+   * Validate if the date is between a specified min or max
+   *
+   * For Inlcusivity: `[]` === include & `()` === exclude
+   */
   between(min, max, message, inclusivity = "()") {
     return this.test({
       name: "between",
@@ -65,6 +77,9 @@ var MomentDateSchema = class extends MixedSchema {
       }
     });
   }
+  /**
+   * Set if the field is required and add a custom message
+   */
   isRequired(isRequired2 = true, message) {
     return this.test({
       name: "isRequired",
@@ -113,9 +128,15 @@ var DateRangeSchema = class extends MixedSchema2 {
       });
     });
   }
+  /**
+   * Convert the string to a moment object
+   */
   getValidDate(value) {
     return moment2(value, [this.format, ...formats], true);
   }
+  /**
+   * Validate based on min and max distance between dates
+   */
   distance({
     min: { value: minValue, units: minUnits = "day", errorMessage: minErrorMessage } = { value: 0 },
     max: { value: maxValue, units: maxUnits = "day", errorMessage: maxErrorMessage } = { value: 0 }
@@ -127,18 +148,29 @@ var DateRangeSchema = class extends MixedSchema2 {
         if (!minValue && !maxValue || !startDate || !endDate)
           return true;
         if (maxValue && endDate.isAfter(startDate.add(maxValue, maxUnits), "day")) {
-          return new ValidationError(maxErrorMessage || `The end date must be within ${maxValue} ${maxUnits}${maxValue > 1 ? "s" : ""} of the start date`, {
-            startDate,
-            endDate
-          }, this.path);
+          return new ValidationError(
+            maxErrorMessage || `The end date must be within ${maxValue} ${maxUnits}${maxValue > 1 ? "s" : ""} of the start date`,
+            {
+              startDate,
+              endDate
+            },
+            this.path
+          );
         }
         if (minValue && endDate.isBefore(startDate.add(minValue, minUnits), "day")) {
-          return new ValidationError(minErrorMessage || `The end date must be greater than ${minValue} ${minUnits}${minValue > 1 ? "s" : ""} of the start date`, { startDate, endDate }, this.path);
+          return new ValidationError(
+            minErrorMessage || `The end date must be greater than ${minValue} ${minUnits}${minValue > 1 ? "s" : ""} of the start date`,
+            { startDate, endDate },
+            this.path
+          );
         }
         return true;
       }
     });
   }
+  /**
+   * Validate start date is after given min
+   */
   min(min, message) {
     return this.test({
       message: message || (({ min: min2 }) => `Date Range must start on or after ${min2}`),
@@ -153,6 +185,9 @@ var DateRangeSchema = class extends MixedSchema2 {
       }
     });
   }
+  /**
+   * Validate end date is before given max
+   */
   max(max, message) {
     return this.test({
       message: message || (({ max: max2 }) => `Date Range must end on or before ${max2}`),
@@ -167,6 +202,9 @@ var DateRangeSchema = class extends MixedSchema2 {
       }
     });
   }
+  /**
+   * Validate dates are between the set min and max
+   */
   between(min, max, message) {
     return this.test({
       message: message || (({ min: min2, max: max2 }) => `Date Range must be between ${min2} and ${max2}`),
@@ -182,6 +220,9 @@ var DateRangeSchema = class extends MixedSchema2 {
       }
     });
   }
+  /**
+   * Set the field to be required or not
+   */
   isRequired(isRequired2 = true, msg) {
     return this.test({
       name: "isRequired",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@availity/yup",
-  "version": "5.1.2",
+  "version": "5.1.3",
   "description": "Additional methods for yup validation library",
   "keywords": [
     "yup",
@@ -33,12 +33,12 @@
   },
   "dependencies": {
     "lodash": "^4.17.21",
-    "yup": "^0.32.0"
+    "yup": "^0.32.11"
   },
   "devDependencies": {
-    "moment": "^2.24.0",
-    "tsup": "^5.12.8",
-    "typescript": "^4.6.4"
+    "moment": "^2.29.4",
+    "tsup": "^7.2.0",
+    "typescript": "^5.1.6"
   },
   "peerDependencies": {
     "moment": "^2.24.0"

package/project.json

@@ -3,7 +3,7 @@
   "projectType": "library",
   "targets": {
     "test": {
-      "executor": "@nrwl/jest:jest",
+      "executor": "@nx/jest:jest",
       "outputs": ["coverage/yup"],
       "options": {
         "jestConfig": "packages/yup/jest.config.js",
@@ -14,13 +14,13 @@
       "executor": "@jscutlery/semver:version",
       "options": {
         "preset": "angular",
-        "commitMessageFormat": "chore(${projectName}): release version ${version} [skip ci]",
-        "tagPrefix": "@availity/${projectName}@",
+        "commitMessageFormat": "chore({projectName}): release version ${version} [skip ci]",
+        "tagPrefix": "@availity/{projectName}@",
         "baseBranch": "master"
       }
     },
     "lint": {
-      "executor": "@nrwl/linter:eslint",
+      "executor": "@nx/linter:eslint",
       "options": {
         "eslintConfig": ".eslintrc.yaml",
         "lintFilePatterns": ["packages/yup/**/*.{js,ts}"],