Merge pull request #60 from velocitycareerlabs/VL-7723

v0.8.16 - refactor APIS, JSONObject (any) to real Dictionary<k,v>

packages/sample-server/package.json

@@ -19,7 +19,7 @@
         "@fastify/autoload": "~5.7.1",
         "env-var": "~7.3.0",
         "fastify": "~4.15.0",
-        "@velocitycareerlabs/vnf-nodejs-wallet-sdk": "^0.8.15"
+        "@velocitycareerlabs/vnf-nodejs-wallet-sdk": "^0.8.16"
     },
     "devDependencies": {
         "@jest/globals": "~29.5.0",

packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@velocitycareerlabs/vnf-nodejs-wallet-sdk",
-    "version": "0.8.15",
+    "version": "0.8.16",
     "description": "VNF Wallet SDK Nodejs",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

packages/sdk/src/api/VCL.ts

@@ -26,7 +26,7 @@ import VCLSubmissionResult from "./entities/VCLSubmissionResult";
 import VCLToken from "./entities/VCLToken";
 import VCLVerifiedProfile from "./entities/VCLVerifiedProfile";
 import VCLVerifiedProfileDescriptor from "./entities/VCLVerifiedProfileDescriptor";
-import { Nullish } from "../types";
+import { Nullish } from "./VCLTypes";
 
 export default interface VCL {
     initialize(

packages/sdk/src/VCLProvider.ts → packages/sdk/src/api/VCLProvider.ts

@@ -1,4 +1,4 @@
-import { VCLImpl } from "./impl/VCLImpl";
+import { VCLImpl } from "../impl/VCLImpl";
 
 export default class VCLProvider {
     private static vclInstance: VCLImpl;

packages/sdk/src/api/VCLSignatureAlgorithm.ts

@@ -0,0 +1,6 @@
+enum VCLSignatureAlgorithm {
+    ES256 = "P-256",
+    SECP256k1 = "secp256k1"
+}
+
+export default VCLSignatureAlgorithm;

packages/sdk/src/api/VCLTypes.ts

@@ -0,0 +1,3 @@
+export type Nullish<T> = T | null | undefined;
+
+export type Dictionary<T> = Record<string, T>;

packages/sdk/src/api/entities/VCLCountries.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLCountry from "./VCLCountry";
 
 class VCLCountries {

packages/sdk/src/api/entities/VCLCountry.ts

@@ -1,10 +1,10 @@
-import { Nullish } from "../../types";
+import { Dictionary, Nullish } from "../VCLTypes";
 import VCLPlace from "./VCLPlace";
 import VCLRegions from "./VCLRegions";
 
 export default class VCLCountry extends VCLPlace {
     constructor(
-        public payload: JSONObject,
+        public payload: Dictionary<any>,
         public code: string,
         public name: string,
         public regions: Nullish<VCLRegions>

packages/sdk/src/api/entities/VCLCredentialManifest.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLJwt from "./VCLJwt";
 import VCLVerifiedProfile from "./VCLVerifiedProfile";
 

packages/sdk/src/api/entities/VCLCredentialManifestDescriptor.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLIssuingType from "./VCLIssuingType";
 import VCLPushDelegate from "./VCLPushDelegate";
 

packages/sdk/src/api/entities/VCLCredentialManifestDescriptorByDeepLink.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLCredentialManifestDescriptor from "./VCLCredentialManifestDescriptor";
 import VCLDeepLink from "./VCLDeepLink";
 import VCLIssuingType from "./VCLIssuingType";

packages/sdk/src/api/entities/VCLCredentialManifestDescriptorByService.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLCredentialManifestDescriptor from "./VCLCredentialManifestDescriptor";
 import VCLIssuingType from "./VCLIssuingType";
 import VCLPushDelegate from "./VCLPushDelegate";

packages/sdk/src/api/entities/VCLCredentialManifestDescriptorRefresh.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLCredentialManifestDescriptor from "./VCLCredentialManifestDescriptor";
 import VCLIssuingType from "./VCLIssuingType";
 import VCLService from "./VCLService";

packages/sdk/src/api/entities/VCLCredentialType.ts

@@ -1,8 +1,8 @@
-import { Nullish } from "../../types";
+import { Dictionary, Nullish } from "../VCLTypes";
 
 export default class VCLCredentialType {
     constructor(
-        public payload: JSONObject,
+        public payload: Dictionary<any>,
         public id: Nullish<string>,
         public schema: Nullish<string>,
         public createdAt: Nullish<string>,

packages/sdk/src/api/entities/VCLCredentialTypeSchema.ts

@@ -1,3 +1,5 @@
+import { Dictionary } from "../VCLTypes";
+
 export default class VCLCredentialTypeSchema {
-    constructor(public payload: JSONObject) {}
+    constructor(public payload: Dictionary<any>) {}
 }

packages/sdk/src/api/entities/VCLCredentialTypes.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLCredentialType from "./VCLCredentialType";
 
 export default class VCLCredentialTypes {

packages/sdk/src/api/entities/VCLCredentialTypesUIFormSchema.ts

@@ -1,5 +1,7 @@
+import { Dictionary } from "../VCLTypes";
+
 export default class VCLCredentialTypesUIFormSchema {
-    constructor(public payload: JSONObject) {}
+    constructor(public payload: Dictionary<any>) {}
     // CodingKeys
     static readonly KeyAddressRegion = "addressRegion";
     static readonly KeyAddressCountry = "addressCountry";

packages/sdk/src/api/entities/VCLDeepLink.ts

@@ -1,5 +1,5 @@
 import "../../impl/extensions/StringExtensions";
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 
 export default class VCLDeepLink {
     public requestUri: Nullish<string>;

packages/sdk/src/api/entities/VCLDidDocument.ts

@@ -1,3 +1,5 @@
+import { Dictionary } from "../VCLTypes";
+
 export default class VCLDidDocument {
-    constructor(public payload: JSONObject) {}
+    constructor(public payload: Dictionary<any>) {}
 }

packages/sdk/src/api/entities/VCLDidJwkDescriptor.ts

@@ -1,3 +1,10 @@
+import { Nullish } from "src/api/VCLTypes";
+import VCLToken from "./VCLToken";
+import VCLSignatureAlgorithm from "../VCLSignatureAlgorithm";
+
 export default class VCLDidJwkDescriptor {
-    constructor(public kid: string) {}
+    constructor(
+        public signatureAlgorithm: VCLSignatureAlgorithm = VCLSignatureAlgorithm.ES256,
+        public remoteCryptoServicesToken: Nullish<VCLToken> = null
+    ) {}
 }

packages/sdk/src/api/entities/VCLFinalizeOffersDescriptor.ts

@@ -1,29 +1,4 @@
-/*
-
-data class VCLFinalizeOffersDescriptor(
-    val credentialManifest: VCLCredentialManifest,
-    val approvedOfferIds: List<String>,
-    val rejectedOfferIds: List<String>
-) {
-    val payload: JSONObject =
-        JSONObject()
-            .putOpt(KeyExchangeId, exchangeId)
-            .putOpt(KeyApprovedOfferIds, approvedOfferIds.toJsonArray())
-            .putOpt(KeyRejectedOfferIds, rejectedOfferIds.toJsonArray())
-
-    val did: String get() = credentialManifest.did
-    val exchangeId: String get() = credentialManifest.exchangeId
-
-    val finalizeOffersUri: String get() = credentialManifest.finalizeOffersUri
-
-    companion object CodingKeys {
-        const val KeyExchangeId = "exchangeId"
-        const val KeyApprovedOfferIds = "approvedOfferIds"
-        const val KeyRejectedOfferIds = "rejectedOfferIds"
-    }
-}
-*/
-
+import { Dictionary } from "../VCLTypes";
 import VCLCredentialManifest from "./VCLCredentialManifest";
 import VCLJwt from "./VCLJwt";
 
@@ -46,15 +21,15 @@ export default class VCLFinalizeOffersDescriptor {
         return this.credentialManifest.did;
     }
 
-    payload: JSONObject = {
+    payload: Dictionary<any> = {
         [VCLFinalizeOffersDescriptor.KeyExchangeId]: this.exchangeId,
         [VCLFinalizeOffersDescriptor.KeyApprovedOfferIds]:
             this.approvedOfferIds,
         [VCLFinalizeOffersDescriptor.KeyRejectedOfferIds]:
             this.rejectedOfferIds,
     };
 
-    generateRequestBody(jwt: VCLJwt): JSONObject {
+    generateRequestBody(jwt: VCLJwt): Dictionary<any> {
         const retVal = this.payload;
         const proof: any = {};
         proof[VCLFinalizeOffersDescriptor.KeyProofType] =

packages/sdk/src/api/entities/VCLGenerateOffersDescriptor.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Dictionary, Nullish } from "../VCLTypes";
 import VCLCredentialManifest from "./VCLCredentialManifest";
 import VCLVerifiableCredential from "./VCLVerifiableCredential";
 
@@ -10,7 +10,7 @@ export default class VCLGenerateOffersDescriptor {
         public readonly identificationVerifiableCredentials: VCLVerifiableCredential[]
     ) {}
 
-    payload: JSONObject = {
+    payload: Dictionary<any> = {
         [VCLGenerateOffersDescriptor.KeyExchangeId]: this.exchangeId,
         [VCLGenerateOffersDescriptor.KeyTypes]: this.types,
         [VCLGenerateOffersDescriptor.KeyOfferHashes]: this.offerHashes,

packages/sdk/src/api/entities/VCLJwt.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Dictionary, Nullish } from "../VCLTypes";
 
 export default class VCLJwt {
     public encodedJwt: Nullish<string>;
@@ -27,17 +27,17 @@ export default class VCLJwt {
         return (this.header.kid || this.jwk.kid) || ""
     }
 
-    get jwk(): JSONObject {
+    get jwk(): Dictionary<any> {
         return this.header.jwk || JSON.parse("{}")
     }
 
-    get header(): JSONObject {
+    get header(): Dictionary<any> {
         const buff = Buffer.from(this.signedJwt.header, "base64");
         const text = buff.toString("utf-8");
         return JSON.parse(text || "{}");
     }
 
-    get payload(): JSONObject {
+    get payload(): Dictionary<any> {
         const buff = Buffer.from(this.signedJwt.payload, "base64");
         const text = buff.toString("utf-8");
         return JSON.parse(text || "{}");

packages/sdk/src/api/entities/VCLJwtDescriptor.ts

@@ -1,14 +1,31 @@
 import { randomUUID } from "crypto";
-import VCLDidJwk from "./VCLDidJwk";
-import { Nullish } from "../../types";
+import { Dictionary, Nullish } from "../VCLTypes";
 
 export default class VCLJwtDescriptor {
     constructor(
-        public payload: JSONObject,
-        public iss: string,
+        /**
+         * payload is Json formatted payload
+         * @type Nullish<Dictionary<any>>
+         * @public
+         */
+        public payload: Nullish<Dictionary<any>>,
+        /**
+         * jti is JWT ID
+         * @type string
+         * @public
+         */
         public jti: string = randomUUID().toString(),
-        public keyId: Nullish<string>,
-        public didJwk: Nullish<VCLDidJwk> = null,
+        /**
+         * iss is the did of the wallet owner
+         * @type string
+         * @public
+         */
+        public iss: string,
+        /**
+         * aud is the issuer DID
+         * @type string
+         * @public
+         */
         public aud: Nullish<string> = null
     ) {}
 }

packages/sdk/src/api/entities/VCLOffers.ts

@@ -1,8 +1,9 @@
+import { Dictionary } from "src/api/VCLTypes";
 import VCLToken from "./VCLToken";
 
 export default class VCLOffers {
     constructor(
-        public readonly all: JSONObject[],
+        public readonly all: Dictionary<any>[],
         public readonly responseCode: number,
         public readonly token: VCLToken
     ) {}

packages/sdk/src/api/entities/VCLOrganization.ts

@@ -1,3 +1,4 @@
+import { Dictionary } from "../VCLTypes";
 import VCLServiceCredentialAgentIssuer from "./VCLServiceCredentialAgentIssuer";
 
 export default class VCLOrganization {
@@ -6,14 +7,14 @@ export default class VCLOrganization {
     get serviceCredentialAgentIssuers(): VCLServiceCredentialAgentIssuer[] {
         return this.parseServiceCredentialAgentIssuers();
     }
-    constructor(public readonly payload: JSONObject) {}
+    constructor(public readonly payload: Dictionary<any>) {}
 
     private parseServiceCredentialAgentIssuers(): VCLServiceCredentialAgentIssuer[] {
         const result: VCLServiceCredentialAgentIssuer[] = [];
 
         try {
             const serviceJsonArr = (this.payload[VCLOrganization.KeyService] ??
-                []) as JSONObject[];
+                []) as Dictionary<any>[];
             if (serviceJsonArr) {
                 for (const i in serviceJsonArr) {
                     const it = serviceJsonArr[i];

packages/sdk/src/api/entities/VCLOrganizationsSearchDescriptor.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLServiceTypes from "./VCLServiceTypes";
 
 export default class VCLOrganizationsSearchDescriptor {

packages/sdk/src/api/entities/VCLPlace.ts

@@ -1,6 +1,8 @@
+import { Dictionary } from "../VCLTypes";
+
 export default class VCLPlace {
     constructor(
-        public readonly payload: JSONObject,
+        public readonly payload: Dictionary<any>,
         public readonly code: string,
         public readonly name: string
     ) {}

packages/sdk/src/api/entities/VCLPresentationRequest.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLDeepLink from "./VCLDeepLink";
 import VCLJwt from "./VCLJwt";
 import VCLPushDelegate from "./VCLPushDelegate";

packages/sdk/src/api/entities/VCLPresentationRequestDescriptor.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLDeepLink from "./VCLDeepLink";
 import VCLPushDelegate from "./VCLPushDelegate";
 

packages/sdk/src/api/entities/VCLPublicJwk.ts

@@ -1,3 +1,5 @@
+import { Dictionary } from "../VCLTypes";
+
 enum Format {
     jwk = "jwk",
     hex = "hex",
@@ -6,7 +8,7 @@ enum Format {
 }
 
 export default class VCLPublicJwk {
-    constructor(public valueStr: string, public valueJson: JSONObject) {}
+    constructor(public valueStr: string, public valueJson: Dictionary<any>) {}
     static readonly Format = Format;
     get curve(): string {
         return this.valueJson["crv"];
@@ -16,7 +18,7 @@ export default class VCLPublicJwk {
         return new VCLPublicJwk(valueStr, JSON.parse(valueStr));
     }
 
-    public static fromJSON(valueJson: JSONObject) {
+    public static fromJSON(valueJson: Dictionary<any>) {
         return new VCLPublicJwk(JSON.stringify(valueJson), valueJson);
     }
 }

packages/sdk/src/api/entities/VCLPushDelegate.ts

@@ -1,3 +1,5 @@
+import { Dictionary } from "../VCLTypes";
+
 export default class VCLPushDelegate {
     constructor(
         public readonly pushUrl: string,
@@ -7,7 +9,7 @@ export default class VCLPushDelegate {
     static readonly KeyPushUrl = "pushUrl";
     static readonly KeyPushToken = "pushToken";
 
-    toJsonObject() {
+    toJsonObject(): Dictionary<any> {
         return {
             [VCLPushDelegate.KeyPushUrl]: this.pushUrl,
             [VCLPushDelegate.KeyPushToken]: this.pushToken,

packages/sdk/src/api/entities/VCLRegion.ts

@@ -1,7 +1,8 @@
+import { Dictionary } from "../VCLTypes";
 import VCLPlace from "./VCLPlace";
 
 export default class VCLRegion extends VCLPlace {
-    constructor(payload: JSONObject, code: string, name: string) {
+    constructor(payload: Dictionary<any>, code: string, name: string) {
         super(payload, code, name);
     }
 

packages/sdk/src/api/entities/VCLResult.ts

@@ -1,4 +1,4 @@
-import { Nullish } from "../../types";
+import { Nullish } from "../VCLTypes";
 import VCLError from "./error/VCLError";
 
 export default class VCLResult<R> {