@notabene/javascript-sdk 2.0.0-next.2 → 2.0.0-next.20

package/src/utils/MessageEventManager.ts

@@ -1,29 +1,76 @@
 import { ComponentMessage, HostMessage } from '../types';
 
-export type MessageCallback = (message: ComponentMessage) => void;
+/**
+ * Callback function for handling component messages.
+ *
+ * @typeParam T - The type of data contained in the component message
+ * @param message - The message object containing the component data and type
+ * @public
+ */
 
-export class MessageEventManager {
-  private listeners: Map<string, Set<MessageCallback>> = new Map();
+export type MessageCallback<T> = (message: ComponentMessage<T>) => void;
+
+/**
+ * Manages message event communication through MessagePorts.
+ *
+ * This class handles bidirectional communication between components using MessagePorts,
+ * allowing subscription to specific message types and dispatching messages to registered callbacks.
+ *
+ * @typeParam T - The type of data contained in messages received from components
+ * @typeParam O - The type of data contained in messages sent from the host
+ */
+
+export class MessageEventManager<T, O> {
+  private listeners: Map<string, Set<MessageCallback<T>>> = new Map();
   private port?: MessagePort;
 
   constructor() {
     this.handleMessage = this.handleMessage.bind(this);
   }
 
+  /**
+   * Sets up the message port for communication.
+   *
+   * Initializes the MessagePort for receiving messages by setting up the message handler
+   * and starting the port.
+   *
+   * @param port - The MessagePort instance to use for communication
+   */
+
   setPort(port: MessagePort): void {
     this.port = port;
     this.port.onmessage = this.handleMessage;
     this.port.start();
   }
 
-  on(messageType: string, callback: MessageCallback): void {
+  /**
+   * Registers a callback for a specific message type.
+   *
+   * When messages of the specified type are received, the callback will be executed
+   * with the message data.
+   *
+   * @param messageType - The type of message to listen for
+   * @param callback - The callback function to execute when matching messages are received
+   */
+
+  on(messageType: string, callback: MessageCallback<T>): void {
     if (!this.listeners.has(messageType)) {
       this.listeners.set(messageType, new Set());
     }
     this.listeners.get(messageType)!.add(callback);
   }
 
-  off(messageType: string, callback: MessageCallback): void {
+  /**
+   * Removes a callback for a specific message type.
+   *
+   * If the callback is the last one registered for the message type,
+   * the message type entry will be removed entirely.
+   *
+   * @param messageType - The type of message to remove listener from
+   * @param callback - The callback function to remove
+   */
+
+  off(messageType: string, callback: MessageCallback<T>): void {
     const callbacks = this.listeners.get(messageType);
     if (callbacks) {
       callbacks.delete(callback);
@@ -33,8 +80,17 @@ export class MessageEventManager {
     }
   }
 
-  private handleMessage(event: MessageEvent): void {
-    console.log('received message', event.data);
+  /**
+   * Internal message handler for processing received messages.
+   *
+   * Validates incoming messages and dispatches them to registered callbacks
+   * based on the message type.
+   *
+   * @param event - The message event containing the component message
+   */
+
+  private handleMessage(event: MessageEvent<ComponentMessage<T>>): void {
+    // console.log('received message', event.data);
     const message = event.data;
     if (typeof message === 'object' && message !== null && 'type' in message) {
       const messageType = message.type as string;
@@ -45,11 +101,13 @@ export class MessageEventManager {
     }
   }
 
-  // Method to send messages through the port
-  send(message: HostMessage): void {
-    if (!this.port) {
-      throw new Error('No port set');
+  /**
+   * Sends a message through the message port
+   * @param message The host message to send
+   */
+  send(message: HostMessage<T, O>): void {
+    if (this.port) {
+      this.port.postMessage(message);
     }
-    this.port.postMessage(message);
   }
 }

package/src/utils/__tests__/MessageEventManager.test.ts

@@ -1,9 +1,14 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest';
-import { HMType, UpdateValue } from '../../types';
+import {
+  HMType,
+  type TransactionOptions,
+  type UpdateValue,
+  type Withdrawal,
+} from '../../types';
 import { MessageEventManager } from '../MessageEventManager';
 
 describe('MessageEventManager', () => {
-  let messageEventManager: MessageEventManager;
+  let messageEventManager: MessageEventManager<Withdrawal, TransactionOptions>;
   let mockPort: MessagePort;
 
   beforeEach(() => {
@@ -13,7 +18,10 @@ describe('MessageEventManager', () => {
       start: vi.fn(),
     } as unknown as MessagePort;
 
-    messageEventManager = new MessageEventManager();
+    messageEventManager = new MessageEventManager<
+      Withdrawal,
+      TransactionOptions
+    >();
   });
 
   describe('setPort', () => {
@@ -73,9 +81,9 @@ describe('MessageEventManager', () => {
     });
 
     it('should send messages through the port', () => {
-      const message: UpdateValue = {
+      const message: UpdateValue<Withdrawal, TransactionOptions> = {
         type: HMType.UPDATE,
-        value: { asset: 'USDC' },
+        value: { requestId: 'id' },
       };
       messageEventManager.send(message);
 

package/src/utils/arbitraries.ts

@@ -7,15 +7,20 @@ import {
   CAIP2_MATCHER,
 } from './caip';
 
+const LOCALE = new RegExp(/^[a-z]{2}(-[A-Z]{2})?$/);
+
 // Arbitraries
 export const arbitraryCAIP10 = (): fc.Arbitrary<CAIP10> =>
-  fc.stringMatching(CAIP10_MATCHER);
+  fc.stringMatching(CAIP10_MATCHER) as fc.Arbitrary<CAIP10>;
 
 export const arbitraryCAIP2 = (): fc.Arbitrary<CAIP2> =>
-  fc.stringMatching(CAIP2_MATCHER);
+  fc.stringMatching(CAIP2_MATCHER) as fc.Arbitrary<CAIP2>;
 
 export const arbitraryCAIP19 = (): fc.Arbitrary<CAIP19> =>
-  fc.stringMatching(CAIP19_MATCHER);
+  fc.stringMatching(CAIP19_MATCHER) as fc.Arbitrary<CAIP19>;
 
 export const arbitraryCAIP220 = (): fc.Arbitrary<CAIP220> =>
-  fc.stringMatching(CAIP220_MATCHER);
+  fc.stringMatching(CAIP220_MATCHER) as fc.Arbitrary<CAIP220>;
+
+export const arbitraryLocale = (): fc.Arbitrary<string> =>
+  fc.stringMatching(LOCALE) as fc.Arbitrary<string>;

package/.editorconfig

@@ -1,10 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-[*.{js,json,yml}]
-charset = utf-8
-indent_style = space
-indent_size = 2

package/.gitlab-ci.yml

@@ -1,85 +0,0 @@
-image: registry.gitlab.com/notabene/devops/build-node-18-image:latest
-
-variables:
-  NPM_TOKEN: ${CI_JOB_TOKEN}
-
-stages:
-  - install
-  - lint
-  - test
-  - build
-  - release
-
-install:
-  stage: install
-  artifacts:
-    paths:
-      - .yarn
-      - .pnp.cjs
-      - .pnp.loader.mjs
-  script:
-    - yarn
-
-lint:
-  stage: lint
-  needs:
-    - install
-  script:
-    - yarn lint
-
-test:
-  stage: test
-  needs:
-    - install
-  script:
-    - yarn test
-
-build:
-  stage: build
-  needs:
-    - install
-  script:
-    - yarn build
-  artifacts:
-    paths:
-      - dist
-
-publish-gitlab:
-  stage: release
-  needs:
-    - install
-    - build
-  variables:
-    GITLAB_USER_NAME: 'gitlab-ci'
-    GITLAB_USER_EMAIL: 'gitlab-ci@example.com'
-  before_script:
-    - git config --global user.email "$GITLAB_USER_EMAIL"
-    - git config --global user.name "$GITLAB_USER_NAME"
-    - |
-      {
-        echo "@${CI_PROJECT_ROOT_NAMESPACE}:registry=${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/npm/"
-        echo "${CI_API_V4_URL#https?}/projects/${CI_PROJECT_ID}/packages/npm/:_authToken=\${CI_JOB_TOKEN}"
-      } | tee -a .npmrc
-  script:
-    - yarn semantic-release
-  only:
-    - master
-
-publish-npm:
-  stage: release
-  when: manual
-  script:
-    - yarn npm publish
-  only:
-    - tags
-
-publish-npm-next:
-  stage: release
-  needs:
-    - install
-    - build
-  script:
-    - yarn npm version prerelease
-    - yarn npm publish --tag next
-  only:
-    - v2

package/.husky/commit-msg

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn commitlint -e "${1}"

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn lint-staged

package/.husky/pre-push

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn test --run

package/.prettierrc

@@ -1,4 +0,0 @@
-{
-    "semi": true,
-    "singleQuote": true
-  }

package/.releaserc.json

@@ -1,16 +0,0 @@
-{
-    "branches": ["master"],
-    "plugins": [
-      "@semantic-release/commit-analyzer",
-      "@semantic-release/release-notes-generator",
-      "@semantic-release/gitlab",
-      "@semantic-release/npm",
-      [
-        "@semantic-release/git",
-        {
-          "assets": ["package.json"],
-          "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-        }
-      ]
-    ]
-  }

package/.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
-}

package/.vscode/settings.json

@@ -1,11 +0,0 @@
-{
-  "search.exclude": {
-    "**/.yarn": true,
-    "**/.pnp.*": true
-  },
-  "typescript.enablePromptUseWorkspaceTsdk": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": "explicit"
-  }
-}