docs: added doc-blocks describing RPC manifests

[ci skip]

Author: tegefaulkes

src/agent/handlers/clientManifest.ts

@@ -54,7 +54,12 @@ const vaultsScan = new ServerCaller<
   AgentRPCResponseResult<VaultsScanMessage>
 >();
 
-// No type used here, it will override type inference
+/**
+ * All the client caller definitions for the AgentClient RPC.
+ * Used by the RPCClient to register callers and enforce types.
+ *
+ * No type used here, it will override type inference.
+ */
 const clientManifest = {
   nodesClaimsGet,
   nodesClosestLocalNodesGet,

src/agent/handlers/serverManifest.ts

@@ -17,6 +17,12 @@ import { VaultsScanHandler } from './vaultsScan';
 import { VaultsGitInfoGetHandler } from './vaultsGitInfoGet';
 import { VaultsGitPackGetHandler } from './vaultsGitPackGet';
 
+/**
+ * All the server handler definitions for the AgentServer RPC.
+ * This will take the container of all the required dependencies and create the server handlers.
+ *
+ * Used by the RPCServer to register handlers and enforce types.
+ */
 const serverManifest = (container: {
   db: DB;
   sigchain: Sigchain;

src/client/handlers/clientManifest.ts

@@ -403,7 +403,12 @@ const vaultsVersion = new UnaryCaller<
   ClientRPCResponseResult<VaultsLatestVersionMessage>
 >();
 
-// No type used here, it will override type inference
+/**
+ * All the client caller definitions for the ClientClient RPC.
+ * Used by the RPCClient to register callers and enforce types.
+ *
+ * No type used here, it will override type inference.
+ */
 const clientManifest = {
   agentLockAll,
   agentStatus,

src/client/handlers/serverManifest.ts

@@ -83,6 +83,12 @@ import { VaultsVersionHandler } from './vaultsVersion';
 import { KeysVerifyHandler } from '../../client/handlers/keysVerify';
 import { KeysSignHandler } from '../../client/handlers/keysSign';
 
+/**
+ * All the server handler definitions for the ClientServer RPC.
+ * This will take the container of all the required dependencies and create the server handlers.
+ *
+ * Used by the RPCServer to register handlers and enforce types.
+ */
 const serverManifest = (container: {
   pkAgentProm: Promise<PolykeyAgent>;
   keyRing: KeyRing;

src/rpc/types.ts

@@ -291,7 +291,14 @@ type ConvertCaller<T extends Caller> = T extends DuplexCaller
   ? RawCallerImplementation
   : never;
 
+/**
+ * Contains the handler Classes that defines the handling logic and types for the server handlers.
+ */
 type ServerManifest = Record<string, Handler>;
+
+/**
+ * Contains the Caller classes that defines the types for the client callers.
+ */
 type ClientManifest = Record<string, Caller>;
 
 type HandlerType = 'DUPLEX' | 'SERVER' | 'CLIENT' | 'UNARY' | 'RAW';

tests/PolykeyClient.test.ts

@@ -60,7 +60,7 @@ describe('PolykeyClient', () => {
       fs,
       logger,
       fresh: true,
-      rpcClientClient: {} as any,
+      rpcClientClient: { destroy: () => {} } as any,
     });
     expect(await session.readToken()).toBeUndefined();
     await session.writeToken('abc' as SessionToken);