react-store-input 0.2.5 → 0.4.0

package/dist/index.d.mts

@@ -1,11 +1,128 @@
-export { StoreControllerProps, useStoreController } from './use_store_controller.mjs';
-export { InferNameFromProps, StoreInputWithNameProps, useStoreInputWithName } from './use_store_input_with_name.mjs';
-export { StoreInputProps, useStoreInput } from './use_store_input.mjs';
-export { Input, Select, StoreComponentPropsWithStore, StoreInputWithNameComponentProps, Textarea, useStoreComponent } from './use_store_component.mjs';
-export { FormStore, useFormStore } from './use_form_store.mjs';
-export { TextEditor, TextEditorProps } from './text_editor.mjs';
-import 'gw-store';
-import 'react';
-import 'react/jsx-runtime';
-import './create_render.mjs';
-import 'gw-react-text-editor';
+import { Immutable, Draft } from 'immer';
+import { Store, EqualityFn } from 'gw-store';
+export * from 'gw-store';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { ReactNode, ChangeEvent, HTMLInputTypeAttribute, RefObject, InputHTMLAttributes, SelectHTMLAttributes, TextareaHTMLAttributes } from 'react';
+import { Result } from 'gw-result';
+export { Result, err, ok } from 'gw-result';
+
+type StoreControllerProps<TState extends object> = {
+    onSubscribe: (state: Immutable<TState>) => void;
+    onDispatch: (state: Draft<TState>) => void;
+};
+declare function useStoreController<TState extends object>(store: Store<TState>, props: StoreControllerProps<TState>): {
+    dispatch: () => void;
+};
+
+type CreateRender<TState extends object> = (selector: (state: Immutable<TState>) => ReactNode, compare?: EqualityFn<Immutable<TState>>) => ReactNode;
+declare function createRender<TState extends object>(store: Store<TState>, selector: (state: Immutable<TState>) => ReactNode, compare?: EqualityFn<Immutable<TState>>): react_jsx_runtime.JSX.Element;
+declare function createRenderWithStore<TState extends object>(store: Store<TState>): CreateRender<TState>;
+
+type Lens<TState extends object, TValue> = {
+    get: (state: Immutable<TState>) => TValue;
+    set: (state: Draft<TState>, value: TValue) => void;
+};
+type LensBuilder<TState extends object, TValue> = Lens<TState, TValue> & (TValue extends object ? {
+    prop<TKey extends keyof TValue>(key: TKey): LensBuilder<TState, TValue[TKey]>;
+} : object);
+type StateLens<TState extends object> = {
+    prop<TKey extends keyof TState>(key: TKey): LensBuilder<TState, TState[TKey]>;
+};
+declare function defineLens<TState extends object, TValue>(lens: Lens<TState, TValue>): Lens<TState, TValue>;
+declare function stateLens<TState extends object>(): StateLens<TState>;
+
+type Codec<TValue, TInput, TError = never> = {
+    format: (value: TValue) => TInput;
+    parse: (input: TInput) => Result<TValue, TError>;
+    equals?: (previous: TValue, next: TValue) => boolean;
+};
+declare function defineCodec<TValue, TInput, TError = never>(codec: Codec<TValue, TInput, TError>): Codec<TValue, TInput, TError>;
+
+type InputBinding<TState extends object, TValue, TInput, TError = never> = {
+    lens: Lens<TState, TValue>;
+    codec: Codec<TValue, TInput, TError>;
+};
+declare function defineBinding<TState extends object, TValue, TInput, TError = never>(binding: InputBinding<TState, TValue, TInput, TError>): InputBinding<TState, TValue, TInput, TError>;
+
+type Equality<TValue> = (previous: TValue, next: TValue) => boolean;
+declare function assertLensLaws<TState extends object, TValue>(lens: Lens<TState, TValue>, options: {
+    state: TState;
+    values: readonly TValue[];
+    equalsState?: Equality<TState>;
+    equalsValue?: Equality<TValue>;
+}): void;
+declare function assertCodecLaws<TValue, TInput, TError>(codec: Codec<TValue, TInput, TError>, options: {
+    values: readonly TValue[];
+    inputs?: readonly TInput[];
+    equals?: Equality<TValue>;
+    equalsInput?: Equality<TInput>;
+}): void;
+
+type InputDisplayValue = string | number | readonly string[];
+type InputStateValue = string | string[];
+type InputControlValue = string | readonly string[] | number | boolean | FileList | null;
+type StoreInputOptions<TInputElement> = {
+    type?: HTMLInputTypeAttribute;
+    defaultValue?: InputDisplayValue;
+    value?: InputDisplayValue;
+    checked?: boolean;
+    defaultChecked?: boolean;
+    multiple?: boolean;
+    onChange?: (event: ChangeEvent<TInputElement>) => void;
+};
+type StoreInputBindingOptions<TInputElement, TValue> = StoreInputOptions<TInputElement> & {
+    resetValue?: TValue;
+};
+type StoreInputDomProps<TInputElement> = {
+    defaultValue?: InputDisplayValue;
+    defaultChecked?: boolean;
+    onChange: (event: ChangeEvent<TInputElement>) => void;
+};
+type StoreInputMeta<TError> = {
+    valid: true;
+    error?: never;
+} | {
+    valid: false;
+    error: TError;
+};
+type BindingInputResult<TInputElement, TError> = {
+    inputProps: StoreInputDomProps<TInputElement>;
+    meta: StoreInputMeta<TError>;
+};
+
+type StoreElement$2 = HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement;
+declare function useStoreInput<TInputElement extends StoreElement$2, TState extends object, TValue, TInput extends InputControlValue, TError>(ref: RefObject<TInputElement | null>, store: Store<TState>, binding: InputBinding<TState, TValue, TInput, TError>, options?: StoreInputBindingOptions<TInputElement, TValue>): BindingInputResult<TInputElement, TError>;
+
+type StoreElement$1 = HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement;
+type StoreInputWithNameProps<TInputElement, TState extends object, TName extends keyof TState> = StoreInputOptions<TInputElement> & {
+    name: TName;
+};
+declare function useStoreInputWithName<TInputElement extends StoreElement$1, TState extends object, TName extends keyof TState>(ref: RefObject<TInputElement | null>, store: Store<TState>, props: StoreInputWithNameProps<TInputElement, TState, TName>): {
+    name: string;
+    defaultValue?: InputDisplayValue;
+    defaultChecked?: boolean;
+    onChange: (event: react.ChangeEvent<TInputElement>) => void;
+};
+
+type StoreElement = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement;
+type ElementAttributes<TElement extends StoreElement> = TElement extends HTMLInputElement ? InputHTMLAttributes<HTMLInputElement> : TElement extends HTMLSelectElement ? SelectHTMLAttributes<HTMLSelectElement> : TextareaHTMLAttributes<HTMLTextAreaElement>;
+type StoreInputWithNameComponentProps<TElement extends StoreElement, TState extends object, TName extends keyof TState> = StoreInputWithNameProps<TElement, TState, TName> & Omit<ElementAttributes<TElement>, keyof StoreInputWithNameProps<TElement, TState, TName>>;
+type StoreComponentPropsWithStore<TElement extends StoreElement, TState extends object, TName extends keyof TState> = StoreInputWithNameComponentProps<TElement, TState, TName> & {
+    store: Store<TState>;
+};
+declare function Input<TState extends object, TName extends keyof TState>({ store, ...props }: StoreComponentPropsWithStore<HTMLInputElement, TState, TName>): react_jsx_runtime.JSX.Element;
+declare function Select<TState extends object, TName extends keyof TState>({ store, ...props }: StoreComponentPropsWithStore<HTMLSelectElement, TState, TName>): react_jsx_runtime.JSX.Element;
+declare function Textarea<TState extends object, TName extends keyof TState>({ store, ...props }: StoreComponentPropsWithStore<HTMLTextAreaElement, TState, TName>): react_jsx_runtime.JSX.Element;
+declare function useStoreComponent<TState extends object>(store: Store<TState>): {
+    input: <TName extends keyof TState>(props: StoreInputWithNameComponentProps<HTMLInputElement, TState, TName>) => react_jsx_runtime.JSX.Element;
+    select: <TName extends keyof TState>(props: StoreInputWithNameComponentProps<HTMLSelectElement, TState, TName>) => react_jsx_runtime.JSX.Element;
+    textarea: <TName extends keyof TState>(props: StoreInputWithNameComponentProps<HTMLTextAreaElement, TState, TName>) => react_jsx_runtime.JSX.Element;
+};
+
+type FormStore<TState extends object> = Store<TState> & ReturnType<typeof useStoreComponent<TState>> & {
+    render: CreateRender<TState>;
+};
+declare function useFormStore<TState extends object>(initialState: TState): FormStore<TState>;
+
+export { type BindingInputResult, type Codec, type CreateRender, type FormStore, Input, type InputBinding, type InputControlValue, type InputDisplayValue, type InputStateValue, type Lens, type LensBuilder, Select, type StateLens, type StoreComponentPropsWithStore, type StoreControllerProps, type StoreInputBindingOptions, type StoreInputDomProps, type StoreInputMeta, type StoreInputOptions, type StoreInputWithNameComponentProps, type StoreInputWithNameProps, Textarea, assertCodecLaws, assertLensLaws, createRender, createRenderWithStore, defineBinding, defineCodec, defineLens, stateLens, useFormStore, useStoreComponent, useStoreController, useStoreInput, useStoreInputWithName };

package/dist/index.d.ts

@@ -1,11 +1,128 @@
-export { StoreControllerProps, useStoreController } from './use_store_controller.js';
-export { InferNameFromProps, StoreInputWithNameProps, useStoreInputWithName } from './use_store_input_with_name.js';
-export { StoreInputProps, useStoreInput } from './use_store_input.js';
-export { Input, Select, StoreComponentPropsWithStore, StoreInputWithNameComponentProps, Textarea, useStoreComponent } from './use_store_component.js';
-export { FormStore, useFormStore } from './use_form_store.js';
-export { TextEditor, TextEditorProps } from './text_editor.js';
-import 'gw-store';
-import 'react';
-import 'react/jsx-runtime';
-import './create_render.js';
-import 'gw-react-text-editor';
+import { Immutable, Draft } from 'immer';
+import { Store, EqualityFn } from 'gw-store';
+export * from 'gw-store';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { ReactNode, ChangeEvent, HTMLInputTypeAttribute, RefObject, InputHTMLAttributes, SelectHTMLAttributes, TextareaHTMLAttributes } from 'react';
+import { Result } from 'gw-result';
+export { Result, err, ok } from 'gw-result';
+
+type StoreControllerProps<TState extends object> = {
+    onSubscribe: (state: Immutable<TState>) => void;
+    onDispatch: (state: Draft<TState>) => void;
+};
+declare function useStoreController<TState extends object>(store: Store<TState>, props: StoreControllerProps<TState>): {
+    dispatch: () => void;
+};
+
+type CreateRender<TState extends object> = (selector: (state: Immutable<TState>) => ReactNode, compare?: EqualityFn<Immutable<TState>>) => ReactNode;
+declare function createRender<TState extends object>(store: Store<TState>, selector: (state: Immutable<TState>) => ReactNode, compare?: EqualityFn<Immutable<TState>>): react_jsx_runtime.JSX.Element;
+declare function createRenderWithStore<TState extends object>(store: Store<TState>): CreateRender<TState>;
+
+type Lens<TState extends object, TValue> = {
+    get: (state: Immutable<TState>) => TValue;
+    set: (state: Draft<TState>, value: TValue) => void;
+};
+type LensBuilder<TState extends object, TValue> = Lens<TState, TValue> & (TValue extends object ? {
+    prop<TKey extends keyof TValue>(key: TKey): LensBuilder<TState, TValue[TKey]>;
+} : object);
+type StateLens<TState extends object> = {
+    prop<TKey extends keyof TState>(key: TKey): LensBuilder<TState, TState[TKey]>;
+};
+declare function defineLens<TState extends object, TValue>(lens: Lens<TState, TValue>): Lens<TState, TValue>;
+declare function stateLens<TState extends object>(): StateLens<TState>;
+
+type Codec<TValue, TInput, TError = never> = {
+    format: (value: TValue) => TInput;
+    parse: (input: TInput) => Result<TValue, TError>;
+    equals?: (previous: TValue, next: TValue) => boolean;
+};
+declare function defineCodec<TValue, TInput, TError = never>(codec: Codec<TValue, TInput, TError>): Codec<TValue, TInput, TError>;
+
+type InputBinding<TState extends object, TValue, TInput, TError = never> = {
+    lens: Lens<TState, TValue>;
+    codec: Codec<TValue, TInput, TError>;
+};
+declare function defineBinding<TState extends object, TValue, TInput, TError = never>(binding: InputBinding<TState, TValue, TInput, TError>): InputBinding<TState, TValue, TInput, TError>;
+
+type Equality<TValue> = (previous: TValue, next: TValue) => boolean;
+declare function assertLensLaws<TState extends object, TValue>(lens: Lens<TState, TValue>, options: {
+    state: TState;
+    values: readonly TValue[];
+    equalsState?: Equality<TState>;
+    equalsValue?: Equality<TValue>;
+}): void;
+declare function assertCodecLaws<TValue, TInput, TError>(codec: Codec<TValue, TInput, TError>, options: {
+    values: readonly TValue[];
+    inputs?: readonly TInput[];
+    equals?: Equality<TValue>;
+    equalsInput?: Equality<TInput>;
+}): void;
+
+type InputDisplayValue = string | number | readonly string[];
+type InputStateValue = string | string[];
+type InputControlValue = string | readonly string[] | number | boolean | FileList | null;
+type StoreInputOptions<TInputElement> = {
+    type?: HTMLInputTypeAttribute;
+    defaultValue?: InputDisplayValue;
+    value?: InputDisplayValue;
+    checked?: boolean;
+    defaultChecked?: boolean;
+    multiple?: boolean;
+    onChange?: (event: ChangeEvent<TInputElement>) => void;
+};
+type StoreInputBindingOptions<TInputElement, TValue> = StoreInputOptions<TInputElement> & {
+    resetValue?: TValue;
+};
+type StoreInputDomProps<TInputElement> = {
+    defaultValue?: InputDisplayValue;
+    defaultChecked?: boolean;
+    onChange: (event: ChangeEvent<TInputElement>) => void;
+};
+type StoreInputMeta<TError> = {
+    valid: true;
+    error?: never;
+} | {
+    valid: false;
+    error: TError;
+};
+type BindingInputResult<TInputElement, TError> = {
+    inputProps: StoreInputDomProps<TInputElement>;
+    meta: StoreInputMeta<TError>;
+};
+
+type StoreElement$2 = HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement;
+declare function useStoreInput<TInputElement extends StoreElement$2, TState extends object, TValue, TInput extends InputControlValue, TError>(ref: RefObject<TInputElement | null>, store: Store<TState>, binding: InputBinding<TState, TValue, TInput, TError>, options?: StoreInputBindingOptions<TInputElement, TValue>): BindingInputResult<TInputElement, TError>;
+
+type StoreElement$1 = HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement;
+type StoreInputWithNameProps<TInputElement, TState extends object, TName extends keyof TState> = StoreInputOptions<TInputElement> & {
+    name: TName;
+};
+declare function useStoreInputWithName<TInputElement extends StoreElement$1, TState extends object, TName extends keyof TState>(ref: RefObject<TInputElement | null>, store: Store<TState>, props: StoreInputWithNameProps<TInputElement, TState, TName>): {
+    name: string;
+    defaultValue?: InputDisplayValue;
+    defaultChecked?: boolean;
+    onChange: (event: react.ChangeEvent<TInputElement>) => void;
+};
+
+type StoreElement = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement;
+type ElementAttributes<TElement extends StoreElement> = TElement extends HTMLInputElement ? InputHTMLAttributes<HTMLInputElement> : TElement extends HTMLSelectElement ? SelectHTMLAttributes<HTMLSelectElement> : TextareaHTMLAttributes<HTMLTextAreaElement>;
+type StoreInputWithNameComponentProps<TElement extends StoreElement, TState extends object, TName extends keyof TState> = StoreInputWithNameProps<TElement, TState, TName> & Omit<ElementAttributes<TElement>, keyof StoreInputWithNameProps<TElement, TState, TName>>;
+type StoreComponentPropsWithStore<TElement extends StoreElement, TState extends object, TName extends keyof TState> = StoreInputWithNameComponentProps<TElement, TState, TName> & {
+    store: Store<TState>;
+};
+declare function Input<TState extends object, TName extends keyof TState>({ store, ...props }: StoreComponentPropsWithStore<HTMLInputElement, TState, TName>): react_jsx_runtime.JSX.Element;
+declare function Select<TState extends object, TName extends keyof TState>({ store, ...props }: StoreComponentPropsWithStore<HTMLSelectElement, TState, TName>): react_jsx_runtime.JSX.Element;
+declare function Textarea<TState extends object, TName extends keyof TState>({ store, ...props }: StoreComponentPropsWithStore<HTMLTextAreaElement, TState, TName>): react_jsx_runtime.JSX.Element;
+declare function useStoreComponent<TState extends object>(store: Store<TState>): {
+    input: <TName extends keyof TState>(props: StoreInputWithNameComponentProps<HTMLInputElement, TState, TName>) => react_jsx_runtime.JSX.Element;
+    select: <TName extends keyof TState>(props: StoreInputWithNameComponentProps<HTMLSelectElement, TState, TName>) => react_jsx_runtime.JSX.Element;
+    textarea: <TName extends keyof TState>(props: StoreInputWithNameComponentProps<HTMLTextAreaElement, TState, TName>) => react_jsx_runtime.JSX.Element;
+};
+
+type FormStore<TState extends object> = Store<TState> & ReturnType<typeof useStoreComponent<TState>> & {
+    render: CreateRender<TState>;
+};
+declare function useFormStore<TState extends object>(initialState: TState): FormStore<TState>;
+
+export { type BindingInputResult, type Codec, type CreateRender, type FormStore, Input, type InputBinding, type InputControlValue, type InputDisplayValue, type InputStateValue, type Lens, type LensBuilder, Select, type StateLens, type StoreComponentPropsWithStore, type StoreControllerProps, type StoreInputBindingOptions, type StoreInputDomProps, type StoreInputMeta, type StoreInputOptions, type StoreInputWithNameComponentProps, type StoreInputWithNameProps, Textarea, assertCodecLaws, assertLensLaws, createRender, createRenderWithStore, defineBinding, defineCodec, defineLens, stateLens, useFormStore, useStoreComponent, useStoreController, useStoreInput, useStoreInputWithName };