@enbox/dwn-sdk-js 0.0.1

package/dist/types/src/types/jose-types.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Contains a public-private key pair and the associated key ID.
+ */
+export type KeyMaterial = {
+    keyId: string;
+    keyPair: {
+        publicJwk: PublicJwk;
+        privateJwk: PrivateJwk;
+    };
+};
+export type Jwk = {
+    /** The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. */
+    alg?: string;
+    /** The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. */
+    kid?: string;
+    /** identifies the cryptographic algorithm family used with the key, such "EC". */
+    kty: string;
+};
+export type PublicJwk = Jwk & {
+    /** The "crv" (curve) parameter identifies the cryptographic curve used with the key.
+     * MUST be present for all EC public keys
+     */
+    crv: 'Ed25519' | 'secp256k1' | 'P-256';
+    /**
+     * the x coordinate for the Elliptic Curve point.
+     * Represented as the base64url encoding of the octet string representation of the coordinate.
+     * MUST be present for all EC public keys
+     */
+    x: string;
+    /**
+     * the y coordinate for the Elliptic Curve point.
+     * Represented as the base64url encoding of the octet string representation of the coordinate.
+     */
+    y?: string;
+};
+export type PrivateJwk = PublicJwk & {
+    /**
+     * the Elliptic Curve private key value.
+     * It is represented as the base64url encoding of the octet string representation of the private key value
+     * MUST be present to represent Elliptic Curve private keys.
+     */
+    d: string;
+};
+export interface SignatureAlgorithm {
+    /**
+     * signs the provided payload using the provided JWK
+     * @param content - the content to sign
+     * @param privateJwk - the key to sign with
+     * @returns the signed content (aka signature)
+     */
+    sign(content: Uint8Array, privateJwk: PrivateJwk): Promise<Uint8Array>;
+    /**
+     * Verifies a signature against the provided payload hash and public key.
+     * @param content - the content to verify with
+     * @param signature - the signature to verify against
+     * @param publicJwk - the key to verify with
+     * @returns a boolean indicating whether the signature matches
+     */
+    verify(content: Uint8Array, signature: Uint8Array, publicJwk: PublicJwk): Promise<boolean>;
+    /**
+     * generates a random key pair
+     * @returns the public and private keys as JWKs
+     */
+    generateKeyPair(): Promise<{
+        publicJwk: PublicJwk;
+        privateJwk: PrivateJwk;
+    }>;
+    /**
+     * converts public key in bytes into a JWK
+     * @param publicKeyBytes - the public key to convert into JWK
+     * @returns the public key in JWK format
+     */
+    publicKeyToJwk(publicKeyBytes: Uint8Array): Promise<PublicJwk>;
+}
+//# sourceMappingURL=jose-types.d.ts.map

package/dist/types/src/types/jose-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jose-types.d.ts","sourceRoot":"","sources":["../../../../src/types/jose-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE;QAAE,SAAS,EAAE,SAAS,CAAC;QAAC,UAAU,EAAE,UAAU,CAAA;KAAE,CAAA;CAC1D,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG;IAChB,8FAA8F;IAC9F,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8FAA8F;IAC9F,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kFAAkF;IAClF,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,GAAG,GAAG;IAC5B;;OAEG;IACH,GAAG,EAAE,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC;IACvC;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IACV;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG;IACnC;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;CACX,CAAC;AAEF,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvE;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE3F;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC;QAAE,SAAS,EAAE,SAAS,CAAC;QAAC,UAAU,EAAE,UAAU,CAAA;KAAE,CAAC,CAAA;IAG5E;;;;OAIG;IACH,cAAc,CAAC,cAAc,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC/D"}

package/dist/types/src/types/jws-types.d.ts

@@ -0,0 +1,27 @@
+/**
+ * General JWS definition. Payload is returned as an empty
+ * string when JWS Unencoded Payload Option
+ * [RFC7797](https://www.rfc-editor.org/rfc/rfc7797) is used.
+ */
+export type GeneralJws = {
+    payload: string;
+    signatures: SignatureEntry[];
+};
+/**
+ * An entry of the `signatures` array in a general JWS.
+ */
+export type SignatureEntry = {
+    /**
+     * The "protected" member MUST be present and contain the value
+     * BASE64URL(UTF8(JWS Protected Header)) when the JWS Protected
+     * Header value is non-empty; otherwise, it MUST be absent.  These
+     * Header Parameter values are integrity protected.
+     */
+    protected: string;
+    /**
+     * The "signature" member MUST be present and contain the value
+     * BASE64URL(JWS Signature).
+     */
+    signature: string;
+};
+//# sourceMappingURL=jws-types.d.ts.map

package/dist/types/src/types/jws-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jws-types.d.ts","sourceRoot":"","sources":["../../../../src/types/jws-types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,cAAc,EAAE,CAAA;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB,CAAC"}

package/dist/types/src/types/message-interface.d.ts

@@ -0,0 +1,27 @@
+import type { GenericMessage, GenericSignaturePayload } from './message-types.js';
+/**
+ * An generic interface that represents a DWN message and convenience methods for working with it.
+ */
+export interface MessageInterface<M extends GenericMessage> {
+    /**
+     * Valid JSON message representing this DWN message.
+     */
+    get message(): M;
+    /**
+     * Gets the signer of this message.
+     * This is not to be confused with the logical author of the message.
+     */
+    get signer(): string | undefined;
+    /**
+     * DID of the logical author of this message.
+     * NOTE: we say "logical" author because a message can be signed by a delegate of the actual author,
+     * in which case the author DID would not be the same as the signer/delegate DID,
+     * but be the DID of the grantor (`grantedBy`) of the delegated grant presented.
+     */
+    get author(): string | undefined;
+    /**
+     * Decoded payload of the signature of this message.
+     */
+    get signaturePayload(): GenericSignaturePayload | undefined;
+}
+//# sourceMappingURL=message-interface.d.ts.map

package/dist/types/src/types/message-interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-interface.d.ts","sourceRoot":"","sources":["../../../../src/types/message-interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,cAAc;IACxD;;OAEG;IACH,IAAI,OAAO,IAAI,CAAC,CAAC;IAEjB;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAAC;IAEjC;;;;;OAKG;IACH,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAAC;IAEjC;;OAEG;IACH,IAAI,gBAAgB,IAAI,uBAAuB,GAAG,SAAS,CAAC;CAC7D"}

package/dist/types/src/types/message-store.d.ts

@@ -0,0 +1,42 @@
+import type { Filter, KeyValues, PaginationCursor } from './query-types.js';
+import type { GenericMessage, MessageSort, Pagination } from './message-types.js';
+export interface MessageStoreOptions {
+    signal?: AbortSignal;
+}
+export interface MessageStore {
+    /**
+     * opens a connection to the underlying store
+     */
+    open(): Promise<void>;
+    /**
+     * closes the connection to the underlying store
+     */
+    close(): Promise<void>;
+    /**
+     * adds a message to the underlying store. Uses the message's cid as the key
+     * @param indexes indexes (key-value pairs) to be included as part of this put operation
+     */
+    put(tenant: string, message: GenericMessage, indexes: KeyValues, options?: MessageStoreOptions): Promise<void>;
+    /**
+     * Fetches a single message by `cid` from the underlying store.
+     * Returns `undefined` no message was found.
+     */
+    get(tenant: string, cid: string, options?: MessageStoreOptions): Promise<GenericMessage | undefined>;
+    /**
+     * Queries the underlying store for messages that matches the provided filters.
+     * Supplying multiple filters establishes an OR condition between the filters.
+     */
+    query(tenant: string, filters: Filter[], messageSort?: MessageSort, pagination?: Pagination, options?: MessageStoreOptions): Promise<{
+        messages: GenericMessage[];
+        cursor?: PaginationCursor;
+    }>;
+    /**
+     * Deletes the message associated with the id provided.
+     */
+    delete(tenant: string, cid: string, options?: MessageStoreOptions): Promise<void>;
+    /**
+     * Clears the entire store. Mainly used for cleaning up in test environment.
+     */
+    clear(): Promise<void>;
+}
+//# sourceMappingURL=message-store.d.ts.map

package/dist/types/src/types/message-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-store.d.ts","sourceRoot":"","sources":["../../../../src/types/message-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC5E,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAElF,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;OAGG;IACH,GAAG,CACD,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,SAAS,EAClB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;OAGG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAErG;;;OAGG;IACH,KAAK,CACH,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EAAE,EACjB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,UAAU,EACvB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC;QAAE,QAAQ,EAAE,cAAc,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,gBAAgB,CAAA;KAAC,CAAC,CAAC;IAErE;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElF;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB"}

package/dist/types/src/types/message-types.d.ts

@@ -0,0 +1,116 @@
+import type { GeneralJws } from './jws-types.js';
+import type { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+import type { PaginationCursor, SortDirection } from './query-types.js';
+/**
+ * Intersection type for all concrete message types.
+ */
+export type GenericMessage = {
+    descriptor: Descriptor;
+    authorization?: AuthorizationModel;
+};
+/**
+ * The data model for the `authorization` property in a DWN message.
+ */
+export type AuthorizationModel = {
+    /**
+     * The signature of the message signer.
+     * NOTE: the signer is not necessarily the logical author of the message (e.g. signer is a delegate).
+     */
+    signature: GeneralJws;
+    /**
+     * The delegated grant required when the message is signed by an author-delegate.
+     */
+    authorDelegatedGrant?: DelegatedGrantRecordsWriteMessage;
+    /**
+     * An "overriding" signature for a DWN owner or owner-delegate to store a message authored by another entity.
+     */
+    ownerSignature?: GeneralJws;
+    /**
+     * The delegated grant required when the message is signed by an owner-delegate.
+     */
+    ownerDelegatedGrant?: DelegatedGrantRecordsWriteMessage;
+};
+export type DelegatedGrantRecordsWriteMessage = {
+    authorization: {
+        /**
+         * The signature of the author.
+         */
+        signature: GeneralJws;
+    };
+    recordId: string;
+    contextId?: string;
+    descriptor: {
+        interface: DwnInterfaceName.Records;
+        method: DwnMethodName.Write;
+        protocol?: string;
+        protocolPath?: string;
+        recipient?: string;
+        schema?: string;
+        parentId?: string;
+        dataCid: string;
+        dataSize: number;
+        dateCreated: string;
+        messageTimestamp: string;
+        published?: boolean;
+        datePublished?: string;
+        dataFormat: string;
+    };
+    encodedData: string;
+};
+/**
+ * Type of common decoded `authorization` property payload.
+ */
+export type GenericSignaturePayload = {
+    descriptorCid: string;
+    permissionGrantId?: string;
+    /**
+     * Record ID of a permission grant DWN `RecordsWrite` with `delegated` set to `true`.
+     */
+    delegatedGrantId?: string;
+    /**
+     * Used in the Records interface to authorize role-authorized actions for protocol records.
+     */
+    protocolRole?: string;
+};
+/**
+ * Intersection type for all DWN message descriptor.
+ */
+export type Descriptor = {
+    interface: string;
+    method: string;
+    messageTimestamp: string;
+};
+/**
+ * Message returned in a query result.
+ * NOTE: the message structure is a modified version of the message received, the most notable differences are:
+ * 1. May include encoded data
+ */
+export type QueryResultEntry = GenericMessage & {
+    encodedData?: string;
+};
+export interface MessageSubscription {
+    id: string;
+    close: () => Promise<void>;
+}
+/**
+ * Pagination Options for querying messages.
+ *
+ * The cursor is the messageCid of the message you would like to pagination from.
+ */
+export type Pagination = {
+    cursor?: PaginationCursor;
+    limit?: number;
+};
+export type Status = {
+    code: number;
+    detail: string;
+};
+export type GenericMessageReply = {
+    status: Status;
+};
+export type MessageSort = {
+    dateCreated?: SortDirection;
+    datePublished?: SortDirection;
+    messageTimestamp?: SortDirection;
+};
+//# sourceMappingURL=message-types.d.ts.map

package/dist/types/src/types/message-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-types.d.ts","sourceRoot":"","sources":["../../../../src/types/message-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACxF,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,UAAU,CAAC;IACvB,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,SAAS,EAAE,UAAU,CAAC;IAEtB;;OAEG;IACH,oBAAoB,CAAC,EAAE,iCAAiC,CAAC;IAEzD;;OAEG;IACH,cAAc,CAAC,EAAE,UAAU,CAAC;IAE5B;;OAEG;IACH,mBAAmB,CAAC,EAAE,iCAAiC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,aAAa,EAAE;QACb;;WAEG;QACH,SAAS,EAAE,UAAU,CAAC;KACvB,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE;QACV,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC;QACpC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC;QAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,gBAAgB,EAAE,MAAM,CAAC;QACzB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,GAAG;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,gBAAgB,CAAC,EAAE,aAAa,CAAC;CAClC,CAAC"}

package/dist/types/src/types/messages-types.d.ts

@@ -0,0 +1,65 @@
+import type { MessageEvent } from './subscriptions.js';
+import type { Readable } from 'readable-stream';
+import type { AuthorizationModel, GenericMessage, GenericMessageReply, MessageSubscription } from './message-types.js';
+import type { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+import type { PaginationCursor, RangeCriterion } from './query-types.js';
+/**
+ * filters used when filtering for any type of Message across interfaces
+ */
+export type MessagesFilter = {
+    interface?: string;
+    method?: string;
+    protocol?: string;
+    messageTimestamp?: RangeCriterion;
+};
+export type MessagesReadDescriptor = {
+    interface: DwnInterfaceName.Messages;
+    method: DwnMethodName.Read;
+    messageCid: string;
+    messageTimestamp: string;
+};
+export type MessagesReadMessage = GenericMessage & {
+    authorization: AuthorizationModel;
+    descriptor: MessagesReadDescriptor;
+};
+export type MessagesReadReplyEntry = {
+    messageCid: string;
+    message: GenericMessage;
+    data?: Readable;
+};
+export type MessagesReadReply = GenericMessageReply & {
+    entry?: MessagesReadReplyEntry;
+};
+export type MessagesQueryDescriptor = {
+    interface: DwnInterfaceName.Messages;
+    method: DwnMethodName.Query;
+    messageTimestamp: string;
+    filters: MessagesFilter[];
+    cursor?: PaginationCursor;
+};
+export type MessagesQueryMessage = GenericMessage & {
+    authorization: AuthorizationModel;
+    descriptor: MessagesQueryDescriptor;
+};
+export type MessagesQueryReply = GenericMessageReply & {
+    entries?: string[];
+    cursor?: PaginationCursor;
+};
+export type MessageSubscriptionHandler = (event: MessageEvent) => void;
+export type MessagesSubscribeMessageOptions = {
+    subscriptionHandler: MessageSubscriptionHandler;
+};
+export type MessagesSubscribeMessage = {
+    authorization: AuthorizationModel;
+    descriptor: MessagesSubscribeDescriptor;
+};
+export type MessagesSubscribeReply = GenericMessageReply & {
+    subscription?: MessageSubscription;
+};
+export type MessagesSubscribeDescriptor = {
+    interface: DwnInterfaceName.Messages;
+    method: DwnMethodName.Subscribe;
+    messageTimestamp: string;
+    filters: MessagesFilter[];
+};
+//# sourceMappingURL=messages-types.d.ts.map

package/dist/types/src/types/messages-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages-types.d.ts","sourceRoot":"","sources":["../../../../src/types/messages-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACvH,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACxF,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,cAAc,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAG,gBAAgB,CAAC,QAAQ,CAAC;IACtC,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG;IACjD,aAAa,EAAE,kBAAkB,CAAC;IAClC,UAAU,EAAE,sBAAsB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,cAAc,CAAC;IACxB,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,mBAAmB,GAAG;IACpD,KAAK,CAAC,EAAE,sBAAsB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC;IACrC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,aAAa,EAAE,kBAAkB,CAAC;IAClC,UAAU,EAAE,uBAAuB,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IACrD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;AAEvE,MAAM,MAAM,+BAA+B,GAAG;IAC5C,mBAAmB,EAAE,0BAA0B,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,aAAa,EAAE,kBAAkB,CAAC;IAClC,UAAU,EAAE,2BAA2B,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,GAAG;IACzD,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC;IACrC,MAAM,EAAE,aAAa,CAAC,SAAS,CAAC;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC"}

package/dist/types/src/types/method-handler.d.ts

@@ -0,0 +1,19 @@
+import type { MessageSubscriptionHandler } from './messages-types.js';
+import type { Readable } from 'readable-stream';
+import type { RecordSubscriptionHandler } from './records-types.js';
+import type { GenericMessage, GenericMessageReply } from './message-types.js';
+/**
+ * Interface that defines a message handler of a specific method.
+ */
+export interface MethodHandler {
+    /**
+     * Handles the given message and returns a `MessageReply` response.
+     */
+    handle(input: {
+        tenant: string;
+        message: GenericMessage;
+        dataStream?: Readable;
+        subscriptionHandler?: MessageSubscriptionHandler | RecordSubscriptionHandler;
+    }): Promise<GenericMessageReply>;
+}
+//# sourceMappingURL=method-handler.d.ts.map

package/dist/types/src/types/method-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"method-handler.d.ts","sourceRoot":"","sources":["../../../../src/types/method-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,cAAc,CAAC;QACxB,UAAU,CAAC,EAAE,QAAQ,CAAA;QACrB,mBAAmB,CAAC,EAAE,0BAA0B,GAAG,yBAAyB,CAAC;KAC9E,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAClC"}

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

@@ -0,0 +1,93 @@
+import type { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+/**
+ * Type for the data payload of a permission request message.
+ */
+export type PermissionRequestData = {
+    /**
+     * If the grant is a delegated grant or not. If `true`, the `grantedTo` will be able to act as the `grantedBy` within the scope of this grant.
+     */
+    delegated: boolean;
+    /**
+     * Optional string that communicates what the grant would be used for.
+     */
+    description?: string;
+    /**
+     * The scope of the allowed access.
+     */
+    scope: PermissionScope;
+    conditions?: PermissionConditions;
+};
+/**
+ * Type for the data payload of a permission grant message.
+ */
+export type PermissionGrantData = {
+    /**
+     * Optional string that communicates what the grant would be used for
+     */
+    description?: string;
+    /**
+     * Optional CID of a permission request. This is optional because grants may be given without being officially requested
+     * */
+    requestId?: string;
+    /**
+     * Timestamp at which this grant will no longer be active.
+     */
+    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.
+     */
+    delegated?: boolean;
+    /**
+     * The scope of the allowed access.
+     */
+    scope: PermissionScope;
+    conditions?: PermissionConditions;
+};
+/**
+ * Type for the data payload of a permission revocation message.
+ */
+export type PermissionRevocationData = {
+    /**
+     * Optional string that communicates the details of the revocation.
+     */
+    description?: string;
+};
+/**
+ * The data model for a permission scope.
+ */
+export type PermissionScope = ProtocolPermissionScope | MessagesPermissionScope | RecordsPermissionScope;
+export type ProtocolPermissionScope = {
+    interface: DwnInterfaceName.Protocols;
+    method: DwnMethodName.Configure | DwnMethodName.Query;
+    protocol?: string;
+};
+export type MessagesPermissionScope = {
+    interface: DwnInterfaceName.Messages;
+    method: DwnMethodName.Query | DwnMethodName.Read | DwnMethodName.Subscribe;
+    protocol?: string;
+};
+/**
+ * The data model for a permission scope that is specific to the Records interface.
+ */
+export type RecordsPermissionScope = {
+    interface: DwnInterfaceName.Records;
+    method: DwnMethodName.Read | DwnMethodName.Write | DwnMethodName.Query | DwnMethodName.Subscribe | DwnMethodName.Delete;
+    protocol: string;
+    /** May only be present when `protocol` is defined and `protocolPath` is undefined */
+    contextId?: string;
+    /** May only be present when `protocol` is defined and `contextId` is undefined */
+    protocolPath?: string;
+};
+export declare enum PermissionConditionPublication {
+    Required = "Required",
+    Prohibited = "Prohibited"
+}
+export type PermissionConditions = {
+    /**
+     * indicates whether a message written with the invocation of a permission must, may, or must not
+     * be marked as public.
+     * If `undefined`, it is optional to make the message public.
+     */
+    publication?: PermissionConditionPublication;
+};
+//# sourceMappingURL=permission-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"permission-types.d.ts","sourceRoot":"","sources":["../../../../src/types/permission-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAExF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAElC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAA;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;SAEK;IACL,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAA;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,uBAAuB,GAAG,uBAAuB,GAAG,sBAAsB,CAAC;AAEzG,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,gBAAgB,CAAC,SAAS,CAAC;IACtC,MAAM,EAAE,aAAa,CAAC,SAAS,GAAG,aAAa,CAAC,KAAK,CAAC;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC;IACrC,MAAM,EAAE,aAAa,CAAC,KAAK,GAAG,aAAa,CAAC,IAAI,GAAG,aAAa,CAAC,SAAS,CAAC;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC;IACpC,MAAM,EAAE,aAAa,CAAC,IAAI,GAAG,aAAa,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,GAAG,aAAa,CAAC,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC;IACxH,QAAQ,EAAE,MAAM,CAAC;IACjB,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kFAAkF;IAClF,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,oBAAY,8BAA8B;IACxC,QAAQ,aAAa;IACrB,UAAU,eAAe;CAC1B;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;OAIG;IACH,WAAW,CAAC,EAAE,8BAA8B,CAAC;CAC9C,CAAC"}

package/dist/types/src/types/protocols-types.d.ts

@@ -0,0 +1,154 @@
+import type { PublicJwk } from './jose-types.js';
+import type { AuthorizationModel, GenericMessage, GenericMessageReply } from './message-types.js';
+import type { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export type ProtocolsConfigureDescriptor = {
+    interface: DwnInterfaceName.Protocols;
+    method: DwnMethodName.Configure;
+    messageTimestamp: string;
+    definition: ProtocolDefinition;
+};
+export type ProtocolDefinition = {
+    protocol: string;
+    /**
+     * Denotes if this Protocol Definition can be returned by unauthenticated or unauthorized `ProtocolsQuery`.
+     */
+    published: boolean;
+    types: ProtocolTypes;
+    structure: {
+        [key: string]: ProtocolRuleSet;
+    };
+};
+export type ProtocolType = {
+    schema?: string;
+    dataFormats?: string[];
+};
+export type ProtocolTypes = {
+    [key: string]: ProtocolType;
+};
+export declare enum ProtocolActor {
+    Anyone = "anyone",
+    Author = "author",
+    Recipient = "recipient"
+}
+export declare enum ProtocolAction {
+    CoDelete = "co-delete",
+    CoPrune = "co-prune",
+    CoUpdate = "co-update",
+    Create = "create",
+    Delete = "delete",
+    Prune = "prune",
+    Query = "query",
+    Read = "read",
+    Subscribe = "subscribe",
+    Update = "update"
+}
+/**
+ * Rules defining which actors may access a record at the given protocol path.
+ * Rules take three forms, e.g.:
+ * 1. Anyone can create.
+ *   {
+ *     who: 'anyone',
+ *     can: ['create']
+ *   }
+ *
+ * 2. Author of protocolPath can create; OR
+ *    Recipient of protocolPath can write.
+ *   {
+ *     who: 'recipient'
+ *     of: 'requestForQuote',
+ *     can: ['create']
+ *   }
+ *
+ * 3. Role can create.
+ *   {
+ *     role: 'friend',
+ *     can: ['create']
+ *   }
+ */
+export type ProtocolActionRule = {
+    /**
+     * May be 'anyone' | 'author' | 'recipient'.
+     * If `who` === 'anyone', then `of` must be omitted. Otherwise `of` must be present.
+     * Mutually exclusive with `role`
+     */
+    who?: string;
+    /**
+     * The protocol path of a role record type marked with $role: true.
+     * Mutually exclusive with `who`
+     */
+    role?: string;
+    /**
+     * Protocol path.
+     * Must be present if `who` === 'author' or 'recipient'
+     */
+    of?: string;
+    /**
+     * Array of actions that the actor/role can perform.
+     * See {ProtocolAction} for possible values.
+     * 'query' and 'subscribe' are only supported for `role` rules.
+     */
+    can: string[];
+};
+/**
+ * Config for protocol-path encryption scheme.
+ */
+export type ProtocolPathEncryption = {
+    /**
+     * The ID of the root key that derives the public key at this protocol path for encrypting the symmetric key used for data encryption.
+     */
+    rootKeyId: string;
+    /**
+     * Public key for encrypting the symmetric key used for data encryption.
+     */
+    publicKeyJwk: PublicJwk;
+};
+export type ProtocolRuleSet = {
+    /**
+     * Encryption setting for objects that are in this protocol path.
+     */
+    $encryption?: ProtocolPathEncryption;
+    $actions?: ProtocolActionRule[];
+    /**
+     * If true, this marks a record as a `role` that may used within a context.
+     * The recipient of a $role record may invoke their role by setting `protocolRole` property to the protocol path of the $role record.
+     */
+    $role?: boolean;
+    /**
+     * If $size is set, the record size in bytes must be within the limits.
+     */
+    $size?: {
+        min?: number;
+        max?: number;
+    };
+    /**
+     * If $tags is set, the record must conform to the tag rules.
+     */
+    $tags?: {
+        /** array of required tags */
+        $requiredTags?: string[];
+        /** allow properties other than those explicitly listed. defaults to false  */
+        $allowUndefinedTags?: boolean;
+        [key: string]: any;
+    };
+    [key: string]: any;
+};
+export type ProtocolsConfigureMessage = GenericMessage & {
+    authorization: AuthorizationModel;
+    descriptor: ProtocolsConfigureDescriptor;
+};
+export type ProtocolsQueryFilter = {
+    protocol: string;
+};
+export type ProtocolsQueryDescriptor = {
+    interface: DwnInterfaceName.Protocols;
+    method: DwnMethodName.Query;
+    messageTimestamp: string;
+    filter?: ProtocolsQueryFilter;
+};
+export type ProtocolsQueryMessage = GenericMessage & {
+    descriptor: ProtocolsQueryDescriptor;
+};
+export type ProtocolsQueryReply = GenericMessageReply & {
+    entries?: ProtocolsConfigureMessage[];
+};
+//# sourceMappingURL=protocols-types.d.ts.map

package/dist/types/src/types/protocols-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocols-types.d.ts","sourceRoot":"","sources":["../../../../src/types/protocols-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAClG,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAExF,MAAM,MAAM,4BAA4B,GAAG;IACzC,SAAS,EAAG,gBAAgB,CAAC,SAAS,CAAC;IACvC,MAAM,EAAE,aAAa,CAAC,SAAS,CAAC;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,kBAAkB,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,aAAa,CAAC;IACrB,SAAS,EAAE;QACT,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;KAChC,CAAA;CACF,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC;CAC7B,CAAC;AAEF,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,cAAc;CACxB;AAED,oBAAY,cAAc;IACxB,QAAQ,cAAc;IACtB,OAAO,aAAa;IACpB,QAAQ,cAAc;IACtB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,MAAM,WAAW;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,GAAG,EAAE,MAAM,EAAE,CAAC;CACf,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IAEnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,SAAS,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,sBAAsB,CAAC;IACrC,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAEhC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAA;KACb,CAAA;IAED;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,6BAA6B;QAC7B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;QACzB,8EAA8E;QAC9E,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAE9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAA;IAGD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,cAAc,GAAG;IACvD,aAAa,EAAE,kBAAkB,CAAC;IAClC,UAAU,EAAE,4BAA4B,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,SAAS,EAAG,gBAAgB,CAAC,SAAS,CAAC;IACvC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,oBAAoB,CAAA;CAC9B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,UAAU,EAAE,wBAAwB,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG;IACtD,OAAO,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACvC,CAAC"}