@meshconnect/web-link-sdk 3.9.4 → 3.9.7

package/Link.js

@@ -221,9 +221,18 @@ export var createLink = function (options) {
         window.removeEventListener('message', eventsListener);
         (_a = options.onExit) === null || _a === void 0 ? void 0 : _a.call(options);
     };
+    var closeLinkRequested = function () {
+        if ((currentOptions === null || currentOptions === void 0 ? void 0 : currentOptions.renderType) === 'embedded') {
+            sendMessageToIframe({ type: 'closeRequested' });
+        }
+        else {
+            closeLink();
+        }
+    };
     return {
         openLink: openLink,
-        closeLink: closeLink
+        closeLink: closeLink,
+        closeLinkRequested: closeLinkRequested
     };
 };
 function addLanguage(linkUrl, language) {

package/README.md

@@ -40,7 +40,6 @@ import { createLink } from '@meshconnect/web-link-sdk';
 // ...
 
 const linkConnection = createLink({
-  clientId: '<Your Mesh Connect Client Id>',
   onIntegrationConnected: (data: LinkPayload) => {
     // use broker account data
   },
@@ -97,7 +96,6 @@ After successfull authentication on the Link session, the popup will be closed a
 
 | key                      | type                                                   | description                                                                          |
 | ------------------------ | ------------------------------------------------------ | ------------------------------------------------------------------------------------ |
-| `clientId`               | `string`                                               | Keys from https://dashboard.meshconnect.com/company/keys page                        |
 | `onIntegrationConnected` | `(payload: LinkPayload) => void`                       | Callback called when users connects their accounts                                   |
 | `onExit`                 | `((error?: string \| undefined) => void) \| undefined` | Called if connection not happened                                                    |
 | `onTransferFinished`     | `(payload: TransferFinishedPayload) => void`           | Callback called when a crypto transfer is executed                                   |
@@ -106,13 +104,15 @@ After successfull authentication on the Link session, the popup will be closed a
 | `language`               | `'en' \| undefined`                                    | Link UI language                                                                     |
 | `displayFiatCurrency`    | `'USD' \| undefined`                                   | A fiat currency to display fiat equivalent of a crypto amount                        |
 | `theme`                  | `'dark' \| 'light' \| 'system' \| undefined`           | Color theme of Link UI interface                                                     |
+| `renderType`             | `'overlay' \| 'embedded' \| undefined`                 | `'overlay'` (default) renders a full-screen popup; `'embedded'` renders inside a client-supplied iframe (requires `customIframeId` in `openLink`) |
 
 #### `createLink` return value
 
-| key         | type                                   | description              |
-| ----------- | -------------------------------------- | ------------------------ |
-| `openLink`  | `(linkToken: string) => Promise<void>` | Opens the Link UI popup  |
-| `closeLink` | `() => Promise<void>`                  | Closes the Link UI popup |
+| key                  | type                                                        | description                                                                                                |
+| -------------------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `openLink`           | `(linkToken: string, customIframeId?: string) => void`      | Opens the Link UI popup. Optionally targets an existing iframe by ID instead of creating a new popup       |
+| `closeLink`          | `() => void`                                                | Closes the Link UI popup immediately                                                                       |
+| `closeLinkRequested` | `() => void`                                                | Requests graceful close in `embedded` mode (sends `closeRequested` to iframe); closes immediately otherwise  |
 
 ### Using tokens
 
@@ -121,3 +121,19 @@ You can use broker tokens to perform requests to get current balance, assets and
 ## Typescript support
 
 TypeScript definitions for `@meshconnect/web-link-sdk` are built into the npm package.
+
+### Exported types
+
+| type                      | description                                                                                   |
+| ------------------------- | --------------------------------------------------------------------------------------------- |
+| `LinkPayload`             | Payload passed to `onIntegrationConnected`                                                    |
+| `AccessTokenPayload`      | Broker access token details within `LinkPayload`                                              |
+| `DelayedAuthPayload`      | Delayed auth details within `LinkPayload`                                                     |
+| `IntegrationAccessToken`  | Access token shape used in the `accessTokens` option                                          |
+| `TransferFinishedPayload` | Payload passed to `onTransferFinished`                                                        |
+| `BrokerType`              | Union of supported broker/integration type strings (re-exported from `@meshconnect/node-api`) |
+| `LinkOptions`             | Full options object passed to `createLink`                                                    |
+| `Link`                    | Return type of `createLink`                                                                   |
+| `AccountToken`            | Account token within `AccessTokenPayload`                                                     |
+| `Account`                 | Account details within `AccountToken`                                                         |
+| `BrandInfo`               | Integration brand/logo info                                                                   |

package/index.d.ts

@@ -1,3 +1,4 @@
 export * from './utils/types';
 export * from './utils/event-types';
 export { createLink } from './Link';
+export type { BrokerType } from '@meshconnect/node-api';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meshconnect/web-link-sdk",
-  "version": "3.9.4",
+  "version": "3.9.7",
   "description": "A client-side JS library for integrating with Mesh Connect",
   "exports": "./index.js",
   "license": "MIT",

package/utils/event-types.d.ts

@@ -54,6 +54,8 @@ export interface TransferExecuted extends LinkEventBase {
         symbol: string;
         amount: number;
         networkId: string;
+        userId?: string;
+        clientTransactionId?: string;
     };
 }
 export interface TransferNoEligibleAssets extends LinkEventBase {

package/utils/types.d.ts

@@ -12,6 +12,10 @@ export interface Link {
      * A function to close Link UI popup
      */
     closeLink: () => void;
+    /**
+     * A function to request Link UI to close gracefully in embedded mode.
+     */
+    closeLinkRequested: () => void;
 }
 export interface AccountToken {
     account: Account;
@@ -82,6 +86,8 @@ export interface TransferFinishedPayload {
     symbol: string;
     amount: number;
     networkId: string;
+    userId?: string;
+    clientTransactionId?: string;
     amountInFiat?: number;
     totalAmountInFiat?: number;
     networkName?: string;
@@ -98,7 +104,7 @@ export interface IntegrationAccessToken {
 }
 export interface LinkOptions {
     /**
-     * Client ID that can be obtained at https://dashboard.meshconnect.com/company/keys
+     * @deprecated This property is unused and will be removed in the next major version.
      */
     clientId?: string;
     /**

package/utils/version.d.ts

@@ -1 +1 @@
-export declare const sdkVersion = "3.9.4";
+export declare const sdkVersion = "3.9.7";

package/utils/version.js

@@ -1 +1 @@
-export var sdkVersion = '3.9.4';
+export var sdkVersion = '3.9.7';