@abaxxtech/id 0.0.0

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';
+    /**
+     * 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,CAAC;IAC7B;;;;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,22 @@
+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;
+    /**
+     * 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;;;;;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,43 @@
+import type { Filter, 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: {
+        [key: string]: string | boolean;
+    }, 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?: string;
+    }>;
+    /**
+     * 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,cAAc,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE1F,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;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,EAC5C,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,MAAM,CAAA;KAAE,CAAC,CAAC;IAE5D;;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,113 @@
+import type { DelegatedGrantMessage } from '../types/delegated-grant-message.js';
+import type { GeneralJws } from './jws-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 optional signature of a DWN owner wishing store a message authored by another entity.
+     */
+    ownerSignature?: GeneralJws;
+    /**
+     * The delegated grant invoked by a delegate, if the message is signed by a delegate.
+     */
+    authorDelegatedGrant?: DelegatedGrantMessage;
+};
+/**
+ * Type of common decoded `authorization`property payload.
+ */
+export type GenericSignaturePayload = {
+    descriptorCid: string;
+    permissionsGrantId?: string;
+    /**
+     * CID of a `PermissionsGrant` DWN message 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. does not contain `authorization`
+ * 2. may include encoded data
+ */
+export type QueryResultEntry = {
+    descriptor: Descriptor;
+    encodedData?: string;
+};
+export type EqualFilter = string | number | boolean;
+export type OneOfFilter = EqualFilter[];
+export type RangeValue = string | number;
+/**
+ * "greater than" or "greater than or equal to" range condition. `gt` and `gte` are mutually exclusive.
+ */
+export type GT = ({
+    gt: RangeValue;
+} & {
+    gte?: never;
+}) | ({
+    gt?: never;
+} & {
+    gte: RangeValue;
+});
+/**
+ * "less than" or "less than or equal to" range condition. `lt`, `lte` are mutually exclusive.
+ */
+export type LT = ({
+    lt: RangeValue;
+} & {
+    lte?: never;
+}) | ({
+    lt?: never;
+} & {
+    lte: RangeValue;
+});
+/**
+ * Ranger filter. 1 condition is required.
+ */
+export type RangeFilter = (GT | LT) & Partial<GT> & Partial<LT>;
+export type Filter = {
+    [property: string]: EqualFilter | OneOfFilter | RangeFilter;
+};
+/**
+ * Pagination Options for querying messages.
+ *
+ * The cursor is the messageCid of the message you would like to pagination from.
+ */
+export type Pagination = {
+    cursor?: string;
+    limit?: number;
+};
+export declare enum SortOrder {
+    Descending = -1,
+    Ascending = 1
+}
+export type MessageSort = {
+    dateCreated?: SortOrder;
+    datePublished?: SortOrder;
+    messageTimestamp?: SortOrder;
+};
+//# 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,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AACjF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEjD;;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,cAAc,CAAC,EAAE,UAAU,CAAC;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;CAC9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;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;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpD,MAAM,MAAM,WAAW,GAAG,WAAW,EAAE,CAAC;AAExC,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,EAAE,GAAG,CAAC;IAAE,EAAE,EAAE,UAAU,CAAA;CAAE,GAAG;IAAE,GAAG,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC,GAAG,CAAC;IAAE,EAAE,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,GAAG,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC;AAEjG;;GAEG;AACH,MAAM,MAAM,EAAE,GAAG,CAAC;IAAE,EAAE,EAAE,UAAU,CAAA;CAAE,GAAG;IAAE,GAAG,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC,GAAG,CAAC;IAAE,EAAE,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,GAAG,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC;AAEjG;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;AAEhE,MAAM,MAAM,MAAM,GAAG;IACnB,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CAAA;CAC5D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,oBAAY,SAAS;IACnB,UAAU,KAAK;IACf,SAAS,IAAI;CACd;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,aAAa,CAAC,EAAE,SAAS,CAAC;IAC1B,gBAAgB,CAAC,EAAE,SAAS,CAAC;CAC9B,CAAC"}

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

@@ -0,0 +1,23 @@
+import type { GenericMessageReply } from '../core/message-reply.js';
+import type { AuthorizationModel, GenericMessage } from './message-types.js';
+import type { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export type MessagesGetDescriptor = {
+    interface: DwnInterfaceName.Messages;
+    method: DwnMethodName.Get;
+    messageCids: string[];
+    messageTimestamp: string;
+};
+export type MessagesGetMessage = GenericMessage & {
+    authorization: AuthorizationModel;
+    descriptor: MessagesGetDescriptor;
+};
+export type MessagesGetReplyEntry = {
+    messageCid: string;
+    message?: GenericMessage;
+    encodedData?: string;
+    error?: string;
+};
+export type MessagesGetReply = GenericMessageReply & {
+    messages?: MessagesGetReplyEntry[];
+};
+//# 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,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAExF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAG,gBAAgB,CAAC,QAAQ,CAAC;IACtC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC;IAC1B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,aAAa,EAAE,kBAAkB,CAAC;IAClC,UAAU,EAAE,qBAAqB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG;IACnD,QAAQ,CAAC,EAAE,qBAAqB,EAAE,CAAC;CACpC,CAAC"}

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

@@ -0,0 +1,17 @@
+import type { GenericMessage } from './message-types.js';
+import type { GenericMessageReply } from '../core/message-reply.js';
+import type { Readable } from 'readable-stream';
+/**
+ * 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;
+    }): 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,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;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;KACtB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAClC"}

package/dist/types/src/types/permissions-grant-descriptor.d.ts

@@ -0,0 +1,65 @@
+import type { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+export type PermissionsGrantDescriptor = {
+    interface: DwnInterfaceName.Permissions;
+    method: DwnMethodName.Grant;
+    messageTimestamp: string;
+    /**
+     * Optional CID of a PermissionsRequest message. This is optional because grants may be given without being officially requested
+     * */
+    permissionsRequestId?: string;
+    /**
+     * Timestamp at which this grant will no longer be active.
+     */
+    dateExpires: string;
+    /**
+     * The DID of the DWN which the grantee will be given access
+     */
+    grantedFor: string;
+    /**
+     * The recipient of the grant. Usually this is the author of the PermissionsRequest message
+     */
+    grantedTo: string;
+    /**
+     * The granter, who will be either the DWN owner or an entity who the DWN owner has delegated permission to.
+     */
+    grantedBy: 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;
+    /**
+     * Optional string that communicates what the grant would be used for
+     */
+    description?: string;
+    scope: PermissionScope;
+    conditions?: PermissionConditions;
+};
+export type PermissionScope = {
+    interface: DwnInterfaceName;
+    method: DwnMethodName;
+} | RecordsPermissionScope;
+export type RecordsPermissionScope = {
+    interface: DwnInterfaceName.Records;
+    method: DwnMethodName.Read | DwnMethodName.Write;
+    /** May only be present when `schema` is undefined */
+    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;
+    /** May only be present when `protocol` is undefined */
+    schema?: string;
+};
+export declare enum PermissionsConditionPublication {
+    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?: PermissionsConditionPublication;
+};
+//# sourceMappingURL=permissions-grant-descriptor.d.ts.map

package/dist/types/src/types/permissions-grant-descriptor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions-grant-descriptor.d.ts","sourceRoot":"","sources":["../../../../src/types/permissions-grant-descriptor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAExF,MAAM,MAAM,0BAA0B,GAAG;IACvC,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC;IACxC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;SAEK;IACL,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,EAAE,eAAe,CAAC;IACvB,UAAU,CAAC,EAAE,oBAAoB,CAAA;CAClC,CAAC;AAGF,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,MAAM,EAAE,aAAa,CAAC;CACvB,GAAG,sBAAsB,CAAC;AAG3B,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC;IACpC,MAAM,EAAE,aAAa,CAAC,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC;IACjD,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kFAAkF;IAClF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uDAAuD;IACvD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,oBAAY,+BAA+B;IACzC,QAAQ,aAAa;IACrB,UAAU,eAAe;CAC1B;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;OAIG;IACH,WAAW,CAAC,EAAE,+BAA+B,CAAC;CAC/C,CAAC"}

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

@@ -0,0 +1,33 @@
+import type { AuthorizationModel, GenericMessage } from './message-types.js';
+import type { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+import type { PermissionConditions, PermissionScope, PermissionsGrantDescriptor } from './permissions-grant-descriptor.js';
+export type PermissionsRequestDescriptor = {
+    interface: DwnInterfaceName.Permissions;
+    method: DwnMethodName.Request;
+    messageTimestamp: string;
+    grantedFor: string;
+    grantedTo: string;
+    grantedBy: string;
+    description?: string;
+    scope: PermissionScope;
+    conditions?: PermissionConditions;
+};
+export type PermissionsRequestMessage = GenericMessage & {
+    authorization: AuthorizationModel;
+    descriptor: PermissionsRequestDescriptor;
+};
+export type PermissionsGrantMessage = GenericMessage & {
+    authorization: AuthorizationModel;
+    descriptor: PermissionsGrantDescriptor;
+};
+export type PermissionsRevokeDescriptor = {
+    interface: DwnInterfaceName.Permissions;
+    method: DwnMethodName.Revoke;
+    messageTimestamp: string;
+    permissionsGrantId: string;
+};
+export type PermissionsRevokeMessage = GenericMessage & {
+    authorization: AuthorizationModel;
+    descriptor: PermissionsRevokeDescriptor;
+};
+//# sourceMappingURL=permissions-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"permissions-types.d.ts","sourceRoot":"","sources":["../../../../src/types/permissions-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACxF,OAAO,KAAK,EAAE,oBAAoB,EAAE,eAAe,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAE3H,MAAM,MAAM,4BAA4B,GAAG;IACzC,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC;IACxC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IAEzB,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,eAAe,CAAC;IACvB,UAAU,CAAC,EAAE,oBAAoB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,cAAc,GAAG;IACvD,aAAa,EAAE,kBAAkB,CAAC;IAClC,UAAU,EAAE,4BAA4B,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG;IACrD,aAAa,EAAE,kBAAkB,CAAC;IAClC,UAAU,EAAE,0BAA0B,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC;IACxC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;IAEzB,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,aAAa,EAAE,kBAAkB,CAAC;IAClC,UAAU,EAAE,2BAA2B,CAAC;CACzC,CAAC"}

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

@@ -0,0 +1,138 @@
+import type { GenericMessageReply } from '../core/message-reply.js';
+import type { PublicJwk } from './jose-types.js';
+import type { AuthorizationModel, GenericMessage } 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 `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 {
+    Delete = "delete",
+    Query = "query",
+    Read = "read",
+    Update = "update",
+    Write = "write"
+}
+/**
+ * Rules defining which actors may access a record at the given protocol path.
+ * Rules take three forms:
+ * 1. Anyone can write.
+ *   {
+ *     who: 'anyone',
+ *     can: 'write
+ *   }
+ *
+ * 2. Author of protocolPath can write; OR
+ *    Recipient of protocolPath can write.
+ *   {
+ *     who: 'recipient'
+ *     of: 'requestForQuote',
+ *     can: 'write'
+ *   }
+ *
+ * 3. Role can write.
+ *   {
+ *     role: 'friend',
+ *     can: 'write'
+ *   }
+ */
+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 record marked with $globalRole: true.
+     * Mutually exclusive with `who`
+     */
+    role?: string;
+    /**
+     * Protocol path.
+     * Must be present if `who` === 'author' or 'recipient'
+     */
+    of?: string;
+    /**
+     * Action that the actor can perform.
+     * May be 'query' | 'read' | 'write'
+     * 'query' is only supported for `role` rules.
+     */
+    can: string;
+};
+/**
+ * Config for protocol-path encryption scheme.
+ */
+export type ProtocolPathEncryption = {
+    /**
+     * 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 be used across contexts. Only root records
+     * may set $globalRole: true.
+     * The recipient of a $globalRole record may invoke their role in RecordsRead or RecordsWrites
+     * by setting `protocolRole` property to the protocol path of the $globalRole record.
+     */
+    $globalRole?: boolean;
+    /**
+     * If true, this marks a record as a `role` that may used within a single context. Only
+     * second-level records may set $contextRole: true.
+     * The recipient of a $contextRole record may invoke their role in RecordsReads or RecordsWrites
+     * by setting `protocolRole` property to the protocol path of the $contextRole record.
+     */
+    $contextRole?: boolean;
+    [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,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC7E,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,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;CAChB;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,CAAC;CACb,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;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;IAChC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,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"}