@interop/did-web-resolver 3.0.0 → 4.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@interop/did-web-resolver",
   "description": "A did:web method Decentralized Identifier (DID) resolver for the did-io library.",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "author": {
     "name": "Dmitri Zagidulin",
     "url": "https://github.com/dmitrizagidulin/"
@@ -14,92 +14,80 @@
   "homepage": "https://github.com/interop-alliance/did-web-driver",
   "bugs": "https://github.com/interop-alliance/did-web-driver/issues",
   "scripts": {
-    "rollup": "rollup -c rollup.config.js",
-    "build": "npm run clear && npm run rollup && ./build-dist.sh",
-    "clear": "rimraf dist/ && mkdir dist",
+    "build": "npm run clear && tsc -d && tsc -p tsconfig.esm.json",
+    "clear": "rimraf dist/*",
+    "lint": "ts-standard --fix --project tsconfig.spec.json",
     "prepare": "npm run build",
     "rebuild": "npm run clear && npm run build",
-    "test": "npm run standard && npm run test-node",
-    "test-node": "cross-env NODE_ENV=test mocha -r esm --preserve-symlinks -t 10000 test/**/*.spec.js",
-    "test-karma": "karma start test/karma.conf.js",
-    "nyc": "cross-env NODE_ENV=test nyc npm run test-node",
-    "standard": "standard --fix"
+    "test": "npm run lint && npm run test-node",
+    "test-node": "cross-env NODE_ENV=test TS_NODE_PROJECT=tsconfig.spec.json TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha -r ts-node/register --project tsconfig.spec.json 'test/*.ts'"
   },
   "files": [
     "dist",
     "src",
-    "rollup.config.js",
-    "build-dist.sh",
     "README.md",
     "LICENSE"
   ],
-  "main": "dist/index.js",
+  "main": "dist/src/index.js",
   "module": "dist/esm/index.js",
-  "exports": {
-    ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/esm/index.js"
-    },
-    "./package.json": "./package.json"
-  },
+  "browser": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
   "dependencies": {
-    "@digitalcredentials/bnid": "^2.1.1",
+    "@digitalbazaar/http-client": "digitalcredentials/http-client#react-native",
+    "@digitalcredentials/bnid": "^3.0.1",
     "@digitalcredentials/did-io": "^1.0.2",
-    "@digitalcredentials/http-client": "^1.2.2",
     "did-context": "^3.1.1",
     "ed25519-signature-2020-context": "^1.1.0",
-    "whatwg-url": "^11.0.0",
+    "whatwg-url": "^14.0.0",
     "x25519-key-agreement-2020-context": "^1.0.0"
   },
+  "resolutions": {
+    "@typescript-eslint/typescript-estree": "^6.1.6"
+  },
   "devDependencies": {
-    "@babel/core": "^7.16.7",
-    "@babel/plugin-transform-modules-commonjs": "^7.16.7",
-    "@babel/plugin-transform-runtime": "^7.16.7",
-    "@babel/preset-env": "^7.16.7",
-    "@babel/runtime": "^7.16.7",
     "@digitalcredentials/ed25519-verification-key-2020": "^3.2.2",
     "@digitalcredentials/x25519-key-agreement-key-2020": "^2.0.2",
-    "babel-loader": "^8.2.3",
-    "chai": "^4.3.4",
+    "@types/chai": "^4.3.5",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.4.6",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "chai": "^4.3.7",
     "cross-env": "^7.0.3",
     "crypto-ld": "^6.0.0",
-    "dirty-chai": "^2.0.1",
-    "esm": "^3.2.25",
-    "karma": "^6.3.9",
-    "karma-babel-preprocessor": "^8.0.1",
-    "karma-chai": "^0.1.0",
-    "karma-chrome-launcher": "^3.1.0",
-    "karma-mocha": "^2.0.1",
-    "karma-mocha-reporter": "^2.2.5",
-    "karma-sourcemap-loader": "^0.3.8",
-    "karma-webpack": "^5.0.0",
-    "mocha": "^8.4.0",
-    "nyc": "^15.1.0",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.62.0",
-    "sinon": "^12.0.1",
-    "standard": "^16.0.4",
-    "webpack": "^5.65.0"
+    "eslint": "^8.46.0",
+    "mocha": "^10.2.0",
+    "rimraf": "^5.0.1",
+    "ts-node": "^10.9.1",
+    "ts-standard": "^12.0.2",
+    "typescript": "5.2.2"
+  },
+  "publishConfig": {
+    "access": "public"
   },
-  "nyc": {
-    "reporter": [
-      "html",
-      "text-summary"
+  "mocha": {
+    "require": "ts-node/register",
+    "extension": [
+      "ts"
     ],
-    "cache": true
+    "spec": "test/**/*.ts"
   },
-  "standard": {
+  "ts-standard": {
+    "ignore": [
+      "dist"
+    ],
     "globals": [
-      "after",
-      "afterEach",
-      "before",
-      "beforeEach",
-      "describe",
       "it",
-      "require"
+      "describe",
+      "beforeEach"
     ]
   },
   "engines": {
-    "node": ">=12.0"
+    "node": ">=18.0"
+  },
+  "standard": {
+    "globals": [
+      "it"
+    ]
   }
 }

package/src/{DidWebResolver.js → DidWebResolver.ts}

@@ -1,8 +1,9 @@
-import { httpClient } from '@digitalcredentials/http-client'
+/* eslint-disable @typescript-eslint/strict-boolean-expressions */
+import { httpClient } from '@digitalbazaar/http-client'
 import * as didIo from '@digitalcredentials/did-io'
-import ed25519Context from 'ed25519-signature-2020-context'
-import x25519Context from 'x25519-key-agreement-2020-context'
-import didContext from 'did-context'
+import * as ed25519Context from 'ed25519-signature-2020-context'
+import * as x25519Context from 'x25519-key-agreement-2020-context'
+import * as didContext from 'did-context'
 import { decodeSecretKeySeed } from '@digitalcredentials/bnid'
 import { URL } from 'whatwg-url'
 
@@ -16,7 +17,7 @@ const DEFAULT_KEY_MAP = {
   keyAgreement: 'X25519KeyAgreementKey2020'
 }
 
-export function didFromUrl ({ url } = {}) {
+export function didFromUrl ({ url }: { url?: string } = {}): string {
   if (!url) {
     throw new TypeError('Cannot convert url to did, missing url.')
   }
@@ -31,29 +32,37 @@ export function didFromUrl ({ url } = {}) {
     throw new TypeError(`Invalid url: "${url}".`)
   }
 
-  const { host, pathname } = parsedUrl
-
+  let { host, pathname } = parsedUrl
   let pathComponent = ''
-  if (pathname && pathname !== '/' && pathname !== '/.well-known/did.json') {
+
+  const didJsonSuffix = '/did.json'
+  const wellKnownSuffix = '/.well-known'
+
+  if (pathname?.endsWith(didJsonSuffix)) {
+    pathname = pathname.substring(0, pathname.length - didJsonSuffix.length)
+  }
+
+  if (pathname?.endsWith(wellKnownSuffix)) {
+    pathname = pathname.substring(0, pathname.length - wellKnownSuffix.length)
+  }
+
+  if (pathname && pathname !== '/') {
     pathComponent = pathname.split('/').map(encodeURIComponent).join(':')
   }
 
   return 'did:web:' + encodeURIComponent(host) + pathComponent
 }
 
-export function urlFromDid ({ did } = {}) {
-  if (!did) {
-    throw new TypeError('Cannot convert did to url, missing did.')
-  }
-  if (!did.startsWith('did:web:')) {
-    throw new TypeError(`DID Method not supported: "${did}".`)
+export function urlFromDid ({ did }: { did: string | undefined }): string {
+  if (!did?.startsWith('did:web:')) {
+    throw new TypeError(`DID Method not supported: "${did ?? ''}".`)
   }
 
   const [didUrl, hashFragment] = did.split('#')
   // eslint-disable-next-line no-unused-vars
   // const [didResource, query] = didUrl.split('?')
 
-  // eslint-disable-next-line no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const [_did, _web, urlNoProtocol, ...pathFragments] = didUrl.split(':')
 
   if (urlNoProtocol.includes('/')) {
@@ -108,8 +117,11 @@ export function urlFromDid ({ did } = {}) {
  *   DID Document initialized with keys, as well as the map of the corresponding
  *   key pairs (by key id).
  */
-export async function initKeys ({ didDocument, cryptoLd, keyMap } = {}) {
-  const doc = { ...didDocument }
+export async function initKeys (
+  { didDocument, cryptoLd, keyMap }:
+  { didDocument?: object, cryptoLd?: any, keyMap?: any } = {}
+): Promise<{ didDocument: object, keyPairs: Map<string, any> }> {
+  const doc: any = { ...didDocument }
   if (!doc.id) {
     throw new TypeError(
       'DID Document "id" property is required to initialize keys.')
@@ -144,13 +156,19 @@ export async function initKeys ({ didDocument, cryptoLd, keyMap } = {}) {
 }
 
 export class DidWebResolver {
+  public cryptoLd: any
+  public keyMap: object
+  public method: string
+  public logger: any
+
   /**
    * @param cryptoLd {CryptoLD}
    * @param keyMap {object}
    * @param [logger] {object} Logger object (with .log, .error, .warn,
    *   etc methods).
    */
-  constructor ({ cryptoLd, keyMap = DEFAULT_KEY_MAP, logger = console } = {}) {
+  constructor ({ cryptoLd, keyMap = DEFAULT_KEY_MAP, logger = console }:
+  { cryptoLd?: any, keyMap?: object, logger?: any } = {}) {
     this.method = 'web' // did:web:... (used for didIo resolver harness)
     this.cryptoLd = cryptoLd
     this.keyMap = keyMap
@@ -171,18 +189,23 @@ export class DidWebResolver {
    * Either an `id` or a `url` is required:
    * @param [id] {string} - A did:web DID. If absent, will be converted from url
    * @param [url] {string}
+   * @param [seed] {string|Uint8Array}
    *
    * @param [keyMap] {object} A hashmap of key types by purpose.
    *
+   * @param cryptoLd
    * @parma [cryptoLd] {object} CryptoLD instance with support for supported
    *   crypto suites installed.
    *
-   * @returns {Promise<{didDocument: object, keyPairs: Map,
+   * @returns {Promise<{didDocument: object, keyPairs: object,
    *   methodFor: Function}>} Resolves with the generated DID Document, along
    *   with the corresponding key pairs used to generate it (for storage in a
    *   KMS).
    */
-  async generate ({ id, url, seed, keyMap, cryptoLd = this.cryptoLd } = {}) {
+  async generate (
+    { id, url, seed, keyMap, cryptoLd = this.cryptoLd }:
+    { id?: string, url?: string, seed?: string | Uint8Array, keyMap?: any, cryptoLd?: any } = {}):
+    Promise<{ didDocument: any, keyPairs: object, methodFor: Function }> {
     if (!id && !url) {
       throw new TypeError('A "url" or an "id" parameter is required.')
     }
@@ -192,7 +215,7 @@ export class DidWebResolver {
       )
     }
 
-    const did = id || didFromUrl({ url })
+    const did = id ?? didFromUrl({ url })
 
     if (seed) {
       const keyPair = await _keyPairFromSecretSeed({
@@ -213,13 +236,13 @@ export class DidWebResolver {
       id: did
     }
 
-    const result = await initKeys({ didDocument, cryptoLd, keyMap })
+    const result: any = await initKeys({ didDocument, cryptoLd, keyMap })
     const keyPairs = result.keyPairs
     didDocument = result.didDocument
 
     // Convenience function that returns the public/private key pair instance
     // for a given purpose (authentication, assertionMethod, keyAgreement, etc).
-    const methodFor = ({ purpose }) => {
+    const methodFor = ({ purpose }: { purpose: string }): any => {
       const { id: methodId } = didIo.findVerificationMethod({
         doc: didDocument, purpose
       })
@@ -247,8 +270,8 @@ export class DidWebResolver {
    *
    * @returns {Promise<object>} Plain parsed JSON object of the DID Document.
    */
-  async get ({ did, url, agent, logger = this.logger }) {
-    const didUrl = url || urlFromDid({ did })
+  async get ({ did, url, agent, logger = this.logger }: { did?: string | undefined, url?: string | undefined, agent?: any, logger?: any }): Promise<object> {
+    const didUrl = url ?? urlFromDid({ did })
     if (!didUrl) {
       throw new TypeError('A DID or a URL is required.')
     }
@@ -260,11 +283,12 @@ export class DidWebResolver {
       logger.info(`Fetching "${urlAuthority}" via http client.`)
       const result = await httpClient.get(urlAuthority, { agent })
       didDocument = result.data
-    } catch (e) {
+    } catch (e: any) {
       // status is HTTP status code
       // data is JSON error from the server if available
       const { data, status } = e
-      logger.error(`Http ${status} error:`, data)
+      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+      logger.error(`Http ${status ?? ''} error:`, data)
       throw e
     }
     if (didDocument && keyIdFragment) {
@@ -308,14 +332,7 @@ export class DidWebResolver {
    * @returns {object} Returns the public key object (obtained from the DID
    *   Document), without a `@context`.
    */
-  publicMethodFor ({ didDocument, purpose } = {}) {
-    if (!didDocument) {
-      throw new TypeError('The "didDocument" parameter is required.')
-    }
-    if (!purpose) {
-      throw new TypeError('The "purpose" parameter is required.')
-    }
-
+  publicMethodFor ({ didDocument, purpose }: { didDocument: any, purpose: string }): any {
     const method = didIo.findVerificationMethod({ doc: didDocument, purpose })
     if (!method) {
       throw new Error(`No verification method found for purpose "${purpose}"`)
@@ -332,7 +349,7 @@ export class DidWebResolver {
  *
  * @return {Promise<LDKeyPair>}
  */
-async function _keyPairFromSecretSeed ({ seed, controller, cryptoLd } = {}) {
+async function _keyPairFromSecretSeed ({ seed, controller, cryptoLd }: { seed: string | Uint8Array, controller?: string, cryptoLd?: any }): Promise<any> {
   let seedBytes
   if (typeof seed === 'string') {
     // Currently only supports base58 multibase / identity multihash encoding.

package/src/declarations.d.ts

@@ -0,0 +1,11 @@
+declare module '@digitalbazaar/http-client'
+declare module '@digitalcredentials/did-io'
+declare module 'ed25519-signature-2020-context'
+declare module 'x25519-key-agreement-2020-context'
+declare module 'did-context'
+declare module '@digitalcredentials/bnid'
+declare module '@digitalcredentials/ed25519-verification-key-2020'
+declare module '@digitalcredentials/x25519-key-agreement-key-2020'
+declare module 'crypto-ld'
+declare module 'whatwg-url'
+declare module 'dirty-chai'

package/src/{index.js → index.ts}

@@ -1,7 +1,7 @@
 
-import { DidWebResolver, didFromUrl, urlFromDid } from './DidWebResolver.js'
+import { DidWebResolver, didFromUrl, urlFromDid } from './DidWebResolver'
 
-const driver = options => {
+const driver = (options: { cryptoLd?: any, keyMap?: object | undefined, logger?: any } | undefined): DidWebResolver => {
   return new DidWebResolver(options)
 }
 

package/build-dist.sh

@@ -1,14 +0,0 @@
-mkdir ./dist/esm
-cat >dist/esm/index.js <<!EOF
-import cjsModule from '../index.js';
-export const driver = cjsModule.driver;
-export const DidWebResolver = cjsModule.DidWebResolver;
-export const didFromUrl = cjsModule.didFromUrl;
-export const urlFromDid = cjsModule.urlFromDid;
-!EOF
-
-cat >dist/esm/package.json <<!EOF
-{
-  "type": "module"
-}
-!EOF