formhell 0.1.5

package/dist/index.d.ts

@@ -0,0 +1,127 @@
+import * as react from 'react';
+import { ReactNode, ComponentType } from 'react';
+
+type JSONSchemaType = "string" | "number" | "integer" | "boolean" | "object" | "array" | "null";
+interface JSONSchema {
+    $id?: string;
+    $schema?: string;
+    $ref?: string;
+    title?: string;
+    description?: string;
+    type?: JSONSchemaType | JSONSchemaType[];
+    enum?: unknown[];
+    default?: unknown;
+    multipleOf?: number;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number;
+    exclusiveMaximum?: number;
+    minProperties?: number;
+    maxProperties?: number;
+    deprecated?: boolean;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    examples?: unknown[];
+    properties?: Record<string, JSONSchema>;
+    patternProperties?: Record<string, JSONSchema>;
+    required?: string[];
+    dependentRequired?: Record<string, string[]>;
+    dependentSchemas?: Record<string, JSONSchema>;
+    items?: JSONSchema | boolean;
+    prefixItems?: JSONSchema[];
+    unevaluatedItems?: JSONSchema;
+    additionalProperties?: boolean | JSONSchema;
+    unevaluatedProperties?: JSONSchema;
+    propertyNames?: JSONSchema;
+    oneOf?: JSONSchema[];
+    anyOf?: JSONSchema[];
+    allOf?: JSONSchema[];
+    not?: JSONSchema;
+    if?: JSONSchema;
+    then?: JSONSchema;
+    else?: JSONSchema;
+    [key: string]: unknown;
+}
+type OutputData = unknown;
+type PeerSchemasInput = JSONSchema[] | Record<string, JSONSchema>;
+
+interface FieldComponentProps<TValue = unknown> {
+    label: string;
+    required: boolean;
+    pointer: string;
+    schema: JSONSchema;
+    value: TValue;
+    disabled?: boolean;
+    controls?: ReactNode;
+    onChange: (next: TValue) => void;
+}
+interface SchemaFormObjectProps extends FieldComponentProps<Record<string, unknown>> {
+    children: ReactNode;
+}
+interface SchemaFormArrayProps extends FieldComponentProps<unknown[]> {
+    itemsSchema?: JSONSchema;
+    itemSchemas?: JSONSchema[];
+    canAddItem?: boolean;
+    canRemoveItems?: boolean;
+    renderItem: (index: number, pointer: string, value: unknown) => ReactNode;
+    createDefaultItem: () => unknown;
+}
+type SchemaPointerWidget = ComponentType<any>;
+interface SchemaFormWidgets {
+    [schemaPointer: string]: SchemaPointerWidget | undefined;
+    String?: ComponentType<FieldComponentProps<string>>;
+    Select?: ComponentType<FieldComponentProps<unknown>>;
+    Boolean?: ComponentType<FieldComponentProps<boolean>>;
+    Number?: ComponentType<FieldComponentProps<number | undefined>>;
+    Integer?: ComponentType<FieldComponentProps<number | undefined>>;
+    Null?: ComponentType<FieldComponentProps<null>>;
+    Object?: ComponentType<SchemaFormObjectProps>;
+    Array?: ComponentType<SchemaFormArrayProps>;
+}
+interface SchemaFormOptions {
+    defaults?: "all" | "required-only";
+}
+interface SchemaFormProps {
+    schema: JSONSchema;
+    peerSchemas?: PeerSchemasInput;
+    getSchema?: (requestedSchema: string) => Promise<JSONSchema>;
+    widgets?: SchemaFormWidgets;
+    options?: SchemaFormOptions;
+    data?: OutputData;
+    onChange?: (data: OutputData, validationErrors: SchemaFormValidationError[], fieldPointer: string, prev: any, next: any) => void;
+}
+interface SchemaFormValidationError {
+    message: string;
+    source: "schema" | "peerSchemas" | "ref-resolution" | "data";
+}
+interface SchemaBuilderProps {
+    schema?: JSONSchema;
+    domain?: string;
+    onChange?: (schema: JSONSchema, validationErrors: SchemaBuilderValidationError[]) => void;
+}
+interface SchemaBuilderHelperContentEntry {
+    longDetails: string;
+    label?: string;
+}
+type SchemaBuilderHelperContent = Record<string, string | SchemaBuilderHelperContentEntry>;
+interface SchemaBuilderHelperProps {
+    debounceMs?: number;
+    maxResults?: number;
+    placeholder?: string;
+    initialQuery?: string;
+    helpContent?: SchemaBuilderHelperContent;
+}
+interface SchemaBuilderValidationError {
+    message: string;
+    keyword?: string;
+    instancePath?: string;
+    schemaPath?: string;
+    source: "schema" | "json-parse";
+}
+
+declare function SchemaForm({ schema, peerSchemas, getSchema, widgets, options, data, onChange }: SchemaFormProps): react.JSX.Element;
+
+declare function SchemaBuilderHelper({ debounceMs, maxResults, placeholder, initialQuery, helpContent }: SchemaBuilderHelperProps): react.JSX.Element;
+declare function SchemaBuilder({ schema, domain, onChange }: SchemaBuilderProps): react.JSX.Element;
+
+export { type FieldComponentProps, type JSONSchema, type JSONSchemaType, type OutputData, type PeerSchemasInput, SchemaBuilder, SchemaBuilderHelper, type SchemaBuilderHelperContent, type SchemaBuilderHelperContentEntry, type SchemaBuilderHelperProps, type SchemaBuilderProps, type SchemaBuilderValidationError, SchemaForm, type SchemaFormOptions, type SchemaFormProps, type SchemaFormValidationError, type SchemaFormWidgets };