@enbox/dwn-sdk-js 0.0.1

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

@@ -0,0 +1,66 @@
+export type QueryOptions = {
+    sortProperty: string;
+    sortDirection?: SortDirection;
+    limit?: number;
+    cursor?: PaginationCursor;
+};
+export declare enum SortDirection {
+    Descending = -1,
+    Ascending = 1
+}
+export type KeyValues = {
+    [key: string]: string | number | boolean | string[] | number[];
+};
+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 StartsWithFilter = {
+    startsWith: string;
+};
+export type FilterValue = EqualFilter | OneOfFilter | RangeFilter;
+export type Filter = {
+    [property: string]: FilterValue;
+};
+export type RangeCriterion = {
+    /**
+     * Inclusive starting date-time.
+     */
+    from?: string;
+    /**
+     * Inclusive end date-time.
+     */
+    to?: string;
+};
+export type PaginationCursor = {
+    messageCid: string;
+    value: string | number;
+};
+//# sourceMappingURL=query-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"query-types.d.ts","sourceRoot":"","sources":["../../../../src/types/query-types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B,CAAC;AAEF,oBAAY,aAAa;IACvB,UAAU,KAAK;IACf,SAAS,IAAI;CACd;AAED,MAAM,MAAM,SAAS,GAAG;IAAE,CAAC,GAAG,EAAC,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAA;CAAE,CAAC;AAE1F,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,gBAAgB,GAAG;IAC7B,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CAAC;AAElE,MAAM,MAAM,MAAM,GAAG;IACnB,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB,CAAC"}

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

@@ -0,0 +1,230 @@
+import type { EncryptionAlgorithm } from '../utils/encryption.js';
+import type { GeneralJws } from './jws-types.js';
+import type { KeyDerivationScheme } from '../utils/hd-key.js';
+import type { PublicJwk } from './jose-types.js';
+import type { Readable } from 'readable-stream';
+import type { AuthorizationModel, GenericMessage, GenericMessageReply, GenericSignaturePayload, MessageSubscription, Pagination } from './message-types.js';
+import type { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
+import type { PaginationCursor, RangeCriterion, RangeFilter, StartsWithFilter } from './query-types.js';
+export declare enum DateSort {
+    CreatedAscending = "createdAscending",
+    CreatedDescending = "createdDescending",
+    PublishedAscending = "publishedAscending",
+    PublishedDescending = "publishedDescending"
+}
+export type RecordsWriteTagValue = string | number | boolean | string[] | number[];
+export type RecordsWriteTags = {
+    [property: string]: RecordsWriteTagValue;
+};
+export type RecordsWriteTagsFilter = StartsWithFilter | RangeFilter | string | number | boolean;
+export type RecordsWriteDescriptor = {
+    interface: DwnInterfaceName.Records;
+    method: DwnMethodName.Write;
+    protocol?: string;
+    protocolPath?: string;
+    recipient?: string;
+    schema?: string;
+    tags?: RecordsWriteTags;
+    parentId?: string;
+    dataCid: string;
+    dataSize: number;
+    dateCreated: string;
+    messageTimestamp: string;
+    published?: boolean;
+    datePublished?: string;
+    dataFormat: string;
+};
+export type RecordsWriteMessageOptions = {
+    dataStream?: Readable;
+};
+/**
+ * Internal RecordsWrite message representation that can be in an incomplete state.
+ */
+export type InternalRecordsWriteMessage = GenericMessage & {
+    recordId?: string;
+    contextId?: string;
+    descriptor: RecordsWriteDescriptor;
+    attestation?: GeneralJws;
+    encryption?: EncryptionProperty;
+};
+export type RecordsWriteMessage = {
+    authorization: AuthorizationModel;
+    recordId: string;
+    contextId?: string;
+    descriptor: RecordsWriteDescriptor;
+    attestation?: GeneralJws;
+    encryption?: EncryptionProperty;
+};
+export type EncryptionProperty = {
+    algorithm: EncryptionAlgorithm;
+    initializationVector: string;
+    keyEncryption: EncryptedKey[];
+};
+export type EncryptedKey = {
+    /**
+     * The fully qualified key ID (e.g. did:example:abc#encryption-key-id) of the root public key used to encrypt the symmetric encryption key.
+     */
+    rootKeyId: string;
+    /**
+     * The actual derived public key.
+     */
+    derivedPublicKey?: PublicJwk;
+    derivationScheme: KeyDerivationScheme;
+    algorithm: EncryptionAlgorithm;
+    initializationVector: string;
+    ephemeralPublicKey: PublicJwk;
+    messageAuthenticationCode: string;
+    encryptedKey: string;
+};
+/**
+ * Data structure returned in a `RecordsQuery` reply entry.
+ * NOTE: the message structure is a modified version of the message received, the most notable differences are:
+ * 1. May include an initial RecordsWrite message
+ * 2. May include encoded data
+ */
+export type RecordsQueryReplyEntry = RecordsWriteMessage & {
+    /**
+     * The initial write of the record if the returned RecordsWrite message itself is not the initial write.
+     */
+    initialWrite?: RecordsWriteMessage;
+    /**
+     * The encoded data of the record if the data associated with the record is equal or smaller than `DwnConstant.maxDataSizeAllowedToBeEncoded`.
+     */
+    encodedData?: string;
+};
+/**
+ * Represents a RecordsWrite message with encoded data attached.
+ */
+export type DataEncodedRecordsWriteMessage = RecordsWriteMessage & {
+    /**
+     * The encoded data of the record if the data associated with the record is equal or smaller than `DwnConstant.maxDataSizeAllowedToBeEncoded`.
+     */
+    encodedData: string;
+};
+export type RecordsQueryDescriptor = {
+    interface: DwnInterfaceName.Records;
+    method: DwnMethodName.Query;
+    messageTimestamp: string;
+    filter: RecordsFilter;
+    dateSort?: DateSort;
+    pagination?: Pagination;
+};
+export type RecordsSubscribeDescriptor = {
+    interface: DwnInterfaceName.Records;
+    method: DwnMethodName.Subscribe;
+    messageTimestamp: string;
+    filter: RecordsFilter;
+};
+export type RecordsFilter = {
+    /**
+     * The logical author of the record
+     */
+    author?: string | string[];
+    attester?: string;
+    recipient?: string | string[];
+    protocol?: string;
+    protocolPath?: string;
+    published?: boolean;
+    /**
+     * When given all Records message under the context of the given `contextId` will be returned.
+     */
+    contextId?: string;
+    schema?: string;
+    tags?: {
+        [property: string]: RecordsWriteTagsFilter;
+    };
+    recordId?: string;
+    parentId?: string;
+    dataFormat?: string;
+    dataSize?: RangeFilter;
+    dataCid?: string;
+    dateCreated?: RangeCriterion;
+    datePublished?: RangeCriterion;
+    dateUpdated?: RangeCriterion;
+};
+export type RecordsWriteAttestationPayload = {
+    descriptorCid: string;
+};
+export type RecordsWriteSignaturePayload = GenericSignaturePayload & {
+    recordId: string;
+    contextId?: string;
+    attestationCid?: string;
+    encryptionCid?: string;
+};
+export type RecordsQueryMessage = GenericMessage & {
+    descriptor: RecordsQueryDescriptor;
+};
+export type RecordsQueryReply = GenericMessageReply & {
+    entries?: RecordsQueryReplyEntry[];
+    cursor?: PaginationCursor;
+};
+export type RecordEvent = {
+    message: RecordsWriteMessage | RecordsDeleteMessage;
+    initialWrite?: RecordsWriteMessage;
+};
+export type RecordSubscriptionHandler = (event: RecordEvent) => void;
+export type RecordsSubscribeMessageOptions = {
+    subscriptionHandler: RecordSubscriptionHandler;
+};
+export type RecordsSubscribeMessage = GenericMessage & {
+    descriptor: RecordsSubscribeDescriptor;
+};
+export type RecordsSubscribeReply = GenericMessageReply & {
+    subscription?: MessageSubscription;
+};
+export type RecordsReadMessage = {
+    authorization?: AuthorizationModel;
+    descriptor: RecordsReadDescriptor;
+};
+/**
+ * The reply to a RecordsRead message.
+ */
+export type RecordsReadReply = GenericMessageReply & {
+    /**
+     * A container for the data returned from a `RecordsRead`.
+     * `undefined` if no data needs to be returned.
+     */
+    entry?: RecordsReadReplyEntry;
+};
+/**
+ * The structure of the `entry` container property in `RecordsReadReplyEntry`.
+ */
+export type RecordsReadReplyEntry = {
+    /**
+     * The latest RecordsWrite message of the record if record exists (not deleted).
+     */
+    recordsWrite?: RecordsWriteMessage;
+    /**
+     * The RecordsDelete if the record is deleted.
+     */
+    recordsDelete?: RecordsDeleteMessage;
+    /**
+     * The initial write of the record if the returned RecordsWrite message itself is not the initial write or if a RecordsDelete is returned.
+     */
+    initialWrite?: RecordsWriteMessage;
+    /**
+     * The data stream associated with the record if the records exists (not deleted).
+     */
+    data?: Readable;
+};
+export type RecordsReadDescriptor = {
+    interface: DwnInterfaceName.Records;
+    method: DwnMethodName.Read;
+    filter: RecordsFilter;
+    messageTimestamp: string;
+};
+export type RecordsDeleteMessage = GenericMessage & {
+    authorization: AuthorizationModel;
+    descriptor: RecordsDeleteDescriptor;
+};
+export type RecordsDeleteDescriptor = {
+    interface: DwnInterfaceName.Records;
+    method: DwnMethodName.Delete;
+    messageTimestamp: string;
+    recordId: string;
+    /**
+     * Denotes if all the descendent records should be purged.
+     */
+    prune: boolean;
+};
+//# sourceMappingURL=records-types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"records-types.d.ts","sourceRoot":"","sources":["../../../../src/types/records-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC5J,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACxF,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAExG,oBAAY,QAAQ;IAClB,gBAAgB,qBAAqB;IACrC,iBAAiB,sBAAsB;IACvC,kBAAkB,uBAAuB;IACzC,mBAAmB,wBAAwB;CAC5C;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;AACnF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEhG,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC;IACpC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,UAAU,CAAC,EAAE,QAAQ,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,sBAAsB,CAAC;IACnC,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB,UAAU,CAAC,EAAE,kBAAkB,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,EAAE,kBAAkB,CAAC;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,sBAAsB,CAAC;IACnC,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB,UAAU,CAAC,EAAE,kBAAkB,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,YAAY,EAAE,CAAA;CAC9B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,SAAS,CAAC;IAC7B,gBAAgB,EAAE,mBAAmB,CAAC;IACtC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,kBAAkB,EAAE,SAAS,CAAC;IAC9B,yBAAyB,EAAE,MAAM,CAAC;IAClC,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,GAAG;IACzD;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,GAAG;IACjE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC;IACpC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC;IACpC,MAAM,EAAE,aAAa,CAAC,SAAS,CAAC;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE;QAAE,CAAC,QAAQ,EAAC,MAAM,GAAG,sBAAsB,CAAA;KAAE,CAAA;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,WAAW,CAAC,EAAE,cAAc,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,uBAAuB,GAAG;IACnE,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG;IACjD,UAAU,EAAE,sBAAsB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,mBAAmB,GAAG;IACpD,OAAO,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACnC,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,mBAAmB,GAAG,oBAAoB,CAAA;IACnD,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC;AAErE,MAAM,MAAM,8BAA8B,GAAG;IAC3C,mBAAmB,EAAE,yBAAyB,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG;IACrD,UAAU,EAAE,0BAA0B,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,GAAG;IACxD,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC,UAAU,EAAE,qBAAqB,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG;IACnD;;;OAGG;IACH,KAAK,CAAC,EAAE,qBAAqB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC;IACpC,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC;IAC3B,MAAM,EAAE,aAAa,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,aAAa,EAAE,kBAAkB,CAAC;IAClC,UAAU,EAAE,uBAAuB,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC;IACpC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAA;CACf,CAAC"}

package/dist/types/src/types/resumable-task-store.d.ts

@@ -0,0 +1,89 @@
+/**
+ * An managed resumable task model.
+ */
+export type ManagedResumableTask = {
+    /** Globally unique ID. Used to extend or delete the task. */
+    id: string;
+    /** Task specific data. This is deliberately of type `any` because this store should not have to be ware of its type. */
+    task: any;
+    /** Task timeout in Epoch Time. */
+    timeout: number;
+    /** Number of retries */
+    retryCount: number;
+};
+/**
+ * Interface for interacting with the resumable task store.
+ *
+ * Implementer's Note:
+ * The store implementation used in a horizontally scalable deployment, such as in a Kubernetes cluster,
+ * must account for concurrent access by multiple `ResumableTaskStore` instances.
+ * It would be undesirable to have many kubernetes pods all trying to handle the same resumable task.
+ * A minimal viable implementation can use a per tenant exclusive lock on the store when `grab()` and  method is called.
+ * This would prevent issues that occur from concurrent modification to the same task to the store,
+ * but negatively impacts the throughput performance of the DWN.
+ * Requirements for a more performant implementation that allows distributed processing of resumable tasks across multiple clients:
+ * 1. The implementation probably requires both:
+ *   a. a persistent store for storing the data of each resumable task; and
+ *   b. an message streaming queue/service for distributing the each task exclusively to one of multiple handling clients.
+ * 2. The `grab()` and/or `open()` implementation will need to copy the timed-out tasks from persistent store into the message queue/service
+ *    for distributed processing by multiple clients when there is no resumable tasks to grab in the message queue.
+ *    During the move, the persistent store should be locked to prevent multiple copies of the same tasks from being copied.
+ * 3. Both Google's pub-sub and Amazon's SQS require an Ack ID / Receipt Handle to acknowledge the message,
+ *    The value of Ack ID / Receipt Handle is not known until the message is received,
+ *    therefore the implementer will likely need to have an in-memory mapping of task ID -> Ack ID / Receipt Handle
+ *    so that `delete()` can be called with task ID.
+ */
+export interface ResumableTaskStore {
+    /**
+     * Opens a connection to the underlying store and initializes it.
+     */
+    open(): Promise<void>;
+    /**
+     * Closes the connection to the underlying store.
+     */
+    close(): Promise<void>;
+    /**
+     * Registers a new resumable task that is currently in-flight/under processing to the store.
+     * If the task is timed out, a client will be able to grab it through the `grab()` method and resume the task.
+     * @param task Task specific data.  This is deliberately of type `any` because this store should not have to be ware of its type.
+     * @param timeoutInSeconds Timeout in seconds from the current time.
+     * @returns A `ManagedResumableTask` object that can be used to extend or delete the task.
+     * @throws {Error} with `code` set to `ResumableTaskAlreadyExists` if the same task is already registered.
+     */
+    register(task: any, timeoutInSeconds: number): Promise<ManagedResumableTask>;
+    /**
+     * Grabs a number of unhandled tasks from the store.
+     * Unhandled tasks are tasks that are not currently in-flight/under processing (ie. tasks that have timed-out).
+     * NOTE: The implementation must make sure that once a task is grabbed by a client,
+     * tis timeout must be updated so that it is considered in-flight/under processing
+     * and cannot be grabbed by another client until it is timed-out.
+     * @param count Desired number of tasks to grab.
+     * @returns A list of tasks exclusive for the caller to handle; or empty array if there is no tasks, or if all tasks are already grabbed by others.
+     */
+    grab(count: number): Promise<ManagedResumableTask[]>;
+    /**
+     * Reads the task associated with the task ID provided regardless of whether it is in-flight/under processing or not.
+     * This is mainly introduced for testing purposes: ie. to check the status of a task for easy test verification.
+     * @param taskId ID of the task to read.
+     */
+    read(taskId: string): Promise<ManagedResumableTask | undefined>;
+    /**
+     * Extends the timeout of the task associated with the task ID provided.
+     * No-op if the task is not found, as this implies that the task has already been completed.
+     * This allows the client that is executing the task to continue working on it before the task is considered timed out.
+     * @param taskId ID of the task to extend the timeout for.
+     * @param timeoutInSeconds Timeout in seconds from the current time.
+     */
+    extend(taskId: string, timeoutInSeconds: number): Promise<void>;
+    /**
+     * Deletes the task associated with the task ID provided.
+     * No-op if the task is not found, as this implies that the task has already been completed.
+     * Called when the task has been successfully completed.
+     */
+    delete(taskId: string): Promise<void>;
+    /**
+     * Clears the entire store. Mainly used for cleaning up in test environment.
+     */
+    clear(): Promise<void>;
+}
+//# sourceMappingURL=resumable-task-store.d.ts.map

package/dist/types/src/types/resumable-task-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resumable-task-store.d.ts","sourceRoot":"","sources":["../../../../src/types/resumable-task-store.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,6DAA6D;IAC7D,EAAE,EAAE,MAAM,CAAC;IACX,wHAAwH;IACxH,IAAI,EAAE,GAAG,CAAC;IACV,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,wBAAwB;IACxB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE7E;;;;;;;;OAQG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAErD;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtC;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB"}

package/dist/types/src/types/signer.d.ts

@@ -0,0 +1,26 @@
+/**
+ * A signer that is capable of generating a digital signature over any given bytes.
+ */
+export interface Signer {
+    /**
+     * The ID of the key used by this signer.
+     * This needs to be a fully-qualified ID (ie. prefixed with DID) so that author can be parsed out for processing such as `recordId` computation.
+     * Example: did:example:alice#key1
+     * This value will be used as the "kid" parameter in JWS produced.
+     * While this property is not a required property per JWS specification, it is required for DWN authentication.
+     */
+    keyId: string;
+    /**
+     * The name of the signature algorithm used by this signer.
+     * This value will be used as the "alg" parameter in JWS produced.
+     * This parameter is not used by the DWN but is unfortunately a required header property for a JWS as per:
+     * https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.1
+     * Valid signature algorithm values can be found at https://www.iana.org/assignments/jose/jose.xhtml
+     */
+    algorithm: string;
+    /**
+     * Signs the given content and returns the signature as bytes.
+     */
+    sign(content: Uint8Array): Promise<Uint8Array>;
+}
+//# sourceMappingURL=signer.d.ts.map

package/dist/types/src/types/signer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../../../src/types/signer.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACjD"}

package/dist/types/src/types/subscriptions.d.ts

@@ -0,0 +1,30 @@
+import type { GenericMessageReply } from '../types/message-types.js';
+import type { KeyValues } from './query-types.js';
+import type { RecordsWriteMessage } from './records-types.js';
+import type { GenericMessage, MessageSubscription } from './message-types.js';
+export type EventListener = (tenant: string, event: MessageEvent, indexes: KeyValues) => void;
+/**
+ * MessageEvent contains the message being emitted and an optional initial write message.
+ */
+export type MessageEvent = {
+    message: GenericMessage;
+    /** the initial write of the RecordsWrite or RecordsDelete message */
+    initialWrite?: RecordsWriteMessage;
+};
+/**
+ * The EventStream interface implements a pub/sub system based on Message filters.
+ */
+export interface EventStream {
+    subscribe(tenant: string, id: string, listener: EventListener): Promise<EventSubscription>;
+    emit(tenant: string, event: MessageEvent, indexes: KeyValues): void;
+    open(): Promise<void>;
+    close(): Promise<void>;
+}
+export interface EventSubscription {
+    id: string;
+    close: () => Promise<void>;
+}
+export type SubscriptionReply = GenericMessageReply & {
+    subscription?: MessageSubscription;
+};
+//# sourceMappingURL=subscriptions.d.ts.map

package/dist/types/src/types/subscriptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../../../src/types/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,KAAK,IAAI,CAAC;AAE9F;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAC;IACxB,qEAAqE;IACrE,YAAY,CAAC,EAAE,mBAAmB,CAAA;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC3F,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,GAAG,IAAI,CAAC;IACpE,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED,MAAM,MAAM,iBAAiB,GAAG,mBAAmB,GAAG;IACpD,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC,CAAC"}

package/dist/types/src/utils/abort.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Wraps the given `Promise` such that it will reject if the `AbortSignal` is triggered.
+ */
+export declare function executeUnlessAborted<T>(promise: Promise<T>, signal: AbortSignal | undefined): Promise<T>;
+//# sourceMappingURL=abort.d.ts.map

package/dist/types/src/utils/abort.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort.d.ts","sourceRoot":"","sources":["../../../../src/utils/abort.ts"],"names":[],"mappings":"AAkBA;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,CAS9G"}

package/dist/types/src/utils/array.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Array utility methods.
+ */
+export declare class ArrayUtility {
+    /**
+     * Returns `true` if content of the two given byte arrays are equal; `false` otherwise.
+     */
+    static byteArraysEqual(array1: Uint8Array, array2: Uint8Array): boolean;
+    /**
+     * Asynchronously iterates an {AsyncGenerator} to return all the values in an array.
+     */
+    static fromAsyncGenerator<T>(iterator: AsyncGenerator<T>): Promise<Array<T>>;
+    /**
+     * Generic asynchronous sort method.
+     */
+    static asyncSort<T>(array: T[], asyncComparer: (a: T, b: T) => Promise<number>): Promise<T[]>;
+}
+//# sourceMappingURL=array.d.ts.map

package/dist/types/src/utils/array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../../../src/utils/array.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,YAAY;IACvB;;OAEG;WACW,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAC,UAAU,GAAG,OAAO;IAK7E;;OAEG;WACiB,kBAAkB,CAAC,CAAC,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAQzF;;OAEG;WACiB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;CAY3G"}

package/dist/types/src/utils/cid.d.ts

@@ -0,0 +1,30 @@
+import type { Readable } from 'readable-stream';
+import { CID } from 'multiformats/cid';
+/**
+ * Utility class for creating CIDs. Exported for the convenience of developers.
+ */
+export declare class Cid {
+    /**
+     * Computes a V1 CID for the provided payload
+     * @param codecCode - the codec to use. Defaults to cbor
+     * @param multihashCode - the multihasher to use. Defaults to sha256
+     * @returns payload CID
+     * @throws {Error} codec is not supported
+     * @throws {Error} encoding fails
+     * @throws {Error} if hasher is not supported
+     */
+    static computeCid(payload: any, codecCode?: number, multihashCode?: number): Promise<string>;
+    /**
+     * Parses the given CID string into a {CID}.
+     */
+    static parseCid(str: string): CID;
+    /**
+     * @returns V1 CID of the DAG comprised by chunking data into unixfs DAG-PB encoded blocks
+     */
+    static computeDagPbCidFromBytes(content: Uint8Array): Promise<string>;
+    /**
+     * @returns V1 CID of the DAG comprised by chunking data into unixfs DAG-PB encoded blocks
+     */
+    static computeDagPbCidFromStream(dataStream: Readable): Promise<string>;
+}
+//# sourceMappingURL=cid.d.ts.map

package/dist/types/src/utils/cid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cid.d.ts","sourceRoot":"","sources":["../../../../src/utils/cid.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AAiBvC;;GAEG;AACH,qBAAa,GAAG;IAEd;;;;;;;;OAQG;WACiB,UAAU,CAC5B,OAAO,EAAE,GAAG,EACZ,SAAS,GAAE,MAAkB,EAC7B,aAAa,GAAE,MAAoB,GAClC,OAAO,CAAC,MAAM,CAAC;IAkBlB;;OAEG;WACW,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG;IAcxC;;OAEG;WACiB,wBAAwB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAUlF;;OAEG;WACiB,yBAAyB,CAAC,UAAU,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;CASrF"}

package/dist/types/src/utils/data-stream.d.ts

@@ -0,0 +1,31 @@
+import { Readable } from 'readable-stream';
+/**
+ * Utility class for readable data stream, intentionally named to disambiguate from ReadableStream, readable-stream, Readable etc.
+ */
+export declare class DataStream {
+    /**
+     * Reads the entire readable stream given into array of bytes.
+     */
+    static toBytes(readableStream: Readable): Promise<Uint8Array>;
+    /**
+     * Reads the entire readable stream and JSON parses it into an object.
+     */
+    static toObject(readableStream: Readable): Promise<object>;
+    /**
+     * Concatenates the array of bytes given into one Uint8Array.
+     */
+    private static concatenateArrayOfBytes;
+    /**
+     * Creates a readable stream from the bytes given.
+     */
+    static fromBytes(bytes: Uint8Array): Readable;
+    /**
+     * Creates a readable stream from the object given.
+     */
+    static fromObject(object: Record<string, any>): Readable;
+    /**
+     * Duplicates the given data stream into the number of streams specified so that multiple handlers can consume the same data stream.
+     */
+    static duplicateDataStream(dataStream: Readable, count: number): Readable[];
+}
+//# sourceMappingURL=data-stream.d.ts.map

package/dist/types/src/utils/data-stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-stream.d.ts","sourceRoot":"","sources":["../../../../src/utils/data-stream.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAExD;;GAEG;AACH,qBAAa,UAAU;IACrB;;OAEG;WACiB,OAAO,CAAC,cAAc,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;IAgB1E;;OAEG;WACiB,QAAQ,CAAC,cAAc,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IAMvE;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAetC;;OAEG;WACW,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ;IAqBpD;;OAEG;WACW,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,QAAQ;IAK/D;;OAEG;WACW,mBAAmB,CAAC,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,QAAQ,EAAE;CAUnF"}

package/dist/types/src/utils/encoder.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Utility class for encoding/converting data into various formats.
+ */
+export declare class Encoder {
+    static base64UrlToBytes(base64urlString: string): Uint8Array;
+    static base64UrlToObject(base64urlString: string): any;
+    static bytesToBase64Url(bytes: Uint8Array): string;
+    static bytesToString(content: Uint8Array): string;
+    static bytesToObject(content: Uint8Array): object;
+    static objectToBytes(obj: Record<string, any>): Uint8Array;
+    static stringToBase64Url(content: string): string;
+    static stringToBytes(content: string): Uint8Array;
+}
+//# sourceMappingURL=encoder.d.ts.map

package/dist/types/src/utils/encoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoder.d.ts","sourceRoot":"","sources":["../../../../src/utils/encoder.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,qBAAa,OAAO;WAEJ,gBAAgB,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU;WAKrD,iBAAiB,CAAC,eAAe,EAAE,MAAM,GAAG,GAAG;WAM/C,gBAAgB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM;WAK3C,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM;WAK1C,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM;WAM1C,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,UAAU;WAMnD,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;WAM1C,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU;CAIzD"}

package/dist/types/src/utils/encryption.d.ts

@@ -0,0 +1,44 @@
+import { Readable } from 'readable-stream';
+/**
+ * Utility class for performing common, non-DWN specific encryption operations.
+ */
+export declare class Encryption {
+    /**
+     * Encrypts the given plaintext stream using AES-256-CTR algorithm.
+     */
+    static aes256CtrEncrypt(key: Uint8Array, initializationVector: Uint8Array, plaintextStream: Readable): Promise<Readable>;
+    /**
+     * Decrypts the given cipher stream using AES-256-CTR algorithm.
+     */
+    static aes256CtrDecrypt(key: Uint8Array, initializationVector: Uint8Array, cipherStream: Readable): Promise<Readable>;
+    /**
+     * Encrypts the given plaintext using ECIES (Elliptic Curve Integrated Encryption Scheme)
+     * with SECP256K1 for the asymmetric calculations, HKDF as the key-derivation function,
+     * and AES-GCM for the symmetric encryption and MAC algorithms.
+     */
+    static eciesSecp256k1Encrypt(publicKeyBytes: Uint8Array, plaintext: Uint8Array): Promise<EciesEncryptionOutput>;
+    /**
+     * Decrypt the given plaintext using ECIES (Elliptic Curve Integrated Encryption Scheme)
+     * with SECP256K1 for the asymmetric calculations, HKDF as the key-derivation function,
+     * and AES-GCM for the symmetric encryption and MAC algorithms.
+     */
+    static eciesSecp256k1Decrypt(input: EciesEncryptionInput): Promise<Uint8Array>;
+    /**
+     * Expose eciesjs library configuration
+     */
+    static get isEphemeralKeyCompressed(): boolean;
+}
+export type EciesEncryptionOutput = {
+    initializationVector: Uint8Array;
+    ephemeralPublicKey: Uint8Array;
+    ciphertext: Uint8Array;
+    messageAuthenticationCode: Uint8Array;
+};
+export type EciesEncryptionInput = EciesEncryptionOutput & {
+    privateKey: Uint8Array;
+};
+export declare enum EncryptionAlgorithm {
+    Aes256Ctr = "A256CTR",
+    EciesSecp256k1 = "ECIES-ES256K"
+}
+//# sourceMappingURL=encryption.d.ts.map

package/dist/types/src/utils/encryption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryption.d.ts","sourceRoot":"","sources":["../../../../src/utils/encryption.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAK3C;;GAEG;AACH,qBAAa,UAAU;IACrB;;OAEG;WACiB,gBAAgB,CAAC,GAAG,EAAE,UAAU,EAAE,oBAAoB,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAyBrI;;OAEG;WACiB,gBAAgB,CAAC,GAAG,EAAE,UAAU,EAAE,oBAAoB,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAyBlI;;;;OAIG;WACiB,qBAAqB,CAAC,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA8B5H;;;;OAIG;WACiB,qBAAqB,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAe3F;;OAEG;IACH,MAAM,KAAK,wBAAwB,IAAG,OAAO,CAE5C;CACF;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,oBAAoB,EAAE,UAAU,CAAC;IACjC,kBAAkB,EAAE,UAAU,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;IACvB,yBAAyB,EAAE,UAAU,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,GAAG;IACzD,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC;AAEF,oBAAY,mBAAmB;IAC7B,SAAS,YAAY;IACrB,cAAc,iBAAiB;CAChC"}