@abaxxtech/id 0.0.0

package/dist/types/src/core/dwn-error.d.ts

@@ -0,0 +1,133 @@
+/**
+ * A class that represents a DWN error.
+ */
+export declare class DwnError extends Error {
+    code: string;
+    constructor(code: string, message: string);
+}
+/**
+ * DWN SDK error codes.
+ */
+export declare enum DwnErrorCode {
+    AuthenticateJwsMissing = "AuthenticateJwsMissing",
+    AuthenticateDescriptorCidMismatch = "AuthenticateDescriptorCidMismatch",
+    AuthenticationMoreThanOneSignatureNotSupported = "AuthenticationMoreThanOneSignatureNotSupported",
+    AuthorizationUnknownAuthor = "AuthorizationUnknownAuthor",
+    AuthorizationNotGrantedToAuthor = "AuthorizationNotGrantedToAuthor",
+    ComputeCidCodecNotSupported = "ComputeCidCodecNotSupported",
+    ComputeCidMultihashNotSupported = "ComputeCidMultihashNotSupported",
+    DidMethodNotSupported = "DidMethodNotSupported",
+    DidNotString = "DidNotString",
+    DidNotValid = "DidNotValid",
+    DidResolutionFailed = "DidResolutionFailed",
+    Ed25519InvalidJwk = "Ed25519InvalidJwk",
+    GeneralJwsVerifierGetPublicKeyNotFound = "GeneralJwsVerifierGetPublicKeyNotFound",
+    GeneralJwsVerifierInvalidSignature = "GeneralJwsVerifierInvalidSignature",
+    GrantAuthorizationGrantExpired = "GrantAuthorizationGrantExpired",
+    GrantAuthorizationGrantMissing = "GrantAuthorizationGrantMissing",
+    GrantAuthorizationGrantRevoked = "GrantAuthorizationGrantRevoked",
+    GrantAuthorizationInterfaceMismatch = "GrantAuthorizationInterfaceMismatch",
+    GrantAuthorizationMethodMismatch = "GrantAuthorizationMethodMismatch",
+    GrantAuthorizationNotGrantedForTenant = "GrantAuthorizationNotGrantedForTenant",
+    GrantAuthorizationNotGrantedToAuthor = "GrantAuthorizationNotGrantedToAuthor",
+    GrantAuthorizationGrantNotYetActive = "GrantAuthorizationGrantNotYetActive",
+    HdKeyDerivationPathInvalid = "HdKeyDerivationPathInvalid",
+    JwsVerifySignatureUnsupportedCrv = "JwsVerifySignatureUnsupportedCrv",
+    JwsDecodePlainObjectPayloadInvalid = "JwsDecodePlainObjectPayloadInvalid",
+    MessageGetInvalidCid = "MessageGetInvalidCid",
+    ParseCidCodecNotSupported = "ParseCidCodecNotSupported",
+    ParseCidMultihashNotSupported = "ParseCidMultihashNotSupported",
+    PermissionsGrantGrantedByMismatch = "PermissionsGrantGrantedByMismatch",
+    PermissionsGrantNotADelegatedGrant = "PermissionsGrantNotADelegatedGrant",
+    PermissionsGrantScopeContextIdAndProtocolPath = "PermissionsGrantScopeContextIdAndProtocolPath",
+    PermissionsGrantScopeSchemaProhibitedFields = "PermissionsGrantScopeSchemaProhibitedFields",
+    PermissionsGrantUnauthorizedGrant = "PermissionsGrantUnauthorizedGrant",
+    PermissionsRevokeMissingPermissionsGrant = "PermissionsRevokeMissingPermissionsGrant",
+    PermissionsRevokeUnauthorizedRevoke = "PermissionsRevokeUnauthorizedRevoke",
+    PrivateKeySignerUnableToDeduceAlgorithm = "PrivateKeySignerUnableToDeduceAlgorithm",
+    PrivateKeySignerUnableToDeduceKeyId = "PrivateKeySignerUnableToDeduceKeyId",
+    PrivateKeySignerUnsupportedCurve = "PrivateKeySignerUnsupportedCurve",
+    ProtocolAuthorizationActionNotAllowed = "ProtocolAuthorizationActionNotAllowed",
+    ProtocolAuthorizationActionRulesNotFound = "ProtocolAuthorizationActionRulesNotFound",
+    ProtocolAuthorizationDuplicateContextRoleRecipient = "ProtocolAuthorizationDuplicateContextRoleRecipient",
+    ProtocolAuthorizationDuplicateGlobalRoleRecipient = "ProtocolAuthorizationDuplicateGlobalRoleRecipient",
+    ProtocolAuthorizationIncorrectDataFormat = "ProtocolAuthorizationIncorrectDataFormat",
+    ProtocolAuthorizationIncorrectProtocolPath = "ProtocolAuthorizationIncorrectProtocolPath",
+    ProtocolAuthorizationInvalidSchema = "ProtocolAuthorizationInvalidSchema",
+    ProtocolAuthorizationInvalidType = "ProtocolAuthorizationInvalidType",
+    ProtocolAuthorizationMissingContextId = "ProtocolAuthorizationMissingContextId",
+    ProtocolAuthorizationMissingRole = "ProtocolAuthorizationMissingRole",
+    ProtocolAuthorizationMissingRuleSet = "ProtocolAuthorizationMissingRuleSet",
+    ProtocolAuthorizationParentlessIncorrectProtocolPath = "ProtocolAuthorizationParentlessIncorrectProtocolPath",
+    ProtocolAuthorizationNotARole = "ProtocolAuthorizationNotARole",
+    ProtocolAuthorizationParentNotFound = "ProtocolAuthorizationParentNotFound",
+    ProtocolAuthorizationProtocolNotFound = "ProtocolAuthorizationProtocolNotFound",
+    ProtocolAuthorizationQueryWithoutRole = "ProtocolAuthorizationQueryWithoutRole",
+    ProtocolAuthorizationRoleMissingRecipient = "ProtocolAuthorizationRoleMissingRecipient",
+    ProtocolsConfigureContextRoleAtProhibitedProtocolPath = "ProtocolsConfigureContextRoleAtProhibitedProtocolPath",
+    ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath = "ProtocolsConfigureGlobalRoleAtProhibitedProtocolPath",
+    ProtocolsConfigureInvalidRole = "ProtocolsConfigureInvalidRole",
+    ProtocolsConfigureInvalidActionMissingOf = "ProtocolsConfigureInvalidActionMissingOf",
+    ProtocolsConfigureInvalidActionOfNotAllowed = "ProtocolsConfigureInvalidActionOfNotAllowed",
+    ProtocolsConfigureInvalidRecipientOfAction = "ProtocolsConfigureInvalidRecipientOfAction",
+    ProtocolsConfigureQueryNotAllowed = "ProtocolsConfigureQueryNotAllowed",
+    ProtocolsConfigureUnauthorized = "ProtocolsConfigureUnauthorized",
+    ProtocolsQueryUnauthorized = "ProtocolsQueryUnauthorized",
+    RecordsDecryptNoMatchingKeyEncryptedFound = "RecordsDecryptNoMatchingKeyEncryptedFound",
+    RecordsDeleteAuthorizationFailed = "RecordsDeleteAuthorizationFailed",
+    RecordsGrantAuthorizationConditionPublicationProhibited = "RecordsGrantAuthorizationConditionPublicationProhibited",
+    RecordsGrantAuthorizationConditionPublicationRequired = "RecordsGrantAuthorizationConditionPublicationRequired",
+    RecordsGrantAuthorizationScopeContextIdMismatch = "RecordsGrantAuthorizationScopeContextIdMismatch",
+    RecordsGrantAuthorizationScopeNotProtocol = "RecordsGrantAuthorizationScopeNotProtocol",
+    RecordsGrantAuthorizationScopeProtocolMismatch = "RecordsGrantAuthorizationScopeProtocolMismatch",
+    RecordsGrantAuthorizationScopeProtocolPathMismatch = "RecordsGrantAuthorizationScopeProtocolPathMismatch",
+    RecordsGrantAuthorizationScopeSchema = "RecordsGrantAuthorizationScopeSchema",
+    RecordsDerivePrivateKeyUnSupportedCurve = "RecordsDerivePrivateKeyUnSupportedCurve",
+    RecordsInvalidAncestorKeyDerivationSegment = "RecordsInvalidAncestorKeyDerivationSegment",
+    RecordsProtocolContextDerivationSchemeMissingContextId = "RecordsProtocolContextDerivationSchemeMissingContextId",
+    RecordsProtocolPathDerivationSchemeMissingProtocol = "RecordsProtocolPathDerivationSchemeMissingProtocol",
+    RecordsQueryFilterMissingRequiredProperties = "RecordsQueryFilterMissingRequiredProperties",
+    RecordsReadReturnedMultiple = "RecordsReadReturnedMultiple",
+    RecordsReadAuthorizationFailed = "RecordsReadAuthorizationFailed",
+    RecordsSchemasDerivationSchemeMissingSchema = "RecordsSchemasDerivationSchemeMissingSchema",
+    RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch = "RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch",
+    RecordsValidateIntegrityGrantedToAndSignerMismatch = "RecordsValidateIntegrityGrantedToAndSignerMismatch",
+    RecordsWriteAttestationIntegrityMoreThanOneSignature = "RecordsWriteAttestationIntegrityMoreThanOneSignature",
+    RecordsWriteAttestationIntegrityDescriptorCidMismatch = "RecordsWriteAttestationIntegrityDescriptorCidMismatch",
+    RecordsWriteAttestationIntegrityInvalidPayloadProperty = "RecordsWriteAttestationIntegrityInvalidPayloadProperty",
+    RecordsWriteAuthorizationFailed = "RecordsWriteAuthorizationFailed",
+    RecordsWriteCreateMissingSigner = "RecordsWriteCreateMissingSigner",
+    RecordsWriteCreateContextIdAndParentIdMutuallyInclusive = "RecordsWriteCreateContextIdAndParentIdMutuallyInclusive",
+    RecordsWriteCreateDataAndDataCidMutuallyExclusive = "RecordsWriteCreateDataAndDataCidMutuallyExclusive",
+    RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive = "RecordsWriteCreateDataCidAndDataSizeMutuallyInclusive",
+    RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive = "RecordsWriteCreateProtocolAndProtocolPathMutuallyInclusive",
+    RecordsWriteDataCidMismatch = "RecordsWriteDataCidMismatch",
+    RecordsWriteDataSizeMismatch = "RecordsWriteDataSizeMismatch",
+    RecordsWriteGetEntryIdUndefinedAuthor = "RecordsWriteGetEntryIdUndefinedAuthor",
+    RecordsWriteGetInitialWriteNotFound = "RecordsWriteGetInitialWriteNotFound",
+    RecordsWriteImmutablePropertyChanged = "RecordsWriteImmutablePropertyChanged",
+    RecordsWriteMissingAuthorizationSigner = "RecordsWriteMissingAuthorizationSigner",
+    RecordsWriteMissingSigner = "RecordsWriteMissingSigner",
+    RecordsWriteMissingDataInPrevious = "RecordsWriteMissingDataInPrevious",
+    RecordsWriteMissingDataAssociation = "RecordsWriteMissingDataAssociation",
+    RecordsWriteMissingDataStream = "RecordsWriteMissingDataStream",
+    RecordsWriteMissingProtocol = "RecordsWriteMissingProtocol",
+    RecordsWriteMissingSchema = "RecordsWriteMissingSchema",
+    RecordsWriteOwnerAndTenantMismatch = "RecordsWriteOwnerAndTenantMismatch",
+    RecordsWriteSignAsOwnerUnknownAuthor = "RecordsWriteSignAsOwnerUnknownAuthor",
+    RecordsWriteValidateIntegrityAttestationMismatch = "RecordsWriteValidateIntegrityAttestationMismatch",
+    RecordsWriteValidateIntegrityContextIdMismatch = "RecordsWriteValidateIntegrityContextIdMismatch",
+    RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload = "RecordsWriteValidateIntegrityContextIdNotInSignerSignaturePayload",
+    RecordsWriteValidateIntegrityDateCreatedMismatch = "RecordsWriteValidateIntegrityDateCreatedMismatch",
+    RecordsWriteValidateIntegrityEncryptionCidMismatch = "RecordsWriteValidateIntegrityEncryptionCidMismatch",
+    RecordsWriteValidateIntegrityRecordIdUnauthorized = "RecordsWriteValidateIntegrityRecordIdUnauthorized",
+    SchemaValidatorSchemaNotFound = "SchemaValidatorSchemaNotFound",
+    SchemaValidationFailure = "SchemaValidationFailure",
+    Secp256k1KeyNotValid = "Secp256k1KeyNotValid",
+    TimestampInvalid = "TimestampInvalid",
+    UrlProtocolNotNormalized = "UrlProtocolNotNormalized",
+    UrlProtocolNotNormalizable = "UrlProtocolNotNormalizable",
+    UrlSchemaNotNormalized = "UrlSchemaNotNormalized",
+    UrlSchemaNotNormalizable = "UrlSchemaNotNormalizable"
+}
+//# sourceMappingURL=dwn-error.d.ts.map

package/dist/types/src/core/dwn-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dwn-error.d.ts","sourceRoot":"","sources":["../../../../src/core/dwn-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACb,IAAI,EAAE,MAAM;gBAAZ,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAKlD;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB,sBAAsB,2BAA2B;IACjD,iCAAiC,sCAAsC;IACvE,8CAA8C,mDAAmD;IACjG,0BAA0B,+BAA+B;IACzD,+BAA+B,oCAAoC;IACnE,2BAA2B,gCAAgC;IAC3D,+BAA+B,oCAAoC;IACnE,qBAAqB,0BAA0B;IAC/C,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,mBAAmB,wBAAwB;IAC3C,iBAAiB,sBAAsB;IACvC,sCAAsC,2CAA2C;IACjF,kCAAkC,uCAAuC;IACzE,8BAA8B,mCAAmC;IACjE,8BAA8B,mCAAmC;IACjE,8BAA8B,mCAAmC;IACjE,mCAAmC,wCAAwC;IAC3E,gCAAgC,qCAAqC;IACrE,qCAAqC,0CAA0C;IAC/E,oCAAoC,yCAAyC;IAC7E,mCAAmC,wCAAwC;IAC3E,0BAA0B,+BAA+B;IACzD,gCAAgC,qCAAqC;IACrE,kCAAkC,uCAAuC;IACzE,oBAAoB,yBAAyB;IAC7C,yBAAyB,8BAA8B;IACvD,6BAA6B,kCAAkC;IAC/D,iCAAiC,sCAAsC;IACvE,kCAAkC,uCAAuC;IACzE,6CAA6C,kDAAkD;IAC/F,2CAA2C,gDAAgD;IAC3F,iCAAiC,sCAAsC;IACvE,wCAAwC,6CAA6C;IACrF,mCAAmC,wCAAwC;IAC3E,uCAAuC,4CAA4C;IACnF,mCAAmC,wCAAwC;IAC3E,gCAAgC,qCAAqC;IACrE,qCAAqC,0CAA0C;IAC/E,wCAAwC,6CAA6C;IACrF,kDAAkD,uDAAuD;IACzG,iDAAiD,sDAAsD;IACvG,wCAAwC,6CAA6C;IACrF,0CAA0C,+CAA+C;IACzF,kCAAkC,uCAAuC;IACzE,gCAAgC,qCAAqC;IACrE,qCAAqC,0CAA0C;IAC/E,gCAAgC,qCAAqC;IACrE,mCAAmC,wCAAwC;IAC3E,oDAAoD,yDAAyD;IAC7G,6BAA6B,kCAAkC;IAC/D,mCAAmC,wCAAwC;IAC3E,qCAAqC,0CAA0C;IAC/E,qCAAqC,0CAA0C;IAC/E,yCAAyC,8CAA8C;IACvF,qDAAqD,0DAA0D;IAC/G,oDAAoD,yDAAyD;IAC7G,6BAA6B,kCAAkC;IAC/D,wCAAwC,6CAA6C;IACrF,2CAA2C,gDAAgD;IAC3F,0CAA0C,+CAA+C;IACzF,iCAAiC,sCAAsC;IACvE,8BAA8B,mCAAmC;IACjE,0BAA0B,+BAA+B;IACzD,yCAAyC,8CAA8C;IACvF,gCAAgC,qCAAqC;IACrE,uDAAuD,4DAA4D;IACnH,qDAAqD,0DAA0D;IAC/G,+CAA+C,oDAAoD;IACnG,yCAAyC,8CAA8C;IACvF,8CAA8C,mDAAmD;IACjG,kDAAkD,uDAAuD;IACzG,oCAAoC,yCAAyC;IAC7E,uCAAuC,4CAA4C;IACnF,0CAA0C,+CAA+C;IACzF,sDAAsD,2DAA2D;IACjH,kDAAkD,uDAAuD;IACzG,2CAA2C,gDAAgD;IAC3F,2BAA2B,gCAAgC;IAC3D,8BAA8B,mCAAmC;IACjE,2CAA2C,gDAAgD;IAC3F,4DAA4D,iEAAiE;IAC7H,kDAAkD,uDAAuD;IACzG,oDAAoD,yDAAyD;IAC7G,qDAAqD,0DAA0D;IAC/G,sDAAsD,2DAA2D;IACjH,+BAA+B,oCAAoC;IACnE,+BAA+B,oCAAoC;IACnE,uDAAuD,4DAA4D;IACnH,iDAAiD,sDAAsD;IACvG,qDAAqD,0DAA0D;IAC/G,0DAA0D,+DAA+D;IACzH,2BAA2B,gCAAgC;IAC3D,4BAA4B,iCAAiC;IAC7D,qCAAqC,0CAA0C;IAC/E,mCAAmC,wCAAwC;IAC3E,oCAAoC,yCAAyC;IAC7E,sCAAsC,2CAA2C;IACjF,yBAAyB,8BAA8B;IACvD,iCAAiC,sCAAsC;IACvE,kCAAkC,uCAAuC;IACzE,6BAA6B,kCAAkC;IAC/D,2BAA2B,gCAAgC;IAC3D,yBAAyB,8BAA8B;IACvD,kCAAkC,uCAAuC;IACzE,oCAAoC,yCAAyC;IAC7E,gDAAgD,qDAAqD;IACrG,8CAA8C,mDAAmD;IACjG,iEAAiE,sEAAsE;IACvI,gDAAgD,qDAAqD;IACrG,kDAAkD,uDAAuD;IACzG,iDAAiD,sDAAsD;IACvG,6BAA6B,kCAAkC;IAC/D,uBAAuB,4BAA4B;IACnD,oBAAoB,yBAAyB;IAC7C,gBAAgB,qBAAqB;IACrC,wBAAwB,6BAA6B;IACrD,0BAA0B,+BAA+B;IACzD,sBAAsB,2BAA2B;IACjD,wBAAwB,6BAA6B;CACtD"}

package/dist/types/src/core/grant-authorization.d.ts

@@ -0,0 +1,35 @@
+import type { GenericMessage } from '../types/message-types.js';
+import type { MessageStore } from '../types/message-store.js';
+import type { PermissionsGrantMessage } from '../types/permissions-types.js';
+export declare class GrantAuthorization {
+    /**
+     * Performs PermissionsGrant-based authorization against the given message
+     * Does not validate grant `conditions` or `scope` beyond `interface` and `method`
+     * @throws {DwnError} if authorization fails
+     */
+    static authorizeGenericMessage(tenant: string, incomingMessage: GenericMessage, author: string, permissionsGrantMessage: PermissionsGrantMessage, messageStore: MessageStore): Promise<void>;
+    /**
+     * Fetches PermissionsGrantMessage with CID `permissionsGrantId`.
+     * @returns the PermissionsGrantMessage with CID `permissionsGrantId` if message exists
+     * @throws {Error} if PermissionsGrantMessage with CID `permissionsGrantId` does not exist
+     */
+    static fetchGrant(tenant: string, messageStore: MessageStore, permissionsGrantId: string): Promise<PermissionsGrantMessage>;
+    /**
+     * Verifies the given `grantedTo` and `grantedFor` values against the given permissions grant and throws error if there is a mismatch.
+     */
+    private static verifyGrantedToAndGrantedFor;
+    /**
+     * Verify that the incoming message is within the allowed time frame of the grant,
+     * and the grant has not been revoked.
+     * @param permissionsGrantId Purely being passed as an optimization. Technically can be computed from `permissionsGrantMessage`.
+     * @throws {DwnError} if incomingMessage has timestamp for a time in which the grant is not active.
+     */
+    private static verifyGrantActive;
+    /**
+     * Verify that the `interface` and `method` grant scopes match the incoming message
+     * @param permissionsGrantId Purely being passed for logging purposes.
+     * @throws {DwnError} if the `interface` and `method` of the incoming message do not match the scope of the PermissionsGrant
+     */
+    private static verifyGrantScopeInterfaceAndMethod;
+}
+//# sourceMappingURL=grant-authorization.d.ts.map

package/dist/types/src/core/grant-authorization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grant-authorization.d.ts","sourceRoot":"","sources":["../../../../src/core/grant-authorization.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAM7E,qBAAa,kBAAkB;IAE7B;;;;OAIG;WACiB,uBAAuB,CACzC,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,cAAc,EAC/B,MAAM,EAAE,MAAM,EACd,uBAAuB,EAAE,uBAAuB,EAChD,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC;IAyBhB;;;;OAIG;WACiB,UAAU,CAC5B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,YAAY,EAC1B,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,uBAAuB,CAAC;IAgBnC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAoB3C;;;;;OAKG;mBACkB,iBAAiB;IAuCtC;;;;OAIG;mBACkB,kCAAkC;CAkBxD"}

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

@@ -0,0 +1,33 @@
+import type { QueryResultEntry } from '../types/message-types.js';
+import type { Readable } from 'readable-stream';
+type Status = {
+    code: number;
+    detail: string;
+};
+export type GenericMessageReply = {
+    status: Status;
+};
+export declare function messageReplyFromError(e: unknown, code: number): GenericMessageReply;
+/**
+ * Catch-all message reply type. It is recommended to use GenericMessageReply or a message-specific reply type wherever possible.
+ */
+export type UnionMessageReply = GenericMessageReply & {
+    /**
+     * Resulting message entries or events returned from the invocation of the corresponding message.
+     * e.g. the resulting messages from a RecordsQuery
+     * Mutually exclusive with `data`.
+     */
+    entries?: QueryResultEntry[];
+    /**
+     * Data corresponding to the message received if applicable (e.g. RecordsRead).
+     * Mutually exclusive with `entries` and `cursor`.
+     */
+    data?: Readable;
+    /**
+     * A cursor for pagination if applicable (e.g. RecordsQuery).
+     * Mutually exclusive with `data`.
+     */
+    cursor?: string;
+};
+export {};
+//# sourceMappingURL=message-reply.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"message-reply.d.ts","sourceRoot":"","sources":["../../../../src/core/message-reply.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEhD,KAAK,MAAM,GAAG;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAKnF;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,mBAAmB,GAAG;IACpD;;;;OAIG;IACH,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE7B;;;OAGG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

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

@@ -0,0 +1,79 @@
+import type { DelegatedGrantMessage } from '../types/delegated-grant-message.js';
+import type { GeneralJws } from '../types/jws-types.js';
+import type { Signer } from '../types/signer.js';
+import type { AuthorizationModel, Descriptor, GenericMessage, GenericSignaturePayload } from '../types/message-types.js';
+/**
+ * A class containing utility methods for working with DWN messages.
+ */
+export declare class Message {
+    /**
+     * Validates the given message against the corresponding JSON schema.
+     * @throws {Error} if fails validation.
+     */
+    static validateJsonSchema(rawMessage: any): void;
+    /**
+     * Gets the DID of the signer of the given message, returns `undefined` if message is not signed.
+     */
+    static getSigner(message: GenericMessage): string | undefined;
+    /**
+     * Gets the CID of the given message.
+     */
+    static getCid(message: GenericMessage): Promise<string>;
+    /**
+     * Compares message CID in lexicographical order according to the spec.
+     * @returns 1 if `a` is larger than `b`; -1 if `a` is smaller/older than `b`; 0 otherwise (same message)
+     */
+    static compareCid(a: GenericMessage, b: GenericMessage): Promise<number>;
+    /**
+     * Creates the `authorization` property to be included in a DWN message.
+     * @param signer Message signer.
+     * @returns {AuthorizationModel} used as an `authorization` property.
+     */
+    static createAuthorization(input: {
+        descriptor: Descriptor;
+        signer: Signer;
+        delegatedGrant?: DelegatedGrantMessage;
+        permissionsGrantId?: string;
+        protocolRole?: string;
+    }): Promise<AuthorizationModel>;
+    /**
+     * Creates a generic signature from the given DWN message descriptor by including `descriptorCid` as the required property in the signature payload.
+     * NOTE: there is an opportunity to consolidate RecordsWrite.createSignerSignature() wth this method
+     */
+    static createSignature(descriptor: Descriptor, signer: Signer, additionalPayloadProperties?: {
+        delegatedGrantId?: string;
+        permissionsGrantId?: string;
+        protocolRole?: string;
+    }): Promise<GeneralJws>;
+    /**
+     * @returns newest message in the array. `undefined` if given array is empty.
+     */
+    static getNewestMessage(messages: GenericMessage[]): Promise<GenericMessage | undefined>;
+    /**
+     * @returns oldest message in the array. `undefined` if given array is empty.
+     */
+    static getOldestMessage(messages: GenericMessage[]): Promise<GenericMessage | undefined>;
+    /**
+     * Checks if first message is newer than second message.
+     * @returns `true` if `a` is newer than `b`; `false` otherwise
+     */
+    static isNewer(a: GenericMessage, b: GenericMessage): Promise<boolean>;
+    /**
+     * Checks if first message is older than second message.
+     * @returns `true` if `a` is older than `b`; `false` otherwise
+     */
+    static isOlder(a: GenericMessage, b: GenericMessage): Promise<boolean>;
+    /**
+     * Compares the `messageTimestamp` of the given messages with a fallback to message CID according to the spec.
+     * @returns 1 if `a` is larger/newer than `b`; -1 if `a` is smaller/older than `b`; 0 otherwise (same age)
+     */
+    static compareMessageTimestamp(a: GenericMessage, b: GenericMessage): Promise<number>;
+    /**
+     * Validates the structural integrity of the message signature given.
+     * NOTE: signature is not verified.
+     * @param payloadJsonSchemaKey The key to look up the JSON schema referenced in `compile-validators.js` and perform payload schema validation on.
+     * @returns the parsed JSON payload object if validation succeeds.
+     */
+    static validateMessageSignatureIntegrity(messageSignature: GeneralJws, messageDescriptor: Descriptor, payloadJsonSchemaKey?: string): Promise<GenericSignaturePayload>;
+}
+//# sourceMappingURL=message.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../../../src/core/message.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AACjF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAWzH;;GAEG;AACH,qBAAa,OAAO;IAClB;;;OAGG;WACW,kBAAkB,CAAC,UAAU,EAAE,GAAG,GAAG,IAAI;IASvD;;OAEG;WACW,SAAS,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,GAAG,SAAS;IASpE;;OAEG;WACiB,MAAM,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBpE;;;OAGG;WACiB,UAAU,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAOrF;;;;OAIG;WACiB,mBAAmB,CAAC,KAAK,EAAE;QAC7C,UAAU,EAAE,UAAU,CAAC;QACvB,MAAM,EAAE,MAAM,CAAC;QACf,cAAc,CAAC,EAAE,qBAAqB,CAAC;QACvC,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAqB/B;;;OAGG;WACiB,eAAe,CACjC,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,EACd,2BAA2B,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,GAC9G,OAAO,CAAC,UAAU,CAAC;IActB;;OAEG;WACiB,gBAAgB,CAAC,QAAQ,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAWrG;;OAEG;WACiB,gBAAgB,CAAC,QAAQ,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAWrG;;;OAGG;WACiB,OAAO,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAKnF;;;OAGG;WACiB,OAAO,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAKnF;;;OAGG;WACiB,uBAAuB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAalG;;;;;OAKG;WACiB,iCAAiC,CACnD,gBAAgB,EAAE,UAAU,EAC5B,iBAAiB,EAAE,UAAU,EAC7B,oBAAoB,GAAE,MAAkC,GACvD,OAAO,CAAC,uBAAuB,CAAC;CAuBpC"}

package/dist/types/src/core/protocol-authorization.d.ts

@@ -0,0 +1,85 @@
+import type { MessageStore } from '../types/message-store.js';
+import type { RecordsDelete } from '../interfaces/records-delete.js';
+import type { RecordsQuery } from '../interfaces/records-query.js';
+import type { RecordsRead } from '../interfaces/records-read.js';
+import { RecordsWrite } from '../interfaces/records-write.js';
+export declare class ProtocolAuthorization {
+    /**
+     * Performs validation on the structure of RecordsWrite messages that use a protocol.
+     * @throws {Error} if validation fails.
+     */
+    static validateReferentialIntegrity(tenant: string, incomingMessage: RecordsWrite, messageStore: MessageStore): Promise<void>;
+    /**
+     * Performs protocol-based authorization against the incoming RecordsWrite message.
+     * @throws {Error} if authorization fails.
+     */
+    static authorizeWrite(tenant: string, incomingMessage: RecordsWrite, messageStore: MessageStore): Promise<void>;
+    /**
+     * Performs protocol-based authorization against the incoming RecordsRead  message.
+     * @param newestRecordsWrite Either the incomingMessage itself if the incoming is a RecordsWrite,
+     *                     or the latest RecordsWrite associated with the recordId being read.
+     * @throws {Error} if authorization fails.
+     */
+    static authorizeRead(tenant: string, incomingMessage: RecordsRead, newestRecordsWrite: RecordsWrite, messageStore: MessageStore): Promise<void>;
+    /**
+     * Performs protocol-based authorization against the incoming RecordsQuery message.
+     * @throws {Error} if authorization fails.
+     */
+    static authorizeQuery(tenant: string, incomingMessage: RecordsQuery, messageStore: MessageStore): Promise<void>;
+    static authorizeDelete(tenant: string, incomingMessage: RecordsDelete, newestRecordsWrite: RecordsWrite, messageStore: MessageStore): Promise<void>;
+    /**
+     * Fetches the protocol definition based on the protocol specified in the given message.
+     */
+    private static fetchProtocolDefinition;
+    /**
+     * Constructs a chain of ancestor messages
+     * @param newestRecordsWrite The newest RecordsWrite associated with the recordId being written.
+     *                           This will be the incoming RecordsWrite itself if the incoming message is a RecordsWrite.
+     * @returns the ancestor chain of messages where the first element is the root of the chain; returns empty array if no parent is specified.
+     */
+    private static constructAncestorMessageChain;
+    /**
+     * Gets the rule set corresponding to the given message chain.
+     */
+    private static getRuleSet;
+    /**
+     * Verifies the `protocolPath` declared in the given message (if it is a RecordsWrite) matches the path of actual ancestor chain.
+     * @throws {DwnError} if fails verification.
+     */
+    private static verifyProtocolPath;
+    /**
+     * Verifies the `dataFormat` and `schema` declared in the given message (if it is a RecordsWrite) matches dataFormat
+     * and schema of the type in the given protocol.
+     * @throws {DwnError} if fails verification.
+     */
+    private static verifyType;
+    /**
+     * Check if the incoming message is invoking a role. If so, validate the invoked role.
+     */
+    private static verifyInvokedRole;
+    /**
+     * Returns a list of ProtocolAction(s) based on the incoming message, one of which must be allowed for the message to be authorized.
+     * NOTE: the reason why there could be multiple actions is because in case of an "update" RecordsWrite by the original record author,
+     * the RecordsWrite can either be authorized by a `write` or `update` allow rule. It is important to recognize that the `write` access that allowed
+     * the original record author to create the record maybe revoked (e.g. by role revocation) by the time an "update" by the same author is attempted.
+     */
+    private static getActionsSeekingARuleMatch;
+    /**
+     * Verifies the action (e.g. read/write) specified in the given message matches the allowed actions in the rule set.
+     * @throws {Error} if action not allowed.
+     */
+    private static verifyAllowedActions;
+    /**
+     * Verifies that writes to a $globalRole or $contextRole record do not have the same recipient as an existing RecordsWrite
+     * to the same $globalRole or the same $contextRole in the same context.
+     */
+    private static verifyUniqueRoleRecipient;
+    private static getRuleSetAtProtocolPath;
+    /**
+     * Checks if there is a record in the ancestor chain matching the `who: 'author' | 'recipient'` action rule.
+     * @returns true if the action rule is satisfied. false otherwise
+     */
+    private static checkActor;
+    private static getTypeName;
+}
+//# sourceMappingURL=protocol-authorization.d.ts.map

package/dist/types/src/core/protocol-authorization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol-authorization.d.ts","sourceRoot":"","sources":["../../../../src/core/protocol-authorization.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAIjE,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAK9D,qBAAa,qBAAqB;IAEhC;;;OAGG;WACiB,4BAA4B,CAC9C,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,YAAY,EAC7B,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC;IAoChB;;;OAGG;WACiB,cAAc,CAChC,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,YAAY,EAC7B,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC;IAsChB;;;;;OAKG;WACiB,aAAa,CAC/B,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,WAAW,EAC5B,kBAAkB,EAAE,YAAY,EAChC,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC;IAsChB;;;OAGG;WACiB,cAAc,CAChC,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,YAAY,EAC7B,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC;WAqCI,eAAe,CACjC,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,aAAa,EAC9B,kBAAkB,EAAE,YAAY,EAChC,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC;IAwChB;;OAEG;mBACkB,uBAAuB;IAqB5C;;;;;OAKG;mBACkB,6BAA6B;IA6ClD;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAYzB;;;OAGG;mBACkB,kBAAkB;IAsCvC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAuCzB;;OAEG;mBACkB,iBAAiB;IAoDtC;;;;;OAKG;mBACkB,2BAA2B;IAkChD;;;OAGG;mBACkB,oBAAoB;IA+DzC;;;OAGG;mBACkB,yBAAyB;IAmD9C,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAmBvC;;;OAGG;mBACkB,UAAU;IA2B/B,OAAO,CAAC,MAAM,CAAC,WAAW;CAG3B"}

package/dist/types/src/core/records-grant-authorization.d.ts

@@ -0,0 +1,38 @@
+import type { MessageStore } from '../types/message-store.js';
+import type { PermissionsGrantMessage } from '../types/permissions-types.js';
+import type { RecordsRead } from '../interfaces/records-read.js';
+import type { RecordsWriteMessage } from '../types/records-types.js';
+export declare class RecordsGrantAuthorization {
+    /**
+     * Authorizes the given RecordsWrite in the scope of the DID given.
+     */
+    static authorizeWrite(tenant: string, incomingMessage: RecordsWriteMessage, author: string, permissionsGrantMessage: PermissionsGrantMessage, messageStore: MessageStore): Promise<void>;
+    /**
+     * Authorizes the scope of a PermissionsGrant for RecordsRead.
+     */
+    static authorizeRead(tenant: string, incomingMessage: RecordsRead, newestRecordsWriteMessage: RecordsWriteMessage, author: string, permissionsGrantMessage: PermissionsGrantMessage, messageStore: MessageStore): Promise<void>;
+    /**
+     * @param recordsWrite The source of the record being authorized. If the incoming message is a write,
+     *                     then this is the incoming RecordsWrite. Otherwise, it is the newest existing RecordsWrite.
+     */
+    private static verifyScope;
+    /**
+     * Authorizes a grant scope for a protocol record
+     */
+    private static authorizeProtocolRecord;
+    /**
+     * Authorizes a grant scope for a non-protocol record
+     */
+    private static authorizeFlatRecord;
+    /**
+     * Verifies grant `conditions`.
+     * Currently the only condition is `published` which only applies to RecordsWrites
+     */
+    private static verifyConditions;
+    /**
+     * Checks if scope has no restrictions beyond interface and method.
+     * Grant-holder is authorized to access any record.
+     */
+    private static isUnrestrictedScope;
+}
+//# sourceMappingURL=records-grant-authorization.d.ts.map

package/dist/types/src/core/records-grant-authorization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"records-grant-authorization.d.ts","sourceRoot":"","sources":["../../../../src/core/records-grant-authorization.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAE7E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAMrE,qBAAa,yBAAyB;IACpC;;OAEG;WACiB,cAAc,CAChC,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,mBAAmB,EACpC,MAAM,EAAE,MAAM,EACd,uBAAuB,EAAE,uBAAuB,EAChD,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC;IAchB;;OAEG;WACiB,aAAa,CAC/B,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,WAAW,EAC5B,yBAAyB,EAAE,mBAAmB,EAC9C,MAAM,EAAE,MAAM,EACd,uBAAuB,EAAE,uBAAuB,EAChD,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC;IAYhB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAiB1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAqCtC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAoB/B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;CAInC"}

package/dist/types/src/core/tenant-gate.d.ts

@@ -0,0 +1,16 @@
+/**
+ * An interface that determines if a DID is a tenant of the DWN.
+ */
+export interface TenantGate {
+    /**
+     * @returns `true` if the given DID is a tenant of the DWN; `false` otherwise
+     */
+    isTenant(did: string): Promise<boolean>;
+}
+/**
+ * A tenant gate that treats every DID as a tenant.
+ */
+export declare class AllowAllTenantGate implements TenantGate {
+    isTenant(_did: string): Promise<boolean>;
+}
+//# sourceMappingURL=tenant-gate.d.ts.map

package/dist/types/src/core/tenant-gate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant-gate.d.ts","sourceRoot":"","sources":["../../../../src/core/tenant-gate.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,qBAAa,kBAAmB,YAAW,UAAU;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAGtD"}

package/dist/types/src/did/did-dht-resolver.d.ts

@@ -0,0 +1,26 @@
+import type { DidMethodResolver, DidResolutionResult } from '../types/did-types.js';
+/**
+ * did:dht Resolver.
+ * Resolves DIDs using the Pkarr DHT network.
+ *
+ * Helpful Resources:
+ * * [DID-DHT Spec](https://did-dht.com/)
+ */
+export declare class DidDhtResolver implements DidMethodResolver {
+    private pkarrRelay;
+    constructor(pkarrRelay?: string);
+    method(): string;
+    resolve(did: string): Promise<DidResolutionResult>;
+    /**
+     * Converts a signed pkarr relay payload (`sig + seq + dns-packet`) into a DID Document.
+     */
+    private fromDnsPacket;
+    private extractRawDnsPacket;
+    private txtToString;
+    private parseTxtRecord;
+    private recordHead;
+    private keyMaterialToJwk;
+    private base64UrlToBytes;
+    private static defaultRelayUrl;
+}
+//# sourceMappingURL=did-dht-resolver.d.ts.map

package/dist/types/src/did/did-dht-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"did-dht-resolver.d.ts","sourceRoot":"","sources":["../../../../src/did/did-dht-resolver.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAe,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAGjG;;;;;;GAMG;AACH,qBAAa,cAAe,YAAW,iBAAiB;IACtD,OAAO,CAAC,UAAU,CAAS;gBAEf,UAAU,GAAE,MAAyC;IAIjE,MAAM,IAAI,MAAM;IAIV,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA6CxD;;OAEG;YACW,aAAa;IAoG3B,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,UAAU;YAcJ,gBAAgB;IAe9B,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,MAAM,CAAC,eAAe;CAI/B"}

package/dist/types/src/did/did-ion-resolver.d.ts

@@ -0,0 +1,20 @@
+import type { DidMethodResolver, DidResolutionResult } from '../types/did-types.js';
+/**
+ * Resolver for ION DIDs.
+ *
+ * NOTE: For production use, consider using ion-sidtree in a Docker container
+ * to resolve ION DIDs locally instead of relying on external resolution endpoints.
+ * This would provide better reliability and performance.
+ */
+export declare class DidIonResolver implements DidMethodResolver {
+    private resolutionEndpoint;
+    private fetchFn;
+    /**
+     * @param resolutionEndpoint optional custom URL to send DID resolution request to
+     * @param fetchFn optional custom fetch function for testing
+     */
+    constructor(resolutionEndpoint?: string, fetchFn?: typeof globalThis.fetch);
+    method(): string;
+    resolve(did: string): Promise<DidResolutionResult>;
+}
+//# sourceMappingURL=did-ion-resolver.d.ts.map

package/dist/types/src/did/did-ion-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"did-ion-resolver.d.ts","sourceRoot":"","sources":["../../../../src/did/did-ion-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAYpF;;;;;;GAMG;AACH,qBAAa,cAAe,YAAW,iBAAiB;IAQpD,OAAO,CAAC,kBAAkB;IAP5B,OAAO,CAAC,OAAO,CAA0B;IAEzC;;;OAGG;gBAEO,kBAAkB,GAAE,MAA+D,EAC3F,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK;IAKnC,MAAM,IAAI,MAAM;IAIV,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAczD"}

package/dist/types/src/did/did-key-resolver.d.ts

@@ -0,0 +1,32 @@
+import type { DidMethodResolver, DidResolutionResult } from '../types/did-types.js';
+import type { KeyMaterial } from '../types/jose-types.js';
+/**
+ * did:key Resolver.
+ * * **NOTE**: Key support is limited to Ed25519 and SECP256k1.
+ * * **NOTE**: `verificationMethod` support is limited to `JsonWebKey2020`
+ *
+ * Helpful Resources:
+ * * [DID-Key Draft Spec](https://w3c-ccg.github.io/did-method-key/)
+ */
+export declare class DidKeyResolver implements DidMethodResolver {
+    method(): string;
+    /**
+     * Gets the number of bytes of the multicodec header in the `did:key` DID.
+     * @param did - A `did:key` DID
+     * @returns size of the multicodec head in number of bytes
+     */
+    static getMulticodecSize(did: Uint8Array): number;
+    resolve(did: string): Promise<DidResolutionResult>;
+    /**
+     * Generates a new ed25519 public/private key pair. Creates a DID using the private key.
+     * @returns DID and its key material.
+     */
+    static generate(): Promise<{
+        did: string;
+    } & KeyMaterial>;
+    /**
+     * Gets the fully qualified key ID of a `did:key` DID. ie. '<did>#<method-specific-id>'
+     */
+    static getKeyId(did: string): string;
+}
+//# sourceMappingURL=did-key-resolver.d.ts.map

package/dist/types/src/did/did-key-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"did-key-resolver.d.ts","sourceRoot":"","sources":["../../../../src/did/did-key-resolver.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAe,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAOjG,OAAO,KAAK,EAAE,WAAW,EAAa,MAAM,wBAAwB,CAAC;AAErE;;;;;;;GAOG;AACH,qBAAa,cAAe,YAAW,iBAAiB;IACtD,MAAM,IAAI,MAAM;IAIhB;;;;OAIG;WACW,iBAAiB,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM;IAiBlD,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA6DxD;;;OAGG;WACiB,QAAQ,IAAI,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,WAAW,CAAC;IAiBtE;;OAEG;WACW,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;CAM5C"}

package/dist/types/src/did/did-resolver.d.ts

@@ -0,0 +1,20 @@
+import type { Cache } from '../types/cache.js';
+import type { DidMethodResolver, DidResolutionResult } from '../types/did-types.js';
+/**
+ * A DID resolver that by default supports `did:key`, `did:ion`, and `did:dht` DIDs.
+ */
+export declare class DidResolver {
+    private didResolvers;
+    private cache;
+    constructor(resolvers?: DidMethodResolver[], cache?: Cache);
+    /**
+     * attempt to resolve the DID provided
+     * @throws {Error} if DID is invalid
+     * @throws {Error} if DID method is not supported
+     * @throws {Error} if resolving DID fails
+     * @param did - the DID to resolve
+     * @returns {DidResolutionResult}
+     */
+    resolve(did: string): Promise<DidResolutionResult>;
+}
+//# sourceMappingURL=did-resolver.d.ts.map

package/dist/types/src/did/did-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"did-resolver.d.ts","sourceRoot":"","sources":["../../../../src/did/did-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AASpF;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,YAAY,CAAiC;IACrD,OAAO,CAAC,KAAK,CAAQ;gBAET,SAAS,CAAC,EAAE,iBAAiB,EAAE,EAAE,KAAK,CAAC,EAAC,KAAK;IAoBzD;;;;;;;OAOG;IACU,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;CA+BhE"}

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

@@ -0,0 +1,15 @@
+export declare class Did {
+    /**
+     * Gets the method specific ID segment of a DID. ie. did:<method-name>:<method-specific-id>
+     */
+    static getMethodSpecificId(did: string): string;
+    /**
+     * @param did - the DID to validate
+     */
+    static validate(did: unknown): void;
+    /**
+     * Gets the method name from a DID. ie. did:<method-name>:<method-specific-id>
+     */
+    static getMethodName(did: string): string;
+}
+//# sourceMappingURL=did.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"did.d.ts","sourceRoot":"","sources":["../../../../src/did/did.ts"],"names":[],"mappings":"AAKA,qBAAa,GAAG;IACd;;OAEG;WACW,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAMtD;;OAEG;WACW,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAY1C;;OAEG;WACW,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;CAKjD"}