Switch to @digitalbazaar/did-io framework (#1)

* Switch to using @digitalbazaar/did-io
* Upgrade dependencies
* Add github workflows

Author: wesbiggs

.github/ISSUE_TEMPLATE/BUG_Issue.md

@@ -0,0 +1,23 @@
+---
+    name: Bug Report
+    about: Report an issue found in the Frequency Schemas
+    title: ""
+    labels: ""
+    assignees: ""
+---
+Thanks for reporting an issue!
+
+### Steps to reproduce
+Tell us how to reproduce this issue.
+
+### Expected behaviour
+Tell us what should happen
+
+### Actual behaviour
+Tell us what happens instead
+
+### Any logs, error output, etc?
+...
+
+### Any other comments?
+...

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Issue Template
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+Problem
+=======
+problem statement
+
+Closes: <!-- GitHub Issue  ->
+
+Solution
+========
+What I/we did to solve this problem
+
+with @pairperson1
+
+Double Checks:
+---------------
+- [] Did you update the changelog?
+- [] Do you have good documentation on exported methods?
+
+Change summary:
+---------------
+* Tidy, well formulated commit message
+* Another great commit message
+* Something else I/we did
+
+Steps to Verify:
+----------------
+1. A setup step / beginning state
+1. What to do next
+1. Any other instructions
+1. Expected behavior
+1. Suggestions for testing

.github/workflows/main.yml

@@ -0,0 +1,35 @@
+name: Tests CI
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ '**' ]
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: 'https://registry.npmjs.org'
+          cache-dependency-path: package-lock.json
+
+      - name: Install 💾
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Test
+        run: npm run test
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish Dry Run
+        run: npm publish --dry-run
+        working-directory: dist

.github/workflows/node.js.yml

@@ -0,0 +1,33 @@
+name: Release Package
+on:
+  release:
+    types: [ released ]
+jobs:
+  publish-to-npm:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: 'https://registry.npmjs.org'
+          cache-dependency-path: package-lock.json
+
+      - name: Install 💾
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Version ⬆️
+        run: npm version --new-version ${{ github.event.release.tag_name }} --no-git-tag-version
+        working-directory: dist
+
+      - name: Publish 🚂
+        run: npm publish --tag latest
+        working-directory: dist
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}

.github/workflows/release.yml

@@ -1,62 +1,75 @@
 # Overview
 
 This package implements a generic resolver for the `dsnp` DID method (that is, DIDs of the form `did:dsnp:123456`, where `123456` is a [DSNP User Id](https://spec.dsnp.org/DSNP/Identifiers.html#dsnp-user-id) in decimal format).
-This resolver should be used with one or more plugins for specific DSNP systems (see below).
+This resolver must be used with one or more plugins for specific DSNP systems (see below).
 
 # Usage
 
-This package follows the conventions described in the [`did-resolver`](https://github.com/decentralized-identity/did-resolver) package and exposes a `getResolver()` function which returns a mapping from the `dsnp` DID method to a resolver function.
+This package follows the conventions described in the [`@digitalbazaar/did-io`](https://github.com/digitalbazaar/did-io) package and exposes a `driver()` function which returns an object with a `get(options)` method.
+Pass an array of DSNPResolver objects to the `driver()` method.
 
 ## Usage for DSNP DID method only
 
 ```
-import { Resolver } from "did-resolver";
-import dsnp from "@dsnp/did-resolver"; 
-import "dsnp-did-resolver-plugin-foo"; // See below for known plugins
+import { CachedResolver } from "@digitalbazaar/did-io";
+import didDsnp from "@dsnp/did-resolver";
+import { FooResolver} from "dsnp-did-resolver-plugin-foo"; // See below for known plugins
 // ... additional dsnp-did-resolver plugins if needed
 
-const resolver = new Resolver(dsnp.getResolver());
+const resolver = new CachedResolver();
+resolver.use(didDsnp.driver([ new FooResolver() ]));
+
 const myDid = "did:dsnp:123456";
-const result = await resolver.resolve(myDid);
+const result = await resolver.get({ did: myDid });
 console.log(JSON.stringify(result, null, 2));
 ```
 
 ## Usage with other DID method resolvers
 
-The Resolver constructor can combine resolvers for multiple DID methods as described in the `did-resolver` [documentation](https://github.com/decentralized-identity/did-resolver#readme).
-For example, if you also want to be able to resolve `did:ethr:*` DIDs, you would import and include the `ethr` resolver and pass its destructured resolver alongside the DSNP one to the constructor as follows:
+The CachedResolver can combine drivers for multiple DID methods as described in the `did-io` [documentation](https://github.com/digitalbazaar/did-io#readme).
+For example, if you also want to be able to resolve `did:web:*` DIDs, you can use the `did-method-web` driver alongside the DSNP driver.
 
 ```
-import ethr from "ethr-did-resolver";
-// ... additional did-resolver packages; 
-
-const resolver = new Resolver({
-  ...dsnp.getResolver(),
-  ...ethr.getResolver()
-});
-// usage is same as in previous example
+import { CachedResolver } from "@digitalbazaar/did-io";
+import didWeb from "@digitalbazaar/did-method-web";
+import didDsnp from "@dsnp/did-resolver";
+import { FooResolver} from "dsnp-did-resolver-plugin-foo";
+
+const resolver = new CachedResolver();
+resolver.use(didWeb.driver());
+resolver.use(didDsnp.driver([ new FooResolver() ]));
+
+// DID resolution proceeds as in previous example
 ```
 
 # Plugins
 
-To resolve a DSNP User Id to a specific DSNP system, one or more system-specific plugins must be imported.
-Plugin import order defines the order in which this resolver will attempt to resolve a DSNP DID.
+To resolve a DSNP User Id to a specific DSNP system, one or more instances of system-specific plugins are required.
+Array ordering defines the order in which this resolver will attempt to resolve a DSNP DID.
 It will return the result from the first plugin that returns a DID document.
 
 ## Plugin development
 
-Plugins should implement a function with the `DSNPResolver` type (see `index.ts`):
+Plugins should implement the `DSNPResolver` interface, which includes a `resolve(bigint)` function (see `index.ts`):
 
 ```
-export type DSNPResolver = (dsnpUserId: BigInt) => Promise<DIDDocument | null>;
+export interface DSNPResolver {
+  resolve(dsnpUserId: bigint): Promise<object | null>;
+}
 ```
 
-The `DIDDocument` type is defined in the `did-resolver` package.
-
-The DSNP resolver function should return `null` if the DSNP User Id cannot be resolved to a DID document for any reason.
+The `resolve()` function should return `null` if the DSNP User Id cannot be resolved to a DID document for any reason.
 Plugins should avoid throwing errors except in dire circumstances, as errors from one plugin will cause any further plugins that have been registered to *not* be called.
 
-Register the function by calling `registerDSNPResolver(myResolver)`.
+`DSNPResolver` instances are passed to this library's `driver()` method as shown above.
+
+## Known plugins
+
+| System | Plugin package
+|---|---|
+| Frequency | [`@dsnp/did-resolver-plugin-frequency`](https://github.com/ProjectLibertyLabs/dsnp-did-resolver-plugin-frequency) | 
+
+Please submit a pull request with any additional plugins.
 
 # Development