Rename ResponseStatus detail to message

Signed-off-by: Frank Hinek <[email protected]>
decentralized-identity · Mar 15, 2024 · 4601bed · 4601bed
1 parent 72df802
commit 4601bed
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 13 deletions.
diff --git a/packages/agent/src/did-api.ts b/packages/agent/src/did-api.ts
@@ -282,14 +282,14 @@ export class AgentDidApi<TKeyManager extends AgentKeyManager = AgentKeyManager>
             metadata : bearerDid.metadata,
           },
           ok     : true,
-          status : { code: 201, detail: 'Created' }
+          status : { code: 201, message: 'Created' }
         };
         return response;
 
       } catch (error: any) {
         return {
           ok     : false,
-          status : { code: 500, detail: error.message ?? 'Unknown error occurred' }
+          status : { code: 500, message: error.message ?? 'Unknown error occurred' }
         };
       }
     }
@@ -301,7 +301,7 @@ export class AgentDidApi<TKeyManager extends AgentKeyManager = AgentKeyManager>
       const response: DidResponse<typeof request.messageType> = {
         result : resolutionResult,
         ok     : true,
-        status : { code: 200, detail: 'OK' }
+        status : { code: 200, message: 'OK' }
       };
       return response;
     }

diff --git a/packages/agent/src/types/agent.ts b/packages/agent/src/types/agent.ts
@@ -42,12 +42,13 @@ export type ResponseStatus = {
     code: number;
 
     /**
-     * A descriptive string providing additional information about the operation's result.
+     * A descriptive message corresponding to the status code that provides additional information
+     * about the operation's result.
      *
-     * This detail is particularly useful for logging, debugging, or displaying contextual messages
+     * This message is particularly useful for logging, debugging, or displaying contextual messages
      * to the end-user, offering insights into why an operation succeeded or failed.
      */
-    detail: string;
+    message: string;
   };
 };
 

diff --git a/packages/api/src/protocol.ts b/packages/api/src/protocol.ts
@@ -1,4 +1,4 @@
-import type { DwnMessage, Web5Agent } from '@web5/agent';
+import type { DwnMessage, DwnResponseStatus, Web5Agent } from '@web5/agent';
 
 import { DwnInterface } from '@web5/agent';
 
@@ -68,7 +68,7 @@ export class Protocol {
    * @param target - The DID of the target DWN to which the protocol configuration will be installed.
    * @returns A promise that resolves to an object containing the status of the send operation.
    */
-  async send(target: string) {
+  async send(target: string): Promise<DwnResponseStatus> {
     const { reply } = await this._agent.sendDwnRequest({
       author      : this._metadata.author,
       messageCid  : this._metadata.messageCid,

diff --git a/packages/api/tests/did-api.spec.ts b/packages/api/tests/did-api.spec.ts
@@ -42,7 +42,7 @@ describe('DidApi', () => {
       expect(didCreateResponse).to.have.property('ok', true);
       expect(didCreateResponse).to.have.property('status');
       expect(didCreateResponse.status).to.have.property('code', 201);
-      expect(didCreateResponse.status).to.have.property('detail', 'Created');
+      expect(didCreateResponse.status).to.have.property('message', 'Created');
       expect(didCreateResponse).to.have.property('did');
       expect(didCreateResponse.did).to.have.property('uri');
       expect(didCreateResponse.did).to.have.property('document');

diff --git a/packages/proxy-agent/tests/proxy-agent.spec.ts b/packages/proxy-agent/tests/proxy-agent.spec.ts
@@ -127,7 +127,7 @@ describe('Web5ProxyAgent', () => {
           expect(didCreateResponse).to.have.property('ok', true);
           expect(didCreateResponse).to.have.property('status');
           expect(didCreateResponse.status).to.have.property('code', 201);
-          expect(didCreateResponse.status).to.have.property('detail', 'Created');
+          expect(didCreateResponse.status).to.have.property('message', 'Created');
           expect(didCreateResponse).to.have.property('result');
           expect(didCreateResponse.result).to.have.property('uri');
           expect(didCreateResponse.result).to.have.property('document');
@@ -144,7 +144,7 @@ describe('Web5ProxyAgent', () => {
           expect(didResolveResponse).to.have.property('ok', true);
           expect(didResolveResponse).to.have.property('status');
           expect(didResolveResponse.status).to.have.property('code', 200);
-          expect(didResolveResponse.status).to.have.property('detail', 'OK');
+          expect(didResolveResponse.status).to.have.property('message', 'OK');
           expect(didResolveResponse).to.have.property('result');
           expect(didResolveResponse.result).to.have.property('didDocument');
           expect(didResolveResponse.result).to.have.property('didDocumentMetadata');

diff --git a/packages/user-agent/tests/user-agent.spec.ts b/packages/user-agent/tests/user-agent.spec.ts
@@ -127,7 +127,7 @@ describe('Web5UserAgent', () => {
           expect(didCreateResponse).to.have.property('ok', true);
           expect(didCreateResponse).to.have.property('status');
           expect(didCreateResponse.status).to.have.property('code', 201);
-          expect(didCreateResponse.status).to.have.property('detail', 'Created');
+          expect(didCreateResponse.status).to.have.property('message', 'Created');
           expect(didCreateResponse).to.have.property('result');
           expect(didCreateResponse.result).to.have.property('uri');
           expect(didCreateResponse.result).to.have.property('document');
@@ -144,7 +144,7 @@ describe('Web5UserAgent', () => {
           expect(didResolveResponse).to.have.property('ok', true);
           expect(didResolveResponse).to.have.property('status');
           expect(didResolveResponse.status).to.have.property('code', 200);
-          expect(didResolveResponse.status).to.have.property('detail', 'OK');
+          expect(didResolveResponse.status).to.have.property('message', 'OK');
           expect(didResolveResponse).to.have.property('result');
           expect(didResolveResponse.result).to.have.property('didDocument');
           expect(didResolveResponse.result).to.have.property('didDocumentMetadata');