@overmap-ai/core 1.0.29-org-switcher-and-bug-fixes.7 → 1.0.30

package/dist/forms/renderer/FormSubmissionBrowser/FormSubmissionBrowser.d.ts

@@ -0,0 +1,28 @@
+import React, { ReactNode } from "react";
+import { Offline, UserFormSubmission, UserFormSubmissionPayload } from "../../../typings";
+export interface FormSubmissionClickEvent {
+    submission: Offline<UserFormSubmissionPayload>;
+}
+interface UserFormSubmissionBrowserEntryProps {
+    submission: Offline<UserFormSubmissionPayload> | UserFormSubmission;
+    onSubmissionClick?: (e: FormSubmissionClickEvent) => void;
+    rowDecorator?: (submission: Offline<UserFormSubmissionPayload> | UserFormSubmission, Row: ReactNode) => ReactNode;
+    compact: boolean;
+    labelType: "creator" | "formName";
+}
+interface FormSubmissionBrowserProps {
+    formId?: string;
+    submissions?: (Offline<UserFormSubmissionPayload> | UserFormSubmission)[];
+    onSubmissionClick?: (e: FormSubmissionClickEvent) => void;
+    rowDecorator?: UserFormSubmissionBrowserEntryProps["rowDecorator"];
+    /** @default false */
+    compact?: boolean;
+    labelType: "creator" | "formName";
+    className?: string;
+    /** @default outline */
+    variant?: "ghost" | "outline";
+    /** Content displayed within the container but after the list */
+    after?: ReactNode;
+}
+export declare const FormSubmissionBrowser: React.NamedExoticComponent<FormSubmissionBrowserProps>;
+export {};

package/dist/forms/renderer/FormSubmissionViewer/FormSubmissionViewer.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="react" />
+import { Offline, UserFormSubmissionPayload } from "../../../typings";
+interface FormSubmissionViewerProps {
+    /** The submission to render for viewing */
+    submission: Offline<UserFormSubmissionPayload>;
+    /** @default false */
+    showFormDescription?: boolean;
+    /** @default true */
+    showFormTitle?: boolean;
+}
+/**
+ * Wrapper for `FormRenderer` that takes a `UserFormSubmissionPayload` instead of an `ISchema`.
+ * Also, unlike `FormRenderer`, this component depends on the redux store.
+ * @see FormRenderer
+ */
+export declare const FormSubmissionViewer: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<FormSubmissionViewerProps & import("react").RefAttributes<HTMLDivElement>>>;
+export {};

package/dist/forms/renderer/PatchForm/Field.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from "react";
+import { FieldValue } from "../../typings.ts";
+interface RenderArgs {
+    value: FieldValue;
+    /** Intermediate changes to the field value */
+    setValue: (value: FieldValue) => void;
+    /** EX: when the onBlur event is fired */
+    patchValue: () => void;
+}
+interface PatchFieldProps {
+    name: string;
+    render: (args: RenderArgs) => ReactNode;
+}
+export declare const PatchField: import("react").MemoExoticComponent<(props: PatchFieldProps) => import("react/jsx-runtime").JSX.Element>;
+export {};

package/dist/forms/renderer/PatchForm/Provider.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="react" />
+import { FormikErrors } from "formik";
+import { ISchema } from "../../fields";
+import { Form } from "../../typings.ts";
+interface PatchFormProviderProps {
+    children: React.ReactNode;
+    schema: ISchema;
+    values: Form;
+    /** Called when `patchValue` is called on a child `PatchField` and the form is valid.
+     *  @example ```js
+     * {"field name": "field value"}
+     * ``` */
+    onPatch: (values: Form) => void;
+    /** Called when `patchValue` is called on a child `PatchField` and the form is not valid.
+     * After this event is fired, the form is reset to the initial values.
+     * @example ```js
+     * {"field name": "error message"}
+     * ``` */
+    onError: (error: FormikErrors<Form>) => void;
+    className?: string;
+}
+/** Use PatchForms to create patch edits to existing forms rather than editing the entire form. */
+export declare const PatchFormProvider: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<PatchFormProviderProps & import("react").RefAttributes<HTMLFormElement>>>;
+export {};

package/dist/forms/renderer/PatchForm/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Field";
+export * from "./Provider";

package/dist/forms/renderer/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./FormRenderer/FormRenderer";
+export * from "./FormSubmissionViewer/FormSubmissionViewer";
+export * from "./FormBrowser/FormBrowser";
+export * from "./FormSubmissionBrowser/FormSubmissionBrowser";
+export * from "./PatchForm";

package/dist/forms/typings.d.ts

@@ -1,5 +1,21 @@
 import { HTMLInputTypeAttribute } from "react";
 import { Marker } from "../typings";
+import { AnyField, BaseField } from "./fields";
+/**
+ * When upload fields are given initial values, that value will be
+ * a `Promise<File>[]` instead of a `File[]` as the files must be downloaded.
+ * `Promise<File>[]` is not add to the `FieldValue` type as it is not a valid
+ * value for submitted forms as the files must be present to be submitted
+ * TODO: This causes type errors in hemora-web. Maybe we should change this to:
+ *  export type Form = {
+ *    data: Record<string, FieldValue>,
+ *    attachments: Record<string, Promise<File>[]>
+ *  }
+ *  Then, we could just use `data` for creating attachment instances.
+ */
+export type Form = Record<string, FieldValue | Promise<File>[]>;
+/** Helper type that extracts the TValue type from a BaseField. */
+export type ValueOfField<Type extends AnyField> = Type extends BaseField<infer TValue> ? TValue : never;
 export type FieldTypeIdentifier = "string" | "text" | "boolean" | "number" | "date" | "select" | "custom" | "section" | "multi-string" | "multi-select" | "upload";
 export interface BaseSerializedObject<TIdentifier extends FieldTypeIdentifier = FieldTypeIdentifier> {
     description?: string | null;

package/dist/forms/utils.d.ts

@@ -0,0 +1,6 @@
+import { FormikErrors } from "formik";
+import { BaseFormElement, ISchema } from "./fields";
+import { Form } from "./typings.ts";
+export declare const hasKeys: (errors: object) => boolean;
+export declare const validateForm: (schema: ISchema, form: Form) => FormikErrors<Form> | undefined;
+export declare const initialFormValues: (fields: BaseFormElement[], values: Form) => Form;

package/dist/index.d.ts

@@ -6,3 +6,5 @@ export * from "./store";
 export * from "./typings";
 export * from "./utils";
 export * from "./constants";
+import * as forms from "./forms";
+export { forms };