@0xpolygonid/js-sdk 1.9.4 → 1.10.1

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.9.4",
+  "version": "1.10.1",
   "description": "SDK to work with Polygon ID",
   "main": "dist/node/cjs/index.js",
   "module": "dist/node/esm/index.js",
@@ -34,7 +34,9 @@
     "tsc:declaration:watch": "tsc --watch --module commonjs --emitDeclarationOnly",
     "test": "env TS_NODE_COMPILER_OPTIONS='{\"strict\": false, \"module\": \"CommonJS\"}' mocha",
     "lint": "eslint --fix --ext .ts src/** tests/**",
-    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\""
+    "lint:check": "eslint --ext .ts src/** tests/**",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "format:check": "prettier \"src/**/*.ts\" \"tests/**/*.ts\" --check"
   },
   "repository": {
     "type": "git",
@@ -85,11 +87,11 @@
     "typescript": "^4.8.4"
   },
   "peerDependencies": {
-    "@iden3/js-crypto": "1.0.3",
-    "@iden3/js-iden3-core": "1.2.1",
-    "@iden3/js-jsonld-merklization": "1.1.2",
-    "@iden3/js-jwz": "1.3.0",
-    "@iden3/js-merkletree": "1.1.2",
+    "@iden3/js-crypto": "1.1.0",
+    "@iden3/js-iden3-core": "1.3.1",
+    "@iden3/js-jsonld-merklization": "1.2.0",
+    "@iden3/js-jwz": "1.4.0",
+    "@iden3/js-merkletree": "1.2.0",
     "ffjavascript": "0.2.63",
     "rfc4648": "1.5.3",
     "snarkjs": "0.7.3"
@@ -121,6 +123,6 @@
     ]
   },
   "engines": {
-    "node": ">=18.16.0"
+    "node": ">=20.11.0"
   }
 }