@superleapai/flow-ui 2.5.19 → 2.5.21

package/index.d.ts

@@ -29,13 +29,13 @@ declare module "@superleapai/flow-ui" {
   // CRM BRIDGE TYPES
   // ============================================================================
 
-  /** Configuration passed to SuperLeap.connect() */
+  /** Configuration passed to Superleap.connect() */
   export interface ConnectOptions {
     /** Unique identifier for this flow/form (must match CRM-side registration) */
     flowId: string;
     /** Expected CRM origin for validation (e.g., "https://app.superleap.com"). Optional for RN. */
     crmOrigin?: string;
-    /** Whether to auto-call SuperLeap.init() with the SDK config from the CRM. Default: true */
+    /** Whether to auto-call Superleap.init() with the SDK config from the CRM. Default: true */
     autoInit?: boolean;
     /** Handshake timeout in milliseconds. Default: 5000 */
     timeout?: number;
@@ -61,13 +61,13 @@ declare module "@superleapai/flow-ui" {
 
   /** Configuration received from the CRM */
   export interface CRMConfig {
-    /** SDK configuration for SuperLeap.init() */
+    /** SDK configuration for Superleap.init() */
     sdkConfig?: SuperLeapConfig;
     /** Any additional configuration */
     [key: string]: any;
   }
 
-  /** Result of a successful SuperLeap.connect() call */
+  /** Result of a successful Superleap.connect() call */
   export interface ConnectResult {
     /** Context data from the CRM */
     context: CRMContext;
@@ -75,10 +75,10 @@ declare module "@superleapai/flow-ui" {
     config: CRMConfig;
   }
 
-  /** Unsubscribe function returned by SuperLeap.on() */
+  /** Unsubscribe function returned by Superleap.on() */
   export type EventUnsubscribe = () => void;
 
-  export interface SuperLeap {
+  export interface Superleap {
     // SDK Methods (from superleapClient.js)
     init(config?: SuperLeapConfig): void;
     getSdk(): any;
@@ -112,12 +112,11 @@ declare module "@superleapai/flow-ui" {
     closeForm(): void;
 
     /**
-     * Register a callback for when the CRM form is submitted successfully.
-     * The CRM sends a notification after the form saves.
-     * @param callback - Handler called with the submission payload
-     * @returns Unsubscribe function
+     * Notify the CRM that the form was submitted successfully.
+     * The CRM listens for this event and can react (e.g. close the form, refresh data).
+     * @param payload - Optional data about the submission
      */
-    onFormSubmitSuccess(callback: (payload: any) => void): EventUnsubscribe;
+    formSubmittedSuccessfully(payload?: any): void;
 
     /**
      * Tell the CRM to show a toast notification
@@ -128,7 +127,7 @@ declare module "@superleapai/flow-ui" {
     toast(
       message: string,
       type?: "success" | "error" | "warning" | "info",
-      duration?: number
+      duration?: number,
     ): void;
 
     /**
@@ -167,7 +166,7 @@ declare module "@superleapai/flow-ui" {
     off(event: string, callback: (payload: any) => void): void;
   }
 
-  export const SuperLeap: SuperLeap;
+  export const Superleap: Superleap;
 
   // ============================================================================
   // STATE MANAGEMENT
@@ -263,7 +262,13 @@ declare module "@superleapai/flow-ui" {
     /** 'default' | 'small' | 'large' */
     size?: "default" | "small" | "large";
     /** 'default' | 'error' | 'warning' | 'success' | 'borderless' | 'inline' */
-    variant?: "default" | "error" | "warning" | "success" | "borderless" | "inline";
+    variant?:
+      | "default"
+      | "error"
+      | "warning"
+      | "success"
+      | "borderless"
+      | "inline";
     helpText?: string;
   }
 
@@ -279,7 +284,13 @@ declare module "@superleapai/flow-ui" {
     granularity?: "day" | "hour" | "minute" | "second";
     size?: "small" | "default" | "large";
     /** 'default' | 'error' | 'warning' | 'success' | 'borderless' | 'inline' */
-    variant?: "default" | "error" | "warning" | "success" | "borderless" | "inline";
+    variant?:
+      | "default"
+      | "error"
+      | "warning"
+      | "success"
+      | "borderless"
+      | "inline";
     fromDate?: Date;
     toDate?: Date;
     helpText?: string;
@@ -596,7 +607,7 @@ declare module "@superleapai/flow-ui" {
     // State management
     initState(
       initialState: FlowUIState,
-      onChangeCallback?: (state: FlowUIState) => void
+      onChangeCallback?: (state: FlowUIState) => void,
     ): void;
     getState(): FlowUIState;
     setState(partial: Partial<FlowUIState>): void;
@@ -612,7 +623,7 @@ declare module "@superleapai/flow-ui" {
     createFieldWrapper(
       label: string,
       required?: boolean,
-      helpText?: string | null
+      helpText?: string | null,
     ): HTMLElement;
 
     // Form components
@@ -639,7 +650,7 @@ declare module "@superleapai/flow-ui" {
     renderStepper(
       container: HTMLElement,
       steps: StepConfig[],
-      currentStepId: string
+      currentStepId: string,
     ): void;
     createTabs(config: TabsConfig): HTMLElement;
     createSteps(config: StepsConfig): HTMLElement;
@@ -648,7 +659,7 @@ declare module "@superleapai/flow-ui" {
     showToast(
       message: string,
       type?: "success" | "error" | "warning" | "info" | "loading",
-      duration?: number
+      duration?: number,
     ): ToastAPI;
 
     // Table
@@ -676,6 +687,6 @@ declare module "@superleapai/flow-ui" {
 declare global {
   interface Window {
     FlowUI: FlowUI;
-    SuperLeap: SuperLeap;
+    Superleap: Superleap;
   }
 }

package/index.js

@@ -2,8 +2,8 @@
  * Superleap-Flow Library Entry Point
  * @superleapai/flow-ui
  *
- * Single-file bundle that includes SuperLeap SDK and all components.
- * Only FlowUI and SuperLeap are exposed to global scope.
+ * Single-file bundle that includes Superleap SDK and all components.
+ * Only FlowUI and Superleap are exposed to global scope.
  *
  * Usage:
  *
@@ -11,7 +11,7 @@
  * <script src="path/to/superleap-flow/index.js"></script>
  * <script>
  *   // Connect to CRM (inside an iframe)
- *   const { context, config } = await SuperLeap.connect({
+ *   const { context, config } = await Superleap.connect({
  *     flowId: 'my-flow'
  *   });
  *   // SDK is auto-initialized, context has orgId/userId/etc.
@@ -20,15 +20,15 @@
  *   FlowUI.initState({ name: '' });
  *
  *   // CRM actions
- *   SuperLeap.toast('Saved!', 'success');
- *   SuperLeap.closeForm();
+ *   Superleap.toast('Saved!', 'success');
+ *   Superleap.closeForm();
  * </script>
  *
  * ES Module:
- * import { FlowUI, SuperLeap } from '@superleapai/flow-ui';
+ * import { FlowUI, Superleap } from '@superleapai/flow-ui';
  *
  * CommonJS:
- * const { FlowUI, SuperLeap } = require('@superleapai/flow-ui');
+ * const { FlowUI, Superleap } = require('@superleapai/flow-ui');
  */
 
 (function (global) {
@@ -41,13 +41,13 @@
 
   // In Node.js/CommonJS environment, load all modules
   if (isNode && !isBrowser) {
-    // Note: In Node.js, SuperLeap SDK should be installed separately via npm
+    // Note: In Node.js, Superleap SDK should be installed separately via npm
     // npm install superleap-sdk
     try {
       global.createSuperLeapSDK = require("superleap-sdk");
     } catch (e) {
       console.warn(
-        "[Superleap-Flow] SuperLeap SDK not found. Install with: npm install superleap-sdk"
+        "[Superleap-Flow] Superleap SDK not found. Install with: npm install superleap-sdk",
       );
     }
 
@@ -97,10 +97,10 @@
     require("./components/tabs.js");
     require("./components/steps.js");
 
-    // Export FlowUI and SuperLeap from global scope
+    // Export FlowUI and Superleap from global scope
     if (typeof global !== "undefined" && global.FlowUI) {
-      // Create SuperLeap export
-      const SuperLeap = global.superleapClient
+      // Create Superleap export
+      const Superleap = global.superleapClient
         ? {
             init: global.superleapClient.init,
             getSdk: global.superleapClient.getSdk,
@@ -111,11 +111,11 @@
 
       module.exports = {
         FlowUI: global.FlowUI,
-        SuperLeap: SuperLeap,
+        Superleap: Superleap,
       };
     } else if (typeof window !== "undefined" && window.FlowUI) {
-      // Create SuperLeap export
-      const SuperLeap = window.superleapClient
+      // Create Superleap export
+      const Superleap = window.superleapClient
         ? {
             init: window.superleapClient.init,
             getSdk: window.superleapClient.getSdk,
@@ -126,7 +126,7 @@
 
       module.exports = {
         FlowUI: window.FlowUI,
-        SuperLeap: SuperLeap,
+        Superleap: Superleap,
       };
     }
   } else if (isBrowser) {
@@ -182,7 +182,7 @@
           _components[name] = window[name];
 
           // Clean up global scope - remove all component globals
-          // Only FlowUI and SuperLeap will remain
+          // Only FlowUI and Superleap will remain
           delete window[name];
         }
       });
@@ -194,11 +194,11 @@
         };
       }
 
-      // Expose SuperLeap from captured superleapClient (must use _components - superleapClient was already deleted from window)
+      // Expose Superleap from captured superleapClient (must use _components - superleapClient was already deleted from window)
       // Note: crm.js has already extended superleapClient with bridge methods (connect, toast, etc.)
       const client = _components["superleapClient"];
       if (client) {
-        window.SuperLeap = {
+        window.Superleap = {
           // SDK methods (from superleapClient.js)
           init: client.init.bind(client),
           getSdk: client.getSdk.bind(client),
@@ -218,8 +218,8 @@
           closeForm: client.closeForm
             ? client.closeForm.bind(client)
             : undefined,
-          onFormSubmitSuccess: client.onFormSubmitSuccess
-            ? client.onFormSubmitSuccess.bind(client)
+          formSubmittedSuccessfully: client.formSubmittedSuccessfully
+            ? client.formSubmittedSuccessfully.bind(client)
             : undefined,
           toast: client.toast ? client.toast.bind(client) : undefined,
           navigate: client.navigate ? client.navigate.bind(client) : undefined,
@@ -239,11 +239,14 @@
 
     // Function to dispatch the ready event
     function dispatchReady() {
-      if (typeof CustomEvent !== "undefined" && typeof document !== "undefined") {
+      if (
+        typeof CustomEvent !== "undefined" &&
+        typeof document !== "undefined"
+      ) {
         var event = new CustomEvent("superleap-flow:ready", {
           detail: {
             FlowUI: window.FlowUI,
-            SuperLeap: window.SuperLeap,
+            Superleap: window.Superleap,
             components: _components,
           },
         });
@@ -257,14 +260,22 @@
     var urlParams = new URLSearchParams(window.location.search);
     var bridgeId = urlParams.get("_bridgeId");
 
-    if (isInIframe && bridgeId && window.SuperLeap && window.SuperLeap.connect) {
+    if (
+      isInIframe &&
+      bridgeId &&
+      window.Superleap &&
+      window.Superleap.connect
+    ) {
       // Auto-connect to CRM — defer ready event until connected
       function doAutoConnect() {
-        window.SuperLeap.connect({ bridgeId: bridgeId })
+        window.Superleap.connect({ bridgeId: bridgeId })
           .then(function () {
             // Expose SDK as a direct global so users can write sdkInstance.getModel() directly
-            if (window.SuperLeap && typeof window.SuperLeap.getSdk === "function") {
-              window.sdkInstance = window.SuperLeap.getSdk();
+            if (
+              window.Superleap &&
+              typeof window.Superleap.getSdk === "function"
+            ) {
+              window.sdkInstance = window.Superleap.getSdk();
             }
             dispatchReady();
           })
@@ -282,7 +293,7 @@
         setTimeout(doAutoConnect, 0);
       }
     } else {
-      // Standalone mode — user must call SuperLeap.init(config) manually
+      // Standalone mode — user must call Superleap.init(config) manually
       // Dispatch ready immediately (no connection needed)
       if (document.readyState === "loading") {
         document.addEventListener("DOMContentLoaded", dispatchReady);
@@ -296,7 +307,7 @@
   if (typeof window !== "undefined" && window.FlowUI) {
     if (typeof exports !== "undefined") {
       exports.FlowUI = window.FlowUI;
-      exports.SuperLeap = window.SuperLeap;
+      exports.Superleap = window.Superleap;
     }
   }
 
@@ -307,6 +318,6 @@
     typeof exports !== "undefined"
   ) {
     exports.FlowUI = global.FlowUI;
-    exports.SuperLeap = global.SuperLeap;
+    exports.Superleap = global.Superleap;
   }
 })(typeof window !== "undefined" ? window : this);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superleapai/flow-ui",
-  "version": "2.5.19",
+  "version": "2.5.21",
   "description": "A reusable design system for building multi-step forms with comprehensive UI components. Single file, clean globals, SDK included. Only FlowUI and SuperLeap exposed.",
   "main": "dist/superleap-flow.min.js",
   "types": "index.d.ts",
@@ -50,7 +50,7 @@
     "notifications",
     "superleap"
   ],
-  "author": "SuperLeap",
+  "author": "Superleap",
   "license": "MIT",
   "repository": {
     "type": "git",