@enbox/dwn-sdk-js 0.0.1

package/dist/esm/src/utils/hd-key.js

@@ -0,0 +1,114 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Encoder } from './encoder.js';
+import { getWebcryptoSubtle } from '@noble/ciphers/webcrypto';
+import { Secp256k1 } from './secp256k1.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+export var KeyDerivationScheme;
+(function (KeyDerivationScheme) {
+    /**
+     * Key derivation using the `dataFormat` value for Flat-space records.
+     */
+    KeyDerivationScheme["DataFormats"] = "dataFormats";
+    KeyDerivationScheme["ProtocolContext"] = "protocolContext";
+    KeyDerivationScheme["ProtocolPath"] = "protocolPath";
+    /**
+     * Key derivation using the `schema` value for Flat-space records.
+     */
+    KeyDerivationScheme["Schemas"] = "schemas";
+})(KeyDerivationScheme || (KeyDerivationScheme = {}));
+/**
+ * Class containing hierarchical deterministic key related utility methods used by the DWN.
+ */
+export class HdKey {
+    /**
+     * Derives a descendant private key.
+     * NOTE: currently only supports SECP256K1 keys.
+     */
+    static derivePrivateKey(ancestorKey, subDerivationPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const ancestorPrivateKey = Secp256k1.privateJwkToBytes(ancestorKey.derivedPrivateKey);
+            const ancestorPrivateKeyDerivationPath = (_a = ancestorKey.derivationPath) !== null && _a !== void 0 ? _a : [];
+            const derivedPrivateKeyBytes = yield HdKey.derivePrivateKeyBytes(ancestorPrivateKey, subDerivationPath);
+            const derivedPrivateJwk = yield Secp256k1.privateKeyToJwk(derivedPrivateKeyBytes);
+            const derivedDescendantPrivateKey = {
+                rootKeyId: ancestorKey.rootKeyId,
+                derivationScheme: ancestorKey.derivationScheme,
+                derivationPath: [...ancestorPrivateKeyDerivationPath, ...subDerivationPath],
+                derivedPrivateKey: derivedPrivateJwk
+            };
+            return derivedDescendantPrivateKey;
+        });
+    }
+    /**
+     * Derives a descendant public key from an ancestor private key.
+     * NOTE: currently only supports SECP256K1 keys.
+     */
+    static derivePublicKey(ancestorKey, subDerivationPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const derivedDescendantPrivateKey = yield HdKey.derivePrivateKey(ancestorKey, subDerivationPath);
+            const derivedDescendantPublicKey = yield Secp256k1.getPublicJwk(derivedDescendantPrivateKey.derivedPrivateKey);
+            return derivedDescendantPublicKey;
+        });
+    }
+    /**
+     * Derives a hardened hierarchical deterministic private key.
+     */
+    static derivePrivateKeyBytes(privateKey, relativePath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            HdKey.validateKeyDerivationPath(relativePath);
+            let currentPrivateKey = privateKey;
+            for (const segment of relativePath) {
+                const segmentBytes = Encoder.stringToBytes(segment);
+                currentPrivateKey = yield HdKey.deriveKeyUsingHkdf({
+                    hashAlgorithm: 'SHA-256',
+                    initialKeyMaterial: currentPrivateKey,
+                    info: segmentBytes, // use the segment as the application specific info for key derivation
+                    keyLengthInBytes: 32 // 32 bytes = 256 bits
+                });
+            }
+            return currentPrivateKey;
+        });
+    }
+    /**
+     * Derives a key using  HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as defined in RFC 5869.
+     * TODO: Consolidate HKDF implementation and usage with web5-js - https://github.com/TBD54566975/dwn-sdk-js/issues/742
+     */
+    static deriveKeyUsingHkdf(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { hashAlgorithm, initialKeyMaterial, info, keyLengthInBytes } = params;
+            const webCrypto = getWebcryptoSubtle();
+            // Import the `initialKeyMaterial` into the Web Crypto API to use for the key derivation operation.
+            const webCryptoKey = yield webCrypto.importKey('raw', initialKeyMaterial, { name: 'HKDF' }, false, ['deriveBits']);
+            // Derive the bytes using the Web Crypto API.
+            const derivedKeyBuffer = yield crypto.subtle.deriveBits({
+                name: 'HKDF',
+                hash: hashAlgorithm,
+                salt: new Uint8Array(0), // `info` should be sufficient in our use case
+                info
+            }, webCryptoKey, keyLengthInBytes * 8 // convert from bytes to bits
+            );
+            // Convert from ArrayBuffer to Uint8Array.
+            const derivedKeyBytes = new Uint8Array(derivedKeyBuffer);
+            return derivedKeyBytes;
+        });
+    }
+    /**
+     * Validates that no empty strings exist within the derivation path segments array.
+     * @throws {DwnError} with `DwnErrorCode.HdKeyDerivationPathInvalid` if derivation path fails validation.
+     */
+    static validateKeyDerivationPath(pathSegments) {
+        if (pathSegments.includes('')) {
+            throw new DwnError(DwnErrorCode.HdKeyDerivationPathInvalid, `Invalid key derivation path: ${pathSegments}`);
+        }
+    }
+}
+//# sourceMappingURL=hd-key.js.map

package/dist/esm/src/utils/hd-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hd-key.js","sourceRoot":"","sources":["../../../../src/utils/hd-key.ts"],"names":[],"mappings":";;;;;;;;;AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAE9D,MAAM,CAAN,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;OAEG;IACH,kDAA2B,CAAA;IAC3B,0DAAmC,CAAA;IACnC,oDAA6B,CAAA;IAE7B;;OAEG;IACH,0CAAmB,CAAA;AACrB,CAAC,EAZW,mBAAmB,KAAnB,mBAAmB,QAY9B;AASD;;GAEG;AACH,MAAM,OAAO,KAAK;IAChB;;;OAGG;IACI,MAAM,CAAO,gBAAgB,CAAC,WAA8B,EAAE,iBAA2B;;;YAC9F,MAAM,kBAAkB,GAAG,SAAS,CAAC,iBAAiB,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;YACtF,MAAM,gCAAgC,GAAG,MAAA,WAAW,CAAC,cAAc,mCAAI,EAAE,CAAC;YAC1E,MAAM,sBAAsB,GAAG,MAAM,KAAK,CAAC,qBAAqB,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,CAAC;YACxG,MAAM,iBAAiB,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC;YAClF,MAAM,2BAA2B,GAAsB;gBACrD,SAAS,EAAW,WAAW,CAAC,SAAS;gBACzC,gBAAgB,EAAI,WAAW,CAAC,gBAAgB;gBAChD,cAAc,EAAM,CAAC,GAAG,gCAAgC,EAAE,GAAG,iBAAiB,CAAC;gBAC/E,iBAAiB,EAAG,iBAAiB;aACtC,CAAC;YAEF,OAAO,2BAA2B,CAAC;QACrC,CAAC;KAAA;IAED;;;OAGG;IACI,MAAM,CAAO,eAAe,CAAC,WAA8B,EAAE,iBAA2B;;YAC7F,MAAM,2BAA2B,GAAG,MAAM,KAAK,CAAC,gBAAgB,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;YACjG,MAAM,0BAA0B,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,2BAA2B,CAAC,iBAAiB,CAAC,CAAC;YAE/G,OAAO,0BAA0B,CAAC;QACpC,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAO,qBAAqB,CAAC,UAAsB,EAAE,YAAsB;;YACtF,KAAK,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;YAE9C,IAAI,iBAAiB,GAAG,UAAU,CAAC;YACnC,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;gBACnC,MAAM,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACpD,iBAAiB,GAAG,MAAM,KAAK,CAAC,kBAAkB,CAAC;oBACjD,aAAa,EAAQ,SAAS;oBAC9B,kBAAkB,EAAG,iBAAiB;oBACtC,IAAI,EAAiB,YAAY,EAAE,sEAAsE;oBACzG,gBAAgB,EAAK,EAAE,CAAC,sBAAsB;iBAC/C,CAAC,CAAC;YACL,CAAC;YAED,OAAO,iBAAiB,CAAC;QAC3B,CAAC;KAAA;IAED;;;OAGG;IACI,MAAM,CAAO,kBAAkB,CAAC,MAKtC;;YACC,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;YAE7E,MAAM,SAAS,GAAG,kBAAkB,EAAkB,CAAC;YAEvD,mGAAmG;YACnG,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;YAEnH,6CAA6C;YAC7C,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CACrD;gBACE,IAAI,EAAG,MAAM;gBACb,IAAI,EAAG,aAAa;gBACpB,IAAI,EAAG,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,8CAA8C;gBACxE,IAAI;aACL,EACD,YAAY,EACZ,gBAAgB,GAAG,CAAC,CAAC,6BAA6B;aACnD,CAAC;YAEF,0CAA0C;YAC1C,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAC;YACzD,OAAO,eAAe,CAAC;QACzB,CAAC;KAAA;IAED;;;OAGG;IACK,MAAM,CAAC,yBAAyB,CAAC,YAAsB;QAC7D,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,gCAAgC,YAAY,EAAE,CAAC,CAAC;QAC9G,CAAC;IACH,CAAC;CACF"}

package/dist/esm/src/utils/jws.js

@@ -0,0 +1,89 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import isPlainObject from 'lodash/isPlainObject.js';
+import { Encoder } from './encoder.js';
+import { PrivateKeySigner } from './private-key-signer.js';
+import { signatureAlgorithms } from '../jose/algorithms/signing/signature-algorithms.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+/**
+ * Utility class for JWS related operations.
+ */
+export class Jws {
+    /**
+     * Gets the `kid` from a general JWS signature entry.
+     */
+    static getKid(signatureEntry) {
+        const { kid } = Encoder.base64UrlToObject(signatureEntry.protected);
+        return kid;
+    }
+    /**
+     * Gets the signer DID from a general JWS signature entry.
+     */
+    static getSignerDid(signatureEntry) {
+        const kid = Jws.getKid(signatureEntry);
+        const did = Jws.extractDid(kid);
+        return did;
+    }
+    /**
+     * Verifies the signature against the given payload.
+     * @returns `true` if signature is valid; `false` otherwise
+     */
+    static verifySignature(base64UrlPayload, signatureEntry, jwkPublic) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const signatureAlgorithm = signatureAlgorithms[jwkPublic.crv];
+            if (!signatureAlgorithm) {
+                throw new DwnError(DwnErrorCode.JwsVerifySignatureUnsupportedCrv, `unsupported crv. crv must be one of ${Object.keys(signatureAlgorithms)}`);
+            }
+            const payload = Encoder.stringToBytes(`${signatureEntry.protected}.${base64UrlPayload}`);
+            const signatureBytes = Encoder.base64UrlToBytes(signatureEntry.signature);
+            return yield signatureAlgorithm.verify(payload, signatureBytes, jwkPublic);
+        });
+    }
+    /**
+     * Decodes the payload of the given JWS object as a plain object.
+     */
+    static decodePlainObjectPayload(jws) {
+        let payloadJson;
+        try {
+            payloadJson = Encoder.base64UrlToObject(jws.payload);
+        }
+        catch (_a) {
+            throw new DwnError(DwnErrorCode.JwsDecodePlainObjectPayloadInvalid, 'payload is not a JSON object');
+        }
+        if (!isPlainObject(payloadJson)) {
+            throw new DwnError(DwnErrorCode.JwsDecodePlainObjectPayloadInvalid, 'signed payload must be a plain object');
+        }
+        return payloadJson;
+    }
+    /**
+     * Extracts the DID from the given `kid` string.
+     */
+    static extractDid(kid) {
+        const [did] = kid.split('#');
+        return did;
+    }
+    /**
+     * Creates a Signer[] from the given Personas.
+     */
+    static createSigners(keyMaterials) {
+        const signers = keyMaterials.map((keyMaterial) => Jws.createSigner(keyMaterial));
+        return signers;
+    }
+    /**
+     * Creates a Signer from the given Persona.
+     */
+    static createSigner(keyMaterial) {
+        const privateJwk = keyMaterial.keyPair.privateJwk;
+        const keyId = keyMaterial.keyId;
+        const signer = new PrivateKeySigner({ privateJwk, keyId });
+        return signer;
+    }
+}
+//# sourceMappingURL=jws.js.map

package/dist/esm/src/utils/jws.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jws.js","sourceRoot":"","sources":["../../../../src/utils/jws.ts"],"names":[],"mappings":";;;;;;;;;AAKA,OAAO,aAAa,MAAM,yBAAyB,CAAC;AAEpD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAC;AACzF,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAG9D;;GAEG;AACH,MAAM,OAAO,GAAG;IACd;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,cAA8B;QACjD,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QACpE,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAAC,cAA8B;QACvD,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QACvC,MAAM,GAAG,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAO,eAAe,CAAC,gBAAwB,EAAE,cAA8B,EAAE,SAAoB;;YAChH,MAAM,kBAAkB,GAAG,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAE9D,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,gCAAgC,EAAE,uCAAuC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;YAC/I,CAAC;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,cAAc,CAAC,SAAS,IAAI,gBAAgB,EAAE,CAAC,CAAC;YACzF,MAAM,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAE1E,OAAO,MAAM,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;QAC7E,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAC,wBAAwB,CAAC,GAAe;QACpD,IAAI,WAAW,CAAC;QAChB,IAAI,CAAC;YACH,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACvD,CAAC;QAAC,WAAM,CAAC;YACP,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,kCAAkC,EAAE,8BAA8B,CAAC,CAAC;QACtG,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,kCAAkC,EAAE,uCAAuC,CAAC,CAAC;QAC/G,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU,CAAC,GAAW;QAClC,MAAM,CAAE,GAAG,CAAE,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,aAAa,CAAC,YAA2B;QACrD,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC;QACjF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAAC,WAAwB;QACjD,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC;QAClD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;QAChC,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3D,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/dist/esm/src/utils/memory-cache.js

@@ -0,0 +1,41 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { LRUCache } from 'lru-cache';
+/**
+ * A cache using local memory.
+ */
+export class MemoryCache {
+    /**
+     * @param timeToLiveInSeconds time-to-live for every key-value pair set in the cache
+     */
+    constructor(timeToLiveInSeconds) {
+        this.timeToLiveInSeconds = timeToLiveInSeconds;
+        this.cache = new LRUCache({
+            max: 100000,
+            ttl: timeToLiveInSeconds * 1000
+        });
+    }
+    set(key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                this.cache.set(key, value);
+            }
+            catch (_a) {
+                // let the code continue as this is a non-fatal error
+            }
+        });
+    }
+    get(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.cache.get(key);
+        });
+    }
+}
+//# sourceMappingURL=memory-cache.js.map

package/dist/esm/src/utils/memory-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory-cache.js","sourceRoot":"","sources":["../../../../src/utils/memory-cache.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC;;GAEG;AACH,MAAM,OAAO,WAAW;IAGtB;;OAEG;IACH,YAA4B,mBAA2B;QAA3B,wBAAmB,GAAnB,mBAAmB,CAAQ;QACrD,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC;YACxB,GAAG,EAAG,MAAO;YACb,GAAG,EAAG,mBAAmB,GAAG,IAAI;SACjC,CAAC,CAAC;IACL,CAAC;IAEK,GAAG,CAAC,GAAW,EAAE,KAAU;;YAC/B,IAAI,CAAC;gBACH,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC7B,CAAC;YAAC,WAAM,CAAC;gBACP,qDAAqD;YACvD,CAAC;QACH,CAAC;KAAA;IAEK,GAAG,CAAC,GAAW;;YACnB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;KAAA;CACF"}

package/dist/esm/src/utils/messages.js

@@ -0,0 +1,84 @@
+import { FilterUtility } from './filter.js';
+import { normalizeProtocolUrl } from './url.js';
+import { PermissionsProtocol } from '../protocols/permissions.js';
+import { Records } from './records.js';
+import { isEmptyObject, removeUndefinedProperties } from './object.js';
+/**
+ * Class containing Messages related utility methods.
+ */
+export class Messages {
+    /**
+     * Normalizes/fixes the formatting of the given filters (such as URLs) so that they provide a consistent search experience.
+     */
+    static normalizeFilters(filters) {
+        const messagesQueryFilters = [];
+        // normalize each filter, and only add non-empty filters to the returned array
+        for (const filter of filters) {
+            // normalize the protocol URL if it exists
+            const protocol = filter.protocol !== undefined ? normalizeProtocolUrl(filter.protocol) : undefined;
+            const messagesFilter = Object.assign(Object.assign({}, filter), { protocol });
+            // remove any empty filter properties and do not add if empty
+            removeUndefinedProperties(messagesFilter);
+            if (!isEmptyObject(messagesFilter)) {
+                messagesQueryFilters.push(messagesFilter);
+            }
+        }
+        return messagesQueryFilters;
+    }
+    /**
+     *  Converts an incoming array of MessagesFilter into an array of Filter usable by MessageLog.
+     *
+     * @param filters An array of MessagesFilter
+     * @returns {Filter[]} an array of generic Filter able to be used when querying.
+     */
+    static convertFilters(filters) {
+        const messagesQueryFilters = [];
+        // convert each filter individually by the specific type of filter it is
+        // we must check for the type of filter in a specific order to make a reductive decision as to which filters need converting
+        // first we check for `MessagesRecordsFilter` fields for conversion
+        // otherwise it is `MessagesMessageFilter` fields for conversion
+        for (const filter of filters) {
+            // extract the protocol tag filter from the incoming message record filter
+            // this filters for permission grants, requests and revocations associated with a targeted protocol
+            // since permissions are their own protocol, we added an additional tag index when writing the permission messages
+            // so that we can filter for permission records here
+            const permissionRecordsFilter = this.constructPermissionRecordsFilter(filter);
+            if (permissionRecordsFilter) {
+                messagesQueryFilters.push(permissionRecordsFilter);
+            }
+            messagesQueryFilters.push(this.convertFilter(filter));
+        }
+        return messagesQueryFilters;
+    }
+    /**
+     * Constructs a filter that gets associated permission records if protocol is in the given filter.
+     */
+    static constructPermissionRecordsFilter(filter) {
+        const { protocol, messageTimestamp } = filter;
+        if (protocol !== undefined) {
+            const taggedFilter = Object.assign({ protocol: PermissionsProtocol.uri }, Records.convertTagsFilter({ protocol }));
+            if (messageTimestamp != undefined) {
+                // if we filter by message timestamp, we also want to filter the permission messages by the same timestamp range
+                const messageTimestampFilter = FilterUtility.convertRangeCriterion(messageTimestamp);
+                if (messageTimestampFilter) {
+                    taggedFilter.messageTimestamp = messageTimestampFilter;
+                }
+            }
+            return taggedFilter;
+        }
+    }
+    /**
+     * Converts an external-facing filter model into an internal-facing filer model used by data store.
+     */
+    static convertFilter(filter) {
+        const filterCopy = Object.assign({}, filter);
+        const { messageTimestamp } = filter;
+        const messageTimestampFilter = messageTimestamp ? FilterUtility.convertRangeCriterion(messageTimestamp) : undefined;
+        if (messageTimestampFilter) {
+            filterCopy.messageTimestamp = messageTimestampFilter;
+            delete filterCopy.dateUpdated;
+        }
+        return filterCopy;
+    }
+}
+//# sourceMappingURL=messages.js.map

package/dist/esm/src/utils/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../../../src/utils/messages.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAGvE;;GAEG;AACH,MAAM,OAAO,QAAQ;IACnB;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,OAAyB;QAEtD,MAAM,oBAAoB,GAAqB,EAAE,CAAC;QAElD,8EAA8E;QAC9E,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,0CAA0C;YAC1C,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEnG,MAAM,cAAc,mCACf,MAAM,KACT,QAAQ,GACT,CAAC;YAEF,6DAA6D;YAC7D,yBAAyB,CAAC,cAAc,CAAC,CAAC;YAC1C,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;gBACnC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;QAED,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,OAAyB;QAEpD,MAAM,oBAAoB,GAAa,EAAE,CAAC;QAE1C,wEAAwE;QACxE,4HAA4H;QAC5H,mEAAmE;QACnE,gEAAgE;QAChE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,0EAA0E;YAC1E,mGAAmG;YACnG,kHAAkH;YAClH,oDAAoD;YACpD,MAAM,uBAAuB,GAAG,IAAI,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;YAC9E,IAAI,uBAAuB,EAAE,CAAC;gBAC5B,oBAAoB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACrD,CAAC;YAED,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,gCAAgC,CAAC,MAAsB;QACpE,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;QAC9C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,YAAY,GAAG,gBACnB,QAAQ,EAAE,mBAAmB,CAAC,GAAG,IAC9B,OAAO,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,CAAC,CACjC,CAAC;YAEZ,IAAI,gBAAgB,IAAI,SAAS,EAAE,CAAC;gBAClC,gHAAgH;gBAChH,MAAM,sBAAsB,GAAG,aAAa,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;gBACrF,IAAI,sBAAsB,EAAE,CAAC;oBAC3B,YAAY,CAAC,gBAAgB,GAAG,sBAAsB,CAAC;gBACzD,CAAC;YACH,CAAC;YAED,OAAO,YAAY,CAAC;QACtB,CAAC;IACH,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,aAAa,CAAC,MAAsB;QACjD,MAAM,UAAU,GAAG,kBAAK,MAAM,CAAY,CAAC;QAE3C,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;QACpC,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,CAAC,CAAC,aAAa,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACpH,IAAI,sBAAsB,EAAE,CAAC;YAC3B,UAAU,CAAC,gBAAgB,GAAG,sBAAsB,CAAC;YACrD,OAAO,UAAU,CAAC,WAAW,CAAC;QAChC,CAAC;QACD,OAAO,UAAoB,CAAC;IAC9B,CAAC;CACF"}

package/dist/esm/src/utils/object.js

@@ -0,0 +1,40 @@
+/**
+ * Checks whether the given object has any properties.
+ */
+export function isEmptyObject(obj) {
+    if (typeof (obj) !== 'object') {
+        return false;
+    }
+    for (const _ in obj) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Recursively removes all properties with an empty object or array as its value from the given object.
+ */
+export function removeEmptyObjects(obj) {
+    Object.keys(obj).forEach(key => {
+        if (typeof (obj[key]) === 'object') {
+            // recursive remove empty object or array properties in nested objects
+            removeEmptyObjects(obj[key]);
+        }
+        if (isEmptyObject(obj[key])) {
+            delete obj[key];
+        }
+    });
+}
+/**
+ * Recursively removes all properties with `undefined` as its value from the given object.
+ */
+export function removeUndefinedProperties(obj) {
+    Object.keys(obj).forEach(key => {
+        if (obj[key] === undefined) {
+            delete obj[key];
+        }
+        else if (typeof (obj[key]) === 'object') {
+            removeUndefinedProperties(obj[key]); // recursive remove `undefined` properties in nested objects
+        }
+    });
+}
+//# sourceMappingURL=object.js.map

package/dist/esm/src/utils/object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../../src/utils/object.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,IAAI,OAAM,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAA4B;IAC7D,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC7B,IAAI,OAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YAClC,sEAAsE;YACtE,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAA4B,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAC5B,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,GAA4B;IACpE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC7B,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;aAAM,IAAI,OAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YACzC,yBAAyB,CAAC,GAAG,CAAC,GAAG,CAA4B,CAAC,CAAC,CAAC,4DAA4D;QAC9H,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/esm/src/utils/private-key-signer.js

@@ -0,0 +1,43 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { signatureAlgorithms } from '../jose/algorithms/signing/signature-algorithms.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+/**
+ * A signer that signs using a private key.
+ */
+export class PrivateKeySigner {
+    constructor(options) {
+        var _a, _b;
+        if (options.keyId === undefined && options.privateJwk.kid === undefined) {
+            throw new DwnError(DwnErrorCode.PrivateKeySignerUnableToDeduceKeyId, `Unable to deduce the key ID`);
+        }
+        // NOTE: `alg` is optional for a JWK as specified in https://datatracker.ietf.org/doc/html/rfc7517#section-4.4
+        if (options.algorithm === undefined && options.privateJwk.alg === undefined) {
+            throw new DwnError(DwnErrorCode.PrivateKeySignerUnableToDeduceAlgorithm, `Unable to deduce the signature algorithm`);
+        }
+        this.keyId = (_a = options.keyId) !== null && _a !== void 0 ? _a : options.privateJwk.kid;
+        this.algorithm = (_b = options.algorithm) !== null && _b !== void 0 ? _b : options.privateJwk.alg;
+        this.privateJwk = options.privateJwk;
+        this.signatureAlgorithm = signatureAlgorithms[options.privateJwk.crv];
+        if (!this.signatureAlgorithm) {
+            throw new DwnError(DwnErrorCode.PrivateKeySignerUnsupportedCurve, `Unsupported crv ${options.privateJwk.crv}, crv must be one of ${Object.keys(signatureAlgorithms)}`);
+        }
+    }
+    /**
+     * Signs the given content and returns the signature as bytes.
+     */
+    sign(content) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const signatureBytes = yield this.signatureAlgorithm.sign(content, this.privateJwk);
+            return signatureBytes;
+        });
+    }
+}
+//# sourceMappingURL=private-key-signer.js.map

package/dist/esm/src/utils/private-key-signer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-key-signer.js","sourceRoot":"","sources":["../../../../src/utils/private-key-signer.ts"],"names":[],"mappings":";;;;;;;;;AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAC;AACzF,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAsB9D;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAM3B,YAAmB,OAAgC;;QACjD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACxE,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,mCAAmC,EAChD,6BAA6B,CAC9B,CAAC;QACJ,CAAC;QAED,8GAA8G;QAC9G,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YAC5E,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,uCAAuC,EACpD,0CAA0C,CAC3C,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,MAAA,OAAO,CAAC,KAAK,mCAAI,OAAO,CAAC,UAAU,CAAC,GAAI,CAAC;QACtD,IAAI,CAAC,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,OAAO,CAAC,UAAU,CAAC,GAAI,CAAC;QAC9D,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,mBAAmB,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAEtE,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,gCAAgC,EAC7C,mBAAmB,OAAO,CAAC,UAAU,CAAC,GAAG,wBAAwB,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CACpG,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACU,IAAI,CAAE,OAAmB;;YACpC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACpF,OAAO,cAAc,CAAC;QACxB,CAAC;KAAA;CACF"}

package/dist/esm/src/utils/protocols.js

@@ -0,0 +1,51 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Secp256k1 } from './secp256k1.js';
+import { HdKey, KeyDerivationScheme } from '../utils/hd-key.js';
+/**
+ * Class containing Protocol related utility methods.
+ */
+export class Protocols {
+    /**
+     * Derives public encryptions keys and inject it in the `$encryption` property for each protocol path segment of the given Protocol definition,
+     * then returns the final encryption-enabled protocol definition.
+     * NOTE: The original definition passed in is unmodified.
+     */
+    static deriveAndInjectPublicEncryptionKeys(protocolDefinition, rootKeyId, privateJwk) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // clone before modify
+            const encryptionEnabledProtocolDefinition = JSON.parse(JSON.stringify(protocolDefinition));
+            // a function that recursively creates and adds `$encryption` property to every rule set
+            function addEncryptionProperty(ruleSet, parentKey) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    for (const key in ruleSet) {
+                        // if we encounter a nested rule set (a property name that doesn't begin with '$'), recursively inject the `$encryption` property
+                        if (!key.startsWith('$')) {
+                            const derivedPrivateKey = yield HdKey.derivePrivateKey(parentKey, [key]);
+                            const publicKeyJwk = yield Secp256k1.getPublicJwk(derivedPrivateKey.derivedPrivateKey);
+                            ruleSet[key].$encryption = { rootKeyId, publicKeyJwk };
+                            yield addEncryptionProperty(ruleSet[key], derivedPrivateKey);
+                        }
+                    }
+                });
+            }
+            // inject encryption property starting from each root level record type
+            const rootKey = {
+                derivationScheme: KeyDerivationScheme.ProtocolPath,
+                derivedPrivateKey: privateJwk,
+                rootKeyId
+            };
+            const protocolLevelDerivedKey = yield HdKey.derivePrivateKey(rootKey, [KeyDerivationScheme.ProtocolPath, protocolDefinition.protocol]);
+            yield addEncryptionProperty(encryptionEnabledProtocolDefinition.structure, protocolLevelDerivedKey);
+            return encryptionEnabledProtocolDefinition;
+        });
+    }
+}
+//# sourceMappingURL=protocols.js.map

package/dist/esm/src/utils/protocols.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocols.js","sourceRoot":"","sources":["../../../../src/utils/protocols.ts"],"names":[],"mappings":";;;;;;;;;AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEhE;;GAEG;AACH,MAAM,OAAO,SAAS;IACpB;;;;OAIG;IACI,MAAM,CAAO,mCAAmC,CACrD,kBAAsC,EACtC,SAAiB,EACjB,UAAsB;;YAEtB,sBAAsB;YACtB,MAAM,mCAAmC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAuB,CAAC;YAEjH,wFAAwF;YACxF,SAAe,qBAAqB,CAAC,OAAwB,EAAE,SAA4B;;oBACzF,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;wBAC1B,iIAAiI;wBACjI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;4BACzB,MAAM,iBAAiB,GAAG,MAAM,KAAK,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;4BACzE,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;4BAEvF,OAAO,CAAC,GAAG,CAAC,CAAC,WAAW,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;4BACvD,MAAM,qBAAqB,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,iBAAiB,CAAC,CAAC;wBAC/D,CAAC;oBACH,CAAC;gBACH,CAAC;aAAA;YAED,uEAAuE;YACvE,MAAM,OAAO,GAAsB;gBACjC,gBAAgB,EAAI,mBAAmB,CAAC,YAAY;gBACpD,iBAAiB,EAAG,UAAU;gBAC9B,SAAS;aACV,CAAC;YACF,MAAM,uBAAuB,GAAG,MAAM,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC;YACvI,MAAM,qBAAqB,CAAC,mCAAmC,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC;YAEpG,OAAO,mCAAmC,CAAC;QAC7C,CAAC;KAAA;CACF"}