@spscommerce/ds-react 5.10.5-ie → 5.11.0

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>>)[];

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

@@ -0,0 +1,79 @@
+import type { SpsValidator, SpsValidationErrors } from "../validation/types";
+declare type PathComponent = string | number;
+declare type Path = PathComponent[];
+declare type UpdateFn = (path?: Path, newValue?: any, markAsBlurred?: boolean) => void;
+export declare abstract class SpsFormMetaBase<T> {
+    path: Path;
+    update: UpdateFn;
+    validators: Array<SpsValidator<T>>;
+    errors: SpsValidationErrors | null;
+    revealAllErrors: boolean;
+    preventativeErrors: any[];
+    constructor(path: Path, update: UpdateFn);
+    abstract isPristine(): boolean;
+    abstract markAsPristine(): SpsFormMetaBase<T>;
+    abstract markAsDirty(): SpsFormMetaBase<T>;
+    abstract isFocused(): boolean;
+    setValidators(newValidators: Array<SpsValidator<T>>): SpsFormMetaBase<T>;
+    validate(newValue: T): SpsFormMetaBase<T>;
+    isValid(): boolean;
+    hasErrors(): boolean;
+    isVisibilyInvalid(): boolean;
+    hasError(errorKey: string): any;
+    hasPreventativeError(errorKey: string): boolean;
+    hasPreventativeErrors(): boolean;
+    isRequired(): boolean;
+    onFocus(): void;
+    onBlur(): void;
+}
+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>;
+}
+export declare 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 declare type SpsFormSetMembers<T> = {
+    [K in keyof T]?: SpsFormMetaBase<any>;
+};
+export declare type InferredSpsFormMetaSetMembers<T> = SpsFormSetMembers<T> & {
+    [K in keyof T]: InferredSpsFormMeta<T[K]>;
+};
+export declare 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);
+    protected abstract inferMembers(inferFromValue: T): any;
+    protected inferSpsControl(valueOrControl: any, key: PathComponent): SpsFormMetaBase<any>;
+    private rollup;
+    isFocused(): boolean;
+    isValid(): boolean;
+    hasErrors(): boolean;
+    contentsAreValid(): boolean;
+    isPristine(): boolean;
+    markAsPristine(): this;
+    markAsDirty(): this;
+    markAsBlurred(): this;
+}
+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) => void;
+}
+export declare type SpsValidatorMapValue = Array<SpsValidator<any>> | ((value: any) => Array<SpsValidator<any>>);
+export declare 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,15 @@
+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 "./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,16 @@
+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>;
+    maxLength: SpsValidatorFactory<string>;
+    pattern: SpsValidatorFactory<string>;
+    alpha: SpsValidator<string>;
+    numeric: SpsValidator<string>;
+    nonNumeric: SpsValidator<string>;
+    OnBlurErrorKeys: Set<string>;
+    date: SpsValidator<import("@spscommerce/ds-shared").SimpleDate | import("@spscommerce/ds-shared").SimpleDateRange>;
+    dateRange: SpsValidator<import("@spscommerce/ds-shared").SimpleDateRange | import("moment").Duration>;
+    dateConstraint: SpsValidatorFactory<import("@spscommerce/ds-shared").SimpleDate | import("@spscommerce/ds-shared").SimpleDateRange>;
+}>;

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

@@ -0,0 +1,7 @@
+export declare type SpsValidationErrors = Record<string, boolean | number | string | Record<string, any>>;
+export declare type SpsValidationStatus = SpsValidationErrors | null;
+export declare type SpsValidator<T> = (value: T) => SpsValidationStatus;
+export declare type SpsValidatorFactory<T> = (...args: any[]) => SpsValidator<T>;
+export declare const OnBlurErrorKeys: Set<string>;
+export declare const AsTypingErrorKeys: Set<string>;
+export declare const PreventativeErrorKeys: Set<string>;

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

@@ -0,0 +1,2 @@
+import type { SpsValidationErrors, SpsValidator } from "./types";
+export declare function validate<T>(value: T, validators?: Array<SpsValidator<T>>): SpsValidationErrors | null;

package/lib/growler/SpsGrowler.d.ts

@@ -0,0 +1,17 @@
+import { GrowlerKind } from "@spscommerce/ds-shared";
+import * as React from "react";
+import * as PropTypes from "../prop-types";
+declare const propTypes: {
+    imgSrc: PropTypes.Requireable<string>;
+    kind: PropTypes.Requireable<GrowlerKind>;
+    onClose: PropTypes.Requireable<() => void>;
+    persist: PropTypes.Requireable<boolean>;
+    title: PropTypes.Requireable<string>;
+    children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+    className: PropTypes.Requireable<string>;
+    "data-testid": PropTypes.Requireable<string>;
+    unsafelyReplaceClassName: PropTypes.Requireable<string>;
+};
+export declare type SpsGrowlerProps = PropTypes.InferTS<typeof propTypes, HTMLDivElement>;
+export declare function SpsGrowler(props: SpsGrowlerProps): React.ReactPortal;
+export {};

package/lib/growler/SpsGrowler.examples.d.ts

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

package/lib/growler/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./SpsGrowler";
+export * from "./useGrowlers";
+export * from "./SpsGrowler.examples";

package/lib/growler/useGrowlers.d.ts

@@ -0,0 +1,12 @@
+import { GrowlerKind } from "@spscommerce/ds-shared";
+import type { ReactNodeOrRenderFn } from "../prop-types";
+export interface GrowlerConfig {
+    title?: string;
+    content: ReactNodeOrRenderFn;
+    kind?: GrowlerKind;
+    imgSrc?: string;
+    onClose?: () => void;
+    closed?: boolean;
+    id?: string;
+}
+export declare function useGrowlers(): [() => JSX.Element[], (config: GrowlerConfig) => void];

package/lib/i18n.d.ts

@@ -0,0 +1,3 @@
+import * as React from "react";
+import type { I18nObject } from "@spscommerce/ds-shared";
+export declare const I18nContext: React.Context<I18nObject>;

package/lib/icon/SpsIcon.d.ts

@@ -0,0 +1,13 @@
+import { SpsIcon as SpsIconEnum, SpsIconSize } from "@spscommerce/ds-shared";
+import * as PropTypes from "../prop-types";
+declare const propTypes: {
+    icon: PropTypes.Validator<SpsIconEnum>;
+    size: PropTypes.Requireable<SpsIconSize>;
+    children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+    className: PropTypes.Requireable<string>;
+    "data-testid": PropTypes.Requireable<string>;
+    unsafelyReplaceClassName: PropTypes.Requireable<string>;
+};
+export declare type SpsIconProps = PropTypes.InferTS<typeof propTypes, HTMLElement>;
+export declare function SpsI(props: SpsIconProps): JSX.Element;
+export {};

package/lib/icon/index.d.ts

@@ -0,0 +1 @@
+export * from "./SpsIcon";

package/lib/incrementor/SpsIncrementor.d.ts

@@ -0,0 +1,15 @@
+import * as PropTypes from "../prop-types";
+declare const propTypes: {
+    children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+    className: PropTypes.Requireable<string>;
+    "data-testid": PropTypes.Requireable<string>;
+    unsafelyReplaceClassName: PropTypes.Requireable<string>;
+    disabled: PropTypes.Requireable<boolean>;
+    min: PropTypes.Requireable<number>;
+    max: PropTypes.Requireable<number>;
+    step: PropTypes.Requireable<number>;
+    onValueChange: PropTypes.Requireable<(newValue: number) => void>;
+};
+export declare type SpsIncrementorProps = PropTypes.InferTS<typeof propTypes, HTMLDivElement>;
+export declare function SpsIncrementor(props: SpsIncrementorProps): JSX.Element;
+export {};

package/lib/incrementor/SpsIncrementor.examples.d.ts

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

package/lib/incrementor/index.d.ts

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