npm - @credo-ts/didcomm - Versions diffs - 0.6.0-pr-2392-20251010173905 → 0.6.0-pr-2457-20251016083534 - Mend

@credo-ts/didcomm 0.6.0-pr-2392-20251010173905 → 0.6.0-pr-2457-20251016083534

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (868) hide show

package/build/updates/0.1-0.2/credential.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"credential.mjs","names":[],"sources":["../../../src/updates/0.1-0.2/credential.ts"],"sourcesContent":["import type { BaseAgent, JsonObject } from '@credo-ts/core'\nimport type { DidCommCredentialExchangeRecord } from '../../modules/credentials'\nimport type { DidCommPlaintextMessage } from '../../types'\n\nimport { Metadata } from '@credo-ts/core'\n\nimport { DidCommCredentialState } from '../../modules/credentials/models/DidCommCredentialState'\nimport { DidCommCredentialExchangeRepository } from '../../modules/credentials/repository/DidCommCredentialExchangeRepository'\nimport { DidCommMessageRecord, DidCommMessageRepository, DidCommMessageRole } from '../../repository'\n\n/*\n Migrates the {@link CredentialRecord} to 0.2 compatible format. It fetches all records from storage\n * and applies the needed updates to the records. After a record has been transformed, it is updated\n * in storage and the next record will be transformed.\n \n The following transformations are applied:\n * - {@link updateIndyMetadata}\n /\nexport async function migrateCredentialRecordToV0_2<Agent extends BaseAgent>(agent: Agent) {\n agent.config.logger.info('Migrating credential records to storage version 0.2')\n const credentialRepository = agent.dependencyManager.resolve(DidCommCredentialExchangeRepository)\n\n agent.config.logger.debug('Fetching all credential records from storage')\n const allCredentials = await credentialRepository.getAll(agent.context)\n\n agent.config.logger.debug(`Found a total of ${allCredentials.length} credential records to update.`)\n for (const credentialRecord of allCredentials) {\n agent.config.logger.debug(`Migrating credential record with id ${credentialRecord.id} to storage version 0.2`)\n\n await updateIndyMetadata(agent, credentialRecord)\n await migrateInternalCredentialRecordProperties(agent, credentialRecord)\n await moveDidCommMessages(agent, credentialRecord)\n\n await credentialRepository.update(agent.context, credentialRecord)\n\n agent.config.logger.debug(\n `Successfully migrated credential record with id ${credentialRecord.id} to storage version 0.2`\n )\n }\n}\n\nexport enum V01_02MigrationCredentialRole {\n Issuer = 0,\n Holder = 1,\n}\n\nconst holderCredentialStates = [\n DidCommCredentialState.Declined,\n DidCommCredentialState.ProposalSent,\n DidCommCredentialState.OfferReceived,\n DidCommCredentialState.RequestSent,\n DidCommCredentialState.CredentialReceived,\n]\n\nconst didCommMessageRoleMapping = {\n [V01_02MigrationCredentialRole.Issuer]: {\n proposalMessage: DidCommMessageRole.Receiver,\n offerMessage: DidCommMessageRole.Sender,\n requestMessage: DidCommMessageRole.Receiver,\n credentialMessage: DidCommMessageRole.Sender,\n },\n [V01_02MigrationCredentialRole.Holder]: {\n proposalMessage: DidCommMessageRole.Sender,\n offerMessage: DidCommMessageRole.Receiver,\n requestMessage: DidCommMessageRole.Sender,\n credentialMessage: DidCommMessageRole.Receiver,\n },\n}\n\nconst credentialRecordMessageKeys = ['proposalMessage', 'offerMessage', 'requestMessage', 'credentialMessage'] as const\n\nexport function getCredentialRole(credentialRecord: DidCommCredentialExchangeRecord) {\n // Credentials will only have a value when a credential is received, meaning we're the holder\n if (credentialRecord.credentials.length > 0) {\n return V01_02MigrationCredentialRole.Holder\n }\n // If credentialRecord.credentials doesn't have any values, and we're also not in state done it means we're the issuer.\n if (credentialRecord.state === DidCommCredentialState.Done) {\n return V01_02MigrationCredentialRole.Issuer\n }\n // For these states we know for certain that we're the holder\n if (holderCredentialStates.includes(credentialRecord.state)) {\n return V01_02MigrationCredentialRole.Holder\n }\n\n // For all other states we can be certain we're the issuer\n return V01_02MigrationCredentialRole.Issuer\n}\n\n/\n The credential record had a custom `metadata` property in pre-0.1.0 storage that contained the `requestMetadata`, `schemaId` and `credentialDefinition`\n * properties. Later a generic metadata API was added that only allows objects to be stored. Therefore the properties were moved into a different structure.\n \n This migration method updates the top level properties to the new nested metadata structure.\n \n The following pre-0.1.0 structure:\n \n ```json\n * {\n * \"requestMetadata\": \"<value of requestMetadata>\",\n * \"schemaId\": \"<value of schemaId>\",\n * \"credentialDefinitionId\": \"<value of credential definition id>\"\n * }\n * ```\n \n Will be transformed into the following 0.2.0 structure:\n \n ```json\n * {\n * \"_internal/indyRequest\": <value of requestMetadata>,\n * \"_internal/indyCredential\": {\n * \"schemaId\": \"<value of schemaId>\",\n * \"credentialDefinitionId\": \"<value of credential definition id>\"\n * }\n * }\n * ```\n /\nexport async function updateIndyMetadata<Agent extends BaseAgent>(\n agent: Agent,\n credentialRecord: DidCommCredentialExchangeRecord\n) {\n agent.config.logger.debug('Updating indy metadata to use the generic metadata api available to records.')\n\n const { requestMetadata, schemaId, credentialDefinitionId, ...rest } = credentialRecord.metadata.data\n const metadata = new Metadata<Record<string, unknown>>(rest)\n\n const indyRequestMetadataKey = '_internal/indyRequest'\n const indyCredentialMetadataKey = '_internal/indyCredential'\n if (requestMetadata) {\n agent.config.logger.trace(`Found top-level 'requestMetadata' key, moving to '${indyRequestMetadataKey}'`)\n metadata.add(indyRequestMetadataKey, { ...requestMetadata })\n }\n\n if (schemaId && typeof schemaId === 'string') {\n agent.config.logger.trace(`Found top-level 'schemaId' key, moving to '${indyCredentialMetadataKey}.schemaId'`)\n metadata.add(indyCredentialMetadataKey, { schemaId })\n }\n\n if (credentialDefinitionId && typeof credentialDefinitionId === 'string') {\n agent.config.logger.trace(\n `Found top-level 'credentialDefinitionId' key, moving to '${indyCredentialMetadataKey}.credentialDefinitionId'`\n )\n metadata.add(indyCredentialMetadataKey, { credentialDefinitionId })\n }\n\n credentialRecord.metadata = metadata\n}\n\n/\n With the addition of support for different protocol versions the credential record now stores the protocol version.\n * With the addition of issue credential v2 support, other credential formats than indy can be used, and multiple credentials can be issued at once. To\n * account for this the `credentialId` has been replaced by the `credentials` array. This is an array of objects containing the `credentialRecordId` and\n * the `credentialRecordType`. For all current credentials the `credentialRecordType` will always be `indy`.\n \n The following 0.1.0 credential record structure (unrelated keys omitted):\n \n ```json\n * {\n * \"credentialId\": \"09e46da9-a575-4909-b016-040e96c3c539\"\n * }\n * ```\n \n Will be transformed into the following 0.2.0 structure (unrelated keys omitted):\n \n ```json\n * {\n * \"protocolVersion: \"v1\",\n * \"credentials\": [\n * {\n * \"credentialRecordId\": \"09e46da9-a575-4909-b016-040e96c3c539\",\n * \"credentialRecordType\": \"anoncreds\"\n * }\n * ]\n * }\n * ```\n /\nexport async function migrateInternalCredentialRecordProperties<Agent extends BaseAgent>(\n agent: Agent,\n credentialRecord: DidCommCredentialExchangeRecord\n) {\n agent.config.logger.debug(\n `Migrating internal credential record ${credentialRecord.id} properties to storage version 0.2`\n )\n\n if (!credentialRecord.protocolVersion) {\n agent.config.logger.debug('Setting protocolVersion to v1')\n credentialRecord.protocolVersion = 'v1'\n }\n\n const untypedCredentialRecord = credentialRecord as unknown as JsonObject\n\n if (untypedCredentialRecord.credentialId) {\n agent.config.logger.debug(`Migrating indy credentialId ${untypedCredentialRecord.id} to credentials array`)\n credentialRecord.credentials = [\n {\n credentialRecordId: untypedCredentialRecord.credentialId as string,\n credentialRecordType: 'indy',\n },\n ]\n\n // biome-ignore lint/performance/noDelete: <explanation>\n delete untypedCredentialRecord.credentialId\n }\n\n agent.config.logger.debug(\n `Successfully migrated internal credential record ${credentialRecord.id} properties to storage version 0.2`\n )\n}\n\n/\n In 0.2.0 the v1 didcomm messages have been moved out of the credential record into separate record using the DidCommMessageRepository.\n * This migration scripts extracts all message (proposalMessage, offerMessage, requestMessage, credentialMessage) and moves\n * them into the DidCommMessageRepository.\n */\nexport async function moveDidCommMessages<Agent extends BaseAgent>(\n agent: Agent,\n credentialRecord: DidCommCredentialExchangeRecord\n) {\n agent.config.logger.debug(\n `Moving didcomm messages from credential record with id ${credentialRecord.id} to DidCommMessageRecord`\n )\n const didCommMessageRepository = agent.dependencyManager.resolve(DidCommMessageRepository)\n\n for (const messageKey of credentialRecordMessageKeys) {\n agent.config.logger.debug(\n `Starting move of ${messageKey} from credential record with id ${credentialRecord.id} to DIDCommMessageRecord`\n )\n const credentialRecordJson = credentialRecord as unknown as JsonObject\n const message = credentialRecordJson[messageKey] as DidCommPlaintextMessage \| undefined\n\n if (message) {\n const credentialRole = getCredentialRole(credentialRecord)\n const didCommMessageRole = didCommMessageRoleMapping[credentialRole][messageKey]\n\n const didCommMessageRecord = new DidCommMessageRecord({\n role: didCommMessageRole,\n associatedRecordId: credentialRecord.id,\n message,\n })\n await didCommMessageRepository.save(agent.context, didCommMessageRecord)\n\n agent.config.logger.debug(\n `Successfully moved ${messageKey} from credential record with id ${credentialRecord.id} to DIDCommMessageRecord`\n )\n\n delete credentialRecordJson[messageKey]\n } else {\n agent.config.logger.debug(\n `Credential record with id ${credentialRecord.id} does not have a ${messageKey}. Not creating a DIDCommMessageRecord`\n )\n }\n }\n\n agent.config.logger.debug(\n `Successfully moved didcomm messages from credential record with id ${credentialRecord.id} to DIDCommMessageRecord`\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAkBA,eAAsB,8BAAuD,OAAc;AACzF,OAAM,OAAO,OAAO,KAAK,sDAAsD;CAC/E,MAAM,uBAAuB,MAAM,kBAAkB,QAAQ,oCAAoC;AAEjG,OAAM,OAAO,OAAO,MAAM,+CAA+C;CACzE,MAAM,iBAAiB,MAAM,qBAAqB,OAAO,MAAM,QAAQ;AAEvE,OAAM,OAAO,OAAO,MAAM,oBAAoB,eAAe,OAAO,gCAAgC;AACpG,MAAK,MAAM,oBAAoB,gBAAgB;AAC7C,QAAM,OAAO,OAAO,MAAM,uCAAuC,iBAAiB,GAAG,yBAAyB;AAE9G,QAAM,mBAAmB,OAAO,iBAAiB;AACjD,QAAM,0CAA0C,OAAO,iBAAiB;AACxE,QAAM,oBAAoB,OAAO,iBAAiB;AAElD,QAAM,qBAAqB,OAAO,MAAM,SAAS,iBAAiB;AAElE,QAAM,OAAO,OAAO,MAClB,mDAAmD,iBAAiB,GAAG,yBACxE;;;AAIL,IAAY,0FAAL;AACL;AACA;;;AAGF,MAAM,yBAAyB;CAC7B,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACxB;AAED,MAAM,4BAA4B;EAC/B,8BAA8B,SAAS;EACtC,iBAAiB,mBAAmB;EACpC,cAAc,mBAAmB;EACjC,gBAAgB,mBAAmB;EACnC,mBAAmB,mBAAmB;EACvC;EACA,8BAA8B,SAAS;EACtC,iBAAiB,mBAAmB;EACpC,cAAc,mBAAmB;EACjC,gBAAgB,mBAAmB;EACnC,mBAAmB,mBAAmB;EACvC;CACF;AAED,MAAM,8BAA8B;CAAC;CAAmB;CAAgB;CAAkB;CAAoB;AAE9G,SAAgB,kBAAkB,kBAAmD;AAEnF,KAAI,iBAAiB,YAAY,SAAS,EACxC,QAAO,8BAA8B;AAGvC,KAAI,iBAAiB,UAAU,uBAAuB,KACpD,QAAO,8BAA8B;AAGvC,KAAI,uBAAuB,SAAS,iBAAiB,MAAM,CACzD,QAAO,8BAA8B;AAIvC,QAAO,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BvC,eAAsB,mBACpB,OACA,kBACA;AACA,OAAM,OAAO,OAAO,MAAM,+EAA+E;CAEzG,MAAM,EAAE,iBAAiB,UAAU,uBAAwB,GAAG,SAAS,iBAAiB,SAAS;CACjG,MAAM,WAAW,IAAI,SAAkC,KAAK;CAE5D,MAAM,yBAAyB;CAC/B,MAAM,4BAA4B;AAClC,KAAI,iBAAiB;AACnB,QAAM,OAAO,OAAO,MAAM,qDAAqD,uBAAuB,GAAG;AACzG,WAAS,IAAI,wBAAwB,EAAE,GAAG,iBAAiB,CAAC;;AAG9D,KAAI,YAAY,OAAO,aAAa,UAAU;AAC5C,QAAM,OAAO,OAAO,MAAM,8CAA8C,0BAA0B,YAAY;AAC9G,WAAS,IAAI,2BAA2B,EAAE,UAAU,CAAC;;AAGvD,KAAI,0BAA0B,OAAO,2BAA2B,UAAU;AACxE,QAAM,OAAO,OAAO,MAClB,4DAA4D,0BAA0B,0BACvF;AACD,WAAS,IAAI,2BAA2B,EAAE,wBAAwB,CAAC;;AAGrE,kBAAiB,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+B9B,eAAsB,0CACpB,OACA,kBACA;AACA,OAAM,OAAO,OAAO,MAClB,wCAAwC,iBAAiB,GAAG,oCAC7D;AAED,KAAI,CAAC,iBAAiB,iBAAiB;AACrC,QAAM,OAAO,OAAO,MAAM,gCAAgC;AAC1D,mBAAiB,kBAAkB;;CAGrC,MAAM,0BAA0B;AAEhC,KAAI,wBAAwB,cAAc;AACxC,QAAM,OAAO,OAAO,MAAM,+BAA+B,wBAAwB,GAAG,uBAAuB;AAC3G,mBAAiB,cAAc,CAC7B;GACE,oBAAoB,wBAAwB;GAC5C,sBAAsB;GACvB,CACF;AAGD,SAAO,wBAAwB;;AAGjC,OAAM,OAAO,OAAO,MAClB,oDAAoD,iBAAiB,GAAG,oCACzE;;;;;;;AAQH,eAAsB,oBACpB,OACA,kBACA;AACA,OAAM,OAAO,OAAO,MAClB,0DAA0D,iBAAiB,GAAG,0BAC/E;CACD,MAAM,2BAA2B,MAAM,kBAAkB,QAAQ,yBAAyB;AAE1F,MAAK,MAAM,cAAc,6BAA6B;AACpD,QAAM,OAAO,OAAO,MAClB,oBAAoB,WAAW,kCAAkC,iBAAiB,GAAG,0BACtF;EACD,MAAM,uBAAuB;EAC7B,MAAM,UAAU,qBAAqB;AAErC,MAAI,SAAS;GAEX,MAAM,qBAAqB,0BADJ,kBAAkB,iBAAiB,EACW;GAErE,MAAM,uBAAuB,IAAI,qBAAqB;IACpD,MAAM;IACN,oBAAoB,iBAAiB;IACrC;IACD,CAAC;AACF,SAAM,yBAAyB,KAAK,MAAM,SAAS,qBAAqB;AAExE,SAAM,OAAO,OAAO,MAClB,sBAAsB,WAAW,kCAAkC,iBAAiB,GAAG,0BACxF;AAED,UAAO,qBAAqB;QAE5B,OAAM,OAAO,OAAO,MAClB,6BAA6B,iBAAiB,GAAG,mBAAmB,WAAW,uCAChF;;AAIL,OAAM,OAAO,OAAO,MAClB,sEAAsE,iBAAiB,GAAG,0BAC3F"}
1	+ {"version":3,"file":"credential.mjs","names":[],"sources":["../../../src/updates/0.1-0.2/credential.ts"],"sourcesContent":["import type { BaseAgent, JsonObject } from '@credo-ts/core'\nimport { Metadata } from '@credo-ts/core'\nimport type { DidCommCredentialExchangeRecord } from '../../modules/credentials'\nimport { DidCommCredentialState } from '../../modules/credentials/models/DidCommCredentialState'\nimport { DidCommCredentialExchangeRepository } from '../../modules/credentials/repository/DidCommCredentialExchangeRepository'\nimport { DidCommMessageRecord, DidCommMessageRepository, DidCommMessageRole } from '../../repository'\nimport type { DidCommPlaintextMessage } from '../../types'\n\n/*\n Migrates the {@link CredentialRecord} to 0.2 compatible format. It fetches all records from storage\n * and applies the needed updates to the records. After a record has been transformed, it is updated\n * in storage and the next record will be transformed.\n \n The following transformations are applied:\n * - {@link updateIndyMetadata}\n /\nexport async function migrateCredentialRecordToV0_2<Agent extends BaseAgent>(agent: Agent) {\n agent.config.logger.info('Migrating credential records to storage version 0.2')\n const credentialRepository = agent.dependencyManager.resolve(DidCommCredentialExchangeRepository)\n\n agent.config.logger.debug('Fetching all credential records from storage')\n const allCredentials = await credentialRepository.getAll(agent.context)\n\n agent.config.logger.debug(`Found a total of ${allCredentials.length} credential records to update.`)\n for (const credentialRecord of allCredentials) {\n agent.config.logger.debug(`Migrating credential record with id ${credentialRecord.id} to storage version 0.2`)\n\n await updateIndyMetadata(agent, credentialRecord)\n await migrateInternalCredentialRecordProperties(agent, credentialRecord)\n await moveDidCommMessages(agent, credentialRecord)\n\n await credentialRepository.update(agent.context, credentialRecord)\n\n agent.config.logger.debug(\n `Successfully migrated credential record with id ${credentialRecord.id} to storage version 0.2`\n )\n }\n}\n\nexport enum V01_02MigrationCredentialRole {\n Issuer = 0,\n Holder = 1,\n}\n\nconst holderCredentialStates = [\n DidCommCredentialState.Declined,\n DidCommCredentialState.ProposalSent,\n DidCommCredentialState.OfferReceived,\n DidCommCredentialState.RequestSent,\n DidCommCredentialState.CredentialReceived,\n]\n\nconst didCommMessageRoleMapping = {\n [V01_02MigrationCredentialRole.Issuer]: {\n proposalMessage: DidCommMessageRole.Receiver,\n offerMessage: DidCommMessageRole.Sender,\n requestMessage: DidCommMessageRole.Receiver,\n credentialMessage: DidCommMessageRole.Sender,\n },\n [V01_02MigrationCredentialRole.Holder]: {\n proposalMessage: DidCommMessageRole.Sender,\n offerMessage: DidCommMessageRole.Receiver,\n requestMessage: DidCommMessageRole.Sender,\n credentialMessage: DidCommMessageRole.Receiver,\n },\n}\n\nconst credentialRecordMessageKeys = ['proposalMessage', 'offerMessage', 'requestMessage', 'credentialMessage'] as const\n\nexport function getCredentialRole(credentialRecord: DidCommCredentialExchangeRecord) {\n // Credentials will only have a value when a credential is received, meaning we're the holder\n if (credentialRecord.credentials.length > 0) {\n return V01_02MigrationCredentialRole.Holder\n }\n // If credentialRecord.credentials doesn't have any values, and we're also not in state done it means we're the issuer.\n if (credentialRecord.state === DidCommCredentialState.Done) {\n return V01_02MigrationCredentialRole.Issuer\n }\n // For these states we know for certain that we're the holder\n if (holderCredentialStates.includes(credentialRecord.state)) {\n return V01_02MigrationCredentialRole.Holder\n }\n\n // For all other states we can be certain we're the issuer\n return V01_02MigrationCredentialRole.Issuer\n}\n\n/\n The credential record had a custom `metadata` property in pre-0.1.0 storage that contained the `requestMetadata`, `schemaId` and `credentialDefinition`\n * properties. Later a generic metadata API was added that only allows objects to be stored. Therefore the properties were moved into a different structure.\n \n This migration method updates the top level properties to the new nested metadata structure.\n \n The following pre-0.1.0 structure:\n \n ```json\n * {\n * \"requestMetadata\": \"<value of requestMetadata>\",\n * \"schemaId\": \"<value of schemaId>\",\n * \"credentialDefinitionId\": \"<value of credential definition id>\"\n * }\n * ```\n \n Will be transformed into the following 0.2.0 structure:\n \n ```json\n * {\n * \"_internal/indyRequest\": <value of requestMetadata>,\n * \"_internal/indyCredential\": {\n * \"schemaId\": \"<value of schemaId>\",\n * \"credentialDefinitionId\": \"<value of credential definition id>\"\n * }\n * }\n * ```\n /\nexport async function updateIndyMetadata<Agent extends BaseAgent>(\n agent: Agent,\n credentialRecord: DidCommCredentialExchangeRecord\n) {\n agent.config.logger.debug('Updating indy metadata to use the generic metadata api available to records.')\n\n const { requestMetadata, schemaId, credentialDefinitionId, ...rest } = credentialRecord.metadata.data\n const metadata = new Metadata<Record<string, unknown>>(rest)\n\n const indyRequestMetadataKey = '_internal/indyRequest'\n const indyCredentialMetadataKey = '_internal/indyCredential'\n if (requestMetadata) {\n agent.config.logger.trace(`Found top-level 'requestMetadata' key, moving to '${indyRequestMetadataKey}'`)\n metadata.add(indyRequestMetadataKey, { ...requestMetadata })\n }\n\n if (schemaId && typeof schemaId === 'string') {\n agent.config.logger.trace(`Found top-level 'schemaId' key, moving to '${indyCredentialMetadataKey}.schemaId'`)\n metadata.add(indyCredentialMetadataKey, { schemaId })\n }\n\n if (credentialDefinitionId && typeof credentialDefinitionId === 'string') {\n agent.config.logger.trace(\n `Found top-level 'credentialDefinitionId' key, moving to '${indyCredentialMetadataKey}.credentialDefinitionId'`\n )\n metadata.add(indyCredentialMetadataKey, { credentialDefinitionId })\n }\n\n credentialRecord.metadata = metadata\n}\n\n/\n With the addition of support for different protocol versions the credential record now stores the protocol version.\n * With the addition of issue credential v2 support, other credential formats than indy can be used, and multiple credentials can be issued at once. To\n * account for this the `credentialId` has been replaced by the `credentials` array. This is an array of objects containing the `credentialRecordId` and\n * the `credentialRecordType`. For all current credentials the `credentialRecordType` will always be `indy`.\n \n The following 0.1.0 credential record structure (unrelated keys omitted):\n \n ```json\n * {\n * \"credentialId\": \"09e46da9-a575-4909-b016-040e96c3c539\"\n * }\n * ```\n \n Will be transformed into the following 0.2.0 structure (unrelated keys omitted):\n \n ```json\n * {\n * \"protocolVersion: \"v1\",\n * \"credentials\": [\n * {\n * \"credentialRecordId\": \"09e46da9-a575-4909-b016-040e96c3c539\",\n * \"credentialRecordType\": \"anoncreds\"\n * }\n * ]\n * }\n * ```\n /\nexport async function migrateInternalCredentialRecordProperties<Agent extends BaseAgent>(\n agent: Agent,\n credentialRecord: DidCommCredentialExchangeRecord\n) {\n agent.config.logger.debug(\n `Migrating internal credential record ${credentialRecord.id} properties to storage version 0.2`\n )\n\n if (!credentialRecord.protocolVersion) {\n agent.config.logger.debug('Setting protocolVersion to v1')\n credentialRecord.protocolVersion = 'v1'\n }\n\n const untypedCredentialRecord = credentialRecord as unknown as JsonObject\n\n if (untypedCredentialRecord.credentialId) {\n agent.config.logger.debug(`Migrating indy credentialId ${untypedCredentialRecord.id} to credentials array`)\n credentialRecord.credentials = [\n {\n credentialRecordId: untypedCredentialRecord.credentialId as string,\n credentialRecordType: 'indy',\n },\n ]\n\n // biome-ignore lint/performance/noDelete: no explanation\n delete untypedCredentialRecord.credentialId\n }\n\n agent.config.logger.debug(\n `Successfully migrated internal credential record ${credentialRecord.id} properties to storage version 0.2`\n )\n}\n\n/\n In 0.2.0 the v1 didcomm messages have been moved out of the credential record into separate record using the DidCommMessageRepository.\n * This migration scripts extracts all message (proposalMessage, offerMessage, requestMessage, credentialMessage) and moves\n * them into the DidCommMessageRepository.\n */\nexport async function moveDidCommMessages<Agent extends BaseAgent>(\n agent: Agent,\n credentialRecord: DidCommCredentialExchangeRecord\n) {\n agent.config.logger.debug(\n `Moving didcomm messages from credential record with id ${credentialRecord.id} to DidCommMessageRecord`\n )\n const didCommMessageRepository = agent.dependencyManager.resolve(DidCommMessageRepository)\n\n for (const messageKey of credentialRecordMessageKeys) {\n agent.config.logger.debug(\n `Starting move of ${messageKey} from credential record with id ${credentialRecord.id} to DIDCommMessageRecord`\n )\n const credentialRecordJson = credentialRecord as unknown as JsonObject\n const message = credentialRecordJson[messageKey] as DidCommPlaintextMessage \| undefined\n\n if (message) {\n const credentialRole = getCredentialRole(credentialRecord)\n const didCommMessageRole = didCommMessageRoleMapping[credentialRole][messageKey]\n\n const didCommMessageRecord = new DidCommMessageRecord({\n role: didCommMessageRole,\n associatedRecordId: credentialRecord.id,\n message,\n })\n await didCommMessageRepository.save(agent.context, didCommMessageRecord)\n\n agent.config.logger.debug(\n `Successfully moved ${messageKey} from credential record with id ${credentialRecord.id} to DIDCommMessageRecord`\n )\n\n delete credentialRecordJson[messageKey]\n } else {\n agent.config.logger.debug(\n `Credential record with id ${credentialRecord.id} does not have a ${messageKey}. Not creating a DIDCommMessageRecord`\n )\n }\n }\n\n agent.config.logger.debug(\n `Successfully moved didcomm messages from credential record with id ${credentialRecord.id} to DIDCommMessageRecord`\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAgBA,eAAsB,8BAAuD,OAAc;AACzF,OAAM,OAAO,OAAO,KAAK,sDAAsD;CAC/E,MAAM,uBAAuB,MAAM,kBAAkB,QAAQ,oCAAoC;AAEjG,OAAM,OAAO,OAAO,MAAM,+CAA+C;CACzE,MAAM,iBAAiB,MAAM,qBAAqB,OAAO,MAAM,QAAQ;AAEvE,OAAM,OAAO,OAAO,MAAM,oBAAoB,eAAe,OAAO,gCAAgC;AACpG,MAAK,MAAM,oBAAoB,gBAAgB;AAC7C,QAAM,OAAO,OAAO,MAAM,uCAAuC,iBAAiB,GAAG,yBAAyB;AAE9G,QAAM,mBAAmB,OAAO,iBAAiB;AACjD,QAAM,0CAA0C,OAAO,iBAAiB;AACxE,QAAM,oBAAoB,OAAO,iBAAiB;AAElD,QAAM,qBAAqB,OAAO,MAAM,SAAS,iBAAiB;AAElE,QAAM,OAAO,OAAO,MAClB,mDAAmD,iBAAiB,GAAG,yBACxE;;;AAIL,IAAY,0FAAL;AACL;AACA;;;AAGF,MAAM,yBAAyB;CAC7B,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACxB;AAED,MAAM,4BAA4B;EAC/B,8BAA8B,SAAS;EACtC,iBAAiB,mBAAmB;EACpC,cAAc,mBAAmB;EACjC,gBAAgB,mBAAmB;EACnC,mBAAmB,mBAAmB;EACvC;EACA,8BAA8B,SAAS;EACtC,iBAAiB,mBAAmB;EACpC,cAAc,mBAAmB;EACjC,gBAAgB,mBAAmB;EACnC,mBAAmB,mBAAmB;EACvC;CACF;AAED,MAAM,8BAA8B;CAAC;CAAmB;CAAgB;CAAkB;CAAoB;AAE9G,SAAgB,kBAAkB,kBAAmD;AAEnF,KAAI,iBAAiB,YAAY,SAAS,EACxC,QAAO,8BAA8B;AAGvC,KAAI,iBAAiB,UAAU,uBAAuB,KACpD,QAAO,8BAA8B;AAGvC,KAAI,uBAAuB,SAAS,iBAAiB,MAAM,CACzD,QAAO,8BAA8B;AAIvC,QAAO,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BvC,eAAsB,mBACpB,OACA,kBACA;AACA,OAAM,OAAO,OAAO,MAAM,+EAA+E;CAEzG,MAAM,EAAE,iBAAiB,UAAU,uBAAwB,GAAG,SAAS,iBAAiB,SAAS;CACjG,MAAM,WAAW,IAAI,SAAkC,KAAK;CAE5D,MAAM,yBAAyB;CAC/B,MAAM,4BAA4B;AAClC,KAAI,iBAAiB;AACnB,QAAM,OAAO,OAAO,MAAM,qDAAqD,uBAAuB,GAAG;AACzG,WAAS,IAAI,wBAAwB,EAAE,GAAG,iBAAiB,CAAC;;AAG9D,KAAI,YAAY,OAAO,aAAa,UAAU;AAC5C,QAAM,OAAO,OAAO,MAAM,8CAA8C,0BAA0B,YAAY;AAC9G,WAAS,IAAI,2BAA2B,EAAE,UAAU,CAAC;;AAGvD,KAAI,0BAA0B,OAAO,2BAA2B,UAAU;AACxE,QAAM,OAAO,OAAO,MAClB,4DAA4D,0BAA0B,0BACvF;AACD,WAAS,IAAI,2BAA2B,EAAE,wBAAwB,CAAC;;AAGrE,kBAAiB,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+B9B,eAAsB,0CACpB,OACA,kBACA;AACA,OAAM,OAAO,OAAO,MAClB,wCAAwC,iBAAiB,GAAG,oCAC7D;AAED,KAAI,CAAC,iBAAiB,iBAAiB;AACrC,QAAM,OAAO,OAAO,MAAM,gCAAgC;AAC1D,mBAAiB,kBAAkB;;CAGrC,MAAM,0BAA0B;AAEhC,KAAI,wBAAwB,cAAc;AACxC,QAAM,OAAO,OAAO,MAAM,+BAA+B,wBAAwB,GAAG,uBAAuB;AAC3G,mBAAiB,cAAc,CAC7B;GACE,oBAAoB,wBAAwB;GAC5C,sBAAsB;GACvB,CACF;AAGD,SAAO,wBAAwB;;AAGjC,OAAM,OAAO,OAAO,MAClB,oDAAoD,iBAAiB,GAAG,oCACzE;;;;;;;AAQH,eAAsB,oBACpB,OACA,kBACA;AACA,OAAM,OAAO,OAAO,MAClB,0DAA0D,iBAAiB,GAAG,0BAC/E;CACD,MAAM,2BAA2B,MAAM,kBAAkB,QAAQ,yBAAyB;AAE1F,MAAK,MAAM,cAAc,6BAA6B;AACpD,QAAM,OAAO,OAAO,MAClB,oBAAoB,WAAW,kCAAkC,iBAAiB,GAAG,0BACtF;EACD,MAAM,uBAAuB;EAC7B,MAAM,UAAU,qBAAqB;AAErC,MAAI,SAAS;GAEX,MAAM,qBAAqB,0BADJ,kBAAkB,iBAAiB,EACW;GAErE,MAAM,uBAAuB,IAAI,qBAAqB;IACpD,MAAM;IACN,oBAAoB,iBAAiB;IACrC;IACD,CAAC;AACF,SAAM,yBAAyB,KAAK,MAAM,SAAS,qBAAqB;AAExE,SAAM,OAAO,OAAO,MAClB,sBAAsB,WAAW,kCAAkC,iBAAiB,GAAG,0BACxF;AAED,UAAO,qBAAqB;QAE5B,OAAM,OAAO,OAAO,MAClB,6BAA6B,iBAAiB,GAAG,mBAAmB,WAAW,uCAChF;;AAIL,OAAM,OAAO,OAAO,MAClB,sEAAsE,iBAAiB,GAAG,0BAC3F"}

package/build/updates/0.2-0.3/proof.js CHANGED Viewed

@@ -1,6 +1,6 @@
 const require_DidCommMessageRecord = require('../../repository/DidCommMessageRecord.js');
-const require_DidCommMessageRole = require('../../repository/DidCommMessageRole.js');
 const require_DidCommMessageRepository = require('../../repository/DidCommMessageRepository.js');
+const require_DidCommMessageRole = require('../../repository/DidCommMessageRole.js');
 require('../../repository/index.js');
 const require_DidCommProofState = require('../../modules/proofs/models/DidCommProofState.js');
 const require_DidCommProofExchangeRepository = require('../../modules/proofs/repository/DidCommProofExchangeRepository.js');

package/build/updates/0.2-0.3/proof.mjs CHANGED Viewed

@@ -1,6 +1,6 @@
 import { DidCommMessageRecord } from "../../repository/DidCommMessageRecord.mjs";
-import { DidCommMessageRole } from "../../repository/DidCommMessageRole.mjs";
 import { DidCommMessageRepository } from "../../repository/DidCommMessageRepository.mjs";
+import { DidCommMessageRole } from "../../repository/DidCommMessageRole.mjs";
 import "../../repository/index.mjs";
 import { DidCommProofState } from "../../modules/proofs/models/DidCommProofState.mjs";
 import { DidCommProofExchangeRepository } from "../../modules/proofs/repository/DidCommProofExchangeRepository.mjs";

package/build/updates/0.2-0.3/proof.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"proof.mjs","names":[],"sources":["../../../src/updates/0.2-0.3/proof.ts"],"sourcesContent":["import type { BaseAgent, JsonObject } from '@credo-ts/core'\nimport ~~type~~ { ~~DidCommPlaintextMessage } from '../../types'~~\n~~\nimport {\n~~ type DidCommProofExchangeRecord,\n DidCommProofExchangeRepository,\n DidCommProofState,\n} from '../../modules/proofs'\nimport { DidCommMessageRecord, DidCommMessageRepository, DidCommMessageRole } from '../../repository'\n\n/*\n Migrates the {@link DidCommProofExchangeRecord} to 0.3 compatible format. It fetches all records from storage\n * and applies the needed updates to the records. After a record has been transformed, it is updated\n * in storage and the next record will be transformed.\n \n The following transformations are applied:\n * - {@link migrateInternalProofExchangeRecordProperties}\n * - {@link moveDidCommMessages}\n /\nexport async function migrateProofExchangeRecordToV0_3<Agent extends BaseAgent>(agent: Agent) {\n agent.config.logger.info('Migrating proof records to storage version 0.3')\n const proofRepository = agent.dependencyManager.resolve(DidCommProofExchangeRepository)\n\n agent.config.logger.debug('Fetching all proof records from storage')\n const allProofs = await proofRepository.getAll(agent.context)\n\n agent.config.logger.debug(`Found a total of ${allProofs.length} proof records to update.`)\n for (const proofRecord of allProofs) {\n agent.config.logger.debug(`Migrating proof record with id ${proofRecord.id} to storage version 0.3`)\n\n await migrateInternalProofExchangeRecordProperties(agent, proofRecord)\n await moveDidCommMessages(agent, proofRecord)\n\n await proofRepository.update(agent.context, proofRecord)\n\n agent.config.logger.debug(`Successfully migrated proof record with id ${proofRecord.id} to storage version 0.3`)\n }\n}\n\nexport enum V02_03MigrationProofRole {\n Verifier = 0,\n Prover = 1,\n}\n\nconst proverProofStates = [\n DidCommProofState.Declined,\n DidCommProofState.ProposalSent,\n DidCommProofState.RequestReceived,\n DidCommProofState.PresentationSent,\n DidCommProofState.Done,\n]\n\nconst didCommMessageRoleMapping = {\n [V02_03MigrationProofRole.Verifier]: {\n proposalMessage: DidCommMessageRole.Receiver,\n requestMessage: DidCommMessageRole.Sender,\n presentationMessage: DidCommMessageRole.Receiver,\n },\n [V02_03MigrationProofRole.Prover]: {\n proposalMessage: DidCommMessageRole.Sender,\n requestMessage: DidCommMessageRole.Receiver,\n presentationMessage: DidCommMessageRole.Sender,\n },\n}\n\nconst proofRecordMessageKeys = ['proposalMessage', 'requestMessage', 'presentationMessage'] as const\n\nexport function getProofRole(proofRecord: DidCommProofExchangeRecord) {\n // Proofs will only have an isVerified value when a presentation is verified, meaning we're the verifier\n if (proofRecord.isVerified !== undefined) {\n return V02_03MigrationProofRole.Verifier\n }\n // If proofRecord.isVerified doesn't have any value, and we're also not in state done it means we're the prover.\n if (proofRecord.state === DidCommProofState.Done) {\n return V02_03MigrationProofRole.Prover\n }\n // For these states we know for certain that we're the prover\n if (proverProofStates.includes(proofRecord.state)) {\n return V02_03MigrationProofRole.Prover\n }\n\n // For all other states we can be certain we're the verifier\n return V02_03MigrationProofRole.Verifier\n}\n\n/\n With the addition of support for different protocol versions the proof record now stores the protocol version.\n \n The following 0.2.0 proof record structure (unrelated keys omitted):\n \n ```json\n * {\n * }\n * ```\n \n Will be transformed into the following 0.3.0 structure (unrelated keys omitted):\n \n ```json\n * {\n * \"protocolVersion: \"v1\"\n * }\n * ```\n /\nexport async function migrateInternalProofExchangeRecordProperties<Agent extends BaseAgent>(\n agent: Agent,\n proofRecord: DidCommProofExchangeRecord\n) {\n agent.config.logger.debug(`Migrating internal proof record ${proofRecord.id} properties to storage version 0.3`)\n\n if (!proofRecord.protocolVersion) {\n agent.config.logger.debug('Setting protocolVersion to v1')\n proofRecord.protocolVersion = 'v1'\n }\n\n agent.config.logger.debug(\n `Successfully migrated internal proof record ${proofRecord.id} properties to storage version 0.3`\n )\n}\n\n/\n In 0.3.0 the v1 didcomm messages have been moved out of the proof record into separate record using the DidCommMessageRepository.\n * This migration scripts extracts all message (proposalMessage, requestMessage, presentationMessage) and moves\n * them into the DidCommMessageRepository.\n */\nexport async function moveDidCommMessages<Agent extends BaseAgent>(\n agent: Agent,\n proofRecord: DidCommProofExchangeRecord\n) {\n agent.config.logger.debug(\n `Moving didcomm messages from proof record with id ${proofRecord.id} to DidCommMessageRecord`\n )\n const didCommMessageRepository = agent.dependencyManager.resolve(DidCommMessageRepository)\n\n for (const messageKey of proofRecordMessageKeys) {\n agent.config.logger.debug(\n `Starting move of ${messageKey} from proof record with id ${proofRecord.id} to DIDCommMessageRecord`\n )\n const proofRecordJson = proofRecord as unknown as JsonObject\n const message = proofRecordJson[messageKey] as DidCommPlaintextMessage \| undefined\n\n if (message) {\n const proofRole = getProofRole(proofRecord)\n const didCommMessageRole = didCommMessageRoleMapping[proofRole][messageKey]\n\n const didCommMessageRecord = new DidCommMessageRecord({\n role: didCommMessageRole,\n associatedRecordId: proofRecord.id,\n message,\n })\n await didCommMessageRepository.save(agent.context, didCommMessageRecord)\n\n agent.config.logger.debug(\n `Successfully moved ${messageKey} from proof record with id ${proofRecord.id} to DIDCommMessageRecord`\n )\n\n delete proofRecordJson[messageKey]\n } else {\n agent.config.logger.debug(\n `Proof record with id ${proofRecord.id} does not have a ${messageKey}. Not creating a DIDCommMessageRecord`\n )\n }\n }\n\n agent.config.logger.debug(\n `Successfully moved didcomm messages from proof record with id ${proofRecord.id} to DIDCommMessageRecord`\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;~~AAmBA~~,eAAsB,iCAA0D,OAAc;AAC5F,OAAM,OAAO,OAAO,KAAK,iDAAiD;CAC1E,MAAM,kBAAkB,MAAM,kBAAkB,QAAQ,+BAA+B;AAEvF,OAAM,OAAO,OAAO,MAAM,0CAA0C;CACpE,MAAM,YAAY,MAAM,gBAAgB,OAAO,MAAM,QAAQ;AAE7D,OAAM,OAAO,OAAO,MAAM,oBAAoB,UAAU,OAAO,2BAA2B;AAC1F,MAAK,MAAM,eAAe,WAAW;AACnC,QAAM,OAAO,OAAO,MAAM,kCAAkC,YAAY,GAAG,yBAAyB;AAEpG,QAAM,6CAA6C,OAAO,YAAY;AACtE,QAAM,oBAAoB,OAAO,YAAY;AAE7C,QAAM,gBAAgB,OAAO,MAAM,SAAS,YAAY;AAExD,QAAM,OAAO,OAAO,MAAM,8CAA8C,YAAY,GAAG,yBAAyB;;;AAIpH,IAAY,gFAAL;AACL;AACA;;;AAGF,MAAM,oBAAoB;CACxB,kBAAkB;CAClB,kBAAkB;CAClB,kBAAkB;CAClB,kBAAkB;CAClB,kBAAkB;CACnB;AAED,MAAM,4BAA4B;EAC/B,yBAAyB,WAAW;EACnC,iBAAiB,mBAAmB;EACpC,gBAAgB,mBAAmB;EACnC,qBAAqB,mBAAmB;EACzC;EACA,yBAAyB,SAAS;EACjC,iBAAiB,mBAAmB;EACpC,gBAAgB,mBAAmB;EACnC,qBAAqB,mBAAmB;EACzC;CACF;AAED,MAAM,yBAAyB;CAAC;CAAmB;CAAkB;CAAsB;AAE3F,SAAgB,aAAa,aAAyC;AAEpE,KAAI,YAAY,eAAe,OAC7B,QAAO,yBAAyB;AAGlC,KAAI,YAAY,UAAU,kBAAkB,KAC1C,QAAO,yBAAyB;AAGlC,KAAI,kBAAkB,SAAS,YAAY,MAAM,CAC/C,QAAO,yBAAyB;AAIlC,QAAO,yBAAyB;;;;;;;;;;;;;;;;;;;;AAqBlC,eAAsB,6CACpB,OACA,aACA;AACA,OAAM,OAAO,OAAO,MAAM,mCAAmC,YAAY,GAAG,oCAAoC;AAEhH,KAAI,CAAC,YAAY,iBAAiB;AAChC,QAAM,OAAO,OAAO,MAAM,gCAAgC;AAC1D,cAAY,kBAAkB;;AAGhC,OAAM,OAAO,OAAO,MAClB,+CAA+C,YAAY,GAAG,oCAC/D;;;;;;;AAQH,eAAsB,oBACpB,OACA,aACA;AACA,OAAM,OAAO,OAAO,MAClB,qDAAqD,YAAY,GAAG,0BACrE;CACD,MAAM,2BAA2B,MAAM,kBAAkB,QAAQ,yBAAyB;AAE1F,MAAK,MAAM,cAAc,wBAAwB;AAC/C,QAAM,OAAO,OAAO,MAClB,oBAAoB,WAAW,6BAA6B,YAAY,GAAG,0BAC5E;EACD,MAAM,kBAAkB;EACxB,MAAM,UAAU,gBAAgB;AAEhC,MAAI,SAAS;GAEX,MAAM,qBAAqB,0BADT,aAAa,YAAY,EACqB;GAEhE,MAAM,uBAAuB,IAAI,qBAAqB;IACpD,MAAM;IACN,oBAAoB,YAAY;IAChC;IACD,CAAC;AACF,SAAM,yBAAyB,KAAK,MAAM,SAAS,qBAAqB;AAExE,SAAM,OAAO,OAAO,MAClB,sBAAsB,WAAW,6BAA6B,YAAY,GAAG,0BAC9E;AAED,UAAO,gBAAgB;QAEvB,OAAM,OAAO,OAAO,MAClB,wBAAwB,YAAY,GAAG,mBAAmB,WAAW,uCACtE;;AAIL,OAAM,OAAO,OAAO,MAClB,iEAAiE,YAAY,GAAG,0BACjF"}
1	+ {"version":3,"file":"proof.mjs","names":[],"sources":["../../../src/updates/0.2-0.3/proof.ts"],"sourcesContent":["import type { BaseAgent, JsonObject } from '@credo-ts/core'\nimport {\n type DidCommProofExchangeRecord,\n DidCommProofExchangeRepository,\n DidCommProofState,\n} from '../../modules/proofs'\nimport { DidCommMessageRecord, DidCommMessageRepository, DidCommMessageRole } from '../../repository'\nimport type { DidCommPlaintextMessage } from '../../types'\n\n/*\n Migrates the {@link DidCommProofExchangeRecord} to 0.3 compatible format. It fetches all records from storage\n * and applies the needed updates to the records. After a record has been transformed, it is updated\n * in storage and the next record will be transformed.\n \n The following transformations are applied:\n * - {@link migrateInternalProofExchangeRecordProperties}\n * - {@link moveDidCommMessages}\n /\nexport async function migrateProofExchangeRecordToV0_3<Agent extends BaseAgent>(agent: Agent) {\n agent.config.logger.info('Migrating proof records to storage version 0.3')\n const proofRepository = agent.dependencyManager.resolve(DidCommProofExchangeRepository)\n\n agent.config.logger.debug('Fetching all proof records from storage')\n const allProofs = await proofRepository.getAll(agent.context)\n\n agent.config.logger.debug(`Found a total of ${allProofs.length} proof records to update.`)\n for (const proofRecord of allProofs) {\n agent.config.logger.debug(`Migrating proof record with id ${proofRecord.id} to storage version 0.3`)\n\n await migrateInternalProofExchangeRecordProperties(agent, proofRecord)\n await moveDidCommMessages(agent, proofRecord)\n\n await proofRepository.update(agent.context, proofRecord)\n\n agent.config.logger.debug(`Successfully migrated proof record with id ${proofRecord.id} to storage version 0.3`)\n }\n}\n\nexport enum V02_03MigrationProofRole {\n Verifier = 0,\n Prover = 1,\n}\n\nconst proverProofStates = [\n DidCommProofState.Declined,\n DidCommProofState.ProposalSent,\n DidCommProofState.RequestReceived,\n DidCommProofState.PresentationSent,\n DidCommProofState.Done,\n]\n\nconst didCommMessageRoleMapping = {\n [V02_03MigrationProofRole.Verifier]: {\n proposalMessage: DidCommMessageRole.Receiver,\n requestMessage: DidCommMessageRole.Sender,\n presentationMessage: DidCommMessageRole.Receiver,\n },\n [V02_03MigrationProofRole.Prover]: {\n proposalMessage: DidCommMessageRole.Sender,\n requestMessage: DidCommMessageRole.Receiver,\n presentationMessage: DidCommMessageRole.Sender,\n },\n}\n\nconst proofRecordMessageKeys = ['proposalMessage', 'requestMessage', 'presentationMessage'] as const\n\nexport function getProofRole(proofRecord: DidCommProofExchangeRecord) {\n // Proofs will only have an isVerified value when a presentation is verified, meaning we're the verifier\n if (proofRecord.isVerified !== undefined) {\n return V02_03MigrationProofRole.Verifier\n }\n // If proofRecord.isVerified doesn't have any value, and we're also not in state done it means we're the prover.\n if (proofRecord.state === DidCommProofState.Done) {\n return V02_03MigrationProofRole.Prover\n }\n // For these states we know for certain that we're the prover\n if (proverProofStates.includes(proofRecord.state)) {\n return V02_03MigrationProofRole.Prover\n }\n\n // For all other states we can be certain we're the verifier\n return V02_03MigrationProofRole.Verifier\n}\n\n/\n With the addition of support for different protocol versions the proof record now stores the protocol version.\n \n The following 0.2.0 proof record structure (unrelated keys omitted):\n \n ```json\n * {\n * }\n * ```\n \n Will be transformed into the following 0.3.0 structure (unrelated keys omitted):\n \n ```json\n * {\n * \"protocolVersion: \"v1\"\n * }\n * ```\n /\nexport async function migrateInternalProofExchangeRecordProperties<Agent extends BaseAgent>(\n agent: Agent,\n proofRecord: DidCommProofExchangeRecord\n) {\n agent.config.logger.debug(`Migrating internal proof record ${proofRecord.id} properties to storage version 0.3`)\n\n if (!proofRecord.protocolVersion) {\n agent.config.logger.debug('Setting protocolVersion to v1')\n proofRecord.protocolVersion = 'v1'\n }\n\n agent.config.logger.debug(\n `Successfully migrated internal proof record ${proofRecord.id} properties to storage version 0.3`\n )\n}\n\n/\n In 0.3.0 the v1 didcomm messages have been moved out of the proof record into separate record using the DidCommMessageRepository.\n * This migration scripts extracts all message (proposalMessage, requestMessage, presentationMessage) and moves\n * them into the DidCommMessageRepository.\n */\nexport async function moveDidCommMessages<Agent extends BaseAgent>(\n agent: Agent,\n proofRecord: DidCommProofExchangeRecord\n) {\n agent.config.logger.debug(\n `Moving didcomm messages from proof record with id ${proofRecord.id} to DidCommMessageRecord`\n )\n const didCommMessageRepository = agent.dependencyManager.resolve(DidCommMessageRepository)\n\n for (const messageKey of proofRecordMessageKeys) {\n agent.config.logger.debug(\n `Starting move of ${messageKey} from proof record with id ${proofRecord.id} to DIDCommMessageRecord`\n )\n const proofRecordJson = proofRecord as unknown as JsonObject\n const message = proofRecordJson[messageKey] as DidCommPlaintextMessage \| undefined\n\n if (message) {\n const proofRole = getProofRole(proofRecord)\n const didCommMessageRole = didCommMessageRoleMapping[proofRole][messageKey]\n\n const didCommMessageRecord = new DidCommMessageRecord({\n role: didCommMessageRole,\n associatedRecordId: proofRecord.id,\n message,\n })\n await didCommMessageRepository.save(agent.context, didCommMessageRecord)\n\n agent.config.logger.debug(\n `Successfully moved ${messageKey} from proof record with id ${proofRecord.id} to DIDCommMessageRecord`\n )\n\n delete proofRecordJson[messageKey]\n } else {\n agent.config.logger.debug(\n `Proof record with id ${proofRecord.id} does not have a ${messageKey}. Not creating a DIDCommMessageRecord`\n )\n }\n }\n\n agent.config.logger.debug(\n `Successfully moved didcomm messages from proof record with id ${proofRecord.id} to DIDCommMessageRecord`\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,eAAsB,iCAA0D,OAAc;AAC5F,OAAM,OAAO,OAAO,KAAK,iDAAiD;CAC1E,MAAM,kBAAkB,MAAM,kBAAkB,QAAQ,+BAA+B;AAEvF,OAAM,OAAO,OAAO,MAAM,0CAA0C;CACpE,MAAM,YAAY,MAAM,gBAAgB,OAAO,MAAM,QAAQ;AAE7D,OAAM,OAAO,OAAO,MAAM,oBAAoB,UAAU,OAAO,2BAA2B;AAC1F,MAAK,MAAM,eAAe,WAAW;AACnC,QAAM,OAAO,OAAO,MAAM,kCAAkC,YAAY,GAAG,yBAAyB;AAEpG,QAAM,6CAA6C,OAAO,YAAY;AACtE,QAAM,oBAAoB,OAAO,YAAY;AAE7C,QAAM,gBAAgB,OAAO,MAAM,SAAS,YAAY;AAExD,QAAM,OAAO,OAAO,MAAM,8CAA8C,YAAY,GAAG,yBAAyB;;;AAIpH,IAAY,gFAAL;AACL;AACA;;;AAGF,MAAM,oBAAoB;CACxB,kBAAkB;CAClB,kBAAkB;CAClB,kBAAkB;CAClB,kBAAkB;CAClB,kBAAkB;CACnB;AAED,MAAM,4BAA4B;EAC/B,yBAAyB,WAAW;EACnC,iBAAiB,mBAAmB;EACpC,gBAAgB,mBAAmB;EACnC,qBAAqB,mBAAmB;EACzC;EACA,yBAAyB,SAAS;EACjC,iBAAiB,mBAAmB;EACpC,gBAAgB,mBAAmB;EACnC,qBAAqB,mBAAmB;EACzC;CACF;AAED,MAAM,yBAAyB;CAAC;CAAmB;CAAkB;CAAsB;AAE3F,SAAgB,aAAa,aAAyC;AAEpE,KAAI,YAAY,eAAe,OAC7B,QAAO,yBAAyB;AAGlC,KAAI,YAAY,UAAU,kBAAkB,KAC1C,QAAO,yBAAyB;AAGlC,KAAI,kBAAkB,SAAS,YAAY,MAAM,CAC/C,QAAO,yBAAyB;AAIlC,QAAO,yBAAyB;;;;;;;;;;;;;;;;;;;;AAqBlC,eAAsB,6CACpB,OACA,aACA;AACA,OAAM,OAAO,OAAO,MAAM,mCAAmC,YAAY,GAAG,oCAAoC;AAEhH,KAAI,CAAC,YAAY,iBAAiB;AAChC,QAAM,OAAO,OAAO,MAAM,gCAAgC;AAC1D,cAAY,kBAAkB;;AAGhC,OAAM,OAAO,OAAO,MAClB,+CAA+C,YAAY,GAAG,oCAC/D;;;;;;;AAQH,eAAsB,oBACpB,OACA,aACA;AACA,OAAM,OAAO,OAAO,MAClB,qDAAqD,YAAY,GAAG,0BACrE;CACD,MAAM,2BAA2B,MAAM,kBAAkB,QAAQ,yBAAyB;AAE1F,MAAK,MAAM,cAAc,wBAAwB;AAC/C,QAAM,OAAO,OAAO,MAClB,oBAAoB,WAAW,6BAA6B,YAAY,GAAG,0BAC5E;EACD,MAAM,kBAAkB;EACxB,MAAM,UAAU,gBAAgB;AAEhC,MAAI,SAAS;GAEX,MAAM,qBAAqB,0BADT,aAAa,YAAY,EACqB;GAEhE,MAAM,uBAAuB,IAAI,qBAAqB;IACpD,MAAM;IACN,oBAAoB,YAAY;IAChC;IACD,CAAC;AACF,SAAM,yBAAyB,KAAK,MAAM,SAAS,qBAAqB;AAExE,SAAM,OAAO,OAAO,MAClB,sBAAsB,WAAW,6BAA6B,YAAY,GAAG,0BAC9E;AAED,UAAO,gBAAgB;QAEvB,OAAM,OAAO,OAAO,MAClB,wBAAwB,YAAY,GAAG,mBAAmB,WAAW,uCACtE;;AAIL,OAAM,OAAO,OAAO,MAClB,iEAAiE,YAAY,GAAG,0BACjF"}

package/build/updates/0.4-0.5/credentialExchangeRecord.js CHANGED Viewed

@@ -1,10 +1,10 @@
 const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.js');
 const require_messageType = require('../../util/messageType.js');
-const require_DidCommMessageRole = require('../../repository/DidCommMessageRole.js');
 const require_DidCommMessageRepository = require('../../repository/DidCommMessageRepository.js');
+const require_DidCommMessageRole = require('../../repository/DidCommMessageRole.js');
 require('../../repository/index.js');
-const require_DidCommCredentialState = require('../../modules/credentials/models/DidCommCredentialState.js');
 const require_DidCommCredentialRole = require('../../modules/credentials/models/DidCommCredentialRole.js');
+const require_DidCommCredentialState = require('../../modules/credentials/models/DidCommCredentialState.js');
 const require_DidCommCredentialExchangeRepository = require('../../modules/credentials/repository/DidCommCredentialExchangeRepository.js');
 const require_DidCommOfferCredentialV2Message = require('../../modules/credentials/protocol/v2/messages/DidCommOfferCredentialV2Message.js');
 const require_DidCommProposeCredentialV2Message = require('../../modules/credentials/protocol/v2/messages/DidCommProposeCredentialV2Message.js');

package/build/updates/0.4-0.5/credentialExchangeRecord.mjs CHANGED Viewed

@@ -1,9 +1,9 @@
 import { parseMessageType } from "../../util/messageType.mjs";
-import { DidCommMessageRole } from "../../repository/DidCommMessageRole.mjs";
 import { DidCommMessageRepository } from "../../repository/DidCommMessageRepository.mjs";
+import { DidCommMessageRole } from "../../repository/DidCommMessageRole.mjs";
 import "../../repository/index.mjs";
-import { DidCommCredentialState } from "../../modules/credentials/models/DidCommCredentialState.mjs";
 import { DidCommCredentialRole } from "../../modules/credentials/models/DidCommCredentialRole.mjs";
+import { DidCommCredentialState } from "../../modules/credentials/models/DidCommCredentialState.mjs";
 import { DidCommCredentialExchangeRepository } from "../../modules/credentials/repository/DidCommCredentialExchangeRepository.mjs";
 import { DidCommOfferCredentialV2Message } from "../../modules/credentials/protocol/v2/messages/DidCommOfferCredentialV2Message.mjs";
 import { DidCommProposeCredentialV2Message } from "../../modules/credentials/protocol/v2/messages/DidCommProposeCredentialV2Message.mjs";

package/build/updates/0.4-0.5/credentialExchangeRecord.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"credentialExchangeRecord.mjs","names":[],"sources":["../../../src/updates/0.4-0.5/credentialExchangeRecord.ts"],"sourcesContent":["import type { BaseAgent } from '@credo-ts/core'\nimport ~~type~~ { ~~DidCommCredentialExchangeRecord~~ } from '~~../../modules~~/~~credentials~~'\n\nimport { ~~CredoError~~ } from '~~@credo-ts~~/~~core~~'\n\nimport {\n DidCommCredentialExchangeRepository,\n DidCommCredentialRole,\n DidCommCredentialState,\n DidCommOfferCredentialV2Message,\n DidCommProposeCredentialV2Message,\n DidCommRequestCredentialV2Message,\n} from '../../modules/credentials'\nimport { DidCommMessageRepository, DidCommMessageRole } from '../../repository'\nimport { parseMessageType } from '../../util/messageType'\n\n/*\n Migrates the {@link DidCommCredentialExchangeRecord} to 0.5 compatible format. It fetches all credential exchange records from\n * storage and applies the needed updates to the records. After a record has been transformed, it is updated\n * in storage and the next record will be transformed.\n \n The following transformations are applied:\n * - {@link migrateRole}\n /\nexport async function migrateCredentialExchangeRecordToV0_5<Agent extends BaseAgent>(agent: Agent) {\n agent.config.logger.info('Migrating credential exchange records to storage version 0.5')\n const credentialRepository = agent.dependencyManager.resolve(DidCommCredentialExchangeRepository)\n\n agent.config.logger.debug('Fetching all credential records from storage')\n const credentialRecords = await credentialRepository.getAll(agent.context)\n\n agent.config.logger.debug(`Found a total of ${credentialRecords.length} credential exchange records to update.`)\n for (const credentialRecord of credentialRecords) {\n agent.config.logger.debug(\n `Migrating credential exchange record with id ${credentialRecord.id} to storage version 0.5`\n )\n\n await migrateRole(agent, credentialRecord)\n\n // Save updated record\n await credentialRepository.update(agent.context, credentialRecord)\n\n agent.config.logger.debug(\n `Successfully migrated credential exchange record with id ${credentialRecord.id} to storage version 0.5`\n )\n }\n}\n\nconst holderCredentialStates = [\n DidCommCredentialState.Declined,\n DidCommCredentialState.ProposalSent,\n DidCommCredentialState.OfferReceived,\n DidCommCredentialState.RequestSent,\n DidCommCredentialState.CredentialReceived,\n]\n\nconst issuerCredentialStates = [\n DidCommCredentialState.ProposalReceived,\n DidCommCredentialState.OfferSent,\n DidCommCredentialState.RequestReceived,\n DidCommCredentialState.CredentialIssued,\n]\n\nexport async function getCredentialRole(agent: BaseAgent, credentialRecord: DidCommCredentialExchangeRecord) {\n // Credentials will only have a value when a credential is received, meaning we're the holder\n if (credentialRecord.credentials.length > 0) {\n return DidCommCredentialRole.Holder\n }\n // If credentialRecord.credentials doesn't have any values, and we're also not in state done it means we're the issuer.\n if (credentialRecord.state === DidCommCredentialState.Done) {\n return DidCommCredentialRole.Issuer\n }\n // For these states we know for certain that we're the holder\n if (holderCredentialStates.includes(credentialRecord.state)) {\n return DidCommCredentialRole.Holder\n }\n // For these states we know for certain that we're the issuer\n if (issuerCredentialStates.includes(credentialRecord.state)) {\n return DidCommCredentialRole.Issuer\n }\n\n // We now need to determine the role based on the didcomm message. Only the Abandoned state remains\n // and we can't be certain of the role based on the state alone.\n\n // Fetch any of the associated credential messages that we can use to determine the role\n // Either one of these MUST be present or we can't determine the role.\n const didCommMessageRepository = agent.dependencyManager.resolve(DidCommMessageRepository)\n const [didCommMessageRecord] = await didCommMessageRepository.findByQuery(agent.context, {\n associatedRecordId: credentialRecord.id,\n $or: [\n // We can't be certain which messages will be present.\n { messageName: DidCommOfferCredentialV2Message.type.messageName },\n { messageName: DidCommProposeCredentialV2Message.type.messageName },\n { messageName: DidCommRequestCredentialV2Message.type.messageName },\n ],\n })\n\n if (!didCommMessageRecord) {\n throw new CredoError(\n `Unable to determine the role of the credential exchange record with id ${credentialRecord.id} without any didcomm messages and state abandoned`\n )\n }\n\n // Maps the message name and the didcomm message role to the respective credential role\n const roleStateMapping = {\n [DidCommOfferCredentialV2Message.type.messageName]: {\n [DidCommMessageRole.Sender]: DidCommCredentialRole.Issuer,\n [DidCommMessageRole.Receiver]: DidCommCredentialRole.Holder,\n },\n [DidCommProposeCredentialV2Message.type.messageName]: {\n [DidCommMessageRole.Sender]: DidCommCredentialRole.Holder,\n [DidCommMessageRole.Receiver]: DidCommCredentialRole.Issuer,\n },\n [DidCommRequestCredentialV2Message.type.messageName]: {\n [DidCommMessageRole.Sender]: DidCommCredentialRole.Holder,\n [DidCommMessageRole.Receiver]: DidCommCredentialRole.Issuer,\n },\n }\n\n const messageName = parseMessageType(didCommMessageRecord.message['@type']).messageName\n const credentialRole = roleStateMapping[messageName][didCommMessageRecord.role]\n\n return credentialRole\n}\n\n/\n Add a role to the credential record.\n */\nexport async function migrateRole<Agent extends BaseAgent>(\n agent: Agent,\n credentialRecord: DidCommCredentialExchangeRecord\n) {\n agent.config.logger.debug(`Adding role to record with id ${credentialRecord.id} to for version 0.4`)\n\n credentialRecord.role = await getCredentialRole(agent, credentialRecord)\n\n agent.config.logger.debug(\n `Successfully updated role to '${credentialRecord.role}' on credential record with id ${credentialRecord.id} to for version 0.4`\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;~~AAwBA~~,eAAsB,sCAA+D,OAAc;AACjG,OAAM,OAAO,OAAO,KAAK,+DAA+D;CACxF,MAAM,uBAAuB,MAAM,kBAAkB,QAAQ,oCAAoC;AAEjG,OAAM,OAAO,OAAO,MAAM,+CAA+C;CACzE,MAAM,oBAAoB,MAAM,qBAAqB,OAAO,MAAM,QAAQ;AAE1E,OAAM,OAAO,OAAO,MAAM,oBAAoB,kBAAkB,OAAO,yCAAyC;AAChH,MAAK,MAAM,oBAAoB,mBAAmB;AAChD,QAAM,OAAO,OAAO,MAClB,gDAAgD,iBAAiB,GAAG,yBACrE;AAED,QAAM,YAAY,OAAO,iBAAiB;AAG1C,QAAM,qBAAqB,OAAO,MAAM,SAAS,iBAAiB;AAElE,QAAM,OAAO,OAAO,MAClB,4DAA4D,iBAAiB,GAAG,yBACjF;;;AAIL,MAAM,yBAAyB;CAC7B,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACxB;AAED,MAAM,yBAAyB;CAC7B,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACxB;AAED,eAAsB,kBAAkB,OAAkB,kBAAmD;AAE3G,KAAI,iBAAiB,YAAY,SAAS,EACxC,QAAO,sBAAsB;AAG/B,KAAI,iBAAiB,UAAU,uBAAuB,KACpD,QAAO,sBAAsB;AAG/B,KAAI,uBAAuB,SAAS,iBAAiB,MAAM,CACzD,QAAO,sBAAsB;AAG/B,KAAI,uBAAuB,SAAS,iBAAiB,MAAM,CACzD,QAAO,sBAAsB;CAS/B,MAAM,CAAC,wBAAwB,MADE,MAAM,kBAAkB,QAAQ,yBAAyB,CAC5B,YAAY,MAAM,SAAS;EACvF,oBAAoB,iBAAiB;EACrC,KAAK;GAEH,EAAE,aAAa,gCAAgC,KAAK,aAAa;GACjE,EAAE,aAAa,kCAAkC,KAAK,aAAa;GACnE,EAAE,aAAa,kCAAkC,KAAK,aAAa;GACpE;EACF,CAAC;AAEF,KAAI,CAAC,qBACH,OAAM,IAAI,WACR,0EAA0E,iBAAiB,GAAG,mDAC/F;AAsBH,QAlByB;GACtB,gCAAgC,KAAK,cAAc;IACjD,mBAAmB,SAAS,sBAAsB;IAClD,mBAAmB,WAAW,sBAAsB;GACtD;GACA,kCAAkC,KAAK,cAAc;IACnD,mBAAmB,SAAS,sBAAsB;IAClD,mBAAmB,WAAW,sBAAsB;GACtD;GACA,kCAAkC,KAAK,cAAc;IACnD,mBAAmB,SAAS,sBAAsB;IAClD,mBAAmB,WAAW,sBAAsB;GACtD;EACF,CAEmB,iBAAiB,qBAAqB,QAAQ,SAAS,CAAC,aACvB,qBAAqB;;;;;AAQ5E,eAAsB,YACpB,OACA,kBACA;AACA,OAAM,OAAO,OAAO,MAAM,iCAAiC,iBAAiB,GAAG,qBAAqB;AAEpG,kBAAiB,OAAO,MAAM,kBAAkB,OAAO,iBAAiB;AAExE,OAAM,OAAO,OAAO,MAClB,iCAAiC,iBAAiB,KAAK,iCAAiC,iBAAiB,GAAG,qBAC7G"}
1	+ {"version":3,"file":"credentialExchangeRecord.mjs","names":[],"sources":["../../../src/updates/0.4-0.5/credentialExchangeRecord.ts"],"sourcesContent":["import type { BaseAgent } from '@credo-ts/core'\nimport { CredoError } from '@credo-ts/core'\nimport type { DidCommCredentialExchangeRecord } from '../../modules/credentials'\n\nimport {\n DidCommCredentialExchangeRepository,\n DidCommCredentialRole,\n DidCommCredentialState,\n DidCommOfferCredentialV2Message,\n DidCommProposeCredentialV2Message,\n DidCommRequestCredentialV2Message,\n} from '../../modules/credentials'\nimport { DidCommMessageRepository, DidCommMessageRole } from '../../repository'\nimport { parseMessageType } from '../../util/messageType'\n\n/*\n Migrates the {@link DidCommCredentialExchangeRecord} to 0.5 compatible format. It fetches all credential exchange records from\n * storage and applies the needed updates to the records. After a record has been transformed, it is updated\n * in storage and the next record will be transformed.\n \n The following transformations are applied:\n * - {@link migrateRole}\n /\nexport async function migrateCredentialExchangeRecordToV0_5<Agent extends BaseAgent>(agent: Agent) {\n agent.config.logger.info('Migrating credential exchange records to storage version 0.5')\n const credentialRepository = agent.dependencyManager.resolve(DidCommCredentialExchangeRepository)\n\n agent.config.logger.debug('Fetching all credential records from storage')\n const credentialRecords = await credentialRepository.getAll(agent.context)\n\n agent.config.logger.debug(`Found a total of ${credentialRecords.length} credential exchange records to update.`)\n for (const credentialRecord of credentialRecords) {\n agent.config.logger.debug(\n `Migrating credential exchange record with id ${credentialRecord.id} to storage version 0.5`\n )\n\n await migrateRole(agent, credentialRecord)\n\n // Save updated record\n await credentialRepository.update(agent.context, credentialRecord)\n\n agent.config.logger.debug(\n `Successfully migrated credential exchange record with id ${credentialRecord.id} to storage version 0.5`\n )\n }\n}\n\nconst holderCredentialStates = [\n DidCommCredentialState.Declined,\n DidCommCredentialState.ProposalSent,\n DidCommCredentialState.OfferReceived,\n DidCommCredentialState.RequestSent,\n DidCommCredentialState.CredentialReceived,\n]\n\nconst issuerCredentialStates = [\n DidCommCredentialState.ProposalReceived,\n DidCommCredentialState.OfferSent,\n DidCommCredentialState.RequestReceived,\n DidCommCredentialState.CredentialIssued,\n]\n\nexport async function getCredentialRole(agent: BaseAgent, credentialRecord: DidCommCredentialExchangeRecord) {\n // Credentials will only have a value when a credential is received, meaning we're the holder\n if (credentialRecord.credentials.length > 0) {\n return DidCommCredentialRole.Holder\n }\n // If credentialRecord.credentials doesn't have any values, and we're also not in state done it means we're the issuer.\n if (credentialRecord.state === DidCommCredentialState.Done) {\n return DidCommCredentialRole.Issuer\n }\n // For these states we know for certain that we're the holder\n if (holderCredentialStates.includes(credentialRecord.state)) {\n return DidCommCredentialRole.Holder\n }\n // For these states we know for certain that we're the issuer\n if (issuerCredentialStates.includes(credentialRecord.state)) {\n return DidCommCredentialRole.Issuer\n }\n\n // We now need to determine the role based on the didcomm message. Only the Abandoned state remains\n // and we can't be certain of the role based on the state alone.\n\n // Fetch any of the associated credential messages that we can use to determine the role\n // Either one of these MUST be present or we can't determine the role.\n const didCommMessageRepository = agent.dependencyManager.resolve(DidCommMessageRepository)\n const [didCommMessageRecord] = await didCommMessageRepository.findByQuery(agent.context, {\n associatedRecordId: credentialRecord.id,\n $or: [\n // We can't be certain which messages will be present.\n { messageName: DidCommOfferCredentialV2Message.type.messageName },\n { messageName: DidCommProposeCredentialV2Message.type.messageName },\n { messageName: DidCommRequestCredentialV2Message.type.messageName },\n ],\n })\n\n if (!didCommMessageRecord) {\n throw new CredoError(\n `Unable to determine the role of the credential exchange record with id ${credentialRecord.id} without any didcomm messages and state abandoned`\n )\n }\n\n // Maps the message name and the didcomm message role to the respective credential role\n const roleStateMapping = {\n [DidCommOfferCredentialV2Message.type.messageName]: {\n [DidCommMessageRole.Sender]: DidCommCredentialRole.Issuer,\n [DidCommMessageRole.Receiver]: DidCommCredentialRole.Holder,\n },\n [DidCommProposeCredentialV2Message.type.messageName]: {\n [DidCommMessageRole.Sender]: DidCommCredentialRole.Holder,\n [DidCommMessageRole.Receiver]: DidCommCredentialRole.Issuer,\n },\n [DidCommRequestCredentialV2Message.type.messageName]: {\n [DidCommMessageRole.Sender]: DidCommCredentialRole.Holder,\n [DidCommMessageRole.Receiver]: DidCommCredentialRole.Issuer,\n },\n }\n\n const messageName = parseMessageType(didCommMessageRecord.message['@type']).messageName\n const credentialRole = roleStateMapping[messageName][didCommMessageRecord.role]\n\n return credentialRole\n}\n\n/\n Add a role to the credential record.\n */\nexport async function migrateRole<Agent extends BaseAgent>(\n agent: Agent,\n credentialRecord: DidCommCredentialExchangeRecord\n) {\n agent.config.logger.debug(`Adding role to record with id ${credentialRecord.id} to for version 0.4`)\n\n credentialRecord.role = await getCredentialRole(agent, credentialRecord)\n\n agent.config.logger.debug(\n `Successfully updated role to '${credentialRecord.role}' on credential record with id ${credentialRecord.id} to for version 0.4`\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAuBA,eAAsB,sCAA+D,OAAc;AACjG,OAAM,OAAO,OAAO,KAAK,+DAA+D;CACxF,MAAM,uBAAuB,MAAM,kBAAkB,QAAQ,oCAAoC;AAEjG,OAAM,OAAO,OAAO,MAAM,+CAA+C;CACzE,MAAM,oBAAoB,MAAM,qBAAqB,OAAO,MAAM,QAAQ;AAE1E,OAAM,OAAO,OAAO,MAAM,oBAAoB,kBAAkB,OAAO,yCAAyC;AAChH,MAAK,MAAM,oBAAoB,mBAAmB;AAChD,QAAM,OAAO,OAAO,MAClB,gDAAgD,iBAAiB,GAAG,yBACrE;AAED,QAAM,YAAY,OAAO,iBAAiB;AAG1C,QAAM,qBAAqB,OAAO,MAAM,SAAS,iBAAiB;AAElE,QAAM,OAAO,OAAO,MAClB,4DAA4D,iBAAiB,GAAG,yBACjF;;;AAIL,MAAM,yBAAyB;CAC7B,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACxB;AAED,MAAM,yBAAyB;CAC7B,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACvB,uBAAuB;CACxB;AAED,eAAsB,kBAAkB,OAAkB,kBAAmD;AAE3G,KAAI,iBAAiB,YAAY,SAAS,EACxC,QAAO,sBAAsB;AAG/B,KAAI,iBAAiB,UAAU,uBAAuB,KACpD,QAAO,sBAAsB;AAG/B,KAAI,uBAAuB,SAAS,iBAAiB,MAAM,CACzD,QAAO,sBAAsB;AAG/B,KAAI,uBAAuB,SAAS,iBAAiB,MAAM,CACzD,QAAO,sBAAsB;CAS/B,MAAM,CAAC,wBAAwB,MADE,MAAM,kBAAkB,QAAQ,yBAAyB,CAC5B,YAAY,MAAM,SAAS;EACvF,oBAAoB,iBAAiB;EACrC,KAAK;GAEH,EAAE,aAAa,gCAAgC,KAAK,aAAa;GACjE,EAAE,aAAa,kCAAkC,KAAK,aAAa;GACnE,EAAE,aAAa,kCAAkC,KAAK,aAAa;GACpE;EACF,CAAC;AAEF,KAAI,CAAC,qBACH,OAAM,IAAI,WACR,0EAA0E,iBAAiB,GAAG,mDAC/F;AAsBH,QAlByB;GACtB,gCAAgC,KAAK,cAAc;IACjD,mBAAmB,SAAS,sBAAsB;IAClD,mBAAmB,WAAW,sBAAsB;GACtD;GACA,kCAAkC,KAAK,cAAc;IACnD,mBAAmB,SAAS,sBAAsB;IAClD,mBAAmB,WAAW,sBAAsB;GACtD;GACA,kCAAkC,KAAK,cAAc;IACnD,mBAAmB,SAAS,sBAAsB;IAClD,mBAAmB,WAAW,sBAAsB;GACtD;EACF,CAEmB,iBAAiB,qBAAqB,QAAQ,SAAS,CAAC,aACvB,qBAAqB;;;;;AAQ5E,eAAsB,YACpB,OACA,kBACA;AACA,OAAM,OAAO,OAAO,MAAM,iCAAiC,iBAAiB,GAAG,qBAAqB;AAEpG,kBAAiB,OAAO,MAAM,kBAAkB,OAAO,iBAAiB;AAExE,OAAM,OAAO,OAAO,MAClB,iCAAiC,iBAAiB,KAAK,iCAAiC,iBAAiB,GAAG,qBAC7G"}

package/build/updates/0.4-0.5/proofExchangeRecord.js CHANGED Viewed

@@ -1,13 +1,13 @@
 const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.js');
 const require_messageType = require('../../util/messageType.js');
-const require_DidCommMessageRole = require('../../repository/DidCommMessageRole.js');
 const require_DidCommMessageRepository = require('../../repository/DidCommMessageRepository.js');
+const require_DidCommMessageRole = require('../../repository/DidCommMessageRole.js');
 require('../../repository/index.js');
 const require_DidCommProofState = require('../../modules/proofs/models/DidCommProofState.js');
+const require_DidCommProofExchangeRepository = require('../../modules/proofs/repository/DidCommProofExchangeRepository.js');
 const require_DidCommProofRole = require('../../modules/proofs/models/DidCommProofRole.js');
 const require_DidCommProposePresentationV2Message = require('../../modules/proofs/protocol/v2/messages/DidCommProposePresentationV2Message.js');
 const require_DidCommRequestPresentationV2Message = require('../../modules/proofs/protocol/v2/messages/DidCommRequestPresentationV2Message.js');
-const require_DidCommProofExchangeRepository = require('../../modules/proofs/repository/DidCommProofExchangeRepository.js');
 require('../../modules/proofs/index.js');
 let __credo_ts_core = require("@credo-ts/core");
 __credo_ts_core = require_rolldown_runtime.__toESM(__credo_ts_core);

package/build/updates/0.4-0.5/proofExchangeRecord.mjs CHANGED Viewed

@@ -1,12 +1,12 @@
 import { parseMessageType } from "../../util/messageType.mjs";
-import { DidCommMessageRole } from "../../repository/DidCommMessageRole.mjs";
 import { DidCommMessageRepository } from "../../repository/DidCommMessageRepository.mjs";
+import { DidCommMessageRole } from "../../repository/DidCommMessageRole.mjs";
 import "../../repository/index.mjs";
 import { DidCommProofState } from "../../modules/proofs/models/DidCommProofState.mjs";
+import { DidCommProofExchangeRepository } from "../../modules/proofs/repository/DidCommProofExchangeRepository.mjs";
 import { DidCommProofRole } from "../../modules/proofs/models/DidCommProofRole.mjs";
 import { DidCommProposePresentationV2Message } from "../../modules/proofs/protocol/v2/messages/DidCommProposePresentationV2Message.mjs";
 import { DidCommRequestPresentationV2Message } from "../../modules/proofs/protocol/v2/messages/DidCommRequestPresentationV2Message.mjs";
-import { DidCommProofExchangeRepository } from "../../modules/proofs/repository/DidCommProofExchangeRepository.mjs";
 import "../../modules/proofs/index.mjs";
 import { CredoError } from "@credo-ts/core";

package/build/util/DidCommLinkedAttachment.js CHANGED Viewed

@@ -1,12 +1,12 @@
 const require_rolldown_runtime = require('../_virtual/rolldown_runtime.js');
-const require_decorateMetadata = require('../_virtual/_@oxc-project_runtime@0.94.0/helpers/decorateMetadata.js');
 const require_decorate = require('../_virtual/_@oxc-project_runtime@0.94.0/helpers/decorate.js');
+const require_decorateMetadata = require('../_virtual/_@oxc-project_runtime@0.94.0/helpers/decorateMetadata.js');
 const require_DidCommAttachment = require('../decorators/attachment/DidCommAttachment.js');
 const require_attachment = require('./attachment.js');
-let class_transformer = require("class-transformer");
-class_transformer = require_rolldown_runtime.__toESM(class_transformer);
 let class_validator = require("class-validator");
 class_validator = require_rolldown_runtime.__toESM(class_validator);
+let class_transformer = require("class-transformer");
+class_transformer = require_rolldown_runtime.__toESM(class_transformer);
 //#region src/util/DidCommLinkedAttachment.ts
 var _ref;

package/build/util/DidCommLinkedAttachment.mjs CHANGED Viewed

@@ -1,9 +1,9 @@
-import { __decorateMetadata } from "../_virtual/_@oxc-project_runtime@0.94.0/helpers/decorateMetadata.mjs";
 import { __decorate } from "../_virtual/_@oxc-project_runtime@0.94.0/helpers/decorate.mjs";
+import { __decorateMetadata } from "../_virtual/_@oxc-project_runtime@0.94.0/helpers/decorateMetadata.mjs";
 import { DidCommAttachment } from "../decorators/attachment/DidCommAttachment.mjs";
 import { encodeAttachment } from "./attachment.mjs";
-import { Type } from "class-transformer";
 import { IsString } from "class-validator";
+import { Type } from "class-transformer";
 //#region src/util/DidCommLinkedAttachment.ts
 var _ref;

package/build/util/JWE.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"JWE.mjs","names":[],"sources":["../../src/util/JWE.ts"],"sourcesContent":["import type { DidCommEncryptedMessage } from '../types'\n\n// biome-ignore lint/suspicious/noExplicitAny: <explanation>\nexport function isValidJweStructure(message: any): message is DidCommEncryptedMessage {\n return Boolean(\n message &&\n typeof message === 'object' &&\n message !== null &&\n typeof message.protected === 'string' &&\n message.iv &&\n message.ciphertext &&\n message.tag\n )\n}\n"],"mappings":";AAGA,SAAgB,oBAAoB,SAAkD;AACpF,QAAO,QACL,WACE,OAAO,YAAY,YACnB,YAAY,QACZ,OAAO,QAAQ,cAAc,YAC7B,QAAQ,MACR,QAAQ,cACR,QAAQ,IACX"}
1	+ {"version":3,"file":"JWE.mjs","names":[],"sources":["../../src/util/JWE.ts"],"sourcesContent":["import type { DidCommEncryptedMessage } from '../types'\n\n// biome-ignore lint/suspicious/noExplicitAny: no explanation\nexport function isValidJweStructure(message: any): message is DidCommEncryptedMessage {\n return Boolean(\n message &&\n typeof message === 'object' &&\n message !== null &&\n typeof message.protected === 'string' &&\n message.iv &&\n message.ciphertext &&\n message.tag\n )\n}\n"],"mappings":";AAGA,SAAgB,oBAAoB,SAAkD;AACpF,QAAO,QACL,WACE,OAAO,YAAY,YACnB,YAAY,QACZ,OAAO,QAAQ,cAAc,YAC7B,QAAQ,MACR,QAAQ,cACR,QAAQ,IACX"}

package/build/util/attachment.d.mts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"attachment.d.mts","names":[],"sources":["../../src/util/attachment.ts"],"sourcesContent":[],"mappings":";;;;;;;~~AAaA~~;;;;;;AAuBgB,iBAvBA,gBAAA,CAuB+B,UAAA,EAtBjC,iBAsBkD,EAAA,aAAA,CAAA,EArB/C,QAqB+C,EAAA,QAAA,CAAA,EApBpD,QAoBoD,CAAA,EAAA,MAAA;;;;;;;iBAAhD,kBAAA,aAA+B"}
1	+ {"version":3,"file":"attachment.d.mts","names":[],"sources":["../../src/util/attachment.ts"],"sourcesContent":[],"mappings":";;;;;;;AAYA;;;;;;AAuBgB,iBAvBA,gBAAA,CAuB+B,UAAA,EAtBjC,iBAsBkD,EAAA,aAAA,CAAA,EArB/C,QAqB+C,EAAA,QAAA,CAAA,EApBpD,QAoBoD,CAAA,EAAA,MAAA;;;;;;;iBAAhD,kBAAA,aAA+B"}

package/build/util/attachment.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"attachment.d.ts","names":[],"sources":["../../src/util/attachment.ts"],"sourcesContent":[],"mappings":";;;;;;;~~AAaA~~;;;;;;AAuBgB,iBAvBA,gBAAA,CAuB+B,UAAA,EAtBjC,iBAsBkD,EAAA,aAAA,CAAA,EArB/C,QAqB+C,EAAA,QAAA,CAAA,EApBpD,QAoBoD,CAAA,EAAA,MAAA;;;;;;;iBAAhD,kBAAA,aAA+B"}
1	+ {"version":3,"file":"attachment.d.ts","names":[],"sources":["../../src/util/attachment.ts"],"sourcesContent":[],"mappings":";;;;;;;AAYA;;;;;;AAuBgB,iBAvBA,gBAAA,CAuB+B,UAAA,EAtBjC,iBAsBkD,EAAA,aAAA,CAAA,EArB/C,QAqB+C,EAAA,QAAA,CAAA,EApBpD,QAoBoD,CAAA,EAAA,MAAA;;;;;;;iBAAhD,kBAAA,aAA+B"}

package/build/util/attachment.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"attachment.mjs","names":[],"sources":["../../src/util/attachment.ts"],"sourcesContent":["import type { BaseName, HashName } from '@credo-ts/core'\nimport ~~type~~ { ~~DidCommAttachment~~ } from '~~../decorators~~/~~attachment/DidCommAttachment~~'\n\nimport { ~~CredoError,~~ ~~HashlinkEncoder, TypedArrayEncoder~~ } from '~~@credo-ts~~/~~core~~'\n\n/*\n Encodes an attachment based on the `data` property\n \n @param attachment The attachment that needs to be encoded\n * @param hashAlgorithm The hashing algorithm that is going to be used\n * @param baseName The base encoding name that is going to be used\n * @returns A hashlink based on the attachment data\n /\nexport function encodeAttachment(\n attachment: DidCommAttachment,\n hashAlgorithm: HashName = 'sha-256',\n baseName: BaseName = 'base58btc'\n) {\n if (attachment.data.sha256) {\n return `hl:${attachment.data.sha256}`\n }\n if (attachment.data.base64) {\n return HashlinkEncoder.encode(TypedArrayEncoder.fromBase64(attachment.data.base64), hashAlgorithm, baseName)\n }\n if (attachment.data.json) {\n throw new CredoError(`Attachment: (${attachment.id}) has json encoded data. This is currently not supported`)\n }\n throw new CredoError(`Attachment: (${attachment.id}) has no data to create a link with`)\n}\n\n/\n Checks if an attachment is a linked Attachment\n \n @param attachment the attachment that has to be validated\n * @returns a boolean whether the attachment is a linkedAttachment\n */\nexport function isLinkedAttachment(attachment: DidCommAttachment) {\n return HashlinkEncoder.isValid(`hl:${attachment.id}`)\n}\n"],"mappings":";;;;;;;;;;;~~AAaA~~,SAAgB,iBACd,YACA,gBAA0B,WAC1B,WAAqB,aACrB;AACA,KAAI,WAAW,KAAK,OAClB,QAAO,MAAM,WAAW,KAAK;AAE/B,KAAI,WAAW,KAAK,OAClB,QAAO,gBAAgB,OAAO,kBAAkB,WAAW,WAAW,KAAK,OAAO,EAAE,eAAe,SAAS;AAE9G,KAAI,WAAW,KAAK,KAClB,OAAM,IAAI,WAAW,gBAAgB,WAAW,GAAG,0DAA0D;AAE/G,OAAM,IAAI,WAAW,gBAAgB,WAAW,GAAG,qCAAqC;;;;;;;;AAS1F,SAAgB,mBAAmB,YAA+B;AAChE,QAAO,gBAAgB,QAAQ,MAAM,WAAW,KAAK"}
1	+ {"version":3,"file":"attachment.mjs","names":[],"sources":["../../src/util/attachment.ts"],"sourcesContent":["import type { BaseName, HashName } from '@credo-ts/core'\nimport { CredoError, HashlinkEncoder, TypedArrayEncoder } from '@credo-ts/core'\nimport type { DidCommAttachment } from '../decorators/attachment/DidCommAttachment'\n\n/*\n Encodes an attachment based on the `data` property\n \n @param attachment The attachment that needs to be encoded\n * @param hashAlgorithm The hashing algorithm that is going to be used\n * @param baseName The base encoding name that is going to be used\n * @returns A hashlink based on the attachment data\n /\nexport function encodeAttachment(\n attachment: DidCommAttachment,\n hashAlgorithm: HashName = 'sha-256',\n baseName: BaseName = 'base58btc'\n) {\n if (attachment.data.sha256) {\n return `hl:${attachment.data.sha256}`\n }\n if (attachment.data.base64) {\n return HashlinkEncoder.encode(TypedArrayEncoder.fromBase64(attachment.data.base64), hashAlgorithm, baseName)\n }\n if (attachment.data.json) {\n throw new CredoError(`Attachment: (${attachment.id}) has json encoded data. This is currently not supported`)\n }\n throw new CredoError(`Attachment: (${attachment.id}) has no data to create a link with`)\n}\n\n/\n Checks if an attachment is a linked Attachment\n \n @param attachment the attachment that has to be validated\n * @returns a boolean whether the attachment is a linkedAttachment\n */\nexport function isLinkedAttachment(attachment: DidCommAttachment) {\n return HashlinkEncoder.isValid(`hl:${attachment.id}`)\n}\n"],"mappings":";;;;;;;;;;;AAYA,SAAgB,iBACd,YACA,gBAA0B,WAC1B,WAAqB,aACrB;AACA,KAAI,WAAW,KAAK,OAClB,QAAO,MAAM,WAAW,KAAK;AAE/B,KAAI,WAAW,KAAK,OAClB,QAAO,gBAAgB,OAAO,kBAAkB,WAAW,WAAW,KAAK,OAAO,EAAE,eAAe,SAAS;AAE9G,KAAI,WAAW,KAAK,KAClB,OAAM,IAAI,WAAW,gBAAgB,WAAW,GAAG,0DAA0D;AAE/G,OAAM,IAAI,WAAW,gBAAgB,WAAW,GAAG,qCAAqC;;;;;;;;AAS1F,SAAgB,mBAAmB,YAA+B;AAChE,QAAO,gBAAgB,QAAQ,MAAM,WAAW,KAAK"}

package/build/util/messageType.d.mts CHANGED Viewed

@@ -57,6 +57,42 @@ interface ParsedMessageType extends ParsedDidCommProtocolUri {
   messageTypeUri: string;
 }
 declare function parseMessageType(messageType: string): ParsedMessageType;
+/**
+ * Check whether the incoming message type is a message type that can be handled by comparing it to the expected message type.
+ * In this case the expected message type is e.g. the type declared on an agent message class, and the incoming message type is the type
+ * that is parsed from the incoming JSON.
+ *
+ * The method will make sure the following fields are equal:
+ *  - documentUri
+ *  - protocolName
+ *  - majorVersion
+ *  - messageName
+ *
+ * If allowLegacyDidSovPrefixMismatch is true (default) it will allow for the case where the incoming message type still has the legacy
+ * did:sov:BzCbsNYhMrjHiqZDTUASHg;spec did prefix, but the expected message type does not. This only works for incoming messages with a prefix
+ * of did:sov:BzCbsNYhMrjHiqZDTUASHg;spec and the expected message type having a prefix value of https:/didcomm.org
+ *
+ * @example
+ * const incomingMessageType = parseMessageType('https://didcomm.org/connections/1.0/request')
+ * const expectedMessageType = parseMessageType('https://didcomm.org/connections/1.4/request')
+ *
+ * // Returns true because the incoming message type is equal to the expected message type, except for
+ * // the minor version, which is lower
+ * const isIncomingMessageTypeSupported = supportsIncomingMessageType(incomingMessageType, expectedMessageType)
+ *
+ * @example
+ * const incomingMessageType = parseMessageType('did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/connections/1.0/request')
+ * const expectedMessageType = parseMessageType('https://didcomm.org/connections/1.0/request')
+ *
+ * // Returns true because the incoming message type is equal to the expected message type, except for
+ * // the legacy did sov prefix.
+ * const isIncomingMessageTypeSupported = supportsIncomingMessageType(incomingMessageType, expectedMessageType)
+ */
+declare function supportsIncomingMessageType(incomingMessageType: ParsedMessageType, expectedMessageType: ParsedMessageType, {
+  allowLegacyDidSovPrefixMismatch
+}?: {
+  allowLegacyDidSovPrefixMismatch?: boolean;
+}): boolean;
 /**
  * class-validator decorator to check if the string message type value matches with the
  * expected message type. This uses {@link supportsIncomingMessageType}.
@@ -64,5 +100,5 @@ declare function parseMessageType(messageType: string): ParsedMessageType;
 declare function IsValidMessageType(messageType: ParsedMessageType, validationOptions?: ValidationOptions): PropertyDecorator;
 declare function replaceLegacyDidSovPrefix(messageType: string): string;
 //#endregion
-export { IsValidMessageType, ParsedDidCommProtocolUri, ParsedMessageType, parseMessageType, replaceLegacyDidSovPrefix };
+export { IsValidMessageType, ParsedDidCommProtocolUri, ParsedMessageType, parseMessageType, replaceLegacyDidSovPrefix, supportsIncomingMessageType };
 //# sourceMappingURL=messageType.d.mts.map

package/build/util/messageType.d.mts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"messageType.d.mts","names":[],"sources":["../../src/util/messageType.ts"],"sourcesContent":[],"mappings":";;;~~UAQiB~~,wBAAA;EAAA;AA8CjB;AAmBA;~~AAmJA~~;;~~iBACe~~,EAAA,MAAA;;;;AAsCf~~;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;~~UA7MiB,iBAAA,SAA0B;;;;;;;;;;;;;;;iBAmB3B,gBAAA,uBAAuC~~;;;;;iBAmJvC~~,kBAAA,cACD,uCACO,oBACnB;iBAoCa,yBAAA"}
1	+ {"version":3,"file":"messageType.d.mts","names":[],"sources":["../../src/util/messageType.ts"],"sourcesContent":[],"mappings":";;;UAOiB,wBAAA;EAAA;AA8CjB;AAmBA;AAsHA;;iBACuB,EAAA,MAAA;;;;AA4BvB;;sBACe,EAAA,MAAA;;;;AAsCf;;;;;;;;;;;;;;;;;;;;;;;;UA7MiB,iBAAA,SAA0B;;;;;;;;;;;;;;;iBAmB3B,gBAAA,uBAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsHvC,2BAAA,sBACO,wCACA;;;;;;;;;iBA2BP,kBAAA,cACD,uCACO,oBACnB;iBAoCa,yBAAA"}

package/build/util/messageType.d.ts CHANGED Viewed

@@ -57,6 +57,42 @@ interface ParsedMessageType extends ParsedDidCommProtocolUri {
   messageTypeUri: string;
 }
 declare function parseMessageType(messageType: string): ParsedMessageType;
+/**
+ * Check whether the incoming message type is a message type that can be handled by comparing it to the expected message type.
+ * In this case the expected message type is e.g. the type declared on an agent message class, and the incoming message type is the type
+ * that is parsed from the incoming JSON.
+ *
+ * The method will make sure the following fields are equal:
+ *  - documentUri
+ *  - protocolName
+ *  - majorVersion
+ *  - messageName
+ *
+ * If allowLegacyDidSovPrefixMismatch is true (default) it will allow for the case where the incoming message type still has the legacy
+ * did:sov:BzCbsNYhMrjHiqZDTUASHg;spec did prefix, but the expected message type does not. This only works for incoming messages with a prefix
+ * of did:sov:BzCbsNYhMrjHiqZDTUASHg;spec and the expected message type having a prefix value of https:/didcomm.org
+ *
+ * @example
+ * const incomingMessageType = parseMessageType('https://didcomm.org/connections/1.0/request')
+ * const expectedMessageType = parseMessageType('https://didcomm.org/connections/1.4/request')
+ *
+ * // Returns true because the incoming message type is equal to the expected message type, except for
+ * // the minor version, which is lower
+ * const isIncomingMessageTypeSupported = supportsIncomingMessageType(incomingMessageType, expectedMessageType)
+ *
+ * @example
+ * const incomingMessageType = parseMessageType('did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/connections/1.0/request')
+ * const expectedMessageType = parseMessageType('https://didcomm.org/connections/1.0/request')
+ *
+ * // Returns true because the incoming message type is equal to the expected message type, except for
+ * // the legacy did sov prefix.
+ * const isIncomingMessageTypeSupported = supportsIncomingMessageType(incomingMessageType, expectedMessageType)
+ */
+declare function supportsIncomingMessageType(incomingMessageType: ParsedMessageType, expectedMessageType: ParsedMessageType, {
+  allowLegacyDidSovPrefixMismatch
+}?: {
+  allowLegacyDidSovPrefixMismatch?: boolean;
+}): boolean;
 /**
  * class-validator decorator to check if the string message type value matches with the
  * expected message type. This uses {@link supportsIncomingMessageType}.
@@ -64,5 +100,5 @@ declare function parseMessageType(messageType: string): ParsedMessageType;
 declare function IsValidMessageType(messageType: ParsedMessageType, validationOptions?: ValidationOptions): PropertyDecorator;
 declare function replaceLegacyDidSovPrefix(messageType: string): string;
 //#endregion
-export { IsValidMessageType, ParsedDidCommProtocolUri, ParsedMessageType, parseMessageType, replaceLegacyDidSovPrefix };
+export { IsValidMessageType, ParsedDidCommProtocolUri, ParsedMessageType, parseMessageType, replaceLegacyDidSovPrefix, supportsIncomingMessageType };
 //# sourceMappingURL=messageType.d.ts.map

package/build/util/messageType.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"messageType.d.ts","names":[],"sources":["../../src/util/messageType.ts"],"sourcesContent":[],"mappings":";;;~~UAQiB~~,wBAAA;EAAA;AA8CjB;AAmBA;~~AAmJA~~;;~~iBACe~~,EAAA,MAAA;;;;AAsCf~~;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;~~UA7MiB,iBAAA,SAA0B;;;;;;;;;;;;;;;iBAmB3B,gBAAA,uBAAuC~~;;;;;iBAmJvC~~,kBAAA,cACD,uCACO,oBACnB;iBAoCa,yBAAA"}
1	+ {"version":3,"file":"messageType.d.ts","names":[],"sources":["../../src/util/messageType.ts"],"sourcesContent":[],"mappings":";;;UAOiB,wBAAA;EAAA;AA8CjB;AAmBA;AAsHA;;iBACuB,EAAA,MAAA;;;;AA4BvB;;sBACe,EAAA,MAAA;;;;AAsCf;;;;;;;;;;;;;;;;;;;;;;;;UA7MiB,iBAAA,SAA0B;;;;;;;;;;;;;;;iBAmB3B,gBAAA,uBAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsHvC,2BAAA,sBACO,wCACA;;;;;;;;;iBA2BP,kBAAA,cACD,uCACO,oBACnB;iBAoCa,yBAAA"}

package/build/util/messageType.js CHANGED Viewed

@@ -13,8 +13,8 @@ function parseMessageType(messageType) {
 		documentUri,
 		protocolName,
 		protocolVersion: `${protocolVersionMajor}.${protocolVersionMinor}`,
-		protocolMajorVersion: Number.parseInt(protocolVersionMajor),
-		protocolMinorVersion: Number.parseInt(protocolVersionMinor),
+		protocolMajorVersion: Number.parseInt(protocolVersionMajor, 10),
+		protocolMinorVersion: Number.parseInt(protocolVersionMinor, 10),
 		messageName,
 		protocolUri: `${documentUri}/${protocolName}/${protocolVersionMajor}.${protocolVersionMinor}`,
 		messageTypeUri: messageType
@@ -28,8 +28,8 @@ function parseDidCommProtocolUri(didCommProtocolUri) {
 		documentUri,
 		protocolName,
 		protocolVersion: `${protocolVersionMajor}.${protocolVersionMinor}`,
-		protocolMajorVersion: Number.parseInt(protocolVersionMajor),
-		protocolMinorVersion: Number.parseInt(protocolVersionMinor),
+		protocolMajorVersion: Number.parseInt(protocolVersionMajor, 10),
+		protocolMinorVersion: Number.parseInt(protocolVersionMinor, 10),
 		protocolUri: `${documentUri}/${protocolName}/${protocolVersionMajor}.${protocolVersionMinor}`
 	};
 }

package/build/util/messageType.mjs CHANGED Viewed

@@ -11,8 +11,8 @@ function parseMessageType(messageType) {
 		documentUri,
 		protocolName,
 		protocolVersion: `${protocolVersionMajor}.${protocolVersionMinor}`,
-		protocolMajorVersion: Number.parseInt(protocolVersionMajor),
-		protocolMinorVersion: Number.parseInt(protocolVersionMinor),
+		protocolMajorVersion: Number.parseInt(protocolVersionMajor, 10),
+		protocolMinorVersion: Number.parseInt(protocolVersionMinor, 10),
 		messageName,
 		protocolUri: `${documentUri}/${protocolName}/${protocolVersionMajor}.${protocolVersionMinor}`,
 		messageTypeUri: messageType
@@ -26,8 +26,8 @@ function parseDidCommProtocolUri(didCommProtocolUri) {
 		documentUri,
 		protocolName,
 		protocolVersion: `${protocolVersionMajor}.${protocolVersionMinor}`,
-		protocolMajorVersion: Number.parseInt(protocolVersionMajor),
-		protocolMinorVersion: Number.parseInt(protocolVersionMinor),
+		protocolMajorVersion: Number.parseInt(protocolVersionMajor, 10),
+		protocolMinorVersion: Number.parseInt(protocolVersionMinor, 10),
 		protocolUri: `${documentUri}/${protocolName}/${protocolVersionMajor}.${protocolVersionMinor}`
 	};
 }

package/build/util/messageType.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"messageType.mjs","names":[],"sources":["../../src/util/messageType.ts"],"sourcesContent":["import type { ValidationArguments, ValidationOptions } from 'class-validator'\nimport type { DidCommPlaintextMessage } from '../types'\n\nimport { ValidateBy, buildMessage } from 'class-validator'\n\nconst PROTOCOL_URI_REGEX = /^(.+)\\/([^/\\\\]+)\\/(\\d+).(\\d+)$/\nconst MESSAGE_TYPE_REGEX = /^(.+)\\/([^/\\\\]+)\\/(\\d+).(\\d+)\\/([^/\\\\]+)$/\n\nexport interface ParsedDidCommProtocolUri {\n /*\n Version of the protocol\n \n @example 1.0\n /\n protocolVersion: string\n\n /\n Major version of the protocol\n \n @example 1\n /\n protocolMajorVersion: number\n\n /\n Minor version of the protocol\n \n @example 0\n /\n protocolMinorVersion: number\n\n /\n Name of the protocol\n \n @example connections\n /\n protocolName: string\n\n /\n Document uri of the message.\n \n @example https://didcomm.org\n /\n documentUri: string\n\n /\n Uri identifier of the protocol. Includes the\n * documentUri, protocolName and protocolVersion.\n * Useful when working with feature discovery\n \n @example https://didcomm.org/connections/1.0\n /\n protocolUri: string\n}\n\nexport interface ParsedMessageType extends ParsedDidCommProtocolUri {\n /\n Message name\n \n @example request\n /\n messageName: string\n\n /\n Uri identifier of the message. Includes all parts\n * or the message type.\n \n @example https://didcomm.org/connections/1.0/request\n /\n messageTypeUri: string\n}\n\n// TODO: rename to `parseDidCommMessageType` and `DidCommParsedProtocolUri`\n// in the future\nexport function parseMessageType(messageType: string): ParsedMessageType {\n const match = MESSAGE_TYPE_REGEX.exec(messageType)\n\n if (!match) {\n throw new Error(`Invalid message type: ${messageType}`)\n }\n\n const [, documentUri, protocolName, protocolVersionMajor, protocolVersionMinor, messageName] = match\n\n return {\n documentUri,\n protocolName,\n protocolVersion: `${protocolVersionMajor}.${protocolVersionMinor}`,\n protocolMajorVersion: Number.parseInt(protocolVersionMajor),\n protocolMinorVersion: Number.parseInt(protocolVersionMinor),\n messageName,\n protocolUri: `${documentUri}/${protocolName}/${protocolVersionMajor}.${protocolVersionMinor}`,\n messageTypeUri: messageType,\n }\n}\n\nexport function parseDidCommProtocolUri(didCommProtocolUri: string): ParsedDidCommProtocolUri {\n const match = PROTOCOL_URI_REGEX.exec(didCommProtocolUri)\n\n if (!match) {\n throw new Error(`Invalid protocol uri: ${didCommProtocolUri}`)\n }\n\n const [, documentUri, protocolName, protocolVersionMajor, protocolVersionMinor] = match\n\n return {\n documentUri,\n protocolName,\n protocolVersion: `${protocolVersionMajor}.${protocolVersionMinor}`,\n protocolMajorVersion: Number.parseInt(protocolVersionMajor),\n protocolMinorVersion: Number.parseInt(protocolVersionMinor),\n protocolUri: `${documentUri}/${protocolName}/${protocolVersionMajor}.${protocolVersionMinor}`,\n }\n}\n\n/\n Check whether the incoming didcomm protocol uri is a protocol uri that can be handled by comparing it to the expected didcomm protocol uri.\n * In this case the expected protocol uri is e.g. the handshake protocol supported (https://didcomm.org/connections/1.0), and the incoming protocol uri\n * is the uri that is parsed from the incoming out of band invitation handshake_protocols.\n \n The method will make sure the following fields are equal:\n * - documentUri\n * - protocolName\n * - majorVersion\n \n If allowLegacyDidSovPrefixMismatch is true (default) it will allow for the case where the incoming protocol uri still has the legacy\n * did:sov:BzCbsNYhMrjHiqZDTUASHg;spec did prefix, but the expected message type does not. This only works for incoming messages with a prefix\n * of did:sov:BzCbsNYhMrjHiqZDTUASHg;spec and the expected message type having a prefix value of https:/didcomm.org\n \n @example\n * const incomingProtocolUri = parseDidCommProtocolUri('https://didcomm.org/connections/1.0')\n * const expectedProtocolUri = parseDidCommProtocolUri('https://didcomm.org/connections/1.4')\n \n // Returns true because the incoming protocol uri is equal to the expected protocol uri, except for\n * // the minor version, which is lower\n * const isIncomingProtocolUriSupported = supportsIncomingDidCommProtocolUri(incomingProtocolUri, expectedProtocolUri)\n \n @example\n * const incomingProtocolUri = parseDidCommProtocolUri('did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/connections/1.0')\n * const expectedProtocolUri = parseDidCommProtocolUri('https://didcomm.org/connections/1.0')\n \n // Returns true because the incoming protocol uri is equal to the expected protocol uri, except for\n * // the legacy did sov prefix.\n * const isIncomingProtocolUriSupported = supportsIncomingDidCommProtocolUri(incomingProtocolUri, expectedProtocolUri)\n /\nexport function supportsIncomingDidCommProtocolUri(\n incomingProtocolUri: ParsedDidCommProtocolUri,\n expectedProtocolUri: ParsedDidCommProtocolUri,\n { allowLegacyDidSovPrefixMismatch = true }: { allowLegacyDidSovPrefixMismatch?: boolean } = {}\n) {\n const incomingDocumentUri = allowLegacyDidSovPrefixMismatch\n ? replaceLegacyDidSovPrefix(incomingProtocolUri.documentUri)\n : incomingProtocolUri.documentUri\n\n const documentUriMatches = expectedProtocolUri.documentUri === incomingDocumentUri\n const protocolNameMatches = expectedProtocolUri.protocolName === incomingProtocolUri.protocolName\n const majorVersionMatches = expectedProtocolUri.protocolMajorVersion === incomingProtocolUri.protocolMajorVersion\n\n // Everything besides the minor version must match\n return documentUriMatches && protocolNameMatches && majorVersionMatches\n}\n\n/\n Check whether the incoming message type is a message type that can be handled by comparing it to the expected message type.\n * In this case the expected message type is e.g. the type declared on an agent message class, and the incoming message type is the type\n * that is parsed from the incoming JSON.\n \n The method will make sure the following fields are equal:\n * - documentUri\n * - protocolName\n * - majorVersion\n * - messageName\n \n If allowLegacyDidSovPrefixMismatch is true (default) it will allow for the case where the incoming message type still has the legacy\n * did:sov:BzCbsNYhMrjHiqZDTUASHg;spec did prefix, but the expected message type does not. This only works for incoming messages with a prefix\n * of did:sov:BzCbsNYhMrjHiqZDTUASHg;spec and the expected message type having a prefix value of https:/didcomm.org\n \n @example\n * const incomingMessageType = parseMessageType('https://didcomm.org/connections/1.0/request')\n * const expectedMessageType = parseMessageType('https://didcomm.org/connections/1.4/request')\n \n // Returns true because the incoming message type is equal to the expected message type, except for\n * // the minor version, which is lower\n * const isIncomingMessageTypeSupported = supportsIncomingMessageType(incomingMessageType, expectedMessageType)\n \n @example\n * const incomingMessageType = parseMessageType('did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/connections/1.0/request')\n * const expectedMessageType = parseMessageType('https://didcomm.org/connections/1.0/request')\n \n // Returns true because the incoming message type is equal to the expected message type, except for\n * // the legacy did sov prefix.\n * const isIncomingMessageTypeSupported = supportsIncomingMessageType(incomingMessageType, expectedMessageType)\n /\nexport function supportsIncomingMessageType(\n incomingMessageType: ParsedMessageType,\n expectedMessageType: ParsedMessageType,\n { allowLegacyDidSovPrefixMismatch = true }: { allowLegacyDidSovPrefixMismatch?: boolean } = {}\n) {\n const incomingDocumentUri = allowLegacyDidSovPrefixMismatch\n ? replaceLegacyDidSovPrefix(incomingMessageType.documentUri)\n : incomingMessageType.documentUri\n\n const documentUriMatches = expectedMessageType.documentUri === incomingDocumentUri\n const protocolNameMatches = expectedMessageType.protocolName === incomingMessageType.protocolName\n const majorVersionMatches = expectedMessageType.protocolMajorVersion === incomingMessageType.protocolMajorVersion\n const messageNameMatches = expectedMessageType.messageName === incomingMessageType.messageName\n\n // Everything besides the minor version must match\n return documentUriMatches && protocolNameMatches && majorVersionMatches && messageNameMatches\n}\n\nexport function canHandleMessageType(\n messageClass: { type: ParsedMessageType },\n messageType: ParsedMessageType\n): boolean {\n return supportsIncomingMessageType(messageClass.type, messageType)\n}\n\n/\n class-validator decorator to check if the string message type value matches with the\n * expected message type. This uses {@link supportsIncomingMessageType}.\n */\nexport function IsValidMessageType(\n messageType: ParsedMessageType,\n validationOptions?: ValidationOptions\n): PropertyDecorator {\n return ValidateBy(\n {\n name: 'isValidMessageType',\n constraints: [messageType],\n validator: {\n validate: (value, args: ValidationArguments): boolean => {\n const [expectedMessageType] = args.constraints as [ParsedMessageType]\n\n // Type must be string\n if (typeof value !== 'string') {\n return false\n }\n\n const incomingMessageType = parseMessageType(value)\n return supportsIncomingMessageType(incomingMessageType, expectedMessageType)\n },\n defaultMessage: buildMessage(\n (eachPrefix) =>\n `${eachPrefix}$property does not match the expected message type (only minor version may be lower)`,\n validationOptions\n ),\n },\n },\n validationOptions\n )\n}\n\nexport function replaceLegacyDidSovPrefixOnMessage(message: DidCommPlaintextMessage \| Record<string, unknown>) {\n message['@type'] = replaceLegacyDidSovPrefix(message['@type'] as string)\n}\n\nexport function replaceNewDidCommPrefixWithLegacyDidSovOnMessage(message: Record<string, unknown>) {\n message['@type'] = replaceNewDidCommPrefixWithLegacyDidSov(message['@type'] as string)\n}\n\nexport function replaceLegacyDidSovPrefix(messageType: string) {\n const didSovPrefix = 'did:sov:BzCbsNYhMrjHiqZDTUASHg;spec'\n const didCommPrefix = 'https://didcomm.org'\n\n if (messageType.startsWith(didSovPrefix)) {\n return messageType.replace(didSovPrefix, didCommPrefix)\n }\n\n return messageType\n}\n\nexport function replaceNewDidCommPrefixWithLegacyDidSov(messageType: string) {\n const didSovPrefix = 'did:sov:BzCbsNYhMrjHiqZDTUASHg;spec'\n const didCommPrefix = 'https://didcomm.org'\n\n if (messageType.startsWith(didCommPrefix)) {\n return messageType.replace(didCommPrefix, didSovPrefix)\n }\n\n return messageType\n}\n"],"mappings":";;;AAKA,MAAM,qBAAqB;AAC3B,MAAM,qBAAqB;AAmE3B,SAAgB,iBAAiB,aAAwC;CACvE,MAAM,QAAQ,mBAAmB,KAAK,YAAY;AAElD,KAAI,CAAC,MACH,OAAM,IAAI,MAAM,yBAAyB,cAAc;CAGzD,MAAM,GAAG,aAAa,cAAc,sBAAsB,sBAAsB,eAAe;AAE/F,QAAO;EACL;EACA;EACA,iBAAiB,GAAG,qBAAqB,GAAG;EAC5C,sBAAsB,OAAO,SAAS,qBAAqB;EAC3D,sBAAsB,OAAO,SAAS,qBAAqB;EAC3D;EACA,aAAa,GAAG,YAAY,GAAG,aAAa,GAAG,qBAAqB,GAAG;EACvE,gBAAgB;EACjB;;AAGH,SAAgB,wBAAwB,oBAAsD;CAC5F,MAAM,QAAQ,mBAAmB,KAAK,mBAAmB;AAEzD,KAAI,CAAC,MACH,OAAM,IAAI,MAAM,yBAAyB,qBAAqB;CAGhE,MAAM,GAAG,aAAa,cAAc,sBAAsB,wBAAwB;AAElF,QAAO;EACL;EACA;EACA,iBAAiB,GAAG,qBAAqB,GAAG;EAC5C,sBAAsB,OAAO,SAAS,qBAAqB;EAC3D,sBAAsB,OAAO,SAAS,qBAAqB;EAC3D,aAAa,GAAG,YAAY,GAAG,aAAa,GAAG,qBAAqB,GAAG;EACxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCH,SAAgB,mCACd,qBACA,qBACA,EAAE,kCAAkC,SAAwD,EAAE,EAC9F;CACA,MAAM,sBAAsB,kCACxB,0BAA0B,oBAAoB,YAAY,GAC1D,oBAAoB;CAExB,MAAM,qBAAqB,oBAAoB,gBAAgB;CAC/D,MAAM,sBAAsB,oBAAoB,iBAAiB,oBAAoB;CACrF,MAAM,sBAAsB,oBAAoB,yBAAyB,oBAAoB;AAG7F,QAAO,sBAAsB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCtD,SAAgB,4BACd,qBACA,qBACA,EAAE,kCAAkC,SAAwD,EAAE,EAC9F;CACA,MAAM,sBAAsB,kCACxB,0BAA0B,oBAAoB,YAAY,GAC1D,oBAAoB;CAExB,MAAM,qBAAqB,oBAAoB,gBAAgB;CAC/D,MAAM,sBAAsB,oBAAoB,iBAAiB,oBAAoB;CACrF,MAAM,sBAAsB,oBAAoB,yBAAyB,oBAAoB;CAC7F,MAAM,qBAAqB,oBAAoB,gBAAgB,oBAAoB;AAGnF,QAAO,sBAAsB,uBAAuB,uBAAuB;;AAG7E,SAAgB,qBACd,cACA,aACS;AACT,QAAO,4BAA4B,aAAa,MAAM,YAAY;;;;;;AAOpE,SAAgB,mBACd,aACA,mBACmB;AACnB,QAAO,WACL;EACE,MAAM;EACN,aAAa,CAAC,YAAY;EAC1B,WAAW;GACT,WAAW,OAAO,SAAuC;IACvD,MAAM,CAAC,uBAAuB,KAAK;AAGnC,QAAI,OAAO,UAAU,SACnB,QAAO;AAIT,WAAO,4BADqB,iBAAiB,MAAM,EACK,oBAAoB;;GAE9E,gBAAgB,cACb,eACC,GAAG,WAAW,uFAChB,kBACD;GACF;EACF,EACD,kBACD;;AAGH,SAAgB,mCAAmC,SAA4D;AAC7G,SAAQ,WAAW,0BAA0B,QAAQ,SAAmB;;AAG1E,SAAgB,iDAAiD,SAAkC;AACjG,SAAQ,WAAW,wCAAwC,QAAQ,SAAmB;;AAGxF,SAAgB,0BAA0B,aAAqB;CAC7D,MAAM,eAAe;CACrB,MAAM,gBAAgB;AAEtB,KAAI,YAAY,WAAW,aAAa,CACtC,QAAO,YAAY,QAAQ,cAAc,cAAc;AAGzD,QAAO;;AAGT,SAAgB,wCAAwC,aAAqB;CAC3E,MAAM,eAAe;CACrB,MAAM,gBAAgB;AAEtB,KAAI,YAAY,WAAW,cAAc,CACvC,QAAO,YAAY,QAAQ,eAAe,aAAa;AAGzD,QAAO"}
1	+ {"version":3,"file":"messageType.mjs","names":[],"sources":["../../src/util/messageType.ts"],"sourcesContent":["import type { ValidationArguments, ValidationOptions } from 'class-validator'\nimport { buildMessage, ValidateBy } from 'class-validator'\nimport type { DidCommPlaintextMessage } from '../types'\n\nconst PROTOCOL_URI_REGEX = /^(.+)\\/([^/\\\\]+)\\/(\\d+).(\\d+)$/\nconst MESSAGE_TYPE_REGEX = /^(.+)\\/([^/\\\\]+)\\/(\\d+).(\\d+)\\/([^/\\\\]+)$/\n\nexport interface ParsedDidCommProtocolUri {\n /*\n Version of the protocol\n \n @example 1.0\n /\n protocolVersion: string\n\n /\n Major version of the protocol\n \n @example 1\n /\n protocolMajorVersion: number\n\n /\n Minor version of the protocol\n \n @example 0\n /\n protocolMinorVersion: number\n\n /\n Name of the protocol\n \n @example connections\n /\n protocolName: string\n\n /\n Document uri of the message.\n \n @example https://didcomm.org\n /\n documentUri: string\n\n /\n Uri identifier of the protocol. Includes the\n * documentUri, protocolName and protocolVersion.\n * Useful when working with feature discovery\n \n @example https://didcomm.org/connections/1.0\n /\n protocolUri: string\n}\n\nexport interface ParsedMessageType extends ParsedDidCommProtocolUri {\n /\n Message name\n \n @example request\n /\n messageName: string\n\n /\n Uri identifier of the message. Includes all parts\n * or the message type.\n \n @example https://didcomm.org/connections/1.0/request\n /\n messageTypeUri: string\n}\n\n// TODO: rename to `parseDidCommMessageType` and `DidCommParsedProtocolUri`\n// in the future\nexport function parseMessageType(messageType: string): ParsedMessageType {\n const match = MESSAGE_TYPE_REGEX.exec(messageType)\n\n if (!match) {\n throw new Error(`Invalid message type: ${messageType}`)\n }\n\n const [, documentUri, protocolName, protocolVersionMajor, protocolVersionMinor, messageName] = match\n\n return {\n documentUri,\n protocolName,\n protocolVersion: `${protocolVersionMajor}.${protocolVersionMinor}`,\n protocolMajorVersion: Number.parseInt(protocolVersionMajor, 10),\n protocolMinorVersion: Number.parseInt(protocolVersionMinor, 10),\n messageName,\n protocolUri: `${documentUri}/${protocolName}/${protocolVersionMajor}.${protocolVersionMinor}`,\n messageTypeUri: messageType,\n }\n}\n\nexport function parseDidCommProtocolUri(didCommProtocolUri: string): ParsedDidCommProtocolUri {\n const match = PROTOCOL_URI_REGEX.exec(didCommProtocolUri)\n\n if (!match) {\n throw new Error(`Invalid protocol uri: ${didCommProtocolUri}`)\n }\n\n const [, documentUri, protocolName, protocolVersionMajor, protocolVersionMinor] = match\n\n return {\n documentUri,\n protocolName,\n protocolVersion: `${protocolVersionMajor}.${protocolVersionMinor}`,\n protocolMajorVersion: Number.parseInt(protocolVersionMajor, 10),\n protocolMinorVersion: Number.parseInt(protocolVersionMinor, 10),\n protocolUri: `${documentUri}/${protocolName}/${protocolVersionMajor}.${protocolVersionMinor}`,\n }\n}\n\n/\n Check whether the incoming didcomm protocol uri is a protocol uri that can be handled by comparing it to the expected didcomm protocol uri.\n * In this case the expected protocol uri is e.g. the handshake protocol supported (https://didcomm.org/connections/1.0), and the incoming protocol uri\n * is the uri that is parsed from the incoming out of band invitation handshake_protocols.\n \n The method will make sure the following fields are equal:\n * - documentUri\n * - protocolName\n * - majorVersion\n \n If allowLegacyDidSovPrefixMismatch is true (default) it will allow for the case where the incoming protocol uri still has the legacy\n * did:sov:BzCbsNYhMrjHiqZDTUASHg;spec did prefix, but the expected message type does not. This only works for incoming messages with a prefix\n * of did:sov:BzCbsNYhMrjHiqZDTUASHg;spec and the expected message type having a prefix value of https:/didcomm.org\n \n @example\n * const incomingProtocolUri = parseDidCommProtocolUri('https://didcomm.org/connections/1.0')\n * const expectedProtocolUri = parseDidCommProtocolUri('https://didcomm.org/connections/1.4')\n \n // Returns true because the incoming protocol uri is equal to the expected protocol uri, except for\n * // the minor version, which is lower\n * const isIncomingProtocolUriSupported = supportsIncomingDidCommProtocolUri(incomingProtocolUri, expectedProtocolUri)\n \n @example\n * const incomingProtocolUri = parseDidCommProtocolUri('did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/connections/1.0')\n * const expectedProtocolUri = parseDidCommProtocolUri('https://didcomm.org/connections/1.0')\n \n // Returns true because the incoming protocol uri is equal to the expected protocol uri, except for\n * // the legacy did sov prefix.\n * const isIncomingProtocolUriSupported = supportsIncomingDidCommProtocolUri(incomingProtocolUri, expectedProtocolUri)\n /\nexport function supportsIncomingDidCommProtocolUri(\n incomingProtocolUri: ParsedDidCommProtocolUri,\n expectedProtocolUri: ParsedDidCommProtocolUri,\n { allowLegacyDidSovPrefixMismatch = true }: { allowLegacyDidSovPrefixMismatch?: boolean } = {}\n) {\n const incomingDocumentUri = allowLegacyDidSovPrefixMismatch\n ? replaceLegacyDidSovPrefix(incomingProtocolUri.documentUri)\n : incomingProtocolUri.documentUri\n\n const documentUriMatches = expectedProtocolUri.documentUri === incomingDocumentUri\n const protocolNameMatches = expectedProtocolUri.protocolName === incomingProtocolUri.protocolName\n const majorVersionMatches = expectedProtocolUri.protocolMajorVersion === incomingProtocolUri.protocolMajorVersion\n\n // Everything besides the minor version must match\n return documentUriMatches && protocolNameMatches && majorVersionMatches\n}\n\n/\n Check whether the incoming message type is a message type that can be handled by comparing it to the expected message type.\n * In this case the expected message type is e.g. the type declared on an agent message class, and the incoming message type is the type\n * that is parsed from the incoming JSON.\n \n The method will make sure the following fields are equal:\n * - documentUri\n * - protocolName\n * - majorVersion\n * - messageName\n \n If allowLegacyDidSovPrefixMismatch is true (default) it will allow for the case where the incoming message type still has the legacy\n * did:sov:BzCbsNYhMrjHiqZDTUASHg;spec did prefix, but the expected message type does not. This only works for incoming messages with a prefix\n * of did:sov:BzCbsNYhMrjHiqZDTUASHg;spec and the expected message type having a prefix value of https:/didcomm.org\n \n @example\n * const incomingMessageType = parseMessageType('https://didcomm.org/connections/1.0/request')\n * const expectedMessageType = parseMessageType('https://didcomm.org/connections/1.4/request')\n \n // Returns true because the incoming message type is equal to the expected message type, except for\n * // the minor version, which is lower\n * const isIncomingMessageTypeSupported = supportsIncomingMessageType(incomingMessageType, expectedMessageType)\n \n @example\n * const incomingMessageType = parseMessageType('did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/connections/1.0/request')\n * const expectedMessageType = parseMessageType('https://didcomm.org/connections/1.0/request')\n \n // Returns true because the incoming message type is equal to the expected message type, except for\n * // the legacy did sov prefix.\n * const isIncomingMessageTypeSupported = supportsIncomingMessageType(incomingMessageType, expectedMessageType)\n /\nexport function supportsIncomingMessageType(\n incomingMessageType: ParsedMessageType,\n expectedMessageType: ParsedMessageType,\n { allowLegacyDidSovPrefixMismatch = true }: { allowLegacyDidSovPrefixMismatch?: boolean } = {}\n) {\n const incomingDocumentUri = allowLegacyDidSovPrefixMismatch\n ? replaceLegacyDidSovPrefix(incomingMessageType.documentUri)\n : incomingMessageType.documentUri\n\n const documentUriMatches = expectedMessageType.documentUri === incomingDocumentUri\n const protocolNameMatches = expectedMessageType.protocolName === incomingMessageType.protocolName\n const majorVersionMatches = expectedMessageType.protocolMajorVersion === incomingMessageType.protocolMajorVersion\n const messageNameMatches = expectedMessageType.messageName === incomingMessageType.messageName\n\n // Everything besides the minor version must match\n return documentUriMatches && protocolNameMatches && majorVersionMatches && messageNameMatches\n}\n\nexport function canHandleMessageType(\n messageClass: { type: ParsedMessageType },\n messageType: ParsedMessageType\n): boolean {\n return supportsIncomingMessageType(messageClass.type, messageType)\n}\n\n/\n class-validator decorator to check if the string message type value matches with the\n * expected message type. This uses {@link supportsIncomingMessageType}.\n */\nexport function IsValidMessageType(\n messageType: ParsedMessageType,\n validationOptions?: ValidationOptions\n): PropertyDecorator {\n return ValidateBy(\n {\n name: 'isValidMessageType',\n constraints: [messageType],\n validator: {\n validate: (value, args: ValidationArguments): boolean => {\n const [expectedMessageType] = args.constraints as [ParsedMessageType]\n\n // Type must be string\n if (typeof value !== 'string') {\n return false\n }\n\n const incomingMessageType = parseMessageType(value)\n return supportsIncomingMessageType(incomingMessageType, expectedMessageType)\n },\n defaultMessage: buildMessage(\n (eachPrefix) =>\n `${eachPrefix}$property does not match the expected message type (only minor version may be lower)`,\n validationOptions\n ),\n },\n },\n validationOptions\n )\n}\n\nexport function replaceLegacyDidSovPrefixOnMessage(message: DidCommPlaintextMessage \| Record<string, unknown>) {\n message['@type'] = replaceLegacyDidSovPrefix(message['@type'] as string)\n}\n\nexport function replaceNewDidCommPrefixWithLegacyDidSovOnMessage(message: Record<string, unknown>) {\n message['@type'] = replaceNewDidCommPrefixWithLegacyDidSov(message['@type'] as string)\n}\n\nexport function replaceLegacyDidSovPrefix(messageType: string) {\n const didSovPrefix = 'did:sov:BzCbsNYhMrjHiqZDTUASHg;spec'\n const didCommPrefix = 'https://didcomm.org'\n\n if (messageType.startsWith(didSovPrefix)) {\n return messageType.replace(didSovPrefix, didCommPrefix)\n }\n\n return messageType\n}\n\nexport function replaceNewDidCommPrefixWithLegacyDidSov(messageType: string) {\n const didSovPrefix = 'did:sov:BzCbsNYhMrjHiqZDTUASHg;spec'\n const didCommPrefix = 'https://didcomm.org'\n\n if (messageType.startsWith(didCommPrefix)) {\n return messageType.replace(didCommPrefix, didSovPrefix)\n }\n\n return messageType\n}\n"],"mappings":";;;AAIA,MAAM,qBAAqB;AAC3B,MAAM,qBAAqB;AAmE3B,SAAgB,iBAAiB,aAAwC;CACvE,MAAM,QAAQ,mBAAmB,KAAK,YAAY;AAElD,KAAI,CAAC,MACH,OAAM,IAAI,MAAM,yBAAyB,cAAc;CAGzD,MAAM,GAAG,aAAa,cAAc,sBAAsB,sBAAsB,eAAe;AAE/F,QAAO;EACL;EACA;EACA,iBAAiB,GAAG,qBAAqB,GAAG;EAC5C,sBAAsB,OAAO,SAAS,sBAAsB,GAAG;EAC/D,sBAAsB,OAAO,SAAS,sBAAsB,GAAG;EAC/D;EACA,aAAa,GAAG,YAAY,GAAG,aAAa,GAAG,qBAAqB,GAAG;EACvE,gBAAgB;EACjB;;AAGH,SAAgB,wBAAwB,oBAAsD;CAC5F,MAAM,QAAQ,mBAAmB,KAAK,mBAAmB;AAEzD,KAAI,CAAC,MACH,OAAM,IAAI,MAAM,yBAAyB,qBAAqB;CAGhE,MAAM,GAAG,aAAa,cAAc,sBAAsB,wBAAwB;AAElF,QAAO;EACL;EACA;EACA,iBAAiB,GAAG,qBAAqB,GAAG;EAC5C,sBAAsB,OAAO,SAAS,sBAAsB,GAAG;EAC/D,sBAAsB,OAAO,SAAS,sBAAsB,GAAG;EAC/D,aAAa,GAAG,YAAY,GAAG,aAAa,GAAG,qBAAqB,GAAG;EACxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCH,SAAgB,mCACd,qBACA,qBACA,EAAE,kCAAkC,SAAwD,EAAE,EAC9F;CACA,MAAM,sBAAsB,kCACxB,0BAA0B,oBAAoB,YAAY,GAC1D,oBAAoB;CAExB,MAAM,qBAAqB,oBAAoB,gBAAgB;CAC/D,MAAM,sBAAsB,oBAAoB,iBAAiB,oBAAoB;CACrF,MAAM,sBAAsB,oBAAoB,yBAAyB,oBAAoB;AAG7F,QAAO,sBAAsB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCtD,SAAgB,4BACd,qBACA,qBACA,EAAE,kCAAkC,SAAwD,EAAE,EAC9F;CACA,MAAM,sBAAsB,kCACxB,0BAA0B,oBAAoB,YAAY,GAC1D,oBAAoB;CAExB,MAAM,qBAAqB,oBAAoB,gBAAgB;CAC/D,MAAM,sBAAsB,oBAAoB,iBAAiB,oBAAoB;CACrF,MAAM,sBAAsB,oBAAoB,yBAAyB,oBAAoB;CAC7F,MAAM,qBAAqB,oBAAoB,gBAAgB,oBAAoB;AAGnF,QAAO,sBAAsB,uBAAuB,uBAAuB;;AAG7E,SAAgB,qBACd,cACA,aACS;AACT,QAAO,4BAA4B,aAAa,MAAM,YAAY;;;;;;AAOpE,SAAgB,mBACd,aACA,mBACmB;AACnB,QAAO,WACL;EACE,MAAM;EACN,aAAa,CAAC,YAAY;EAC1B,WAAW;GACT,WAAW,OAAO,SAAuC;IACvD,MAAM,CAAC,uBAAuB,KAAK;AAGnC,QAAI,OAAO,UAAU,SACnB,QAAO;AAIT,WAAO,4BADqB,iBAAiB,MAAM,EACK,oBAAoB;;GAE9E,gBAAgB,cACb,eACC,GAAG,WAAW,uFAChB,kBACD;GACF;EACF,EACD,kBACD;;AAGH,SAAgB,mCAAmC,SAA4D;AAC7G,SAAQ,WAAW,0BAA0B,QAAQ,SAAmB;;AAG1E,SAAgB,iDAAiD,SAAkC;AACjG,SAAQ,WAAW,wCAAwC,QAAQ,SAAmB;;AAGxF,SAAgB,0BAA0B,aAAqB;CAC7D,MAAM,eAAe;CACrB,MAAM,gBAAgB;AAEtB,KAAI,YAAY,WAAW,aAAa,CACtC,QAAO,YAAY,QAAQ,cAAc,cAAc;AAGzD,QAAO;;AAGT,SAAgB,wCAAwC,aAAqB;CAC3E,MAAM,eAAe;CACrB,MAAM,gBAAgB;AAEtB,KAAI,YAAY,WAAW,cAAc,CACvC,QAAO,YAAY,QAAQ,eAAe,aAAa;AAGzD,QAAO"}

package/build/util/parseInvitation.d.mts CHANGED Viewed

@@ -3,6 +3,13 @@ import { AgentDependencies } from "@credo-ts/core";
 //#region src/util/parseInvitation.d.ts
+/**
+ * Parses a JSON containing an invitation message and returns an DidCommOutOfBandInvitation instance
+ *
+ * @param invitationJson JSON object containing message
+ * @returns DidCommOutOfBandInvitation
+ */
+declare const parseInvitationJson: (invitationJson: Record<string, unknown>) => DidCommOutOfBandInvitation;
 /**
  * Parses URL containing encoded invitation and returns invitation message.
  *
@@ -24,5 +31,5 @@ declare const oobInvitationFromShortUrl: (response: Response) => Promise<DidComm
  */
 declare const parseInvitationShortUrl: (invitationUrl: string, dependencies: AgentDependencies) => Promise<DidCommOutOfBandInvitation>;
 //#endregion
-export { oobInvitationFromShortUrl, parseInvitationShortUrl, parseInvitationUrl };
+export { oobInvitationFromShortUrl, parseInvitationJson, parseInvitationShortUrl, parseInvitationUrl };
 //# sourceMappingURL=parseInvitation.d.mts.map

package/build/util/parseInvitation.d.mts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"parseInvitation.d.mts","names":[],"sources":["../../src/util/parseInvitation.ts"],"sourcesContent":[],"mappings":";;;;;;;~~AA6IA;;;;;AAGU~~,~~cAvEG~~,~~kBAuEH~~,EAAA,CAAA,aAAA,EAAA,MAAA,EAAA,~~GAvEiD~~,~~0BAuEjD~~;~~cAxDG~~,~~sCAA6C~~,~~aAAW~~,~~QAAQ~~;;;;;;;;;;;~~cAqDhE~~,+DAEG,sBACb,QAAQ"}
1	+ {"version":3,"file":"parseInvitation.d.mts","names":[],"sources":["../../src/util/parseInvitation.ts"],"sourcesContent":[],"mappings":";;;;;;;AAsCA;;;;AA0BC,cA1BY,mBA0BZ,EAAA,CAAA,cAAA,EA1BmD,MA0BnD,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,GA1B6E,0BA0B7E;AASD;AAeA;;;;;;AAsDa,cArEA,kBA2FZ,EAAA,CAAA,aAAA,EAAA,MAAA,EAAA,GA3F0D,0BA2F1D;AAAA,cA5EY,yBA4EZ,EAAA,CAAA,QAAA,EA5EyD,QA4EzD,EAAA,GA5EoE,OA4EpE,CA5E4E,0BA4E5E,CAAA;;;;;;;;;;;cAtBY,+DAEG,sBACb,QAAQ"}

package/build/util/parseInvitation.d.ts CHANGED Viewed

@@ -3,6 +3,13 @@ import { AgentDependencies } from "@credo-ts/core";
 //#region src/util/parseInvitation.d.ts
+/**
+ * Parses a JSON containing an invitation message and returns an DidCommOutOfBandInvitation instance
+ *
+ * @param invitationJson JSON object containing message
+ * @returns DidCommOutOfBandInvitation
+ */
+declare const parseInvitationJson: (invitationJson: Record<string, unknown>) => DidCommOutOfBandInvitation;
 /**
  * Parses URL containing encoded invitation and returns invitation message.
  *
@@ -24,5 +31,5 @@ declare const oobInvitationFromShortUrl: (response: Response) => Promise<DidComm
  */
 declare const parseInvitationShortUrl: (invitationUrl: string, dependencies: AgentDependencies) => Promise<DidCommOutOfBandInvitation>;
 //#endregion
-export { oobInvitationFromShortUrl, parseInvitationShortUrl, parseInvitationUrl };
+export { oobInvitationFromShortUrl, parseInvitationJson, parseInvitationShortUrl, parseInvitationUrl };
 //# sourceMappingURL=parseInvitation.d.ts.map

package/build/util/parseInvitation.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"parseInvitation.d.ts","names":[],"sources":["../../src/util/parseInvitation.ts"],"sourcesContent":[],"mappings":";;;;;;;~~AA6IA;;;;;AAGU~~,~~cAvEG~~,~~kBAuEH~~,EAAA,CAAA,aAAA,EAAA,MAAA,EAAA,~~GAvEiD~~,~~0BAuEjD~~;~~cAxDG~~,~~sCAA6C~~,~~aAAW~~,~~QAAQ~~;;;;;;;;;;;~~cAqDhE~~,+DAEG,sBACb,QAAQ"}
1	+ {"version":3,"file":"parseInvitation.d.ts","names":[],"sources":["../../src/util/parseInvitation.ts"],"sourcesContent":[],"mappings":";;;;;;;AAsCA;;;;AA0BC,cA1BY,mBA0BZ,EAAA,CAAA,cAAA,EA1BmD,MA0BnD,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,GA1B6E,0BA0B7E;AASD;AAeA;;;;;;AAsDa,cArEA,kBA2FZ,EAAA,CAAA,aAAA,EAAA,MAAA,EAAA,GA3F0D,0BA2F1D;AAAA,cA5EY,yBA4EZ,EAAA,CAAA,QAAA,EA5EyD,QA4EzD,EAAA,GA5EoE,OA4EpE,CA5E4E,0BA4E5E,CAAA;;;;;;;;;;;cAtBY,+DAEG,sBACb,QAAQ"}