@socotra/ec-react-components 2.2.2 → 2.2.3-alpha.2

package/dist/index.d.ts

@@ -2,39 +2,45 @@ import { AccountConfigRecord } from '@socotra/ec-react-schemas';
 import { AccountRequest } from '@socotra/ec-react-schemas';
 import { AccountResponse } from '@socotra/ec-react-schemas';
 import { DataTypeConfigRecord } from '@socotra/ec-react-schemas';
+import { ElementConfig } from '@socotra/ec-react-schemas';
+import { ElementRequest } from '@socotra/ec-react-schemas';
+import { ElementResponse } from '@socotra/ec-react-schemas';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
-import { ProductConfigRecord } from '@socotra/ec-react-schemas';
+import { ProductConfig } from '@socotra/ec-react-schemas';
 import { QuoteRequest } from '@socotra/ec-react-schemas';
 import { QuoteResponse } from '@socotra/ec-react-schemas';
 
 /**
- * AccountForm is a form for creating or updating an account. It accepts a resolved data model, custom data types, and an optional account object to put the form in update mode. References: https://rjsf-team.github.io/react-jsonschema-form/docs/
+ * AccountForm is a form for creating or updating an account. It required a resolved data model, custom data types, and an optional account object to put the form in update mode.
  */
 export declare const AccountForm: {
-    ({ accountsModel, accountType, dataTypes, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, account, submitButtonText, id, }: Props): JSX_2.Element;
+    ({ accountsModel, accountType, dataTypes, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, validateOnSubmit, account, submitButtonText, id, }: Props): JSX_2.Element;
     displayName: string;
 };
 
 /**
- * ElementForm is a form for updating a quote's element. It accepts a resolved data model, element locator, custom data types, and a quote object to build on.
+ * ElementForm is a form for creating or updating an element of a Quote. It required the element's data model, custom data types, and an element response object.
  */
-export declare const ElementForm: () => JSX_2.Element;
+export declare const ElementForm: {
+    ({ elementModel, dataTypes, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, element, validateOnSubmit, submitButtonText, id, }: Props_3): JSX_2.Element;
+    displayName: string;
+};
 
 declare type Props = {
     /**
-     * The resolved data model for accounts retrieved from the data model response
+     * The resolved data model for **all** accounts retrieved from the data model response
      */
     accountsModel: AccountConfigRecord;
     /**
-     * The account type to use for the form
+     * The account type to use for the form, used to pick the correct data model from the accountsModel
      */
     accountType: keyof AccountConfigRecord;
     /**
-     * The custom data types for the configuration that may be referenced by the accountsModel
+     * The custom data types for the configuration that may be referenced by the account's data model
      */
     dataTypes: DataTypeConfigRecord;
     /**
-     * The function to call when the form is submitted. It will create an AccountCreateRequest or AccountUpdateRequest based on the form data
+     * The function to call when the form is submitted. It will create an AccountRequest from the form data.
      */
     handleSubmit: (data: AccountRequest) => void;
     /**
@@ -62,6 +68,10 @@ declare type Props = {
      * The text to display on the submit button
      */
     submitButtonText?: string;
+    /**
+     * Whether to validate the form on submit
+     */
+    validateOnSubmit?: boolean;
     /**
      * ID for the form wrapper
      * */
@@ -74,19 +84,15 @@ declare type Props_2 = {
      */
     quote: QuoteResponse;
     /**
-     * The resolved data model for quotes retrieved from the data model response
+     * The resolved data model for quote retrieved from the data model response
      */
-    productsModel: ProductConfigRecord;
+    productModel: ProductConfig;
     /**
-     * The quote type to use for the form
-     */
-    productType: keyof ProductConfigRecord;
-    /**
-     * The custom data types for the configuration that may be referenced by the DataModel
+     * The custom data types for the configuration that may be referenced by the elementModel
      */
     dataTypes: DataTypeConfigRecord;
     /**
-     * The function to call when the form is submitted. It will create an QuoteUpdateRequest from the form data.
+     * The function to call when the form is submitted. It will create an QuoteRequest from the form data.
      */
     handleSubmit: (data: QuoteRequest) => void;
     /**
@@ -123,11 +129,60 @@ declare type Props_2 = {
     id?: string;
 };
 
+declare type Props_3 = {
+    /**
+     * The resolved data model for the element retrieved from the data model response
+     */
+    elementModel: ElementConfig;
+    /**
+     * The custom data types for the configuration that may be referenced by the elementModel
+     */
+    dataTypes: DataTypeConfigRecord;
+    /**
+     * The function to call when the form is submitted. It will create an ElementUpdateRequest.
+     */
+    handleSubmit: (data: ElementRequest) => void;
+    /**
+     * Set to true when the form is submitting to set fields to readonly and disable the submit button
+     */
+    isSubmitting?: boolean;
+    /**
+     * Disables the form
+     */
+    disabled?: boolean;
+    /**
+     * Prevents the form from resetting when disabled
+     * default is true
+     */
+    preventFormResetOnDisabled?: boolean;
+    /**
+     * The element object from the quote
+     */
+    element: ElementResponse;
+    /**
+     * Hides the submit button
+     */
+    hideSubmitButton?: boolean;
+    /**
+     * Whether to validate the form on submit
+     */
+    validateOnSubmit?: boolean;
+    /**
+     /**
+     * The text to display on the submit button
+     */
+    submitButtonText?: string;
+    /**
+     * ID for the form wrapper
+     * */
+    id?: string;
+};
+
 /**
- * QuoteForm is a form for creating or updating an quote. It accepts a resolved data model, custom data types, and an optional quote object to put the form in update mode. References: https://rjsf-team.github.io/react-jsonschema-form/docs/
+ * QuoteForm is a form for updating a quote. It required a product data model, custom data types, and quote object to render the form.
  */
 export declare const QuoteForm: {
-    ({ quote, productType, productsModel, dataTypes, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, validateOnSubmit, hideSubmitButton, submitButtonText, id, }: Props_2): JSX_2.Element;
+    ({ quote, productModel, dataTypes, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, validateOnSubmit, hideSubmitButton, submitButtonText, id, }: Props_2): JSX_2.Element;
     displayName: string;
 };