@overmap-ai/forms 1.0.0 → 1.0.1

package/dist/fields/BooleanField/BooleanField.d.ts

@@ -0,0 +1,15 @@
+import { ISerializedField, SerializedBooleanField } from "@overmap-ai/core";
+import { BaseField, ChildFieldOptions } from "../BaseField";
+import { ReactNode } from "react";
+import { ComponentProps } from "../typings";
+import { CheckCircledIcon } from "@overmap-ai/blocks";
+export declare class BooleanField extends BaseField<boolean, "boolean"> {
+    static readonly fieldTypeName = "Checkbox";
+    static readonly fieldTypeDescription = "Perfect for both optional and required yes/no questions.";
+    static Icon: typeof CheckCircledIcon;
+    constructor(options: ChildFieldOptions<boolean>);
+    protected isBlank(value: boolean): boolean;
+    serialize(): SerializedBooleanField;
+    static deserialize(data: ISerializedField): BooleanField;
+    getInput(props: ComponentProps<BooleanField>): ReactNode;
+}

package/dist/fields/DateField/DateField.d.ts

@@ -0,0 +1,14 @@
+import { ISerializedField, SerializedDateField } from "@overmap-ai/core";
+import { BaseField, ChildFieldOptions } from "../BaseField";
+import { GetInputProps } from "../typings";
+import React from "react";
+import { CalendarIcon } from "@overmap-ai/blocks";
+export declare class DateField extends BaseField<string, "date"> {
+    static readonly fieldTypeName = "Date";
+    static readonly fieldTypeDescription = "Allows specifying a date.";
+    static Icon: typeof CalendarIcon;
+    constructor(options: ChildFieldOptions<string>);
+    serialize(): SerializedDateField;
+    static deserialize(data: ISerializedField): DateField;
+    getInput(props: GetInputProps<this>): React.ReactNode;
+}

package/dist/fields/MultiStringField/MultiStringField.d.ts

@@ -0,0 +1,28 @@
+import { BaseField, ChildFieldOptions } from "../BaseField";
+import { ISerializedField, SelectFieldOption, SerializedMultiStringField } from "@overmap-ai/core";
+import { GetInputProps, InputFieldLevelValidator } from "../typings.ts";
+import { ReactNode } from "react";
+import { ListBulletIcon } from "@overmap-ai/blocks";
+type MultiStringFieldOptions = ChildFieldOptions<SelectFieldOption[]> & {
+    minimum_length?: number;
+    maximum_length?: number;
+};
+/**
+ * A field that lets the user input multiple strings. Each string must be unique. Useful for things like:
+ * - Specifying the options of a SelectField (used in `SelectField.getFieldCreationSchema`
+ * - Listing serial numbers and similar
+ */
+export declare class MultiStringField extends BaseField<SelectFieldOption[], "multi-string"> {
+    static readonly fieldTypeName = "Multi-string";
+    static readonly fieldTypeDescription = "Allows the user to provide multiple unique strings.";
+    readonly minLength: number;
+    readonly maxLength: number;
+    static Icon: typeof ListBulletIcon;
+    constructor(options: MultiStringFieldOptions);
+    getInput(props: GetInputProps<this>): ReactNode;
+    serialize(): SerializedMultiStringField;
+    protected isBlank(value: SelectFieldOption[]): boolean;
+    getFieldValidators(): InputFieldLevelValidator<SelectFieldOption[]>[];
+    static deserialize(data: ISerializedField): MultiStringField;
+}
+export {};

package/dist/fields/NumberField/NumberField.d.ts

@@ -0,0 +1,28 @@
+import { ISerializedField, SerializedNumberField } from "@overmap-ai/core";
+import { BooleanField } from "../BooleanField";
+import { BaseField, ChildFieldOptions } from "../BaseField";
+import { GetInputProps, InputFieldLevelValidator, InputValidator } from "../typings";
+import { ReactNode } from "react";
+import { FontFamilyIcon } from "@overmap-ai/blocks";
+export type NumberFieldValue = number | "";
+export interface NumberFieldOptions extends ChildFieldOptions<NumberFieldValue> {
+    maximum?: number;
+    minimum?: number;
+    integers?: boolean;
+}
+export declare class NumberField extends BaseField<NumberFieldValue, "number"> {
+    static readonly fieldTypeName = "Number";
+    static readonly fieldTypeDescription = "Allows specifying a number within a given range.";
+    readonly minimum: number | undefined;
+    readonly maximum: number | undefined;
+    readonly integers: boolean;
+    static Icon: typeof FontFamilyIcon;
+    constructor(options: NumberFieldOptions);
+    static _validateMin: InputValidator<NumberFieldValue>;
+    static _validateMax: InputValidator<NumberFieldValue>;
+    static getFieldCreationSchema(): (BooleanField | NumberField)[];
+    getFieldValidators(): InputFieldLevelValidator<NumberFieldValue>[];
+    serialize(): SerializedNumberField;
+    static deserialize(data: ISerializedField): NumberField;
+    getInput(props: GetInputProps<this>): ReactNode;
+}

package/dist/fields/SelectField/MultiSelectField.d.ts

@@ -0,0 +1,19 @@
+import { ISerializedField, SelectFieldOptionValue, SerializedMultiSelectField } from "@overmap-ai/core";
+import { ReactNode } from "react";
+import { GetInputProps } from "../typings";
+import { BaseSelectField, BaseSelectFieldOptions } from "./BaseSelectField";
+import { CheckboxIcon } from "@overmap-ai/blocks";
+/**
+ * The options passed to the constructor of MultiSelectField.
+ */
+export type MultiSelectFieldOptions = Omit<BaseSelectFieldOptions<SelectFieldOptionValue[], "multi-select">, "type">;
+export declare class MultiSelectField extends BaseSelectField<SelectFieldOptionValue[], "multi-select"> {
+    static readonly fieldTypeName = "Multi-select";
+    static readonly fieldTypeDescription = "Allows the user to select a multiple options from a list of options.";
+    static Icon: typeof CheckboxIcon;
+    constructor(options: MultiSelectFieldOptions);
+    protected isBlank(value: SelectFieldOptionValue[]): boolean;
+    serialize(): SerializedMultiSelectField;
+    static deserialize(data: ISerializedField): MultiSelectField;
+    getInput(props: GetInputProps<this>): ReactNode;
+}

package/dist/fields/SelectField/SelectField.d.ts

@@ -0,0 +1,18 @@
+import { ISerializedField, SelectFieldOptionValue, SerializedSelectField } from "@overmap-ai/core";
+import { ReactNode } from "react";
+import { GetInputProps } from "../typings";
+import { BaseSelectField, BaseSelectFieldOptions } from "./BaseSelectField";
+import { DropdownMenuIcon } from "@overmap-ai/blocks";
+/**
+ * The options passed to the constructor of SelectField.
+ */
+export type SelectFieldOptions = Omit<BaseSelectFieldOptions<SelectFieldOptionValue, "select">, "type">;
+export declare class SelectField extends BaseSelectField<SelectFieldOptionValue, "select"> {
+    static readonly fieldTypeName = "Dropdown";
+    static readonly fieldTypeDescription = "Allows the user to select a single option from a list of options.";
+    static Icon: typeof DropdownMenuIcon;
+    constructor(options: SelectFieldOptions);
+    serialize(): SerializedSelectField;
+    static deserialize(data: ISerializedField): SelectField;
+    getInput(props: GetInputProps<this>): ReactNode;
+}

package/dist/fields/StringOrTextFields/StringField/StringField.d.ts

@@ -0,0 +1,19 @@
+import { ISerializedField, SerializedStringField, StringInputType } from "@overmap-ai/core";
+import { StringOrTextField, StringOrTextFieldOptions } from "../StringOrTextField";
+import { GetInputProps } from "../../typings";
+import React from "react";
+import { InputIcon } from "@overmap-ai/blocks";
+interface StringFieldOptions extends Omit<StringOrTextFieldOptions, "type"> {
+    inputType?: StringInputType;
+}
+export declare class StringField extends StringOrTextField<"string"> {
+    static readonly fieldTypeName = "Short Text";
+    static readonly fieldTypeDescription = "Short text fields can hold up to 500 characters on a single line.";
+    readonly inputType: StringInputType;
+    static Icon: typeof InputIcon;
+    constructor(options: StringFieldOptions);
+    serialize(): SerializedStringField;
+    static deserialize(data: ISerializedField): StringField;
+    getInput(props: GetInputProps<this>): React.ReactNode;
+}
+export {};

package/dist/fields/StringOrTextFields/TextField/TextField.d.ts

@@ -0,0 +1,16 @@
+import { ISerializedField, SerializedTextField } from "@overmap-ai/core";
+import { StringOrTextField, StringOrTextFieldOptions } from "../StringOrTextField";
+import { GetInputProps } from "../../typings";
+import React from "react";
+import { RowsIcon } from "@overmap-ai/blocks";
+export interface TextFieldOptions extends Omit<StringOrTextFieldOptions, "type"> {
+}
+export declare class TextField extends StringOrTextField<"text"> {
+    static readonly fieldTypeName = "Paragraph";
+    static readonly fieldTypeDescription = "Paragraph fields can hold up to 5000 characters and can have multiple lines.";
+    static Icon: typeof RowsIcon;
+    constructor(options: TextFieldOptions);
+    serialize(): SerializedTextField;
+    static deserialize(data: ISerializedField): TextField;
+    getInput(props: GetInputProps<this>): React.ReactNode;
+}

package/package.json

@@ -3,7 +3,7 @@
   "description": "Form functionality for Overmap",
   "author": "Wôrdn Inc.",
   "license": "UNLICENSED",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "main": "dist/forms.umd.cjs",
   "module": "dist/forms.js",