@frak-labs/core-sdk 0.0.19 → 0.1.0-beta.8d103039

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.
Files changed (85) hide show
  1. package/cdn/bundle.js +5 -5
  2. package/dist/actions.cjs +1 -1
  3. package/dist/actions.d.cts +154 -73
  4. package/dist/actions.d.ts +154 -73
  5. package/dist/actions.js +1 -1
  6. package/dist/bundle.cjs +2 -2
  7. package/dist/bundle.d.cts +257 -192
  8. package/dist/bundle.d.ts +257 -192
  9. package/dist/bundle.js +2 -2
  10. package/dist/index.cjs +11 -11
  11. package/dist/index.d.cts +199 -185
  12. package/dist/index.d.ts +199 -185
  13. package/dist/index.js +2 -2
  14. package/package.json +7 -2
  15. package/src/actions/displayEmbeddedWallet.ts +20 -0
  16. package/src/actions/displayModal.ts +131 -0
  17. package/src/actions/getProductInformation.ts +14 -0
  18. package/src/actions/index.ts +29 -0
  19. package/src/actions/openSso.ts +116 -0
  20. package/src/actions/prepareSso.ts +48 -0
  21. package/src/actions/referral/processReferral.ts +230 -0
  22. package/src/actions/referral/referralInteraction.ts +57 -0
  23. package/src/actions/sendInteraction.ts +32 -0
  24. package/src/actions/trackPurchaseStatus.ts +53 -0
  25. package/src/actions/watchWalletStatus.ts +94 -0
  26. package/src/actions/wrapper/modalBuilder.ts +212 -0
  27. package/src/actions/wrapper/sendTransaction.ts +62 -0
  28. package/src/actions/wrapper/siweAuthenticate.ts +94 -0
  29. package/src/bundle.ts +3 -0
  30. package/src/clients/DebugInfo.ts +182 -0
  31. package/src/clients/createIFrameFrakClient.ts +287 -0
  32. package/src/clients/index.ts +3 -0
  33. package/src/clients/setupClient.ts +71 -0
  34. package/src/clients/transports/iframeLifecycleManager.ts +88 -0
  35. package/src/constants/interactionTypes.ts +44 -0
  36. package/src/constants/locales.ts +14 -0
  37. package/src/constants/productTypes.ts +33 -0
  38. package/src/index.ts +103 -0
  39. package/src/interactions/index.ts +5 -0
  40. package/src/interactions/pressEncoder.ts +53 -0
  41. package/src/interactions/purchaseEncoder.ts +94 -0
  42. package/src/interactions/referralEncoder.ts +47 -0
  43. package/src/interactions/retailEncoder.ts +37 -0
  44. package/src/interactions/webshopEncoder.ts +30 -0
  45. package/src/types/client.ts +14 -0
  46. package/src/types/compression.ts +22 -0
  47. package/src/types/config.ts +111 -0
  48. package/src/types/context.ts +13 -0
  49. package/src/types/index.ts +70 -0
  50. package/src/types/lifecycle/client.ts +46 -0
  51. package/src/types/lifecycle/iframe.ts +35 -0
  52. package/src/types/lifecycle/index.ts +2 -0
  53. package/src/types/rpc/displayModal.ts +84 -0
  54. package/src/types/rpc/embedded/index.ts +68 -0
  55. package/src/types/rpc/embedded/loggedIn.ts +55 -0
  56. package/src/types/rpc/embedded/loggedOut.ts +28 -0
  57. package/src/types/rpc/interaction.ts +43 -0
  58. package/src/types/rpc/modal/final.ts +46 -0
  59. package/src/types/rpc/modal/generic.ts +46 -0
  60. package/src/types/rpc/modal/index.ts +20 -0
  61. package/src/types/rpc/modal/login.ts +32 -0
  62. package/src/types/rpc/modal/openSession.ts +25 -0
  63. package/src/types/rpc/modal/siweAuthenticate.ts +37 -0
  64. package/src/types/rpc/modal/transaction.ts +33 -0
  65. package/src/types/rpc/productInformation.ts +59 -0
  66. package/src/types/rpc/sso.ts +80 -0
  67. package/src/types/rpc/walletStatus.ts +35 -0
  68. package/src/types/rpc.ts +158 -0
  69. package/src/types/transport.ts +34 -0
  70. package/src/utils/FrakContext.ts +152 -0
  71. package/src/utils/compression/b64.ts +29 -0
  72. package/src/utils/compression/compress.ts +11 -0
  73. package/src/utils/compression/decompress.ts +11 -0
  74. package/src/utils/compression/index.ts +3 -0
  75. package/src/utils/computeProductId.ts +11 -0
  76. package/src/utils/constants.ts +4 -0
  77. package/src/utils/formatAmount.ts +18 -0
  78. package/src/utils/getCurrencyAmountKey.ts +15 -0
  79. package/src/utils/getSupportedCurrency.ts +14 -0
  80. package/src/utils/getSupportedLocale.ts +16 -0
  81. package/src/utils/iframeHelper.ts +142 -0
  82. package/src/utils/index.ts +21 -0
  83. package/src/utils/sso.ts +119 -0
  84. package/src/utils/ssoUrlListener.ts +60 -0
  85. package/src/utils/trackEvent.ts +26 -0
package/dist/actions.cjs CHANGED
@@ -1 +1 @@
1
- "use strict";let __rslib_import_meta_url__="undefined"==typeof document?new(require("url".replace("",""))).URL("file:"+__filename).href:document.currentScript&&document.currentScript.src||new URL("main.js",document.baseURI).href;var __webpack_require__={};__webpack_require__.d=(e,r)=>{for(var t in r)__webpack_require__.o(r,t)&&!__webpack_require__.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:r[t]})},__webpack_require__.o=(e,r)=>Object.prototype.hasOwnProperty.call(e,r),__webpack_require__.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var __webpack_exports__={};__webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{getProductInformation:()=>getProductInformation,displayModal:()=>displayModal,displayEmbeddedWallet:()=>displayEmbeddedWallet,processReferral:()=>processReferral,sendInteraction:()=>sendInteraction,watchWalletStatus:()=>watchWalletStatus,sendTransaction:()=>sendTransaction,modalBuilder:()=>modalBuilder,trackPurchaseStatus:()=>trackPurchaseStatus,siweAuthenticate:()=>siweAuthenticate,referralInteraction:()=>referralInteraction,openSso:()=>openSso});class Deferred{_promise;_resolve;_reject;constructor(){this._promise=new Promise((e,r)=>{this._resolve=e,this._reject=r})}get promise(){return this._promise}resolve=e=>{this._resolve?.(e)};reject=e=>{this._reject?.(e)}}function watchWalletStatus(e,r){if(!r)return e.request({method:"frak_listenToWalletStatus"}).then(r=>(walletStatusSideEffect(e,r),r));let t=new Deferred,a=!1;return e.listenerRequest({method:"frak_listenToWalletStatus"},n=>{walletStatusSideEffect(e,n),r(n),a||(t.resolve(n),a=!0)}).then(()=>t.promise)}function walletStatusSideEffect(e,r){"undefined"!=typeof window&&(e.openPanel?.setGlobalProperties({wallet:r.wallet??null}),r.interactionToken?window.sessionStorage.setItem("frak-wallet-interaction-token",r.interactionToken):window.sessionStorage.removeItem("frak-wallet-interaction-token"))}let external_viem_namespaceObject=require("viem");function computeProductId({domain:e}){let r=(e??window.location.host).replace("www.","");return(0,external_viem_namespaceObject.keccak256)((0,external_viem_namespaceObject.toHex)(r))}async function sendInteraction(e,{productId:r,interaction:t,validation:a}){let n=r??computeProductId(e.config);return await e.request({method:"frak_sendInteraction",params:[n,t,a]})}async function displayModal(e,{steps:r,metadata:t}){return await e.request({method:"frak_displayModal",params:[r,t,e.config.metadata]})}async function displayEmbeddedWallet(e,r){return await e.request({method:"frak_displayEmbeddedWallet",params:[r,e.config.metadata]})}async function openSso(e,r){let{metadata:t,customizations:a}=e.config;await e.request({method:"frak_sso",params:[r,t.name,a?.css]})}async function getProductInformation(e){return await e.request({method:"frak_getProductInformation"})}async function trackPurchaseStatus(e){if("undefined"==typeof window)return void console.warn("[Frak] No window found, can't track purchase");let r=window.sessionStorage.getItem("frak-wallet-interaction-token");if(!r)return void console.warn("[Frak] No frak session found, skipping purchase check");await fetch("https://backend.frak.id/interactions/listenForPurchase",{method:"POST",headers:{Accept:"application/json","Content-Type":"application/json","x-wallet-sdk-auth":r},body:JSON.stringify(e)})}let siwe_namespaceObject=require("viem/siwe");async function siweAuthenticate(e,{siwe:r,metadata:t}){let a=e.config?.domain??window.location.host,n=r?.statement??`I confirm that I want to use my Frak wallet on: ${e.config.metadata.name}`,o={...r,statement:n,nonce:r?.nonce??(0,siwe_namespaceObject.generateSiweNonce)(),uri:r?.uri??`https://${a}`,version:r?.version??"1",domain:a};return(await displayModal(e,{metadata:t,steps:{login:{},siweAuthenticate:{siwe:o}}})).siweAuthenticate}async function sendTransaction(e,{tx:r,metadata:t}){return(await displayModal(e,{metadata:t,steps:{login:{},sendTransaction:{tx:r}}})).sendTransaction}function modalBuilder(e,{metadata:r,login:t,openSession:a}){return modalStepsBuilder(e,{steps:{login:t??{},openSession:a??{}},metadata:r})}function modalStepsBuilder(e,r){async function t(t){return t&&(r.metadata=t(r.metadata??{})),await displayModal(e,r)}return{params:r,sendTx:function(t){return modalStepsBuilder(e,{...r,steps:{...r.steps,sendTransaction:t}})},reward:function(t){return modalStepsBuilder(e,{...r,steps:{...r.steps,final:{...t,action:{key:"reward"}}}})},sharing:function(t,a){return modalStepsBuilder(e,{...r,steps:{...r.steps,final:{...a,action:{key:"sharing",options:t}}}})},display:t}}function base64urlEncode(e){return btoa(Array.from(e,e=>String.fromCharCode(e)).join("")).replace(/\+/g,"-").replace(/\//g,"_").replace(/=+$/,"")}function base64urlDecode(e){let r=e.length%4;return Uint8Array.from(atob(e.replace(/-/g,"+").replace(/_/g,"/").padEnd(e.length+(0===r?0:4-r),"=")),e=>e.charCodeAt(0))}let contextKey="fCtx";function compress(e){if(e?.r)try{let r=(0,external_viem_namespaceObject.hexToBytes)(e.r);return base64urlEncode(r)}catch(r){console.error("Error compressing Frak context",{e:r,context:e})}}function decompress(e){if(e&&0!==e.length)try{let r=base64urlDecode(e);return{r:(0,external_viem_namespaceObject.bytesToHex)(r,{size:20})}}catch(r){console.error("Error decompressing Frak context",{e:r,context:e})}}function parse({url:e}){if(!e)return null;let r=new URL(e).searchParams.get(contextKey);return r?decompress(r):null}function update({url:e,context:r}){if(!e)return null;let t=parse({url:e}),a=t?{...t,...r}:r;if(!a.r)return null;let n=compress(a);if(!n)return null;let o=new URL(e);return o.searchParams.set(contextKey,n),o.toString()}function remove(e){let r=new URL(e);return r.searchParams.delete(contextKey),r.toString()}function replaceUrl({url:e,context:r}){let t;if(!window.location?.href||"undefined"==typeof window)return void console.error("No window found, can't update context");let a=e??window.location.href;(t=null!==r?update({url:a,context:r}):remove(a))&&window.history.replaceState(null,"",t.toString())}let FrakContextManager={compress,decompress,parse,update,remove,replaceUrl},interactionTypes={press:{openArticle:"0xc0a24ffb",readArticle:"0xd5bd0fbe"},dapp:{proofVerifiableStorageUpdate:"0x2ab2aeef",callableVerifiableStorageUpdate:"0xa07da986"},webshop:{open:"0xb311798f"},referral:{referred:"0x010cc3b9",createLink:"0xb2c0f17c"},purchase:{started:"0xd87e90c3",completed:"0x8403aeb4",unsafeCompleted:"0x4d5b14e0"},retail:{customerMeeting:"0x74489004"}},productTypes={dapp:1,press:2,webshop:3,retail:4,referral:30,purchase:31},productTypesMask=Object.entries(productTypes).reduce((e,[r,t])=>(e[r]=BigInt(1)<<BigInt(t),e),{}),ReferralInteractionEncoder={createLink:()=>({handlerTypeDenominator:(0,external_viem_namespaceObject.toHex)(productTypes.referral),interactionData:interactionTypes.referral.createLink}),referred({referrer:e}){let r=(0,external_viem_namespaceObject.concatHex)([interactionTypes.referral.referred,(0,external_viem_namespaceObject.pad)(e,{size:32})]);return{handlerTypeDenominator:(0,external_viem_namespaceObject.toHex)(productTypes.referral),interactionData:r}}};class FrakRpcError extends Error{code;data;constructor(e,r,t){super(r),this.code=e,this.data=t}}class MethodNotFoundError extends FrakRpcError{constructor(e,r){super(RpcErrorCodes.methodNotFound,e,{method:r})}}class InternalError extends FrakRpcError{constructor(e){super(RpcErrorCodes.internalError,e)}}class ClientNotFound extends FrakRpcError{constructor(){super(RpcErrorCodes.clientNotConnected,"Client not found")}}let RpcErrorCodes={parseError:-32700,invalidRequest:-32600,methodNotFound:-32601,invalidParams:-32602,internalError:-32603,serverError:-32e3,clientNotConnected:-32001,configError:-32002,corruptedResponse:-32003,clientAborted:-32004,walletNotConnected:-32005,serverErrorForInteractionDelegation:-32006};function trackEvent(e,r,t={}){if(!e)return void console.debug("[Frak] No client provided, skipping event tracking");try{e.openPanel?.track(r,t)}catch(e){console.debug("[Frak] Failed to track event:",r,e)}}async function processReferral(e,{walletStatus:r,frakContext:t,modalConfig:a,productId:n,options:o}){let s=!1;async function c(){if(!s)return s=!0,ensureWalletConnected(e,{modalConfig:{...a,loggedIn:{action:{key:"referred"}}},walletStatus:r})}async function i(r){let t=ReferralInteractionEncoder.referred({referrer:r});await Promise.allSettled([sendInteraction(e,{productId:n,interaction:t}),trackEvent(e,"user_referred",{properties:{referrer:r}})])}try{let{status:e,currentWallet:a}=await processReferralLogic({initialWalletStatus:r,getFreshWalletStatus:c,pushReferralInteraction:i,frakContext:t});return FrakContextManager.replaceUrl({url:window.location?.href,context:o?.alwaysAppendUrl?{r:a}:null}),e}catch(e){return console.log("Error processing referral",{error:e}),FrakContextManager.replaceUrl({url:window.location?.href,context:o?.alwaysAppendUrl?{r:r?.wallet}:null}),mapErrorToState(e)}}async function processReferralLogic({initialWalletStatus:e,getFreshWalletStatus:r,pushReferralInteraction:t,frakContext:a}){let n=e?.wallet;return a?.r?(n||(n=await r()),n&&(0,external_viem_namespaceObject.isAddressEqual)(a.r,n))?{status:"self-referral",currentWallet:n}:(e?.interactionSession||(n=await r()),await t(a.r),{status:"success",currentWallet:n}):{status:"no-referrer",currentWallet:n}}async function ensureWalletConnected(e,{modalConfig:r,walletStatus:t}){if(!t?.interactionSession){let t=await displayEmbeddedWallet(e,r??{});return t?.wallet??void 0}return t.wallet??void 0}function mapErrorToState(e){if(e instanceof FrakRpcError)switch(e.code){case RpcErrorCodes.walletNotConnected:return"no-wallet";case RpcErrorCodes.serverErrorForInteractionDelegation:return"no-session"}return"error"}async function referralInteraction(e,{productId:r,modalConfig:t,options:a}={}){let n=FrakContextManager.parse({url:window.location.href}),o=await watchWalletStatus(e);try{return await processReferral(e,{walletStatus:o,frakContext:n,modalConfig:t,productId:r,options:a})}catch(e){console.warn("Error processing referral",{error:e})}}for(var __webpack_i__ in exports.displayEmbeddedWallet=__webpack_exports__.displayEmbeddedWallet,exports.displayModal=__webpack_exports__.displayModal,exports.getProductInformation=__webpack_exports__.getProductInformation,exports.modalBuilder=__webpack_exports__.modalBuilder,exports.openSso=__webpack_exports__.openSso,exports.processReferral=__webpack_exports__.processReferral,exports.referralInteraction=__webpack_exports__.referralInteraction,exports.sendInteraction=__webpack_exports__.sendInteraction,exports.sendTransaction=__webpack_exports__.sendTransaction,exports.siweAuthenticate=__webpack_exports__.siweAuthenticate,exports.trackPurchaseStatus=__webpack_exports__.trackPurchaseStatus,exports.watchWalletStatus=__webpack_exports__.watchWalletStatus,__webpack_exports__)-1===["displayEmbeddedWallet","displayModal","getProductInformation","modalBuilder","openSso","processReferral","referralInteraction","sendInteraction","sendTransaction","siweAuthenticate","trackPurchaseStatus","watchWalletStatus"].indexOf(__webpack_i__)&&(exports[__webpack_i__]=__webpack_exports__[__webpack_i__]);Object.defineProperty(exports,"__esModule",{value:!0});
1
+ "use strict";let __rslib_import_meta_url__="undefined"==typeof document?new(require("url".replace("",""))).URL("file:"+__filename).href:document.currentScript&&document.currentScript.src||new URL("main.js",document.baseURI).href;var __webpack_require__={};__webpack_require__.d=(e,t)=>{for(var r in t)__webpack_require__.o(t,r)&&!__webpack_require__.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},__webpack_require__.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),__webpack_require__.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var __webpack_exports__={};__webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{getProductInformation:()=>getProductInformation,displayModal:()=>displayModal,displayEmbeddedWallet:()=>displayEmbeddedWallet,processReferral:()=>processReferral,sendInteraction:()=>sendInteraction,watchWalletStatus:()=>watchWalletStatus,sendTransaction:()=>sendTransaction,modalBuilder:()=>modalBuilder,trackPurchaseStatus:()=>trackPurchaseStatus,siweAuthenticate:()=>siweAuthenticate,referralInteraction:()=>referralInteraction,prepareSso:()=>prepareSso,openSso:()=>openSso});let frame_connector_namespaceObject=require("@frak-labs/frame-connector");function watchWalletStatus(e,t){if(!t)return e.request({method:"frak_listenToWalletStatus"}).then(t=>(walletStatusSideEffect(e,t),t));let r=new frame_connector_namespaceObject.Deferred,a=!1;return e.listenerRequest({method:"frak_listenToWalletStatus"},n=>{walletStatusSideEffect(e,n),t(n),a||(r.resolve(n),a=!0)}),r.promise}function walletStatusSideEffect(e,t){"undefined"!=typeof window&&(e.openPanel?.setGlobalProperties({wallet:t.wallet??null}),t.interactionToken?window.sessionStorage.setItem("frak-wallet-interaction-token",t.interactionToken):window.sessionStorage.removeItem("frak-wallet-interaction-token"))}let external_viem_namespaceObject=require("viem");function computeProductId({domain:e}={}){let t=(e??window.location.host).replace("www.","");return(0,external_viem_namespaceObject.keccak256)((0,external_viem_namespaceObject.toHex)(t))}async function sendInteraction(e,{productId:t,interaction:r,validation:a}){let n=t??computeProductId(e.config);return await e.request({method:"frak_sendInteraction",params:[n,r,a]})}async function displayModal(e,{steps:t,metadata:r}){return await e.request({method:"frak_displayModal",params:[t,r,e.config.metadata]})}async function displayEmbeddedWallet(e,t){return await e.request({method:"frak_displayEmbeddedWallet",params:[t,e.config.metadata]})}function base64urlEncode(e){return btoa(Array.from(e,e=>String.fromCharCode(e)).join("")).replace(/\+/g,"-").replace(/\//g,"_").replace(/=+$/,"")}function base64urlDecode(e){let t=e.length%4;return Uint8Array.from(atob(e.replace(/-/g,"+").replace(/_/g,"/").padEnd(e.length+(0===t?0:4-t),"=")),e=>e.charCodeAt(0))}function compressJsonToB64(e){return base64urlEncode((0,frame_connector_namespaceObject.compressJson)(e))}function generateSsoUrl(e,t,r,a,n){let o=compressJsonToB64(ssoParamsToCompressed({redirectUrl:t.redirectUrl,directExit:t.directExit,lang:t.lang,productId:r,metadata:{name:a,css:n,logoUrl:t.metadata?.logoUrl,homepageLink:t.metadata?.homepageLink}})),s=new URL(e);return s.pathname="/sso",s.searchParams.set("p",o),s.toString()}function ssoParamsToCompressed(e){return{r:e.redirectUrl,d:e.directExit,l:e.lang,p:e.productId,m:{n:e.metadata?.name,css:e.metadata?.css,l:e.metadata?.logoUrl,h:e.metadata?.homepageLink}}}let ssoPopupFeatures="menubar=no,status=no,scrollbars=no,fullscreen=no,width=500, height=800",ssoPopupName="frak-sso";async function openSso(e,t){let{metadata:r,customizations:a,walletUrl:n}=e.config;if(t.openInSameWindow??!!t.redirectUrl)return await e.request({method:"frak_openSso",params:[t,r.name,a?.css]});let o=t.ssoPopupUrl??generateSsoUrl(n??"https://wallet.frak.id",t,computeProductId(),r.name,a?.css),s=window.open(o,"frak-sso","menubar=no,status=no,scrollbars=no,fullscreen=no,width=500, height=800");if(!s)throw Error("Popup was blocked. Please allow popups for this site.");return s.focus(),await e.request({method:"frak_openSso",params:[t,r.name,a?.css]})??{}}async function prepareSso(e,t){let{metadata:r,customizations:a}=e.config;return await e.request({method:"frak_prepareSso",params:[t,r.name,a?.css]})}async function getProductInformation(e){return await e.request({method:"frak_getProductInformation"})}async function trackPurchaseStatus(e){if("undefined"==typeof window)return void console.warn("[Frak] No window found, can't track purchase");let t=window.sessionStorage.getItem("frak-wallet-interaction-token");if(!t)return void console.warn("[Frak] No frak session found, skipping purchase check");await fetch("https://backend.frak.id/interactions/listenForPurchase",{method:"POST",headers:{Accept:"application/json","Content-Type":"application/json","x-wallet-sdk-auth":t},body:JSON.stringify(e)})}let siwe_namespaceObject=require("viem/siwe");async function siweAuthenticate(e,{siwe:t,metadata:r}){let a=e.config?.domain??window.location.host,n=t?.statement??`I confirm that I want to use my Frak wallet on: ${e.config.metadata.name}`,o={...t,statement:n,nonce:t?.nonce??(0,siwe_namespaceObject.generateSiweNonce)(),uri:t?.uri??`https://${a}`,version:t?.version??"1",domain:a};return(await displayModal(e,{metadata:r,steps:{login:{},siweAuthenticate:{siwe:o}}})).siweAuthenticate}async function sendTransaction(e,{tx:t,metadata:r}){return(await displayModal(e,{metadata:r,steps:{login:{},sendTransaction:{tx:t}}})).sendTransaction}function modalBuilder(e,{metadata:t,login:r,openSession:a}){return modalStepsBuilder(e,{steps:{login:r??{},openSession:a??{}},metadata:t})}function modalStepsBuilder(e,t){async function r(r){return r&&(t.metadata=r(t.metadata??{})),await displayModal(e,t)}return{params:t,sendTx:function(r){return modalStepsBuilder(e,{...t,steps:{...t.steps,sendTransaction:r}})},reward:function(r){return modalStepsBuilder(e,{...t,steps:{...t.steps,final:{...r,action:{key:"reward"}}}})},sharing:function(r,a){return modalStepsBuilder(e,{...t,steps:{...t.steps,final:{...a,action:{key:"sharing",options:r}}}})},display:r}}let contextKey="fCtx";function compress(e){if(e?.r)try{let t=(0,external_viem_namespaceObject.hexToBytes)(e.r);return base64urlEncode(t)}catch(t){console.error("Error compressing Frak context",{e:t,context:e})}}function decompress(e){if(e&&0!==e.length)try{let t=base64urlDecode(e);return{r:(0,external_viem_namespaceObject.bytesToHex)(t,{size:20})}}catch(t){console.error("Error decompressing Frak context",{e:t,context:e})}}function parse({url:e}){if(!e)return null;let t=new URL(e).searchParams.get(contextKey);return t?decompress(t):null}function update({url:e,context:t}){if(!e)return null;let r=parse({url:e}),a=r?{...r,...t}:t;if(!a.r)return null;let n=compress(a);if(!n)return null;let o=new URL(e);return o.searchParams.set(contextKey,n),o.toString()}function remove(e){let t=new URL(e);return t.searchParams.delete(contextKey),t.toString()}function replaceUrl({url:e,context:t}){let r;if(!window.location?.href||"undefined"==typeof window)return void console.error("No window found, can't update context");let a=e??window.location.href;(r=null!==t?update({url:a,context:t}):remove(a))&&window.history.replaceState(null,"",r.toString())}let FrakContextManager={compress,decompress,parse,update,remove,replaceUrl},interactionTypes={press:{openArticle:"0xc0a24ffb",readArticle:"0xd5bd0fbe"},dapp:{proofVerifiableStorageUpdate:"0x2ab2aeef",callableVerifiableStorageUpdate:"0xa07da986"},webshop:{open:"0xb311798f"},referral:{referred:"0x010cc3b9",createLink:"0xb2c0f17c"},purchase:{started:"0xd87e90c3",completed:"0x8403aeb4",unsafeCompleted:"0x4d5b14e0"},retail:{customerMeeting:"0x74489004"}},productTypes={dapp:1,press:2,webshop:3,retail:4,referral:30,purchase:31},productTypesMask=Object.entries(productTypes).reduce((e,[t,r])=>(e[t]=BigInt(1)<<BigInt(r),e),{}),ReferralInteractionEncoder={createLink:()=>({handlerTypeDenominator:(0,external_viem_namespaceObject.toHex)(productTypes.referral),interactionData:interactionTypes.referral.createLink}),referred({referrer:e}){let t=(0,external_viem_namespaceObject.concatHex)([interactionTypes.referral.referred,(0,external_viem_namespaceObject.pad)(e,{size:32})]);return{handlerTypeDenominator:(0,external_viem_namespaceObject.toHex)(productTypes.referral),interactionData:t}}};function trackEvent(e,t,r={}){if(!e)return void console.debug("[Frak] No client provided, skipping event tracking");try{e.openPanel?.track(t,r)}catch(e){console.debug("[Frak] Failed to track event:",t,e)}}async function processReferral(e,{walletStatus:t,frakContext:r,modalConfig:a,productId:n,options:o}){let s=!1;async function c(){if(!s)return s=!0,ensureWalletConnected(e,{modalConfig:{...a,loggedIn:{action:{key:"referred"}}},walletStatus:t})}async function i(t){let r=ReferralInteractionEncoder.referred({referrer:t});await Promise.allSettled([sendInteraction(e,{productId:n,interaction:r}),trackEvent(e,"user_referred",{properties:{referrer:t}})])}try{let{status:e,currentWallet:a}=await processReferralLogic({initialWalletStatus:t,getFreshWalletStatus:c,pushReferralInteraction:i,frakContext:r});return FrakContextManager.replaceUrl({url:window.location?.href,context:o?.alwaysAppendUrl?{r:a}:null}),e}catch(e){return console.log("Error processing referral",{error:e}),FrakContextManager.replaceUrl({url:window.location?.href,context:o?.alwaysAppendUrl?{r:t?.wallet}:null}),mapErrorToState(e)}}async function processReferralLogic({initialWalletStatus:e,getFreshWalletStatus:t,pushReferralInteraction:r,frakContext:a}){let n=e?.wallet;return a?.r?(n||(n=await t()),n&&(0,external_viem_namespaceObject.isAddressEqual)(a.r,n))?{status:"self-referral",currentWallet:n}:(e?.interactionSession||(n=await t()),await r(a.r),{status:"success",currentWallet:n}):{status:"no-referrer",currentWallet:n}}async function ensureWalletConnected(e,{modalConfig:t,walletStatus:r}){if(!r?.interactionSession){let r=await displayEmbeddedWallet(e,t??{});return r?.wallet??void 0}return r.wallet??void 0}function mapErrorToState(e){if(e instanceof frame_connector_namespaceObject.FrakRpcError)switch(e.code){case frame_connector_namespaceObject.RpcErrorCodes.walletNotConnected:return"no-wallet";case frame_connector_namespaceObject.RpcErrorCodes.serverErrorForInteractionDelegation:return"no-session"}return"error"}async function referralInteraction(e,{productId:t,modalConfig:r,options:a}={}){let n=FrakContextManager.parse({url:window.location.href}),o=await watchWalletStatus(e);try{return await processReferral(e,{walletStatus:o,frakContext:n,modalConfig:r,productId:t,options:a})}catch(e){console.warn("Error processing referral",{error:e})}}for(var __webpack_i__ in exports.displayEmbeddedWallet=__webpack_exports__.displayEmbeddedWallet,exports.displayModal=__webpack_exports__.displayModal,exports.getProductInformation=__webpack_exports__.getProductInformation,exports.modalBuilder=__webpack_exports__.modalBuilder,exports.openSso=__webpack_exports__.openSso,exports.prepareSso=__webpack_exports__.prepareSso,exports.processReferral=__webpack_exports__.processReferral,exports.referralInteraction=__webpack_exports__.referralInteraction,exports.sendInteraction=__webpack_exports__.sendInteraction,exports.sendTransaction=__webpack_exports__.sendTransaction,exports.siweAuthenticate=__webpack_exports__.siweAuthenticate,exports.trackPurchaseStatus=__webpack_exports__.trackPurchaseStatus,exports.watchWalletStatus=__webpack_exports__.watchWalletStatus,__webpack_exports__)-1===["displayEmbeddedWallet","displayModal","getProductInformation","modalBuilder","openSso","prepareSso","processReferral","referralInteraction","sendInteraction","sendTransaction","siweAuthenticate","trackPurchaseStatus","watchWalletStatus"].indexOf(__webpack_i__)&&(exports[__webpack_i__]=__webpack_exports__[__webpack_i__]);Object.defineProperty(exports,"__esModule",{value:!0});
@@ -1,8 +1,8 @@
1
1
  import type { Address } from 'viem';
2
2
  import { Hex } from 'viem';
3
+ import type { LifecycleMessage } from '@frak-labs/frame-connector';
3
4
  import type { OpenPanel } from '@openpanel/web';
4
- import type { Prettify } from 'viem/chains';
5
- import type { RpcSchema } from 'viem';
5
+ import type { RpcClient } from '@frak-labs/frame-connector';
6
6
  import type { SiweMessage } from 'viem/siwe';
7
7
 
8
8
  /**
@@ -237,34 +237,6 @@ declare type EmbeddedViewActionSharing = {
237
237
  };
238
238
  };
239
239
 
240
- /**
241
- * Type that extract the possible return type from a RPC Schema
242
- * @ignore
243
- */
244
- declare type ExtractedMethodFromRpc<TRpcSchema extends RpcSchema, TMethod extends ExtractedParametersFromRpc<TRpcSchema>["method"] = ExtractedParametersFromRpc<TRpcSchema>["method"]> = Extract<TRpcSchema[number], {
245
- Method: TMethod;
246
- }>;
247
-
248
- /**
249
- * Type that extract the possible parameters from a RPC Schema
250
- * @ignore
251
- */
252
- declare type ExtractedParametersFromRpc<TRpcSchema extends RpcSchema> = {
253
- [K in keyof TRpcSchema]: Prettify<{
254
- method: TRpcSchema[K] extends TRpcSchema[number] ? TRpcSchema[K]["Method"] : string;
255
- } & (TRpcSchema[K] extends TRpcSchema[number] ? TRpcSchema[K]["Parameters"] extends undefined ? {
256
- params?: never;
257
- } : {
258
- params: TRpcSchema[K]["Parameters"];
259
- } : never)>;
260
- }[number];
261
-
262
- /**
263
- * Type that extract the possible return type from a RPC Schema
264
- * @ignore
265
- */
266
- declare type ExtractedReturnTypeFromRpc<TRpcSchema extends RpcSchema, TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>> = ExtractedMethodFromRpc<TRpcSchema, TParameters["method"]>["ReturnType"];
267
-
268
240
  /**
269
241
  * The different types of final actions we can display in the final step
270
242
  * @group Modal Display
@@ -490,40 +462,51 @@ declare type I18nConfig = Record<Language, LocalizedI18nConfig> | LocalizedI18nC
490
462
  /**
491
463
  * RPC interface that's used for the iframe communication
492
464
  *
493
- * Define all the methods available within the iFrame RPC client
465
+ * Define all the methods available within the iFrame RPC client with response type annotations
494
466
  *
495
467
  * @group RPC Schema
496
468
  *
497
469
  * @remarks
498
- * Here is the list of methods available:
470
+ * Each method in the schema now includes a ResponseType field that indicates:
471
+ * - "promise": One-shot request that resolves once
472
+ * - "stream": Streaming request that can emit multiple values
473
+ *
474
+ * ### Methods:
499
475
  *
500
- * ### frak_listenToWalletStatus
476
+ * #### frak_listenToWalletStatus
501
477
  * - Params: None
502
478
  * - Returns: {@link WalletStatusReturnType}
479
+ * - Response Type: stream (emits updates when wallet status changes)
503
480
  *
504
- * ### frak_displayModal
505
- * - Params: [{@link ModalRpcStepsInput}, name: string, metadata?: {@link ModalRpcMetadata}]
481
+ * #### frak_displayModal
482
+ * - Params: [requests: {@link ModalRpcStepsInput}, metadata?: {@link ModalRpcMetadata}, configMetadata: {@link FrakWalletSdkConfig}["metadata"]]
506
483
  * - Returns: {@link ModalRpcStepsResultType}
484
+ * - Response Type: promise (one-shot)
507
485
  *
508
- * ### frak_sendInteraction
486
+ * #### frak_sendInteraction
509
487
  * - Params: [productId: Hex, interaction: {@link PreparedInteraction}, signature?: Hex]
510
488
  * - Returns: {@link SendInteractionReturnType}
489
+ * - Response Type: promise (one-shot)
511
490
  *
512
- * ### frak_sso
513
- * - Params [params: {@link OpenSsoParamsType}, name: string, customCss?: string]
514
- * - Returns: undefined
491
+ * #### frak_sso
492
+ * - Params: [params: {@link OpenSsoParamsType}, name: string, customCss?: string]
493
+ * - Returns: {@link OpenSsoReturnType}
494
+ * - Response Type: promise (one-shot)
515
495
  *
516
- * ### frak_getProductInformation
496
+ * #### frak_getProductInformation
517
497
  * - Params: None
518
498
  * - Returns: {@link GetProductInformationReturnType}
499
+ * - Response Type: promise (one-shot)
519
500
  *
520
- * ### frak_displayEmbeddedWallet
521
- * - Params: [{@link DisplayEmbeddedWalletParamsType}]
501
+ * #### frak_displayEmbeddedWallet
502
+ * - Params: [request: {@link DisplayEmbeddedWalletParamsType}, metadata: {@link FrakWalletSdkConfig}["metadata"]]
522
503
  * - Returns: {@link DisplayEmbeddedWalletResultType}
504
+ * - Response Type: promise (one-shot)
523
505
  */
524
506
  declare type IFrameRpcSchema = [
525
507
  /**
526
508
  * Method used to listen to the wallet status
509
+ * This is a streaming method that emits updates when wallet status changes
527
510
  */
528
511
  {
529
512
  Method: "frak_listenToWalletStatus";
@@ -532,6 +515,7 @@ declare type IFrameRpcSchema = [
532
515
  },
533
516
  /**
534
517
  * Method to display a modal with the provided steps
518
+ * This is a one-shot request
535
519
  */
536
520
  {
537
521
  Method: "frak_displayModal";
@@ -544,6 +528,7 @@ declare type IFrameRpcSchema = [
544
528
  },
545
529
  /**
546
530
  * Method to transmit a user interaction
531
+ * This is a one-shot request
547
532
  */
548
533
  {
549
534
  Method: "frak_sendInteraction";
@@ -555,23 +540,40 @@ declare type IFrameRpcSchema = [
555
540
  ReturnType: SendInteractionReturnType;
556
541
  },
557
542
  /**
558
- * Method to start a SSO
559
- * todo: Should also support direct tracking via a consumeKey
543
+ * Method to prepare SSO (generate URL for popup)
544
+ * Returns the SSO URL that should be opened in a popup
545
+ * Only used for popup flows (not redirect flows)
560
546
  */
561
547
  {
562
- Method: "frak_sso";
548
+ Method: "frak_prepareSso";
549
+ Parameters: [
550
+ params: PrepareSsoParamsType,
551
+ name: string,
552
+ customCss?: string
553
+ ];
554
+ ReturnType: PrepareSsoReturnType;
555
+ },
556
+ /**
557
+ * Method to open/trigger SSO
558
+ * Either triggers redirect (if openInSameWindow/redirectUrl)
559
+ * Or waits for popup completion (if popup mode)
560
+ * This method handles BOTH redirect and popup flows
561
+ */
562
+ {
563
+ Method: "frak_openSso";
563
564
  Parameters: [
564
565
  params: OpenSsoParamsType,
565
566
  name: string,
566
567
  customCss?: string
567
568
  ];
568
- ReturnType: undefined;
569
+ ReturnType: OpenSsoReturnType;
569
570
  },
570
571
  /**
571
572
  * Method to get current product information's
572
573
  * - Is product minted?
573
574
  * - Does it have running campaign?
574
575
  * - Estimated reward on actions
576
+ * This is a one-shot request
575
577
  */
576
578
  {
577
579
  Method: "frak_getProductInformation";
@@ -580,6 +582,7 @@ declare type IFrameRpcSchema = [
580
582
  },
581
583
  /**
582
584
  * Method to show the embedded wallet, with potential customization
585
+ * This is a one-shot request
583
586
  */
584
587
  {
585
588
  Method: "frak_displayEmbeddedWallet";
@@ -606,11 +609,11 @@ declare type IFrameTransport = {
606
609
  /**
607
610
  * Function used to perform a single request via the iframe transport
608
611
  */
609
- request: RequestFn<IFrameRpcSchema>;
612
+ request: RpcClient<IFrameRpcSchema, LifecycleMessage>["request"];
610
613
  /**
611
614
  * Function used to listen to a request response via the iframe transport
612
615
  */
613
- listenerRequest: ListenerRequestFn<IFrameRpcSchema>;
616
+ listenerRequest: RpcClient<IFrameRpcSchema, LifecycleMessage>["listen"];
614
617
  /**
615
618
  * Function used to destroy the iframe transport
616
619
  */
@@ -652,12 +655,6 @@ declare const interactionTypes: {
652
655
  */
653
656
  declare type Language = "fr" | "en";
654
657
 
655
- /**
656
- * Type used for a listening request
657
- * @inline
658
- */
659
- declare type ListenerRequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>, _ReturnType = ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>>(args: TParameters, callback: (result: _ReturnType) => void) => Promise<void>;
660
-
661
658
  /**
662
659
  * A localized i18n config
663
660
  * @category Config
@@ -926,7 +923,16 @@ declare type OpenInteractionSessionReturnType = {
926
923
  * @param client - The current Frak Client
927
924
  * @param args - The SSO parameters
928
925
  *
929
- * @description This function will open the SSO with the provided parameters.
926
+ * @description Two SSO flow modes:
927
+ *
928
+ * **Redirect Mode** (openInSameWindow: true):
929
+ * - Wallet generates URL and triggers redirect
930
+ * - Used when redirectUrl is provided
931
+ *
932
+ * **Popup Mode** (openInSameWindow: false/omitted):
933
+ * - SDK generates URL client-side (or uses provided ssoPopupUrl)
934
+ * - Opens popup synchronously (prevents popup blockers)
935
+ * - Waits for SSO completion via postMessage
930
936
  *
931
937
  * @example
932
938
  * First we build the sso metadata
@@ -940,29 +946,107 @@ declare type OpenInteractionSessionReturnType = {
940
946
  *
941
947
  * Then, either use it with direct exit (and so user is directly redirected to your website), or a custom redirect URL
942
948
  * :::code-group
943
- * ```ts [Direct exit]
944
- * // Trigger an sso opening with redirection
949
+ * ```ts [Popup (default)]
950
+ * // Opens in popup, SDK generates URL automatically
945
951
  * await openSso(frakConfig, {
946
952
  * directExit: true,
947
953
  * metadata,
948
954
  * });
949
955
  * ```
950
- * ```ts [Redirection]
951
- * // Trigger an sso opening within a popup with direct exit
956
+ * ```ts [Redirect]
957
+ * // Opens in same window with redirect
952
958
  * await openSso(frakConfig, {
953
959
  * redirectUrl: "https://my-app.com/frak-sso",
954
960
  * metadata,
961
+ * openInSameWindow: true,
962
+ * });
963
+ * ```
964
+ * ```ts [Custom popup URL]
965
+ * // Advanced: provide custom SSO URL
966
+ * const { ssoUrl } = await prepareSso(frakConfig, { metadata });
967
+ * await openSso(frakConfig, {
968
+ * metadata,
969
+ * ssoPopupUrl: `${ssoUrl}&custom=param`,
955
970
  * });
956
971
  * ```
957
972
  * :::
958
973
  */
959
- export declare function openSso(client: FrakClient, args: OpenSsoParamsType): Promise<void>;
974
+ export declare function openSso(client: FrakClient, args: OpenSsoParamsType): Promise<OpenSsoReturnType>;
960
975
 
961
976
  /**
962
977
  * Params to start a SSO
963
978
  * @group RPC Schema
964
979
  */
965
- declare type OpenSsoParamsType = {
980
+ declare type OpenSsoParamsType = PrepareSsoParamsType & {
981
+ /**
982
+ * Indicate whether we want todo the flow within the same window context, or if we want to do it with an external popup window openned
983
+ * Note: Default true if redirectUrl is present, otherwise, false
984
+ */
985
+ openInSameWindow?: boolean;
986
+ /**
987
+ * Custom SSO popup url if user want additionnal customisation
988
+ */
989
+ ssoPopupUrl?: string;
990
+ };
991
+
992
+ /**
993
+ * Response after an SSO has been openned
994
+ */
995
+ declare type OpenSsoReturnType = {
996
+ /**
997
+ * Optional wallet address, returned when SSO completes via postMessage
998
+ * Note: Only present when SSO flow completes (not immediately on open)
999
+ */
1000
+ wallet?: Hex;
1001
+ };
1002
+
1003
+ /**
1004
+ * Represent a prepared user interaction, ready to be sent on-chain via the wallet
1005
+ */
1006
+ declare type PreparedInteraction = {
1007
+ handlerTypeDenominator: Hex;
1008
+ interactionData: Hex;
1009
+ };
1010
+
1011
+ /**
1012
+ * Generate SSO URL without opening popup
1013
+ *
1014
+ * This is a **synchronous**, client-side function that generates the SSO URL
1015
+ * without any RPC calls to the wallet iframe. Use this when you need:
1016
+ * - Custom URL modifications before opening popup
1017
+ * - Pre-generation for advanced popup strategies
1018
+ * - URL inspection/logging before SSO flow
1019
+ *
1020
+ * @param client - The current Frak Client
1021
+ * @param args - The SSO parameters
1022
+ * @returns Object containing the generated ssoUrl
1023
+ *
1024
+ * @example
1025
+ * ```ts
1026
+ * // Generate URL for inspection
1027
+ * const { ssoUrl } = prepareSso(client, {
1028
+ * metadata: { logoUrl: "..." },
1029
+ * directExit: true
1030
+ * });
1031
+ * console.log("Opening SSO:", ssoUrl);
1032
+ *
1033
+ * // Add custom params
1034
+ * const customUrl = `${ssoUrl}&tracking=abc123`;
1035
+ * await openSso(client, { metadata, ssoPopupUrl: customUrl });
1036
+ * ```
1037
+ *
1038
+ * @remarks
1039
+ * For most use cases, just use `openSso()` which handles URL generation automatically.
1040
+ * Only use `prepareSso()` when you need explicit control over the URL.
1041
+ */
1042
+ export declare function prepareSso(client: FrakClient, args: PrepareSsoParamsType): Promise<PrepareSsoReturnType>;
1043
+
1044
+ /**
1045
+ * Params for preparing SSO (generating URL)
1046
+ * Same as OpenSsoParamsType but without openInSameWindow (popup-only operation)
1047
+ * @group RPC Schema
1048
+ */
1049
+ declare type PrepareSsoParamsType = {
966
1050
  /**
967
1051
  * Redirect URL after the SSO (optional)
968
1052
  */
@@ -980,15 +1064,18 @@ declare type OpenSsoParamsType = {
980
1064
  /**
981
1065
  * Custom SSO metadata
982
1066
  */
983
- metadata: SsoMetadata;
1067
+ metadata?: SsoMetadata;
984
1068
  };
985
1069
 
986
1070
  /**
987
- * Represent a prepared user interaction, ready to be sent on-chain via the wallet
1071
+ * Response after preparing SSO
1072
+ * @group RPC Schema
988
1073
  */
989
- declare type PreparedInteraction = {
990
- handlerTypeDenominator: Hex;
991
- interactionData: Hex;
1074
+ declare type PrepareSsoReturnType = {
1075
+ /**
1076
+ * The SSO URL that should be opened in a popup
1077
+ */
1078
+ ssoUrl: string;
992
1079
  };
993
1080
 
994
1081
  /**
@@ -1083,12 +1170,6 @@ export declare function referralInteraction(client: FrakClient, { productId, mod
1083
1170
  */
1084
1171
  declare type ReferralState = "idle" | "processing" | "success" | "no-wallet" | "no-session" | "error" | "no-referrer" | "self-referral";
1085
1172
 
1086
- /**
1087
- * Type used for a one shot request function
1088
- * @inline
1089
- */
1090
- declare type RequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>, _ReturnType = ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>>(args: TParameters) => Promise<_ReturnType>;
1091
-
1092
1173
  /**
1093
1174
  * Function used to send an interaction
1094
1175
  * @param client - The current Frak Client
@@ -1381,7 +1462,7 @@ declare type WalletStatusReturnType = WalletConnected | WalletNotConnected;
1381
1462
  * Function used to watch the current frak wallet status
1382
1463
  * @param client - The current Frak Client
1383
1464
  * @param callback - The callback that will receive any wallet status change
1384
- * @returns A rpomise resolving with the initial wallet status
1465
+ * @returns A promise resolving with the initial wallet status
1385
1466
  *
1386
1467
  * @description This function will return the current wallet status, and will listen to any change in the wallet status.
1387
1468
  *