feat: interface

.eslintrc.json

@@ -3,32 +3,16 @@
     "browser": true,
     "es2021": true
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "prettier"
-  ],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": "latest",
     "sourceType": "module"
   },
-  "plugins": [
-    "@typescript-eslint"
-  ],
+  "plugins": ["@typescript-eslint"],
   "rules": {
-
-    "linebreak-style": [
-      "error",
-      "unix"
-    ],
-    "quotes": [
-      "error",
-      "single"
-    ],
-    "semi": [
-      "error",
-      "never"
-    ]
+    "linebreak-style": ["error", "unix"],
+    "quotes": ["error", "single"],
+    "semi": ["error", "never"]
   }
 }

.github/workflows/code-format.yml

@@ -0,0 +1,29 @@
+name: Code Format Check
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  format-check:
+    name: Prettier Format Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run Prettier check
+        run: yarn prettier --check .

.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 16
-          cache: "yarn"
+          cache: 'yarn'
 
       - name: yarn install
         run: yarn install --immutable
@@ -34,7 +34,7 @@ jobs:
         run: docker pull $IMG_NAME
 
       - name: run tests
-        timeout-minutes: 5
+        timeout-minutes: 10
         env:
           TESTCONTAINERS_NODE_IMG: ${{ env.IMG_NAME }}
         run: |

.gitignore

@@ -2,6 +2,6 @@
 yarn.lock
 yarn-error.log
 /.vscode
-
+/dist
 *.js
 *.d.ts

.prettierrc

@@ -1,6 +1,6 @@
 {
- "trailingComma": "es5",
- "semi": false,
- "singleQuote": true,
- "tabWidth": 2
+  "trailingComma": "es5",
+  "semi": false,
+  "singleQuote": true,
+  "tabWidth": 2
 }

LICENSE

@@ -1,7 +1,8 @@
 Copyright (c) 2022-2023, BOTLabs GmbH
-All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 
+All rights reserved.
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
-3. All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by the BOTLabs GmbH. 
-4. Neither the name of the BOTLabs GmbH nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+3. All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by the BOTLabs GmbH.
+4. Neither the name of the BOTLabs GmbH nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 THIS SOFTWARE IS PROVIDED BY BOTLABS GMBH  ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BOTLABS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

jest.config.js → jest.config.cjs

@@ -7,5 +7,11 @@ module.exports = {
   collectCoverageFrom: ['**/*/src/**/*.ts'],
   rootDir: 'src',
   coverageDirectory: 'coverage',
-  moduleDirectories: ['node_modules'],
+  moduleDirectories: ['dist', 'node_modules'],
+  globals: {
+    'ts-jest': {
+      tsconfig: 'tsconfig.cjs.json',
+    },
+  },
+  resolver: 'ts-jest-resolver',
 }

package.json

@@ -1,39 +1,35 @@
 {
   "name": "kilt-extension-api",
   "version": "0.1.0",
-  "main": "./index.js",
-  "types": "./index.d.ts",
-  "type": "commonjs",
+  "main": "./dist/cjs/index.js",
+  "types": "./dist/cjs/index.d.ts",
+  "type": "module",
   "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "default": "./index.js"
-    },
-    "./wellKnownDidConfiguration": {
-      "types": "./wellKnownDidConfiguration/index.d.ts",
-      "default": "./wellKnownDidConfiguration/index.js"
-    },
-    "./types": {
-      "types": "./types/index.d.ts"
-    }
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.js",
+    "default": "./dist/cjs/index.js"
   },
   "author": "KILT <[email protected]>",
   "license": "BSD-4-Clause",
   "scripts": {
     "lint": "eslint --ext .ts .",
-    "build": "tsc -p tsconfig.build.json",
+    "build": "yarn build:cjs && yarn build:esm",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.json",
     "clean": "exec git clean -xf -e 'node_modules' '*'",
-    "test": "jest test"
+    "test": "jest test --detectOpenHandles --forceExit"
   },
   "dependencies": {
-    "@kiltprotocol/sdk-js": "^0.33.1",
-    "@kiltprotocol/types": "^0.33.1",
-    "@kiltprotocol/vc-export": "^0.33.1",
+    "@kiltprotocol/sdk-js": "^0.34.0",
+    "@kiltprotocol/types": "^0.34.0",
+    "@kiltprotocol/vc-export": "^0.34.0",
     "@polkadot/keyring": "^12.3.2",
     "@polkadot/util": "^12.3.2",
+    "prettier": "^3.0.1",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
+    "ts-jest-resolver": "^2.0.1",
     "@polkadot/util-crypto": "^12.3.2",
     "@types/jest": "^28.0.0",
     "@types/node": "^18.8.2",
@@ -52,5 +48,6 @@
   },
   "bin": {
     "createDidConfig": "./cli/createDidConfig.js"
-  }
+  },
+  "repository": {}
 }

src/cli/createDidConfig.ts

@@ -1,5 +1,12 @@
 #!/usr/bin/env node
 
+/**
+ * Copyright (c) 2018-2023, BOTLabs GmbH.
+ *
+ * This source code is licensed under the BSD 4-Clause "Original" license
+ * found in the LICENSE file in the root directory of this source tree.
+ */
+
 import { Credential, Did, connect, disconnect } from '@kiltprotocol/sdk-js'
 import { DidResourceUri, DidUri, ICredentialPresentation, SignCallback } from '@kiltprotocol/types'
 
@@ -9,8 +16,8 @@ import { u8aEq } from '@polkadot/util'
 import { readFile, writeFile } from 'fs/promises'
 import yargs from 'yargs/yargs'
 
-import { didConfigResourceFromCredential, createCredential } from '../wellKnownDidConfiguration'
-import { DidConfigResource } from '../types'
+import { didConfigResourceFromCredential, createCredential } from '../wellKnownDidConfiguration/index.js'
+import { DidConfigResource } from '../types/index.js'
 
 type KeyType = 'sr25519' | 'ed25519' | 'ecdsa'
 

src/getExtension/index.ts

@@ -1,4 +1,4 @@
-import { ApiWindow, InjectedWindowProvider, PubSubSessionV1, PubSubSessionV2 } from '../types'
+import { ApiWindow, InjectedWindowProvider, PubSubSessionV1, PubSubSessionV2 } from '../types/index.js'
 
 // cross-environment reference to global object (aka 'window' in browser environments)
 const apiWindow = globalThis as Window & ApiWindow

src/index.ts

@@ -1,3 +1,4 @@
-export { getExtensions, watchExtensions, initializeKiltExtensionAPI } from './getExtension'
-export * as Message from './messaging'
-export * as Quote from './quote'
+export * as Message from './messaging/index.js'
+export * as Quote from './quote/index.js'
+
+export { getExtensions, watchExtensions, initializeKiltExtensionAPI } from './getExtension/index.js'

src/messaging/CredentialApiMessageType.ts

@@ -17,10 +17,12 @@ import {
   isRejectAttestation,
   isSubmitCredential,
   isIRequestCredential,
-} from '../utils'
-import { verifyMessageEnvelope } from './MessageEnvelope'
-import * as MessageError from './Error'
-import type { IMessage, CredentialApiMessageBody } from '../types'
+  isIRequestPayment,
+  isIConfirmPayment,
+} from '../utils/index.js'
+import * as MessageError from './Error.js'
+import type { IMessage, CredentialApiMessageBody } from '../types/index.js'
+import { verifyMessageEnvelope } from './MessageEnvelope.js'
 
 /**
  * Checks if the message body is well-formed.
@@ -67,6 +69,8 @@ export function assertKnownMessageBody(message: IMessage): void {
         throw new MessageError.SignatureMalformedError()
       }
     })
+  } else if (isIRequestPayment(message) || isIConfirmPayment(message)) {
+    return
   } else {
     throw new MessageError.UnknownMessageBodyTypeError()
   }

src/messaging/Error.ts

@@ -15,6 +15,7 @@ export declare class UnknownMessageBodyTypeError extends MessageError {}
 export declare class DecodingMessageError extends MessageError {}
 export declare class CTypeUnknownPropertiesError extends MessageError {}
 export declare class InvalidDidFormatError extends MessageError {}
+export declare class KeyError extends MessageError {}
 export declare class DidError extends MessageError {
   constructor(context?: string, type?: string)
 }

src/messaging/MessageEnvelope.ts

@@ -7,10 +7,10 @@
 
 import { DecryptCallback, DidResolveKey, DidResourceUri, EncryptCallback } from '@kiltprotocol/types'
 import * as Did from '@kiltprotocol/did'
-import * as MessageError from './Error'
+import * as MessageError from './Error.js'
 import { hexToU8a, stringToU8a, u8aToHex, u8aToString } from '@polkadot/util'
 
-import type { IEncryptedMessage, IEncryptedMessageContents, IMessage } from '../types'
+import type { IEncryptedMessage, IEncryptedMessageContents, IMessage } from '../types/index.js'
 
 /**
  * Checks if the message object is well-formed.
@@ -94,14 +94,17 @@ export async function decrypt(
 
   verifyMessageEnvelope(decrypted)
   if (sender !== senderKeyDetails.controller) {
-    throw new MessageError.IdentityMismatchError('Encryption key', 'Sender')
+    throw new MessageError.IdentityMismatchError(
+      'Encryption key',
+      `Sender: ${sender}, found: ${senderKeyDetails.controller}`
+    )
   }
 
   return decrypted
 }
 
 /**
- * Encrypts the [[Message]] as a string. This can be reversed with [[decrypt]].
+ * Encrypts the [[Message]] as a string.
  *
  * @param message The message to encrypt.
  * @param encryptCallback The callback to encrypt with the secret key.

src/messaging/index.ts

@@ -12,7 +12,7 @@
  * Messages are encrypted using authenticated encryption: the two parties authenticate to each other, but the message authentication provides repudiation possibilities.
  */
 
-export { fromBody } from './utils'
-export { encrypt, decrypt } from './MessageEnvelope'
-export { assertKnownMessage } from './CredentialApiMessageType'
-export * from './Error'
+export { fromBody } from './utils.js'
+export { encrypt, decrypt } from './MessageEnvelope.js'
+export { assertKnownMessage } from './CredentialApiMessageType.js'
+export * from './Error.js'