@frak-labs/core-sdk 0.2.1-beta.b38eef2e → 0.2.1-beta.bbbb3d22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -2
- package/cdn/bundle.js +55 -3
- package/dist/actions-CIb7OfPp.js +1 -0
- package/dist/actions-uSbbKcu2.cjs +1 -0
- package/dist/actions.cjs +1 -1
- package/dist/actions.d.cts +3 -3
- package/dist/actions.d.ts +3 -3
- package/dist/actions.js +1 -1
- package/dist/bundle.cjs +1 -1
- package/dist/bundle.d.cts +4 -4
- package/dist/bundle.d.ts +4 -4
- package/dist/bundle.js +1 -1
- package/dist/{computeLegacyProductId-CCAZvLa5.d.cts → index-BMGEHGK_.d.ts} +91 -37
- package/dist/{computeLegacyProductId-b5cUWdAm.d.ts → index-CZ6q9BCe.d.cts} +91 -37
- package/dist/{siweAuthenticate-CnCZ7mok.d.ts → index-D9j5kJQ_.d.cts} +122 -8
- package/dist/{siweAuthenticate-CVigMOxz.d.cts → index-r9cPHZJn.d.ts} +122 -8
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +1 -1
- package/dist/{openSso-B0g7-807.d.cts → openSso-C6AZ6DHE.d.ts} +278 -46
- package/dist/{openSso-CMzwvaCa.d.ts → openSso-DDC7BA9w.d.cts} +278 -46
- package/dist/src-CeGtGFnJ.js +13 -0
- package/dist/src-PWfXcMJt.cjs +13 -0
- package/dist/trackEvent-Ce1XlsIE.js +1 -0
- package/dist/trackEvent-CvbJTTqA.cjs +1 -0
- package/package.json +12 -13
- package/src/actions/displayEmbeddedWallet.ts +6 -2
- package/src/actions/displayModal.ts +6 -2
- package/src/actions/displaySharingPage.ts +49 -0
- package/src/actions/ensureIdentity.ts +2 -2
- package/src/actions/getMerchantInformation.test.ts +13 -1
- package/src/actions/getMerchantInformation.ts +20 -5
- package/src/actions/getMergeToken.ts +33 -0
- package/src/actions/getUserReferralStatus.ts +42 -0
- package/src/actions/index.ts +8 -1
- package/src/actions/referral/setupReferral.test.ts +79 -0
- package/src/actions/referral/setupReferral.ts +32 -0
- package/src/actions/trackPurchaseStatus.test.ts +32 -20
- package/src/actions/trackPurchaseStatus.ts +3 -5
- package/src/actions/wrapper/modalBuilder.test.ts +4 -2
- package/src/actions/wrapper/modalBuilder.ts +6 -8
- package/src/clients/createIFrameFrakClient.ts +150 -27
- package/src/clients/transports/iframeLifecycleManager.test.ts +14 -94
- package/src/clients/transports/iframeLifecycleManager.ts +35 -53
- package/src/index.ts +17 -4
- package/src/types/config.ts +10 -3
- package/src/types/index.ts +13 -1
- package/src/types/lifecycle/client.ts +22 -27
- package/src/types/lifecycle/iframe.ts +7 -8
- package/src/types/resolvedConfig.ts +123 -0
- package/src/types/rpc/displaySharingPage.ts +77 -0
- package/src/types/rpc/embedded/index.ts +1 -1
- package/src/types/rpc/interaction.ts +4 -0
- package/src/types/rpc/userReferralStatus.ts +20 -0
- package/src/types/rpc.ts +54 -5
- package/src/utils/backendUrl.test.ts +2 -2
- package/src/utils/backendUrl.ts +1 -1
- package/src/utils/cache/index.ts +7 -0
- package/src/utils/cache/lruMap.test.ts +55 -0
- package/src/utils/cache/lruMap.ts +38 -0
- package/src/utils/cache/withCache.test.ts +162 -0
- package/src/utils/cache/withCache.ts +105 -0
- package/src/utils/inAppBrowser.ts +60 -0
- package/src/utils/index.ts +6 -4
- package/src/utils/sdkConfigStore.test.ts +405 -0
- package/src/utils/sdkConfigStore.ts +263 -0
- package/src/utils/sso.ts +3 -7
- package/dist/setupClient-CqTHGvVa.cjs +0 -13
- package/dist/setupClient-DTyvAPgh.js +0 -13
- package/dist/siweAuthenticate-BWmI2_TN.cjs +0 -1
- package/dist/siweAuthenticate-zczqxm0a.js +0 -1
- package/dist/trackEvent-CeLFVzZn.js +0 -1
- package/dist/trackEvent-Ew5r5zfI.cjs +0 -1
- package/src/utils/merchantId.test.ts +0 -653
- package/src/utils/merchantId.ts +0 -143
|
@@ -1,13 +1,14 @@
|
|
|
1
|
-
import { A as
|
|
1
|
+
import { A as ModalRpcMetadata, B as LoginModalStepType, D as DisplaySharingPageResultType, E as DisplaySharingPageParamsType, F as SendTransactionReturnType, K as FinalActionType, M as ModalRpcStepsResultType, N as ModalStepTypes, P as SendTransactionModalStepType, R as SiweAuthenticateReturnType, U as PrepareSsoParamsType, W as PrepareSsoReturnType, b as DisplayEmbeddedWalletParamsType, g as GetMerchantInformationReturnType, i as FrakContext, k as DisplayModalParamsType, l as FrakClient, m as UserReferralStatusType, p as WalletStatusReturnType, q as FinalModalStepType, x as DisplayEmbeddedWalletResultType, y as SendInteractionParamsType, z as SiweAuthenticationParams } from "./openSso-DDC7BA9w.cjs";
|
|
2
2
|
|
|
3
3
|
//#region src/actions/displayEmbeddedWallet.d.ts
|
|
4
4
|
/**
|
|
5
5
|
* Function used to display the Frak embedded wallet popup
|
|
6
6
|
* @param client - The current Frak Client
|
|
7
7
|
* @param params - The parameter used to customise the embedded wallet
|
|
8
|
+
* @param placement - Optional placement ID to associate with this display request
|
|
8
9
|
* @returns The embedded wallet display result
|
|
9
10
|
*/
|
|
10
|
-
declare function displayEmbeddedWallet(client: FrakClient, params: DisplayEmbeddedWalletParamsType): Promise<DisplayEmbeddedWalletResultType>;
|
|
11
|
+
declare function displayEmbeddedWallet(client: FrakClient, params: DisplayEmbeddedWalletParamsType, placement?: string): Promise<DisplayEmbeddedWalletResultType>;
|
|
11
12
|
//#endregion
|
|
12
13
|
//#region src/actions/displayModal.d.ts
|
|
13
14
|
/**
|
|
@@ -16,6 +17,7 @@ declare function displayEmbeddedWallet(client: FrakClient, params: DisplayEmbedd
|
|
|
16
17
|
* @param args
|
|
17
18
|
* @param args.steps - The different steps of the modal
|
|
18
19
|
* @param args.metadata - The metadata for the modal (customization, etc)
|
|
20
|
+
* @param placement - Optional placement ID to associate with this modal display
|
|
19
21
|
* @returns The result of each modal steps
|
|
20
22
|
*
|
|
21
23
|
* @description This function will display a modal to the user with the provided steps and metadata.
|
|
@@ -115,7 +117,41 @@ declare function displayEmbeddedWallet(client: FrakClient, params: DisplayEmbedd
|
|
|
115
117
|
declare function displayModal<T extends ModalStepTypes[] = ModalStepTypes[]>(client: FrakClient, {
|
|
116
118
|
steps,
|
|
117
119
|
metadata
|
|
118
|
-
}: DisplayModalParamsType<T
|
|
120
|
+
}: DisplayModalParamsType<T>, placement?: string): Promise<ModalRpcStepsResultType<T>>;
|
|
121
|
+
//#endregion
|
|
122
|
+
//#region src/actions/displaySharingPage.d.ts
|
|
123
|
+
/**
|
|
124
|
+
* Function used to display a sharing page
|
|
125
|
+
* @param client - The current Frak Client
|
|
126
|
+
* @param params - The parameters to customize the sharing page (products, link override, metadata)
|
|
127
|
+
* @param placement - Optional placement ID to associate with this display request
|
|
128
|
+
* @returns The result indicating the user's action (shared, copied, or dismissed)
|
|
129
|
+
*
|
|
130
|
+
* @description This function will display a full-page sharing UI to the user,
|
|
131
|
+
* showing product info, estimated rewards, sharing steps, FAQ, and share/copy buttons.
|
|
132
|
+
* The sharing link is generated from the user's wallet context + merchant info.
|
|
133
|
+
*
|
|
134
|
+
* @remarks
|
|
135
|
+
* - The promise resolves on the first user action (share or copy) but the page stays visible
|
|
136
|
+
* - The user can continue to share/copy multiple times after the initial resolution
|
|
137
|
+
* - Dismissing the page after a share/copy action is a no-op (promise already resolved)
|
|
138
|
+
* - If the user dismisses without any action, the promise resolves with `{ action: "dismissed" }`
|
|
139
|
+
*
|
|
140
|
+
* @example
|
|
141
|
+
* ```ts
|
|
142
|
+
* const result = await displaySharingPage(frakClient, {
|
|
143
|
+
* products: [
|
|
144
|
+
* {
|
|
145
|
+
* title: "Babies camel cuir velours bout carré",
|
|
146
|
+
* imageUrl: "https://example.com/product.jpg",
|
|
147
|
+
* },
|
|
148
|
+
* ],
|
|
149
|
+
* });
|
|
150
|
+
*
|
|
151
|
+
* console.log("User action:", result.action); // "shared" | "copied" | "dismissed"
|
|
152
|
+
* ```
|
|
153
|
+
*/
|
|
154
|
+
declare function displaySharingPage(client: FrakClient, params: DisplaySharingPageParamsType, placement?: string): Promise<DisplaySharingPageResultType>;
|
|
119
155
|
//#endregion
|
|
120
156
|
//#region src/actions/ensureIdentity.d.ts
|
|
121
157
|
/**
|
|
@@ -144,13 +180,70 @@ declare function ensureIdentity(interactionToken: string): Promise<void>;
|
|
|
144
180
|
//#endregion
|
|
145
181
|
//#region src/actions/getMerchantInformation.d.ts
|
|
146
182
|
/**
|
|
147
|
-
* Fetch the current merchant information (name, rewards, tiers) from the wallet iframe
|
|
183
|
+
* Fetch the current merchant information (name, rewards, tiers) from the wallet iframe.
|
|
184
|
+
*
|
|
185
|
+
* Results are cached in memory for 30 seconds by default. Concurrent calls
|
|
186
|
+
* while a request is in-flight are deduplicated automatically.
|
|
187
|
+
*
|
|
148
188
|
* @param client - The current Frak Client
|
|
189
|
+
* @param options - Optional cache configuration
|
|
190
|
+
* @param options.cacheTime - Time in ms to cache the result. Default: 30_000 (30s). Set to 0 to disable.
|
|
149
191
|
* @returns The merchant information including available reward tiers
|
|
150
192
|
*
|
|
151
193
|
* @see {@link @frak-labs/core-sdk!index.GetMerchantInformationReturnType | `GetMerchantInformationReturnType`} for the return type shape
|
|
152
194
|
*/
|
|
153
|
-
declare function getMerchantInformation(client: FrakClient
|
|
195
|
+
declare function getMerchantInformation(client: FrakClient, options?: {
|
|
196
|
+
cacheTime?: number;
|
|
197
|
+
}): Promise<GetMerchantInformationReturnType>;
|
|
198
|
+
//#endregion
|
|
199
|
+
//#region src/actions/getMergeToken.d.ts
|
|
200
|
+
/**
|
|
201
|
+
* Fetch a merge token for the current anonymous identity.
|
|
202
|
+
*
|
|
203
|
+
* Used by in-app browser redirect flows to preserve identity
|
|
204
|
+
* when switching from a WebView to the system browser.
|
|
205
|
+
* The token is appended as `?fmt=` to the redirect URL.
|
|
206
|
+
*
|
|
207
|
+
* Results are cached in memory for 30 seconds by default. Concurrent calls
|
|
208
|
+
* while a request is in-flight are deduplicated automatically.
|
|
209
|
+
*
|
|
210
|
+
* @param client - The current Frak Client
|
|
211
|
+
* @param options - Optional cache configuration
|
|
212
|
+
* @param options.cacheTime - Time in ms to cache the result. Default: 30_000 (30s). Set to 0 to disable.
|
|
213
|
+
* @returns The merge token string, or null if unavailable
|
|
214
|
+
*/
|
|
215
|
+
declare function getMergeToken(client: FrakClient, options?: {
|
|
216
|
+
cacheTime?: number;
|
|
217
|
+
}): Promise<string | null>;
|
|
218
|
+
//#endregion
|
|
219
|
+
//#region src/actions/getUserReferralStatus.d.ts
|
|
220
|
+
/**
|
|
221
|
+
* Fetch the current user's referral status on the current merchant.
|
|
222
|
+
*
|
|
223
|
+
* The listener resolves the user's identity (via clientId or wallet session)
|
|
224
|
+
* and checks whether a referral link exists where the user is the referee.
|
|
225
|
+
*
|
|
226
|
+
* Results are cached in memory for 30 seconds by default. Concurrent calls
|
|
227
|
+
* while a request is in-flight are deduplicated automatically.
|
|
228
|
+
*
|
|
229
|
+
* Returns `null` when the user's identity cannot be resolved.
|
|
230
|
+
*
|
|
231
|
+
* @param client - The current Frak Client
|
|
232
|
+
* @param options - Optional cache configuration
|
|
233
|
+
* @param options.cacheTime - Time in ms to cache the result. Default: 30_000 (30s). Set to 0 to disable.
|
|
234
|
+
* @returns The user's referral status, or `null` if identity cannot be resolved
|
|
235
|
+
*
|
|
236
|
+
* @example
|
|
237
|
+
* ```ts
|
|
238
|
+
* const status = await getUserReferralStatus(client);
|
|
239
|
+
* if (status?.isReferred) {
|
|
240
|
+
* console.log("User was referred to this merchant");
|
|
241
|
+
* }
|
|
242
|
+
* ```
|
|
243
|
+
*/
|
|
244
|
+
declare function getUserReferralStatus(client: FrakClient, options?: {
|
|
245
|
+
cacheTime?: number;
|
|
246
|
+
}): Promise<UserReferralStatusType | null>;
|
|
154
247
|
//#endregion
|
|
155
248
|
//#region src/actions/prepareSso.d.ts
|
|
156
249
|
/**
|
|
@@ -256,6 +349,26 @@ declare function referralInteraction(client: FrakClient, {
|
|
|
256
349
|
options?: ProcessReferralOptions;
|
|
257
350
|
}): Promise<("idle" | "processing" | "success" | "no-referrer" | "self-referral") | undefined>;
|
|
258
351
|
//#endregion
|
|
352
|
+
//#region src/actions/referral/setupReferral.d.ts
|
|
353
|
+
/**
|
|
354
|
+
* Custom event name dispatched on successful referral processing.
|
|
355
|
+
*
|
|
356
|
+
* Fired once per page load when a valid referral context is found in the URL
|
|
357
|
+
* and successfully tracked. Consumers (e.g. `<frak-banner>`) listen for this
|
|
358
|
+
* to display a referral success message.
|
|
359
|
+
*/
|
|
360
|
+
declare const REFERRAL_SUCCESS_EVENT = "frak:referral-success";
|
|
361
|
+
/**
|
|
362
|
+
* Process referral context and emit a DOM event on success.
|
|
363
|
+
*
|
|
364
|
+
* - Calls {@link referralInteraction} to detect and track any referral in the URL
|
|
365
|
+
* - On `"success"`, dispatches a bare {@link REFERRAL_SUCCESS_EVENT} on `window`
|
|
366
|
+
* - Silently swallows errors (fire-and-forget during SDK init)
|
|
367
|
+
*
|
|
368
|
+
* @param client - The initialized Frak client
|
|
369
|
+
*/
|
|
370
|
+
declare function setupReferral(client: FrakClient): Promise<void>;
|
|
371
|
+
//#endregion
|
|
259
372
|
//#region src/actions/sendInteraction.d.ts
|
|
260
373
|
/**
|
|
261
374
|
* Send an interaction to the backend via the listener RPC.
|
|
@@ -322,7 +435,7 @@ declare function sendInteraction(client: FrakClient, params: SendInteractionPara
|
|
|
322
435
|
* }
|
|
323
436
|
*
|
|
324
437
|
* @remarks
|
|
325
|
-
* - Merchant id is resolved in this order: explicit `args.merchantId`, `
|
|
438
|
+
* - Merchant id is resolved in this order: explicit `args.merchantId`, then `sdkConfigStore.resolveMerchantId()` (config store → sessionStorage → backend fetch).
|
|
326
439
|
* - This function supports anonymous users and will use the `x-frak-client-id` header when available.
|
|
327
440
|
* - At least one identity source must exist (`frak-wallet-interaction-token` or `x-frak-client-id`), otherwise the tracking request is skipped.
|
|
328
441
|
* - This function will print a warning if used in a non-browser environment or if no identity / merchant id can be resolved.
|
|
@@ -380,8 +493,9 @@ type ModalStepBuilder<Steps extends ModalStepTypes[] = ModalStepTypes[]> = {
|
|
|
380
493
|
/**
|
|
381
494
|
* Display the modal
|
|
382
495
|
* @param metadataOverride - Function returning optional metadata to override the current modal metadata
|
|
496
|
+
* @param placement - Optional placement ID to associate with this modal display
|
|
383
497
|
*/
|
|
384
|
-
display: (metadataOverride?: (current?: ModalRpcMetadata) => ModalRpcMetadata | undefined) => Promise<ModalRpcStepsResultType<Steps>>;
|
|
498
|
+
display: (metadataOverride?: (current?: ModalRpcMetadata) => ModalRpcMetadata | undefined, placement?: string) => Promise<ModalRpcStepsResultType<Steps>>;
|
|
385
499
|
};
|
|
386
500
|
/**
|
|
387
501
|
* Represent the output type of the modal builder
|
|
@@ -529,4 +643,4 @@ declare function siweAuthenticate(client: FrakClient, {
|
|
|
529
643
|
metadata
|
|
530
644
|
}: SiweAuthenticateModalParams): Promise<SiweAuthenticateReturnType>;
|
|
531
645
|
//#endregion
|
|
532
|
-
export { displayModal as _, ModalBuilder as a, watchWalletStatus as c,
|
|
646
|
+
export { displayEmbeddedWallet as C, displayModal as S, getUserReferralStatus as _, ModalBuilder as a, ensureIdentity as b, watchWalletStatus as c, REFERRAL_SUCCESS_EVENT as d, setupReferral as f, prepareSso as g, processReferral as h, sendTransaction as i, trackPurchaseStatus as l, ProcessReferralOptions as m, siweAuthenticate as n, ModalStepBuilder as o, referralInteraction as p, SendTransactionParams as r, modalBuilder as s, SiweAuthenticateModalParams as t, sendInteraction as u, getMergeToken as v, displaySharingPage as x, getMerchantInformation as y };
|
|
@@ -1,13 +1,14 @@
|
|
|
1
|
-
import { A as
|
|
1
|
+
import { A as ModalRpcMetadata, B as LoginModalStepType, D as DisplaySharingPageResultType, E as DisplaySharingPageParamsType, F as SendTransactionReturnType, K as FinalActionType, M as ModalRpcStepsResultType, N as ModalStepTypes, P as SendTransactionModalStepType, R as SiweAuthenticateReturnType, U as PrepareSsoParamsType, W as PrepareSsoReturnType, b as DisplayEmbeddedWalletParamsType, g as GetMerchantInformationReturnType, i as FrakContext, k as DisplayModalParamsType, l as FrakClient, m as UserReferralStatusType, p as WalletStatusReturnType, q as FinalModalStepType, x as DisplayEmbeddedWalletResultType, y as SendInteractionParamsType, z as SiweAuthenticationParams } from "./openSso-C6AZ6DHE.js";
|
|
2
2
|
|
|
3
3
|
//#region src/actions/displayEmbeddedWallet.d.ts
|
|
4
4
|
/**
|
|
5
5
|
* Function used to display the Frak embedded wallet popup
|
|
6
6
|
* @param client - The current Frak Client
|
|
7
7
|
* @param params - The parameter used to customise the embedded wallet
|
|
8
|
+
* @param placement - Optional placement ID to associate with this display request
|
|
8
9
|
* @returns The embedded wallet display result
|
|
9
10
|
*/
|
|
10
|
-
declare function displayEmbeddedWallet(client: FrakClient, params: DisplayEmbeddedWalletParamsType): Promise<DisplayEmbeddedWalletResultType>;
|
|
11
|
+
declare function displayEmbeddedWallet(client: FrakClient, params: DisplayEmbeddedWalletParamsType, placement?: string): Promise<DisplayEmbeddedWalletResultType>;
|
|
11
12
|
//#endregion
|
|
12
13
|
//#region src/actions/displayModal.d.ts
|
|
13
14
|
/**
|
|
@@ -16,6 +17,7 @@ declare function displayEmbeddedWallet(client: FrakClient, params: DisplayEmbedd
|
|
|
16
17
|
* @param args
|
|
17
18
|
* @param args.steps - The different steps of the modal
|
|
18
19
|
* @param args.metadata - The metadata for the modal (customization, etc)
|
|
20
|
+
* @param placement - Optional placement ID to associate with this modal display
|
|
19
21
|
* @returns The result of each modal steps
|
|
20
22
|
*
|
|
21
23
|
* @description This function will display a modal to the user with the provided steps and metadata.
|
|
@@ -115,7 +117,41 @@ declare function displayEmbeddedWallet(client: FrakClient, params: DisplayEmbedd
|
|
|
115
117
|
declare function displayModal<T extends ModalStepTypes[] = ModalStepTypes[]>(client: FrakClient, {
|
|
116
118
|
steps,
|
|
117
119
|
metadata
|
|
118
|
-
}: DisplayModalParamsType<T
|
|
120
|
+
}: DisplayModalParamsType<T>, placement?: string): Promise<ModalRpcStepsResultType<T>>;
|
|
121
|
+
//#endregion
|
|
122
|
+
//#region src/actions/displaySharingPage.d.ts
|
|
123
|
+
/**
|
|
124
|
+
* Function used to display a sharing page
|
|
125
|
+
* @param client - The current Frak Client
|
|
126
|
+
* @param params - The parameters to customize the sharing page (products, link override, metadata)
|
|
127
|
+
* @param placement - Optional placement ID to associate with this display request
|
|
128
|
+
* @returns The result indicating the user's action (shared, copied, or dismissed)
|
|
129
|
+
*
|
|
130
|
+
* @description This function will display a full-page sharing UI to the user,
|
|
131
|
+
* showing product info, estimated rewards, sharing steps, FAQ, and share/copy buttons.
|
|
132
|
+
* The sharing link is generated from the user's wallet context + merchant info.
|
|
133
|
+
*
|
|
134
|
+
* @remarks
|
|
135
|
+
* - The promise resolves on the first user action (share or copy) but the page stays visible
|
|
136
|
+
* - The user can continue to share/copy multiple times after the initial resolution
|
|
137
|
+
* - Dismissing the page after a share/copy action is a no-op (promise already resolved)
|
|
138
|
+
* - If the user dismisses without any action, the promise resolves with `{ action: "dismissed" }`
|
|
139
|
+
*
|
|
140
|
+
* @example
|
|
141
|
+
* ```ts
|
|
142
|
+
* const result = await displaySharingPage(frakClient, {
|
|
143
|
+
* products: [
|
|
144
|
+
* {
|
|
145
|
+
* title: "Babies camel cuir velours bout carré",
|
|
146
|
+
* imageUrl: "https://example.com/product.jpg",
|
|
147
|
+
* },
|
|
148
|
+
* ],
|
|
149
|
+
* });
|
|
150
|
+
*
|
|
151
|
+
* console.log("User action:", result.action); // "shared" | "copied" | "dismissed"
|
|
152
|
+
* ```
|
|
153
|
+
*/
|
|
154
|
+
declare function displaySharingPage(client: FrakClient, params: DisplaySharingPageParamsType, placement?: string): Promise<DisplaySharingPageResultType>;
|
|
119
155
|
//#endregion
|
|
120
156
|
//#region src/actions/ensureIdentity.d.ts
|
|
121
157
|
/**
|
|
@@ -144,13 +180,70 @@ declare function ensureIdentity(interactionToken: string): Promise<void>;
|
|
|
144
180
|
//#endregion
|
|
145
181
|
//#region src/actions/getMerchantInformation.d.ts
|
|
146
182
|
/**
|
|
147
|
-
* Fetch the current merchant information (name, rewards, tiers) from the wallet iframe
|
|
183
|
+
* Fetch the current merchant information (name, rewards, tiers) from the wallet iframe.
|
|
184
|
+
*
|
|
185
|
+
* Results are cached in memory for 30 seconds by default. Concurrent calls
|
|
186
|
+
* while a request is in-flight are deduplicated automatically.
|
|
187
|
+
*
|
|
148
188
|
* @param client - The current Frak Client
|
|
189
|
+
* @param options - Optional cache configuration
|
|
190
|
+
* @param options.cacheTime - Time in ms to cache the result. Default: 30_000 (30s). Set to 0 to disable.
|
|
149
191
|
* @returns The merchant information including available reward tiers
|
|
150
192
|
*
|
|
151
193
|
* @see {@link @frak-labs/core-sdk!index.GetMerchantInformationReturnType | `GetMerchantInformationReturnType`} for the return type shape
|
|
152
194
|
*/
|
|
153
|
-
declare function getMerchantInformation(client: FrakClient
|
|
195
|
+
declare function getMerchantInformation(client: FrakClient, options?: {
|
|
196
|
+
cacheTime?: number;
|
|
197
|
+
}): Promise<GetMerchantInformationReturnType>;
|
|
198
|
+
//#endregion
|
|
199
|
+
//#region src/actions/getMergeToken.d.ts
|
|
200
|
+
/**
|
|
201
|
+
* Fetch a merge token for the current anonymous identity.
|
|
202
|
+
*
|
|
203
|
+
* Used by in-app browser redirect flows to preserve identity
|
|
204
|
+
* when switching from a WebView to the system browser.
|
|
205
|
+
* The token is appended as `?fmt=` to the redirect URL.
|
|
206
|
+
*
|
|
207
|
+
* Results are cached in memory for 30 seconds by default. Concurrent calls
|
|
208
|
+
* while a request is in-flight are deduplicated automatically.
|
|
209
|
+
*
|
|
210
|
+
* @param client - The current Frak Client
|
|
211
|
+
* @param options - Optional cache configuration
|
|
212
|
+
* @param options.cacheTime - Time in ms to cache the result. Default: 30_000 (30s). Set to 0 to disable.
|
|
213
|
+
* @returns The merge token string, or null if unavailable
|
|
214
|
+
*/
|
|
215
|
+
declare function getMergeToken(client: FrakClient, options?: {
|
|
216
|
+
cacheTime?: number;
|
|
217
|
+
}): Promise<string | null>;
|
|
218
|
+
//#endregion
|
|
219
|
+
//#region src/actions/getUserReferralStatus.d.ts
|
|
220
|
+
/**
|
|
221
|
+
* Fetch the current user's referral status on the current merchant.
|
|
222
|
+
*
|
|
223
|
+
* The listener resolves the user's identity (via clientId or wallet session)
|
|
224
|
+
* and checks whether a referral link exists where the user is the referee.
|
|
225
|
+
*
|
|
226
|
+
* Results are cached in memory for 30 seconds by default. Concurrent calls
|
|
227
|
+
* while a request is in-flight are deduplicated automatically.
|
|
228
|
+
*
|
|
229
|
+
* Returns `null` when the user's identity cannot be resolved.
|
|
230
|
+
*
|
|
231
|
+
* @param client - The current Frak Client
|
|
232
|
+
* @param options - Optional cache configuration
|
|
233
|
+
* @param options.cacheTime - Time in ms to cache the result. Default: 30_000 (30s). Set to 0 to disable.
|
|
234
|
+
* @returns The user's referral status, or `null` if identity cannot be resolved
|
|
235
|
+
*
|
|
236
|
+
* @example
|
|
237
|
+
* ```ts
|
|
238
|
+
* const status = await getUserReferralStatus(client);
|
|
239
|
+
* if (status?.isReferred) {
|
|
240
|
+
* console.log("User was referred to this merchant");
|
|
241
|
+
* }
|
|
242
|
+
* ```
|
|
243
|
+
*/
|
|
244
|
+
declare function getUserReferralStatus(client: FrakClient, options?: {
|
|
245
|
+
cacheTime?: number;
|
|
246
|
+
}): Promise<UserReferralStatusType | null>;
|
|
154
247
|
//#endregion
|
|
155
248
|
//#region src/actions/prepareSso.d.ts
|
|
156
249
|
/**
|
|
@@ -256,6 +349,26 @@ declare function referralInteraction(client: FrakClient, {
|
|
|
256
349
|
options?: ProcessReferralOptions;
|
|
257
350
|
}): Promise<("idle" | "processing" | "success" | "no-referrer" | "self-referral") | undefined>;
|
|
258
351
|
//#endregion
|
|
352
|
+
//#region src/actions/referral/setupReferral.d.ts
|
|
353
|
+
/**
|
|
354
|
+
* Custom event name dispatched on successful referral processing.
|
|
355
|
+
*
|
|
356
|
+
* Fired once per page load when a valid referral context is found in the URL
|
|
357
|
+
* and successfully tracked. Consumers (e.g. `<frak-banner>`) listen for this
|
|
358
|
+
* to display a referral success message.
|
|
359
|
+
*/
|
|
360
|
+
declare const REFERRAL_SUCCESS_EVENT = "frak:referral-success";
|
|
361
|
+
/**
|
|
362
|
+
* Process referral context and emit a DOM event on success.
|
|
363
|
+
*
|
|
364
|
+
* - Calls {@link referralInteraction} to detect and track any referral in the URL
|
|
365
|
+
* - On `"success"`, dispatches a bare {@link REFERRAL_SUCCESS_EVENT} on `window`
|
|
366
|
+
* - Silently swallows errors (fire-and-forget during SDK init)
|
|
367
|
+
*
|
|
368
|
+
* @param client - The initialized Frak client
|
|
369
|
+
*/
|
|
370
|
+
declare function setupReferral(client: FrakClient): Promise<void>;
|
|
371
|
+
//#endregion
|
|
259
372
|
//#region src/actions/sendInteraction.d.ts
|
|
260
373
|
/**
|
|
261
374
|
* Send an interaction to the backend via the listener RPC.
|
|
@@ -322,7 +435,7 @@ declare function sendInteraction(client: FrakClient, params: SendInteractionPara
|
|
|
322
435
|
* }
|
|
323
436
|
*
|
|
324
437
|
* @remarks
|
|
325
|
-
* - Merchant id is resolved in this order: explicit `args.merchantId`, `
|
|
438
|
+
* - Merchant id is resolved in this order: explicit `args.merchantId`, then `sdkConfigStore.resolveMerchantId()` (config store → sessionStorage → backend fetch).
|
|
326
439
|
* - This function supports anonymous users and will use the `x-frak-client-id` header when available.
|
|
327
440
|
* - At least one identity source must exist (`frak-wallet-interaction-token` or `x-frak-client-id`), otherwise the tracking request is skipped.
|
|
328
441
|
* - This function will print a warning if used in a non-browser environment or if no identity / merchant id can be resolved.
|
|
@@ -380,8 +493,9 @@ type ModalStepBuilder<Steps extends ModalStepTypes[] = ModalStepTypes[]> = {
|
|
|
380
493
|
/**
|
|
381
494
|
* Display the modal
|
|
382
495
|
* @param metadataOverride - Function returning optional metadata to override the current modal metadata
|
|
496
|
+
* @param placement - Optional placement ID to associate with this modal display
|
|
383
497
|
*/
|
|
384
|
-
display: (metadataOverride?: (current?: ModalRpcMetadata) => ModalRpcMetadata | undefined) => Promise<ModalRpcStepsResultType<Steps>>;
|
|
498
|
+
display: (metadataOverride?: (current?: ModalRpcMetadata) => ModalRpcMetadata | undefined, placement?: string) => Promise<ModalRpcStepsResultType<Steps>>;
|
|
385
499
|
};
|
|
386
500
|
/**
|
|
387
501
|
* Represent the output type of the modal builder
|
|
@@ -529,4 +643,4 @@ declare function siweAuthenticate(client: FrakClient, {
|
|
|
529
643
|
metadata
|
|
530
644
|
}: SiweAuthenticateModalParams): Promise<SiweAuthenticateReturnType>;
|
|
531
645
|
//#endregion
|
|
532
|
-
export { displayModal as _, ModalBuilder as a, watchWalletStatus as c,
|
|
646
|
+
export { displayEmbeddedWallet as C, displayModal as S, getUserReferralStatus as _, ModalBuilder as a, ensureIdentity as b, watchWalletStatus as c, REFERRAL_SUCCESS_EVENT as d, setupReferral as f, prepareSso as g, processReferral as h, sendTransaction as i, trackPurchaseStatus as l, ProcessReferralOptions as m, siweAuthenticate as n, ModalStepBuilder as o, referralInteraction as p, SendTransactionParams as r, modalBuilder as s, SiweAuthenticateModalParams as t, sendInteraction as u, getMergeToken as v, displaySharingPage as x, getMerchantInformation as y };
|
package/dist/index.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./trackEvent-
|
|
1
|
+
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./trackEvent-CvbJTTqA.cjs`),t=require(`./src-PWfXcMJt.cjs`);exports.DEEP_LINK_SCHEME=t.y,exports.DebugInfoGatherer=t.r,exports.FrakContextManager=e.r,exports.base64urlDecode=e.g,exports.base64urlEncode=e._,exports.baseIframeProps=t.s,exports.clearAllCache=e.s,exports.compressJsonToB64=e.h,exports.computeLegacyProductId=e.v,exports.createIFrameFrakClient=t.n,exports.createIframe=t.c,exports.decompressJsonFromB64=e.o,exports.findIframeInOpener=t.l,exports.formatAmount=t.d,exports.generateSsoUrl=e.m,exports.getBackendUrl=e.u,exports.getCache=e.c,exports.getClientId=e.y,exports.getCurrencyAmountKey=t.u,exports.getSupportedCurrency=t.p,exports.getSupportedLocale=t.f,exports.isChromiumAndroid=t.h,exports.isFrakDeepLink=t.g,exports.isIOS=t.i,exports.isInAppBrowser=t.a,exports.isV1Context=e.i,exports.isV2Context=e.a,exports.locales=t.m,exports.redirectToExternalBrowser=t.o,exports.sdkConfigStore=e.n,exports.setupClient=t.t,exports.ssoPopupFeatures=e.f,exports.ssoPopupName=e.p,exports.toAndroidIntentUrl=t._,exports.trackEvent=e.t,exports.triggerDeepLinkWithFallback=t.v,exports.withCache=e.l;
|
package/dist/index.d.cts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { A as
|
|
2
|
-
import { A as
|
|
3
|
-
export {
|
|
1
|
+
import { $ as ResolvedPlacement, A as ModalRpcMetadata, B as LoginModalStepType, C as EmbeddedViewActionReferred, D as DisplaySharingPageResultType, E as DisplaySharingPageParamsType, F as SendTransactionReturnType, G as SsoMetadata, H as OpenSsoReturnType, I as SendTransactionTxType, J as ModalStepMetadata, K as FinalActionType, L as SiweAuthenticateModalStepType, M as ModalRpcStepsResultType, N as ModalStepTypes, O as SharingPageProduct, P as SendTransactionModalStepType, Q as MerchantConfigResponse, R as SiweAuthenticateReturnType, S as LoggedOutEmbeddedView, T as LoggedInEmbeddedView, U as PrepareSsoParamsType, V as OpenSsoParamsType, W as PrepareSsoReturnType, X as IFrameLifecycleEvent, Y as InteractionTypeKey, Z as ClientLifecycleEvent, _ as RewardTier, a as FrakContextV1, at as Language, b as DisplayEmbeddedWalletParamsType, c as isV2Context, d as IFrameTransport, et as ResolvedSdkConfig, f as IFrameRpcSchema, g as GetMerchantInformationReturnType, h as EstimatedReward, i as FrakContext, it as I18nConfig, j as ModalRpcStepsInput, k as DisplayModalParamsType, l as FrakClient, m as UserReferralStatusType, n as ssoPopupFeatures, nt as Currency, o as FrakContextV2, ot as LocalizedI18nConfig, p as WalletStatusReturnType, q as FinalModalStepType, r as ssoPopupName, rt as FrakWalletSdkConfig, s as isV1Context, tt as SdkResolvedConfig, u as FrakLifecycleEvent, v as TokenAmountType, w as EmbeddedViewActionSharing, x as DisplayEmbeddedWalletResultType, y as SendInteractionParamsType, z as SiweAuthenticationParams } from "./openSso-DDC7BA9w.cjs";
|
|
2
|
+
import { A as getClientId, B as TrackArrivalParams, C as toAndroidIntentUrl, D as compressJsonToB64, E as decompressJsonFromB64, F as LocalesKey, G as KeyProvider, H as UtmParams, I as locales, L as setupClient, M as getCache, N as withCache, O as base64urlDecode, P as getBackendUrl, R as DebugInfoGatherer, S as isFrakDeepLink, T as DEEP_LINK_SCHEME, U as CompressedData, V as TrackArrivalResult, W as HashProtectedData, _ as getCurrencyAmountKey, a as CompressedSsoData, b as DeepLinkFallbackOptions, c as sdkConfigStore, d as redirectToExternalBrowser, f as baseIframeProps, g as getSupportedCurrency, h as getSupportedLocale, i as AppSpecificSsoMetadata, j as clearAllCache, k as base64urlEncode, l as isIOS, m as findIframeInOpener, n as FrakEvent, o as FullSsoParams, p as createIframe, r as trackEvent, s as generateSsoUrl, t as computeLegacyProductId, u as isInAppBrowser, v as formatAmount, w as triggerDeepLinkWithFallback, x as isChromiumAndroid, y as FrakContextManager, z as createIFrameFrakClient } from "./index-CZ6q9BCe.cjs";
|
|
3
|
+
export { AppSpecificSsoMetadata, ClientLifecycleEvent, CompressedData, CompressedSsoData, Currency, DEEP_LINK_SCHEME, DebugInfoGatherer, DeepLinkFallbackOptions, DisplayEmbeddedWalletParamsType, DisplayEmbeddedWalletResultType, DisplayModalParamsType, DisplaySharingPageParamsType, DisplaySharingPageResultType, EmbeddedViewActionReferred, EmbeddedViewActionSharing, EstimatedReward, FinalActionType, FinalModalStepType, FrakClient, FrakContext, FrakContextManager, FrakContextV1, FrakContextV2, FrakEvent, FrakLifecycleEvent, FrakWalletSdkConfig, FullSsoParams, GetMerchantInformationReturnType, HashProtectedData, I18nConfig, IFrameLifecycleEvent, IFrameRpcSchema, IFrameTransport, InteractionTypeKey, KeyProvider, Language, LocalesKey, LocalizedI18nConfig, LoggedInEmbeddedView, LoggedOutEmbeddedView, LoginModalStepType, MerchantConfigResponse, ModalRpcMetadata, ModalRpcStepsInput, ModalRpcStepsResultType, ModalStepMetadata, ModalStepTypes, OpenSsoParamsType, OpenSsoReturnType, PrepareSsoParamsType, PrepareSsoReturnType, ResolvedPlacement, ResolvedSdkConfig, RewardTier, SdkResolvedConfig, SendInteractionParamsType, SendTransactionModalStepType, SendTransactionReturnType, SendTransactionTxType, SharingPageProduct, SiweAuthenticateModalStepType, SiweAuthenticateReturnType, SiweAuthenticationParams, SsoMetadata, TokenAmountType, TrackArrivalParams, TrackArrivalResult, UserReferralStatusType, UtmParams, WalletStatusReturnType, base64urlDecode, base64urlEncode, baseIframeProps, clearAllCache, compressJsonToB64, computeLegacyProductId, createIFrameFrakClient, createIframe, decompressJsonFromB64, findIframeInOpener, formatAmount, generateSsoUrl, getBackendUrl, getCache, getClientId, getCurrencyAmountKey, getSupportedCurrency, getSupportedLocale, isChromiumAndroid, isFrakDeepLink, isIOS, isInAppBrowser, isV1Context, isV2Context, locales, redirectToExternalBrowser, sdkConfigStore, setupClient, ssoPopupFeatures, ssoPopupName, toAndroidIntentUrl, trackEvent, triggerDeepLinkWithFallback, withCache };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { A as
|
|
2
|
-
import { A as
|
|
3
|
-
export {
|
|
1
|
+
import { $ as ResolvedPlacement, A as ModalRpcMetadata, B as LoginModalStepType, C as EmbeddedViewActionReferred, D as DisplaySharingPageResultType, E as DisplaySharingPageParamsType, F as SendTransactionReturnType, G as SsoMetadata, H as OpenSsoReturnType, I as SendTransactionTxType, J as ModalStepMetadata, K as FinalActionType, L as SiweAuthenticateModalStepType, M as ModalRpcStepsResultType, N as ModalStepTypes, O as SharingPageProduct, P as SendTransactionModalStepType, Q as MerchantConfigResponse, R as SiweAuthenticateReturnType, S as LoggedOutEmbeddedView, T as LoggedInEmbeddedView, U as PrepareSsoParamsType, V as OpenSsoParamsType, W as PrepareSsoReturnType, X as IFrameLifecycleEvent, Y as InteractionTypeKey, Z as ClientLifecycleEvent, _ as RewardTier, a as FrakContextV1, at as Language, b as DisplayEmbeddedWalletParamsType, c as isV2Context, d as IFrameTransport, et as ResolvedSdkConfig, f as IFrameRpcSchema, g as GetMerchantInformationReturnType, h as EstimatedReward, i as FrakContext, it as I18nConfig, j as ModalRpcStepsInput, k as DisplayModalParamsType, l as FrakClient, m as UserReferralStatusType, n as ssoPopupFeatures, nt as Currency, o as FrakContextV2, ot as LocalizedI18nConfig, p as WalletStatusReturnType, q as FinalModalStepType, r as ssoPopupName, rt as FrakWalletSdkConfig, s as isV1Context, tt as SdkResolvedConfig, u as FrakLifecycleEvent, v as TokenAmountType, w as EmbeddedViewActionSharing, x as DisplayEmbeddedWalletResultType, y as SendInteractionParamsType, z as SiweAuthenticationParams } from "./openSso-C6AZ6DHE.js";
|
|
2
|
+
import { A as getClientId, B as TrackArrivalParams, C as toAndroidIntentUrl, D as compressJsonToB64, E as decompressJsonFromB64, F as LocalesKey, G as KeyProvider, H as UtmParams, I as locales, L as setupClient, M as getCache, N as withCache, O as base64urlDecode, P as getBackendUrl, R as DebugInfoGatherer, S as isFrakDeepLink, T as DEEP_LINK_SCHEME, U as CompressedData, V as TrackArrivalResult, W as HashProtectedData, _ as getCurrencyAmountKey, a as CompressedSsoData, b as DeepLinkFallbackOptions, c as sdkConfigStore, d as redirectToExternalBrowser, f as baseIframeProps, g as getSupportedCurrency, h as getSupportedLocale, i as AppSpecificSsoMetadata, j as clearAllCache, k as base64urlEncode, l as isIOS, m as findIframeInOpener, n as FrakEvent, o as FullSsoParams, p as createIframe, r as trackEvent, s as generateSsoUrl, t as computeLegacyProductId, u as isInAppBrowser, v as formatAmount, w as triggerDeepLinkWithFallback, x as isChromiumAndroid, y as FrakContextManager, z as createIFrameFrakClient } from "./index-BMGEHGK_.js";
|
|
3
|
+
export { AppSpecificSsoMetadata, ClientLifecycleEvent, CompressedData, CompressedSsoData, Currency, DEEP_LINK_SCHEME, DebugInfoGatherer, DeepLinkFallbackOptions, DisplayEmbeddedWalletParamsType, DisplayEmbeddedWalletResultType, DisplayModalParamsType, DisplaySharingPageParamsType, DisplaySharingPageResultType, EmbeddedViewActionReferred, EmbeddedViewActionSharing, EstimatedReward, FinalActionType, FinalModalStepType, FrakClient, FrakContext, FrakContextManager, FrakContextV1, FrakContextV2, FrakEvent, FrakLifecycleEvent, FrakWalletSdkConfig, FullSsoParams, GetMerchantInformationReturnType, HashProtectedData, I18nConfig, IFrameLifecycleEvent, IFrameRpcSchema, IFrameTransport, InteractionTypeKey, KeyProvider, Language, LocalesKey, LocalizedI18nConfig, LoggedInEmbeddedView, LoggedOutEmbeddedView, LoginModalStepType, MerchantConfigResponse, ModalRpcMetadata, ModalRpcStepsInput, ModalRpcStepsResultType, ModalStepMetadata, ModalStepTypes, OpenSsoParamsType, OpenSsoReturnType, PrepareSsoParamsType, PrepareSsoReturnType, ResolvedPlacement, ResolvedSdkConfig, RewardTier, SdkResolvedConfig, SendInteractionParamsType, SendTransactionModalStepType, SendTransactionReturnType, SendTransactionTxType, SharingPageProduct, SiweAuthenticateModalStepType, SiweAuthenticateReturnType, SiweAuthenticationParams, SsoMetadata, TokenAmountType, TrackArrivalParams, TrackArrivalResult, UserReferralStatusType, UtmParams, WalletStatusReturnType, base64urlDecode, base64urlEncode, baseIframeProps, clearAllCache, compressJsonToB64, computeLegacyProductId, createIFrameFrakClient, createIframe, decompressJsonFromB64, findIframeInOpener, formatAmount, generateSsoUrl, getBackendUrl, getCache, getClientId, getCurrencyAmountKey, getSupportedCurrency, getSupportedLocale, isChromiumAndroid, isFrakDeepLink, isIOS, isInAppBrowser, isV1Context, isV2Context, locales, redirectToExternalBrowser, sdkConfigStore, setupClient, ssoPopupFeatures, ssoPopupName, toAndroidIntentUrl, trackEvent, triggerDeepLinkWithFallback, withCache };
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{_ as e,a as t,c as n,
|
|
1
|
+
import{_ as e,a as t,c as n,f as r,g as i,h as a,i as o,l as s,m as c,n as l,o as u,p as d,r as f,s as p,t as m,u as h,v as g,y as _}from"./trackEvent-Ce1XlsIE.js";import{_ as v,a as y,c as b,d as x,f as S,g as C,h as w,i as T,l as E,m as D,n as O,o as k,p as A,r as j,s as M,t as N,u as P,v as F,y as I}from"./src-CeGtGFnJ.js";export{I as DEEP_LINK_SCHEME,j as DebugInfoGatherer,f as FrakContextManager,i as base64urlDecode,e as base64urlEncode,M as baseIframeProps,p as clearAllCache,a as compressJsonToB64,g as computeLegacyProductId,O as createIFrameFrakClient,b as createIframe,u as decompressJsonFromB64,E as findIframeInOpener,x as formatAmount,c as generateSsoUrl,h as getBackendUrl,n as getCache,_ as getClientId,P as getCurrencyAmountKey,A as getSupportedCurrency,S as getSupportedLocale,w as isChromiumAndroid,C as isFrakDeepLink,T as isIOS,y as isInAppBrowser,o as isV1Context,t as isV2Context,D as locales,k as redirectToExternalBrowser,l as sdkConfigStore,N as setupClient,r as ssoPopupFeatures,d as ssoPopupName,v as toAndroidIntentUrl,m as trackEvent,F as triggerDeepLinkWithFallback,s as withCache};
|