@0xpolygonid/js-sdk 1.7.0 → 1.7.1

package/dist/node/cjs/circuits/comparer.js

@@ -57,8 +57,26 @@ exports.availableTypesOperators = new Map([
     [XSDNS.Integer, allOperations],
     [XSDNS.NonNegativeInteger, allOperations],
     [XSDNS.PositiveInteger, allOperations],
-    [XSDNS.Double, [exports.QueryOperators.$eq, exports.QueryOperators.$ne, exports.QueryOperators.$in, exports.QueryOperators.$nin, exports.QueryOperators.$sd]],
-    [XSDNS.String, [exports.QueryOperators.$eq, exports.QueryOperators.$ne, exports.QueryOperators.$in, exports.QueryOperators.$nin, exports.QueryOperators.$sd]],
+    [
+        XSDNS.Double,
+        [
+            exports.QueryOperators.$eq,
+            exports.QueryOperators.$ne,
+            exports.QueryOperators.$in,
+            exports.QueryOperators.$nin,
+            exports.QueryOperators.$sd
+        ]
+    ],
+    [
+        XSDNS.String,
+        [
+            exports.QueryOperators.$eq,
+            exports.QueryOperators.$ne,
+            exports.QueryOperators.$in,
+            exports.QueryOperators.$nin,
+            exports.QueryOperators.$sd
+        ]
+    ],
     [XSDNS.DateTime, allOperations]
 ]);
 /**

package/dist/node/cjs/circuits/linked-multi-query.js

@@ -28,7 +28,7 @@ class LinkedMultiQueryInputs extends common_1.BaseConfig {
             if (!this.query[i]) {
                 enabled.push(0);
                 claimPathNotExists.push(0);
-                claimPathMtp.push([]);
+                claimPathMtp.push(new Array(this.getMTLevelsClaim()).fill('0'));
                 claimPathMtpNoAux.push('0');
                 claimPathMtpAuxHi.push('0');
                 claimPathMtpAuxHv.push('0');

package/dist/node/cjs/credentials/credential-wallet.js

@@ -76,6 +76,7 @@ class CredentialWallet {
             cr['@context'] = context;
             cr.type = credentialType;
             cr.expirationDate = expirationDate ? new Date(expirationDate * 1000).toISOString() : undefined;
+            cr.refreshService = request.refreshService;
             cr.issuanceDate = new Date().toISOString();
             cr.credentialSubject = credentialSubject;
             cr.issuer = issuer.string();

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

@@ -18,6 +18,8 @@ exports.PROTOCOL_MESSAGE_TYPE = Object.freeze({
     CREDENTIAL_OFFER_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/offer',
     // CredentialIssuanceResponseMessageType is type for message with a credential issuance
     CREDENTIAL_ISSUANCE_RESPONSE_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/issuance-response',
+    // CredentialRefreshMessageType is type for message with a credential issuance
+    CREDENTIAL_REFRESH_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/refresh',
     // DeviceRegistrationRequestMessageType defines device registration request type of the communication protocol
     DEVICE_REGISTRATION_REQUEST_MESSAGE_TYPE: IDEN3_PROTOCOL + 'devices/1.0/registration',
     // MessageFetMessageFetchRequestMessageType defines message fetch request type of the communication protocol.

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

@@ -42,7 +42,7 @@ const js_iden3_core_1 = require("@iden3/js-iden3-core");
  */
 class FetchHandler {
     /**
-     * Creates an instance of AuthHandler.
+     * Creates an instance of FetchHandler.
      * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
      */
     constructor(_packerMgr) {
@@ -55,7 +55,7 @@ class FetchHandler {
      *     offer: Uint8Array; offer - raw offer message
      *     opts
      *   }) options how to fetch credential
-     * @returns `Promise<W3CCredential>`
+     * @returns `Promise<W3CCredential[]>`
      */
     async handleCredentialOffer(offer, opts) {
         if (!opts) {

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

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./auth"), exports);
 __exportStar(require("./fetch"), exports);
 __exportStar(require("./contract-request"), exports);
+__exportStar(require("./refresh"), exports);

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

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RefreshHandler = void 0;
+const constants_1 = require("../constants");
+const constants_2 = require("../constants");
+const verifiable_1 = require("../../verifiable");
+const utils_1 = require("../../utils");
+const js_jwz_1 = require("@iden3/js-jwz");
+const js_iden3_core_1 = require("@iden3/js-iden3-core");
+const circuits_1 = require("../../circuits");
+const crypto_1 = require("crypto");
+/**
+ *
+ * Allows to refresh credential from refresh service and return refreshed credential
+ *
+ * @public
+
+ * @class RefreshHandler
+ * @implements implements RefreshHandler interface
+ */
+class RefreshHandler {
+    /**
+     * Creates an instance of RefreshHandler.
+     * @param {RefreshHandlerOptions} _options - refresh handler options
+     */
+    constructor(_options) {
+        this._options = _options;
+    }
+    async refreshCredential(credential, opts) {
+        if (!credential.refreshService) {
+            throw new Error('refreshService not specified for W3CCredential');
+        }
+        if (credential.refreshService.type !== verifiable_1.RefreshServiceType.Iden3RefreshService2023) {
+            throw new Error(`refresh service type ${credential.refreshService.type} is not supported`);
+        }
+        const otherIdentifier = credential.credentialSubject.id;
+        if (!otherIdentifier) {
+            throw new Error('self credentials do not support refresh');
+        }
+        const senderDID = js_iden3_core_1.DID.parse(otherIdentifier);
+        const zkpParams = {
+            senderDID,
+            provingMethodAlg: new js_jwz_1.ProvingMethodAlg(js_jwz_1.proving.provingMethodGroth16AuthV2Instance.methodAlg.alg, circuits_1.CircuitId.AuthV2)
+        };
+        const refreshMsg = {
+            id: (0, crypto_1.randomUUID)(),
+            typ: constants_1.MediaType.ZKPMessage,
+            type: constants_2.PROTOCOL_MESSAGE_TYPE.CREDENTIAL_REFRESH_MESSAGE_TYPE,
+            thid: (0, crypto_1.randomUUID)(),
+            body: {
+                id: otherIdentifier,
+                reason: opts?.reason ?? 'credential is expired'
+            },
+            from: otherIdentifier,
+            to: credential.issuer
+        };
+        const msgBytes = utils_1.byteEncoder.encode(JSON.stringify(refreshMsg));
+        const jwzToken = await this._options.packageManager.pack(constants_1.MediaType.ZKPMessage, msgBytes, zkpParams);
+        const resp = await fetch(credential.refreshService.id, {
+            method: 'post',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: jwzToken
+        });
+        if (resp.status !== 200) {
+            throw new Error(`could not refresh W3C credential, return status ${resp.status}`);
+        }
+        const respBody = await resp.json();
+        if (!respBody.body?.credential) {
+            throw new Error('no credential in CredentialIssuanceMessage response');
+        }
+        return verifiable_1.W3CCredential.fromJSON(respBody.body.credential);
+    }
+}
+exports.RefreshHandler = RefreshHandler;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubjectPosition = exports.MerklizedRootPosition = exports.ProofPurpose = exports.CredentialStatusType = exports.ProofType = exports.VerifiableConstants = void 0;
+exports.RefreshServiceType = exports.SubjectPosition = exports.MerklizedRootPosition = exports.ProofPurpose = exports.CredentialStatusType = exports.ProofType = exports.VerifiableConstants = void 0;
 /** Verifiable constants */
 exports.VerifiableConstants = Object.freeze({
     ERRORS: {
@@ -103,3 +103,12 @@ var SubjectPosition;
     // Value save subject in value part of claim.
     SubjectPosition["Value"] = "value";
 })(SubjectPosition = exports.SubjectPosition || (exports.SubjectPosition = {}));
+/**
+ * RefreshServiceType type for refreshService
+ *
+ * @enum {string}
+ */
+var RefreshServiceType;
+(function (RefreshServiceType) {
+    RefreshServiceType["Iden3RefreshService2023"] = "Iden3RefreshService2023";
+})(RefreshServiceType = exports.RefreshServiceType || (exports.RefreshServiceType = {}));

package/dist/node/esm/circuits/comparer.js

@@ -54,8 +54,26 @@ export const availableTypesOperators = new Map([
     [XSDNS.Integer, allOperations],
     [XSDNS.NonNegativeInteger, allOperations],
     [XSDNS.PositiveInteger, allOperations],
-    [XSDNS.Double, [QueryOperators.$eq, QueryOperators.$ne, QueryOperators.$in, QueryOperators.$nin, QueryOperators.$sd]],
-    [XSDNS.String, [QueryOperators.$eq, QueryOperators.$ne, QueryOperators.$in, QueryOperators.$nin, QueryOperators.$sd]],
+    [
+        XSDNS.Double,
+        [
+            QueryOperators.$eq,
+            QueryOperators.$ne,
+            QueryOperators.$in,
+            QueryOperators.$nin,
+            QueryOperators.$sd
+        ]
+    ],
+    [
+        XSDNS.String,
+        [
+            QueryOperators.$eq,
+            QueryOperators.$ne,
+            QueryOperators.$in,
+            QueryOperators.$nin,
+            QueryOperators.$sd
+        ]
+    ],
     [XSDNS.DateTime, allOperations]
 ]);
 /**

package/dist/node/esm/circuits/linked-multi-query.js

@@ -25,7 +25,7 @@ export class LinkedMultiQueryInputs extends BaseConfig {
             if (!this.query[i]) {
                 enabled.push(0);
                 claimPathNotExists.push(0);
-                claimPathMtp.push([]);
+                claimPathMtp.push(new Array(this.getMTLevelsClaim()).fill('0'));
                 claimPathMtpNoAux.push('0');
                 claimPathMtpAuxHi.push('0');
                 claimPathMtpAuxHv.push('0');

package/dist/node/esm/credentials/credential-wallet.js

@@ -50,6 +50,7 @@ export class CredentialWallet {
             cr['@context'] = context;
             cr.type = credentialType;
             cr.expirationDate = expirationDate ? new Date(expirationDate * 1000).toISOString() : undefined;
+            cr.refreshService = request.refreshService;
             cr.issuanceDate = new Date().toISOString();
             cr.credentialSubject = credentialSubject;
             cr.issuer = issuer.string();

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

@@ -15,6 +15,8 @@ export const PROTOCOL_MESSAGE_TYPE = Object.freeze({
     CREDENTIAL_OFFER_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/offer',
     // CredentialIssuanceResponseMessageType is type for message with a credential issuance
     CREDENTIAL_ISSUANCE_RESPONSE_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/issuance-response',
+    // CredentialRefreshMessageType is type for message with a credential issuance
+    CREDENTIAL_REFRESH_MESSAGE_TYPE: IDEN3_PROTOCOL + 'credentials/1.0/refresh',
     // DeviceRegistrationRequestMessageType defines device registration request type of the communication protocol
     DEVICE_REGISTRATION_REQUEST_MESSAGE_TYPE: IDEN3_PROTOCOL + 'devices/1.0/registration',
     // MessageFetMessageFetchRequestMessageType defines message fetch request type of the communication protocol.

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

@@ -16,7 +16,7 @@ import { DID } from '@iden3/js-iden3-core';
  */
 export class FetchHandler {
     /**
-     * Creates an instance of AuthHandler.
+     * Creates an instance of FetchHandler.
      * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
      */
     constructor(_packerMgr) {
@@ -29,7 +29,7 @@ export class FetchHandler {
      *     offer: Uint8Array; offer - raw offer message
      *     opts
      *   }) options how to fetch credential
-     * @returns `Promise<W3CCredential>`
+     * @returns `Promise<W3CCredential[]>`
      */
     async handleCredentialOffer(offer, opts) {
         if (!opts) {

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

@@ -1,3 +1,4 @@
 export * from './auth';
 export * from './fetch';
 export * from './contract-request';
+export * from './refresh';

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

@@ -0,0 +1,72 @@
+import { MediaType } from '../constants';
+import { PROTOCOL_MESSAGE_TYPE } from '../constants';
+import { RefreshServiceType, W3CCredential } from '../../verifiable';
+import { byteEncoder } from '../../utils';
+import { proving, ProvingMethodAlg } from '@iden3/js-jwz';
+import { DID } from '@iden3/js-iden3-core';
+import { CircuitId } from '../../circuits';
+import { randomUUID } from 'crypto';
+/**
+ *
+ * Allows to refresh credential from refresh service and return refreshed credential
+ *
+ * @public
+
+ * @class RefreshHandler
+ * @implements implements RefreshHandler interface
+ */
+export class RefreshHandler {
+    /**
+     * Creates an instance of RefreshHandler.
+     * @param {RefreshHandlerOptions} _options - refresh handler options
+     */
+    constructor(_options) {
+        this._options = _options;
+    }
+    async refreshCredential(credential, opts) {
+        if (!credential.refreshService) {
+            throw new Error('refreshService not specified for W3CCredential');
+        }
+        if (credential.refreshService.type !== RefreshServiceType.Iden3RefreshService2023) {
+            throw new Error(`refresh service type ${credential.refreshService.type} is not supported`);
+        }
+        const otherIdentifier = credential.credentialSubject.id;
+        if (!otherIdentifier) {
+            throw new Error('self credentials do not support refresh');
+        }
+        const senderDID = DID.parse(otherIdentifier);
+        const zkpParams = {
+            senderDID,
+            provingMethodAlg: new ProvingMethodAlg(proving.provingMethodGroth16AuthV2Instance.methodAlg.alg, CircuitId.AuthV2)
+        };
+        const refreshMsg = {
+            id: randomUUID(),
+            typ: MediaType.ZKPMessage,
+            type: PROTOCOL_MESSAGE_TYPE.CREDENTIAL_REFRESH_MESSAGE_TYPE,
+            thid: randomUUID(),
+            body: {
+                id: otherIdentifier,
+                reason: opts?.reason ?? 'credential is expired'
+            },
+            from: otherIdentifier,
+            to: credential.issuer
+        };
+        const msgBytes = byteEncoder.encode(JSON.stringify(refreshMsg));
+        const jwzToken = await this._options.packageManager.pack(MediaType.ZKPMessage, msgBytes, zkpParams);
+        const resp = await fetch(credential.refreshService.id, {
+            method: 'post',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: jwzToken
+        });
+        if (resp.status !== 200) {
+            throw new Error(`could not refresh W3C credential, return status ${resp.status}`);
+        }
+        const respBody = await resp.json();
+        if (!respBody.body?.credential) {
+            throw new Error('no credential in CredentialIssuanceMessage response');
+        }
+        return W3CCredential.fromJSON(respBody.body.credential);
+    }
+}

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

@@ -100,3 +100,12 @@ export var SubjectPosition;
     // Value save subject in value part of claim.
     SubjectPosition["Value"] = "value";
 })(SubjectPosition || (SubjectPosition = {}));
+/**
+ * RefreshServiceType type for refreshService
+ *
+ * @enum {string}
+ */
+export var RefreshServiceType;
+(function (RefreshServiceType) {
+    RefreshServiceType["Iden3RefreshService2023"] = "Iden3RefreshService2023";
+})(RefreshServiceType || (RefreshServiceType = {}));

package/dist/types/credentials/credential-wallet.d.ts

@@ -1,6 +1,6 @@
 import { DID } from '@iden3/js-iden3-core';
 import { IDataStorage } from '../storage/interfaces';
-import { W3CCredential, ProofQuery, SubjectPosition, MerklizedRootPosition, CredentialStatus, RevocationStatus, CredentialStatusType } from './../verifiable';
+import { W3CCredential, ProofQuery, SubjectPosition, MerklizedRootPosition, CredentialStatus, RevocationStatus, CredentialStatusType, RefreshService } from './../verifiable';
 import { JSONSchema } from '../schema-processor';
 import { CredentialStatusResolverRegistry } from './status/resolver';
 import { CredentialStatusResolveOptions } from './status/resolver';
@@ -29,6 +29,10 @@ export interface CredentialRequest {
      * expiration time
      */
     expiration?: number;
+    /**
+     * refreshService
+     */
+    refreshService?: RefreshService;
     /**
      * claim version
      */

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

@@ -8,6 +8,7 @@ export declare const PROTOCOL_MESSAGE_TYPE: Readonly<{
     CREDENTIAL_FETCH_REQUEST_MESSAGE_TYPE: string;
     CREDENTIAL_OFFER_MESSAGE_TYPE: string;
     CREDENTIAL_ISSUANCE_RESPONSE_MESSAGE_TYPE: string;
+    CREDENTIAL_REFRESH_MESSAGE_TYPE: string;
     DEVICE_REGISTRATION_REQUEST_MESSAGE_TYPE: string;
     MESSAGE_FETCH_REQUEST_MESSAGE_TYPE: string;
     PROOF_GENERATION_REQUEST_MESSAGE_TYPE: string;

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

@@ -47,7 +47,7 @@ export interface IFetchHandler {
 export declare class FetchHandler implements IFetchHandler {
     private readonly _packerMgr;
     /**
-     * Creates an instance of AuthHandler.
+     * Creates an instance of FetchHandler.
      * @param {IPackageManager} _packerMgr - package manager to unpack message envelope
      */
     constructor(_packerMgr: IPackageManager);
@@ -58,7 +58,7 @@ export declare class FetchHandler implements IFetchHandler {
      *     offer: Uint8Array; offer - raw offer message
      *     opts
      *   }) options how to fetch credential
-     * @returns `Promise<W3CCredential>`
+     * @returns `Promise<W3CCredential[]>`
      */
     handleCredentialOffer(offer: Uint8Array, opts?: FetchHandlerOptions): Promise<W3CCredential[]>;
 }

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

@@ -1,3 +1,4 @@
 export * from './auth';
 export * from './fetch';
 export * from './contract-request';
+export * from './refresh';

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

@@ -0,0 +1,56 @@
+import { IPackageManager } from '../types';
+import { W3CCredential } from '../../verifiable';
+import { ICredentialWallet } from '../../credentials';
+/**
+ * RefreshHandlerOptions contains options for RefreshHandler
+ * @public
+ * @interface   RefreshHandlerOptions
+ */
+export interface RefreshHandlerOptions {
+    packageManager: IPackageManager;
+    credentialWallet?: ICredentialWallet;
+}
+/**
+ *
+ * RefreshOptions contains options for refreshCredential call
+ *
+ * @public
+ * @interface RefreshOptions
+ */
+export interface RefreshOptions {
+    reason?: string;
+}
+/**
+ * Interface to work with credential refresh handler
+ *
+ * @public
+ * @interface IRefreshHandler
+ */
+export interface IRefreshHandler {
+    /**
+     * refresh credential
+     *
+     * @param {W3CCredential} credential - credential to refresh
+     * @param {RefreshOptions} opts - options
+     * @returns {Promise<W3CCredential>}
+     */
+    refreshCredential(credential: W3CCredential, opts?: RefreshOptions): Promise<W3CCredential>;
+}
+/**
+ *
+ * Allows to refresh credential from refresh service and return refreshed credential
+ *
+ * @public
+
+ * @class RefreshHandler
+ * @implements implements RefreshHandler interface
+ */
+export declare class RefreshHandler implements IRefreshHandler {
+    private readonly _options;
+    /**
+     * Creates an instance of RefreshHandler.
+     * @param {RefreshHandlerOptions} _options - refresh handler options
+     */
+    constructor(_options: RefreshHandlerOptions);
+    refreshCredential(credential: W3CCredential, opts?: RefreshOptions): Promise<W3CCredential>;
+}

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

@@ -39,7 +39,8 @@ export type PackerParams = {
  */
 export type ZKPPackerParams = PackerParams & {
     senderDID: DID;
-    profileNonce: number;
+    /** @deprecated */
+    profileNonce?: number;
     provingMethodAlg: ProvingMethodAlg;
 };
 /**

package/dist/types/iden3comm/types/protocol/credentials.d.ts

@@ -71,3 +71,18 @@ export type Schema = {
     url: string;
     type: string;
 };
+/** CredentialRefreshMessage represent Iden3message for credential refresh request */
+export type CredentialRefreshMessage = {
+    id: string;
+    typ?: MediaType;
+    type: ProtocolMessage;
+    thid?: string;
+    body?: CredentialRefreshMessageBody;
+    from?: string;
+    to?: string;
+};
+/** CredentialRefreshMessageBody is msg body for refresh request */
+export type CredentialRefreshMessageBody = {
+    id: string;
+    reason: string;
+};

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

@@ -76,3 +76,11 @@ export declare enum SubjectPosition {
     Index = "index",
     Value = "value"
 }
+/**
+ * RefreshServiceType type for refreshService
+ *
+ * @enum {string}
+ */
+export declare enum RefreshServiceType {
+    Iden3RefreshService2023 = "Iden3RefreshService2023"
+}

package/dist/types/verifiable/credential.d.ts

@@ -1,4 +1,4 @@
-import { BJJSignatureProof2021, Iden3SparseMerkleTreeProof, CredentialStatus } from './proof';
+import { BJJSignatureProof2021, Iden3SparseMerkleTreeProof, CredentialStatus, RefreshService } from './proof';
 import { Claim } from '@iden3/js-iden3-core';
 import { ProofType } from './constants';
 import { Proof } from '@iden3/js-merkletree';
@@ -16,6 +16,7 @@ export declare class W3CCredential {
     '@context': string[];
     type: string[];
     expirationDate?: string;
+    refreshService?: RefreshService;
     issuanceDate?: string;
     credentialSubject: {
         [key: string]: object | string | number | boolean;

package/dist/types/verifiable/proof.d.ts

@@ -1,5 +1,5 @@
 import { Hash, Proof } from '@iden3/js-merkletree';
-import { ProofType, CredentialStatusType } from './constants';
+import { ProofType, CredentialStatusType, RefreshServiceType } from './constants';
 import { TreeState } from '../circuits';
 import { Signature } from '@iden3/js-crypto';
 import { Claim, DID } from '@iden3/js-iden3-core';
@@ -184,3 +184,12 @@ export interface CredentialStatus {
     revocationNonce?: number;
     statusIssuer?: CredentialStatus;
 }
+/**
+ * RefreshService contains type and id
+ * @public
+ * @interface   RefreshService
+ */
+export interface RefreshService {
+    id: string;
+    type: RefreshServiceType | string;
+}

package/package.json

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