docs(remote-client): add inline documentation for exports

packages/remote-client/src/client.ts

@@ -1,6 +1,17 @@
 import 'cross-fetch/polyfill'
 import { IAgentPlugin, IPluginMethodMap, IAgentPluginSchema } from '@veramo/core'
 
+/**
+ * This plugin can be used to access the methods of a remote Veramo agent as if they were implemented locally.
+ *
+ * The remote agent should be provided by {@link @veramo/remote-server#AgentRouter | AgentRouter}, or a similar
+ * implementation of this API.
+ *
+ * The schema of the remote agent is usually provided by {@link @veramo/remote-server#ApiSchemaRouter |
+ * ApiSchemaRouter}.
+ *
+ * @public
+ */
 export class AgentRestClient implements IAgentPlugin {
   readonly methods: IPluginMethodMap = {}
   readonly schema?: IAgentPluginSchema

packages/remote-client/src/openApi.ts

@@ -1,6 +1,18 @@
 import { OpenAPIV3 } from 'openapi-types'
 import { IAgent } from '@veramo/core'
 
+/**
+ * This method can be used to generate an OpenAPIv3 schema to describe how the methods of a Veramo agent can be called
+ * remotely.
+ *
+ * @param agent - The agent whose schema needs to be interpreted.
+ * @param basePath - The base URL
+ * @param exposedMethods - The list of method names available through this schema
+ * @param name - The name of the agent
+ * @param version - The version of the agent
+ *
+ * @public
+ */
 export const getOpenApiSchema = (
   agent: IAgent,
   basePath: string,