@notabene/javascript-sdk 1.34.0 → 2.0.0-next.11

package/src/utils/MessageEventManager.ts

@@ -0,0 +1,54 @@
+import { ComponentMessage, HostMessage } from '../types';
+
+export type MessageCallback = (message: ComponentMessage) => void;
+
+export class MessageEventManager {
+  private listeners: Map<string, Set<MessageCallback>> = new Map();
+  private port?: MessagePort;
+
+  constructor() {
+    this.handleMessage = this.handleMessage.bind(this);
+  }
+
+  setPort(port: MessagePort): void {
+    this.port = port;
+    this.port.onmessage = this.handleMessage;
+    this.port.start();
+  }
+
+  on(messageType: string, callback: MessageCallback): void {
+    if (!this.listeners.has(messageType)) {
+      this.listeners.set(messageType, new Set());
+    }
+    this.listeners.get(messageType)!.add(callback);
+  }
+
+  off(messageType: string, callback: MessageCallback): void {
+    const callbacks = this.listeners.get(messageType);
+    if (callbacks) {
+      callbacks.delete(callback);
+      if (callbacks.size === 0) {
+        this.listeners.delete(messageType);
+      }
+    }
+  }
+
+  private handleMessage(event: MessageEvent): 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;
+      const callbacks = this.listeners.get(messageType);
+      if (callbacks) {
+        callbacks.forEach((callback) => callback(message));
+      }
+    }
+  }
+
+  // Method to send messages through the port
+  send(message: HostMessage): void {
+    if (this.port) {
+      this.port.postMessage(message);
+    }
+  }
+}

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

@@ -0,0 +1,95 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { HMType, UpdateValue } from '../../types';
+import { MessageEventManager } from '../MessageEventManager';
+
+describe('MessageEventManager', () => {
+  let messageEventManager: MessageEventManager;
+  let mockPort: MessagePort;
+
+  beforeEach(() => {
+    mockPort = {
+      onmessage: null,
+      postMessage: vi.fn(),
+      start: vi.fn(),
+    } as unknown as MessagePort;
+
+    messageEventManager = new MessageEventManager();
+  });
+
+  describe('setPort', () => {
+    beforeEach(() => {
+      messageEventManager.setPort(mockPort);
+    });
+
+    it('should start the port when initialized', () => {
+      expect(mockPort.start).toHaveBeenCalled();
+    });
+
+    it('should subscribe and receive messages of a specific type', () => {
+      const readyHandler = vi.fn();
+      messageEventManager.on('ready', readyHandler);
+
+      const readyMessage = { type: 'ready' };
+      mockPort.onmessage!({ data: readyMessage } as MessageEvent);
+
+      expect(readyHandler).toHaveBeenCalledWith(readyMessage);
+    });
+
+    it('should not call handlers for different message types', () => {
+      const updateHandler = vi.fn();
+      const errorHandler = vi.fn();
+      messageEventManager.on('update', updateHandler);
+      messageEventManager.on('error', errorHandler);
+
+      const errorMessage = { type: 'error', message: 'Something went wrong' };
+      mockPort.onmessage!({ data: errorMessage } as MessageEvent);
+
+      expect(updateHandler).not.toHaveBeenCalled();
+      expect(errorHandler).toHaveBeenCalledWith(errorMessage);
+    });
+
+    it('should unsubscribe handlers', () => {
+      const updateHandler = vi.fn();
+      messageEventManager.on('update', updateHandler);
+      messageEventManager.off('update', updateHandler);
+
+      const updateMessage = { type: 'update', data: { foo: 'bar' } };
+      mockPort.onmessage!({ data: updateMessage } as MessageEvent);
+
+      expect(updateHandler).not.toHaveBeenCalled();
+    });
+
+    it('should allow multiple subscribers for the same message type', () => {
+      const updateHandler1 = vi.fn();
+      const updateHandler2 = vi.fn();
+      messageEventManager.on('update', updateHandler1);
+      messageEventManager.on('update', updateHandler2);
+
+      const updateMessage = { type: 'update', data: { foo: 'bar' } };
+      mockPort.onmessage!({ data: updateMessage } as MessageEvent);
+
+      expect(updateHandler1).toHaveBeenCalledWith(updateMessage);
+      expect(updateHandler2).toHaveBeenCalledWith(updateMessage);
+    });
+
+    it('should send messages through the port', () => {
+      const message: UpdateValue = {
+        type: HMType.UPDATE,
+        value: { requestId: 'id' },
+      };
+      messageEventManager.send(message);
+
+      expect(mockPort.postMessage).toHaveBeenCalledWith(message);
+    });
+
+    it('should ignore messages without a type', () => {
+      const handler = vi.fn();
+      messageEventManager.on('update', handler);
+
+      const invalidMessage = { data: 'no type field' };
+      mockPort.onmessage!({ data: invalidMessage } as MessageEvent);
+
+      expect(handler).not.toHaveBeenCalled();
+    });
+  });
+});

package/src/utils/arbitraries.ts

@@ -0,0 +1,26 @@
+import fc from 'fast-check';
+import type { CAIP10, CAIP19, CAIP2, CAIP220 } from '../types';
+import {
+  CAIP10_MATCHER,
+  CAIP19_MATCHER,
+  CAIP220_MATCHER,
+  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) as fc.Arbitrary<CAIP10>;
+
+export const arbitraryCAIP2 = (): fc.Arbitrary<CAIP2> =>
+  fc.stringMatching(CAIP2_MATCHER) as fc.Arbitrary<CAIP2>;
+
+export const arbitraryCAIP19 = (): fc.Arbitrary<CAIP19> =>
+  fc.stringMatching(CAIP19_MATCHER) as fc.Arbitrary<CAIP19>;
+
+export const arbitraryCAIP220 = (): fc.Arbitrary<CAIP220> =>
+  fc.stringMatching(CAIP220_MATCHER) as fc.Arbitrary<CAIP220>;
+
+export const arbitraryLocale = (): fc.Arbitrary<string> =>
+  fc.stringMatching(LOCALE) as fc.Arbitrary<string>;

package/src/utils/caip.ts

@@ -0,0 +1,16 @@
+// Regexes
+export const ACCOUNT_ADDRESS_REGEX = '[-.%a-zA-Z0-9]{1,128}';
+export const CAIP2_REGEX = '[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}';
+export const CAIP10_REGEX = `^${CAIP2_REGEX}:${ACCOUNT_ADDRESS_REGEX}$`;
+export const CAIP19_REGEX = `^${CAIP2_REGEX}/[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}(/[-.%a-zA-Z0-9]{1,78})?$`;
+export const CAIP220_REGEX = `^${CAIP2_REGEX}:[block:]?tx/[-.%a-zA-Z0-9]{1,128}$`;
+export const CRYPTO_SYMBOL_REGEX = '^[A-Z0-9]{2,10}$';
+export const DTI_REGEX = '^[A-Za-z0-9]{10}$';
+export const COMBINED_ASSET_REGEX = `(${CRYPTO_SYMBOL_REGEX})|(${CAIP19_REGEX})|(${DTI_REGEX})`;
+
+// Matchers
+export const CAIP2_MATCHER = new RegExp(CAIP2_REGEX);
+export const CAIP10_MATCHER = new RegExp(CAIP10_REGEX);
+export const CAIP19_MATCHER = new RegExp(CAIP19_REGEX);
+export const CAIP220_MATCHER = new RegExp(CAIP220_REGEX);
+export const COMBINED_ASSET_MATCHER = new RegExp(COMBINED_ASSET_REGEX);

package/src/utils/urls.ts

@@ -0,0 +1,15 @@
+export function encodeObjectToFragment(obj: any) {
+  return Object.entries(obj)
+    .map(([key, value]) => {
+      if (!(key && value)) return undefined;
+      const encodedKey = encodeURIComponent(key);
+      const encodedValue = encodeURIComponent(
+        typeof value === 'object'
+          ? JSON.stringify(value)
+          : (value as string | number | boolean),
+      );
+      return `${encodedKey}=${encodedValue}`;
+    })
+    .filter((entry) => !!entry)
+    .join('&');
+}

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/.envrc.template

@@ -1 +0,0 @@
-export GITLAB_TOKEN="your-gitlab-token"

package/.eslintignore

@@ -1,3 +0,0 @@
-dist
-.eslintrc.js
-jest.config.js

package/.eslintrc.js

@@ -1,13 +0,0 @@
-module.exports = {
-  root: true,
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:prettier/recommended',
-  ],
-  rules: {
-    '@typescript-eslint/ban-ts-comment': 'off',
-  },
-};

package/.gitlab-ci.yml

@@ -1,74 +0,0 @@
-image: registry.gitlab.com/notabene/devops/build-node-16-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

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

package/.nvmrc

@@ -1 +0,0 @@
-v16

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/.tool-versions

@@ -1,3 +0,0 @@
-nodejs 16.16.0
-yarn 1.22.19
-direnv 2.32.1

package/.vscode/extensions.json

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

package/.vscode/settings.json

@@ -1,11 +0,0 @@
-{
-  "search.exclude": {
-    "**/.yarn": true,
-    "**/.pnp.*": true
-  },
-  "eslint.nodePath": ".yarn/sdks",
-  "prettier.prettierPath": ".yarn/sdks/prettier/index.js",
-  "typescript.tsdk": ".yarn/sdks/typescript/lib",
-  "typescript.enablePromptUseWorkspaceTsdk": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode"
-}

package/CODEOWNERS

@@ -1 +0,0 @@
-* @ajunge @brunosimplicio @dw1284 @richardcrosby @david1250 @marieh_mai @timothy4915912 @graham9961840