@zerohash-sdk/crypto-account-link-js 1.1.0
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 +125 -0
- package/dist/index.d.ts +488 -0
- package/dist/index.js +200 -0
- package/dist/index.umd.cjs +1 -0
- package/package.json +25 -0
package/README.md
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# @zerohash-sdk/crypto-account-link-js
|
|
2
|
+
|
|
3
|
+
A JavaScript SDK that enables frontend applications to seamlessly integrate with the Connect Crypto Account Link product.
|
|
4
|
+
|
|
5
|
+
Connect Crypto Account Link provides a secure, customizable flow for linking external crypto accounts (for deposits or payouts) directly within your application.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
### Via NPM (recommended)
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @zerohash-sdk/crypto-account-link-js
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
```javascript
|
|
16
|
+
import { CryptoAccountLink } from '@zerohash-sdk/crypto-account-link-js';
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Via CDN
|
|
20
|
+
|
|
21
|
+
```html
|
|
22
|
+
<script
|
|
23
|
+
type="module"
|
|
24
|
+
src="https://sdk.connect.xyz/crypto-account-link-web/index.js"
|
|
25
|
+
></script>
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Or import directly in your JavaScript code:
|
|
29
|
+
|
|
30
|
+
```javascript
|
|
31
|
+
import { CryptoAccountLink } from 'https://sdk.connect.xyz/crypto-account-link-web/index.js';
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Getting Started
|
|
35
|
+
|
|
36
|
+
### 1. Import the CryptoAccountLink module
|
|
37
|
+
|
|
38
|
+
```javascript
|
|
39
|
+
import { CryptoAccountLink } from '@zerohash-sdk/crypto-account-link-js';
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### 2. Initialize and render the widget
|
|
43
|
+
|
|
44
|
+
```javascript
|
|
45
|
+
const cryptoAccountLink = new CryptoAccountLink({
|
|
46
|
+
jwt: 'your-jwt-token',
|
|
47
|
+
env: 'prod',
|
|
48
|
+
theme: 'auto',
|
|
49
|
+
isPayouts: false, // true for payouts/withdrawals, false for deposits
|
|
50
|
+
onCompleted: ({ externalAccountId, address, nickname, asset, network }) => {
|
|
51
|
+
console.log('Account linked:', externalAccountId, address);
|
|
52
|
+
},
|
|
53
|
+
onExternalAccountCreated: () => {
|
|
54
|
+
console.log('External account created');
|
|
55
|
+
},
|
|
56
|
+
onError: ({ errorCode, reason }) => {
|
|
57
|
+
console.error('Error:', errorCode, 'Reason:', reason);
|
|
58
|
+
},
|
|
59
|
+
onClose: () => console.log('Widget closed'),
|
|
60
|
+
onEvent: ({ type, data }) => console.log('Event:', type, data),
|
|
61
|
+
onLoaded: () => console.log('Widget loaded and ready'),
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
await cryptoAccountLink.render(document.getElementById('crypto-account-link-container'));
|
|
65
|
+
|
|
66
|
+
cryptoAccountLink.destroy();
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### 2.1 Using TypeScript (optional)
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
import { CryptoAccountLink, CryptoAccountLinkConfig } from '@zerohash-sdk/crypto-account-link-js';
|
|
73
|
+
|
|
74
|
+
const config: CryptoAccountLinkConfig = {
|
|
75
|
+
jwt: 'your-jwt-token',
|
|
76
|
+
env: 'cert',
|
|
77
|
+
isPayouts: false,
|
|
78
|
+
onCompleted: ({ externalAccountId, address }) => {
|
|
79
|
+
console.log(externalAccountId, address);
|
|
80
|
+
},
|
|
81
|
+
};
|
|
82
|
+
|
|
83
|
+
const cryptoAccountLink = new CryptoAccountLink(config);
|
|
84
|
+
await cryptoAccountLink.render(document.getElementById('container')!);
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## API Reference
|
|
88
|
+
|
|
89
|
+
### Configuration
|
|
90
|
+
|
|
91
|
+
| Prop | Type | Required | Default | Description |
|
|
92
|
+
| -------------------------- | ------------------------------------------------------------------------- | -------- | -------- | ----------------------------------------------------------- |
|
|
93
|
+
| `jwt` | `string` | Yes | - | JWT token for authentication with Connect |
|
|
94
|
+
| `env` | `"prod" \| "cert" \| "dev" \| "local"` | No | `"prod"` | Target environment |
|
|
95
|
+
| `theme` | `"auto" \| "light" \| "dark"` | No | `"auto"` | Theme mode for the interface |
|
|
96
|
+
| `isPayouts` | `boolean` | No | `false` | Set to `true` for payouts/withdrawals, `false` for deposits |
|
|
97
|
+
| `onCompleted` | `({ externalAccountId?, address?, nickname?, asset?, network? }) => void` | No | - | Callback when account linking completes successfully |
|
|
98
|
+
| `onExternalAccountCreated` | `() => void` | No | - | Callback when an external account is created |
|
|
99
|
+
| `onError` | `({ errorCode, reason }) => void` | No | - | Callback for error events |
|
|
100
|
+
| `onClose` | `() => void` | No | - | Callback when the widget is closed |
|
|
101
|
+
| `onEvent` | `({ type, data }) => void` | No | - | Callback for general events |
|
|
102
|
+
| `onLoaded` | `() => void` | No | - | Callback when the widget is loaded and ready |
|
|
103
|
+
|
|
104
|
+
### Methods
|
|
105
|
+
|
|
106
|
+
#### `render(container: HTMLElement): Promise<void>`
|
|
107
|
+
|
|
108
|
+
#### `updateConfig(config: Partial<CryptoAccountLinkConfig>): void`
|
|
109
|
+
|
|
110
|
+
#### `destroy(): void`
|
|
111
|
+
|
|
112
|
+
#### `isRendered(): boolean`
|
|
113
|
+
|
|
114
|
+
#### `getConfig(): CryptoAccountLinkConfig`
|
|
115
|
+
|
|
116
|
+
## Browser Support
|
|
117
|
+
|
|
118
|
+
- Chrome/Edge 90+
|
|
119
|
+
- Firefox 88+
|
|
120
|
+
- Safari 14+
|
|
121
|
+
- All modern browsers with Web Components support
|
|
122
|
+
|
|
123
|
+
## More Information & Support
|
|
124
|
+
|
|
125
|
+
For comprehensive documentation or support about Connect, visit our [Documentation Page](https://docs.zerohash.com/).
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,488 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Zerohash Crypto Account Link JavaScript SDK
|
|
3
|
+
*
|
|
4
|
+
* A programmatic JavaScript SDK for integrating the Crypto Account Link widget
|
|
5
|
+
* into web applications without requiring HTML custom elements.
|
|
6
|
+
*
|
|
7
|
+
* @packageDocumentation
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Generic app event structure
|
|
12
|
+
* @template TType - Event type string
|
|
13
|
+
* @template TData - Event data payload
|
|
14
|
+
*/
|
|
15
|
+
declare type AppEvent<TType extends string = string, TData = Record<string, unknown>> = {
|
|
16
|
+
/** The type of event that occurred */
|
|
17
|
+
type: TType;
|
|
18
|
+
/** Data associated with the event */
|
|
19
|
+
data: TData;
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Configuration options for the SDK
|
|
24
|
+
*/
|
|
25
|
+
declare interface BaseConfig<TEvent = AppEvent> extends CommonCallbacks<TEvent> {
|
|
26
|
+
/**
|
|
27
|
+
* JWT token used for authentication
|
|
28
|
+
*/
|
|
29
|
+
jwt: string;
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Target environment
|
|
33
|
+
* @default 'production'
|
|
34
|
+
*/
|
|
35
|
+
env?: Environment;
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Theme mode
|
|
39
|
+
* @default 'auto'
|
|
40
|
+
*
|
|
41
|
+
* Available themes:
|
|
42
|
+
* - `'auto'` - Automatically detect system preference (light/dark mode)
|
|
43
|
+
* - `'light'` - Force light theme
|
|
44
|
+
* - `'dark'` - Force dark theme
|
|
45
|
+
*/
|
|
46
|
+
theme?: Theme;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
declare type BaseErrorMessageKeys =
|
|
50
|
+
| 'ALREADY_RENDERED'
|
|
51
|
+
| 'NOT_RENDERED'
|
|
52
|
+
| 'INVALID_CONTAINER'
|
|
53
|
+
| 'SCRIPT_LOAD_FAILED'
|
|
54
|
+
| 'WEB_COMPONENT_NOT_DEFINED';
|
|
55
|
+
|
|
56
|
+
declare abstract class BaseJsSdk<Config extends BaseConfig<never> = BaseConfig> {
|
|
57
|
+
private config: Config;
|
|
58
|
+
private state: SdkState;
|
|
59
|
+
private scriptLoadingPromise?: Promise<void>;
|
|
60
|
+
|
|
61
|
+
protected abstract errorMessages: Record<BaseErrorMessageKeys, string>;
|
|
62
|
+
protected abstract scriptUrls: Record<string, string>;
|
|
63
|
+
protected abstract webComponentTag: string;
|
|
64
|
+
|
|
65
|
+
constructor(config: Config) {
|
|
66
|
+
if (!config.jwt || typeof config.jwt !== 'string') {
|
|
67
|
+
throw new Error(INVALID_JWT_ERROR_MESSAGE);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
this.config = {
|
|
71
|
+
...config,
|
|
72
|
+
env: config.env || DEFAULT_ENVIRONMENT,
|
|
73
|
+
theme: config.theme,
|
|
74
|
+
};
|
|
75
|
+
|
|
76
|
+
this.state = {
|
|
77
|
+
initialized: false,
|
|
78
|
+
scriptLoaded: false,
|
|
79
|
+
container: null,
|
|
80
|
+
element: null,
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Render the widget to a container element
|
|
86
|
+
* @param container - The container element to render the widget into
|
|
87
|
+
* @returns Promise that resolves when the widget is rendered
|
|
88
|
+
*/
|
|
89
|
+
async render(container: HTMLElement): Promise<void> {
|
|
90
|
+
// Validate container
|
|
91
|
+
if (!container || !(container instanceof HTMLElement)) {
|
|
92
|
+
throw new Error(this.errorMessages.INVALID_CONTAINER);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
// Check if already rendered
|
|
96
|
+
if (this.state.initialized) {
|
|
97
|
+
throw new Error(this.errorMessages.ALREADY_RENDERED);
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
try {
|
|
101
|
+
// Ensure script is loaded
|
|
102
|
+
await this.ensureScriptLoaded();
|
|
103
|
+
|
|
104
|
+
// Create and append the web component
|
|
105
|
+
const element = this.createWebComponent();
|
|
106
|
+
|
|
107
|
+
// Clear the container and append the element
|
|
108
|
+
container.innerHTML = '';
|
|
109
|
+
container.appendChild(element);
|
|
110
|
+
|
|
111
|
+
// Update state
|
|
112
|
+
this.state.container = container;
|
|
113
|
+
this.state.element = element;
|
|
114
|
+
this.state.initialized = true;
|
|
115
|
+
} catch (error) {
|
|
116
|
+
console.error('Failed to render widget:', error);
|
|
117
|
+
throw error;
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Update the configuration of the widget
|
|
123
|
+
* @param config - Partial configuration to update
|
|
124
|
+
* @returns void
|
|
125
|
+
*/
|
|
126
|
+
updateConfig(config: Partial<Config>): void {
|
|
127
|
+
if (!this.state.initialized || !this.state.element) {
|
|
128
|
+
throw new Error(this.errorMessages.NOT_RENDERED);
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
const element = this.state.element as SdkElement<Config>;
|
|
132
|
+
|
|
133
|
+
Object.entries(config).forEach(([key, value]) => {
|
|
134
|
+
if (value) {
|
|
135
|
+
this.config[key as keyof Config] = value;
|
|
136
|
+
element[key as keyof Config] = value;
|
|
137
|
+
}
|
|
138
|
+
});
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Destroy the widget and clean up resources
|
|
143
|
+
*/
|
|
144
|
+
destroy(): void {
|
|
145
|
+
if (!this.state.initialized) {
|
|
146
|
+
return; // Nothing to destroy
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
// Remove the element from the container
|
|
150
|
+
if (this.state.element && this.state.element.parentNode) {
|
|
151
|
+
this.state.element.parentNode.removeChild(this.state.element);
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
// Clear the container
|
|
155
|
+
if (this.state.container) {
|
|
156
|
+
this.state.container.innerHTML = '';
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
// Reset state
|
|
160
|
+
this.state.container = null;
|
|
161
|
+
this.state.element = null;
|
|
162
|
+
this.state.initialized = false;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* Check if the widget is currently rendered
|
|
167
|
+
* @returns True if the widget is rendered, false otherwise
|
|
168
|
+
*/
|
|
169
|
+
isRendered(): boolean {
|
|
170
|
+
return this.state.initialized;
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Get the current configuration
|
|
175
|
+
* @returns The current configuration object
|
|
176
|
+
*/
|
|
177
|
+
getConfig(): Readonly<Config> {
|
|
178
|
+
return { ...this.config };
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
private getEnvironment(): Environment {
|
|
182
|
+
return this.config.env || DEFAULT_ENVIRONMENT;
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
private getScriptId() {
|
|
186
|
+
return `${this.webComponentTag}-script-${this.getEnvironment()}`;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
private isScriptLoaded() {
|
|
190
|
+
return !!document.getElementById(this.getScriptId());
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
private getWebComponent() {
|
|
194
|
+
return customElements.get(this.webComponentTag);
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
private getScriptUrl() {
|
|
198
|
+
// Support local development with Vite
|
|
199
|
+
if (typeof import.meta !== 'undefined' && import.meta.env?.['VITE_INTERNAL_BUILD'] === 'true') {
|
|
200
|
+
return import.meta.env['VITE_SCRIPT_URL'] || this.scriptUrls[this.getEnvironment()];
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
return this.scriptUrls[this.getEnvironment()];
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
private async loadScript() {
|
|
207
|
+
if (this.isScriptLoaded()) {
|
|
208
|
+
return;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
if (this.scriptLoadingPromise) {
|
|
212
|
+
return this.scriptLoadingPromise;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
this.scriptLoadingPromise = new Promise<void>((resolve, reject) => {
|
|
216
|
+
const script = document.createElement('script');
|
|
217
|
+
script.id = this.getScriptId();
|
|
218
|
+
script.src = this.getScriptUrl();
|
|
219
|
+
script.type = 'module';
|
|
220
|
+
script.async = true;
|
|
221
|
+
|
|
222
|
+
script.onload = () => {
|
|
223
|
+
setTimeout(() => {
|
|
224
|
+
if (this.getWebComponent()) {
|
|
225
|
+
resolve();
|
|
226
|
+
} else {
|
|
227
|
+
reject(new Error(this.errorMessages.WEB_COMPONENT_NOT_DEFINED));
|
|
228
|
+
}
|
|
229
|
+
}, 0);
|
|
230
|
+
};
|
|
231
|
+
|
|
232
|
+
script.onerror = () => {
|
|
233
|
+
this.scriptLoadingPromise = undefined;
|
|
234
|
+
reject(new Error(`${this.errorMessages.SCRIPT_LOAD_FAILED} (${this.getEnvironment()})`));
|
|
235
|
+
};
|
|
236
|
+
|
|
237
|
+
document.head.appendChild(script);
|
|
238
|
+
});
|
|
239
|
+
|
|
240
|
+
try {
|
|
241
|
+
await this.scriptLoadingPromise;
|
|
242
|
+
} catch (error) {
|
|
243
|
+
this.scriptLoadingPromise = undefined;
|
|
244
|
+
throw error;
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
return this.scriptLoadingPromise;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
private async waitForWebComponent(timeout = 5000) {
|
|
251
|
+
if (this.getWebComponent()) {
|
|
252
|
+
return;
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
return new Promise<void>((resolve, reject) => {
|
|
256
|
+
const timeoutId = setTimeout(() => {
|
|
257
|
+
reject(new Error(`Timeout waiting for ${this.webComponentTag} to be defined`));
|
|
258
|
+
}, timeout);
|
|
259
|
+
|
|
260
|
+
customElements
|
|
261
|
+
.whenDefined(this.webComponentTag)
|
|
262
|
+
.then(() => {
|
|
263
|
+
clearTimeout(timeoutId);
|
|
264
|
+
resolve();
|
|
265
|
+
})
|
|
266
|
+
.catch((error) => {
|
|
267
|
+
clearTimeout(timeoutId);
|
|
268
|
+
reject(error);
|
|
269
|
+
});
|
|
270
|
+
});
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* Load the web component script if not already loaded
|
|
275
|
+
*/
|
|
276
|
+
protected async ensureScriptLoaded(): Promise<void> {
|
|
277
|
+
if (this.state.scriptLoaded) {
|
|
278
|
+
return;
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
try {
|
|
282
|
+
await this.loadScript();
|
|
283
|
+
await this.waitForWebComponent();
|
|
284
|
+
this.state.scriptLoaded = true;
|
|
285
|
+
} catch (error) {
|
|
286
|
+
console.error('Failed to load Connect script:', error);
|
|
287
|
+
throw error;
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
private createWebComponent() {
|
|
292
|
+
const element = document.createElement(this.webComponentTag) as SdkElement<Config>;
|
|
293
|
+
|
|
294
|
+
Object.entries(this.config).forEach(([key, value]) => {
|
|
295
|
+
if (value) {
|
|
296
|
+
element[key as keyof Config] = value;
|
|
297
|
+
}
|
|
298
|
+
});
|
|
299
|
+
|
|
300
|
+
return element;
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Common callback function types shared across all Connect apps
|
|
306
|
+
* @template TEvent - The event type for onEvent callback
|
|
307
|
+
*/
|
|
308
|
+
declare type CommonCallbacks<TEvent = AppEvent> = {
|
|
309
|
+
/** Called when an error occurs */
|
|
310
|
+
onError?: (error: ErrorPayload) => void;
|
|
311
|
+
/** Called when the component is closed */
|
|
312
|
+
onClose?: () => void;
|
|
313
|
+
/** Called when a general event occurs */
|
|
314
|
+
onEvent?: (event: TEvent) => void;
|
|
315
|
+
/** Called when the widget has loaded and is ready */
|
|
316
|
+
onLoaded?: () => void;
|
|
317
|
+
};
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* CryptoAccountLink SDK class for programmatic control of the Connect Crypto Account Link widget.
|
|
321
|
+
*
|
|
322
|
+
* Renders the `zerohash-crypto-account-link` web component, which handles the iframe
|
|
323
|
+
* and postMessage communication internally.
|
|
324
|
+
*
|
|
325
|
+
* @example
|
|
326
|
+
* ```javascript
|
|
327
|
+
* const cryptoAccountLink = new CryptoAccountLink({
|
|
328
|
+
* jwt: 'your-jwt-token',
|
|
329
|
+
* env: 'prod',
|
|
330
|
+
* theme: 'auto',
|
|
331
|
+
* isPayouts: false,
|
|
332
|
+
* onCompleted: (data) => console.log('Completed', data),
|
|
333
|
+
* onClose: () => console.log('Closed'),
|
|
334
|
+
* onError: ({ errorCode, reason }) => console.error(errorCode, reason),
|
|
335
|
+
* onExternalAccountCreated: () => console.log('External account created'),
|
|
336
|
+
* });
|
|
337
|
+
*
|
|
338
|
+
* // Render to a container
|
|
339
|
+
* await cryptoAccountLink.render(document.getElementById('crypto-account-link-container'));
|
|
340
|
+
*
|
|
341
|
+
* // Update configuration
|
|
342
|
+
* cryptoAccountLink.updateConfig({ jwt: 'new-token', theme: 'dark' });
|
|
343
|
+
*
|
|
344
|
+
* // Clean up
|
|
345
|
+
* cryptoAccountLink.destroy();
|
|
346
|
+
* ```
|
|
347
|
+
*/
|
|
348
|
+
declare class CryptoAccountLink extends BaseJsSdk<CryptoAccountLinkConfig> {
|
|
349
|
+
protected errorMessages: {
|
|
350
|
+
ALREADY_RENDERED: string;
|
|
351
|
+
NOT_RENDERED: string;
|
|
352
|
+
INVALID_CONTAINER: string;
|
|
353
|
+
SCRIPT_LOAD_FAILED: string;
|
|
354
|
+
WEB_COMPONENT_NOT_DEFINED: string;
|
|
355
|
+
};
|
|
356
|
+
protected scriptUrls: {
|
|
357
|
+
local: string;
|
|
358
|
+
dev: string;
|
|
359
|
+
cert: string;
|
|
360
|
+
prod: string;
|
|
361
|
+
sandbox: string;
|
|
362
|
+
production: string;
|
|
363
|
+
};
|
|
364
|
+
protected webComponentTag: string;
|
|
365
|
+
/**
|
|
366
|
+
* Render the CryptoAccountLink widget to a container element
|
|
367
|
+
* @param container - The container element to render the widget into
|
|
368
|
+
* @returns Promise that resolves when the widget is rendered
|
|
369
|
+
*/
|
|
370
|
+
render(container: HTMLElement): Promise<void>;
|
|
371
|
+
/**
|
|
372
|
+
* Update the configuration of the CryptoAccountLink widget
|
|
373
|
+
* @param config - Partial configuration to update
|
|
374
|
+
*/
|
|
375
|
+
updateConfig(config: Partial<CryptoAccountLinkConfig>): void;
|
|
376
|
+
/**
|
|
377
|
+
* Get the current configuration
|
|
378
|
+
* @returns The current configuration object
|
|
379
|
+
*/
|
|
380
|
+
getConfig(): Readonly<CryptoAccountLinkConfig>;
|
|
381
|
+
/**
|
|
382
|
+
* Check if the CryptoAccountLink widget is currently rendered
|
|
383
|
+
* @returns True if the widget is rendered, false otherwise
|
|
384
|
+
*/
|
|
385
|
+
isRendered(): boolean;
|
|
386
|
+
/**
|
|
387
|
+
* Destroy the CryptoAccountLink widget and clean up resources
|
|
388
|
+
*/
|
|
389
|
+
destroy(): void;
|
|
390
|
+
}
|
|
391
|
+
export { CryptoAccountLink }
|
|
392
|
+
export default CryptoAccountLink;
|
|
393
|
+
|
|
394
|
+
declare type CryptoAccountLinkCallbacks = CommonCallbacks<CryptoAccountLinkEvent> & {
|
|
395
|
+
/** Called when an external account is created */
|
|
396
|
+
onExternalAccountCreated?: () => void;
|
|
397
|
+
/** Called when the account linking is successfully completed */
|
|
398
|
+
onCompleted?: (data: CryptoAccountLinkCompletedData) => void;
|
|
399
|
+
};
|
|
400
|
+
|
|
401
|
+
declare interface CryptoAccountLinkCompletedData {
|
|
402
|
+
externalAccountId?: string;
|
|
403
|
+
address?: string;
|
|
404
|
+
nickname?: string;
|
|
405
|
+
asset?: string;
|
|
406
|
+
network?: string;
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
export declare interface CryptoAccountLinkConfig extends BaseConfig<CryptoAccountLinkEvent>, CryptoAccountLinkCallbacks {
|
|
410
|
+
isPayouts?: boolean;
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
/**
|
|
414
|
+
* Crypto account link event structure
|
|
415
|
+
*/
|
|
416
|
+
declare type CryptoAccountLinkEvent = AppEvent<CryptoAccountLinkEventType>;
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* Crypto account link event type literals
|
|
420
|
+
*/
|
|
421
|
+
declare type CryptoAccountLinkEventType = string;
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
* Environment configuration for the SDK
|
|
425
|
+
*/
|
|
426
|
+
export declare type Environment = 'local' | 'dev' | 'cert' | 'prod' | 'sandbox' | 'production';
|
|
427
|
+
|
|
428
|
+
/**
|
|
429
|
+
* Generic error codes for all Connect applications
|
|
430
|
+
*/
|
|
431
|
+
export declare enum ErrorCode {
|
|
432
|
+
/** Network connectivity error */
|
|
433
|
+
NETWORK_ERROR = 'network_error',
|
|
434
|
+
/** Authentication or session expired error */
|
|
435
|
+
AUTH_ERROR = 'auth_error',
|
|
436
|
+
/** Resource not found error */
|
|
437
|
+
NOT_FOUND_ERROR = 'not_found_error',
|
|
438
|
+
/** Validation error from user input */
|
|
439
|
+
VALIDATION_ERROR = 'validation_error',
|
|
440
|
+
/** Server error (5xx) */
|
|
441
|
+
SERVER_ERROR = 'server_error',
|
|
442
|
+
/** Client error (4xx) */
|
|
443
|
+
CLIENT_ERROR = 'client_error',
|
|
444
|
+
/** Unknown or unexpected error */
|
|
445
|
+
UNKNOWN_ERROR = 'unknown_error',
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
/**
|
|
449
|
+
* Generic error payload structure for error callbacks
|
|
450
|
+
*/
|
|
451
|
+
declare type ErrorPayload = {
|
|
452
|
+
/** Error code indicating the type of error */
|
|
453
|
+
errorCode: ErrorCode;
|
|
454
|
+
/** Human-readable reason for the error */
|
|
455
|
+
reason: string;
|
|
456
|
+
};
|
|
457
|
+
|
|
458
|
+
/**
|
|
459
|
+
* Generic HTMLElement representing a web component with custom config
|
|
460
|
+
*/
|
|
461
|
+
declare type SdkElement<Config extends BaseConfig<never>> = HTMLElement & Config;
|
|
462
|
+
|
|
463
|
+
/**
|
|
464
|
+
* Internal state of the SDK
|
|
465
|
+
*/
|
|
466
|
+
declare interface SdkState {
|
|
467
|
+
/** Whether the SDK is initialized */
|
|
468
|
+
initialized: boolean;
|
|
469
|
+
/** Whether the web component script is loaded */
|
|
470
|
+
scriptLoaded: boolean;
|
|
471
|
+
/** The container element where the widget is rendered */
|
|
472
|
+
container: HTMLElement | null;
|
|
473
|
+
/** The web component element */
|
|
474
|
+
element: HTMLElement | null;
|
|
475
|
+
}
|
|
476
|
+
|
|
477
|
+
/**
|
|
478
|
+
* Theme configuration for the SDK
|
|
479
|
+
*
|
|
480
|
+
* - `"auto"` - Automatically detect system preference (light/dark mode)
|
|
481
|
+
* - `"light"` - Force light theme
|
|
482
|
+
* - `"dark"` - Force dark theme
|
|
483
|
+
*/
|
|
484
|
+
declare type Theme = 'auto' | 'light' | 'dark';
|
|
485
|
+
|
|
486
|
+
export declare type ZerohashCryptoAccountLinkElement = SdkElement<CryptoAccountLinkConfig>;
|
|
487
|
+
|
|
488
|
+
export { }
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
const s = "production", c = "JWT token is required and must be a string.";
|
|
2
|
+
class d {
|
|
3
|
+
config;
|
|
4
|
+
state;
|
|
5
|
+
scriptLoadingPromise;
|
|
6
|
+
constructor(e) {
|
|
7
|
+
if (!e.jwt || typeof e.jwt != "string")
|
|
8
|
+
throw new Error(c);
|
|
9
|
+
this.config = {
|
|
10
|
+
...e,
|
|
11
|
+
env: e.env || s,
|
|
12
|
+
theme: e.theme
|
|
13
|
+
}, this.state = {
|
|
14
|
+
initialized: !1,
|
|
15
|
+
scriptLoaded: !1,
|
|
16
|
+
container: null,
|
|
17
|
+
element: null
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Render the widget to a container element
|
|
22
|
+
* @param container - The container element to render the widget into
|
|
23
|
+
* @returns Promise that resolves when the widget is rendered
|
|
24
|
+
*/
|
|
25
|
+
async render(e) {
|
|
26
|
+
if (!e || !(e instanceof HTMLElement))
|
|
27
|
+
throw new Error(this.errorMessages.INVALID_CONTAINER);
|
|
28
|
+
if (this.state.initialized)
|
|
29
|
+
throw new Error(this.errorMessages.ALREADY_RENDERED);
|
|
30
|
+
try {
|
|
31
|
+
await this.ensureScriptLoaded();
|
|
32
|
+
const r = this.createWebComponent();
|
|
33
|
+
e.innerHTML = "", e.appendChild(r), this.state.container = e, this.state.element = r, this.state.initialized = !0;
|
|
34
|
+
} catch (r) {
|
|
35
|
+
throw console.error("Failed to render widget:", r), r;
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Update the configuration of the widget
|
|
40
|
+
* @param config - Partial configuration to update
|
|
41
|
+
* @returns void
|
|
42
|
+
*/
|
|
43
|
+
updateConfig(e) {
|
|
44
|
+
if (!this.state.initialized || !this.state.element)
|
|
45
|
+
throw new Error(this.errorMessages.NOT_RENDERED);
|
|
46
|
+
const r = this.state.element;
|
|
47
|
+
Object.entries(e).forEach(([t, i]) => {
|
|
48
|
+
i && (this.config[t] = i, r[t] = i);
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Destroy the widget and clean up resources
|
|
53
|
+
*/
|
|
54
|
+
destroy() {
|
|
55
|
+
this.state.initialized && (this.state.element && this.state.element.parentNode && this.state.element.parentNode.removeChild(this.state.element), this.state.container && (this.state.container.innerHTML = ""), this.state.container = null, this.state.element = null, this.state.initialized = !1);
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Check if the widget is currently rendered
|
|
59
|
+
* @returns True if the widget is rendered, false otherwise
|
|
60
|
+
*/
|
|
61
|
+
isRendered() {
|
|
62
|
+
return this.state.initialized;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Get the current configuration
|
|
66
|
+
* @returns The current configuration object
|
|
67
|
+
*/
|
|
68
|
+
getConfig() {
|
|
69
|
+
return { ...this.config };
|
|
70
|
+
}
|
|
71
|
+
getEnvironment() {
|
|
72
|
+
return this.config.env || s;
|
|
73
|
+
}
|
|
74
|
+
getScriptId() {
|
|
75
|
+
return `${this.webComponentTag}-script-${this.getEnvironment()}`;
|
|
76
|
+
}
|
|
77
|
+
isScriptLoaded() {
|
|
78
|
+
return !!document.getElementById(this.getScriptId());
|
|
79
|
+
}
|
|
80
|
+
getWebComponent() {
|
|
81
|
+
return customElements.get(this.webComponentTag);
|
|
82
|
+
}
|
|
83
|
+
getScriptUrl() {
|
|
84
|
+
return this.scriptUrls[this.getEnvironment()];
|
|
85
|
+
}
|
|
86
|
+
async loadScript() {
|
|
87
|
+
if (!this.isScriptLoaded()) {
|
|
88
|
+
if (this.scriptLoadingPromise)
|
|
89
|
+
return this.scriptLoadingPromise;
|
|
90
|
+
this.scriptLoadingPromise = new Promise((e, r) => {
|
|
91
|
+
const t = document.createElement("script");
|
|
92
|
+
t.id = this.getScriptId(), t.src = this.getScriptUrl(), t.type = "module", t.async = !0, t.onload = () => {
|
|
93
|
+
setTimeout(() => {
|
|
94
|
+
this.getWebComponent() ? e() : r(new Error(this.errorMessages.WEB_COMPONENT_NOT_DEFINED));
|
|
95
|
+
}, 0);
|
|
96
|
+
}, t.onerror = () => {
|
|
97
|
+
this.scriptLoadingPromise = void 0, r(new Error(`${this.errorMessages.SCRIPT_LOAD_FAILED} (${this.getEnvironment()})`));
|
|
98
|
+
}, document.head.appendChild(t);
|
|
99
|
+
});
|
|
100
|
+
try {
|
|
101
|
+
await this.scriptLoadingPromise;
|
|
102
|
+
} catch (e) {
|
|
103
|
+
throw this.scriptLoadingPromise = void 0, e;
|
|
104
|
+
}
|
|
105
|
+
return this.scriptLoadingPromise;
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
async waitForWebComponent(e = 5e3) {
|
|
109
|
+
if (!this.getWebComponent())
|
|
110
|
+
return new Promise((r, t) => {
|
|
111
|
+
const i = setTimeout(() => {
|
|
112
|
+
t(new Error(`Timeout waiting for ${this.webComponentTag} to be defined`));
|
|
113
|
+
}, e);
|
|
114
|
+
customElements.whenDefined(this.webComponentTag).then(() => {
|
|
115
|
+
clearTimeout(i), r();
|
|
116
|
+
}).catch((a) => {
|
|
117
|
+
clearTimeout(i), t(a);
|
|
118
|
+
});
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Load the web component script if not already loaded
|
|
123
|
+
*/
|
|
124
|
+
async ensureScriptLoaded() {
|
|
125
|
+
if (!this.state.scriptLoaded)
|
|
126
|
+
try {
|
|
127
|
+
await this.loadScript(), await this.waitForWebComponent(), this.state.scriptLoaded = !0;
|
|
128
|
+
} catch (e) {
|
|
129
|
+
throw console.error("Failed to load Connect script:", e), e;
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
createWebComponent() {
|
|
133
|
+
const e = document.createElement(this.webComponentTag);
|
|
134
|
+
return Object.entries(this.config).forEach(([r, t]) => {
|
|
135
|
+
t && (e[r] = t);
|
|
136
|
+
}), e;
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
var o;
|
|
140
|
+
(function(n) {
|
|
141
|
+
n.NETWORK_ERROR = "network_error", n.AUTH_ERROR = "auth_error", n.NOT_FOUND_ERROR = "not_found_error", n.VALIDATION_ERROR = "validation_error", n.SERVER_ERROR = "server_error", n.CLIENT_ERROR = "client_error", n.UNKNOWN_ERROR = "unknown_error";
|
|
142
|
+
})(o || (o = {}));
|
|
143
|
+
class h extends d {
|
|
144
|
+
errorMessages = {
|
|
145
|
+
ALREADY_RENDERED: "CryptoAccountLink widget is already rendered. Call destroy() before rendering again.",
|
|
146
|
+
NOT_RENDERED: "CryptoAccountLink widget is not rendered. Call render() first.",
|
|
147
|
+
INVALID_CONTAINER: "Invalid container element provided.",
|
|
148
|
+
SCRIPT_LOAD_FAILED: "Failed to load the Connect CryptoAccountLink script.",
|
|
149
|
+
WEB_COMPONENT_NOT_DEFINED: "Web component is not defined. Script may not be loaded."
|
|
150
|
+
};
|
|
151
|
+
scriptUrls = {
|
|
152
|
+
local: "http://localhost:5173/crypto-account-link-web/index.js",
|
|
153
|
+
dev: "https://connect-sdk.dev.0hash.com/crypto-account-link-web/index.js",
|
|
154
|
+
cert: "https://sdk.sandbox.connect.xyz/crypto-account-link-web/index.js",
|
|
155
|
+
prod: "https://sdk.connect.xyz/crypto-account-link-web/index.js",
|
|
156
|
+
sandbox: "https://sdk.sandbox.connect.xyz/crypto-account-link-web/index.js",
|
|
157
|
+
production: "https://sdk.connect.xyz/crypto-account-link-web/index.js"
|
|
158
|
+
};
|
|
159
|
+
webComponentTag = "zerohash-crypto-account-link";
|
|
160
|
+
/**
|
|
161
|
+
* Render the CryptoAccountLink widget to a container element
|
|
162
|
+
* @param container - The container element to render the widget into
|
|
163
|
+
* @returns Promise that resolves when the widget is rendered
|
|
164
|
+
*/
|
|
165
|
+
render(e) {
|
|
166
|
+
return super.render(e);
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* Update the configuration of the CryptoAccountLink widget
|
|
170
|
+
* @param config - Partial configuration to update
|
|
171
|
+
*/
|
|
172
|
+
updateConfig(e) {
|
|
173
|
+
return super.updateConfig(e);
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Get the current configuration
|
|
177
|
+
* @returns The current configuration object
|
|
178
|
+
*/
|
|
179
|
+
getConfig() {
|
|
180
|
+
return super.getConfig();
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Check if the CryptoAccountLink widget is currently rendered
|
|
184
|
+
* @returns True if the widget is rendered, false otherwise
|
|
185
|
+
*/
|
|
186
|
+
isRendered() {
|
|
187
|
+
return super.isRendered();
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* Destroy the CryptoAccountLink widget and clean up resources
|
|
191
|
+
*/
|
|
192
|
+
destroy() {
|
|
193
|
+
return super.destroy();
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
export {
|
|
197
|
+
h as CryptoAccountLink,
|
|
198
|
+
o as ErrorCode,
|
|
199
|
+
h as default
|
|
200
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
(function(i,o){typeof exports=="object"&&typeof module<"u"?o(exports):typeof define=="function"&&define.amd?define(["exports"],o):(i=typeof globalThis<"u"?globalThis:i||self,o(i.CryptoAccountLink={}))})(this,(function(i){"use strict";const o="production",c="JWT token is required and must be a string.";class d{config;state;scriptLoadingPromise;constructor(e){if(!e.jwt||typeof e.jwt!="string")throw new Error(c);this.config={...e,env:e.env||o,theme:e.theme},this.state={initialized:!1,scriptLoaded:!1,container:null,element:null}}async render(e){if(!e||!(e instanceof HTMLElement))throw new Error(this.errorMessages.INVALID_CONTAINER);if(this.state.initialized)throw new Error(this.errorMessages.ALREADY_RENDERED);try{await this.ensureScriptLoaded();const n=this.createWebComponent();e.innerHTML="",e.appendChild(n),this.state.container=e,this.state.element=n,this.state.initialized=!0}catch(n){throw console.error("Failed to render widget:",n),n}}updateConfig(e){if(!this.state.initialized||!this.state.element)throw new Error(this.errorMessages.NOT_RENDERED);const n=this.state.element;Object.entries(e).forEach(([t,s])=>{s&&(this.config[t]=s,n[t]=s)})}destroy(){this.state.initialized&&(this.state.element&&this.state.element.parentNode&&this.state.element.parentNode.removeChild(this.state.element),this.state.container&&(this.state.container.innerHTML=""),this.state.container=null,this.state.element=null,this.state.initialized=!1)}isRendered(){return this.state.initialized}getConfig(){return{...this.config}}getEnvironment(){return this.config.env||o}getScriptId(){return`${this.webComponentTag}-script-${this.getEnvironment()}`}isScriptLoaded(){return!!document.getElementById(this.getScriptId())}getWebComponent(){return customElements.get(this.webComponentTag)}getScriptUrl(){return this.scriptUrls[this.getEnvironment()]}async loadScript(){if(!this.isScriptLoaded()){if(this.scriptLoadingPromise)return this.scriptLoadingPromise;this.scriptLoadingPromise=new Promise((e,n)=>{const t=document.createElement("script");t.id=this.getScriptId(),t.src=this.getScriptUrl(),t.type="module",t.async=!0,t.onload=()=>{setTimeout(()=>{this.getWebComponent()?e():n(new Error(this.errorMessages.WEB_COMPONENT_NOT_DEFINED))},0)},t.onerror=()=>{this.scriptLoadingPromise=void 0,n(new Error(`${this.errorMessages.SCRIPT_LOAD_FAILED} (${this.getEnvironment()})`))},document.head.appendChild(t)});try{await this.scriptLoadingPromise}catch(e){throw this.scriptLoadingPromise=void 0,e}return this.scriptLoadingPromise}}async waitForWebComponent(e=5e3){if(!this.getWebComponent())return new Promise((n,t)=>{const s=setTimeout(()=>{t(new Error(`Timeout waiting for ${this.webComponentTag} to be defined`))},e);customElements.whenDefined(this.webComponentTag).then(()=>{clearTimeout(s),n()}).catch(h=>{clearTimeout(s),t(h)})})}async ensureScriptLoaded(){if(!this.state.scriptLoaded)try{await this.loadScript(),await this.waitForWebComponent(),this.state.scriptLoaded=!0}catch(e){throw console.error("Failed to load Connect script:",e),e}}createWebComponent(){const e=document.createElement(this.webComponentTag);return Object.entries(this.config).forEach(([n,t])=>{t&&(e[n]=t)}),e}}i.ErrorCode=void 0,(function(r){r.NETWORK_ERROR="network_error",r.AUTH_ERROR="auth_error",r.NOT_FOUND_ERROR="not_found_error",r.VALIDATION_ERROR="validation_error",r.SERVER_ERROR="server_error",r.CLIENT_ERROR="client_error",r.UNKNOWN_ERROR="unknown_error"})(i.ErrorCode||(i.ErrorCode={}));class a extends d{errorMessages={ALREADY_RENDERED:"CryptoAccountLink widget is already rendered. Call destroy() before rendering again.",NOT_RENDERED:"CryptoAccountLink widget is not rendered. Call render() first.",INVALID_CONTAINER:"Invalid container element provided.",SCRIPT_LOAD_FAILED:"Failed to load the Connect CryptoAccountLink script.",WEB_COMPONENT_NOT_DEFINED:"Web component is not defined. Script may not be loaded."};scriptUrls={local:"http://localhost:5173/crypto-account-link-web/index.js",dev:"https://connect-sdk.dev.0hash.com/crypto-account-link-web/index.js",cert:"https://sdk.sandbox.connect.xyz/crypto-account-link-web/index.js",prod:"https://sdk.connect.xyz/crypto-account-link-web/index.js",sandbox:"https://sdk.sandbox.connect.xyz/crypto-account-link-web/index.js",production:"https://sdk.connect.xyz/crypto-account-link-web/index.js"};webComponentTag="zerohash-crypto-account-link";render(e){return super.render(e)}updateConfig(e){return super.updateConfig(e)}getConfig(){return super.getConfig()}isRendered(){return super.isRendered()}destroy(){return super.destroy()}}i.CryptoAccountLink=a,i.default=a,Object.defineProperties(i,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})}));
|
package/package.json
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@zerohash-sdk/crypto-account-link-js",
|
|
3
|
+
"version": "1.1.0",
|
|
4
|
+
"private": false,
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./dist/index.js",
|
|
7
|
+
"module": "./dist/index.js",
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
|
+
"license": "MIT",
|
|
10
|
+
"exports": {
|
|
11
|
+
"./package.json": "./package.json",
|
|
12
|
+
".": {
|
|
13
|
+
"types": "./dist/index.d.ts",
|
|
14
|
+
"import": "./dist/index.js",
|
|
15
|
+
"default": "./dist/index.js"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist",
|
|
20
|
+
"!**/*.tsbuildinfo"
|
|
21
|
+
],
|
|
22
|
+
"nx": {
|
|
23
|
+
"name": "crypto-account-link-js"
|
|
24
|
+
}
|
|
25
|
+
}
|