@verana-labs/vs-agent-client 2.0.0-dev.64 → 2.0.0-dev.65

package/build/ApiClient.d.ts

@@ -1,33 +1,22 @@
-import { CredentialTypeService, InvitationService, MessageService, RevocationRegistryService, TrustCredentialService } from './services';
+import { CredentialTypeService, DidcommInvitationsService, InvitationService, MessageService, RevocationRegistryService, TrustCredentialService } from './services';
 import { ApiVersion } from './types';
 /**
- * `ApiClient` class for easy access to the available endpoints in the Agent Service.
- * This class simplifies the interaction with the service by providing methods
- * that map the required data and allow straightforward use of the endpoints.
- *
- * Each method corresponds to an HTTP POST endpoint with a specified route
- * within the Express structure. The `ApiClient` class is designed to handle
- * events and make requests efficiently.
- *
- * Usage:
- * Extend `ApiClient` in your project and implement specific handlers to
- * interact with the available services like message sending and credential management.
+ * `ApiClient` gives access to the Admin API of a VS Agent.
  *
  * Example:
  *
- * // Initialize ApiClient with the base URL and version
  * const apiClient = new ApiClient('http://localhost', ApiVersion.V1)
- *
- * // Example to query available credentials
  * await apiClient.credentialTypes.getAll()
+ * await apiClient.messages.send(message)
+ * await apiClient.didcomm.invitations.send({ connectionId, label })
  *
- * // Example to send a message
- * apiClient.messages.send(message: BaseMessage)
- *
- * The `ApiClient` class provides easy methods for interacting with:
- * - `messages`: Send and manage messages.
- * - `credentialTypes`: Query and manage credential types.
- * - `revocationRegistries`: Query and manage the revocation registry for credential definitions.
+ * Services:
+ * - `messages`: send v1 messages.
+ * - `credentialTypes`: create, import, export and list credential types.
+ * - `revocationRegistries`: create and list revocation registries.
+ * - `invitations`: create invitation codes.
+ * - `trustCredentials`: issue and revoke Verifiable Trust credentials.
+ * - `didcomm`: v2 DIDComm modules. `didcomm.invitations` sends an invitation on a connection.
  */
 export declare class ApiClient {
     private baseURL;
@@ -37,5 +26,8 @@ export declare class ApiClient {
     readonly revocationRegistries: RevocationRegistryService;
     readonly invitations: InvitationService;
     readonly trustCredentials: TrustCredentialService;
+    readonly didcomm: {
+        invitations: DidcommInvitationsService;
+    };
     constructor(baseURL: string, version?: ApiVersion);
 }

package/build/ApiClient.js

@@ -5,33 +5,22 @@ exports.ApiClient = void 0;
 const services_1 = require("./services");
 const types_1 = require("./types");
 /**
- * `ApiClient` class for easy access to the available endpoints in the Agent Service.
- * This class simplifies the interaction with the service by providing methods
- * that map the required data and allow straightforward use of the endpoints.
- *
- * Each method corresponds to an HTTP POST endpoint with a specified route
- * within the Express structure. The `ApiClient` class is designed to handle
- * events and make requests efficiently.
- *
- * Usage:
- * Extend `ApiClient` in your project and implement specific handlers to
- * interact with the available services like message sending and credential management.
+ * `ApiClient` gives access to the Admin API of a VS Agent.
  *
  * Example:
  *
- * // Initialize ApiClient with the base URL and version
  * const apiClient = new ApiClient('http://localhost', ApiVersion.V1)
- *
- * // Example to query available credentials
  * await apiClient.credentialTypes.getAll()
+ * await apiClient.messages.send(message)
+ * await apiClient.didcomm.invitations.send({ connectionId, label })
  *
- * // Example to send a message
- * apiClient.messages.send(message: BaseMessage)
- *
- * The `ApiClient` class provides easy methods for interacting with:
- * - `messages`: Send and manage messages.
- * - `credentialTypes`: Query and manage credential types.
- * - `revocationRegistries`: Query and manage the revocation registry for credential definitions.
+ * Services:
+ * - `messages`: send v1 messages.
+ * - `credentialTypes`: create, import, export and list credential types.
+ * - `revocationRegistries`: create and list revocation registries.
+ * - `invitations`: create invitation codes.
+ * - `trustCredentials`: issue and revoke Verifiable Trust credentials.
+ * - `didcomm`: v2 DIDComm modules. `didcomm.invitations` sends an invitation on a connection.
  */
 class ApiClient {
     constructor(baseURL, version = types_1.ApiVersion.V1) {
@@ -42,6 +31,7 @@ class ApiClient {
         this.credentialTypes = new services_1.CredentialTypeService(baseURL, version);
         this.revocationRegistries = new services_1.RevocationRegistryService(baseURL, version);
         this.trustCredentials = new services_1.TrustCredentialService(baseURL, version);
+        this.didcomm = { invitations: new services_1.DidcommInvitationsService(baseURL) };
     }
 }
 exports.ApiClient = ApiClient;

package/build/ApiClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiClient.js","sourceRoot":"","sources":["../src/ApiClient.ts"],"names":[],"mappings":";AAAA,mBAAmB;;;AAEnB,yCAMmB;AACnB,mCAAoC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAa,SAAS;IAOpB,YACU,OAAe,EACf,UAAsB,kBAAU,CAAC,EAAE;QADnC,YAAO,GAAP,OAAO,CAAQ;QACf,YAAO,GAAP,OAAO,CAA4B;QAE3C,IAAI,CAAC,WAAW,GAAG,IAAI,4BAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC1D,IAAI,CAAC,QAAQ,GAAG,IAAI,yBAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACpD,IAAI,CAAC,eAAe,GAAG,IAAI,gCAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAClE,IAAI,CAAC,oBAAoB,GAAG,IAAI,oCAAyB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC3E,IAAI,CAAC,gBAAgB,GAAG,IAAI,iCAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IACtE,CAAC;CACF;AAjBD,8BAiBC"}
+{"version":3,"file":"ApiClient.js","sourceRoot":"","sources":["../src/ApiClient.ts"],"names":[],"mappings":";AAAA,mBAAmB;;;AAEnB,yCAOmB;AACnB,mCAAoC;AAEpC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,SAAS;IAQpB,YACU,OAAe,EACf,UAAsB,kBAAU,CAAC,EAAE;QADnC,YAAO,GAAP,OAAO,CAAQ;QACf,YAAO,GAAP,OAAO,CAA4B;QAE3C,IAAI,CAAC,WAAW,GAAG,IAAI,4BAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC1D,IAAI,CAAC,QAAQ,GAAG,IAAI,yBAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACpD,IAAI,CAAC,eAAe,GAAG,IAAI,gCAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAClE,IAAI,CAAC,oBAAoB,GAAG,IAAI,oCAAyB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC3E,IAAI,CAAC,gBAAgB,GAAG,IAAI,iCAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACpE,IAAI,CAAC,OAAO,GAAG,EAAE,WAAW,EAAE,IAAI,oCAAyB,CAAC,OAAO,CAAC,EAAE,CAAA;IACxE,CAAC;CACF;AAnBD,8BAmBC"}

package/build/services/DidcommInvitationsService.d.ts

@@ -0,0 +1,10 @@
+import { SendInvitationOptions, SendInvitationResult } from '@verana-labs/vs-agent-model';
+/**
+ * `DidcommInvitationsService` sends an Out-of-Band invitation on a connection.
+ * The invitation opens a sub-connection to this agent or a referral to a different service.
+ */
+export declare class DidcommInvitationsService {
+    private url;
+    constructor(baseURL: string);
+    send(options: SendInvitationOptions): Promise<SendInvitationResult>;
+}

package/build/services/DidcommInvitationsService.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DidcommInvitationsService = void 0;
+const tslog_1 = require("tslog");
+const logger = new tslog_1.Logger({
+    name: 'DidcommInvitationsService',
+    type: 'pretty',
+    prettyLogTemplate: '{{logLevelName}} [{{name}}]: ',
+});
+/**
+ * `DidcommInvitationsService` sends an Out-of-Band invitation on a connection.
+ * The invitation opens a sub-connection to this agent or a referral to a different service.
+ */
+class DidcommInvitationsService {
+    constructor(baseURL) {
+        this.url = `${baseURL.replace(/\/$/, '')}/v2/didcomm/invitations`;
+    }
+    async send(options) {
+        logger.info(`send(): ${JSON.stringify(options)}`);
+        const response = await fetch(this.url, {
+            method: 'POST',
+            body: JSON.stringify(options),
+            headers: { accept: 'application/json', 'Content-Type': 'application/json' },
+        });
+        if (!response.ok)
+            throw new Error(`Cannot send invitation: status ${response.status}`);
+        return (await response.json());
+    }
+}
+exports.DidcommInvitationsService = DidcommInvitationsService;
+//# sourceMappingURL=DidcommInvitationsService.js.map

package/build/services/DidcommInvitationsService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DidcommInvitationsService.js","sourceRoot":"","sources":["../../src/services/DidcommInvitationsService.ts"],"names":[],"mappings":";;;AACA,iCAA8B;AAE9B,MAAM,MAAM,GAAG,IAAI,cAAM,CAAC;IACxB,IAAI,EAAE,2BAA2B;IACjC,IAAI,EAAE,QAAQ;IACd,iBAAiB,EAAE,+BAA+B;CACnD,CAAC,CAAA;AAEF;;;GAGG;AACH,MAAa,yBAAyB;IAGpC,YAAY,OAAe;QACzB,IAAI,CAAC,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,yBAAyB,CAAA;IACnE,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,OAA8B;QAC9C,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAEjD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;YACrC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,kBAAkB,EAAE;SAC5E,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;QAEtF,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAyB,CAAA;IACxD,CAAC;CACF;AAnBD,8DAmBC"}

package/build/services/index.d.ts

@@ -1,4 +1,5 @@
 export * from './CredentialTypeService';
+export * from './DidcommInvitationsService';
 export * from './InvitationService';
 export * from './MessageService';
 export * from './RevocationRegistryService';

package/build/services/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CredentialTypeService"), exports);
+__exportStar(require("./DidcommInvitationsService"), exports);
 __exportStar(require("./InvitationService"), exports);
 __exportStar(require("./MessageService"), exports);
 __exportStar(require("./RevocationRegistryService"), exports);

package/build/services/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAuC;AACvC,sDAAmC;AACnC,mDAAgC;AAChC,8DAA2C;AAC3C,2DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAuC;AACvC,8DAA2C;AAC3C,sDAAmC;AACnC,mDAAgC;AAChC,8DAA2C;AAC3C,2DAAwC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@verana-labs/vs-agent-client",
   "main": "build/index",
   "types": "build/index",
-  "version": "2.0.0-dev.64",
+  "version": "2.0.0-dev.65",
   "repository": {
     "type": "git",
     "url": "https://github.com/verana-labs/vs-agent"
@@ -19,7 +19,7 @@
     "class-validator": "0.14.1",
     "express": "^4.18.1",
     "tslog": "^4.8.2",
-    "@verana-labs/vs-agent-model": "2.0.0-dev.64"
+    "@verana-labs/vs-agent-model": "2.0.0-dev.65"
   },
   "devDependencies": {
     "@nestjs/common": "^10.0.0",