@sd-jwt/core 0.3.2-next.63 → 0.3.2-next.65

package/README.md

@@ -0,0 +1,78 @@
+![License](https://img.shields.io/github/license/openwallet-foundation-labs/sd-jwt-js.svg)
+![NPM](https://img.shields.io/npm/v/%40sd-jwt%2Fcore)
+![Release](https://img.shields.io/github/v/release/openwallet-foundation-labs/sd-jwt-js)
+![Stars](https://img.shields.io/github/stars/openwallet-foundation-labs/sd-jwt-js)
+
+# SD-JWT Implementation in JavaScript (TypeScript)
+
+## SD-JWT Core
+
+### About
+
+Core library for selective disclosure JWTs
+
+Check the detail description in our github [repo](https://github.com/openwallet-foundation-labs/sd-jwt-js).
+
+### Installation
+
+To install this project, run the following command:
+
+```bash
+# using npm
+npm install @sd-jwt/core
+
+# using yarn
+yarn add @sd-jwt/core
+
+# using pnpm
+pnpm install @sd-jwt/core
+```
+
+Ensure you have Node.js installed as a prerequisite.
+
+### Usage
+
+Here's a basic example of how to use this library:
+
+```jsx
+import { DisclosureFrame } from '@sd-jwt/core';
+
+// Issuer defines the claims object with the user's information
+const claims = {
+  firstname: 'John',
+  lastname: 'Doe',
+  ssn: '123-45-6789',
+  id: '1234',
+};
+
+// Issuer defines the disclosure frame to specify which claims can be disclosed/undisclosed
+const disclosureFrame: DisclosureFrame<typeof claims> = {
+  _sd: ['firstname', 'lastname', 'ssn'],
+};
+
+// Issuer issues a signed JWT credential with the specified claims and disclosure frame
+// returns an encoded JWT
+const credential = await sdjwt.issue(claims, disclosureFrame);
+
+// Holder may validate the credential from the issuer
+const valid = await sdjwt.validate(credential);
+
+// Holder defines the presentation frame to specify which claims should be presented
+// The list of presented claims must be a subset of the disclosed claims
+const presentationFrame = ['firstname', 'ssn'];
+
+// Holder creates a presentation using the issued credential and the presentation frame
+// returns an encoded SD JWT.
+const presentation = await sdjwt.present(credential, presentationFrame);
+
+// Verifier can verify the presentation using the Issuer's public key
+const verified = await sdjwt.verify(presentation);
+```
+
+Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/examples)
+
+### Dependencies
+
+- @sd-jwt/decode
+- @sd-jwt/types
+- @sd-jwt/utils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sd-jwt/core",
-  "version": "0.3.2-next.63+fb2e533",
+  "version": "0.3.2-next.65+622c8dc",
   "description": "sd-jwt draft 7 implementation in typescript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -36,12 +36,12 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@sd-jwt/crypto-nodejs": "0.3.2-next.63+fb2e533"
+    "@sd-jwt/crypto-nodejs": "0.3.2-next.65+622c8dc"
   },
   "dependencies": {
-    "@sd-jwt/decode": "0.3.2-next.63+fb2e533",
-    "@sd-jwt/types": "0.3.2-next.63+fb2e533",
-    "@sd-jwt/utils": "0.3.2-next.63+fb2e533"
+    "@sd-jwt/decode": "0.3.2-next.65+622c8dc",
+    "@sd-jwt/types": "0.3.2-next.65+622c8dc",
+    "@sd-jwt/utils": "0.3.2-next.65+622c8dc"
   },
   "publishConfig": {
     "access": "public"
@@ -59,5 +59,5 @@
       "esm"
     ]
   },
-  "gitHead": "fb2e5336529e8ef8fb4bb17b5aba77202dd8e784"
+  "gitHead": "622c8dc2001c4ca6cc3e6da75f7516d4c70a73db"
 }

package/src/sdjwt.ts

@@ -250,7 +250,23 @@ export const pack = async <T extends Record<string, unknown>>(
       const claim = recursivePackedClaims[i]
         ? recursivePackedClaims[i]
         : claims[i];
-      // TODO: should this actually be the `i` or `claim`?
+      /** This part is set discloure for array items.
+       *  The example of disclosureFrame of an Array is
+       *
+       *  const claims = {
+       *    array: ['a', 'b', 'c']
+       *  }
+       *
+       *  diclosureFrame: DisclosureFrame<typeof claims> = {
+       *    array: {
+       *      _sd: [0, 2]
+       *    }
+       *  }
+       *
+       *  It means that we want to disclose the first and the third item of the array
+       *
+       *  So If the index `i` is in the disclosure list(sd), then we create a disclosure for the claim
+       */
       // @ts-ignore
       if (sd.includes(i)) {
         const salt = await saltGenerator(16);