@carecard/validate 3.17.0 → 3.19.0

package/index.d.ts

@@ -20,94 +20,95 @@ export type ValidateWhitelistFlattenKeyStyle = 'path' | 'leaf';
  * Options for {@link validateWhitelistProperties}.
  */
 export interface ValidateWhitelistPropertiesOptions {
-    /** Properties allowed in the input but not required. */
-    optionalProperties?: readonly string[] | null;
-    /** When true, the returned object's keys are converted to snake_case. */
-    convertToSnakeCase?: boolean;
-    /**
-     * When true, the returned object is flattened so that every validated leaf
-     * becomes a top-level key. No nested objects remain in the output. Applied
-     * after snake_case conversion.
-     */
-    flattenOutput?: boolean;
-    /**
-     * Controls flattened key naming when `flattenOutput` is true.
-     * - `path` uses full dot-notation paths, e.g. `{ "user.email": "Jane" }`.
-     * - `leaf` uses only leaf names, e.g. `{ email: "Jane" }`.
-     *
-     * Defaults to `path`.
-     */
-    flattenKeyStyle?: ValidateWhitelistFlattenKeyStyle;
+  /** Properties allowed in the input but not required. */
+  optionalProperties?: readonly string[] | null;
+  /** When true, the returned object's keys are converted to snake_case. */
+  convertToSnakeCase?: boolean;
+  /**
+   * When true, the returned object is flattened so that every validated leaf
+   * becomes a top-level key. No nested objects remain in the output. Applied
+   * after snake_case conversion.
+   */
+  flattenOutput?: boolean;
+  /**
+   * Controls flattened key naming when `flattenOutput` is true.
+   * - `path` uses full dot-notation paths, e.g. `{ "user.email": "Jane" }`.
+   * - `leaf` uses only leaf names, e.g. `{ email: "Jane" }`.
+   *
+   * Defaults to `path`.
+   */
+  flattenKeyStyle?: ValidateWhitelistFlattenKeyStyle;
 }
 
 export interface ValidateWhitelistPropertiesFunction {
-    /**
-     * Validates and transforms whitelisted properties from an input object.
-     *
-     * - Supports nested objects via dot-notation paths (e.g. `"address.city"`),
-     *   up to 5 levels deep. The function checks that each path resolves to an
-     *   existing leaf property and validates the leaf value by its leaf segment.
-     * - Extracts only the whitelisted (required + optional) leaf properties and
-     *   rebuilds the same nested shape in the result.
-     * - Validates values via {@link validateProperties}.
-     * - Throws a "Bad_Input" error when any required property is missing/invalid,
-     *   when a provided optional property has an invalid value, when a path
-     *   exceeds 5 levels of nesting, or when the combined count of
-     *   `requiredProperties` and `options.optionalProperties` exceeds 5000.
-     * - Array values are supported: if a leaf value is an array, the per-leaf
-     *   validator is applied to each element. The leaf is accepted only when every
-     *   element passes validation, and the returned value is an array of the
-     *   validated elements.
-     * - Optionally converts the resulting keys, including nested keys, to snake_case.
-     * - Optionally flattens the result after snake_case conversion.
-     *
-     * @param inputObject The input object, for example `req.body` or `req.params`.
-     * @param requiredProperties Leaf paths that must be present and valid. Dot notation is supported.
-     * @param options Optional additional leaf paths plus output transformation flags.
-     */
-    (
-        inputObject?: ValidatePropertiesInput,
-        requiredProperties?: readonly string[] | null,
-        options?: ValidateWhitelistPropertiesOptions | null,
-    ): Promise<ValidatePropertiesResult>;
-    validateWhitelistProperties: ValidateWhitelistPropertiesFunction;
-    MAX_NESTING_DEPTH: 5;
-    MAX_KEYS_PER_CALL: 5000;
+  /**
+   * Validates and transforms whitelisted properties from an input object.
+   *
+   * - Supports nested objects via dot-notation paths (e.g. `"address.city"`),
+   *   up to 5 levels deep. The function checks that each path resolves to an
+   *   existing leaf property and validates the leaf value by its leaf segment.
+   * - Extracts only the whitelisted (required + optional) leaf properties and
+   *   rebuilds the same nested shape in the result.
+   * - Validates values via {@link validateProperties}.
+   * - Throws a "Bad_Input" error when any required property is missing/invalid,
+   *   when a provided optional property has an invalid value, when a path
+   *   exceeds 5 levels of nesting, or when the combined count of
+   *   `requiredProperties` and `options.optionalProperties` exceeds 5000.
+   * - Array values are supported: if a leaf value is an array, the per-leaf
+   *   validator is applied to each element. The leaf is accepted only when every
+   *   element passes validation, and the returned value is an array of the
+   *   validated elements.
+   * - Optionally converts the resulting keys, including nested keys, to snake_case.
+   * - Optionally flattens the result after snake_case conversion.
+   *
+   * @param inputObject The input object, for example `req.body` or `req.params`.
+   * @param requiredProperties Leaf paths that must be present and valid. Dot notation is supported.
+   * @param options Optional additional leaf paths plus output transformation flags.
+   */
+  (
+    inputObject?: ValidatePropertiesInput,
+    requiredProperties?: readonly string[] | null,
+    options?: ValidateWhitelistPropertiesOptions | null,
+  ): Promise<ValidatePropertiesResult>;
+  validateWhitelistProperties: ValidateWhitelistPropertiesFunction;
+  MAX_NESTING_DEPTH: 5;
+  MAX_KEYS_PER_CALL: 5000;
 }
 
 export const validateWhitelistProperties: ValidateWhitelistPropertiesFunction;
 
 export type UserRoleRequestRole = 'student' | 'intern' | 'volunteer';
-export type UserRoleRequestScopeRequirement = boolean | typeof REQUIRE_SCOPE_WHEN_ROLE_OR_SCOPE_PRESENT;
+export type UserRoleRequestScopeRequirement =
+  boolean | typeof REQUIRE_SCOPE_WHEN_ROLE_OR_SCOPE_PRESENT;
 
 export const DEFAULT_USER_ROLE_REQUEST_ROLE: 'student';
 export const REQUIRE_SCOPE_WHEN_ROLE_OR_SCOPE_PRESENT: 'whenRoleOrScopePresent';
 
 export interface ValidateNewUserRoleRequestOptions {
-    defaultRole?: UserRoleRequestRole | undefined;
-    requireScope?: UserRoleRequestScopeRequirement;
+  defaultRole?: UserRoleRequestRole | undefined;
+  requireScope?: UserRoleRequestScopeRequirement;
 }
 
 export interface ValidateNewUserRoleRequestInput extends Record<string, unknown> {
-    role_name?: unknown;
-    roleName?: unknown;
-    role?: unknown;
-    institution_id?: unknown;
-    institutionId?: unknown;
-    campus_id?: unknown;
-    campusId?: unknown;
-    program_id?: unknown;
-    programId?: unknown;
-    program_term_id?: unknown;
-    programTermId?: unknown;
+  role_name?: unknown;
+  roleName?: unknown;
+  role?: unknown;
+  institution_id?: unknown;
+  institutionId?: unknown;
+  campus_id?: unknown;
+  campusId?: unknown;
+  program_id?: unknown;
+  programId?: unknown;
+  program_term_id?: unknown;
+  programTermId?: unknown;
 }
 
 export interface ValidateNewUserRoleRequestPayload extends Record<string, unknown> {
-    role_name?: string;
-    institution_id?: string;
-    campus_id?: string;
-    program_id?: string;
-    program_term_id?: string;
+  role_name?: string;
+  institution_id?: string;
+  campus_id?: string;
+  program_id?: string;
+  program_term_id?: string;
 }
 
 /**
@@ -116,8 +117,8 @@ export interface ValidateNewUserRoleRequestPayload extends Record<string, unknow
  * both institution_id and campus_id must be provided.
  */
 export function validateNewUserRoleRequestObject(
-    roleRequest?: ValidateNewUserRoleRequestInput | null,
-    options?: ValidateNewUserRoleRequestOptions | null,
+  roleRequest?: ValidateNewUserRoleRequestInput | null,
+  options?: ValidateNewUserRoleRequestOptions | null,
 ): ValidateNewUserRoleRequestPayload;
 
 /** Checks if the string is a valid image URL format. */
@@ -198,40 +199,40 @@ export const isValidArrayOfStrings: BoolValidator;
  * @deprecated Use direct imports instead.
  */
 export const validate: {
-    isImageUrl: typeof isImageUrl;
-    isInteger: typeof isInteger;
-    isValidJsonString: typeof isValidJsonString;
-    isValidIntegerString: typeof isValidIntegerString;
-    isValidUuidString: typeof isValidUuidString;
-    isCcIdString: typeof isCcIdString;
-    isCharactersString: typeof isCharactersString;
-    isStreetString: typeof isStreetString;
-    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;
-    isTextString: typeof isTextString;
-    isInStringArray: typeof isInStringArray;
-    isUserRoleRequestStatusString: typeof isUserRoleRequestStatusString;
-    isUserRoleRequestRoleString: typeof isUserRoleRequestRoleString;
-    isCountryCodeString: typeof isCountryCodeString;
-    isValidDomainName: typeof isValidDomainName;
-    isValidTimestampzString: typeof isValidTimestampzString;
-    isValidTimestampString: typeof isValidTimestampString;
-    isValidDateString: typeof isValidDateString;
-    isValidUrl: typeof isValidUrl;
-    isValidArrayOfStrings: typeof isValidArrayOfStrings;
+  isImageUrl: typeof isImageUrl;
+  isInteger: typeof isInteger;
+  isValidJsonString: typeof isValidJsonString;
+  isValidIntegerString: typeof isValidIntegerString;
+  isValidUuidString: typeof isValidUuidString;
+  isCcIdString: typeof isCcIdString;
+  isCharactersString: typeof isCharactersString;
+  isStreetString: typeof isStreetString;
+  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;
+  isTextString: typeof isTextString;
+  isInStringArray: typeof isInStringArray;
+  isUserRoleRequestStatusString: typeof isUserRoleRequestStatusString;
+  isUserRoleRequestRoleString: typeof isUserRoleRequestRoleString;
+  isCountryCodeString: typeof isCountryCodeString;
+  isValidDomainName: typeof isValidDomainName;
+  isValidTimestampzString: typeof isValidTimestampzString;
+  isValidTimestampString: typeof isValidTimestampString;
+  isValidDateString: typeof isValidDateString;
+  isValidUrl: typeof isValidUrl;
+  isValidArrayOfStrings: typeof isValidArrayOfStrings;
 };

package/index.js

@@ -4,10 +4,10 @@ const validateWhitelistProperties = require('./lib/validateWhitelistProperties')
 const validateNewUserRoleRequest = require('./lib/validateNewUserRoleRequest');
 
 module.exports = {
-    validate,
-    validateProperties,
-    validateWhitelistProperties,
-    ...validateNewUserRoleRequest,
-    ...validate,
-    ...validateProperties,
+  validate,
+  validateProperties,
+  validateWhitelistProperties,
+  ...validateNewUserRoleRequest,
+  ...validate,
+  ...validateProperties,
 };