atom.io 0.28.1 → 0.29.0

package/react-devtools/dist/index.d.ts

@@ -1,3 +1,160 @@
-declare const AtomIODevtools: () => JSX.Element;
+import { DetailedHTMLProps, InputHTMLAttributes, ForwardRefExoticComponent, FC, ErrorInfo, ReactNode, Component, CSSProperties, ReactElement } from 'react';
+import { JsonTypes, Json } from 'atom.io/json';
 
-export { AtomIODevtools };
+declare const AtomIODevtools: React.FC;
+
+type ElasticInputProps = DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement> & {
+    widthPadding?: number;
+};
+declare const ElasticInput: ForwardRefExoticComponent<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement> & {
+    widthPadding?: number;
+}>;
+
+declare function clampInto(min: number, max: number): (value: number) => number;
+declare const VALID_NON_NUMBERS: readonly ["", "-", ".", "-."];
+type ValidNonNumber = (typeof VALID_NON_NUMBERS)[number];
+declare const isValidNonNumber: (input: string) => input is ValidNonNumber;
+declare const VALID_NON_NUMBER_INTERPRETATIONS: Readonly<Record<ValidNonNumber, number | null>>;
+type DecimalInProgress = `${number | ``}.${number}`;
+declare const isDecimalInProgress: (input: string) => input is DecimalInProgress;
+type NumberConstraints = {
+    max: number;
+    min: number;
+    decimalPlaces: number;
+    nullable: boolean;
+};
+declare const DEFAULT_NUMBER_CONSTRAINTS: NumberConstraints;
+type NumberInputProps = Partial<NumberConstraints> & {
+    autoSize?: boolean;
+    disabled?: boolean;
+    id?: string;
+    label?: string;
+    name?: string;
+    onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    onClick?: (e: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
+    placeholder?: string;
+    set?: ((newValue: number | null) => void) | undefined;
+    testid?: string;
+    value?: number | null;
+};
+declare const NumberInput: FC<NumberInputProps>;
+
+type TextInputProps = {
+    value: string;
+    set?: ((value: string) => void) | undefined;
+    label?: string;
+    placeholder?: string;
+    autoSize?: boolean;
+    readOnly?: boolean;
+    testid?: string;
+};
+declare const TextInput: FC<TextInputProps>;
+
+type FallbackProps = {
+    error?: Error | string | undefined;
+    errorInfo?: ErrorInfo | undefined;
+};
+declare const DefaultFallback: FC<FallbackProps>;
+
+type ErrorBoundaryState = {
+    error?: Error | string;
+    errorInfo?: ErrorInfo;
+};
+type ErrorBoundaryProps = {
+    children: ReactNode;
+    onError?: ((error: Error | string, errorInfo: ErrorInfo) => void) | undefined;
+    Fallback?: FC<FallbackProps> | undefined;
+    useResetErrorState?: () => () => void;
+    useErrorState?: () => [
+        ErrorBoundaryState,
+        (newState: ErrorBoundaryState | ((currState: ErrorBoundaryState) => ErrorBoundaryState)) => void
+    ];
+};
+declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    constructor(props: ErrorBoundaryProps);
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): ReactNode;
+}
+
+type Dict<T> = Record<string, T>;
+type WrapperComponent<T extends Dict<unknown> = Dict<unknown>> = FC<T & {
+    children: ReactNode;
+    testid?: string | undefined;
+}>;
+type WC<T extends Dict<unknown> = Dict<unknown>> = WrapperComponent<T>;
+type JsonEditorComponents = {
+    ErrorBoundary: WC;
+    Button: WC<{
+        onClick?: () => void;
+        disabled?: boolean;
+    }>;
+    DeleteIcon: FC;
+    EditorWrapper: WC<{
+        style?: CSSProperties | undefined;
+        className?: string | undefined;
+        testid?: string | undefined;
+    }>;
+    ArrayWrapper: WC;
+    ObjectWrapper: WC;
+    StringWrapper: WC;
+    NumberWrapper: WC;
+    BooleanWrapper: WC;
+    Null: FC<{
+        testid?: string | undefined;
+    }>;
+    MissingPropertyWrapper: WC;
+    KeyWrapper: WC;
+};
+declare const DEFAULT_JSON_EDITOR_COMPONENTS: JsonEditorComponents;
+
+type JsonEditorProps_INTERNAL<T> = {
+    data: T;
+    set: SetterOrUpdater<T>;
+    name?: string | undefined;
+    rename?: ((newKey: string) => void) | undefined;
+    remove?: (() => void) | undefined;
+    recast?: (newType: keyof JsonTypes) => void;
+    path?: ReadonlyArray<number | string>;
+    isReadonly?: (path: ReadonlyArray<number | string>) => boolean;
+    isHidden?: (path: ReadonlyArray<number | string>) => boolean;
+    className?: string | undefined;
+    style?: CSSProperties | undefined;
+    Header?: FC<{
+        data: T;
+    }> | undefined;
+    Components: JsonEditorComponents;
+    testid?: string | undefined;
+};
+
+type JsonEditorProps<T> = {
+    data: T;
+    set: (valOrUpdater: T | ((currVal: T) => T)) => void;
+    name?: string | undefined;
+    rename?: ((newKey: string) => void) | undefined;
+    remove?: () => void;
+    path?: ReadonlyArray<number | string>;
+    isReadonly?: (path: ReadonlyArray<number | string>) => boolean;
+    isHidden?: (path: ReadonlyArray<number | string>) => boolean;
+    className?: string;
+    style?: CSSProperties;
+    Header?: FC<{
+        data: T;
+    }>;
+    Components?: Partial<JsonEditorComponents>;
+    testid?: string;
+};
+declare const JsonEditor: <T>({ data, set, name, rename, remove, isReadonly, isHidden, className, Header, style, Components: CustomComponents, testid, }: JsonEditorProps<T>) => ReactElement;
+
+declare const castToJson: (input: unknown) => {
+    array: Json.Tree.Array;
+    boolean: boolean;
+    number: number;
+    object: Json.Tree.Object;
+    string: string;
+    null: null;
+};
+
+type SetterOrUpdater<T> = <New extends T>(next: New | ((old: T) => New)) => void;
+declare const SubEditors: Record<keyof JsonTypes, FC<JsonEditorProps_INTERNAL<any>>>;
+
+export { AtomIODevtools, DEFAULT_JSON_EDITOR_COMPONENTS, DEFAULT_NUMBER_CONSTRAINTS, type DecimalInProgress, DefaultFallback, type Dict, ElasticInput, type ElasticInputProps, ErrorBoundary, type ErrorBoundaryProps, type ErrorBoundaryState, type FallbackProps, JsonEditor, type JsonEditorComponents, type JsonEditorProps, type NumberConstraints, NumberInput, type SetterOrUpdater, SubEditors, TextInput, type TextInputProps, VALID_NON_NUMBERS, VALID_NON_NUMBER_INTERPRETATIONS, type ValidNonNumber, type WC, type WrapperComponent, castToJson, clampInto, isDecimalInProgress, isValidNonNumber };