@spscommerce/ds-react 0.0.0-20260319-8230915ce

package/lib/datepicker/utils.d.ts

@@ -0,0 +1,38 @@
+import type { SimpleDate, SimpleDateRange, DatePreset, DateTimePreset, SimpleMomentRange } from "@spscommerce/ds-shared";
+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, 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, 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;
+    isAfter(date: SimpleDate | Moment | null, referenceDate: SimpleDate | Moment | null): boolean | null;
+    isBefore(date: SimpleDate | Moment | null, referenceDate: SimpleDate | Moment | null): boolean | null;
+    isInRange(date: SimpleDate, range: SimpleDateRange, inclusive?: boolean): boolean | 0 | null;
+    prevMonth(date: SimpleDate): SimpleDate;
+    nextMonth(date: SimpleDate): SimpleDate;
+    createRangeFromPreset(preset: DatePreset, format?: string): SimpleDateRange;
+    createDateTimeRangeFromPreset(preset: DateTimePreset): SimpleMomentRange;
+    splitMomentInDateTimeParts(dateMoment?: Moment | null, twentyFourHourFormat?: boolean, dateFormat?: string, defaultToEndOfDay?: boolean): [string, string, string | undefined];
+    getCurrentMoment(): Moment;
+    validateTimeString(timeString?: string, twentyFourHourFormat?: boolean): boolean;
+    padIncompleteTimeString(timeString?: string, twentyFourHourFormat?: boolean): string;
+}>;
+export declare const twelveHourTimes: string[];
+export declare const twentyFourHourTimes: string[];

package/lib/datepicker/validation.d.ts

@@ -0,0 +1,11 @@
+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 {
+    minExceeded: string | null;
+    maxExceeded: string | null;
+}
+export declare const dateConstraint: SpsValidatorFactory<SimpleDate | SimpleDateRange | Moment | SimpleMomentRange>;

package/lib/datetime/SpsDateTime.d.ts

@@ -0,0 +1,11 @@
+import * as React from "react";
+export type SpsDateTimeProps = React.PropsWithChildren<{
+    currentUser?: any;
+    dateToFormat?: string | Date;
+    format?: string;
+    locale?: string;
+    relative?: boolean;
+    relativeHrs?: number;
+    tz?: string;
+}> & React.HTMLAttributes<HTMLSpanElement>;
+export declare function SpsDateTime(props: SpsDateTimeProps): React.JSX.Element;

package/lib/datetime/SpsDateTime.examples.d.ts

@@ -0,0 +1,2 @@
+import type { DSReactExamples } from "@spscommerce/ds-shared";
+export declare const SpsDatetimeExamples: DSReactExamples;

package/lib/datetime/SpsLocaleProvider.d.ts

@@ -0,0 +1,7 @@
+import * as React from "react";
+export type SpsLocaleProviderProps = React.PropsWithChildren<{
+    currentUser?: any;
+    locale?: string;
+}>;
+export declare function SpsLocaleProvider({ currentUser, locale, children, }: SpsLocaleProviderProps): React.ReactElement;
+export declare function useSpsLocale(currentUser?: any): string;

package/lib/datetime/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./SpsDateTime";
+export * from "./SpsDateTime.examples";
+export * from "./SpsLocaleProvider";

package/lib/datetime/localeDefinitions.d.ts

@@ -0,0 +1,20 @@
+type MomentInstance = typeof import("moment");
+export declare function registerLocale_de(moment: MomentInstance): void;
+export declare function registerLocale_enAu(moment: MomentInstance): void;
+export declare function registerLocale_enCa(moment: MomentInstance): void;
+export declare function registerLocale_enGb(moment: MomentInstance): void;
+export declare function registerLocale_enIe(moment: MomentInstance): void;
+export declare function registerLocale_es(moment: MomentInstance): void;
+export declare function registerLocale_fr(moment: MomentInstance): void;
+export declare function registerLocale_frCa(moment: MomentInstance): void;
+export declare function registerLocale_it(moment: MomentInstance): void;
+export declare function registerLocale_nl(moment: MomentInstance): void;
+export declare function registerLocale_zhCn(moment: MomentInstance): void;
+export declare function registerLocale_zhTw(moment: MomentInstance): void;
+/**
+ * Register all supported locales on the provided moment instance.
+ * Call this function with your moment instance to ensure locales
+ * are registered on the correct instance.
+ */
+export declare function registerAllLocales(moment: MomentInstance): void;
+export {};

package/lib/datetime/momentLocale.d.ts

@@ -0,0 +1,3 @@
+export declare function getBrowserLocale(): string;
+export declare function getLocaleUses24HourTime(locale?: string): boolean;
+export declare function resolveMomentLocale(locale?: string): string;

package/lib/description-list/SpsDescriptionList.d.ts

@@ -0,0 +1,9 @@
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsDescriptionListProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    compact?: boolean;
+    wideTerms?: boolean;
+    widerTerms?: boolean;
+}> & React.HTMLAttributes<HTMLDListElement>;
+export declare function SpsDescriptionList(props: SpsDescriptionListProps): React.JSX.Element;
+export declare function SpsDl(props: SpsDescriptionListProps): React.JSX.Element;

package/lib/description-list/SpsDescriptionList.examples.d.ts

@@ -0,0 +1,2 @@
+import type { DSReactExamples } from "@spscommerce/ds-shared";
+export declare const SpsDescriptionListExamples: DSReactExamples;

package/lib/description-list/SpsDescriptionListDefinition.d.ts

@@ -0,0 +1,5 @@
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsDescriptionListDefinitionProps = React.PropsWithChildren<SpsGlobalPropTypes> & React.HTMLAttributes<HTMLElement>;
+export declare function SpsDescriptionListDefinition(props: SpsDescriptionListDefinitionProps): React.JSX.Element;
+export declare function SpsDd(props: SpsDescriptionListDefinitionProps): React.JSX.Element;

package/lib/description-list/SpsDescriptionListTerm.d.ts

@@ -0,0 +1,13 @@
+import * as React from "react";
+import type { SpsFormControl } from "../form/hooks/formControl";
+import type { SpsFormFieldMeta } from "../form/hooks/useSpsForm";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsDescriptionListTermProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    error?: boolean;
+    errors?: React.ReactNode | (() => React.ReactNode);
+    help?: React.ReactNode | (() => React.ReactNode);
+    labelFor?: SpsFormControl<any> | SpsFormFieldMeta<any>;
+    required?: boolean;
+}> & React.HTMLAttributes<HTMLElement>;
+export declare function SpsDescriptionListTerm(props: SpsDescriptionListTermProps): React.JSX.Element;
+export declare function SpsDt(props: SpsDescriptionListTermProps): React.JSX.Element;

package/lib/description-list/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./SpsDescriptionList";
+export * from "./SpsDescriptionListTerm";
+export * from "./SpsDescriptionListDefinition";
+export * from "./SpsDescriptionList.examples";

package/lib/dropdown/SpsDropdown.d.ts

@@ -0,0 +1,24 @@
+import type { SpsActionDescriptor, SpsActionMethod } from "@spscommerce/ds-shared";
+import { DropdownKind, SpsIcon } from "@spscommerce/ds-shared";
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsDropdownProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    action?: (...args: any[]) => void;
+    alignLeft?: boolean;
+    disabled?: boolean;
+    conformWidth?: boolean;
+    icon?: SpsIcon;
+    kind?: DropdownKind;
+    label?: string;
+    options?: Array<SpsActionMethod | [SpsActionDescriptor, () => void]>;
+    spinning?: boolean;
+    spinningTitle?: string;
+    tallOptionList?: boolean;
+    onOpen?: () => void;
+    onClose?: () => void;
+    loading?: boolean;
+    maxHeightOptionListPx?: number;
+    maxHeightOptionListRem?: number;
+    disableOptionsMemoization?: boolean;
+}> & React.HTMLAttributes<HTMLDivElement>;
+export declare function SpsDropdown(props: SpsDropdownProps): React.JSX.Element;

package/lib/dropdown/SpsDropdown.examples.d.ts

@@ -0,0 +1,2 @@
+import type { DSReactExamples } from "@spscommerce/ds-shared";
+export declare const SpsDropdownExamples: DSReactExamples;

package/lib/dropdown/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./SpsDropdown";
+export * from "./SpsDropdown.examples";

package/lib/feedback-block/SpsFeedbackBlock.d.ts

@@ -0,0 +1,7 @@
+import { FeedbackBlockKind } from "@spscommerce/ds-shared";
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsFeedbackBlockProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    kind?: FeedbackBlockKind;
+}> & React.HTMLAttributes<HTMLDivElement>;
+export declare function SpsFeedbackBlock(props: SpsFeedbackBlockProps): React.JSX.Element;

package/lib/feedback-block/SpsFeedbackBlock.examples.d.ts

@@ -0,0 +1,2 @@
+import type { DSReactExamples } from "@spscommerce/ds-shared";
+export declare const SpsFeedbackBlockExamples: DSReactExamples;

package/lib/feedback-block/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./SpsFeedbackBlock";
+export * from "./SpsFeedbackBlock.examples";

package/lib/fieldset/SpsFieldset.d.ts

@@ -0,0 +1,22 @@
+import { TooltipShowTrigger, Position } from "@spscommerce/ds-shared";
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+import type { SpsFormArray } from "../form/hooks/formArray";
+import type { SpsFormGroup } from "../form/hooks/formGroup";
+import type { SpsFormSetMeta } from "../form/hooks/useSpsForm";
+export type SpsFieldsetProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    errors?: React.ReactNode | (() => React.ReactNode);
+    formArray?: SpsFormArray<any>;
+    formGroup?: SpsFormGroup;
+    formMeta?: SpsFormSetMeta<any>;
+    legend?: string;
+    hasRequiredFields?: boolean;
+    optional?: boolean;
+    enabled?: boolean;
+    onToggled?: (isEnabled: boolean) => void;
+    tooltip?: string;
+    applyNestedStyles?: boolean;
+    errorsTooltipTrigger?: TooltipShowTrigger;
+    errorsTooltipPosition?: Position;
+}> & React.HTMLAttributes<HTMLDivElement>;
+export declare function SpsFieldset({ children, className, errors, formArray, formGroup, formMeta, legend, unsafelyReplaceClassName, hasRequiredFields, optional, enabled, onToggled, tooltip, applyNestedStyles, "data-testid": testId, errorsTooltipTrigger, errorsTooltipPosition, }: SpsFieldsetProps): React.JSX.Element;

package/lib/fieldset/SpsFieldset.examples.d.ts

@@ -0,0 +1,2 @@
+import type { DSReactExamples } from "@spscommerce/ds-shared";
+export declare const SpsFieldsetExamples: DSReactExamples;

package/lib/fieldset/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./SpsFieldset";
+export * from "./SpsFieldset.examples";

package/lib/filter-panel/SpsFilterPanel.d.ts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsFilterPanelProps = React.PropsWithChildren<SpsGlobalPropTypes> & React.HTMLAttributes<HTMLDivElement>;
+export declare function SpsFilterPanel({ children, className, ...rest }: SpsFilterPanelProps): React.JSX.Element;

package/lib/filter-panel/SpsFilterPanel.examples.d.ts

@@ -0,0 +1,2 @@
+import type { DSReactExamples } from "@spscommerce/ds-shared";
+export declare const SpsFilterPanelExamples: DSReactExamples;

package/lib/filter-panel/SpsFilterPanelCap.d.ts

@@ -0,0 +1,6 @@
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsFilterPanelCapProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    onClear?: () => void;
+}> & React.HTMLAttributes<HTMLDivElement>;
+export declare function SpsFilterPanelCap({ children, className, onClear, ...rest }: SpsFilterPanelCapProps): React.JSX.Element;

package/lib/filter-panel/SpsFilterPanelFilterBox.d.ts

@@ -0,0 +1,10 @@
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+import type { SpsFormFieldMeta } from "../form";
+export type SpsFilterPanelFilterBoxProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    value?: string;
+    placeholder?: string;
+    formMeta?: SpsFormFieldMeta<string>;
+    onFilterChange?: React.ChangeEventHandler<HTMLInputElement>;
+}> & React.HTMLAttributes<HTMLDivElement>;
+export declare function SpsFilterPanelFilterBox({ className, value, placeholder, formMeta, onFilterChange, ...rest }: SpsFilterPanelFilterBoxProps): React.JSX.Element;

package/lib/filter-panel/SpsFilterPanelSection.d.ts

@@ -0,0 +1,11 @@
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsFilterPanelSectionProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    title?: string | React.ReactNode;
+    expanded?: boolean;
+    heightPx?: number;
+    heightRem?: number;
+    onExpand?: () => void;
+    onCollapse?: () => void;
+}> & Omit<React.HTMLAttributes<HTMLDivElement>, "title">;
+export declare function SpsFilterPanelSection({ children, className, title, expanded, heightPx, heightRem, onExpand, onCollapse, ...rest }: SpsFilterPanelSectionProps): React.JSX.Element;

package/lib/filter-panel/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./SpsFilterPanel";
+export * from "./SpsFilterPanelSection";
+export * from "./SpsFilterPanelCap";
+export * from "./SpsFilterPanel.examples";
+export * from "./SpsFilterPanelFilterBox";

package/lib/filter-tile-list/SpsFilterTile.d.ts

@@ -0,0 +1,10 @@
+import * as React from "react";
+import { SpsFilterTileKind } from "@spscommerce/ds-shared";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsFilterTileProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    value: number;
+    title: string;
+    kind?: SpsFilterTileKind;
+    active?: boolean;
+}> & React.HTMLAttributes<HTMLDivElement>;
+export declare function SpsFilterTile(props: SpsFilterTileProps): React.JSX.Element;

package/lib/filter-tile-list/SpsFilterTileList.d.ts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsFilterTileListProps = React.PropsWithChildren<SpsGlobalPropTypes> & React.HTMLAttributes<HTMLDivElement>;
+export declare function SpsFilterTileList(props: SpsFilterTileListProps): React.JSX.Element;

package/lib/filter-tile-list/SpsFilterTileList.examples.d.ts

@@ -0,0 +1,2 @@
+import type { DSReactExamples } from "@spscommerce/ds-shared";
+export declare const SpsFilterTileListExamples: DSReactExamples;

package/lib/filter-tile-list/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./SpsFilterTile";
+export * from "./SpsFilterTileList";
+export * from "./SpsFilterTileList.examples";

package/lib/focused-task/SpsFocusedTask.d.ts

@@ -0,0 +1,8 @@
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsFocusedTaskProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    fullWidth?: boolean;
+    isOpen?: boolean;
+    onClose?: () => void;
+}> & React.HTMLAttributes<HTMLDivElement>;
+export declare function SpsFocusedTask(props: SpsFocusedTaskProps): React.JSX.Element;

package/lib/focused-task/SpsFocusedTask.examples.d.ts

@@ -0,0 +1,2 @@
+import type { DSReactExamples } from "@spscommerce/ds-shared";
+export declare const SpsFocusedTaskExamples: DSReactExamples;

package/lib/focused-task/SpsFocusedTaskActions.d.ts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+export type SpsFocusedTaskActionsProps = React.PropsWithChildren<SpsGlobalPropTypes> & React.HTMLAttributes<HTMLDivElement>;
+export declare function SpsFocusedTaskActions(props: SpsFocusedTaskActionsProps): React.JSX.Element;

package/lib/focused-task/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./SpsFocusedTask";
+export * from "./SpsFocusedTaskActions";
+export * from "./SpsFocusedTask.examples";

package/lib/form/AddRemoveFormRows.examples.d.ts

@@ -0,0 +1,18 @@
+export declare const SpsAddRemoveFormRowExamples: {
+    ideal: {
+        label: string;
+        examples: {
+            ideal: {
+                react: string;
+            };
+        };
+    };
+    alternate: {
+        label: string;
+        examples: {
+            alternate: {
+                react: string;
+            };
+        };
+    };
+};

package/lib/form/SpsForm.d.ts

@@ -0,0 +1,18 @@
+import * as React from "react";
+import type { SpsFormArray } from "./hooks/formArray";
+import type { SpsFormGroup } from "./hooks/formGroup";
+import type { SpsFormSetMeta } from "./hooks/useSpsForm";
+export declare const spsFormProps: {
+    formMeta: string;
+    onSubmit: string;
+};
+export type SpsFormProps = React.PropsWithChildren<{
+    formArray?: SpsFormArray<any>;
+    formGroup?: SpsFormGroup;
+    formMeta?: SpsFormSetMeta<any>;
+    onSubmit?: React.FormEventHandler;
+}> & React.HTMLAttributes<HTMLFormElement>;
+type SpsFormForwardRefType = SpsFormProps & React.RefAttributes<HTMLFormElement>;
+type SpsFormForwardRefExoticComponent = React.ForwardRefExoticComponent<SpsFormForwardRefType>;
+export declare const SpsForm: SpsFormForwardRefExoticComponent;
+export {};

package/lib/form/SpsForm.examples.d.ts

@@ -0,0 +1 @@
+export declare const SpsFormExamples: {};

package/lib/form/SpsFormComponentWrapper.d.ts

@@ -0,0 +1,14 @@
+import * as React from "react";
+import type { SpsGlobalPropTypes } from "../prop-types";
+import type { SpsFormControl } from "./hooks/formControl";
+import type { SpsFormMetaBase } from "./hooks/useSpsForm";
+export type SpsFormComponentWrapperProps = React.PropsWithChildren<SpsGlobalPropTypes & {
+    focusInputOnClick?: boolean;
+    formMeta?: SpsFormMetaBase<any>;
+    formControl?: SpsFormControl<any>;
+    inputRef?: React.MutableRefObject<HTMLInputElement | HTMLTextAreaElement | null>;
+}> & React.HTMLAttributes<HTMLDivElement>;
+type SpsFormComponentWrapperForwardRefType = SpsFormComponentWrapperProps & React.RefAttributes<HTMLDivElement>;
+type SpsFormComponentWrapperForwardRefExoticComponent = React.ForwardRefExoticComponent<SpsFormComponentWrapperForwardRefType>;
+export declare const SpsFormComponentWrapper: SpsFormComponentWrapperForwardRefExoticComponent;
+export {};

package/lib/form/hooks/SpsAbstractControl.interface.d.ts

@@ -0,0 +1,24 @@
+import type { SpsValidator, SpsValidationErrors } from "../validation/types";
+export interface SpsAbstractControlConfig<T> {
+    validators?: Array<SpsValidator<T>>;
+}
+export interface SpsAbstractControl<T> extends SpsAbstractControlConfig<T> {
+    _type: string;
+    errors: SpsValidationErrors | null;
+    invalid: boolean;
+    setInitValue: (newValue: T) => any;
+    getValue: () => T;
+    setValue: (newValue: T) => any;
+    isValid: () => boolean;
+    hasError: (errorKey: string) => boolean;
+    isFocused: () => boolean;
+    focus: () => any;
+    blur: () => any;
+    onFocus?: () => any;
+    onBlur?: () => any;
+    isPristine: () => boolean;
+    markAsPristine: () => any;
+    markAsDirty: () => any;
+    reset: (value?: T) => any;
+    update: () => any;
+}

package/lib/form/hooks/SpsControlSet.interface.d.ts

@@ -0,0 +1,7 @@
+import type { SpsAbstractControl } from "./SpsAbstractControl.interface";
+export interface SpsControlSet extends SpsAbstractControl<any> {
+    members: any;
+    get: <T extends SpsAbstractControl<any>>(path: PropertyKey | PropertyKey[]) => T;
+    update: () => any;
+}
+export declare function getMember<T extends SpsAbstractControl<any>>(controlSet: SpsControlSet, path: PropertyKey | PropertyKey[]): T;

package/lib/form/hooks/formArray.d.ts

@@ -0,0 +1,12 @@
+import type { SpsAbstractControl, SpsAbstractControlConfig } from "./SpsAbstractControl.interface";
+import type { SpsControlSet } from "./SpsControlSet.interface";
+export interface SpsFormArray<T> extends SpsControlSet {
+    members: Array<SpsAbstractControl<T>>;
+    length: number;
+    at: (index: number) => SpsAbstractControl<T>;
+    push: (control: SpsAbstractControl<T>) => any;
+    insert: (index: number, control: SpsAbstractControl<T>) => any;
+    removeAt: (index: number) => any;
+    setControl: (index: number, control: SpsAbstractControl<T>) => any;
+}
+export declare function formArray<T>(members?: Array<SpsAbstractControl<T>>, config?: SpsAbstractControlConfig<T>): SpsFormArray<T>;

package/lib/form/hooks/formControl.d.ts

@@ -0,0 +1,9 @@
+import type { SpsAbstractControl, SpsAbstractControlConfig } from "./SpsAbstractControl.interface";
+export interface SpsFormControl<T> extends SpsAbstractControl<T> {
+    id: string;
+    value: T;
+    focused: boolean;
+    pristine: boolean;
+    isRequired: () => boolean;
+}
+export declare function formControl<T>(initValue?: T, config?: SpsAbstractControlConfig<T>): SpsFormControl<T>;

package/lib/form/hooks/formGroup.d.ts

@@ -0,0 +1,10 @@
+import type { SpsAbstractControl, SpsAbstractControlConfig } from "./SpsAbstractControl.interface";
+import type { SpsControlSet } from "./SpsControlSet.interface";
+export interface SpsFormGroup extends SpsControlSet {
+    members: Record<string, SpsAbstractControl<any>>;
+    addControl: (name: string, control: SpsAbstractControl<any>) => any;
+    removeControl: (name: string) => any;
+    setControl: (name: string, control: SpsAbstractControl<any>) => any;
+    contains: (name: string) => boolean;
+}
+export declare function formGroup(members?: Record<string, SpsAbstractControl<any>>, config?: SpsAbstractControlConfig<any>): SpsFormGroup;

package/lib/form/hooks/useCustomValidator.d.ts

@@ -0,0 +1,7 @@
+import type { SpsValidator } from "../validation/types";
+export declare enum ValidationMode {
+    ON_CHANGE = 0,
+    ON_BLUR = 1,
+    ON_SUBMIT = 2
+}
+export declare function useCustomValidator<T>(validator: SpsValidator<T>, validatorConfig?: Record<string, ValidationMode>, dependencies?: any[]): SpsValidator<T>;

package/lib/form/hooks/useForm.d.ts

@@ -0,0 +1,2 @@
+import type { SpsControlSet } from "./SpsControlSet.interface";
+export declare function useForm<T extends SpsControlSet>(controls: T, initValue?: any): T;

package/lib/form/hooks/useFormControlId.d.ts

@@ -0,0 +1,4 @@
+export declare function useFormControlId(id?: string, formControl?: any): {
+    wrapperId: string | undefined;
+    controlId: string;
+};

package/lib/form/hooks/useServerSideValidation.d.ts

@@ -0,0 +1,3 @@
+import type { SpsValidationStatus } from "../validation/types";
+import type { SpsAbstractControl } from "./SpsAbstractControl.interface";
+export declare function useServerSideValidation(formControl: SpsAbstractControl<any>, initialState?: SpsValidationStatus): (import("../validation/types").SpsValidationErrors | import("react").Dispatch<import("react").SetStateAction<import("../validation/types").SpsValidationErrors | null>> | null)[];

package/lib/form/hooks/useSpsForm.d.ts

@@ -0,0 +1,92 @@
+import type { SpsValidator } from "../validation/types";
+import { ValidationMode } from "./useCustomValidator";
+type PathComponent = string | number;
+type Path = PathComponent[];
+type UpdateFn = (path?: Path, newValue?: any, markAsBlurred?: boolean, newValidators?: Array<SpsValidator<any>>, markAsSubmitted?: boolean) => void;
+interface UpdateFormOptions {
+    validators?: SpsValidatorMap;
+    runValidators?: boolean;
+}
+export declare abstract class SpsFormMetaBase<T> {
+    #private;
+    path: Path;
+    update: UpdateFn;
+    validators: Array<SpsValidator<T>>;
+    preventativeErrors: string[];
+    submitted: boolean;
+    constructor(path: Path, update: UpdateFn);
+    get errors(): {
+        [x: string]: string | number | boolean | Record<string, any>;
+    } | null;
+    setValidators(newValidators: Array<SpsValidator<T>>): SpsFormMetaBase<T>;
+    validate(newValue: T, mode?: ValidationMode, skipUpdateAfterValidation?: boolean): SpsFormMetaBase<T>;
+    isValid(): boolean;
+    hasErrors(): boolean;
+    isVisibilyInvalid(): boolean;
+    hasError(errorKey: string): any;
+    hasPreventativeError(errorKey: string): boolean;
+    hasPreventativeErrors(): boolean;
+    isRequired(): boolean;
+    isSubmitted(): boolean;
+    onFocus(): void;
+    onBlur(): void;
+    abstract isPristine(): boolean;
+    abstract markAsPristine(): SpsFormMetaBase<T>;
+    abstract markAsDirty(): SpsFormMetaBase<T>;
+    abstract isFocused(): boolean;
+}
+export declare class SpsFormFieldMeta<T> extends SpsFormMetaBase<T> {
+    id: string;
+    focused: boolean;
+    pristine: boolean;
+    setValue(newValue: T): void;
+    isPristine(): boolean;
+    markAsPristine(): SpsFormFieldMeta<T>;
+    markAsDirty(): SpsFormFieldMeta<T>;
+    isFocused(): boolean;
+    markAsFocused(): SpsFormFieldMeta<T>;
+    markAsBlurred(): SpsFormFieldMeta<T>;
+    markAsSubmitted(): SpsFormFieldMeta<T>;
+}
+export type InferredSpsFormMeta<T> = SpsFormMetaBase<T> & (T extends any[] ? SpsFormArrayMeta<T> : T extends (Array<infer U> | undefined) ? SpsFormArrayMeta<U[]> | undefined : T extends object ? SpsFormGroupMeta<T> : T extends (object | undefined) ? SpsFormGroupMeta<object & T> | undefined : T extends boolean ? SpsFormFieldMeta<boolean> : T extends (infer V | undefined) ? SpsFormFieldMeta<V> | undefined : SpsFormFieldMeta<T>);
+export type SpsFormSetMembers<T> = {
+    [K in keyof T]?: SpsFormMetaBase<any>;
+};
+export type InferredSpsFormMetaSetMembers<T> = SpsFormSetMembers<T> & {
+    [K in keyof T]: InferredSpsFormMeta<T[K]>;
+};
+export type SpsFormSetValue = any[] | object;
+export declare abstract class SpsFormSetMeta<T extends SpsFormSetValue, U extends SpsFormSetMembers<T> = InferredSpsFormMetaSetMembers<T>> extends SpsFormFieldMeta<T> {
+    fields: U;
+    constructor(path: Path, update: UpdateFn);
+    constructor(inferMembersFromValue: T, path: Path, update: UpdateFn);
+    isFocused(): boolean;
+    isValid(): boolean;
+    hasErrors(): boolean;
+    contentsAreValid(): boolean;
+    isPristine(): boolean;
+    markAsPristine(): this;
+    markAsDirty(): this;
+    markAsBlurred(): this;
+    markAsSubmitted(): this;
+    protected inferSpsControl(valueOrControl: any, key: PathComponent): SpsFormMetaBase<any>;
+    private rollup;
+    protected abstract inferMembers(inferFromValue: T): any;
+}
+export declare class SpsFormGroupMeta<T extends object> extends SpsFormSetMeta<T> {
+    protected inferMembers(inferFromValue: T): void;
+}
+export declare class SpsFormArrayMeta<T extends any[]> extends SpsFormSetMeta<T> {
+    protected inferMembers(inferFromValue: T): void;
+}
+export interface SpsFormState<T extends SpsFormSetValue> {
+    formValue: T;
+    formMeta: SpsFormSetMeta<T>;
+    updateForm: (newValue?: T, options?: UpdateFormOptions) => void;
+    validateForm: () => boolean;
+    getCurrentFormValue: () => T;
+}
+export type SpsValidatorMapValue = Array<SpsValidator<any>> | ((value: any) => Array<SpsValidator<any>>);
+export type SpsValidatorMap = Record<string, SpsValidatorMapValue>;
+export declare function useSpsForm<T extends SpsFormSetValue>(value: T, validatorMap?: SpsValidatorMap): SpsFormState<T>;
+export {};

package/lib/form/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./hooks/useSpsForm";
+export * from "./hooks/formArray";
+export * from "./hooks/formControl";
+export * from "./hooks/formGroup";
+export * from "./hooks/SpsAbstractControl.interface";
+export * from "./hooks/SpsControlSet.interface";
+export * from "./hooks/useForm";
+export * from "./hooks/useServerSideValidation";
+export * from "./hooks/useCustomValidator";
+export * from "./validation/SpsValidators";
+export * from "./validation/types";
+export * from "./validation/validate";
+export { SpsForm } from "./SpsForm";
+export * from "./SpsForm.examples";
+export * from "./AddRemoveFormRows.examples";
+export { SpsFormComponentWrapper } from "./SpsFormComponentWrapper";

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

@@ -0,0 +1,20 @@
+import type { SpsValidator, SpsValidatorFactory } from "./types";
+export declare const SpsValidators: Readonly<{
+    min: SpsValidatorFactory<string | number>;
+    max: SpsValidatorFactory<string | number>;
+    required: SpsValidator<any>;
+    minLength: SpsValidatorFactory<string>;
+    minLengthArray: SpsValidatorFactory<any[]>;
+    maxLength: SpsValidatorFactory<string>;
+    maxLengthArray: SpsValidatorFactory<any[]>;
+    pattern: SpsValidatorFactory<string>;
+    alpha: SpsValidator<string>;
+    numeric: SpsValidator<string>;
+    nonNumeric: SpsValidator<string>;
+    positiveOrNegativeNumber: SpsValidator<string>;
+    OnBlurErrorKeys: Set<string>;
+    setDateFormat(format: string): void;
+    date: SpsValidator<import("@spscommerce/ds-shared").SimpleDate | import("@spscommerce/ds-shared").SimpleDateRange | import("moment").Moment | import("@spscommerce/ds-shared").SimpleMomentRange | null>;
+    dateRange: SpsValidator<import("@spscommerce/ds-shared").SimpleDateRange | import("moment").Duration | import("@spscommerce/ds-shared").SimpleMomentRange>;
+    dateConstraint: SpsValidatorFactory<import("@spscommerce/ds-shared").SimpleDate | import("@spscommerce/ds-shared").SimpleDateRange | import("moment").Moment | import("@spscommerce/ds-shared").SimpleMomentRange>;
+}>;