@uphold/enterprise-widget-sdk-core 0.3.0 → 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/README.md ADDED
@@ -0,0 +1,68 @@
1
+ # enterprise-widget-sdk-core
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@uphold/enterprise-widget-sdk-core.svg?style=flat-square)](https://www.npmjs.com/package/@uphold/enterprise-widget-sdk-core)
4
+
5
+ Core SDK package to support enterprise widgets.
6
+
7
+ ## Installation
8
+
9
+ To install the package, run:
10
+
11
+ ```bash
12
+ npm install @uphold/enterprise-widget-sdk-core
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ This package should not be used directly. Please refer to the specific widget SDK packages for usage instructions.
18
+
19
+ ## Contributing
20
+
21
+ ### Installing the project
22
+
23
+ Install the dependencies:
24
+
25
+ ```bash
26
+ npm install
27
+ ```
28
+
29
+ ### Development
30
+
31
+ #### Lint
32
+
33
+ To lint the project, run:
34
+
35
+ ```sh
36
+ npm run lint
37
+ ```
38
+
39
+ #### Test
40
+
41
+ To test the project, run:
42
+
43
+ ```sh
44
+ npm test
45
+ ```
46
+
47
+ #### Typecheck
48
+
49
+ To type check the project, run:
50
+
51
+ ```sh
52
+ npm run typecheck
53
+ ```
54
+
55
+ ### Building for production
56
+
57
+ To create a production build, run:
58
+
59
+ ```sh
60
+ npm run build
61
+ ```
62
+
63
+ ### Generating a new release
64
+
65
+ Releases are performed manually via a specific `Release` GitHub workflow. After merging the changes to the `master` branch, trigger the workflow selecting that branch and the appropriate version bump to apply to the new version.
66
+
67
+ > [!IMPORTANT]
68
+ > After releasing a new version, make sure to update the dependencies section in the `package.json` files of the other packages in the monorepo to use the newly released version. This is necessary because internal dependencies are not automatically updated during the release process due to the tool being used not supporting monorepos. This will be updated in the future when we migrate to a different release tool.
@@ -38,5 +38,4 @@ export type WidgetMountIframeOptions = Record<string, unknown>;
38
38
  export type WidgetOptions = {
39
39
  debug?: boolean;
40
40
  };
41
- export type PaymentWidgetOptions = WidgetOptions;
42
41
  //# sourceMappingURL=base.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/types/base.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EACV,4BAA4B,EAC5B,uBAAuB,EACvB,8BAA8B,EAC9B,yBAAyB,EACzB,WAAW,EACX,2BAA2B,EAC3B,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,2CAA2C,CAAC;AAEnD;;GAEG;AAEH,YAAY,EAAE,WAAW,EAAE,2BAA2B,EAAE,8BAA8B,EAAE,4BAA4B,EAAE,CAAC;AAEvH,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,CAAC;AAC1D,MAAM,MAAM,uBAAuB,GAAG,yBAAyB,CAAC;AAChE,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,CAAC;AAC5D,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,CAAC;AAE1D,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,oBAAoB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,uBAAuB,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,qBAAqB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,8BAA8B,CACxC,aAAa,SAAS,kBAAkB,EACxC,KAAK,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IACzC,OAAO,CAAC,aAAa,EAAE;IAAE,IAAI,EAAE;QAAE,IAAI,EAAE,KAAK,CAAA;KAAE,CAAA;CAAE,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9D,MAAM,MAAM,eAAe,CAAC,aAAa,SAAS,kBAAkB,IAAI,WAAW,CACjF,8BAA8B,CAAC,aAAa,EAAE,MAAM,CAAC,CACtD,CAAC;AACF,MAAM,MAAM,gBAAgB,CAAC,aAAa,SAAS,kBAAkB,IAAI,WAAW,CAClF,8BAA8B,CAAC,aAAa,EAAE,OAAO,CAAC,CACvD,CAAC;AACF,MAAM,MAAM,mBAAmB,CAAC,aAAa,SAAS,kBAAkB,IAAI,WAAW,CACrF,8BAA8B,CAAC,aAAa,EAAE,UAAU,CAAC,CAC1D,CAAC;AACF,MAAM,MAAM,iBAAiB,CAAC,aAAa,SAAS,kBAAkB,IAAI,WAAW,CACnF,8BAA8B,CAAC,aAAa,EAAE,QAAQ,CAAC,CACxD,CAAC;AACF,MAAM,MAAM,gBAAgB,CAAC,aAAa,SAAS,kBAAkB,IAAI,WAAW,CAClF,8BAA8B,CAAC,aAAa,EAAE,OAAO,CAAC,CACvD,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,aAAa,SAAS,kBAAkB,GAAG,kBAAkB,IACjF,gBAAgB,CAAC,aAAa,CAAC,GAC/B,mBAAmB,CAAC,aAAa,CAAC,GAClC,iBAAiB,CAAC,aAAa,CAAC,GAChC,gBAAgB,CAAC,aAAa,CAAC,CAAC;AAEpC,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC"}
1
+ {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/types/base.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EACV,4BAA4B,EAC5B,uBAAuB,EACvB,8BAA8B,EAC9B,yBAAyB,EACzB,WAAW,EACX,2BAA2B,EAC3B,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,2CAA2C,CAAC;AAEnD;;GAEG;AAEH,YAAY,EAAE,WAAW,EAAE,2BAA2B,EAAE,8BAA8B,EAAE,4BAA4B,EAAE,CAAC;AAEvH,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,CAAC;AAC1D,MAAM,MAAM,uBAAuB,GAAG,yBAAyB,CAAC;AAChE,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,CAAC;AAC5D,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,CAAC;AAE1D,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,oBAAoB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,uBAAuB,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,qBAAqB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,8BAA8B,CACxC,aAAa,SAAS,kBAAkB,EACxC,KAAK,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IACzC,OAAO,CAAC,aAAa,EAAE;IAAE,IAAI,EAAE;QAAE,IAAI,EAAE,KAAK,CAAA;KAAE,CAAA;CAAE,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9D,MAAM,MAAM,eAAe,CAAC,aAAa,SAAS,kBAAkB,IAAI,WAAW,CACjF,8BAA8B,CAAC,aAAa,EAAE,MAAM,CAAC,CACtD,CAAC;AACF,MAAM,MAAM,gBAAgB,CAAC,aAAa,SAAS,kBAAkB,IAAI,WAAW,CAClF,8BAA8B,CAAC,aAAa,EAAE,OAAO,CAAC,CACvD,CAAC;AACF,MAAM,MAAM,mBAAmB,CAAC,aAAa,SAAS,kBAAkB,IAAI,WAAW,CACrF,8BAA8B,CAAC,aAAa,EAAE,UAAU,CAAC,CAC1D,CAAC;AACF,MAAM,MAAM,iBAAiB,CAAC,aAAa,SAAS,kBAAkB,IAAI,WAAW,CACnF,8BAA8B,CAAC,aAAa,EAAE,QAAQ,CAAC,CACxD,CAAC;AACF,MAAM,MAAM,gBAAgB,CAAC,aAAa,SAAS,kBAAkB,IAAI,WAAW,CAClF,8BAA8B,CAAC,aAAa,EAAE,OAAO,CAAC,CACvD,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,aAAa,SAAS,kBAAkB,GAAG,kBAAkB,IACjF,gBAAgB,CAAC,aAAa,CAAC,GAC/B,mBAAmB,CAAC,aAAa,CAAC,GAClC,iBAAiB,CAAC,aAAa,CAAC,GAChC,gBAAgB,CAAC,aAAa,CAAC,CAAC;AAEpC,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC"}
package/dist/widget.d.ts CHANGED
@@ -7,16 +7,16 @@ import { logSymbol } from './constants';
7
7
  /**
8
8
  * Widget base class.
9
9
  */
10
- declare class Widget<TSession extends WidgetSession, TMessageEvent extends WidgetMessageEvent, TEvent extends WidgetEvent<TMessageEvent>> extends EventTarget {
10
+ declare class Widget<TSession extends WidgetSession, TMessageEvent extends WidgetMessageEvent, TEvent extends WidgetEvent<TMessageEvent>, TWidgetOptions extends WidgetOptions = WidgetOptions> extends EventTarget {
11
11
  #private;
12
12
  session: TSession;
13
13
  mountOptions?: WidgetMountIframeOptions;
14
- options?: WidgetOptions;
14
+ options?: TWidgetOptions;
15
15
  [logSymbol]: {
16
16
  log: (message?: any, ...optionalParams: any[]) => void;
17
17
  warn: (message?: any, ...optionalParams: any[]) => void;
18
18
  };
19
- constructor(session: TSession, options?: WidgetOptions);
19
+ constructor(session: TSession, options?: TWidgetOptions);
20
20
  on<T extends TEvent['detail']['type']>(event: T, listener: (event: Extract<TEvent, {
21
21
  detail: {
22
22
  type: T;
@@ -1 +1 @@
1
- {"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../src/widget.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,wBAAwB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACzF,OAAO,KAAK,EAEV,kBAAkB,EAClB,aAAa,EACd,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AAEH,cAAM,MAAM,CACV,QAAQ,SAAS,aAAa,EAC9B,aAAa,SAAS,kBAAkB,EACxC,MAAM,SAAS,WAAW,CAAC,aAAa,CAAC,CACzC,SAAQ,WAAW;;IAGnB,OAAO,EAAE,QAAQ,CAAC;IAClB,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,CAAC,SAAS,CAAC;wBAEO,GAAG,qBAAqB,GAAG,EAAE;yBAI5B,GAAG,qBAAqB,GAAG,EAAE;MAG9C;gBAEU,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,aAAa;IAWtD,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EACnC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAA;KAAE,CAAC,KAAK,IAAI;IAarE,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EACpC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAA;KAAE,CAAC,KAAK,IAAI;IAiBrE,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,wBAAwB;IA4BzE,OAAO;CAsGR;AAED;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,CAAC"}
1
+ {"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../src/widget.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,wBAAwB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACzF,OAAO,KAAK,EAEV,kBAAkB,EAClB,aAAa,EACd,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AAEH,cAAM,MAAM,CACV,QAAQ,SAAS,aAAa,EAC9B,aAAa,SAAS,kBAAkB,EACxC,MAAM,SAAS,WAAW,CAAC,aAAa,CAAC,EACzC,cAAc,SAAS,aAAa,GAAG,aAAa,CACpD,SAAQ,WAAW;;IAGnB,OAAO,EAAE,QAAQ,CAAC;IAClB,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,CAAC,SAAS,CAAC;wBAEO,GAAG,qBAAqB,GAAG,EAAE;yBAI5B,GAAG,qBAAqB,GAAG,EAAE;MAG9C;gBAEU,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,cAAc;IAWvD,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EACnC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAA;KAAE,CAAC,KAAK,IAAI;IAarE,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EACpC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAA;KAAE,CAAC,KAAK,IAAI;IAiBrE,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,wBAAwB;IA4BzE,OAAO;CAuGR;AAED;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,CAAC"}
package/dist/widget.js CHANGED
@@ -112,6 +112,7 @@ class Widget extends EventTarget {
112
112
  case 'load': {
113
113
  const widgetInitMessage = {
114
114
  ...this.session,
115
+ options: this.options,
115
116
  type: 'init'
116
117
  };
117
118
  this.#sendMessageToWidget(widgetInitMessage);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uphold/enterprise-widget-sdk-core",
3
- "version": "0.3.0",
3
+ "version": "0.5.0",
4
4
  "type": "module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -29,6 +29,9 @@
29
29
  ]
30
30
  },
31
31
  "dependencies": {
32
- "@uphold/enterprise-widget-messaging-types": "^0.7.0"
32
+ "@uphold/enterprise-widget-messaging-types": "^0.10.0"
33
+ },
34
+ "devDependencies": {
35
+ "jsdom": "^27.4.0"
33
36
  }
34
37
  }