@enbox/api 0.0.1

package/dist/types/dwn-api.d.ts

@@ -0,0 +1,336 @@
+/**
+ * NOTE: Added reference types here to avoid a `pnpm` bug during build.
+ * https://github.com/TBD54566975/web5-js/pull/507
+ */
+import type { CreateGrantParams, CreateRequestParams, FetchPermissionRequestParams, FetchPermissionsParams } from '@enbox/agent';
+import { Web5Agent, DwnMessageParams, DwnMessageSubscription, DwnResponseStatus, DwnPaginationCursor } from '@enbox/agent';
+import { DwnInterface } from '@enbox/agent';
+import { Record } from './record.js';
+import { Protocol } from './protocol.js';
+import { PermissionGrant } from './permission-grant.js';
+import { PermissionRequest } from './permission-request.js';
+/**
+ * Represents the request payload for fetching permission requests from a Decentralized Web Node (DWN).
+ *
+ * Optionally, specify a remote DWN target in the `from` property to fetch requests from.
+ */
+export type FetchRequestsRequest = Omit<FetchPermissionRequestParams, 'author' | 'target' | 'remote'> & {
+    /** Optional DID specifying the remote target DWN tenant to be queried. */
+    from?: string;
+};
+/**
+ * Represents the request payload for fetching permission grants from a Decentralized Web Node (DWN).
+ *
+ * Optionally, specify a remote DWN target in the `from` property to fetch requests from.
+ * Optionally, specify whether to check if the grant is revoked in the `checkRevoked` property.
+ */
+export type FetchGrantsRequest = Omit<FetchPermissionsParams, 'author' | 'target' | 'remote'> & {
+    /** Optional DID specifying the remote target DWN tenant to be queried. */
+    from?: string;
+    /** Optionally check if the grant has been revoked. */
+    checkRevoked?: boolean;
+};
+/**
+ * Represents the request payload for configuring a protocol on a Decentralized Web Node (DWN).
+ *
+ * This request type is used to specify the configuration options for the protocol.
+ */
+export type ProtocolsConfigureRequest = {
+    /** Configuration options for the protocol. */
+    message: Omit<DwnMessageParams[DwnInterface.ProtocolsConfigure], 'signer'>;
+};
+/**
+ * Encapsulates the response from a protocol configuration request to a Decentralized Web Node (DWN).
+ *
+ * This response type combines the general operation status with the details of the protocol that
+ * was configured, if the operation was successful.
+ *
+ * @beta
+ */
+export type ProtocolsConfigureResponse = DwnResponseStatus & {
+    /** The configured protocol, if successful. */
+    protocol?: Protocol;
+};
+/**
+ * Defines the request structure for querying protocols from a Decentralized Web Node (DWN).
+ *
+ * This request type is used to specify the target DWN from which protocols should be queried and
+ * any additional query filters or options. If the `from` property is not provided, the query will
+ * target the local DWN. If the `from` property is provided, the query will target the specified
+ * remote DWN.
+ */
+export type ProtocolsQueryRequest = {
+    /** Optional DID specifying the remote target DWN tenant to be queried. */
+    from?: string;
+    /** Query filters and options that influence the results returned. */
+    message: Omit<DwnMessageParams[DwnInterface.ProtocolsQuery], 'signer'>;
+};
+/**
+ * Wraps the response from a protocols query, including the operation status and the list of
+ * protocols.
+ */
+export type ProtocolsQueryResponse = DwnResponseStatus & {
+    /** Array of protocols matching the query. */
+    protocols: Protocol[];
+};
+/**
+ * Type alias for {@link RecordsWriteRequest}
+ */
+export type RecordsCreateRequest = RecordsWriteRequest;
+/**
+ * Type alias for {@link RecordsWriteResponse}
+ */
+export type RecordsCreateResponse = RecordsWriteResponse;
+/**
+ * Represents a request to create a new record based on an existing one.
+ *
+ * This request type allows specifying the new data for the record, along with any additional
+ * message parameters required for the write operation.
+ */
+export type RecordsCreateFromRequest = {
+    /** The DID of the entity authoring the record. */
+    author: string;
+    /** The new data for the record. */
+    data: unknown;
+    /** ptional additional parameters for the record write operation */
+    message?: Omit<DwnMessageParams[DwnInterface.RecordsWrite], 'signer'>;
+    /** The existing record instance that is being used as a basis for the new record. */
+    record: Record;
+};
+/**
+ * Defines a request to delete a record from the Decentralized Web Node (DWN).
+ *
+ * This request type optionally specifies the target from which the record should be deleted and the
+ * message parameters for the delete operation. If the `from` property is not provided, the record
+ * will be deleted from the local DWN.
+ */
+export type RecordsDeleteRequest = {
+    /** Optional DID specifying the remote target DWN tenant the record will be deleted from. */
+    from?: string;
+    /** Records must be scoped to a specific protocol */
+    protocol?: string;
+    /** The parameters for the delete operation. */
+    message: Omit<DwnMessageParams[DwnInterface.RecordsDelete], 'signer'>;
+};
+/**
+ * Encapsulates a request to query records from a Decentralized Web Node (DWN).
+ *
+ * This request type is used to specify the criteria for querying records, including query
+ * parameters, and optionally the target DWN to query from. If the `from` property is not provided,
+ * the query will target the local DWN.
+ */
+export type RecordsQueryRequest = {
+    /** Optional DID specifying the remote target DWN tenant to query from and return results. */
+    from?: string;
+    /** Records must be scoped to a specific protocol */
+    protocol?: string;
+    /** The parameters for the query operation, detailing the criteria for selecting records. */
+    message: Omit<DwnMessageParams[DwnInterface.RecordsQuery], 'signer'>;
+};
+/**
+ * Represents the response from a records query operation, including status, records, and an
+ * optional pagination cursor.
+ */
+export type RecordsQueryResponse = DwnResponseStatus & {
+    /** Array of records matching the query. */
+    records?: Record[];
+    /** If there are additional results, the messageCid of the last record will be returned as a pagination cursor. */
+    cursor?: DwnPaginationCursor;
+};
+/**
+ * Represents a request to read a specific record from a Decentralized Web Node (DWN).
+ *
+ * This request type is used to specify the target DWN from which the record should be read and any
+ * additional parameters for the read operation. It's useful for fetching the details of a single
+ * record by its identifier or other criteria.
+ */
+export type RecordsReadRequest = {
+    /** Optional DID specifying the remote target DWN tenant the record will be read from. */
+    from?: string;
+    /** Records must be scoped to a specific protocol */
+    protocol?: string;
+    /** The parameters for the read operation, detailing the criteria for selecting the record. */
+    message: Omit<DwnMessageParams[DwnInterface.RecordsRead], 'signer'>;
+};
+/**
+ * Encapsulates the response from a record read operation, combining the general operation status
+ * with the specific record that was retrieved.
+ */
+export type RecordsReadResponse = DwnResponseStatus & {
+    /** The record retrieved by the read operation. */
+    record: Record;
+};
+/** Subscription handler for Records */
+export type RecordsSubscriptionHandler = (record: Record) => void;
+/**
+ * Represents a request to subscribe to records from a Decentralized Web Node (DWN).
+ *
+ * This request type is used to specify the target DWN from which records matching the subscription
+ * criteria should be emitted. It's useful for being notified in real time when records are written, deleted or modified.
+ */
+export type RecordsSubscribeRequest = {
+    /** Optional DID specifying the remote target DWN tenant to subscribe from. */
+    from?: string;
+    /** Records must be scoped to a specific protocol */
+    protocol?: string;
+    /** The parameters for the subscription operation, detailing the criteria for the subscription filter */
+    message: Omit<DwnMessageParams[DwnInterface.RecordsSubscribe], 'signer'>;
+    /** The handler to process the subscription events */
+    subscriptionHandler: RecordsSubscriptionHandler;
+};
+/** Encapsulates the response from a DWN RecordsSubscriptionRequest */
+export type RecordsSubscribeResponse = DwnResponseStatus & {
+    /**
+     * Represents the subscription that was created. Includes an ID and the close method to stop the subscription.
+     *
+     * */
+    subscription?: DwnMessageSubscription;
+};
+/**
+ * Defines a request to write (create) a record to a Decentralized Web Node (DWN).
+ *
+ * This request type allows specifying the data for the new or updated record, along with any
+ * additional message parameters required for the write operation, and an optional flag to indicate
+ * whether the record should be immediately stored.
+ *
+ * @param data -
+ * @param message - , excluding the signer.
+ * @param store -
+ */
+export type RecordsWriteRequest = {
+    /** The data payload for the record, which can be of any type. */
+    data: unknown;
+    /** Optional additional parameters for the record write operation. */
+    message?: Omit<Partial<DwnMessageParams[DwnInterface.RecordsWrite]>, 'signer'>;
+    /**
+     * Optional flag indicating whether the record should be immediately stored. If true, the record
+     * is persisted in the DWN as part of the write operation. If false, the record is created,
+     * signed, and returned but not persisted.
+     */
+    store?: boolean;
+};
+/**
+ * Encapsulates the response from a record write operation to a Decentralized Web Node (DWN).
+ *
+ * This request type combines the general operation status with the details of the record that was
+ * written, if the operation was successful.
+ *
+ * The response includes a status object that contains the HTTP-like status code and detail message
+ * indicating the success or failure of the write operation. If the operation was successful and a
+ * record was created or updated, the `record` property will contain an instance of the `Record`
+ * class representing the written record. This allows the caller to access the written record's
+ * details and perform additional operations using the provided {@link Record} instance methods.
+ */
+export type RecordsWriteResponse = DwnResponseStatus & {
+    /**
+     * The `Record` instance representing the record that was successfully written to the
+     * DWN as a result of the write operation.
+     */
+    record?: Record;
+};
+/**
+ * Interface to interact with DWN Records and Protocols
+ */
+export declare class DwnApi {
+    /**
+     * Holds the instance of a {@link Web5Agent} that represents the current execution context for
+     * the `DwnApi`. This agent is used to process DWN requests.
+     */
+    private agent;
+    /** The DID of the DWN tenant under which operations are being performed. */
+    private connectedDid;
+    /** (optional) The DID of the signer when signing with permissions */
+    private delegateDid?;
+    /** Holds the instance of {@link AgentPermissionsApi} that helps when dealing with permissions protocol records */
+    private permissionsApi;
+    constructor(options: {
+        agent: Web5Agent;
+        connectedDid: string;
+        delegateDid?: string;
+    });
+    /**
+     * API to interact with Grants
+     *
+     * NOTE: This is an EXPERIMENTAL API that will change behavior.
+     *
+     * Currently only supports issuing requests, grants, revokes and queries on behalf without permissions or impersonation.
+     * If the agent is connected to a delegateDid, the delegateDid will be used to sign/author the underlying records.
+     * If the agent is not connected to a delegateDid, the connectedDid will be used to sign/author the underlying records.
+     *
+     * @beta
+     */
+    get permissions(): {
+        /**
+         * Request permission for a specific scope.
+         */
+        request: (request: Omit<CreateRequestParams, 'author'>) => Promise<PermissionRequest>;
+        /**
+         * Grant permission for a specific scope to a grantee DID.
+         */
+        grant: (request: Omit<CreateGrantParams, 'author'>) => Promise<PermissionGrant>;
+        /**
+         * Query permission requests. You can filter by protocol and specify if you want to query a remote DWN.
+         */
+        queryRequests: (request?: FetchRequestsRequest) => Promise<PermissionRequest[]>;
+        /**
+         * Query permission grants. You can filter by grantee, grantor, protocol and specify if you want to query a remote DWN.
+         */
+        queryGrants: (request?: FetchGrantsRequest) => Promise<PermissionGrant[]>;
+    };
+    /**
+     * API to interact with DWN protocols (e.g., `dwn.protocols.configure()`).
+     */
+    get protocols(): {
+        /**
+         * Configure method, used to setup a new protocol (or update) with the passed definitions
+         */
+        configure: (request: ProtocolsConfigureRequest) => Promise<ProtocolsConfigureResponse>;
+        /**
+         * Query the available protocols
+         */
+        query: (request: ProtocolsQueryRequest) => Promise<ProtocolsQueryResponse>;
+    };
+    /**
+     * API to interact with DWN records (e.g., `dwn.records.create()`).
+     */
+    get records(): {
+        /**
+         * Alias for the `write` method
+         */
+        create: (request: RecordsCreateRequest) => Promise<RecordsCreateResponse>;
+        /**
+         * Write a record based on an existing one (useful for updating an existing record)
+         */
+        createFrom: (request: RecordsCreateFromRequest) => Promise<RecordsWriteResponse>;
+        /**
+         * Delete a record
+         */
+        delete: (request: RecordsDeleteRequest) => Promise<DwnResponseStatus>;
+        /**
+         * Query a single or multiple records based on the given filter
+         */
+        query: (request: RecordsQueryRequest) => Promise<RecordsQueryResponse>;
+        /**
+         * Read a single record based on the given filter
+         */
+        read: (request: RecordsReadRequest) => Promise<RecordsReadResponse>;
+        /**
+         * Subscribes to records based on the given filter and emits events to the `subscriptionHandler`.
+         *
+         * @param request must include the `message` with the subscription filter and the `subscriptionHandler` to process the events.
+         * @returns the subscription status and the subscription object used to close the subscription.
+         */
+        subscribe: (request: RecordsSubscribeRequest) => Promise<RecordsSubscribeResponse>;
+        /**
+         * Writes a record to the DWN
+         *
+         * As a convenience, the Record instance returned will cache a copy of the data.  This is done
+         * to maintain consistency with other DWN methods, like RecordsQuery, that include relatively
+         * small data payloads when returning RecordsWrite message properties. Regardless of data
+         * size, methods such as `record.data.stream()` will return the data when called even if it
+         * requires fetching from the DWN datastore.
+         */
+        write: (request: RecordsWriteRequest) => Promise<RecordsWriteResponse>;
+    };
+}
+//# sourceMappingURL=dwn-api.d.ts.map

package/dist/types/dwn-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dwn-api.d.ts","sourceRoot":"","sources":["../../src/dwn-api.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,sBAAsB,EACvB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,SAAS,EAGT,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EAEjB,mBAAmB,EAEpB,MAAM,cAAc,CAAC;AAGtB,OAAO,EAAE,YAAY,EAAmB,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAG5D;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,4BAA4B,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG;IACtG,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,sBAAsB,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC,GAAG;IAC9F,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sDAAsD;IACtD,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,8CAA8C;IAC9C,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,kBAAkB,CAAC,EAAE,QAAQ,CAAC,CAAC;CAC5E,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,GAAG;IAC3D,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,qEAAqE;IACrE,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,CAAA;CACvE,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,GAAG;IACvD,6CAA6C;IAC7C,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,IAAI,EAAE,OAAO,CAAC;IACd,mEAAmE;IACnE,OAAO,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,CAAC;IACtE,qFAAqF;IACrF,MAAM,EAAE,MAAM,CAAC;CAChB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,4FAA4F;IAC5F,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,+CAA+C;IAC/C,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC,CAAC;CACvE,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,6FAA6F;IAC7F,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,4FAA4F;IAC5F,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,CAAC;CACtE,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG;IACrD,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB,kHAAkH;IAClH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,yFAAyF;IACzF,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,8FAA8F;IAC9F,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC;CACrE,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG;IACpD,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;CAChB,CAAA;AAED,uCAAuC;AACvC,MAAM,MAAM,0BAA0B,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAElE;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,8EAA8E;IAC9E,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,wGAAwG;IACxG,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEzE,qDAAqD;IACrD,mBAAmB,EAAE,0BAA0B,CAAC;CACjD,CAAA;AAED,sEAAsE;AACtE,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,GAAG;IACzD;;;SAGK;IACL,YAAY,CAAC,EAAE,sBAAsB,CAAC;CACvC,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,iEAAiE;IACjE,IAAI,EAAE,OAAO,CAAC;IAEd,qEAAqE;IACrE,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE/E;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG;IACrD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,qBAAa,MAAM;IACjB;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAY;IAEzB,4EAA4E;IAC5E,OAAO,CAAC,YAAY,CAAS;IAE7B,qEAAqE;IACrE,OAAO,CAAC,WAAW,CAAC,CAAS;IAE7B,kHAAkH;IAClH,OAAO,CAAC,cAAc,CAAsB;gBAEhC,OAAO,EAAE;QAAE,KAAK,EAAE,SAAS,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE;IAOrF;;;;;;;;;;OAUG;IACH,IAAI,WAAW;QAEX;;WAEG;2BACqB,KAAK,mBAAmB,EAAE,QAAQ,CAAC,KAAG,QAAQ,iBAAiB,CAAC;QAcxF;;WAEG;yBACmB,KAAK,iBAAiB,EAAE,QAAQ,CAAC,KAAG,QAAQ,eAAe,CAAC;QAclF;;WAEG;kCAC2B,oBAAoB,KAAO,QAAQ,iBAAiB,EAAE,CAAC;QAqBrF;;WAEG;gCACyB,kBAAkB,KAAQ,QAAQ,eAAe,EAAE,CAAC;MAgCnF;IAED;;OAEG;IACH,IAAI,SAAS;QAET;;WAEG;6BACwB,yBAAyB,KAAG,QAAQ,0BAA0B,CAAC;QAuC1F;;WAEG;yBACoB,qBAAqB,KAAG,QAAQ,sBAAsB,CAAC;MAmDjF;IAED;;OAEG;IACH,IAAI,OAAO;QAGP;;WAEG;0BACqB,oBAAoB,KAAG,QAAQ,qBAAqB,CAAC;QAI7E;;WAEG;8BACyB,wBAAwB,KAAG,QAAQ,oBAAoB,CAAC;QA+BpF;;WAEG;0BACqB,oBAAoB,KAAG,QAAQ,iBAAiB,CAAC;QA8CzE;;WAEG;yBACoB,mBAAmB,KAAG,QAAQ,oBAAoB,CAAC;QAyF1E;;WAEG;wBACmB,kBAAkB,KAAG,QAAQ,mBAAmB,CAAC;QAwFvE;;;;;WAKG;6BACwB,uBAAuB,KAAG,QAAQ,wBAAwB,CAAC;QAuEtF;;;;;;;;WAQG;yBACoB,mBAAmB,KAAG,QAAQ,oBAAoB,CAAC;MA8D7E;CACF"}

package/dist/types/grant-revocation.d.ts

@@ -0,0 +1,66 @@
+import { DwnDataEncodedRecordsWriteMessage, DwnResponseStatus, Web5Agent } from '@enbox/agent';
+/**
+ * Represents the structured data model of a GrantRevocation record, encapsulating the essential fields that define.
+ */
+export interface GrantRevocationModel {
+    /** The DWN message used to construct this revocation */
+    rawMessage: DwnDataEncodedRecordsWriteMessage;
+}
+/**
+ * Represents the options for creating a new GrantRevocation instance.
+ */
+export interface GrantRevocationOptions {
+    /** The DID of the DWN tenant under which record operations are being performed. */
+    connectedDid: string;
+    /** The DWN message used to construct this revocation */
+    message: DwnDataEncodedRecordsWriteMessage;
+}
+/**
+ * The `PermissionGrantRevocation` class encapsulates a permissions protocol `grant/revocation` record, providing a more
+ * developer-friendly interface for working with Decentralized Web Node (DWN) records.
+ *
+ * Methods are provided to manage the grant revocation's lifecycle, including writing to remote DWNs.
+ *
+ * @beta
+ */
+export declare class PermissionGrantRevocation implements GrantRevocationModel {
+    /** The PermissionsAPI used to interact with the underlying revocation  */
+    private _permissions;
+    /** The DID to use as the author and default target for the underlying revocation */
+    private _connectedDid;
+    /** The DWN `RecordsWrite` message, along with encodedData that represents the revocation */
+    private _message;
+    private constructor();
+    /** The author of the underlying revocation message */
+    get author(): string;
+    /** parses the grant revocation given am agent, connectedDid and data encoded records write message  */
+    static parse({ connectedDid, agent, message }: {
+        connectedDid: string;
+        agent: Web5Agent;
+        message: DwnDataEncodedRecordsWriteMessage;
+    }): Promise<PermissionGrantRevocation>;
+    /** The agent to use for this instantiation of the grant revocation */
+    private get agent();
+    /** The raw `RecordsWrite` DWN message with encoded data that was used to instantiate this grant revocation */
+    get rawMessage(): DwnDataEncodedRecordsWriteMessage;
+    /**
+     * Send the current grant revocation to a remote DWN by specifying their DID
+     * If no DID is specified, the target is assumed to be the owner (connectedDID).
+     *
+     * @param target - the optional DID to send the grant revocation to, if none is set it is sent to the connectedDid
+     * @returns the status of the send grant revocation request
+     *
+     * @beta
+     */
+    send(target?: string): Promise<DwnResponseStatus>;
+    /**
+     * Stores the current grant revocation to the owner's DWN.
+     *
+     * @param importGrant - if true, the grant revocation will signed by the owner before storing it to the owner's DWN. Defaults to false.
+     * @returns the status of the store request
+     *
+     * @beta
+     */
+    store(importRevocation?: boolean): Promise<DwnResponseStatus>;
+}
+//# sourceMappingURL=grant-revocation.d.ts.map

package/dist/types/grant-revocation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grant-revocation.d.ts","sourceRoot":"","sources":["../../src/grant-revocation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,iCAAiC,EAAE,iBAAiB,EAAmC,SAAS,EAAE,MAAM,cAAc,CAAC;AAIrJ;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,wDAAwD;IACxD,UAAU,EAAE,iCAAiC,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,mFAAmF;IACnF,YAAY,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,OAAO,EAAE,iCAAiC,CAAC;CAC5C;AAED;;;;;;;GAOG;AACH,qBAAa,yBAA0B,YAAW,oBAAoB;IACpE,0EAA0E;IAC1E,OAAO,CAAC,YAAY,CAAsB;IAC1C,oFAAoF;IACpF,OAAO,CAAC,aAAa,CAAS;IAC9B,4FAA4F;IAC5F,OAAO,CAAC,QAAQ,CAAoC;IAEpD,OAAO;IAQP,sDAAsD;IACtD,IAAI,MAAM,WAET;IAED,uGAAuG;WAC1F,KAAK,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,EAAC;QAClD,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,SAAS,CAAC;QACjB,OAAO,EAAE,iCAAiC,CAAC;KAC5C,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAKtC,sEAAsE;IACtE,OAAO,KAAK,KAAK,GAEhB;IAED,8GAA8G;IAC9G,IAAI,UAAU,IAAI,iCAAiC,CAElD;IAED;;;;;;;;OAQG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAmBvD;;;;;;;OAOG;IACG,KAAK,CAAC,gBAAgB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAgBpE"}

package/dist/types/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Making developing with Web5 components at least 5 times easier to work with.
+ *
+ * Web5 consists of the following components:
+ * - Decentralized Identifiers
+ * - Verifiable Credentials
+ * - DWeb Node personal datastores
+ *
+ * The SDK sets out to gather the most oft used functionality from all three of
+ * these pillar technologies to provide a simple library that is as close to
+ * effortless as possible.
+ *
+ * The SDK is currently still under active development, but having entered the
+ * Tech Preview phase there is now a drive to avoid unnecessary changes unless
+ * backwards compatibility is provided. Additional functionality will be added
+ * in the lead up to 1.0 final, and modifications will be made to address
+ * issues and community feedback.
+ *
+ * [Link to GitHub Repo](https://github.com/TBD54566975/web5-js)
+ *
+ * @packageDocumentation
+ */
+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';
+export * from './web5.js';
+import * as utils from './utils.js';
+export { utils };
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAE1B,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/types/permission-grant.d.ts

@@ -0,0 +1,157 @@
+import type { DwnDataEncodedRecordsWriteMessage, DwnPermissionConditions, DwnPermissionScope, DwnResponseStatus, Web5Agent } from '@enbox/agent';
+import { DwnPermissionGrant } from '@enbox/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.
+     */
+    readonly id: string;
+    /**
+     * The grantor of the permission.
+     */
+    readonly grantor: string;
+    /**
+     * The grantee of the permission.
+     */
+    readonly grantee: string;
+    /**
+     * The date at which the grant was given.
+     */
+    readonly dateGranted: string;
+    /**
+     * Optional string that communicates what the grant would be used for
+     */
+    readonly description?: string;
+    /**
+     * Optional CID of a permission request. This is optional because grants may be given without being officially requested
+     */
+    readonly requestId?: string;
+    /**
+     * Timestamp at which this grant will no longer be active.
+     */
+    readonly dateExpires: string;
+    /**
+     * Whether this grant is delegated or not. If `true`, the `grantedTo` will be able to act as the `grantedTo` within the scope of this grant.
+     */
+    readonly delegated?: boolean;
+    /**
+     * The scope of the allowed access.
+     */
+    readonly scope: DwnPermissionScope;
+    /**
+     * Optional conditions that must be met when the grant is used.
+     */
+    readonly conditions?: DwnPermissionConditions;
+}
+/**
+ * Represents the options for creating a new PermissionGrant instance.
+ */
+export interface PermissionGrantOptions {
+    /** The DID to use when interacting with the underlying DWN record representing the grant */
+    connectedDid: string;
+    /** The underlying DWN `RecordsWrite` message along with encoded data that represent the grant */
+    message: DwnDataEncodedRecordsWriteMessage;
+    /** The agent to use when interacting with the underlying DWN record representing the grant */
+    agent: Web5Agent;
+}
+/**
+ * The `PermissionGrant` class encapsulates a permissions protocol `grant` record, providing a more
+ * developer-friendly interface for working with Decentralized Web Node (DWN) records.
+ *
+ * Methods are provided to revoke, check if isRevoked, and manage the grant's lifecycle, including writing to remote DWNs.
+ *
+ * @beta
+ */
+export declare class PermissionGrant implements PermissionGrantModel {
+    /** The PermissionsAPI used to interact with the underlying permission grant */
+    private _permissions;
+    /** The DID to use as the author and default target for the underlying permission grant */
+    private _connectedDid;
+    /** The underlying DWN `RecordsWrite` message along with encoded data that represent the grant */
+    private _message;
+    /** The parsed grant object */
+    private _grant;
+    private constructor();
+    /** parses the grant given an agent, connectedDid and data encoded records write message  */
+    static parse(options: PermissionGrantOptions): Promise<PermissionGrant>;
+    /** The agent to use for this instantiation of the grant */
+    private get agent();
+    /** The grant's ID, which is also the underlying record's ID */
+    get id(): string;
+    /** The DID which granted the permission  */
+    get grantor(): string;
+    /** The DID which the permission was granted to */
+    get grantee(): string;
+    /** The date the permission was granted */
+    get dateGranted(): string;
+    /** (optional) Description of the permission grant */
+    get description(): string | undefined;
+    /** (optional) The Id of the PermissionRequest if one was used */
+    get requestId(): string | undefined;
+    /** The date on which the permission expires */
+    get dateExpires(): string;
+    /** Whether or not the permission grant can be used to impersonate the grantor */
+    get delegated(): boolean | undefined;
+    /** The permission scope under which the grant is valid */
+    get scope(): DwnPermissionScope;
+    /** The conditions under which the grant is valid */
+    get conditions(): DwnPermissionConditions;
+    /** The raw `RecordsWrite` DWN message with encoded data that was used to instantiate this grant */
+    get rawMessage(): DwnDataEncodedRecordsWriteMessage;
+    /**
+     * Send the current grant to a remote DWN by specifying their DID
+     * If no DID is specified, the target is assumed to be the owner (connectedDID).
+     *
+     * @param target - the optional DID to send the grant to, if none is set it is sent to the connectedDid
+     * @returns the status of the send grant request
+     *
+     * @beta
+     */
+    send(target?: string): Promise<DwnResponseStatus>;
+    /**
+     * Stores the current grant to the owner's DWN.
+     *
+     * @param importGrant - if true, the grant will signed by the owner before storing it to the owner's DWN. Defaults to false.
+     * @returns the status of the store request
+     *
+     * @beta
+     */
+    store(importGrant?: boolean): Promise<DwnResponseStatus>;
+    /**
+     * Signs the current grant as the owner and optionally stores it to the owner's DWN.
+     * This is useful when importing a grant that was signed by someone else into your own DWN.
+     *
+     * @param store - if true, the grant will be stored to the owner's DWN after signing. Defaults to true.
+     * @returns the status of the import request
+     *
+     * @beta
+     */
+    import(store?: boolean): Promise<DwnResponseStatus>;
+    /**
+     * Revokes the grant and optionally stores the revocation to the owner's DWN.
+     *
+     * @param store - if true, the revocation will be stored to the owner's DWN. Defaults to true.
+     * @returns {PermissionGrantRevocation} the grant revocation object
+     *
+     * @beta
+     */
+    revoke(store?: boolean): Promise<PermissionGrantRevocation>;
+    /**
+     * Checks if the grant has been revoked.
+     *
+     * @param remote - if true, the check will be made against the remote DWN. Defaults to false.
+     * @returns true if the grant has been revoked, false otherwise.
+     * @throws if there is an error checking the revocation status.
+     *
+     * @beta
+     */
+    isRevoked(remote?: boolean): Promise<boolean>;
+    /**
+     * @returns the JSON representation of the grant
+     */
+    toJSON(): DwnPermissionGrant;
+}
+//# sourceMappingURL=permission-grant.d.ts.map

package/dist/types/permission-grant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission-grant.d.ts","sourceRoot":"","sources":["../../src/permission-grant.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iCAAiC,EACjC,uBAAuB,EACvB,kBAAkB,EAClB,iBAAiB,EAEjB,SAAS,EACV,MAAM,cAAc,CAAC;AAGtB,OAAO,EAGL,kBAAkB,EACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,uBAAuB,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,4FAA4F;IAC5F,YAAY,EAAE,MAAM,CAAC;IACrB,iGAAiG;IACjG,OAAO,EAAE,iCAAiC,CAAC;IAC3C,8FAA8F;IAC9F,KAAK,EAAE,SAAS,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,qBAAa,eAAgB,YAAW,oBAAoB;IAC1D,+EAA+E;IAC/E,OAAO,CAAC,YAAY,CAAsB;IAC1C,0FAA0F;IAC1F,OAAO,CAAC,aAAa,CAAS;IAC9B,iGAAiG;IACjG,OAAO,CAAC,QAAQ,CAAoC;IACpD,8BAA8B;IAC9B,OAAO,CAAC,MAAM,CAAqB;IAEnC,OAAO;IAkBP,4FAA4F;WAC/E,KAAK,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC;IAO7E,2DAA2D;IAC3D,OAAO,KAAK,KAAK,GAEhB;IAED,+DAA+D;IAC/D,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,4CAA4C;IAC5C,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,kDAAkD;IAClD,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,0CAA0C;IAC1C,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,qDAAqD;IACrD,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,iEAAiE;IACjE,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAElC;IAED,+CAA+C;IAC/C,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,iFAAiF;IACjF,IAAI,SAAS,IAAI,OAAO,GAAG,SAAS,CAEnC;IAED,0DAA0D;IAC1D,IAAI,KAAK,IAAI,kBAAkB,CAE9B;IAED,oDAAoD;IACpD,IAAI,UAAU,IAAI,uBAAuB,CAExC;IAED,mGAAmG;IACnG,IAAI,UAAU,IAAI,iCAAiC,CAElD;IAED;;;;;;;;OAQG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAmBvD;;;;;;;OAOG;IACG,KAAK,CAAC,WAAW,GAAE,OAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkBrE;;;;;;;;OAQG;IACG,MAAM,CAAC,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkBhE;;;;;;;OAOG;IACG,MAAM,CAAC,KAAK,GAAE,OAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAcvE;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IASpD;;OAEG;IACH,MAAM,IAAI,kBAAkB;CAc7B"}