update docs of exported types

decentralized-identity · Aug 12, 2024 · 66ca7b7 · 66ca7b7
1 parent 85ff27d
commit 66ca7b7
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/packages/api/src/grant-revocation.ts b/packages/api/src/grant-revocation.ts
@@ -2,10 +2,16 @@ import type { AgentPermissionsApi, DwnDataEncodedRecordsWriteMessage, DwnRespons
 import { DwnInterface } from '@web5/agent';
 import { Convert } from '@web5/common';
 
+/**
+ * Represents the structured data model of a GrantRevocation record, encapsulating the essential fields that define.
+ */
 export interface GrantRevocationModel {
   rawMessage: DwnDataEncodedRecordsWriteMessage;
 }
 
+/**
+ * Represents the options for creating a new GrantRevocation instance.
+ */
 export interface GrantRevocationOptions {
   connectedDid: string;
   message: DwnDataEncodedRecordsWriteMessage;

diff --git a/packages/api/src/index.ts b/packages/api/src/index.ts
@@ -23,6 +23,9 @@
 
 export * from './did-api.js';
 export * from './dwn-api.js';
+export * from './grant-revocation.js';
+export * from './permission-grant.js';
+export * from './permission-request.js';
 export * from './protocol.js';
 export * from './record.js';
 export * from './vc-api.js';

diff --git a/packages/api/src/permission-grant.ts b/packages/api/src/permission-grant.ts
@@ -15,6 +15,9 @@ import {
 } from '@web5/agent';
 import { PermissionGrantRevocation } from './grant-revocation.js';
 
+/**
+ * Represents the structured data model of a PermissionGrant record, encapsulating the essential fields that define
+ */
 export interface PermissionGrantModel {
   /**
    * The ID of the permission grant, which is the record ID DWN message.
@@ -67,6 +70,9 @@ export interface PermissionGrantModel {
   readonly conditions?: DwnPermissionConditions;
 }
 
+/**
+ * Represents the options for creating a new PermissionGrant instance.
+ */
 export interface PermissionGrantOptions {
   connectedDid: string;
   message: DwnDataEncodedRecordsWriteMessage;

diff --git a/packages/api/src/permission-request.ts b/packages/api/src/permission-request.ts
@@ -6,8 +6,6 @@ import { PermissionGrant } from './permission-grant.js';
 /**
  * Represents the structured data model of a PermissionsRequest record, encapsulating the essential fields that define
  * the request's data and payload within a Decentralized Web Node (DWN).
- *
- * @beta
  */
 export interface PermissionRequestModel {
   /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,8 +6,6 @@ import { PermissionGrant } from './permission-grant.js'; @@
     /**
      * Represents the structured data model of a PermissionsRequest record, encapsulating the essential fields that define
      * the request's data and payload within a Decentralized Web Node (DWN).
-     *
-     * @beta
      */
     export interface PermissionRequestModel {
       /**
@@ Expand Down @@