@saasquatch/mint-components 1.14.5 → 1.14.6-1

package/dist/types/components/sqm-lead-form/sqm-lead-form-view.d.ts

@@ -0,0 +1,28 @@
+import { VNode } from "../../stencil-public-runtime";
+import { LeadFormState } from "./useLeadFormState";
+export interface LeadFormViewProps {
+  states: {
+    error: string;
+    loading: boolean;
+    leadFormState: LeadFormState;
+    referralCode: string;
+  };
+  callbacks: {
+    submit: Function;
+    inputFunction: Function;
+  };
+  content: {
+    formData?: VNode;
+    emailLabel?: string;
+    firstNameLabel?: string;
+    lastNameLabel?: string;
+    submitLabel?: string;
+    pageLabel?: string;
+    requiredFieldErrorMessage: string;
+    invalidEmailErrorMessage: string;
+  };
+  refs: {
+    formRef: any;
+  };
+}
+export declare function LeadFormView(props: LeadFormViewProps): any;

package/dist/types/components/sqm-lead-form/sqm-lead-form.d.ts

@@ -0,0 +1,66 @@
+import { DemoData } from "../../global/demo";
+import { LeadFormViewProps } from "./sqm-lead-form-view";
+/**
+ * @uiName Lead Form
+ * @slots [{"name":"formData","title":"Additional Fields"},{"name":"terms","title":"Terms And Conditions Fields"}]
+ */
+export declare class LeadForm {
+  ignored: boolean;
+  /**
+   * Redirect participants to this page from their verification email
+   *
+   * @uiName Submission redirect
+   * @uiWidget pageSelect
+   */
+  nextPage: string;
+  /**
+   * @uiName Email field label
+   */
+  emailLabel: string;
+  /**
+   * @uiName First Name field label
+   */
+  firstNameLabel: string;
+  /**
+   * @uiName Last Name field label
+   */
+  lastNameLabel: string;
+  /**
+   * @uiName Submit button text
+   */
+  submitLabel: string;
+  /**
+   * @uiName Header text
+   */
+  pageLabel: string;
+  formKey: string;
+  /**
+   * The message to be displayed when a required field is not filled.
+   *
+   * @uiName Required field message
+   * @uiWidget textArea
+   */
+  requiredFieldErrorMessage: string;
+  /**
+   * The message to be displayed when a the form submission fails unexpectedly.
+   *
+   * @uiName Network error message
+   * @uiWidget textArea
+   */
+  networkErrorMessage: string;
+  /**
+   * The message to be displayed when the email used is invalid or blocked.
+   *
+   * @uiName Invalid email message
+   * @uiWidget textArea
+   */
+  invalidEmailErrorMessage: string;
+  /**
+   * @undocumented
+   * @uiType object
+   */
+  demoData?: DemoData<LeadFormViewProps>;
+  constructor();
+  disconnectedCallback(): void;
+  render(): any;
+}

package/dist/types/components/sqm-lead-form/useLeadForm.d.ts

@@ -0,0 +1,23 @@
+import { LeadForm } from "./sqm-lead-form";
+export declare type ValidationErrorFunction = (input: {
+  control: any;
+  key: string;
+  value: any;
+}) => string | undefined;
+export declare function useLeadForm(props: LeadForm): {
+  states: {
+    loading: boolean;
+    error: string;
+    leadFormState: import("./useLeadFormState").LeadFormState;
+    referralCode: string;
+  };
+  callbacks: {
+    submit: (event: any) => Promise<void>;
+    inputFunction: (e: any) => void;
+  };
+  refs: {
+    formRef: {
+      current: HTMLFormElement;
+    };
+  };
+};

package/dist/types/components/sqm-lead-form/useLeadFormState.d.ts

@@ -0,0 +1,19 @@
+export declare const LEAD_FORM_STATE_CONTEXT = "sq:lead-form-state";
+export declare type LeadFormState = {
+  error?: string;
+  validationErrors?: ValidationErrors;
+  loading?: boolean;
+  disabled?: boolean;
+  disabledMessage?: string;
+  initialData?: InitialData;
+};
+export declare type ValidationErrors = {
+  [key: string]: string;
+};
+export declare type InitialData = {
+  [key: string]: string;
+};
+export declare function useLeadFormState(formState?: LeadFormState): {
+  leadFormState: LeadFormState;
+  setLeadFormState: (value: LeadFormState | ((previousState?: LeadFormState) => LeadFormState)) => void;
+};

package/dist/types/components.d.ts

@@ -22,6 +22,7 @@ import { UseIndirectTaxFormResult } from "./components/tax-and-cash/sqm-indirect
 import { InputFieldViewProps } from "./components/sqm-input-field/sqm-input-field-view";
 import { EmailRegistrationViewProps } from "./components/views/email-registration-view";
 import { GenericTableViewProps } from "./tables/GenericTableView";
+import { LeadFormViewProps } from "./components/sqm-lead-form/sqm-lead-form-view";
 import { LeaderboardViewProps } from "./components/sqm-leaderboard/sqm-leaderboard-view";
 import { LeaderboardRankViewProps } from "./components/sqm-leaderboard-rank/sqm-leaderboard-rank-view";
 import { CopyTextViewProps } from "./components/views/copy-text-view";
@@ -1477,6 +1478,58 @@ export namespace Components {
         "renderCell": (data: Invoice) => Promise<any>;
         "renderLabel": () => Promise<any>;
     }
+    interface SqmLeadForm {
+        /**
+          * @undocumented 
+          * @uiType object
+         */
+        "demoData"?: DemoData<LeadFormViewProps>;
+        /**
+          * @uiName Email field label
+         */
+        "emailLabel": string;
+        /**
+          * @uiName First Name field label
+         */
+        "firstNameLabel": string;
+        "formKey": string;
+        /**
+          * The message to be displayed when the email used is invalid or blocked.
+          * @uiName Invalid email message
+          * @uiWidget textArea
+         */
+        "invalidEmailErrorMessage": string;
+        /**
+          * @uiName Last Name field label
+         */
+        "lastNameLabel": string;
+        /**
+          * The message to be displayed when a the form submission fails unexpectedly.
+          * @uiName Network error message
+          * @uiWidget textArea
+         */
+        "networkErrorMessage": string;
+        /**
+          * Redirect participants to this page from their verification email
+          * @uiName Submission redirect
+          * @uiWidget pageSelect
+         */
+        "nextPage": string;
+        /**
+          * @uiName Header text
+         */
+        "pageLabel": string;
+        /**
+          * The message to be displayed when a required field is not filled.
+          * @uiName Required field message
+          * @uiWidget textArea
+         */
+        "requiredFieldErrorMessage": string;
+        /**
+          * @uiName Submit button text
+         */
+        "submitLabel": string;
+    }
     interface SqmLeaderboard {
         /**
           * Title displayed for users without names
@@ -6223,6 +6276,12 @@ declare global {
         prototype: HTMLSqmInvoiceTableDownloadColumnElement;
         new (): HTMLSqmInvoiceTableDownloadColumnElement;
     };
+    interface HTMLSqmLeadFormElement extends Components.SqmLeadForm, HTMLStencilElement {
+    }
+    var HTMLSqmLeadFormElement: {
+        prototype: HTMLSqmLeadFormElement;
+        new (): HTMLSqmLeadFormElement;
+    };
     interface HTMLSqmLeaderboardElement extends Components.SqmLeaderboard, HTMLStencilElement {
     }
     var HTMLSqmLeaderboardElement: {
@@ -6787,6 +6846,7 @@ declare global {
         "sqm-invoice-table-date-column": HTMLSqmInvoiceTableDateColumnElement;
         "sqm-invoice-table-download-cell": HTMLSqmInvoiceTableDownloadCellElement;
         "sqm-invoice-table-download-column": HTMLSqmInvoiceTableDownloadColumnElement;
+        "sqm-lead-form": HTMLSqmLeadFormElement;
         "sqm-leaderboard": HTMLSqmLeaderboardElement;
         "sqm-leaderboard-rank": HTMLSqmLeaderboardRankElement;
         "sqm-link-button": HTMLSqmLinkButtonElement;
@@ -8293,6 +8353,58 @@ declare namespace LocalJSX {
     }
     interface SqmInvoiceTableDownloadColumn {
     }
+    interface SqmLeadForm {
+        /**
+          * @undocumented 
+          * @uiType object
+         */
+        "demoData"?: DemoData<LeadFormViewProps>;
+        /**
+          * @uiName Email field label
+         */
+        "emailLabel"?: string;
+        /**
+          * @uiName First Name field label
+         */
+        "firstNameLabel"?: string;
+        "formKey"?: string;
+        /**
+          * The message to be displayed when the email used is invalid or blocked.
+          * @uiName Invalid email message
+          * @uiWidget textArea
+         */
+        "invalidEmailErrorMessage"?: string;
+        /**
+          * @uiName Last Name field label
+         */
+        "lastNameLabel"?: string;
+        /**
+          * The message to be displayed when a the form submission fails unexpectedly.
+          * @uiName Network error message
+          * @uiWidget textArea
+         */
+        "networkErrorMessage"?: string;
+        /**
+          * Redirect participants to this page from their verification email
+          * @uiName Submission redirect
+          * @uiWidget pageSelect
+         */
+        "nextPage"?: string;
+        /**
+          * @uiName Header text
+         */
+        "pageLabel"?: string;
+        /**
+          * The message to be displayed when a required field is not filled.
+          * @uiName Required field message
+          * @uiWidget textArea
+         */
+        "requiredFieldErrorMessage"?: string;
+        /**
+          * @uiName Submit button text
+         */
+        "submitLabel"?: string;
+    }
     interface SqmLeaderboard {
         /**
           * Title displayed for users without names
@@ -12838,6 +12950,7 @@ declare namespace LocalJSX {
         "sqm-invoice-table-date-column": SqmInvoiceTableDateColumn;
         "sqm-invoice-table-download-cell": SqmInvoiceTableDownloadCell;
         "sqm-invoice-table-download-column": SqmInvoiceTableDownloadColumn;
+        "sqm-lead-form": SqmLeadForm;
         "sqm-leaderboard": SqmLeaderboard;
         "sqm-leaderboard-rank": SqmLeaderboardRank;
         "sqm-link-button": SqmLinkButton;
@@ -12967,6 +13080,7 @@ declare module "@stencil/core" {
             "sqm-invoice-table-date-column": LocalJSX.SqmInvoiceTableDateColumn & JSXBase.HTMLAttributes<HTMLSqmInvoiceTableDateColumnElement>;
             "sqm-invoice-table-download-cell": LocalJSX.SqmInvoiceTableDownloadCell & JSXBase.HTMLAttributes<HTMLSqmInvoiceTableDownloadCellElement>;
             "sqm-invoice-table-download-column": LocalJSX.SqmInvoiceTableDownloadColumn & JSXBase.HTMLAttributes<HTMLSqmInvoiceTableDownloadColumnElement>;
+            "sqm-lead-form": LocalJSX.SqmLeadForm & JSXBase.HTMLAttributes<HTMLSqmLeadFormElement>;
             "sqm-leaderboard": LocalJSX.SqmLeaderboard & JSXBase.HTMLAttributes<HTMLSqmLeaderboardElement>;
             "sqm-leaderboard-rank": LocalJSX.SqmLeaderboardRank & JSXBase.HTMLAttributes<HTMLSqmLeaderboardRankElement>;
             "sqm-link-button": LocalJSX.SqmLinkButton & JSXBase.HTMLAttributes<HTMLSqmLinkButtonElement>;