@uphold/enterprise-widget-sdk-core 0.3.0 → 0.4.0

package/README.md

@@ -0,0 +1,68 @@
+# enterprise-widget-sdk-core
+
+[![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)
+
+Core SDK package to support enterprise widgets.
+
+## Installation
+
+To install the package, run:
+
+```bash
+npm install @uphold/enterprise-widget-sdk-core
+```
+
+## Usage
+
+This package should not be used directly. Please refer to the specific widget SDK packages for usage instructions.
+
+## Contributing
+
+### Installing the project
+
+Install the dependencies:
+
+```bash
+npm install
+```
+
+### Development
+
+#### Lint
+
+To lint the project, run:
+
+```sh
+npm run lint
+```
+
+#### Test
+
+To test the project, run:
+
+```sh
+npm test
+```
+
+#### Typecheck
+
+To type check the project, run:
+
+```sh
+npm run typecheck
+```
+
+### Building for production
+
+To create a production build, run:
+
+```sh
+npm run build
+```
+
+### Generating a new release
+
+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.
+
+> [!IMPORTANT]
+> 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.

package/dist/types/base.d.ts

@@ -38,5 +38,4 @@ export type WidgetMountIframeOptions = Record<string, unknown>;
 export type WidgetOptions = {
     debug?: boolean;
 };
-export type PaymentWidgetOptions = WidgetOptions;
 //# sourceMappingURL=base.d.ts.map

package/dist/types/base.d.ts.map

@@ -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"}
+{"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

@@ -7,16 +7,16 @@ import { logSymbol } from './constants';
 /**
  * Widget base class.
  */
-declare class Widget<TSession extends WidgetSession, TMessageEvent extends WidgetMessageEvent, TEvent extends WidgetEvent<TMessageEvent>> extends EventTarget {
+declare class Widget<TSession extends WidgetSession, TMessageEvent extends WidgetMessageEvent, TEvent extends WidgetEvent<TMessageEvent>, TWidgetOptions extends WidgetOptions = WidgetOptions> extends EventTarget {
     #private;
     session: TSession;
     mountOptions?: WidgetMountIframeOptions;
-    options?: WidgetOptions;
+    options?: TWidgetOptions;
     [logSymbol]: {
         log: (message?: any, ...optionalParams: any[]) => void;
         warn: (message?: any, ...optionalParams: any[]) => void;
     };
-    constructor(session: TSession, options?: WidgetOptions);
+    constructor(session: TSession, options?: TWidgetOptions);
     on<T extends TEvent['detail']['type']>(event: T, listener: (event: Extract<TEvent, {
         detail: {
             type: T;

package/dist/widget.d.ts.map

@@ -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"}
+{"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

@@ -112,6 +112,7 @@ class Widget extends EventTarget {
             case 'load': {
                 const widgetInitMessage = {
                     ...this.session,
+                    options: this.options,
                     type: 'init'
                 };
                 this.#sendMessageToWidget(widgetInitMessage);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uphold/enterprise-widget-sdk-core",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,6 +29,9 @@
     ]
   },
   "dependencies": {
-    "@uphold/enterprise-widget-messaging-types": "^0.7.0"
+    "@uphold/enterprise-widget-messaging-types": "^0.8.0"
+  },
+  "devDependencies": {
+    "jsdom": "^27.4.0"
   }
 }