@pagopa/io-react-native-iso18013 0.1.0

package/lib/module/iso18013/iso18013-5/schema.js

@@ -0,0 +1,79 @@
+"use strict";
+
+import { z } from 'zod';
+
+// Inner data: a record of booleans with the attributes and the intent to retain flag
+const booleanFieldGroup = z.record(z.boolean());
+const credentialEntrySchema = z.object({
+  isAuthenticated: z.boolean()
+}).catchall(booleanFieldGroup);
+const VerifierRequest = z.object({
+  request: z.record(credentialEntrySchema)
+});
+
+/**
+ * VerifierRequest type returned by the `onDocumentRequestReceived` event in `Events`.
+ * The outermost key represents the credential doctype, the inner key represents the namespace and the innermost key represents the requested fields with a boolean value
+ * indicating whether the verifier app wants to retain the field or not. The isAuthenticated field is present for each requested credentials and indicates wether or not the verifier is authenticated.
+ * Example:
+ *  `{
+ *    "org.iso.18013.5.1.mDL": {
+ *      "isAuthenticated": true,
+ *      "org.iso.18013.5.1": {
+ *        "hair_colour": true,
+ *        "given_name_national_character": true,
+ *        "family_name_national_character": true,
+ *        "given_name": true,
+ *      }
+ *    }
+ *  }`
+ * The request type can be also be used as input for the `generateResponse` method. The structure is the same, however the boolean value for each claim
+ * indicates the willing to present the claim.
+ */
+
+/**
+ * Parses the input to a VerifierRequest object.
+ * This function is used to parse the request received from the verifier app.
+ * @param input - The input to be parsed
+ * @returns The parsed VerifierRequest object
+ */
+export const parseVerifierRequest = input => {
+  return VerifierRequest.parse(input);
+};
+
+/**
+ * Zod schema for the type returned by the `onError` event in Proximity `Events`.
+ */
+const EventError = z.string().catch('Unknown error');
+
+/**
+ * Error type returned by the `onError` event in Proximity `Events`.
+ */
+
+/**
+ * Parses the input to an Error object.
+ * This function is used to parse the error received from the verifier app via the `onError` event.
+ * @param input - The input to be parsed
+ * @returns The parsed Error object or a default error message if parsing fails
+ */
+export const parseEventError = input => {
+  return EventError.parse(input);
+};
+
+/**
+ * This is the type definition for the accepted fields that will be presented to the verifier app.
+ * It contains of a nested object structure, where the outermost key represents the credential doctype.
+ * The inner dictionary contains namespaces, and for each namespace, there is another dictionary mapping requested claims to a boolean value,
+ * which indicates whether the user is willing to present the corresponding claim. Example:
+ * `{
+ *    "org.iso.18013.5.1.mDL": {
+ *      "org.iso.18013.5.1": {
+ *        "hair_colour": true, // Indicates the user is willing to present this claim
+ *        "given_name_national_character": true,
+ *        "family_name_national_character": true,
+ *        "given_name": true,
+ *     }
+ *    }
+ *  }`
+ **/
+//# sourceMappingURL=schema.js.map

package/lib/module/iso18013/iso18013-5/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["z","booleanFieldGroup","record","boolean","credentialEntrySchema","object","isAuthenticated","catchall","VerifierRequest","request","parseVerifierRequest","input","parse","EventError","string","catch","parseEventError"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-5/schema.ts"],"mappings":";;AAAA,SAASA,CAAC,QAAQ,KAAK;;AAEvB;AACA,MAAMC,iBAAiB,GAAGD,CAAC,CAACE,MAAM,CAACF,CAAC,CAACG,OAAO,CAAC,CAAC,CAAC;AAE/C,MAAMC,qBAAqB,GAAGJ,CAAC,CAC5BK,MAAM,CAAC;EACNC,eAAe,EAAEN,CAAC,CAACG,OAAO,CAAC;AAC7B,CAAC,CAAC,CACDI,QAAQ,CAACN,iBAAiB,CAAC;AAE9B,MAAMO,eAAe,GAAGR,CAAC,CAACK,MAAM,CAAC;EAC/BI,OAAO,EAAET,CAAC,CAACE,MAAM,CAACE,qBAAqB;AACzC,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMM,oBAAoB,GAAIC,KAAc,IAAsB;EACvE,OAAOH,eAAe,CAACI,KAAK,CAACD,KAAK,CAAC;AACrC,CAAC;;AAED;AACA;AACA;AACA,MAAME,UAAU,GAAGb,CAAC,CAACc,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC,eAAe,CAAC;;AAEpD;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,eAAe,GAAIL,KAAc,IAAiB;EAC7D,OAAOE,UAAU,CAACD,KAAK,CAACD,KAAK,CAAC;AAChC,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/lib/module/iso18013/iso18013-7/README.md

@@ -0,0 +1,59 @@
+## ISO18013-7
+
+This module provides methods to obtain data structures necessary for the processes defined in the `ISO-18013` standard.
+
+```typescript
+import { ISO18013_7 } from '@pagopa/io-react-native-cbor';
+```
+
+### Methods
+
+#### `generateOID4VPDeviceResponse`
+
+Generates CBOR of the _Device Response_ containing all the claims that have been chosen to be presented during an _OID4VP_ session.
+
+Returns a `Promise` which resolves to a `string` containing the CBOR of the **Device Response** object or rejects with an instance of `CoseFailure` in case of failures.
+
+```typescript
+try {
+  const result = await ISO18013_7.generateOID4VPDeviceResponse(
+    clientId,
+    responseUri,
+    authorizationRequestNonce,
+    mdocGeneratedNonce,
+    documents,
+    fieldRequestedAndAccepted
+  );
+} catch (error: any) {
+  const { message, userInfo } = e as CoseFailure;
+}
+```
+
+#### Signature
+
+```typescript
+type RequestedDocument = {
+    issuerSignedContent : string,
+    alias : string,
+    docType : string
+}
+
+export const generateOID4VPDeviceResponse = async (
+  clientId: string,
+  responseUri: string,
+  authorizationRequestNonce: string,
+  mdocGeneratedNonce: string,
+  documents: Array<RequestedDocument>,
+  fieldRequestedAndAccepted: Record<string, any> | string
+) : Promise<string> => {...};
+```
+
+### Error Codes
+
+| Type                              | Platform    | Description                                                        |
+| --------------------------------- | ----------- | ------------------------------------------------------------------ |
+| UNABLE_TO_GENERATE_RESPONSE       | Android/iOS | Failure during the generation of a response                        |
+| DOC_REQUESTED_PARSING_EXCEPTION   | Android/iOS | The passed documents where in a bad format or contained wrong data |
+| REQUESTED_ITEMS_PARSING_EXCEPTION | iOS         | The passed items where in a bad format                             |
+| UNABLE_TO_GENERATE_TRANSCRIPT     | Android     | There has been an error generating the session transcript          |
+| UNKNOWN_EXCEPTION                 | Android/iOS | Unexpected failure                                                 |

package/lib/module/iso18013/iso18013-7/index.js

@@ -0,0 +1,4 @@
+"use strict";
+
+export { generateOID4VPDeviceResponse } from "./remote.js";
+//# sourceMappingURL=index.js.map

package/lib/module/iso18013/iso18013-7/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["generateOID4VPDeviceResponse"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-7/index.ts"],"mappings":";;AAAA,SACEA,4BAA4B,QAGvB,aAAU","ignoreList":[]}

package/lib/module/iso18013/iso18013-7/remote.js

@@ -0,0 +1,31 @@
+"use strict";
+
+import { IoReactNativeProximity } from "../index.js";
+
+/**
+ * All error codes that the module could return.
+ */
+
+/**
+ * Error type returned by a rejected promise.
+ *
+ * If additional error information are available,
+ * they are stored in the {@link OID4VPFailure["userInfo"]} field.
+ */
+
+/**
+ *
+ * @param clientId extracted from OID4VP session
+ * @param responseUri extracted from OID4VP session
+ * @param authorizationRequestNonce extracted from OID4VP session
+ * @param mdocGeneratedNonce To be generated
+ * @param documents An Array of {@link DocRequested}
+ * @param fieldRequestedAndAccepted extracted from OID4VP session, it's a record of claims
+ *                                  accepted for disclosure or its stringification
+ * @throws {OID4VPFailure} in case of failure
+ * @returns the Device Response in CBOR format
+ */
+export const generateOID4VPDeviceResponse = async (clientId, responseUri, authorizationRequestNonce, mdocGeneratedNonce, documents, fieldRequestedAndAccepted) => {
+  return await IoReactNativeProximity.generateOID4VPDeviceResponse(clientId, responseUri, authorizationRequestNonce, mdocGeneratedNonce, documents, typeof fieldRequestedAndAccepted === 'string' ? fieldRequestedAndAccepted : JSON.stringify(fieldRequestedAndAccepted));
+};
+//# sourceMappingURL=remote.js.map

package/lib/module/iso18013/iso18013-7/remote.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["IoReactNativeProximity","generateOID4VPDeviceResponse","clientId","responseUri","authorizationRequestNonce","mdocGeneratedNonce","documents","fieldRequestedAndAccepted","JSON","stringify"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-7/remote.ts"],"mappings":";;AAAA,SAASA,sBAAsB,QAAQ,aAAI;;AAG3C;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,4BAA4B,GAAG,MAAAA,CAC1CC,QAAgB,EAChBC,WAAmB,EACnBC,yBAAiC,EACjCC,kBAA0B,EAC1BC,SAAmC,EACnCC,yBAAuD,KACnC;EACpB,OAAO,MAAMP,sBAAsB,CAACC,4BAA4B,CAC9DC,QAAQ,EACRC,WAAW,EACXC,yBAAyB,EACzBC,kBAAkB,EAClBC,SAAS,EACT,OAAOC,yBAAyB,KAAK,QAAQ,GACzCA,yBAAyB,GACzBC,IAAI,CAACC,SAAS,CAACF,yBAAyB,CAC9C,CAAC;AACH,CAAC","ignoreList":[]}

package/lib/module/iso18013/types.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=types.js.map

package/lib/module/iso18013/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sourceRoot":"../../../src","sources":["iso18013/types.ts"],"mappings":"","ignoreList":[]}

package/lib/module/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/lib/typescript/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/lib/typescript/src/cbor/cbor/decoder.d.ts

@@ -0,0 +1,35 @@
+import { Documents, IssuerSigned } from './schema';
+/**
+ * Decode base64 encoded CBOR data to JSON object.
+ *
+ * If it is not possibile to decode the provided data, the promise will be rejected with
+ * an instance of {@link CborFailure}.
+ *
+ * **NOTE**: this method does not handle nested CBOR data, which will need additional
+ * parsing.
+ *
+ * @param data - The base64 or base64url encoded CBOR data
+ * @returns The decoded data as JSON object
+ */
+export declare const decode: (data: string) => Promise<any>;
+/**
+ * Decode base64 or base64url encoded CBOR data to mDOC object
+ *
+ * If it is not possibile to decode the provided data, the promise will be rejected with
+ * an instance of {@link CborFailure}.
+ *
+ * @param data - The base64 encoded MDOC data
+ * @returns The decoded data as mDOC object
+ */
+export declare const decodeDocuments: (data: string) => Promise<Documents>;
+/**
+ * Extract and decode the {@link IssuerSigned} with the {@link IssuerAuth} decoded from base64 encoded CBOR
+ *
+ * If it is not possibile to decode the provided data, the promise will be rejected with
+ * an instance of {@link CborFailure}.
+ *
+ * @param issuerSigned - The base64 or base64url encoded MDOC data
+ * @returns The decoded {@link IssuerSigned} contained in the mDOC object
+ */
+export declare const decodeIssuerSigned: (issuerSigned: string) => Promise<IssuerSigned>;
+//# sourceMappingURL=decoder.d.ts.map

package/lib/typescript/src/cbor/cbor/decoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decoder.d.ts","sourceRoot":"","sources":["../../../../../src/cbor/cbor/decoder.ts"],"names":[],"mappings":"AACA,OAAO,EACL,SAAS,EAET,YAAY,EAEb,MAAM,UAAU,CAAC;AAGlB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,MAAM,GAAU,MAAM,MAAM,KAAG,OAAO,CAAC,GAAG,CAGtD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAAU,MAAM,MAAM,KAAG,OAAO,CAAC,SAAS,CAGrE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,GAC7B,cAAc,MAAM,KACnB,OAAO,CAAC,YAAY,CAItB,CAAC"}

package/lib/typescript/src/cbor/cbor/failure.d.ts

@@ -0,0 +1,15 @@
+/**
+ * All error codes that the module could return.
+ */
+export type CborFailureCodes = 'UNABLE_TO_DECODE' | 'INVALID_ENCODING' | 'UNKNOWN_EXCEPTION';
+/**
+ * Error type returned by a rejected promise.
+ *
+ * If additional error information are available,
+ * they are stored in the {@link CborFailure["userInfo"]} field.
+ */
+export type CborFailure = {
+    message: CborFailureCodes;
+    userInfo: Record<string, string>;
+};
+//# sourceMappingURL=failure.d.ts.map

package/lib/typescript/src/cbor/cbor/failure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"failure.d.ts","sourceRoot":"","sources":["../../../../../src/cbor/cbor/failure.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,CAAC;AAExB;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC"}

package/lib/typescript/src/cbor/cbor/index.d.ts

@@ -0,0 +1,4 @@
+export { decode, decodeDocuments, decodeIssuerSigned } from './decoder';
+export { DocumentValue, Documents, DocumentsFromString, IssuerSigned, MDOC, } from './schema';
+export { type CborFailure, type CborFailureCodes } from './failure';
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/cbor/cbor/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/cbor/cbor/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACxE,OAAO,EACL,aAAa,EACb,SAAS,EACT,mBAAmB,EACnB,YAAY,EACZ,IAAI,GACL,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,WAAW,CAAC"}