@2060.io/service-agent-client v1.2.1-dev.2

@2060.io/service-agent-client

Service Agent Client

Service Agent Client is a TypeScript library designed to simplify the interaction with Service Agent (@2060.io/service-agent-main). It provides an abstraction layer for communicating with the agent, handling messaging, credential management, and event handling efficiently.

This package ensures that the client stays updated with the latest API versioning of the Service Agent to maintain compatibility with evolving endpoints.

Features

• Simplified API interaction: Provides an easy-to-use client to interact with the Service Agent.
• Event handling: Includes an ExpressEventHandler for quick integration into Express-based applications.
• Service-based structure: Dedicated services for messaging, credentials, invitations, and revocation registries.
• Versioning support: Supports API versioning to maintain compatibility with different Service Agent versions.

Repository

Find the public repository here: 2060 Service Agent

How to work

@startuml

package "2060 Ecosystem" {
    package "Service Agent (SA)" {
        class ServiceAgent {
            + Handles DIDComm communication
            + Manages agent wallet and credentials
            + Exposes API for client interactions
        }
    }
    
    package "Libraries" {
        class NestJSClient {
            + Plug-and-play integration
            + Selectable modules for various services
            + Modules:
              -- MessageEventOptions: Configures message event handling
              -- ConnectionEventOptions: Configures connection event handling
              -- CredentialOptions: Configures credential management
        }
        class Client ##red {
            + Directly manages requests to SA
            + Facilitates reception of requests from modules
            + Provides an abstraction for service communication
            + Interfaces:
              -- messages
              -- credentialTypes
              -- revocationRegistries
              -- invitations
      
        }
        class ModelLibrary {
            + Defines required data models
            + Ensures type safety across services
        }
    }
}

NestJSClient --> ServiceAgent : Uses
Client --> ServiceAgent : Sends requests
Client --> ServiceAgent : Receives requests
Client --> ModelLibrary : Uses models
ModelLibrary --> ServiceAgent : Provides data models
NestJSClient --> ModelLibrary : Uses models

@enduml

Installation

npm install @2060.io/service-agent-client

or

yarn add @2060.io/service-agent-client

or

pnpm add @2060.io/service-agent-client

ApiClient.ts

ApiClient class provides a simple interface for interacting with the Service Agent. It abstracts API calls and offers dedicated service methods for messaging, credential types, invitations, and revocation registries.

Example Usage

import { ApiClient, ApiVersion } from '@2060.io/service-agent-client'

const apiClient = new ApiClient('http://localhost:3000', ApiVersion.V1)

// Sending a message
const messageId = await apiClient.messages.send(
  new TextMessage({
  connectionId: 'connectionId',
  content: 'Hello, world!',
  })
)

console.log(`Message sent with ID: ${messageId}`)

Services

• messages: Handles message sending and receiving.
• credentialTypes: Manages credential types.
• revocationRegistries: Manages revocation registries.
• invitations: Handles connection invitations.

ExpressEventHandler.ts

The ExpressEventHandler simplifies event handling for Express applications, mapping API endpoints to event handlers.

Example Usage

import express from 'express'
import { ExpressEventHandler } from '@2060.io/service-agent-client'

const app = express()
const eventHandler = new ExpressEventHandler(app)

expressHandler.messageStateUpdated(async (req, res) => {
  const obj = req.body
  logger.info(`message state updated: ${JSON.stringify(obj)}`)
  res.json({ message: 'ok' })
})

app.listen(3000, () => console.log('Server running on port 3000'))

Available Event Handlers

• connectionStateUpdated (POST /connection-state-updated)
• messageStateUpdated (POST /message-state-updated)
• messageReceived (POST /message-received)

Contributing

This library evolves alongside the Service Agent. Contributions are welcome!

• Fork the repository.
• Create a feature branch.
• Commit changes.
• Open a pull request.

For more details, visit the official repository.