feat: update to new db schema (#5)

Co-authored-by: Justin Enerio <[email protected]>
Co-authored-by: Kirill Bubochkin <[email protected]>

.prettierrc

@@ -0,0 +1,16 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "singleQuote": false,
+  "printWidth" : 80,
+  "semi": true,
+  "trailingComma": "es5",
+  "endOfLine": "lf",
+  "htmlWhitespaceSensitivity": "css",
+  "arrowParens": "always",
+  "singleAttributePerLine": false,
+  "quoteProps": "as-needed",
+  "proseWrap": "preserve",
+  "bracketSpacing": true,
+  "bracketSameLine": false
+}

Makefile

@@ -0,0 +1,6 @@
+generate_protos:
+	mkdir -p ./src/generated && \
+	protoc --plugin=protoc-gen-ts_proto=./node_modules/.bin/protoc-gen-ts_proto \
+       --ts_proto_out=./src/generated \
+       --ts_proto_opt=esModuleInterop=true \
+       --proto_path= ./protos/data.proto

README.md

@@ -61,7 +61,7 @@ An order has the following structure:
 }
 ```
 
-### Getting User Data
+### Getting User Data and Verification Info
 
 To access user data, first obtain the user’s secret key:
 
@@ -76,53 +76,93 @@ console.log('userSecretKey:', secretKey);
 Using this key, you can access the user’s raw information:
 
 ```Javascript
-const data = await client.getData({
+const data = await client.getUserData({
     userPK: order.userPublicKey,
     secretKey: secretKey,
 });
 console.log(data);
 ```
 
-You will receive the following structure:
+You will receive the following structure, where you can see data and verification info:
 
 ```json
 {
-  "email": "[email protected]",
-  "phone": "+1234567890",
-  "firstName": "",
-  "middleName": "",
-  "lastName": "",
-  "dob": "",
-  "countryCode": "",
-  "idType": "",
-  "idNumber": "",
-  "photoIdCard": "",
-  "photoSelfie": "",
-  "bankAccountNumber": "",
-  "bankCode": ""
+  "email": [
+    {
+      "value": "[email protected]",
+      "dataId": "2bf9ad39-b213-4b77-b077-872e93301814",
+      "verified": true
+    }
+  ],
+  "phone": [
+    {
+      "value": "+12345678",
+      "dataId": "6d01814f-431d-4ca6-a4c3-c76ef7fc7343",
+      "verified": false
+    }
+  ],
+  "name": [
+    {
+      "firstName": "John",
+      "lastName": "Doe",
+      "dataId": "2a1b66b2-7bef-4b04-8f13-e7baed9e06eb",
+      "verified": false
+    }
+  ],
+  "birthDate": [
+    {
+      "value": "2000-03-29T21:00:00.000Z",
+      "dataId": "372b9e44-300c-443a-882b-af8cd7ff53d9",
+      "verified": false
+    }
+  ],
+  "document": [
+    {
+      "type": "DOCUMENT_TYPE_VOTER_ID",
+      "number": "1233123",
+      "dataId": "3943bec8-b88d-450d-816b-3faab743ff24",
+      "verified": false
+    }
+  ],
+  "bankInfo": [
+    {
+      "bankName": "bankName",
+      "accountNumber": "accountNumber",
+      "bankCode": "bankCode",
+      "dataId": "54727f50-378d-4d14-bada-5f488b751361",
+      "verified": false
+    }
+  ],
+  "selfie": [
+    {
+     "value": {
+      "1": 60,
+      "2": 115,
+      "3": 118,
+      "4": 103,
+      "5": 32,
+      "6": 119,
+      "7": 105,
+      "8": 100,
+      "9": 116,
+      "10": 104,
+      "11": 61,
+      "12": 34,
+      //...
+        },
+      "dataId": "372b9e44-300c-443a-882b-a3234142429",
+      "verified": false
+    }
+  ],
+  "custom": {
+    "kyc": "\"result\""
+  }
 }
 ```
-
-### Getting Verification Info
-
-You can check if the phone number and email have been verified using the following methods:
-
-```Javascript
-const email = await client.getEmail({
-    userPK: order.userPublicKey,
-    secretKey: secretKey,
-});
-console.log(email); // { value: '[email protected]', verified: true }
-
-const phone = await client.getPhone({
-    userPK: order.userPublicKey,
-    secretKey: secretKey,
-});
-console.log(phone); // { value: '+1234567890', verified: false }
-```
-
 > [!NOTE]
-> Validation info from SmileID will be available soon.
+> - The `verified` flag indicates whether the information has been verified.
+> - Its possible to have empty arrays meaning no data is available.
+> - The `custom` field contains verification results from external sources like SmileID and etc.
 
 ### Accepting and Completing the On-Ramp Order
 

dist/generated/google/protobuf/timestamp.d.ts

@@ -0,0 +1,128 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "google.protobuf";
+/**
+ * A Timestamp represents a point in time independent of any time zone or local
+ * calendar, encoded as a count of seconds and fractions of seconds at
+ * nanosecond resolution. The count is relative to an epoch at UTC midnight on
+ * January 1, 1970, in the proleptic Gregorian calendar which extends the
+ * Gregorian calendar backwards to year one.
+ *
+ * All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+ * second table is needed for interpretation, using a [24-hour linear
+ * smear](https://developers.google.com/time/smear).
+ *
+ * The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+ * restricting to that range, we ensure that we can convert to and from [RFC
+ * 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+ *
+ * # Examples
+ *
+ * Example 1: Compute Timestamp from POSIX `time()`.
+ *
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds(time(NULL));
+ *     timestamp.set_nanos(0);
+ *
+ * Example 2: Compute Timestamp from POSIX `gettimeofday()`.
+ *
+ *     struct timeval tv;
+ *     gettimeofday(&tv, NULL);
+ *
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds(tv.tv_sec);
+ *     timestamp.set_nanos(tv.tv_usec * 1000);
+ *
+ * Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
+ *
+ *     FILETIME ft;
+ *     GetSystemTimeAsFileTime(&ft);
+ *     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+ *
+ *     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+ *     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+ *     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+ *
+ * Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
+ *
+ *     long millis = System.currentTimeMillis();
+ *
+ *     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+ *         .setNanos((int) ((millis % 1000) * 1000000)).build();
+ *
+ * Example 5: Compute Timestamp from Java `Instant.now()`.
+ *
+ *     Instant now = Instant.now();
+ *
+ *     Timestamp timestamp =
+ *         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+ *             .setNanos(now.getNano()).build();
+ *
+ * Example 6: Compute Timestamp from current time in Python.
+ *
+ *     timestamp = Timestamp()
+ *     timestamp.GetCurrentTime()
+ *
+ * # JSON Mapping
+ *
+ * In JSON format, the Timestamp type is encoded as a string in the
+ * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+ * format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
+ * where {year} is always expressed using four digits while {month}, {day},
+ * {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+ * seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+ * are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+ * is required. A proto3 JSON serializer should always use UTC (as indicated by
+ * "Z") when printing the Timestamp type and a proto3 JSON parser should be
+ * able to accept both UTC and other timezones (as indicated by an offset).
+ *
+ * For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+ * 01:30 UTC on January 15, 2017.
+ *
+ * In JavaScript, one can convert a Date object to this format using the
+ * standard
+ * [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
+ * method. In Python, a standard `datetime.datetime` object can be converted
+ * to this format using
+ * [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
+ * the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
+ * the Joda Time's [`ISODateTimeFormat.dateTime()`](
+ * http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
+ * ) to obtain a formatter capable of generating timestamps in this format.
+ */
+export interface Timestamp {
+    /**
+     * Represents seconds of UTC time since Unix epoch
+     * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+     * 9999-12-31T23:59:59Z inclusive.
+     */
+    seconds: number;
+    /**
+     * Non-negative fractions of a second at nanosecond resolution. Negative
+     * second values with fractions must still have non-negative nanos values
+     * that count forward in time. Must be from 0 to 999,999,999
+     * inclusive.
+     */
+    nanos: number;
+}
+export declare const Timestamp: MessageFns<Timestamp>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};

dist/generated/google/protobuf/timestamp.js

@@ -0,0 +1,89 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.2.3
+//   protoc               v5.27.1
+// source: google/protobuf/timestamp.proto
+/* eslint-disable */
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export const protobufPackage = "google.protobuf";
+function createBaseTimestamp() {
+    return { seconds: 0, nanos: 0 };
+}
+export const Timestamp = {
+    encode(message, writer = new BinaryWriter()) {
+        if (message.seconds !== 0) {
+            writer.uint32(8).int64(message.seconds);
+        }
+        if (message.nanos !== 0) {
+            writer.uint32(16).int32(message.nanos);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseTimestamp();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.seconds = longToNumber(reader.int64());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.nanos = reader.int32();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            seconds: isSet(object.seconds) ? globalThis.Number(object.seconds) : 0,
+            nanos: isSet(object.nanos) ? globalThis.Number(object.nanos) : 0,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.seconds !== 0) {
+            obj.seconds = Math.round(message.seconds);
+        }
+        if (message.nanos !== 0) {
+            obj.nanos = Math.round(message.nanos);
+        }
+        return obj;
+    },
+    create(base) {
+        return Timestamp.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseTimestamp();
+        message.seconds = object.seconds ?? 0;
+        message.nanos = object.nanos ?? 0;
+        return message;
+    },
+};
+function longToNumber(int64) {
+    const num = globalThis.Number(int64.toString());
+    if (num > globalThis.Number.MAX_SAFE_INTEGER) {
+        throw new globalThis.Error("Value is larger than Number.MAX_SAFE_INTEGER");
+    }
+    if (num < globalThis.Number.MIN_SAFE_INTEGER) {
+        throw new globalThis.Error("Value is smaller than Number.MIN_SAFE_INTEGER");
+    }
+    return num;
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}