cps-ui-kit 21.12.0 → 21.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cps-ui-kit",
-  "version": "21.12.0",
+  "version": "21.13.0",
   "peerDependencies": {
     "@angular/common": "^21.2.6",
     "@angular/core": "^21.2.6",

package/types/cps-ui-kit.d.ts

@@ -6000,6 +6000,209 @@ declare class CpsThemeService {
     static ɵprov: i0.ɵɵInjectableDeclaration<CpsThemeService>;
 }
 
+/**
+ * Service for validating 6-field cron expressions with extended features.
+ *
+ * This service handles cron validation logic for extended cron expression formats
+ * that support additional features beyond standard Unix cron for more flexible
+ * scheduling capabilities.
+ *
+ * Format: minutes hours day-of-month month day-of-week year
+ *
+ * Key Features:
+ * - Wildcards: asterisk (any value), question mark (any value for day fields)
+ * - Ranges: 1-5, MON-FRI, JAN-MAR
+ * - Steps: asterisk/15, 5/10, 1-5/2
+ * - Lists: 1,3,5, MON,WED,FRI
+ * - Special chars: L (last), W (weekday), hash (nth occurrence)
+ * @see {@link https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html#cron-based | AWS EventBridge Scheduler - Cron-based schedules}
+ * @group Services
+ */
+declare class CpsCronValidationService {
+    /**
+     * Validates a complete 6-field cron expression.
+     *
+     * @param cron - The 6-field cron expression to validate
+     * @param allowEmpty - Whether to allow empty cron expressions
+     * @returns boolean - True if the cron expression is valid
+     * @group Method
+     */
+    isValidCron(cron: string, allowEmpty?: boolean): boolean;
+    /**
+     * Validates all six fields of an extended cron expression.
+     *
+     * Extended cron format uses 6 fields: minutes hours day-of-month month day-of-week year
+     * This method validates each field according to extended cron syntax rules,
+     * which build upon standard Unix cron with additional features.
+     *
+     * Field Ranges and Features:
+     * - Minutes (0-59): Numeric, ranges, steps, lists
+     * - Hours (0-23): Numeric, ranges, steps, lists
+     * - Day-of-month (1-31): Numeric + special chars (L, W, LW)
+     * - Month (1-12): Numeric or named (JAN-DEC), ranges, steps, lists
+     * - Day-of-week (1-7): Numeric or named (SUN-SAT), special chars (L, #)
+     * - Year (1970-2199): Extended range for long-term scheduling
+     *
+     * Key Rules:
+     * - Day-of-month and day-of-week are mutually exclusive (one must be * or ?)
+     * - ? is only valid for day-of-month and day-of-week fields
+     * - Special characters provide advanced scheduling capabilities
+     *
+     * @param parts - Array of 6 cron field strings [minutes, hours, dayOfMonth, month, dayOfWeek, year]
+     * @returns boolean - True if all fields are valid and follow extended cron rules
+     */
+    private _validateCronFields;
+    /**
+     * Enhanced validation for complex cron field patterns.
+     * Supports extended cron features including ranges, steps, lists, and special characters.
+     *
+     * This method handles extended cron expression syntax which builds upon
+     * standard Unix cron format with additional features for flexible scheduling.
+     *
+     * Supported patterns:
+     * - Wildcards: asterisk (any value), question mark (any value for day fields)
+     * - Ranges: 1-5 (values 1 through 5), MON-FRI (Monday through Friday)
+     * - Steps: asterisk/10 (every 10th value), 1-5/2 (every 2nd value from 1 to 5)
+     * - Lists: 1,3,5 (specific values), MON,WED,FRI (specific days)
+     * - Special chars: L (last), W (weekday), hash (nth occurrence)
+     *
+     * @param field - The cron field value to validate (examples: "1-5/2", "MON-FRI", "asterisk/10")
+     * @param min - Minimum valid numeric value for this field type
+     * @param max - Maximum valid numeric value for this field type
+     * @param type - The cron field type ('minutes', 'hours', 'dayOfMonth', 'month', 'dayOfWeek', 'year')
+     * @returns boolean - True if the field is valid according to EventBridge Scheduler rules
+     */
+    private _validateComplexField;
+    /**
+     * Validates single values and extended cron special characters.
+     *
+     * This method handles the validation of individual field values including:
+     * - Numeric values within specified ranges
+     * - Special characters for advanced scheduling
+     * - Named values like month names (JAN, FEB) and day names (SUN, MON)
+     *
+     * Extended Cron Special Characters:
+     * - L: Last day of month (day-of-month) or last occurrence of weekday (day-of-week)
+     * - W: Nearest weekday to the specified day (day-of-month only)
+     * - LW: Last weekday of the month (day-of-month only)
+     * - #: Nth occurrence of weekday (e.g., "3#2" = 3rd Tuesday of month)
+     *
+     * @param value - The single value to validate (e.g., "15", "L", "15W", "MON", "3#2")
+     * @param min - Minimum valid numeric value for this field type
+     * @param max - Maximum valid numeric value for this field type
+     * @param type - The cron field type for context-specific validation
+     * @returns boolean - True if the value is valid for EventBridge Scheduler
+     */
+    private _validateSingleValue;
+    /**
+     * Validates range patterns with step intervals.
+     *
+     * This method handles complex range-step patterns like "1-5/2" which means
+     * "every 2nd value from 1 to 5" (resulting in: 1, 3, 5).
+     *
+     * Extended cron uses this pattern for flexible interval scheduling within specific ranges.
+     * For example: "9-17/2" for hours would trigger at 9:00, 11:00, 13:00, 15:00, 17:00.
+     *
+     * @param start - Range start value (numeric or named like "MON")
+     * @param end - Range end value (numeric or named like "FRI")
+     * @param step - Step interval as string (must be positive integer)
+     * @param min - Minimum allowed value for this field type
+     * @param max - Maximum allowed value for this field type
+     * @param type - Field type for context-aware validation (dayOfWeek gets special handling)
+     * @returns boolean - True if the range-step pattern is valid for EventBridge
+     */
+    private _validateRangeWithStep;
+    /**
+     * Validates simple range patterns without step intervals.
+     *
+     * This method handles basic range patterns like "1-5" (values 1 through 5) or
+     * "MON-FRI" (Monday through Friday). Extended cron supports both numeric and
+     * named ranges for flexible scheduling.
+     *
+     * Examples:
+     * - "9-17" for hours: triggers every hour from 9:00 to 17:00 (9am to 5pm)
+     * - "MON-FRI" for day-of-week: triggers Monday through Friday
+     * - "JAN-MAR" for months: triggers January through March
+     *
+     * @param start - Range start value (numeric or named)
+     * @param end - Range end value (numeric or named)
+     * @param min - Minimum allowed value for this field type
+     * @param max - Maximum allowed value for this field type
+     * @param type - Field type for validation context (affects named value handling)
+     * @returns boolean - True if the range pattern is valid for EventBridge
+     */
+    private _validateSimpleRange;
+    /**
+     * Validates step patterns from a starting point.
+     *
+     * This method handles step patterns like "5/10" (every 10th value starting from 5)
+     * or asterisk/15 (every 15th value starting from minimum). Extended cron uses this for
+     * interval-based scheduling from specific starting points.
+     *
+     * Examples:
+     * - "0/15" for minutes: triggers at 0, 15, 30, 45 minutes past the hour
+     * - asterisk/5 for minutes: triggers every 5 minutes (0, 5, 10, 15, ...)
+     * - "2/3" for day-of-month: triggers every 3rd day starting from the 2nd (2, 5, 8, ...)
+     *
+     * @param start - Starting value (can be asterisk for wildcard start or specific value)
+     * @param step - Step interval as string (must be positive integer)
+     * @param min - Minimum allowed value for this field type
+     * @param max - Maximum allowed value for this field type
+     * @param type - Field type for validation context
+     * @returns boolean - True if the step pattern is valid for EventBridge
+     */
+    private _validateStepField;
+    /**
+     * Validates day-of-month field with special characters.
+     */
+    private _validateDayOfMonth;
+    /**
+     * Validates month field with support for named months.
+     */
+    private _validateMonth;
+    /**
+     * Validates day-of-week field with support for named days and special characters.
+     */
+    private _validateDayOfWeek;
+    /**
+     * Validates mutual exclusivity rule for day-of-month and day-of-week fields.
+     * Extended cron requires that one of these fields must be a wildcard.
+     */
+    private _validateDayMutualExclusivity;
+    /**
+     * Checks if a value represents a valid day of the week (numeric or named).
+     */
+    private _isValidDayOfWeek;
+    /**
+     * Checks if a value represents a valid month name.
+     */
+    private _isValidMonthName;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CpsCronValidationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CpsCronValidationService>;
+}
+/**
+ * Injection token for `CpsCronValidationService`.
+ *
+ * Always inject this token instead of `CpsCronValidationService` directly.
+ * This allows consumer applications to override or disable cron validation by
+ * providing an alternative implementation via `providers`.
+ *
+ * @example
+ * // Inject in a component or service
+ * private readonly cronValidation = inject(CPS_CRON_VALIDATION_SERVICE);
+ *
+ * @example
+ * // Override with a custom implementation
+ * providers: [{ provide: CPS_CRON_VALIDATION_SERVICE, useClass: MyCustomCronValidationService }]
+ *
+ * @example
+ * // Disable cron validation entirely
+ * providers: [{ provide: CPS_CRON_VALIDATION_SERVICE, useValue: null }]
+ *
+ * @group Tokens
+ */
+declare const CPS_CRON_VALIDATION_SERVICE: InjectionToken<CpsCronValidationService | null>;
+
 /**
  * Collects all --cps-color-* CSS custom properties from :root rules only.
  * Theme overrides (e.g. [data-theme='dark']) are excluded to avoid duplicates,
@@ -6009,5 +6212,5 @@ declare const getCpsColors: (_document: Document) => [string, string][];
 declare const getCSSColor: (val: string, _document: Document) => string;
 declare const getTextColor: (backgroundColor: string) => string;
 
-export { CPS_FOCUS_SERVICE, CPS_RADIO_GROUP, CpsAutocompleteComponent, CpsButtonComponent, CpsButtonToggleComponent, CpsCheckboxComponent, CpsChipComponent, CpsColumnFilterMatchMode, CpsDatepickerComponent, CpsDialogConfig, CpsDialogRef, CpsDialogService, CpsDividerComponent, CpsExpansionPanelComponent, CpsFileUploadComponent, CpsFocusService, CpsIconComponent, CpsInfoCircleComponent, CpsInputComponent, CpsLoaderComponent, CpsMenuComponent, CpsMenuHideReason, CpsNotificationAppearance, CpsNotificationPosition, CpsNotificationService, CpsPaginatePipe, CpsPaginatorComponent, CpsProgressCircularComponent, CpsProgressLinearComponent, CpsRadioComponent, CpsRadioGroupComponent, CpsSchedulerComponent, CpsSelectComponent, CpsSidebarMenuComponent, CpsSwitchComponent, CpsTabComponent, CpsTabGroupComponent, CpsTableColumnFilterDirective, CpsTableColumnResizableDirective, CpsTableColumnSortableDirective, CpsTableComponent, CpsTableDetectFilterTypePipe, CpsTableHeaderSelectableDirective, CpsTableRowSelectableDirective, CpsTagComponent, CpsTextareaComponent, CpsThemeService, CpsTimepickerComponent, CpsTooltipDirective, CpsTreeAutocompleteComponent, CpsTreeSelectComponent, CpsTreeTableColumnFilterDirective, CpsTreeTableColumnResizableDirective, CpsTreeTableColumnSortableDirective, CpsTreeTableComponent, CpsTreeTableDetectFilterTypePipe, CpsTreeTableHeaderSelectableDirective, CpsTreeTableRowSelectableDirective, CpsTreetableRowTogglerDirective, ICONS_PATH, getCSSColor, getCpsColors, getTextColor, iconNames, tableFactory, treeTableFactory };
+export { CPS_CRON_VALIDATION_SERVICE, CPS_FOCUS_SERVICE, CPS_RADIO_GROUP, CpsAutocompleteComponent, CpsButtonComponent, CpsButtonToggleComponent, CpsCheckboxComponent, CpsChipComponent, CpsColumnFilterMatchMode, CpsCronValidationService, CpsDatepickerComponent, CpsDialogConfig, CpsDialogRef, CpsDialogService, CpsDividerComponent, CpsExpansionPanelComponent, CpsFileUploadComponent, CpsFocusService, CpsIconComponent, CpsInfoCircleComponent, CpsInputComponent, CpsLoaderComponent, CpsMenuComponent, CpsMenuHideReason, CpsNotificationAppearance, CpsNotificationPosition, CpsNotificationService, CpsPaginatePipe, CpsPaginatorComponent, CpsProgressCircularComponent, CpsProgressLinearComponent, CpsRadioComponent, CpsRadioGroupComponent, CpsSchedulerComponent, CpsSelectComponent, CpsSidebarMenuComponent, CpsSwitchComponent, CpsTabComponent, CpsTabGroupComponent, CpsTableColumnFilterDirective, CpsTableColumnResizableDirective, CpsTableColumnSortableDirective, CpsTableComponent, CpsTableDetectFilterTypePipe, CpsTableHeaderSelectableDirective, CpsTableRowSelectableDirective, CpsTagComponent, CpsTextareaComponent, CpsThemeService, CpsTimepickerComponent, CpsTooltipDirective, CpsTreeAutocompleteComponent, CpsTreeSelectComponent, CpsTreeTableColumnFilterDirective, CpsTreeTableColumnResizableDirective, CpsTreeTableColumnSortableDirective, CpsTreeTableComponent, CpsTreeTableDetectFilterTypePipe, CpsTreeTableHeaderSelectableDirective, CpsTreeTableRowSelectableDirective, CpsTreetableRowTogglerDirective, ICONS_PATH, getCSSColor, getCpsColors, getTextColor, iconNames, tableFactory, treeTableFactory };
 export type { CpsAutocompleteAppearanceType, CpsBaseTheme, CpsButtonToggleOption, CpsColorTheme, CpsColumnFilterCategoryOption, CpsColumnFilterType, CpsDatepickerAppearanceType, CpsDialogAutoFocusTarget, CpsDividerType, CpsInputAppearanceType, CpsMenuAttachPosition, CpsMenuItem, CpsNotificationConfig, CpsRadioOption, CpsRadiusTheme, CpsSelectAppearanceType, CpsSidebarMenuItem, CpsTabChangeEvent, CpsTableExportFormat, CpsTableSize, CpsTableSortMode, CpsTableToolbarSize, CpsTabsAlignmentType, CpsTabsAnimationType, CpsTheme, CpsTime, CpsTooltipOpenOn, CpsTooltipPosition, CpsTreeAutocompleteAppearanceType, CpsTreeSelectAppearanceType, CpsTreeTableSize, CpsTreeTableSortMode, CpsTreeTableToolbarSize, IconType, iconSizeType };