feat(cactus-core-api): add ISendRequestResultV1<T> for Fujitsu verifier

An interface representing the response object of the send sync and send async request methods on the connection-chain verifier API. Also great when trying to help bridge the gap between the API returning results as `unknown` and the tests needing auto-completion for the properties to assert for type of data at runtime. @see {ISocketApiClient<BlockType>} @see {Verifier<LedgerApiType extends ISocketApiClient<unknown>>} @see {IVerifier} [skip ci] Signed-off-by: Peter Somogyvari <[email protected]>
hyperledger-cacti · Oct 12, 2023 · 483de38 · 483de38
1 parent da47e3c
commit 483de38
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/...cactus-core-api/src/main/typescript/plugin/ledger-connector/i-send-request-response-v1.ts b/...cactus-core-api/src/main/typescript/plugin/ledger-connector/i-send-request-response-v1.ts
@@ -0,0 +1,17 @@
+/**
+ * An interface representing the response object of the send sync and send async
+ * request methods on the connection-chain verifier API.
+ *
+ * Also great when trying to help bridge the gap between the API returning
+ * results as `unknown` and the tests needing auto-completion for the properties
+ * to assert for type of data at runtime.
+ *
+ * @see {ISocketApiClient<BlockType>}
+ * @see {Verifier<LedgerApiType extends ISocketApiClient<unknown>>}
+ * @see {IVerifier}
+ */
+export interface ISendRequestResultV1<T> {
+  readonly data: T;
+  readonly errorDetail?: string;
+  readonly status: number;
+}
diff --git a/packages/cactus-core-api/src/main/typescript/public-api.ts b/packages/cactus-core-api/src/main/typescript/public-api.ts
@@ -42,3 +42,5 @@ export {
   LedgerEvent,
   IVerifierEventListener,
 } from "./client/i-verifier";
+
+export { ISendRequestResultV1 } from "./plugin/ledger-connector/i-send-request-response-v1";