@spscommerce/ds-react 8.5.0 → 8.6.0

package/lib/dateRangePicker/SpsDateRangePicker.d.ts

@@ -14,6 +14,7 @@ export declare type SpsDateRangePickerProps = React.PropsWithChildren<SpsGlobalP
     onPresetChange?: (newPreset?: string) => void;
     value?: SimpleDateRange | DatePreset;
     showTwoMonths?: boolean;
+    format?: string;
 }> & React.HTMLAttributes<HTMLInputElement>;
 export declare const DEFAULT_PRESETS: DatePreset[];
-export declare function SpsDateRangePicker({ children, className, disabled, formMeta, id, maxDate, minDate, onChange, presets, selectedPreset: presetProp, onPresetChange, value, showTwoMonths, "data-testid": testId, ...rest }: SpsDateRangePickerProps): React.JSX.Element;
+export declare function SpsDateRangePicker({ children, className, disabled, formMeta, id, maxDate, minDate, onChange, presets, selectedPreset: presetProp, onPresetChange, value, showTwoMonths, format, "data-testid": testId, ...rest }: SpsDateRangePickerProps): React.JSX.Element;

package/lib/dateTimeRangePicker/SpsDateTimeRangePicker.d.ts

@@ -12,6 +12,7 @@ export declare type SpsDateTimeRangePickerProps = React.PropsWithChildren<SpsGlo
     value?: SimpleMomentRange;
     showTwoMonths?: boolean;
     twentyFourHour?: boolean;
+    format?: string;
 }> & React.HTMLAttributes<HTMLInputElement>;
 export declare const DEFAULT_DATETIME_PRESETS: DateTimePreset[];
-export declare function SpsDateTimeRangePicker({ className, disabled, formMeta, id, maxDate, minDate, onChange, presets, value, showTwoMonths, twentyFourHour, "data-testid": testId, }: SpsDateTimeRangePickerProps): React.JSX.Element;
+export declare function SpsDateTimeRangePicker({ className, disabled, formMeta, id, maxDate, minDate, onChange, presets, value, showTwoMonths, twentyFourHour, format, "data-testid": testId, }: SpsDateTimeRangePickerProps): React.JSX.Element;

package/lib/datepicker/SpsDatepicker.d.ts

@@ -10,5 +10,6 @@ export declare type SpsDatepickerProps = React.PropsWithChildren<SpsGlobalPropTy
     minDate?: SimpleDate;
     onChange?: (newDate: SimpleDate) => void;
     value?: SimpleDate;
+    format?: string;
 }> & React.HTMLAttributes<HTMLInputElement>;
-export declare function SpsDatepicker({ children, className, disabled, formMeta, id, maxDate, minDate, onChange, value, "data-testid": testId, ...rest }: SpsDatepickerProps): React.JSX.Element;
+export declare function SpsDatepicker({ children, className, disabled, formMeta, id, maxDate, minDate, onChange, value, format, "data-testid": testId, ...rest }: SpsDatepickerProps): React.JSX.Element;

package/lib/datepicker/utils.d.ts

@@ -3,19 +3,22 @@ import type { Moment } from "moment-timezone";
 export declare const FORMAT = "MM/DD/YYYY";
 export declare const FORMAT_WITH_TIME = "MM/DD/YYYY hh:mm A";
 export declare const FORMAT_WITH_TIME_24 = "MM/DD/YYYY HH:mm";
+export declare const TIME_FORMAT = "hh:mm A";
+export declare const TIME_FORMAT_24 = "HH:mm";
 export declare const FORMAT_PATTERN: RegExp;
 export declare const SYMBOL_DATE_PARSE_ERROR: unique symbol;
 export declare const SimpleDateUtils: Readonly<{
-    createFrom(input?: string | Moment | null): SimpleDate | null;
-    createMomentFrom(input: string | Moment | SimpleDate): Moment | null;
-    createRangeFrom(input: string): SimpleDateRange | null;
+    createFrom(input?: string | Moment | null, format?: string): SimpleDate | null;
+    createMomentFrom(input: string | Moment | SimpleDate, format?: string): Moment | null;
+    getRangeSeparator(format?: string): string;
+    createRangeFrom(input: string, format?: string): SimpleDateRange | null;
     isValid(date?: SimpleDate | Moment | null): boolean | undefined;
     nullifyInvalidDate(value: any): SimpleDate | null;
     toMoment(date?: Moment | SimpleDate | null): Moment | null;
-    toString(date?: Moment | SimpleDate | null): string;
-    toStringRange(dateRange: SimpleDateRange): string;
-    toDateTimeString(dateMoment: Moment | null, twentyFourHourFormat?: boolean): string;
-    toDateTimeStringRange(dateRange: SimpleMomentRange, twentyFourHourFormat?: boolean): string;
+    toString(date?: Moment | SimpleDate | null, format?: string): string;
+    toStringRange(dateRange: SimpleDateRange, format?: string): string;
+    toDateTimeString(dateMoment: Moment | null, twentyFourHourFormat?: boolean, dateFormat?: string): string;
+    toDateTimeStringRange(dateRange: SimpleMomentRange, twentyFourHourFormat?: boolean, dateFormat?: string): string;
     create(): SimpleDate;
     isSameDate(d1: SimpleDate, d2: SimpleDate): boolean;
     isSameMonth(d1: SimpleDate, d2: SimpleDate): boolean;
@@ -24,9 +27,9 @@ export declare const SimpleDateUtils: Readonly<{
     isInRange(date: SimpleDate, range: SimpleDateRange, inclusive?: boolean): boolean | 0 | null;
     prevMonth(date: SimpleDate): SimpleDate;
     nextMonth(date: SimpleDate): SimpleDate;
-    createRangeFromPreset(preset: DatePreset): SimpleDateRange;
+    createRangeFromPreset(preset: DatePreset, format?: string): SimpleDateRange;
     createDateTimeRangeFromPreset(preset: DateTimePreset): SimpleMomentRange;
-    splitMomentInDateTimeParts(dateMoment?: Moment | null, twentyFourHourFormat?: boolean): [string, string, string | undefined];
+    splitMomentInDateTimeParts(dateMoment?: Moment | null, twentyFourHourFormat?: boolean, dateFormat?: string): [string, string, string | undefined];
     getCurrentMoment(): Moment;
     validateTimeString(timeString?: string, twentyFourHourFormat?: boolean): boolean;
     padIncompleteTimeString(timeString?: string, twentyFourHourFormat?: boolean): string;

package/lib/datepicker/validation.d.ts

@@ -1,6 +1,7 @@
 import type { SimpleDate, SimpleDateRange, SimpleMomentRange } from "@spscommerce/ds-shared";
 import type { Duration, Moment } from "moment-timezone";
 import type { SpsValidator, SpsValidatorFactory } from "../form/validation/types";
+export declare function setDateFormat(format: string): void;
 export declare const date: SpsValidator<SimpleDate | SimpleDateRange | Moment | SimpleMomentRange | null>;
 export declare const dateRange: SpsValidator<SimpleDateRange | Duration | SimpleMomentRange>;
 export interface DateConstraintError {

package/lib/form/validation/SpsValidators.d.ts

@@ -12,6 +12,7 @@ export declare const SpsValidators: Readonly<{
     numeric: SpsValidator<string>;
     nonNumeric: SpsValidator<string>;
     OnBlurErrorKeys: Set<string>;
+    setDateFormat(format: string): void;
     date: SpsValidator<import("@spscommerce/ds-shared").SimpleDate | import("moment").Moment | import("@spscommerce/ds-shared").SimpleDateRange | import("@spscommerce/ds-shared").SimpleMomentRange | null>;
     dateRange: SpsValidator<import("@spscommerce/ds-shared").SimpleDateRange | import("@spscommerce/ds-shared").SimpleMomentRange | import("moment").Duration>;
     dateConstraint: SpsValidatorFactory<import("@spscommerce/ds-shared").SimpleDate | import("moment").Moment | import("@spscommerce/ds-shared").SimpleDateRange | import("@spscommerce/ds-shared").SimpleMomentRange>;