@bigbinary/neeto-form-frontend 1.2.14 → 1.2.15

package/app/javascript/src/translations/en.json

@@ -43,7 +43,7 @@
       "nif": "Name",
       "tif": "Single line text",
       "eif": "Email",
-      "pif": "Phone",
+      "pif": "Phone number",
       "rif": "Rating",
       "tcf": "Terms and conditions",
       "date": "Date",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-form-frontend",
-  "version": "1.2.14",
+  "version": "1.2.15",
   "description": "Neeto Form Engine Frontend",
   "license": "UNLICENSED",
   "homepage": "https://github.com/bigbinary/neeto-form-nano",

package/types.d.ts

@@ -1,3 +1,268 @@
-import React from "react";
+import axios from "axios";
+import { ButtonProps, TypographyProps } from "@bigbinary/neetoui";
+import React, { FormHTMLAttributes, HTMLAttributes } from "react";
+import {
+  UseQueryResult,
+  UseMutationResult,
+  UseQueryOptions,
+  UseMutationOptions,
+} from "react-query";
+import { EditorProps } from "@bigbinary/neeto-editor";
+import { Schema } from "yup";
 
-export const WelcomeScreen = React.FC<{}>;
+interface Question {
+  id: string;
+  entityId?: string;
+  entityType?: string;
+  label: string;
+  placeholder?: string;
+  isRequired?: boolean;
+  optionsAttributes?: {
+    id: string;
+    label: string;
+    displayOrder: number;
+  }[];
+  highestRatingLabel?: string;
+  lowestRatingLabel?: string;
+  averageRatingLabel?: string;
+  options?: KeyValuePair[];
+  count?: number;
+  shape?: string;
+  kind: string;
+  [key: string]: any;
+}
+
+interface BuildFormProps {
+  id: string;
+  allowAdditionalGuests?: boolean;
+  onUpdate?: (data: any) => void;
+  buildRequestArgs?: any;
+  showAddQuestionDivider?: boolean;
+  nonRemovableFields?: string[];
+  requiredFields?: string[];
+  formDomProps?: FormHTMLAttributes<HTMLFormElement>;
+  showActionBlock?: boolean;
+  submitButtonProps?: HTMLAttributes<HTMLButtonElement>;
+  cancelButtonProps?: HTMLAttributes<HTMLButtonElement>;
+  questionKinds?: KeyValuePair[];
+  isKindAlreadyActive?: (args: {
+    activeQuestions: KeyValuePair[];
+    kind: KeyValuePair;
+  }) => boolean;
+  getActiveKindDetails?: (args: {
+    allQuestionKinds: KeyValuePair[];
+    item: Item;
+  }) => {
+    kind: string;
+    label: string;
+    FieldComponent: React.FC;
+    FieldIcon: string | any;
+    isSingular: boolean;
+  };
+  showLoader?: boolean;
+  kindUniqueOn?: string[];
+  isFieldRequired?: (item: Item) => boolean;
+  isFieldLabelDisabled?: (item: Item) => boolean;
+  isQuestionDeletable?: (item: Item) => boolean;
+  disabledAddButtonTooltipProps?: DisabledAddButtonTooltipProps;
+}
+
+interface ExternalFormProps {
+  preview?: boolean;
+  formId: string;
+  submissionId?: string;
+  customSubmitHandler?: (data: any) => void;
+  onBeforeSubmit?: (
+    data: any,
+    values: any
+  ) => any | Promise<any> | void | Promise<void> | undefined | null;
+  onSubmitSuccess?: (data: any) => void;
+  showTitle?: boolean;
+  formTitle?: string;
+  titleProps?: TypographyProps;
+  submitRequestArgs?: any;
+  footer?: React.ReactNode;
+  submitButtonProps?: ButtonProps;
+  cancelButtonProps?: ButtonProps;
+  resetButtonProps?: ButtonProps;
+  showPrefixIcons?: boolean;
+  displayThankYou?: boolean;
+  showSuccessToastr?: boolean;
+  showEmptyState?: boolean;
+  className?: string;
+  preserveValues?: boolean;
+  clearValuesOnReset?: boolean;
+  clearValuesOnSubmit?: boolean;
+  onChange?: (values: any) => void;
+  initialValues?: any;
+  formDomProps?: FormHTMLAttributes<HTMLFormElement>;
+  editorProps?: EditorProps;
+  customValidator?: (question: Question) => Schema;
+}
+
+interface DisabledAddButtonTooltipProps {
+  content?: string
+}
+
+interface SubmissionProps {
+  formId: string;
+  submissionId: string;
+  className?: string;
+  questionLabelProps?: TypographyProps;
+  answerProps?: TypographyProps;
+}
+
+interface IBuildFormState {
+  values: any;
+  dirty: boolean;
+  isSubmitting: boolean;
+  isValid: boolean;
+  errors: { [key: string]: string }[];
+  submitForm: () => void;
+  resetForm: () => void;
+}
+
+interface ISubmission {
+  responses: {
+    label: string;
+    value: string;
+    kind: string;
+  }[];
+}
+
+interface KeyValuePair {
+  [key: string]: any;
+}
+
+interface UpdateHookResponse<TData = unknown, TError = unknown>
+  extends Omit<UseMutationResult<TData, TError>, "mutate" | "mutateAsync"> {
+  mutate: (args: { id: string; values: KeyValuePair }) => Promise<TData>;
+  mutateAsync: (args: { id: string; values: KeyValuePair }) => Promise<TData>;
+}
+
+interface CreateHookResponse<TData = unknown, TError = unknown>
+  extends Omit<UseMutationResult<TData, TError>, "mutate" | "mutateAsync"> {
+  mutate: (values: KeyValuePair) => Promise<TData>;
+  mutateAsync: (values: KeyValuePair) => Promise<TData>;
+}
+
+interface DeleteHookResponse<TData = unknown, TError = unknown>
+  extends Omit<UseMutationResult<TData, TError>, "mutate" | "mutateAsync"> {
+  mutate: (args: { id: string }) => Promise<TData>;
+  mutateAsync: (args: { id: string }) => Promise<TData>;
+}
+
+interface FormHookOptions extends UseQueryOptions {
+  formId: string;
+  preview?: boolean;
+}
+
+interface Item {
+  label: string;
+  isRequired: boolean;
+  optionsAttributes: KeyValuePair[];
+  metadata?: KeyValuePair[];
+  kind: string;
+  nodeId: string;
+}
+
+interface EmailProps {
+  name: string;
+  isRequired: boolean;
+}
+
+interface DropdownProps {
+  item: Item;
+  name: string;
+  isRequired: boolean;
+}
+
+interface ShortTextProps {
+  name: string;
+  isRequired: boolean;
+}
+
+interface LongTextProps {
+  name: string;
+  isRequired: boolean;
+}
+
+interface MultipleChoiceProps {
+  item: Item;
+  name: string;
+  isRequired: boolean;
+}
+
+interface SingleChoiceProps {
+  item: Item;
+  name: string;
+  isRequired: boolean;
+}
+
+interface PhoneProps {
+  name: string;
+  isRequired: boolean;
+}
+
+interface RatingProps {
+  name: string;
+  isRequired: boolean;
+}
+
+interface TermsProps {
+  name: string;
+}
+
+interface StarRatingProps {
+  name: string;
+  isRequired: boolean;
+}
+
+interface AdditionalGuestsProps {
+  name: string;
+}
+
+interface ConditionProps {
+  name: string;
+  isRequired: boolean;
+}
+
+export const BuildForm: React.FC<BuildFormProps>;
+export const ExternalForm: React.FC<ExternalFormProps>;
+export const Submission: React.FC<SubmissionProps>;
+export const NeetoFormProvider: React.FC;
+export const Fields: {
+  Email: React.FC<EmailProps>;
+  Dropdown: React.FC<DropdownProps>;
+  ShortText: React.FC<ShortTextProps>;
+  LongText: React.FC<LongTextProps>;
+  MultipleChoice: React.FC<MultipleChoiceProps>;
+  SingleChoice: React.FC<SingleChoiceProps>;
+  Phone: React.FC<PhoneProps>;
+  Rating: React.FC<RatingProps>;
+  Terms: React.FC<TermsProps>;
+  StarRating: React.FC<StarRatingProps>;
+  AdditionalGuests: React.FC<AdditionalGuestsProps>;
+  Condition: React.FC<ConditionProps>;
+};
+
+export const useBuildFormState: () => IBuildFormState;
+export const useFormSubmission: (args: {
+  formId: string;
+  submissionId: string;
+}) => {
+  submission: ISubmission;
+  isLoading: boolean;
+};
+
+export const useForms: (options?: UseQueryOptions) => UseQueryResult;
+export const useForm: (options?: FormHookOptions) => UseQueryResult;
+export const useCreateForm: (
+  options?: UseMutationOptions
+) => CreateHookResponse;
+export const useUpdateForm: (
+  options?: UseMutationOptions
+) => UpdateHookResponse;
+export const useDeleteForm: (
+  options?: UseMutationOptions
+) => DeleteHookResponse;