@0xpolygonid/js-sdk 1.10.0 → 1.10.1

package/dist/node/cjs/iden3comm/constants.js

@@ -35,7 +35,11 @@ exports.PROTOCOL_MESSAGE_TYPE = Object.freeze({
     // ContractInvokeRequestMessageType is type for request of contract invoke request
     CONTRACT_INVOKE_REQUEST_MESSAGE_TYPE: IDEN3_PROTOCOL + 'proofs/1.0/contract-invoke-request',
     // CredentialOnchainOfferMessageType is type of message with credential onchain offering
-    CREDENTIAL_ONCHAIN_OFFER_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/onchain-offer'
+    CREDENTIAL_ONCHAIN_OFFER_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/onchain-offer',
+    // ProposalRequestMessageType is type for proposal-request message
+    PROPOSAL_REQUEST_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/0.1/proposal-request',
+    // ProposalMessageType is type for proposal message
+    PROPOSAL_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/0.1/proposal'
 });
 /**
  * Media types for iden3 comm communication protocol

package/dist/node/cjs/iden3comm/handlers/credential-proposal.js

@@ -0,0 +1,213 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CredentialProposalHandler = exports.createProposal = exports.createProposalRequest = void 0;
+const constants_1 = require("../constants");
+const constants_2 = require("../constants");
+const js_iden3_core_1 = require("@iden3/js-iden3-core");
+const uuid = __importStar(require("uuid"));
+const js_jwz_1 = require("@iden3/js-jwz");
+const utils_1 = require("../../utils");
+/**
+ * @beta
+ * createProposalRequest is a function to create protocol proposal-request protocol message
+ * @param {DID} sender - sender did
+ * @param {DID} receiver - receiver did
+ * @param {ProposalRequestCreationOptions} opts - creation options
+ * @returns `Promise<ProposalRequestMessage>`
+ */
+function createProposalRequest(sender, receiver, opts) {
+    const uuidv4 = uuid.v4();
+    const request = {
+        id: uuidv4,
+        thid: uuidv4,
+        from: sender.string(),
+        to: receiver.string(),
+        typ: constants_2.MediaType.PlainMessage,
+        type: constants_1.PROTOCOL_MESSAGE_TYPE.PROPOSAL_REQUEST_MESSAGE_TYPE,
+        body: opts
+    };
+    return request;
+}
+exports.createProposalRequest = createProposalRequest;
+/**
+ * @beta
+ * createProposal is a function to create protocol proposal protocol message
+ * @param {DID} sender - sender did
+ * @param {DID} receiver - receiver did
+ * @param {Proposal[]} proposals - proposals
+ * @returns `Promise<ProposalRequestMessage>`
+ */
+function createProposal(sender, receiver, proposals) {
+    const uuidv4 = uuid.v4();
+    const request = {
+        id: uuidv4,
+        thid: uuidv4,
+        from: sender.string(),
+        to: receiver.string(),
+        typ: constants_2.MediaType.PlainMessage,
+        type: constants_1.PROTOCOL_MESSAGE_TYPE.PROPOSAL_MESSAGE_TYPE,
+        body: {
+            proposals: proposals || []
+        }
+    };
+    return request;
+}
+exports.createProposal = createProposal;
+/**
+ *
+ * Allows to process ProposalRequest protocol message
+ * @beta
+ * @class CredentialProposalHandler
+ * @implements implements ICredentialProposalHandler interface
+ */
+class CredentialProposalHandler {
+    /**
+     * @beta Creates an instance of CredentialProposalHandler.
+     * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
+     * @param {IIdentityWallet} _identityWallet - identity wallet
+     * @param {CredentialProposalHandlerParams} _params - credential proposal handler params
+     *
+     */
+    constructor(_packerMgr, _identityWallet, _params) {
+        this._packerMgr = _packerMgr;
+        this._identityWallet = _identityWallet;
+        this._params = _params;
+    }
+    /**
+     * @inheritdoc ICredentialProposalHandler#parseProposalRequest
+     */
+    async parseProposalRequest(request) {
+        const { unpackedMessage: message } = await this._packerMgr.unpack(request);
+        const proposalRequest = message;
+        if (message.type !== constants_1.PROTOCOL_MESSAGE_TYPE.PROPOSAL_REQUEST_MESSAGE_TYPE) {
+            throw new Error('Invalid media type');
+        }
+        return proposalRequest;
+    }
+    /**
+     * @inheritdoc ICredentialProposalHandler#handleProposalRequest
+     */
+    async handleProposalRequest(request, 
+    //eslint-disable-next-line @typescript-eslint/no-unused-vars
+    opts) {
+        if (this._params.packerParams.mediaType === constants_2.MediaType.SignedMessage &&
+            !this._params.packerParams.packerOptions) {
+            throw new Error(`jws packer options are required for ${constants_2.MediaType.SignedMessage}`);
+        }
+        const proposalRequest = await this.parseProposalRequest(request);
+        if (!proposalRequest.to) {
+            throw new Error(`failed request. empty 'to' field`);
+        }
+        if (!proposalRequest.from) {
+            throw new Error(`failed request. empty 'from' field`);
+        }
+        if (!proposalRequest.body?.credentials?.length) {
+            throw new Error(`failed request. no 'credentials' in body`);
+        }
+        const senderDID = js_iden3_core_1.DID.parse(proposalRequest.from);
+        let credOfferMessage = undefined;
+        let proposalMessage = undefined;
+        for (let i = 0; i < proposalRequest.body.credentials.length; i++) {
+            const cred = proposalRequest.body.credentials[i];
+            // check if there is credentials in the wallet
+            let credsFromWallet = [];
+            try {
+                credsFromWallet = await this._identityWallet.findOwnedCredentialsByDID(senderDID, {
+                    type: cred.type,
+                    context: cred.context
+                });
+            }
+            catch (e) {
+                if (e.message !== 'no credential satisfied query') {
+                    throw e;
+                }
+            }
+            if (credsFromWallet.length) {
+                const guid = uuid.v4();
+                if (!credOfferMessage) {
+                    credOfferMessage = {
+                        id: guid,
+                        typ: this._params.packerParams.mediaType,
+                        type: constants_1.PROTOCOL_MESSAGE_TYPE.CREDENTIAL_OFFER_MESSAGE_TYPE,
+                        thid: proposalRequest.thid ?? guid,
+                        body: {
+                            url: this._params.agentUrl,
+                            credentials: []
+                        },
+                        from: proposalRequest.to,
+                        to: proposalRequest.from
+                    };
+                }
+                credOfferMessage.body.credentials.push(...credsFromWallet.map((c) => ({
+                    id: c.id,
+                    description: ''
+                })));
+                continue;
+            }
+            // credential not found in the wallet, prepare proposal protocol message
+            const proposal = await this._params.proposalResolverFn(cred.context, cred.type);
+            if (!proposal) {
+                throw new Error(`can't resolve Proposal for type: ${cred.type}, context: ${cred.context}`);
+            }
+            if (!proposalMessage) {
+                const guid = uuid.v4();
+                proposalMessage = {
+                    id: guid,
+                    typ: this._params.packerParams.mediaType,
+                    type: constants_1.PROTOCOL_MESSAGE_TYPE.PROPOSAL_MESSAGE_TYPE,
+                    thid: proposalRequest.thid ?? guid,
+                    body: {
+                        proposals: []
+                    },
+                    from: proposalRequest.to,
+                    to: proposalRequest.from
+                };
+            }
+            proposalMessage.body?.proposals.push(proposal);
+        }
+        // if there is credentials in the wallet, return offer protocol message, otherwise proposal
+        const response = utils_1.byteEncoder.encode(JSON.stringify(proposalMessage ?? credOfferMessage));
+        const packerOpts = this._params.packerParams.mediaType === constants_2.MediaType.SignedMessage
+            ? this._params.packerParams.packerOptions
+            : {
+                provingMethodAlg: js_jwz_1.proving.provingMethodGroth16AuthV2Instance.methodAlg
+            };
+        return this._packerMgr.pack(this._params.packerParams.mediaType, response, {
+            senderDID,
+            ...packerOpts
+        });
+    }
+    /**
+     * @inheritdoc ICredentialProposalHandler#handleProposal
+     */
+    async handleProposal(proposal, opts) {
+        if (opts?.proposalRequest && opts.proposalRequest.from !== proposal.to) {
+            throw new Error(`sender of the request is not a target of response - expected ${opts.proposalRequest.from}, given ${proposal.to}`);
+        }
+        return { proposal };
+    }
+}
+exports.CredentialProposalHandler = CredentialProposalHandler;

package/dist/node/cjs/iden3comm/handlers/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./contract-request"), exports);
 __exportStar(require("./refresh"), exports);
 __exportStar(require("./revocation-status"), exports);
 __exportStar(require("./common"), exports);
+__exportStar(require("./credential-proposal"), exports);

package/dist/node/cjs/iden3comm/types/index.js

@@ -20,5 +20,6 @@ __exportStar(require("./protocol/messages"), exports);
 __exportStar(require("./protocol/proof"), exports);
 __exportStar(require("./protocol/revocation"), exports);
 __exportStar(require("./protocol/contract-request"), exports);
+__exportStar(require("./protocol/proposal-request"), exports);
 __exportStar(require("./packer"), exports);
 __exportStar(require("./packageManager"), exports);

package/dist/node/cjs/iden3comm/types/protocol/proposal-request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/node/esm/iden3comm/constants.js

@@ -32,7 +32,11 @@ export const PROTOCOL_MESSAGE_TYPE = Object.freeze({
     // ContractInvokeRequestMessageType is type for request of contract invoke request
     CONTRACT_INVOKE_REQUEST_MESSAGE_TYPE: IDEN3_PROTOCOL + 'proofs/1.0/contract-invoke-request',
     // CredentialOnchainOfferMessageType is type of message with credential onchain offering
-    CREDENTIAL_ONCHAIN_OFFER_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/onchain-offer'
+    CREDENTIAL_ONCHAIN_OFFER_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/onchain-offer',
+    // ProposalRequestMessageType is type for proposal-request message
+    PROPOSAL_REQUEST_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/0.1/proposal-request',
+    // ProposalMessageType is type for proposal message
+    PROPOSAL_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/0.1/proposal'
 });
 /**
  * Media types for iden3 comm communication protocol

package/dist/node/esm/iden3comm/handlers/credential-proposal.js

@@ -0,0 +1,184 @@
+import { PROTOCOL_MESSAGE_TYPE } from '../constants';
+import { MediaType } from '../constants';
+import { DID } from '@iden3/js-iden3-core';
+import * as uuid from 'uuid';
+import { proving } from '@iden3/js-jwz';
+import { byteEncoder } from '../../utils';
+/**
+ * @beta
+ * createProposalRequest is a function to create protocol proposal-request protocol message
+ * @param {DID} sender - sender did
+ * @param {DID} receiver - receiver did
+ * @param {ProposalRequestCreationOptions} opts - creation options
+ * @returns `Promise<ProposalRequestMessage>`
+ */
+export function createProposalRequest(sender, receiver, opts) {
+    const uuidv4 = uuid.v4();
+    const request = {
+        id: uuidv4,
+        thid: uuidv4,
+        from: sender.string(),
+        to: receiver.string(),
+        typ: MediaType.PlainMessage,
+        type: PROTOCOL_MESSAGE_TYPE.PROPOSAL_REQUEST_MESSAGE_TYPE,
+        body: opts
+    };
+    return request;
+}
+/**
+ * @beta
+ * createProposal is a function to create protocol proposal protocol message
+ * @param {DID} sender - sender did
+ * @param {DID} receiver - receiver did
+ * @param {Proposal[]} proposals - proposals
+ * @returns `Promise<ProposalRequestMessage>`
+ */
+export function createProposal(sender, receiver, proposals) {
+    const uuidv4 = uuid.v4();
+    const request = {
+        id: uuidv4,
+        thid: uuidv4,
+        from: sender.string(),
+        to: receiver.string(),
+        typ: MediaType.PlainMessage,
+        type: PROTOCOL_MESSAGE_TYPE.PROPOSAL_MESSAGE_TYPE,
+        body: {
+            proposals: proposals || []
+        }
+    };
+    return request;
+}
+/**
+ *
+ * Allows to process ProposalRequest protocol message
+ * @beta
+ * @class CredentialProposalHandler
+ * @implements implements ICredentialProposalHandler interface
+ */
+export class CredentialProposalHandler {
+    /**
+     * @beta Creates an instance of CredentialProposalHandler.
+     * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
+     * @param {IIdentityWallet} _identityWallet - identity wallet
+     * @param {CredentialProposalHandlerParams} _params - credential proposal handler params
+     *
+     */
+    constructor(_packerMgr, _identityWallet, _params) {
+        this._packerMgr = _packerMgr;
+        this._identityWallet = _identityWallet;
+        this._params = _params;
+    }
+    /**
+     * @inheritdoc ICredentialProposalHandler#parseProposalRequest
+     */
+    async parseProposalRequest(request) {
+        const { unpackedMessage: message } = await this._packerMgr.unpack(request);
+        const proposalRequest = message;
+        if (message.type !== PROTOCOL_MESSAGE_TYPE.PROPOSAL_REQUEST_MESSAGE_TYPE) {
+            throw new Error('Invalid media type');
+        }
+        return proposalRequest;
+    }
+    /**
+     * @inheritdoc ICredentialProposalHandler#handleProposalRequest
+     */
+    async handleProposalRequest(request, 
+    //eslint-disable-next-line @typescript-eslint/no-unused-vars
+    opts) {
+        if (this._params.packerParams.mediaType === MediaType.SignedMessage &&
+            !this._params.packerParams.packerOptions) {
+            throw new Error(`jws packer options are required for ${MediaType.SignedMessage}`);
+        }
+        const proposalRequest = await this.parseProposalRequest(request);
+        if (!proposalRequest.to) {
+            throw new Error(`failed request. empty 'to' field`);
+        }
+        if (!proposalRequest.from) {
+            throw new Error(`failed request. empty 'from' field`);
+        }
+        if (!proposalRequest.body?.credentials?.length) {
+            throw new Error(`failed request. no 'credentials' in body`);
+        }
+        const senderDID = DID.parse(proposalRequest.from);
+        let credOfferMessage = undefined;
+        let proposalMessage = undefined;
+        for (let i = 0; i < proposalRequest.body.credentials.length; i++) {
+            const cred = proposalRequest.body.credentials[i];
+            // check if there is credentials in the wallet
+            let credsFromWallet = [];
+            try {
+                credsFromWallet = await this._identityWallet.findOwnedCredentialsByDID(senderDID, {
+                    type: cred.type,
+                    context: cred.context
+                });
+            }
+            catch (e) {
+                if (e.message !== 'no credential satisfied query') {
+                    throw e;
+                }
+            }
+            if (credsFromWallet.length) {
+                const guid = uuid.v4();
+                if (!credOfferMessage) {
+                    credOfferMessage = {
+                        id: guid,
+                        typ: this._params.packerParams.mediaType,
+                        type: PROTOCOL_MESSAGE_TYPE.CREDENTIAL_OFFER_MESSAGE_TYPE,
+                        thid: proposalRequest.thid ?? guid,
+                        body: {
+                            url: this._params.agentUrl,
+                            credentials: []
+                        },
+                        from: proposalRequest.to,
+                        to: proposalRequest.from
+                    };
+                }
+                credOfferMessage.body.credentials.push(...credsFromWallet.map((c) => ({
+                    id: c.id,
+                    description: ''
+                })));
+                continue;
+            }
+            // credential not found in the wallet, prepare proposal protocol message
+            const proposal = await this._params.proposalResolverFn(cred.context, cred.type);
+            if (!proposal) {
+                throw new Error(`can't resolve Proposal for type: ${cred.type}, context: ${cred.context}`);
+            }
+            if (!proposalMessage) {
+                const guid = uuid.v4();
+                proposalMessage = {
+                    id: guid,
+                    typ: this._params.packerParams.mediaType,
+                    type: PROTOCOL_MESSAGE_TYPE.PROPOSAL_MESSAGE_TYPE,
+                    thid: proposalRequest.thid ?? guid,
+                    body: {
+                        proposals: []
+                    },
+                    from: proposalRequest.to,
+                    to: proposalRequest.from
+                };
+            }
+            proposalMessage.body?.proposals.push(proposal);
+        }
+        // if there is credentials in the wallet, return offer protocol message, otherwise proposal
+        const response = byteEncoder.encode(JSON.stringify(proposalMessage ?? credOfferMessage));
+        const packerOpts = this._params.packerParams.mediaType === MediaType.SignedMessage
+            ? this._params.packerParams.packerOptions
+            : {
+                provingMethodAlg: proving.provingMethodGroth16AuthV2Instance.methodAlg
+            };
+        return this._packerMgr.pack(this._params.packerParams.mediaType, response, {
+            senderDID,
+            ...packerOpts
+        });
+    }
+    /**
+     * @inheritdoc ICredentialProposalHandler#handleProposal
+     */
+    async handleProposal(proposal, opts) {
+        if (opts?.proposalRequest && opts.proposalRequest.from !== proposal.to) {
+            throw new Error(`sender of the request is not a target of response - expected ${opts.proposalRequest.from}, given ${proposal.to}`);
+        }
+        return { proposal };
+    }
+}

package/dist/node/esm/iden3comm/handlers/index.js

@@ -4,3 +4,4 @@ export * from './contract-request';
 export * from './refresh';
 export * from './revocation-status';
 export * from './common';
+export * from './credential-proposal';

package/dist/node/esm/iden3comm/types/index.js

@@ -4,5 +4,6 @@ export * from './protocol/messages';
 export * from './protocol/proof';
 export * from './protocol/revocation';
 export * from './protocol/contract-request';
+export * from './protocol/proposal-request';
 export * from './packer';
 export * from './packageManager';

package/dist/node/esm/iden3comm/types/protocol/proposal-request.js

@@ -0,0 +1 @@
+export {};

package/dist/types/iden3comm/constants.d.ts

@@ -17,6 +17,8 @@ export declare const PROTOCOL_MESSAGE_TYPE: Readonly<{
     REVOCATION_STATUS_RESPONSE_MESSAGE_TYPE: string;
     CONTRACT_INVOKE_REQUEST_MESSAGE_TYPE: string;
     CREDENTIAL_ONCHAIN_OFFER_MESSAGE_TYPE: string;
+    PROPOSAL_REQUEST_MESSAGE_TYPE: string;
+    PROPOSAL_MESSAGE_TYPE: string;
 }>;
 /**
  * Media types for iden3 comm communication protocol

package/dist/types/iden3comm/handlers/credential-proposal.d.ts

@@ -0,0 +1,112 @@
+import { IPackageManager, JSONObject, PackerParams } from '../types';
+import { DID } from '@iden3/js-iden3-core';
+import { Proposal, ProposalRequestCredential, ProposalRequestMessage, ProposalMessage } from '../types/protocol/proposal-request';
+import { IIdentityWallet } from '../../identity';
+/** @beta ProposalRequestCreationOptions represents proposal-request creation options */
+export type ProposalRequestCreationOptions = {
+    credentials: ProposalRequestCredential[];
+    metadata?: {
+        type: string;
+        data?: JSONObject;
+    };
+    did_doc?: JSONObject;
+};
+/**
+ * @beta
+ * createProposalRequest is a function to create protocol proposal-request protocol message
+ * @param {DID} sender - sender did
+ * @param {DID} receiver - receiver did
+ * @param {ProposalRequestCreationOptions} opts - creation options
+ * @returns `Promise<ProposalRequestMessage>`
+ */
+export declare function createProposalRequest(sender: DID, receiver: DID, opts: ProposalRequestCreationOptions): ProposalRequestMessage;
+/**
+ * @beta
+ * createProposal is a function to create protocol proposal protocol message
+ * @param {DID} sender - sender did
+ * @param {DID} receiver - receiver did
+ * @param {Proposal[]} proposals - proposals
+ * @returns `Promise<ProposalRequestMessage>`
+ */
+export declare function createProposal(sender: DID, receiver: DID, proposals?: Proposal[]): ProposalMessage;
+/**
+ * @beta
+ * Interface that allows the processing of the proposal-request
+ *
+ * @interface ICredentialProposalHandler
+ */
+export interface ICredentialProposalHandler {
+    /**
+     * @beta
+     * unpacks proposal-request
+     * @param {Uint8Array} request - raw byte message
+     * @returns `Promise<ProposalRequestMessage>`
+     */
+    parseProposalRequest(request: Uint8Array): Promise<ProposalRequestMessage>;
+    /**
+     *  @beta
+     * handle proposal-request
+     * @param {Uint8Array} request - raw byte message
+     * @param {ProposalRequestHandlerOptions} opts - handler options
+     * @returns {Promise<Uint8Array>}` - proposal response message
+     */
+    handleProposalRequest(request: Uint8Array, opts?: ProposalRequestHandlerOptions): Promise<Uint8Array>;
+    /**
+       * @beta
+       * handle proposal protocol message
+       * @param {ProposalMessage} proposal  - proposal message
+       * @param {ProposalHandlerOptions} opts - options
+       * @returns `Promise<{
+        proposal: ProposalMessage;
+      }>`
+       */
+    handleProposal(proposal: ProposalMessage, opts?: ProposalHandlerOptions): Promise<{
+        proposal: ProposalMessage;
+    }>;
+}
+/** @beta ProposalRequestHandlerOptions represents proposal-request handler options */
+export type ProposalRequestHandlerOptions = object;
+/** @beta ProposalHandlerOptions represents proposal handler options */
+export type ProposalHandlerOptions = {
+    proposalRequest?: ProposalRequestMessage;
+};
+/** @beta CredentialProposalHandlerParams represents credential proposal handler params */
+export type CredentialProposalHandlerParams = {
+    agentUrl: string;
+    proposalResolverFn: (context: string, type: string) => Promise<Proposal>;
+    packerParams: PackerParams;
+};
+/**
+ *
+ * Allows to process ProposalRequest protocol message
+ * @beta
+ * @class CredentialProposalHandler
+ * @implements implements ICredentialProposalHandler interface
+ */
+export declare class CredentialProposalHandler implements ICredentialProposalHandler {
+    private readonly _packerMgr;
+    private readonly _identityWallet;
+    private readonly _params;
+    /**
+     * @beta Creates an instance of CredentialProposalHandler.
+     * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
+     * @param {IIdentityWallet} _identityWallet - identity wallet
+     * @param {CredentialProposalHandlerParams} _params - credential proposal handler params
+     *
+     */
+    constructor(_packerMgr: IPackageManager, _identityWallet: IIdentityWallet, _params: CredentialProposalHandlerParams);
+    /**
+     * @inheritdoc ICredentialProposalHandler#parseProposalRequest
+     */
+    parseProposalRequest(request: Uint8Array): Promise<ProposalRequestMessage>;
+    /**
+     * @inheritdoc ICredentialProposalHandler#handleProposalRequest
+     */
+    handleProposalRequest(request: Uint8Array, opts?: ProposalRequestHandlerOptions): Promise<Uint8Array>;
+    /**
+     * @inheritdoc ICredentialProposalHandler#handleProposal
+     */
+    handleProposal(proposal: ProposalMessage, opts?: ProposalHandlerOptions): Promise<{
+        proposal: ProposalMessage;
+    }>;
+}

package/dist/types/iden3comm/handlers/index.d.ts

@@ -4,3 +4,4 @@ export * from './contract-request';
 export * from './refresh';
 export * from './revocation-status';
 export * from './common';
+export * from './credential-proposal';

package/dist/types/iden3comm/types/index.d.ts

@@ -4,5 +4,6 @@ export * from './protocol/messages';
 export * from './protocol/proof';
 export * from './protocol/revocation';
 export * from './protocol/contract-request';
+export * from './protocol/proposal-request';
 export * from './packer';
 export * from './packageManager';

package/dist/types/iden3comm/types/protocol/proposal-request.d.ts

@@ -0,0 +1,35 @@
+import { BasicMessage, JSONObject } from '../';
+/** @beta ProposalRequestMessage is struct the represents proposal-request message */
+export type ProposalRequestMessage = BasicMessage & {
+    body?: ProposalRequestMessageBody;
+};
+/** @beta ProposalRequestMessageBody is struct the represents body for proposal-request */
+export type ProposalRequestMessageBody = {
+    credentials: ProposalRequestCredential[];
+    metadata?: {
+        type: string;
+        data?: JSONObject;
+    };
+    did_doc?: JSONObject;
+};
+/** @beta  ProposalMessage is struct the represents proposal message */
+export type ProposalMessage = BasicMessage & {
+    body?: ProposalMessageBody;
+};
+/** @beta  ProposalMessageBody is struct the represents body for proposal message */
+export type ProposalMessageBody = {
+    proposals: Proposal[];
+};
+/** @beta  ProposalRequestCredential is struct the represents proposal request credential */
+export type ProposalRequestCredential = {
+    type: string;
+    context: string;
+};
+/** @beta Proposal is struct the represents proposal inside proposal protocol message */
+export type Proposal = {
+    credentials?: ProposalRequestCredential[];
+    type: string;
+    url?: string;
+    expiration?: string;
+    description?: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xpolygonid/js-sdk",
-  "version": "1.10.0",
+  "version": "1.10.1",
   "description": "SDK to work with Polygon ID",
   "main": "dist/node/cjs/index.js",
   "module": "dist/node/esm/index.js",