@verified-network/verified-custody 0.5.0 → 0.5.3

package/README.md

@@ -129,22 +129,22 @@ export type VerifiedWalletTx = {
 export interface VerifiedCustodyHelpers {
   sendCoSignerInvitation: (
     channel: "sms" | "email",
-    cosigerId: string,
+    coSignerId: string,
     creatorId: string,
-    hashedCretorPin: string
+    hashedCreatorPin: string
   ) => Promise<boolean>;
 
   sendCreatorConfirmation: (
     channel: "sms" | "email",
     creatorId: string,
-    cosigersList: [],
+    coSignersList: [],
     requiredSigners: number
   ) => Promise<boolean>;
 
   sendCreatorInitiation: (
     channel: "sms" | "email",
     creatorId: string,
-    hashedCretorPin: string,
+    hashedCreatorPin: string,
     txId: number,
     requiredSigners: number
   ) => Promise<boolean>;
@@ -190,10 +190,10 @@ export interface VerifiedCustodyHelpers {
     Example:
     sendCoSignerInvitation must take four parameters:
     channel: "sms" | "email"
-    cosigerId: string (email or phone number of the co-signer)
+    coSignerId: string (email or phone number of the co-signer)
     phone number must be in format +{countryCode}{10DigitNumber} e.g. +1098765432
     creatorId: string (email or phone number of the wallet creator)
-    hashedCretorPin: string
+    hashedCreatorPin: string
     It returns a Promise resolving to true on successful message delivery, otherwise false.
 
 # 🚀 Full Workflow Example
@@ -205,16 +205,16 @@ import { VerifiedCustody } from "@verified-network/verified-custody";
 function App() {
   const myCustomSendCoSignerInvitation = async (
     channel: "sms" | "email",
-    cosigerId: string,
+    coSignerId: string,
     creatorId: string,
-    hashedCretorPin: string
+    hashedCreatorPin: string
   ): Promise<boolean> => {
     try {
       if (channel === "sms") {
-        // send SMS to cosigerId with creatorId and hashedCretorPin
+        // send SMS to coSignerId with creatorId and hashedCreatorPin
         return true;
       } else if (channel === "email") {
-        // send email to cosigerId with creatorId and hashedCretorPin
+        // send email to coSignerId with creatorId and hashedCreatorPin
         return true;
       }
       return false;
@@ -226,7 +226,7 @@ function App() {
   const myCustomSendCreatorConfirmation = async (
     channel: "sms" | "email",
     creatorId: string,
-    cosigersList: [],
+    coSignersList: [],
     requiredSigners: number
   ): Promise<boolean> => {
     try {
@@ -275,9 +275,9 @@ import { FTUPage } from "@verified-network/verified-custody";
 function App() {
   const myCustomSendCoSignerInvitation = async (
     channel: "sms" | "email",
-    cosigerId: string,
+    coSignerId: string,
     creatorId: string,
-    hashedCretorPin: string
+    hashedCreatorPin: string
   ): Promise<boolean> => {
     // Implementation as above
   };
@@ -285,7 +285,7 @@ function App() {
   const myCustomSendCreatorConfirmation = async (
     channel: "sms" | "email",
     creatorId: string,
-    cosigersList: [],
+    coSignersList: [],
     requiredSigners: number
   ): Promise<boolean> => {
     // Implementation as above
@@ -318,9 +318,9 @@ import { EnterPinPage } from "@verified-network/verified-custody";
 function App() {
   const myCustomSendCoSignerInvitation = async (
     channel: "sms" | "email",
-    cosigerId: string,
+    coSignerId: string,
     creatorId: string,
-    hashedCretorPin: string
+    hashedCreatorPin: string
   ): Promise<boolean> => {
     // Implementation as above
   };
@@ -328,7 +328,7 @@ function App() {
   const myCustomSendCreatorConfirmation = async (
     channel: "sms" | "email",
     creatorId: string,
-    cosigersList: [],
+    coSignersList: [],
     requiredSigners: number
   ): Promise<boolean> => {
     // Implementation as above
@@ -428,7 +428,7 @@ module.exports = function override(config) {
 };
 ```
 
-config-overrides.js' code snippet instructs webpack how to resolve node js related dependencies that may not be available on browser side but are required. It also instruct webpack to ignore react-native related dependencies that may breack our react app.
+config-overrides.js' code snippet instructs webpack how to resolve node js related dependencies that may not be available on browser side but are required. It also instruct webpack to ignore react-native related dependencies that may break our react app.
 
 ✅ 5. Modify package.json Scripts
 In your package.json, replace this:

package/dist/index.d.mts

@@ -36,6 +36,7 @@ interface VerifiedCustodyProps {
         flag: string;
         name: string;
     };
+    passKeyRpId?: string;
     showLogoPage?: boolean;
     rootTagId?: string;
     rootExpandedWidth?: string;
@@ -118,6 +119,7 @@ declare const FTUPage: (props: {
     rootTagId?: string;
     rootExpandedWidth?: string;
     rootExpandedHeight?: string;
+    passKeyRpId?: string;
 }) => React$1.JSX.Element;
 
 declare const EnterPinPage: (props: {
@@ -177,6 +179,7 @@ declare const EnterPinPage: (props: {
     rootTagId?: string;
     rootExpandedWidth?: string;
     rootExpandedHeight?: string;
+    passKeyRpId?: string;
 }) => React$1.JSX.Element;
 
 declare const CreatePinPage: (props: {
@@ -223,6 +226,7 @@ declare const CreatePinPage: (props: {
     rootTagId?: string;
     rootExpandedWidth?: string;
     rootExpandedHeight?: string;
+    passKeyRpId?: string;
 }) => React$1.JSX.Element;
 
 declare const ContactPage: (props: {
@@ -357,7 +361,7 @@ declare const hashTheString: (text: string) => string;
 declare const hashTheBuffer: (buffer: ArrayBuffer | Uint8Array) => string;
 declare const encryptString: (text: string, secretKey: string) => string;
 declare const decryptString: (encryptedText: string, secretKey: string) => string;
-declare const publicKeyCredentialRequestOptions: () => any;
+declare const publicKeyCredentialRequestOptions: (rpId?: string) => any;
 declare const encryptWithPasskey: (plaintext: string, rawId: ArrayBuffer | Uint8Array, // allow both ArrayBuffer or Uint8Array
 rawIdString: string) => Promise<string>;
 declare const decryptWithPasskey: (encryptedString: string, rawId: ArrayBuffer | Uint8Array) => Promise<string>;

package/dist/index.d.ts

@@ -36,6 +36,7 @@ interface VerifiedCustodyProps {
         flag: string;
         name: string;
     };
+    passKeyRpId?: string;
     showLogoPage?: boolean;
     rootTagId?: string;
     rootExpandedWidth?: string;
@@ -118,6 +119,7 @@ declare const FTUPage: (props: {
     rootTagId?: string;
     rootExpandedWidth?: string;
     rootExpandedHeight?: string;
+    passKeyRpId?: string;
 }) => React$1.JSX.Element;
 
 declare const EnterPinPage: (props: {
@@ -177,6 +179,7 @@ declare const EnterPinPage: (props: {
     rootTagId?: string;
     rootExpandedWidth?: string;
     rootExpandedHeight?: string;
+    passKeyRpId?: string;
 }) => React$1.JSX.Element;
 
 declare const CreatePinPage: (props: {
@@ -223,6 +226,7 @@ declare const CreatePinPage: (props: {
     rootTagId?: string;
     rootExpandedWidth?: string;
     rootExpandedHeight?: string;
+    passKeyRpId?: string;
 }) => React$1.JSX.Element;
 
 declare const ContactPage: (props: {
@@ -357,7 +361,7 @@ declare const hashTheString: (text: string) => string;
 declare const hashTheBuffer: (buffer: ArrayBuffer | Uint8Array) => string;
 declare const encryptString: (text: string, secretKey: string) => string;
 declare const decryptString: (encryptedText: string, secretKey: string) => string;
-declare const publicKeyCredentialRequestOptions: () => any;
+declare const publicKeyCredentialRequestOptions: (rpId?: string) => any;
 declare const encryptWithPasskey: (plaintext: string, rawId: ArrayBuffer | Uint8Array, // allow both ArrayBuffer or Uint8Array
 rawIdString: string) => Promise<string>;
 declare const decryptWithPasskey: (encryptedString: string, rawId: ArrayBuffer | Uint8Array) => Promise<string>;