Various tweaks.

* Remove "-plugin" from package name
* Generate types in dist
* Allow constuction with pre-existing ApiPromise
* Don't put DID document @context in an array, ed25519-multikey doesn't like it

Author: Wes Biggs

README.md

@@ -1,27 +1,49 @@
 # Overview
 
-This package contains a plugin for the [@dsnp/did-resolver](https://github.com/LibertyDSNP/dsnp-did-resolver) library which enables resolution of `did:dsnp:*` DIDs on the [Frequency](https://github.com/LibertyDSNP/frequency) blockchain.
+This package contains a resolver for the [@dsnp/did-resolver](https://github.com/LibertyDSNP/dsnp-did-resolver) library which enables resolution of `did:dsnp:*` DIDs on the [Frequency](https://github.com/LibertyDSNP/frequency) blockchain.
+
+# Installation
+
+`npm install @dsnp/did-resolver-frequency`
 
 # Usage
 
-The plugin must be initialized with Frequency connection information.
+The resolver object can be constructed with Frequency connection information in one of two ways.
+
+1. Construct with provider URI:
 
 ```
-import { FrequencyResolver } from "@dsnp/did-resolver-plugin-frequency";
+import { FrequencyResolver } from "@dsnp/did-resolver-frequency";
 
 const frequencyResolver = new FrequencyResolver({
   providerUri: "ws://127.0.0.1:9944",
   frequencyNetwork: "local",
 });
 ```
 
-The plugin will automatically register itself with the DSNP DID resolver when initialized.
+If constructed this way, you must call `disconnect()` to explicitly release the connection; the process will not exit if this is not done.
+
+or,
+
+2. Construct with preconfigured `ApiPromise` object from `@polkadot/api`:
+
+```
+import { FrequencyResolver } from "@dsnp/did-resolver-frequency";
+
+const frequencyResolver = new FrequencyResolver({
+  apiPromise: myApiPromise, // from ApiPromise.create(...)
+  frequencyNetwork: "local",
+});
+```
+
+The `frequencyNetwork` key is required in both cases (this is expected to be unnecessary with Frequency schema naming in the future).
 
-The following options must be provided:
+Summary of options:
 
 | Configuration option | Description |
 | --- | --- |
-| `providerUri` | Provider URI for Frequency RPC node |
+| `providerUri` | Provider URI for Frequency RPC node (optional; alternative to `apiPromise` |
+| `apiPromise` | An `ApiPromise` object (optional; alternative to `providerUri` |
 | `frequencyNetwork` | One of `local`, `testnet`, `mainnet` |
 
 See `.env.example` for example configuration.
@@ -56,15 +78,14 @@ frequencyResolver.disconnect();
     "id": "did:dsnp:13972",
     "assertionMethod": [
       {
-        "@context": [
-          "https://w3id.org/security/multikey/v1"
-        ],
+        "@context": "https://w3id.org/security/multikey/v1",
         "id": "did:dsnp:13972#z6MkuzE4hBVHTmwFff37ZuPQs9sbkdJo8jifN9sZ1jXbgyMp",
         "type": "Multikey",
         "controller": "did:dsnp:13972",
         "publicKeyMultibase": "z6MkuzE4hBVHTmwFff37ZuPQs9sbkdJo8jifN9sZ1jXbgyMp"
       }
-    ]
+    ],
+    "keyAgreement": []
   },
   "didDocumentMetadata": {}
 }
@@ -82,7 +103,7 @@ npm run resolve -- 13972
 
 # Features
 
-Currently this plugin implements the minimal functionality required to support lookup of public keys by DSNP applications.
+Currently this resolver implements the minimal functionality required to support lookup of public keys by DSNP applications.
 
 - DSNP public keys with `keyType` 1 are listed in the `keyAgreement` array.
 - DSNP public keys with `keyType` 2 are listed in the `assertionMethod` array.

index.test.ts

@@ -1,12 +1,31 @@
 import { expect, jest, test } from "@jest/globals";
 import { FrequencyResolver } from "./index.js";
+import { ApiPromise, WsProvider } from "@polkadot/api";
+import { options } from "@frequency-chain/api-augment";
 
-describe("dsnp-did-resolver-plugin-frequency", () => {
-  it("can be constructed", async () => {
-    const _resolver = new FrequencyResolver({
+describe("dsnp-did-resolver-frequency", () => {
+  it("can be constructed with providerUri", async () => {
+    const resolver = new FrequencyResolver({
       providerUri: "ws://127.0.0.1:9944",
       frequencyNetwork: "local",
     });
+
+    await resolver.disconnect();
+  });
+
+  it("can be constructed with apiPromise", async () => {
+    const apiPromise = ApiPromise.create({
+      provider: new WsProvider("ws://127.0.0.1:9944"),
+      throwOnConnect: true,
+      ...options,
+    });
+
+    const resolver = new FrequencyResolver({
+      apiPromise,
+      frequencyNetwork: "local",
+    });
+
+    await resolver.disconnect();
   });
 
   /* Need to mock for this...

index.ts

@@ -13,7 +13,7 @@ function makeVerificationMethod(
   publicKeyMultibase: string,
 ) {
   return {
-    "@context": ["https://w3id.org/security/multikey/v1"],
+    "@context": "https://w3id.org/security/multikey/v1",
     id: `${controller}#${publicKeyMultibase}`,
     type: "Multikey",
     controller,
@@ -22,15 +22,17 @@ function makeVerificationMethod(
 }
 
 export class FrequencyResolver implements DSNPResolver {
-  private providerUri: string;
+  private providerUri: string | null = null;
   private frequencyNetwork: string;
   private _singletonApi: Promise<ApiPromise> | null = null;
 
-  constructor(options: { providerUri: string; frequencyNetwork: string }) {
-    this.providerUri = options.providerUri;
-
-    if (!this.providerUri) {
-      throw new Error("providerUri is required");
+  constructor(options: { providerUri?: string; apiPromise?: Promise<ApiPromise>, frequencyNetwork: string }) {
+    if (options.providerUri) {
+      this.providerUri = options.providerUri;
+    } else if (options.apiPromise != null) {
+      this._singletonApi = options.apiPromise;
+    } else {
+      throw new Error("providerUri or apiPromise is required");
     }
 
     this.frequencyNetwork = options.frequencyNetwork;
@@ -47,7 +49,7 @@ export class FrequencyResolver implements DSNPResolver {
   async getApi(): Promise<ApiPromise> {
     if (this._singletonApi == null) {
       this._singletonApi = ApiPromise.create({
-        provider: new WsProvider(this.providerUri),
+        provider: new WsProvider(this.providerUri as string),
         throwOnConnect: true,
         ...options,
       });