@zerohash-sdk/travel-rule-js 0.3.4 → 0.5.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/dist/index.d.ts CHANGED
@@ -24,7 +24,8 @@ declare type AppEvent<TType extends string = string, TData = Record<string, unkn
24
24
  */
25
25
  declare interface BaseConfig<TEvent = AppEvent> extends CommonCallbacks<TEvent> {
26
26
  /**
27
- * JWT token used for authentication
27
+ * JWT token used for authentication. Provide/update it via `setJWT`
28
+ * (`updateConfig({ jwt })`).
28
29
  */
29
30
  jwt: string;
30
31
 
@@ -119,7 +120,11 @@ declare abstract class BaseJsSdk<Config extends BaseConfig<never> = BaseConfig>
119
120
  }
120
121
 
121
122
  /**
122
- * Update the configuration of the widget
123
+ * Update the configuration of the widget (e.g. `theme`, or the `jwt`).
124
+ *
125
+ * Passing a `jwt` is the JS-SDK equivalent of `setJWT` — it provides the JWT
126
+ * used to authenticate.
127
+ *
123
128
  * @param config - Partial configuration to update
124
129
  * @returns void
125
130
  */
@@ -484,9 +489,9 @@ declare type TravelRuleCallbacks = CommonCallbacks<TravelRuleEvent> & {
484
489
 
485
490
  declare type TravelRuleCompletedData = {
486
491
  /** Deposit id the travel-rule submission is tied to */
487
- deposit_id: string;
492
+ deposit_id?: string;
488
493
  /** ISO-8601 timestamp of the travel-rule submission */
489
- submitted_at: string;
494
+ submitted_at?: string;
490
495
  };
491
496
 
492
497
  export declare interface TravelRuleConfig extends BaseConfig<TravelRuleEvent>, TravelRuleCallbacks {
package/dist/index.js CHANGED
@@ -169,7 +169,11 @@ class j {
169
169
  }
170
170
  }
171
171
  /**
172
- * Update the configuration of the widget
172
+ * Update the configuration of the widget (e.g. `theme`, or the `jwt`).
173
+ *
174
+ * Passing a `jwt` is the JS-SDK equivalent of `setJWT` — it provides the JWT
175
+ * used to authenticate.
176
+ *
173
177
  * @param config - Partial configuration to update
174
178
  * @returns void
175
179
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zerohash-sdk/travel-rule-js",
3
- "version": "0.3.4",
3
+ "version": "0.5.0",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",