@socotra/ec-react-components 0.0.0-alpha.0

package/README.md

@@ -0,0 +1,30 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+
+- Configure the top-level `parserOptions` property like this:
+
+```js
+export default {
+	// other rules...
+	parserOptions: {
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+		project: ['./tsconfig.json', './tsconfig.node.json'],
+		tsconfigRootDir: __dirname,
+	},
+};
+```
+
+- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
+- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list

package/dist/index.d.ts

@@ -0,0 +1,143 @@
+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 { default as default_2 } from '@rjsf/core';
+import { ElementConfig } from '@socotra/ec-react-schemas';
+import { ElementResponse } from '@socotra/ec-react-schemas';
+import { FormProps } from '@rjsf/core';
+import { ForwardRefExoticComponent } from 'react';
+import { ProductConfig } from '@socotra/ec-react-schemas';
+import { QuoteRequest } from '@socotra/ec-react-schemas';
+import { QuoteResponse } from '@socotra/ec-react-schemas';
+import { RefAttributes } from 'react';
+import { RJSFSchema } from '@rjsf/utils';
+import { UiSchema } from '@rjsf/utils';
+
+/**
+ * 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/
+ */
+export declare const AccountForm: ForwardRefExoticComponent<Omit<Props, "ref"> & RefAttributes<AccountFormRef>>;
+
+declare type AccountFormRef = default_2<TODO, RJSFSchema, TODO>;
+
+/**
+ * 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.
+ */
+export declare const ElementForm: ForwardRefExoticComponent<Omit<Props_3, "ref"> & RefAttributes<ElementFormRef>>;
+
+declare type ElementFormRef = default_2<TODO, RJSFSchema, TODO>;
+
+declare type Props = {
+    /**
+     * The resolved data model for accounts retrieved from the data model response
+     */
+    accountsModel: AccountConfigRecord;
+    /**
+     * The custom data types for the configuration that may be referenced by the accountsModel
+     */
+    dataTypes: DataTypeConfigRecord;
+    /**
+     * The function to call when the form is submitted. It will create an AccountCreateRequest or AccountUpdateRequest based on the form data
+     */
+    handleSubmit: (data: AccountRequest) => void;
+    /**
+     * The custom UI schema for the form. Reference: https://rjsf-team.github.io/react-jsonschema-form/docs/api-reference/uiSchema/
+     */
+    uiSchema?: UiSchema;
+    /**
+     * The account object to put the form in update mode
+     */
+    account?: AccountResponse;
+    /**
+     * Hides the submit button
+     */
+    hideSubmitButton?: boolean;
+    /**
+     * ID for the form wrapper
+     * */
+    id?: string;
+} & Partial<FormProps>;
+
+declare type Props_2 = {
+    /**
+     * The resolved data model for products retrieved from the data model response
+     */
+    productModel: ProductConfig;
+    /**
+     * The custom data types for the configuration that may be referenced by the productModel
+     */
+    dataTypes: DataTypeConfigRecord;
+    /**
+     * The function to call when the form is submitted. It will create an QuoteUpdateRequest.
+     */
+    handleSubmit: (data: QuoteRequest) => void;
+    /**
+     * The custom UI schema for the form. Reference: https://rjsf-team.github.io/react-jsonschema-form/docs/api-reference/uiSchema/
+     */
+    uiSchema?: UiSchema;
+    /**
+     * The quote object to build on
+     */
+    quote: QuoteResponse;
+    /**
+     * Hides the submit button
+     */
+    hideSubmitButton?: boolean;
+    /**
+     * Removes the default fields like Start and End time, delinquency plan name, etc.
+     */
+    hideDefaultFields?: boolean;
+    /**
+     * Removes the configured fields
+     */
+    hideConfiguredFields?: boolean;
+    /**
+     * ID for the form wrapper
+     * */
+    id?: string;
+} & Partial<FormProps>;
+
+declare type Props_3 = {
+    /**
+     * The resolved quote element to render. Find this by using the `retrieveElementFromQuoteByLocator` utility function.
+     */
+    element: ElementResponse;
+    /**
+     * The data model for the element you want to render. Find this by using the `retrieveDataModelFromElement` utility function.
+     */
+    elementModel: ElementConfig;
+    /**
+     * The custom data types for the configuration that may be referenced by the element model
+     */
+    dataTypes: DataTypeConfigRecord;
+    /**
+     * The locator for the quote element
+     * */
+    locator: string;
+    /**
+     * The function to call when the form is submitted. It will create a QuoteRequest.
+     */
+    handleSubmit: (data: QuoteRequest) => void;
+    /**
+     * The custom UI schema for the form. Reference: https://rjsf-team.github.io/react-jsonschema-form/docs/api-reference/uiSchema/
+     */
+    uiSchema?: UiSchema;
+    /**
+     * Hides the submit button
+     */
+    hideSubmitButton?: boolean;
+    /**
+     * ID for the form wrapper. Useful to submitting the form with a button outside the form.
+     * */
+    id?: string;
+} & Partial<FormProps>;
+
+/**
+ * QuoteForm is a form for updating a quote. It accepts a resolved data model, custom data types, and a quote object to build on.
+ */
+export declare const QuoteForm: ForwardRefExoticComponent<Omit<Props_2, "ref"> & RefAttributes<QuoteFormRef>>;
+
+declare type QuoteFormRef = default_2<TODO, RJSFSchema, TODO>;
+
+export { }