Class InputValidator

Centralized input validation module for CalOohPay application.

Provides consistent validation rules and error messages across all parts of the application. All validation methods throw descriptive errors with context when validation fails.

Index

Constructors

constructor

new InputValidator(): InputValidator
Returns InputValidator

Methods - Other

`Static`sanitizeString

sanitizeString(input: string, defaultValue?: string): string
Sanitizes a string input by trimming whitespace.
Parameters
- input: string
  The string to sanitize
- defaultValue: string = ''
  Optional default value if input is empty after trimming
Returns string
Sanitized string
Example
```
InputValidator.sanitizeString('  test  ');        // 'test'
InputValidator.sanitizeString('   ', 'default');  // 'default'
```
- Defined in validation/InputValidator.ts:239

`Static`validateApiToken

validateApiToken(token: string): void
Validates an API token format.

Basic validation for PagerDuty API tokens. Real validation happens when making API calls, but this catches obvious issues early.
Parameters
- token: string
  API token to validate
Returns void
Throws
If token is missing or appears invalid
Example
```
InputValidator.validateApiToken('u+ABC123xyz789');  // OK
InputValidator.validateApiToken('');                // throws Error
```
- Defined in validation/InputValidator.ts:261

`Static`validateDateRange

validateDateRange(since: string, until: string): void
Validates a date range ensuring 'since' is not greater than 'until'.
Parameters
- since: string
  Start date string (ISO format)
- until: string
  End date string (ISO format)
Returns void
Throws
If since > until or if dates are invalid
Example
```
InputValidator.validateDateRange('2024-01-01', '2024-01-31'); // OK
InputValidator.validateDateRange('2024-02-01', '2024-01-01'); // throws Error
```
- Defined in validation/InputValidator.ts:54

`Static`validateDateString

validateDateString(dateString: string, fieldName: string): void
Validates a date string can be parsed as a valid date.
Parameters
- dateString: string
  The date string to validate
- fieldName: string
  Name of the field being validated (for error messages)
Returns void
Throws
If date string is invalid or cannot be parsed
Example
```
InputValidator.validateDateString('2024-01-15', 'since'); // OK
InputValidator.validateDateString('invalid', 'since');     // throws Error
```
- Defined in validation/InputValidator.ts:28

`Static`validateFilePath

validateFilePath(filePath: string): void
Validates a file path for output.

Basic validation to ensure path is not empty and doesn't contain obviously invalid characters.
Parameters
- filePath: string
  The file path to validate
Returns void
Throws
If file path is invalid
Example
```
InputValidator.validateFilePath('./output/report.csv');  // OK
InputValidator.validateFilePath('');                     // throws Error
```
- Defined in validation/InputValidator.ts:296

`Static`validateOnCallUser

validateOnCallUser(onCallUser: OnCallUser | null | undefined): void
Validates an OnCallUser object for payment calculations.

Ensures the user has all required data for accurate payment calculation.
Parameters
- onCallUser: OnCallUser | null | undefined
  The user object to validate
Returns void
Throws
If user is undefined, missing required fields, or has no on-call periods
Example
```
const user = new OnCallUser('PXXXXXX', 'John Doe', [period]);
InputValidator.validateOnCallUser(user); // OK

InputValidator.validateOnCallUser(null); // throws Error
```
- Defined in validation/InputValidator.ts:196

`Static`validateScheduleId

validateScheduleId(scheduleId: string): void
Validates PagerDuty schedule ID format.

PagerDuty schedule IDs typically start with 'P' followed by alphanumeric characters. This validates basic format and non-empty strings.
Parameters
- scheduleId: string
  The schedule ID to validate
Returns void
Throws
If schedule ID is invalid
Example
```
InputValidator.validateScheduleId('PXXXXXX');  // OK
InputValidator.validateScheduleId('');         // throws Error
InputValidator.validateScheduleId('   ');      // throws Error
```
- Defined in validation/InputValidator.ts:85

`Static`validateScheduleIds

validateScheduleIds(scheduleIds: string): string[]
Validates a comma-separated list of schedule IDs.
Parameters
- scheduleIds: string
  Comma-separated schedule IDs
Returns string[]
Array of validated and trimmed schedule IDs
Throws
If any schedule ID is invalid
Example
```
const ids = InputValidator.validateScheduleIds('PXXXXXX,PYYYYYY');
// Returns: ['PXXXXXX', 'PYYYYYY']
```
- Defined in validation/InputValidator.ts:116

`Static`validateTimezone

validateTimezone(timezone: string): void
Validates an IANA timezone identifier.

Note: This performs basic validation. For comprehensive timezone validation, use Luxon's DateTime.local().setZone() and check if zone.isValid.
Parameters
- timezone: string
  IANA timezone identifier (e.g., 'Europe/London', 'America/New_York')
Returns void
Throws
If timezone is invalid or unsupported
Example
```
InputValidator.validateTimezone('Europe/London');      // OK
InputValidator.validateTimezone('Invalid/Timezone');   // throws Error
```
- Defined in validation/InputValidator.ts:160

Methods - Validation

`Static`validateNonEmptyString

validateNonEmptyString(value: string, fieldName: string): void
Validates that a string is non-empty (after trimming whitespace).

Used for validating required string fields like currency codes.
Parameters
- value: string
  The string to validate
- fieldName: string
  Name of the field being validated (for error messages)
Returns void
Throws
If value is not a string or is empty after trimming
Example
```
InputValidator.validateNonEmptyString('GBP', 'currency');      // OK
InputValidator.validateNonEmptyString('  USD  ', 'currency');  // OK (trimmed)
InputValidator.validateNonEmptyString('', 'currency');         // throws Error
InputValidator.validateNonEmptyString('   ', 'currency');      // throws Error
```
- Defined in validation/InputValidator.ts:370

`Static`validatePositiveNumber

validatePositiveNumber(value: number, fieldName: string): void
Validates that a number is positive (greater than 0).

Used for validating configuration values that must be positive, such as compensation rates.
Parameters
- value: number
  The number to validate
- fieldName: string
  Name of the field being validated (for error messages)
Returns void
Throws
If value is not a number, NaN, or not positive
Example
```
InputValidator.validatePositiveNumber(50, 'weekdayRate');     // OK
InputValidator.validatePositiveNumber(0, 'weekdayRate');      // throws Error
InputValidator.validatePositiveNumber(-10, 'weekdayRate');    // throws Error
InputValidator.validatePositiveNumber(NaN, 'weekdayRate');    // throws Error
```
- Defined in validation/InputValidator.ts:336

Class InputValidator

Index

Constructors

Methods - Other

Methods - Validation

Constructors

constructor

Returns InputValidator

Methods - Other

StaticsanitizeString

Parameters

Returns string

Example

StaticvalidateApiToken

Parameters

Returns void

Throws

Example

StaticvalidateDateRange

Parameters

Returns void

Throws

Example

StaticvalidateDateString

Parameters

Returns void

Throws

Example

StaticvalidateFilePath

Parameters

Returns void

Throws

Example

StaticvalidateOnCallUser

Parameters

Returns void

Throws

Example

StaticvalidateScheduleId

Parameters

Returns void

Throws

Example

StaticvalidateScheduleIds

Parameters

Returns string[]

Throws

Example

StaticvalidateTimezone

Parameters

Returns void

Throws

Example

Methods - Validation

StaticvalidateNonEmptyString

Parameters

Returns void

Throws

Example

StaticvalidatePositiveNumber

Parameters

Returns void

Throws

Example

Settings

On This Page

`Static`sanitizeString

`Static`validateApiToken

`Static`validateDateRange

`Static`validateDateString

`Static`validateFilePath

`Static`validateOnCallUser

`Static`validateScheduleId

`Static`validateScheduleIds

`Static`validateTimezone

`Static`validateNonEmptyString

`Static`validatePositiveNumber