@carecard/validate 3.0.4 → 3.0.5

package/index.d.ts

@@ -1,68 +1,96 @@
 /**
- * Utility functions for validating various types of strings and values.
+ * Utility function to validate multiple properties of an object at once.
  */
-export const validate: {
-  /** Checks if the string is a valid image URL format. */
-  isImageUrl: (imageUrl: any) => boolean;
-  /** Checks if the value is an integer. */
-  isInteger: (number: any) => boolean;
-  /** Checks if the string is a valid JSON string and can be parsed into an object. */
-  isValidJsonString: (str: any) => boolean;
-  /** Checks if the string represents a valid integer. */
-  isValidIntegerString: (str: any) => boolean;
-  /** Checks if the string is a valid UUID. */
-  isValidUuidString: (str: any) => boolean;
-  /** Checks if the string contains only alphanumeric characters, spaces, underscores, or hyphens. */
-  isCharactersString: (str: any) => boolean;
-  /** Checks if the string is a valid name format. */
-  isNameString: (str: any) => boolean;
-  /** Checks if the string is safe for search queries. */
-  isSafeSearchString: (str: any) => boolean;
-  /** Checks if the string is a valid email address. */
-  isEmailString: (email: any) => boolean;
-  /** Checks if the string is a valid JWT format. */
-  isJwtString: (jwt: any) => boolean;
-  /** Checks if the string is a valid strong password. */
-  isPasswordString: (password: any) => boolean;
-  /** Checks if the string is a valid simple password. */
-  isSimplePasswordString: (password: any) => boolean;
-  /** Returns a failure message if the password is not strong enough. */
-  isPasswordStringFailureMessage: (password: any) => string | null;
-  /** Returns a failure message if the password is not valid as a simple password. */
-  isSimplePasswordStringFailureMessage: (password: any) => string | null;
-  /** Checks if the string is a valid username. */
-  isUsernameString: (str: any) => boolean;
-  /** Checks if the string is a valid phone number. */
-  isPhoneNumber: (str: any) => boolean;
-  /** Checks if the string is URL-safe. */
-  isUrlSafeString: (inputString: any) => boolean;
-  /** Checks if the string length is between 6 and 24 characters. */
-  isString6To24CharacterLong: (password: any) => boolean;
-  /** Checks if the string length is between 6 and 16 characters. */
-  isString6To16CharacterLong: (password: any) => boolean;
-  /** Checks if the string is a valid Canadian province abbreviation (ON, QC). */
-  isProvinceString: (inputString: any) => boolean;
-  /** Checks if the value is a boolean. */
-  isBoolValue: (inputValue: any) => boolean;
-  /** Checks if the string is a valid Canadian postal code. */
-  isPostalCodeString: (inputString: any) => boolean;
-  /** Checks if the string contains only allowed "safe" characters. */
-  isSafeString: (str: any) => boolean;
-  /** Checks if a string exists within a given array of strings (case-insensitive). */
-  isInStringArray: (StringArray: string[], inputString: any) => boolean;
-  /** Checks if the string is a valid country code (e.g., +1). */
-  isCountryCodeString: (str: any) => boolean;
-  /** Checks if the string is a valid domain name. */
-  isValidDomainName: (domain: any) => boolean;
-  /** Checks if the string is a valid ISO 8601 timestamp with time zone. */
-  isValidTimestampzString: (str: any) => boolean;
-  /** Checks if the string is a valid ISO 8601 timestamp without time zone. */
-  isValidTimestampString: (str: any) => boolean;
-};
+export function validateProperties(obj?: Record<string, any>): Record<string, any>;
+
+/** Checks if the string is a valid image URL format. */
+export function isImageUrl(imageUrl: any): boolean;
+/** Checks if the value is an integer. */
+export function isInteger(number: any): boolean;
+/** Checks if the string is a valid JSON string and can be parsed into an object. */
+export function isValidJsonString(str: any): boolean;
+/** Checks if the string represents a valid integer. */
+export function isValidIntegerString(str: any): boolean;
+/** Checks if the string is a valid UUID. */
+export function isValidUuidString(str: any): boolean;
+/** Checks if the string contains only alphanumeric characters, spaces, underscores, or hyphens. */
+export function isCharactersString(str: any): boolean;
+/** Checks if the string is a valid name format. */
+export function isNameString(str: any): boolean;
+/** Checks if the string is safe for search queries. */
+export function isSafeSearchString(str: any): boolean;
+/** Checks if the string is a valid email address. */
+export function isEmailString(email: any): boolean;
+/** Checks if the string is a valid JWT format. */
+export function isJwtString(jwt: any): boolean;
+/** Checks if the string is a valid strong password. */
+export function isPasswordString(password: any): boolean;
+/** Checks if the string is a valid simple password. */
+export function isSimplePasswordString(password: any): boolean;
+/** Returns a failure message if the password is not strong enough. */
+export function isPasswordStringFailureMessage(password: any): string | null;
+/** Returns a failure message if the password is not valid as a simple password. */
+export function isSimplePasswordStringFailureMessage(password: any): string | null;
+/** Checks if the string is a valid username. */
+export function isUsernameString(str: any): boolean;
+/** Checks if the string is a valid phone number. */
+export function isPhoneNumber(str: any): boolean;
+/** Checks if the string is URL-safe. */
+export function isUrlSafeString(inputString: any): boolean;
+/** Checks if the string length is between 6 and 24 characters. */
+export function isString6To24CharacterLong(password: any): boolean;
+/** Checks if the string length is between 6 and 16 characters. */
+export function isString6To16CharacterLong(password: any): boolean;
+/** Checks if the string is a valid Canadian province abbreviation (ON, QC). */
+export function isProvinceString(inputString: any): boolean;
+/** Checks if the value is a boolean. */
+export function isBoolValue(inputValue: any): boolean;
+/** Checks if the string is a valid Canadian postal code. */
+export function isPostalCodeString(inputString: any): boolean;
+/** Checks if the string contains only allowed "safe" characters. */
+export function isSafeString(str: any): boolean;
+/** Checks if a string exists within a given array of strings (case-insensitive). */
+export function isInStringArray(StringArray: string[], inputString: any): boolean;
+/** Checks if the string is a valid country code (e.g., +1). */
+export function isCountryCodeString(str: any): boolean;
+/** Checks if the string is a valid domain name. */
+export function isValidDomainName(domain: any): boolean;
+/** Checks if the string is a valid ISO 8601 timestamp with time zone. */
+export function isValidTimestampzString(str: any): boolean;
+/** Checks if the string is a valid ISO 8601 timestamp without time zone. */
+export function isValidTimestampString(str: any): boolean;
 
 /**
- * Utility function to validate multiple properties of an object at once.
+ * Utility functions for validating various types of strings and values.
+ * @deprecated Use direct imports instead.
  */
-export const validateProperties: {
-  validateProperties: (obj?: Record<string, any>) => Record<string, any>;
+export const validate: {
+  isImageUrl: typeof isImageUrl;
+  isInteger: typeof isInteger;
+  isValidJsonString: typeof isValidJsonString;
+  isValidIntegerString: typeof isValidIntegerString;
+  isValidUuidString: typeof isValidUuidString;
+  isCharactersString: typeof isCharactersString;
+  isNameString: typeof isNameString;
+  isSafeSearchString: typeof isSafeSearchString;
+  isEmailString: typeof isEmailString;
+  isJwtString: typeof isJwtString;
+  isPasswordString: typeof isPasswordString;
+  isSimplePasswordString: typeof isSimplePasswordString;
+  isPasswordStringFailureMessage: typeof isPasswordStringFailureMessage;
+  isSimplePasswordStringFailureMessage: typeof isSimplePasswordStringFailureMessage;
+  isUsernameString: typeof isUsernameString;
+  isPhoneNumber: typeof isPhoneNumber;
+  isUrlSafeString: typeof isUrlSafeString;
+  isString6To24CharacterLong: typeof isString6To24CharacterLong;
+  isString6To16CharacterLong: typeof isString6To16CharacterLong;
+  isProvinceString: typeof isProvinceString;
+  isBoolValue: typeof isBoolValue;
+  isPostalCodeString: typeof isPostalCodeString;
+  isSafeString: typeof isSafeString;
+  isInStringArray: typeof isInStringArray;
+  isCountryCodeString: typeof isCountryCodeString;
+  isValidDomainName: typeof isValidDomainName;
+  isValidTimestampzString: typeof isValidTimestampzString;
+  isValidTimestampString: typeof isValidTimestampString;
 };

package/index.js

@@ -1,4 +1,9 @@
+const validate = require( './lib/validate' );
+const validateProperties = require( './lib/validateProperties' );
+
 module.exports = {
-    validate: require( './lib/validate' ),
-    validateProperties: require( './lib/validateProperties' )
+    validate,
+    validateProperties,
+    ...validate,
+    ...validateProperties
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carecard/validate",
-  "version": "3.0.4",
+  "version": "3.0.5",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/CareCard-ca/pkg-validate.git"