signify-ts 0.2.1 → 0.3.0-rc2

package/{src/keri/app/clienting.ts → dist/keri/app/clienting.js}

@@ -1,25 +1,19 @@
-import { Agent, Controller } from './controller';
-import { Tier } from '../core/salter';
-import { Authenticater } from '../core/authing';
-import { ExternalModule, KeyManager } from '../core/keeping';
-
-import { Identifier } from './aiding';
-import { Contacts, Challenges } from './contacting';
-import { Oobis, Operations, KeyEvents, KeyStates } from './coring';
-import { Credentials, Ipex, Registries, Schemas } from './credentialing';
-import { Notifications } from './notifying';
-import { Escrows } from './escrowing';
-import { Groups } from './grouping';
-import { Exchanges } from './exchanging';
-
+import { Authenticater } from "../core/authing.js";
+import { HEADER_SIG_TIME } from "../core/httping.js";
+import { IdentifierManagerFactory } from "../core/keeping.js";
+import { Tier } from "../core/salter.js";
+import { Identifier } from "./aiding.js";
+import { Contacts, Challenges } from "./contacting.js";
+import { Agent, Controller } from "./controller.js";
+import { Oobis, Operations, KeyEvents, KeyStates, Config } from "./coring.js";
+import { Credentials, Ipex, Registries, Schemas } from "./credentialing.js";
+import { Delegations } from "./delegating.js";
+import { Escrows } from "./escrowing.js";
+import { Exchanges } from "./exchanging.js";
+import { Groups } from "./grouping.js";
+import { Notifications } from "./notifying.js";
 const DEFAULT_BOOT_URL = 'http://localhost:3903';
-
 class State {
-    agent: any | null;
-    controller: any | null;
-    ridx: number;
-    pidx: number;
-
     constructor() {
         this.agent = null;
         this.controller = null;
@@ -27,20 +21,11 @@ class State {
         this.ridx = 0;
     }
 }
-
-/** SignifyClient */
+/**
+ * An in-memory key manager that can connect to a KERIA Agent and use it to
+ * receive messages and act as a proxy for multi-signature operations and delegation operations.
+ */
 export class SignifyClient {
-    public controller: Controller;
-    public url: string;
-    public bran: string;
-    public pidx: number;
-    public agent: Agent | null;
-    public authn: Authenticater | null;
-    public manager: KeyManager | null;
-    public tier: Tier;
-    public bootUrl: string;
-    public exteralModules: ExternalModule[];
-
     /**
      * SignifyClient constructor
      * @param {string} url KERIA admin interface URL
@@ -49,13 +34,24 @@ export class SignifyClient {
      * @param {string} bootUrl KERIA boot interface URL
      * @param {ExternalModule[]} externalModules list of external modules to load
      */
-    constructor(
-        url: string,
-        bran: string,
-        tier: Tier = Tier.low,
-        bootUrl: string = DEFAULT_BOOT_URL,
-        externalModules: ExternalModule[] = []
-    ) {
+    constructor(url, bran, tier = Tier.low, bootUrl = DEFAULT_BOOT_URL, externalModules = []) {
+        this._identifiers = new Identifier(this);
+        this._operations = new Operations(this);
+        this._keyEvents = new KeyEvents(this);
+        this._keyStates = new KeyStates(this);
+        this._oobis = new Oobis(this);
+        this._config = new Config(this);
+        this._delegations = new Delegations(this);
+        this._exchanges = new Exchanges(this);
+        this._groups = new Groups(this);
+        this._escrows = new Escrows(this);
+        this._credentials = new Credentials(this);
+        this._registries = new Registries(this);
+        this._ipex = new Ipex(this);
+        this._notifications = new Notifications(this);
+        this._contacts = new Contacts(this);
+        this._challenges = new Challenges(this);
+        this._schemas = new Schemas(this);
         this.url = url;
         if (bran.length < 21) {
             throw Error('bran must be 21 characters');
@@ -70,26 +66,24 @@ export class SignifyClient {
         this.bootUrl = bootUrl;
         this.exteralModules = externalModules;
     }
-
     get data() {
         return [this.url, this.bran, this.pidx, this.authn];
     }
-
     /**
      * Boot a KERIA agent
      * @async
      * @returns {Promise<Response>} A promise to the result of the boot
      */
-    async boot(): Promise<Response> {
-        const [evt, sign] = this.controller?.event ?? [];
+    async boot() {
+        var _a, _b, _c, _d;
+        const [evt, sign] = (_b = (_a = this.controller) === null || _a === void 0 ? void 0 : _a.event) !== null && _b !== void 0 ? _b : [];
         const data = {
-            icp: evt.ked,
+            icp: evt.sad,
             sig: sign.qb64,
-            stem: this.controller?.stem,
+            stem: (_c = this.controller) === null || _c === void 0 ? void 0 : _c.stem,
             pidx: 1,
-            tier: this.controller?.tier,
+            tier: (_d = this.controller) === null || _d === void 0 ? void 0 : _d.tier,
         };
-
         return await fetch(this.bootUrl + '/boot', {
             method: 'POST',
             body: JSON.stringify(data),
@@ -98,29 +92,26 @@ export class SignifyClient {
             },
         });
     }
-
     /**
      * Get state of the agent and the client
      * @async
      * @returns {Promise<Response>} A promise to the state
      */
-    async state(): Promise<State> {
-        const caid = this.controller?.pre;
-
+    async state() {
+        var _a, _b, _c, _d, _e;
+        const caid = (_a = this.controller) === null || _a === void 0 ? void 0 : _a.pre;
         const res = await fetch(this.url + `/agent/${caid}`);
         if (res.status == 404) {
             throw new Error(`agent does not exist for controller ${caid}`);
         }
-
         const data = await res.json();
         const state = new State();
-        state.agent = data.agent ?? {};
-        state.controller = data.controller ?? {};
-        state.ridx = data.ridx ?? 0;
-        state.pidx = data.pidx ?? 0;
+        state.agent = (_b = data.agent) !== null && _b !== void 0 ? _b : {};
+        state.controller = (_c = data.controller) !== null && _c !== void 0 ? _c : {};
+        state.ridx = (_d = data.ridx) !== null && _d !== void 0 ? _d : 0;
+        state.pidx = (_e = data.pidx) !== null && _e !== void 0 ? _e : 0;
         return state;
     }
-
     /**  Connect to a KERIA agent
      * @async
      */
@@ -128,33 +119,19 @@ export class SignifyClient {
         const state = await this.state();
         this.pidx = state.pidx;
         //Create controller representing the local client AID
-        this.controller = new Controller(
-            this.bran,
-            this.tier,
-            0,
-            state.controller
-        );
+        this.controller = new Controller(this.bran, this.tier, 0, state.controller);
         this.controller.ridx = state.ridx !== undefined ? state.ridx : 0;
         // Create agent representing the AID of KERIA cloud agent
         this.agent = new Agent(state.agent);
         if (this.agent.anchor != this.controller.pre) {
-            throw Error(
-                'commitment to controller AID missing in agent inception event'
-            );
+            throw Error('commitment to controller AID missing in agent inception event');
         }
-        if (this.controller.serder.ked.s == 0) {
+        if (this.controller.serder.sad.s == 0) {
             await this.approveDelegation();
         }
-        this.manager = new KeyManager(
-            this.controller.salter,
-            this.exteralModules
-        );
-        this.authn = new Authenticater(
-            this.controller.signer,
-            this.agent.verfer!
-        );
+        this.manager = new IdentifierManagerFactory(this.controller.salter, this.exteralModules);
+        this.authn = new Authenticater(this.controller.signer, this.agent.verfer);
     }
-
     /**
      * Fetch a resource from the KERIA agent
      * @async
@@ -164,37 +141,21 @@ export class SignifyClient {
      * @param {Headers} [extraHeaders] Optional extra headers to be sent with the request
      * @returns {Promise<Response>} A promise to the result of the fetch
      */
-    async fetch(
-        path: string,
-        method: string,
-        data: any,
-        extraHeaders?: Headers
-    ): Promise<Response> {
+    async fetch(path, method, data, extraHeaders) {
+        var _a;
         const headers = new Headers();
         let signed_headers = new Headers();
         const final_headers = new Headers();
-
         headers.set('Signify-Resource', this.controller.pre);
-        headers.set(
-            'Signify-Timestamp',
-            new Date().toISOString().replace('Z', '000+00:00')
-        );
+        headers.set(HEADER_SIG_TIME, new Date().toISOString().replace('Z', '000+00:00'));
         headers.set('Content-Type', 'application/json');
-
         const _body = method == 'GET' ? null : JSON.stringify(data);
-        if (_body !== null) {
-            headers.set('Content-Length', String(_body.length));
-        }
         if (this.authn) {
-            signed_headers = this.authn.sign(
-                headers,
-                method,
-                path.split('?')[0]
-            );
-        } else {
+            signed_headers = this.authn.sign(headers, method, path.split('?')[0]);
+        }
+        else {
             throw new Error('client need to call connect first');
         }
-
         signed_headers.forEach((value, key) => {
             final_headers.set(key, value);
         });
@@ -213,120 +174,72 @@ export class SignifyClient {
             const message = `HTTP ${method} ${path} - ${res.status} ${res.statusText} - ${error}`;
             throw new Error(message);
         }
-        const isSameAgent =
-            this.agent?.pre === res.headers.get('signify-resource');
+        const isSameAgent = ((_a = this.agent) === null || _a === void 0 ? void 0 : _a.pre) === res.headers.get('signify-resource');
         if (!isSameAgent) {
             throw new Error('message from a different remote agent');
         }
-
-        const verification = this.authn.verify(
-            res.headers,
-            method,
-            path.split('?')[0]
-        );
+        const verification = this.authn.verify(res.headers, method, path.split('?')[0]);
         if (verification) {
             return res;
-        } else {
+        }
+        else {
             throw new Error('response verification failed');
         }
     }
-
     /**
-     * Fetch a resource from from an external URL with headers signed by an AID
+     * Create a Signed Request to fetch a resource from an external URL with headers signed by an AID
      * @async
-     * @param {string} url URL of the resource
-     * @param {string} path Path to the resource
-     * @param {string} method HTTP method
-     * @param {any} data Data to be sent in the body of the resource
      * @param {string} aidName Name or alias of the AID to be used for signing
-     * @returns {Promise<Response>} A promise to the result of the fetch
+     * @param {string} url URL of the requested resource
+     * @param {RequestInit} req Request options should include:
+     *     - method: HTTP method
+     *     - data Data to be sent in the body of the resource.
+     *              If the data is a CESR JSON string then you should also set contentType to 'application/json+cesr'
+     *              If the data is a FormData object then you should not set the contentType and the browser will set it to 'multipart/form-data'
+     *              If the data is an object then you should use JSON.stringify to convert it to a string and set the contentType to 'application/json'
+     *     - contentType Content type of the request.
+     * @returns {Promise<Request>} A promise to the created Request
      */
-    async signedFetch(
-        url: string,
-        path: string,
-        method: string,
-        data: any,
-        aidName: string
-    ): Promise<Response> {
+    async createSignedRequest(aidName, url, req) {
+        var _a;
         const hab = await this.identifiers().get(aidName);
-        const keeper = this.manager!.get(hab);
-
-        const authenticator = new Authenticater(
-            keeper.signers[0],
-            keeper.signers[0].verfer
-        );
-
-        const headers = new Headers();
-        headers.set('Signify-Resource', hab.prefix);
-        headers.set(
-            'Signify-Timestamp',
-            new Date().toISOString().replace('Z', '000+00:00')
-        );
-
-        if (data !== null) {
-            headers.set('Content-Length', data.length);
-        } else {
-            headers.set('Content-Length', '0');
-        }
-        const signed_headers = authenticator.sign(
-            headers,
-            method,
-            path.split('?')[0]
-        );
-        let _body = null;
-        if (method != 'GET') {
-            if (data instanceof FormData) {
-                _body = data;
-                // do not set the content type, let the browser do it
-                // headers.set('Content-Type', 'multipart/form-data')
-            } else {
-                _body = JSON.stringify(data);
-                headers.set('Content-Type', 'application/json');
-            }
-        } else {
-            headers.set('Content-Type', 'application/json');
-        }
-
-        return await fetch(url + path, {
-            method: method,
-            body: _body,
-            headers: signed_headers,
-        });
+        const keeper = this.manager.get(hab);
+        const authenticator = new Authenticater(keeper.signers[0], keeper.signers[0].verfer);
+        const headers = new Headers(req.headers);
+        headers.set('Signify-Resource', hab['prefix']);
+        headers.set(HEADER_SIG_TIME, new Date().toISOString().replace('Z', '000+00:00'));
+        const signed_headers = authenticator.sign(new Headers(headers), (_a = req.method) !== null && _a !== void 0 ? _a : 'GET', new URL(url).pathname);
+        req.headers = signed_headers;
+        return new Request(url, req);
     }
-
     /**
      * Approve the delegation of the client AID to the KERIA agent
      * @async
      * @returns {Promise<Response>} A promise to the result of the approval
      */
-    async approveDelegation(): Promise<Response> {
-        const sigs = this.controller.approveDelegation(this.agent!);
-
+    async approveDelegation() {
+        const sigs = this.controller.approveDelegation(this.agent);
         const data = {
-            ixn: this.controller.serder.ked,
+            ixn: this.controller.serder.sad,
             sigs: sigs,
         };
-
-        return await fetch(
-            this.url + '/agent/' + this.controller.pre + '?type=ixn',
-            {
-                method: 'PUT',
-                body: JSON.stringify(data),
-                headers: {
-                    'Content-Type': 'application/json',
-                },
-            }
-        );
+        return await fetch(this.url + '/agent/' + this.controller.pre + '?type=ixn', {
+            method: 'PUT',
+            body: JSON.stringify(data),
+            headers: {
+                'Content-Type': 'application/json',
+            },
+        });
     }
-
     /**
      * Save old client passcode in KERIA agent
      * @async
      * @param {string} passcode Passcode to be saved
      * @returns {Promise<Response>} A promise to the result of the save
      */
-    async saveOldPasscode(passcode: string): Promise<Response> {
-        const caid = this.controller?.pre;
+    async saveOldPasscode(passcode) {
+        var _a;
+        const caid = (_a = this.controller) === null || _a === void 0 ? void 0 : _a.pre;
         const body = { salt: passcode };
         return await fetch(this.url + '/salt/' + caid, {
             method: 'PUT',
@@ -336,14 +249,14 @@ export class SignifyClient {
             },
         });
     }
-
     /**
      * Delete a saved passcode from KERIA agent
      * @async
      * @returns {Promise<Response>} A promise to the result of the deletion
      */
-    async deletePasscode(): Promise<Response> {
-        const caid = this.controller?.pre;
+    async deletePasscode() {
+        var _a;
+        const caid = (_a = this.controller) === null || _a === void 0 ? void 0 : _a.pre;
         return await fetch(this.url + '/salt/' + caid, {
             method: 'DELETE',
             headers: {
@@ -351,7 +264,6 @@ export class SignifyClient {
             },
         });
     }
-
     /**
      * Rotate the client AID
      * @async
@@ -359,7 +271,7 @@ export class SignifyClient {
      * @param {Array<string>} aids List of managed AIDs to be rotated
      * @returns {Promise<Response>} A promise to the result of the rotation
      */
-    async rotate(nbran: string, aids: string[]): Promise<Response> {
+    async rotate(nbran, aids) {
         const data = this.controller.rotate(nbran, aids);
         return await fetch(this.url + '/agent/' + this.controller.pre, {
             method: 'PUT',
@@ -369,124 +281,123 @@ export class SignifyClient {
             },
         });
     }
-
     /**
      * Get identifiers resource
      * @returns {Identifier}
      */
-    identifiers(): Identifier {
-        return new Identifier(this);
+    identifiers() {
+        return this._identifiers;
     }
-
     /**
      * Get OOBIs resource
      * @returns {Oobis}
      */
-    oobis(): Oobis {
-        return new Oobis(this);
+    oobis() {
+        return this._oobis;
     }
-
     /**
      * Get operations resource
      * @returns {Operations}
      */
-    operations(): Operations {
-        return new Operations(this);
+    operations() {
+        return this._operations;
     }
-
     /**
      * Get keyEvents resource
      * @returns {KeyEvents}
      */
-    keyEvents(): KeyEvents {
-        return new KeyEvents(this);
+    keyEvents() {
+        return this._keyEvents;
     }
-
     /**
      * Get keyStates resource
      * @returns {KeyStates}
      */
-    keyStates(): KeyStates {
-        return new KeyStates(this);
+    keyStates() {
+        return this._keyStates;
     }
-
     /**
      * Get credentials resource
      * @returns {Credentials}
      */
-    credentials(): Credentials {
-        return new Credentials(this);
+    credentials() {
+        return this._credentials;
     }
-
     /**
      * Get IPEX resource
      * @returns {Ipex}
      */
-    ipex(): Ipex {
-        return new Ipex(this);
+    ipex() {
+        return this._ipex;
     }
-
     /**
      * Get registries resource
      * @returns {Registries}
      */
-    registries(): Registries {
-        return new Registries(this);
+    registries() {
+        return this._registries;
     }
-
     /**
      * Get schemas resource
      * @returns {Schemas}
      */
-    schemas(): Schemas {
-        return new Schemas(this);
+    schemas() {
+        return this._schemas;
     }
-
     /**
      * Get challenges resource
      * @returns {Challenges}
      */
-    challenges(): Challenges {
-        return new Challenges(this);
+    challenges() {
+        return this._challenges;
     }
-
     /**
      * Get contacts resource
      * @returns {Contacts}
      */
-    contacts(): Contacts {
-        return new Contacts(this);
+    contacts() {
+        return this._contacts;
     }
-
     /**
      * Get notifications resource
      * @returns {Notifications}
      */
-    notifications(): Notifications {
-        return new Notifications(this);
+    notifications() {
+        return this._notifications;
     }
-
     /**
      * Get escrows resource
      * @returns {Escrows}
      */
-    escrows(): Escrows {
-        return new Escrows(this);
+    escrows() {
+        return this._escrows;
     }
-
     /**
      * Get groups resource
      * @returns {Groups}
      */
-    groups(): Groups {
-        return new Groups(this);
+    groups() {
+        return this._groups;
     }
-
     /**
      * Get exchange resource
      * @returns {Exchanges}
      */
-    exchanges(): Exchanges {
-        return new Exchanges(this);
+    exchanges() {
+        return this._exchanges;
+    }
+    /**
+     * Get delegations resource
+     * @returns {Delegations}
+     */
+    delegations() {
+        return this._delegations;
+    }
+    /**
+     * Get agent config resource
+     * @returns {Config}
+     */
+    config() {
+        return this._config;
     }
 }