signify-ts 0.2.0 → 0.3.0-dev.e31e78d

package/dist/keri/app/clienting.d.ts

@@ -1,15 +1,18 @@
-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 { components } from '../../types/keria-api-schema.ts';
+import { Authenticater } from '../core/authing.ts';
+import { ExternalModule, IdentifierManagerFactory } from '../core/keeping.ts';
+import { Tier } from '../core/salter.ts';
+import { Identifier } from './aiding.ts';
+import { Contacts, Challenges } from './contacting.ts';
+import { Agent, Controller } from './controller.ts';
+import { Oobis, Operations, KeyEvents, KeyStates, Config } from './coring.ts';
+import { Credentials, Ipex, Registries, Schemas } from './credentialing.ts';
+import { Delegations } from './delegating.ts';
+import { Escrows } from './escrowing.ts';
+import { Exchanges } from './exchanging.ts';
+import { Groups } from './grouping.ts';
+import { Notifications } from './notifying.ts';
+export type AgentResourceResult = components['schemas']['AgentResourceResult'];
 declare class State {
     agent: any | null;
     controller: any | null;
@@ -17,7 +20,10 @@ declare class State {
     pidx: number;
     constructor();
 }
-/** 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 declare class SignifyClient {
     controller: Controller;
     url: string;
@@ -25,10 +31,27 @@ export declare class SignifyClient {
     pidx: number;
     agent: Agent | null;
     authn: Authenticater | null;
-    manager: KeyManager | null;
+    manager: IdentifierManagerFactory | null;
     tier: Tier;
     bootUrl: string;
     exteralModules: ExternalModule[];
+    private _identifiers;
+    private _operations;
+    private _keyEvents;
+    private _keyStates;
+    private _oobis;
+    private _config;
+    private _delegations;
+    private _exchanges;
+    private _groups;
+    private _escrows;
+    private _credentials;
+    private _registries;
+    private _ipex;
+    private _notifications;
+    private _contacts;
+    private _challenges;
+    private _schemas;
     /**
      * SignifyClient constructor
      * @param {string} url KERIA admin interface URL
@@ -66,16 +89,20 @@ export declare class SignifyClient {
      */
     fetch(path: string, method: string, data: any, extraHeaders?: Headers): Promise<Response>;
     /**
-     * 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
-     */
-    signedFetch(url: string, path: string, method: string, data: any, aidName: string): Promise<Response>;
+     * @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
+     */
+    createSignedRequest(aidName: string, url: string, req: RequestInit): Promise<Request>;
     /**
      * Approve the delegation of the client AID to the KERIA agent
      * @async
@@ -178,5 +205,15 @@ export declare class SignifyClient {
      * @returns {Exchanges}
      */
     exchanges(): Exchanges;
+    /**
+     * Get delegations resource
+     * @returns {Delegations}
+     */
+    delegations(): Delegations;
+    /**
+     * Get agent config resource
+     * @returns {Config}
+     */
+    config(): Config;
 }
 export {};