npm - @plainkey/browser - Versions diffs - 0.6.0 → 0.6.2 - Mend

@plainkey/browser 0.6.0 → 0.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/dist/index.d.ts CHANGED Viewed

@@ -23,13 +23,13 @@ declare class PlainKey {
    * Registration of a new user with a passkey. Will require user interaction to create a passkey.
    *
    * @param userName - A stable unique identifier for the user, like an email address or username.
-   * Can be empty for usernameless login.
+   * Can be empty for usernameless authentication.
    */
   createUserWithPasskey(userName?: string): Promise<CreateUserWithPasskeyResult>;
   /**
    * Adds a passkey to an existing user. Will require user interaction to create a passkey.
    *
-   * @param userToken - The user authentication token, obtained from login.
+   * @param userToken - The user authentication token, is returned from .authenticate() and createUserWithPasskey().
    * Do NOT store it in local storage, database, etc. Always keep it in memory.
    *
    * @param userIdentifier - An object with either the user's PlainKey User ID or their userName.
@@ -39,9 +39,10 @@ declare class PlainKey {
    * Authenticates a user. Can be used for login, verification, 2FA, etc.
    * Will require user interaction to authenticate.
    *
-   * @param userIdentifier - An object with either the user's PlainKey User ID or their userName.
+   * @param userIdentifier - Optional object containing either the user's PlainKey User ID or their userName.
+   * Does not have to be provided for usernameless authentication.
    */
-  authenticate(userIdentifier: UserIdentifier): Promise<AuthenticateResult>;
+  authenticate(userIdentifier?: UserIdentifier): Promise<AuthenticateResult>;
 }
 //#endregion
 export { PlainKey };

package/dist/index.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.d.ts","names":[],"sources":["../src/plainKey.ts"],"sourcesContent":[],"mappings":";;;;;;AAiCA;;;;;;~~AAuMqC~~,~~cAvMxB~~,QAAA,~~CAuMwB~~;EAAyB,iBAAA,SAAA;EAAR,iBAAA,OAAA;EAAO,WAAA,CAAA,SAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAAA,MAAA;;;;;;;;;;;;~~4CApJX~~,QAAQ;;;;;;;;;gDAuEJ,iBAAiB,QAAQ~~;;;;;;;+BA6E1C~~,iBAAiB,QAAQ"}
1	+ {"version":3,"file":"index.d.ts","names":[],"sources":["../src/plainKey.ts"],"sourcesContent":[],"mappings":";;;;;;AAiCA;;;;;;AAwMsC,cAxMzB,QAAA,CAwMyB;EAAyB,iBAAA,SAAA;EAAR,iBAAA,OAAA;EAAO,WAAA,CAAA,SAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAAA,MAAA;;;;;;;;;;;;4CArJZ,QAAQ;;;;;;;;;gDAuEJ,iBAAiB,QAAQ;;;;;;;;gCA8EzC,iBAAiB,QAAQ"}

package/dist/index.js CHANGED Viewed

@@ -44,7 +44,7 @@ var PlainKey = class {
 	* Registration of a new user with a passkey. Will require user interaction to create a passkey.
 	*
 	* @param userName - A stable unique identifier for the user, like an email address or username.
-	* Can be empty for usernameless login.
+	* Can be empty for usernameless authentication.
 	*/
 	async createUserWithPasskey(userName) {
 		try {
@@ -92,7 +92,7 @@ var PlainKey = class {
 	/**
 	* Adds a passkey to an existing user. Will require user interaction to create a passkey.
 	*
-	* @param userToken - The user authentication token, obtained from login.
+	* @param userToken - The user authentication token, is returned from .authenticate() and createUserWithPasskey().
 	* Do NOT store it in local storage, database, etc. Always keep it in memory.
 	*
 	* @param userIdentifier - An object with either the user's PlainKey User ID or their userName.
@@ -150,14 +150,13 @@ var PlainKey = class {
 	* Authenticates a user. Can be used for login, verification, 2FA, etc.
 	* Will require user interaction to authenticate.
 	*
-	* @param userIdentifier - An object with either the user's PlainKey User ID or their userName.
+	* @param userIdentifier - Optional object containing either the user's PlainKey User ID or their userName.
+	* Does not have to be provided for usernameless authentication.
 	*/
 	async authenticate(userIdentifier) {
-		if (!userIdentifier) throw new Error("User identifier is required");
-		if (!userIdentifier.userId && !userIdentifier.userName) throw new Error("Either a userId or a userName is required");
 		try {
 			const beginParams = { userIdentifier };
-			const beginResponse = await fetch(`${this.baseUrl}/login/begin`, {
+			const beginResponse = await fetch(`${this.baseUrl}/authenticate/begin`, {
 				method: "POST",
 				headers: {
 					"Content-Type": "application/json",
@@ -173,7 +172,7 @@ var PlainKey = class {
 				loginSessionId: beginResponseData.loginSession.id,
 				authenticationResponse
 			};
-			const verificationResponse = await fetch(`${this.baseUrl}/login/complete`, {
+			const verificationResponse = await fetch(`${this.baseUrl}/authenticate/complete`, {
 				method: "POST",
 				headers: {
 					"Content-Type": "application/json",
@@ -182,7 +181,7 @@ var PlainKey = class {
 				body: JSON.stringify(completeParams)
 			});
 			const verificationResponseData = await this.parseResponse(verificationResponse);
-			if (!verificationResponseData.verified) throw new Error("Server could not verify login");
+			if (!verificationResponseData.verified) throw new Error("Server could not verify authentication");
 			return {
 				success: verificationResponseData.verified,
 				data: {

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","names":["bodyText: string","json: any","beginParams: RegistrationBeginRequest","credential: RegistrationResponseJSON","completeParams: RegistrationCompleteRequest","completeResponseData: RegistrationCompleteResponse","beginParams: UserCredentialBeginRequest","completeParams: UserCredentialCompleteRequest","completeResponseData: UserCredentialCompleteResponse","beginParams: LoginBeginRequest","beginResponseData: LoginBeginResponse","authenticationResponse: AuthenticationResponseJSON","completeParams: LoginCompleteRequest","verificationResponseData: LoginCompleteResponse"],"sources":["../src/plainKey.ts"],"sourcesContent":["import { startAuthentication, startRegistration } from \"@simplewebauthn/browser\"\nimport { RegistrationResponseJSON, AuthenticationResponseJSON } from \"@simplewebauthn/browser\"\n\nimport type {\n RegistrationBeginRequest,\n RegistrationCompleteRequest,\n UserCredentialBeginRequest,\n UserCredentialCompleteRequest,\n LoginBeginRequest,\n LoginCompleteRequest,\n UserIdentifier,\n CreateUserWithPasskeyResult,\n AddPasskeyResult,\n AuthenticateResult\n} from \"@plainkey/types\"\n\nimport type {\n RegistrationBeginResponse,\n RegistrationCompleteResponse,\n UserCredentialBeginResponse,\n UserCredentialCompleteResponse,\n LoginBeginResponse,\n LoginCompleteResponse\n} from \"@plainkey/types\"\n\n/*\n PlainKey client for the browser. Used to register new users, add passkeys to existing users, and log users in.\n \n Docs: https://plainkey.io/docs\n \n @param projectId - Your PlainKey project ID. You can find it in the PlainKey admin dashboard.\n * @param baseUrl - Set by default to https://api.plainkey.io/api. Change only for development purposes.\n /\nexport class PlainKey {\n private readonly projectId: string\n private readonly baseUrl: string\n\n constructor(projectId: string, baseUrl: string = \"https://api.plainkey.io/api\") {\n if (!projectId) throw new Error(\"Project ID is required\")\n if (!baseUrl) throw new Error(\"Base URL is required\")\n\n this.projectId = projectId\n this.baseUrl = baseUrl.replace(/\\/$/, \"\") // Remove trailing slash\n }\n\n /\n Helper to parse response JSON.\n * Throws error if status code is not 200 OK, if the response is not valid JSON.\n /\n private async parseResponse<T = any>(response: Response): Promise<T> {\n let bodyText: string\n\n // Read as text first to avoid JSON.parse errors on any HTML/plaintext error responses.\n try {\n bodyText = await response.text()\n } catch {\n throw new Error(\"Network error while reading server response\")\n }\n\n // Parse the response text as JSON.\n let json: any\n\n try {\n json = bodyText ? JSON.parse(bodyText) : {}\n } catch {\n if (!response.ok) throw new Error(\"Server returned an invalid JSON error response\")\n throw new Error(\"Invalid JSON received from server\")\n }\n\n if (!response.ok) {\n // Server should return { error: string }\n const message = json && typeof json.error === \"string\" ? json.error : \"Unknown server error\"\n throw new Error(message)\n }\n\n return json as T\n }\n\n /\n Registration of a new user with a passkey. Will require user interaction to create a passkey.\n \n @param userName - A stable unique identifier for the user, like an email address or username.\n * Can be empty for usernameless login.\n /\n async createUserWithPasskey(userName?: string): Promise<CreateUserWithPasskeyResult> {\n try {\n // Step 1: Get registration options from server\n const beginParams: RegistrationBeginRequest = { userName }\n const beginResponse = await fetch(`${this.baseUrl}/user/register/begin`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(beginParams)\n })\n\n // Parse response JSON\n const { options, user } = await this.parseResponse<RegistrationBeginResponse>(beginResponse)\n\n // Step 2: Create credential using browser's WebAuthn API\n const credential: RegistrationResponseJSON = await startRegistration({\n optionsJSON: options\n })\n\n // Step 3: Send credential to server for verification\n const completeParams: RegistrationCompleteRequest = {\n userIdentifier: { userId: user.id },\n credential\n }\n\n const completeResponse = await fetch(`${this.baseUrl}/user/register/complete`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(completeParams)\n })\n\n // Parse response JSON\n const completeResponseData: RegistrationCompleteResponse =\n await this.parseResponse<RegistrationCompleteResponse>(completeResponse)\n\n if (!completeResponseData.success) throw new Error(\"Server could not complete registration\")\n\n // Return success\n return {\n success: completeResponseData.success,\n data: {\n user: completeResponseData.user,\n token: completeResponseData.token,\n credential: completeResponseData.credential,\n session: completeResponseData.session\n }\n }\n } catch (error) {\n // Return error\n return {\n success: false,\n error: {\n message: error instanceof Error ? error.message : \"Unknown error\"\n }\n }\n }\n }\n\n /\n Adds a passkey to an existing user. Will require user interaction to create a passkey.\n \n @param userToken - The user authentication token, obtained from login.\n * Do NOT store it in local storage, database, etc. Always keep it in memory.\n \n @param userIdentifier - An object with either the user's PlainKey User ID or their userName.\n /\n async addPasskey(userToken: string, userIdentifier: UserIdentifier): Promise<AddPasskeyResult> {\n try {\n // Validate user identifier\n if (!userIdentifier) throw new Error(\"User identifier is required\")\n if (!userIdentifier.userId && !userIdentifier.userName)\n throw new Error(\"Either a userId or a userName is required\")\n\n // Step 1: Get credential registration options from server\n const beginParams: UserCredentialBeginRequest = { userToken, userIdentifier }\n const beginResponse = await fetch(`${this.baseUrl}/user/credential/begin`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(beginParams)\n })\n\n // Parse response JSON\n const { options, user }: UserCredentialBeginResponse =\n await this.parseResponse<UserCredentialBeginResponse>(beginResponse)\n\n // Step 2: Create credential using browser's WebAuthn API\n const credential: RegistrationResponseJSON = await startRegistration({\n optionsJSON: options\n })\n\n // Step 3: Send credential to server for verification\n const completeParams: UserCredentialCompleteRequest = {\n userToken: beginParams.userToken,\n userIdentifier: { userId: user.id },\n credential\n }\n\n const completeResponse = await fetch(`${this.baseUrl}/user/credential/complete`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(completeParams)\n })\n\n // Parse response JSON\n const completeResponseData: UserCredentialCompleteResponse =\n await this.parseResponse<UserCredentialCompleteResponse>(completeResponse)\n\n if (!completeResponseData.success)\n throw new Error(\"Server could not complete passkey registration\")\n\n // Return success\n return {\n success: completeResponseData.success,\n data: {\n user: completeResponseData.user,\n token: completeResponseData.token,\n credential: completeResponseData.credential,\n session: completeResponseData.session\n }\n }\n } catch (error) {\n // Return error\n return {\n success: false,\n error: {\n message: error instanceof Error ? error.message : \"Unknown error\"\n }\n }\n }\n }\n\n /\n Authenticates a user. Can be used for login, verification, 2FA, etc.\n * Will require user interaction to authenticate.\n \n @param userIdentifier - An object with either the user's PlainKey User ID or their userName.\n */\n async authenticate(userIdentifier: UserIdentifier): Promise<AuthenticateResult> {\n // Validate user identifier\n if (!userIdentifier) throw new Error(\"User identifier is required\")\n if (!userIdentifier.userId && !userIdentifier.userName)\n throw new Error(\"Either a userId or a userName is required\")\n\n try {\n // Step 1: Get authentication options from server\n const beginParams: LoginBeginRequest = { userIdentifier }\n const beginResponse = await fetch(`${this.baseUrl}/login/begin`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(beginParams)\n })\n\n // Parse response JSON\n const beginResponseData: LoginBeginResponse =\n await this.parseResponse<LoginBeginResponse>(beginResponse)\n\n if (!beginResponseData.options)\n throw new Error(\"Server returned no options in login begin response\")\n\n // Step 2: Pass options to the authenticator and wait for response\n const authenticationResponse: AuthenticationResponseJSON = await startAuthentication({\n optionsJSON: beginResponseData.options\n })\n\n if (!authenticationResponse) throw new Error(\"No authentication response from browser\")\n\n // Step 3: POST the response to the server\n // This uses the login session ID from the begin response - always in JS memory.\n // Do not store it in local storage, database, etc.\n const completeParams: LoginCompleteRequest = {\n loginSessionId: beginResponseData.loginSession.id,\n authenticationResponse\n }\n\n const verificationResponse = await fetch(`${this.baseUrl}/login/complete`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(completeParams)\n })\n\n const verificationResponseData: LoginCompleteResponse =\n await this.parseResponse<LoginCompleteResponse>(verificationResponse)\n\n if (!verificationResponseData.verified) throw new Error(\"Server could not verify login\")\n\n // Return success\n return {\n success: verificationResponseData.verified,\n data: {\n user: verificationResponseData.user,\n token: verificationResponseData.token,\n session: verificationResponseData.session\n }\n }\n } catch (error) {\n // Return error\n return {\n success: false,\n error: {\n message: error instanceof Error ? error.message : \"Unknown error\"\n }\n }\n }\n }\n}\n"],"mappings":";;;;;;;;;;;AAiCA,IAAa,WAAb,MAAsB;CAIpB,YAAY,WAAmB,UAAkB,+BAA+B;AAC9E,MAAI,CAAC,UAAW,OAAM,IAAI,MAAM,yBAAyB;AACzD,MAAI,CAAC,QAAS,OAAM,IAAI,MAAM,uBAAuB;AAErD,OAAK,YAAY;AACjB,OAAK,UAAU,QAAQ,QAAQ,OAAO,GAAG;;;;;;CAO3C,MAAc,cAAuB,UAAgC;EACnE,IAAIA;AAGJ,MAAI;AACF,cAAW,MAAM,SAAS,MAAM;UAC1B;AACN,SAAM,IAAI,MAAM,8CAA8C;;EAIhE,IAAIC;AAEJ,MAAI;AACF,UAAO,WAAW,KAAK,MAAM,SAAS,GAAG,EAAE;UACrC;AACN,OAAI,CAAC,SAAS,GAAI,OAAM,IAAI,MAAM,iDAAiD;AACnF,SAAM,IAAI,MAAM,oCAAoC;;AAGtD,MAAI,CAAC,SAAS,IAAI;GAEhB,MAAM,UAAU,QAAQ,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ;AACtE,SAAM,IAAI,MAAM,QAAQ;;AAG1B,SAAO;;;;;;;;CAST,MAAM,sBAAsB,UAAyD;AACnF,MAAI;GAEF,MAAMC,cAAwC,EAAE,UAAU;GAC1D,MAAM,gBAAgB,MAAM,MAAM,GAAG,KAAK,QAAQ,uBAAuB;IACvE,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,YAAY;IAClC,CAAC;GAGF,MAAM,EAAE,SAAS,SAAS,MAAM,KAAK,cAAyC,cAAc;GAG5F,MAAMC,aAAuC,MAAM,kBAAkB,EACnE,aAAa,SACd,CAAC;GAGF,MAAMC,iBAA8C;IAClD,gBAAgB,EAAE,QAAQ,KAAK,IAAI;IACnC;IACD;GAED,MAAM,mBAAmB,MAAM,MAAM,GAAG,KAAK,QAAQ,0BAA0B;IAC7E,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,eAAe;IACrC,CAAC;GAGF,MAAMC,uBACJ,MAAM,KAAK,cAA4C,iBAAiB;AAE1E,OAAI,CAAC,qBAAqB,QAAS,OAAM,IAAI,MAAM,yCAAyC;AAG5F,UAAO;IACL,SAAS,qBAAqB;IAC9B,MAAM;KACJ,MAAM,qBAAqB;KAC3B,OAAO,qBAAqB;KAC5B,YAAY,qBAAqB;KACjC,SAAS,qBAAqB;KAC/B;IACF;WACM,OAAO;AAEd,UAAO;IACL,SAAS;IACT,OAAO,EACL,SAAS,iBAAiB,QAAQ,MAAM,UAAU,iBACnD;IACF;;;;;;;;;;;CAYL,MAAM,WAAW,WAAmB,gBAA2D;AAC7F,MAAI;AAEF,OAAI,CAAC,eAAgB,OAAM,IAAI,MAAM,8BAA8B;AACnE,OAAI,CAAC,eAAe,UAAU,CAAC,eAAe,SAC5C,OAAM,IAAI,MAAM,4CAA4C;GAG9D,MAAMC,cAA0C;IAAE;IAAW;IAAgB;GAC7E,MAAM,gBAAgB,MAAM,MAAM,GAAG,KAAK,QAAQ,yBAAyB;IACzE,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,YAAY;IAClC,CAAC;GAGF,MAAM,EAAE,SAAS,SACf,MAAM,KAAK,cAA2C,cAAc;GAGtE,MAAMH,aAAuC,MAAM,kBAAkB,EACnE,aAAa,SACd,CAAC;GAGF,MAAMI,iBAAgD;IACpD,WAAW,YAAY;IACvB,gBAAgB,EAAE,QAAQ,KAAK,IAAI;IACnC;IACD;GAED,MAAM,mBAAmB,MAAM,MAAM,GAAG,KAAK,QAAQ,4BAA4B;IAC/E,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,eAAe;IACrC,CAAC;GAGF,MAAMC,uBACJ,MAAM,KAAK,cAA8C,iBAAiB;AAE5E,OAAI,CAAC,qBAAqB,QACxB,OAAM,IAAI,MAAM,iDAAiD;AAGnE,UAAO;IACL,SAAS,qBAAqB;IAC9B,MAAM;KACJ,MAAM,qBAAqB;KAC3B,OAAO,qBAAqB;KAC5B,YAAY,qBAAqB;KACjC,SAAS,qBAAqB;KAC/B;IACF;WACM,OAAO;AAEd,UAAO;IACL,SAAS;IACT,OAAO,EACL,SAAS,iBAAiB,QAAQ,MAAM,UAAU,iBACnD;IACF;;;;;;;;;CAUL,MAAM,aAAa,gBAA6D;AAE9E,MAAI,CAAC,eAAgB,OAAM,IAAI,MAAM,8BAA8B;AACnE,MAAI,CAAC,eAAe,UAAU,CAAC,eAAe,SAC5C,OAAM,IAAI,MAAM,4CAA4C;AAE9D,MAAI;GAEF,MAAMC,cAAiC,EAAE,gBAAgB;GACzD,MAAM,gBAAgB,MAAM,MAAM,GAAG,KAAK,QAAQ,eAAe;IAC/D,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,YAAY;IAClC,CAAC;GAGF,MAAMC,oBACJ,MAAM,KAAK,cAAkC,cAAc;AAE7D,OAAI,CAAC,kBAAkB,QACrB,OAAM,IAAI,MAAM,qDAAqD;GAGvE,MAAMC,yBAAqD,MAAM,oBAAoB,EACnF,aAAa,kBAAkB,SAChC,CAAC;AAEF,OAAI,CAAC,uBAAwB,OAAM,IAAI,MAAM,0CAA0C;GAKvF,MAAMC,iBAAuC;IAC3C,gBAAgB,kBAAkB,aAAa;IAC/C;IACD;GAED,MAAM,uBAAuB,MAAM,MAAM,GAAG,KAAK,QAAQ,kBAAkB;IACzE,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,eAAe;IACrC,CAAC;GAEF,MAAMC,2BACJ,MAAM,KAAK,cAAqC,qBAAqB;AAEvE,OAAI,CAAC,yBAAyB,SAAU,OAAM,IAAI,MAAM,gCAAgC;AAGxF,UAAO;IACL,SAAS,yBAAyB;IAClC,MAAM;KACJ,MAAM,yBAAyB;KAC/B,OAAO,yBAAyB;KAChC,SAAS,yBAAyB;KACnC;IACF;WACM,OAAO;AAEd,UAAO;IACL,SAAS;IACT,OAAO,EACL,SAAS,iBAAiB,QAAQ,MAAM,UAAU,iBACnD;IACF"}
1	+ {"version":3,"file":"index.js","names":["bodyText: string","json: any","beginParams: RegistrationBeginRequest","credential: RegistrationResponseJSON","completeParams: RegistrationCompleteRequest","completeResponseData: RegistrationCompleteResponse","beginParams: UserCredentialBeginRequest","completeParams: UserCredentialCompleteRequest","completeResponseData: UserCredentialCompleteResponse","beginParams: LoginBeginRequest","beginResponseData: LoginBeginResponse","authenticationResponse: AuthenticationResponseJSON","completeParams: LoginCompleteRequest","verificationResponseData: LoginCompleteResponse"],"sources":["../src/plainKey.ts"],"sourcesContent":["import { startAuthentication, startRegistration } from \"@simplewebauthn/browser\"\nimport { RegistrationResponseJSON, AuthenticationResponseJSON } from \"@simplewebauthn/browser\"\n\nimport type {\n RegistrationBeginRequest,\n RegistrationCompleteRequest,\n UserCredentialBeginRequest,\n UserCredentialCompleteRequest,\n LoginBeginRequest,\n LoginCompleteRequest,\n UserIdentifier,\n CreateUserWithPasskeyResult,\n AddPasskeyResult,\n AuthenticateResult\n} from \"@plainkey/types\"\n\nimport type {\n RegistrationBeginResponse,\n RegistrationCompleteResponse,\n UserCredentialBeginResponse,\n UserCredentialCompleteResponse,\n LoginBeginResponse,\n LoginCompleteResponse\n} from \"@plainkey/types\"\n\n/*\n PlainKey client for the browser. Used to register new users, add passkeys to existing users, and log users in.\n \n Docs: https://plainkey.io/docs\n \n @param projectId - Your PlainKey project ID. You can find it in the PlainKey admin dashboard.\n * @param baseUrl - Set by default to https://api.plainkey.io/api. Change only for development purposes.\n /\nexport class PlainKey {\n private readonly projectId: string\n private readonly baseUrl: string\n\n constructor(projectId: string, baseUrl: string = \"https://api.plainkey.io/api\") {\n if (!projectId) throw new Error(\"Project ID is required\")\n if (!baseUrl) throw new Error(\"Base URL is required\")\n\n this.projectId = projectId\n this.baseUrl = baseUrl.replace(/\\/$/, \"\") // Remove trailing slash\n }\n\n /\n Helper to parse response JSON.\n * Throws error if status code is not 200 OK, if the response is not valid JSON.\n /\n private async parseResponse<T = any>(response: Response): Promise<T> {\n let bodyText: string\n\n // Read as text first to avoid JSON.parse errors on any HTML/plaintext error responses.\n try {\n bodyText = await response.text()\n } catch {\n throw new Error(\"Network error while reading server response\")\n }\n\n // Parse the response text as JSON.\n let json: any\n\n try {\n json = bodyText ? JSON.parse(bodyText) : {}\n } catch {\n if (!response.ok) throw new Error(\"Server returned an invalid JSON error response\")\n throw new Error(\"Invalid JSON received from server\")\n }\n\n if (!response.ok) {\n // Server should return { error: string }\n const message = json && typeof json.error === \"string\" ? json.error : \"Unknown server error\"\n throw new Error(message)\n }\n\n return json as T\n }\n\n /\n Registration of a new user with a passkey. Will require user interaction to create a passkey.\n \n @param userName - A stable unique identifier for the user, like an email address or username.\n * Can be empty for usernameless authentication.\n /\n async createUserWithPasskey(userName?: string): Promise<CreateUserWithPasskeyResult> {\n try {\n // Step 1: Get registration options from server\n const beginParams: RegistrationBeginRequest = { userName }\n const beginResponse = await fetch(`${this.baseUrl}/user/register/begin`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(beginParams)\n })\n\n // Parse response JSON\n const { options, user } = await this.parseResponse<RegistrationBeginResponse>(beginResponse)\n\n // Step 2: Create credential using browser's WebAuthn API\n const credential: RegistrationResponseJSON = await startRegistration({\n optionsJSON: options\n })\n\n // Step 3: Send credential to server for verification\n const completeParams: RegistrationCompleteRequest = {\n userIdentifier: { userId: user.id },\n credential\n }\n\n const completeResponse = await fetch(`${this.baseUrl}/user/register/complete`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(completeParams)\n })\n\n // Parse response JSON\n const completeResponseData: RegistrationCompleteResponse =\n await this.parseResponse<RegistrationCompleteResponse>(completeResponse)\n\n if (!completeResponseData.success) throw new Error(\"Server could not complete registration\")\n\n // Return success\n return {\n success: completeResponseData.success,\n data: {\n user: completeResponseData.user,\n token: completeResponseData.token,\n credential: completeResponseData.credential,\n session: completeResponseData.session\n }\n }\n } catch (error) {\n // Return error\n return {\n success: false,\n error: {\n message: error instanceof Error ? error.message : \"Unknown error\"\n }\n }\n }\n }\n\n /\n Adds a passkey to an existing user. Will require user interaction to create a passkey.\n \n @param userToken - The user authentication token, is returned from .authenticate() and createUserWithPasskey().\n * Do NOT store it in local storage, database, etc. Always keep it in memory.\n \n @param userIdentifier - An object with either the user's PlainKey User ID or their userName.\n /\n async addPasskey(userToken: string, userIdentifier: UserIdentifier): Promise<AddPasskeyResult> {\n try {\n // Validate user identifier\n if (!userIdentifier) throw new Error(\"User identifier is required\")\n if (!userIdentifier.userId && !userIdentifier.userName)\n throw new Error(\"Either a userId or a userName is required\")\n\n // Step 1: Get credential registration options from server\n const beginParams: UserCredentialBeginRequest = { userToken, userIdentifier }\n const beginResponse = await fetch(`${this.baseUrl}/user/credential/begin`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(beginParams)\n })\n\n // Parse response JSON\n const { options, user }: UserCredentialBeginResponse =\n await this.parseResponse<UserCredentialBeginResponse>(beginResponse)\n\n // Step 2: Create credential using browser's WebAuthn API\n const credential: RegistrationResponseJSON = await startRegistration({\n optionsJSON: options\n })\n\n // Step 3: Send credential to server for verification\n const completeParams: UserCredentialCompleteRequest = {\n userToken: beginParams.userToken,\n userIdentifier: { userId: user.id },\n credential\n }\n\n const completeResponse = await fetch(`${this.baseUrl}/user/credential/complete`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(completeParams)\n })\n\n // Parse response JSON\n const completeResponseData: UserCredentialCompleteResponse =\n await this.parseResponse<UserCredentialCompleteResponse>(completeResponse)\n\n if (!completeResponseData.success)\n throw new Error(\"Server could not complete passkey registration\")\n\n // Return success\n return {\n success: completeResponseData.success,\n data: {\n user: completeResponseData.user,\n token: completeResponseData.token,\n credential: completeResponseData.credential,\n session: completeResponseData.session\n }\n }\n } catch (error) {\n // Return error\n return {\n success: false,\n error: {\n message: error instanceof Error ? error.message : \"Unknown error\"\n }\n }\n }\n }\n\n /\n Authenticates a user. Can be used for login, verification, 2FA, etc.\n * Will require user interaction to authenticate.\n \n @param userIdentifier - Optional object containing either the user's PlainKey User ID or their userName.\n * Does not have to be provided for usernameless authentication.\n */\n async authenticate(userIdentifier?: UserIdentifier): Promise<AuthenticateResult> {\n try {\n // Step 1: Get authentication options from server\n const beginParams: LoginBeginRequest = { userIdentifier }\n const beginResponse = await fetch(`${this.baseUrl}/authenticate/begin`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(beginParams)\n })\n\n // Parse response JSON\n const beginResponseData: LoginBeginResponse =\n await this.parseResponse<LoginBeginResponse>(beginResponse)\n\n if (!beginResponseData.options)\n throw new Error(\"Server returned no options in login begin response\")\n\n // Step 2: Pass options to the authenticator and wait for response\n const authenticationResponse: AuthenticationResponseJSON = await startAuthentication({\n optionsJSON: beginResponseData.options\n })\n\n if (!authenticationResponse) throw new Error(\"No authentication response from browser\")\n\n // Step 3: POST the response to the server\n // This uses the authentication session ID from the begin response - always in JS memory.\n // Do not store it in local storage, database, etc.\n const completeParams: LoginCompleteRequest = {\n loginSessionId: beginResponseData.loginSession.id,\n authenticationResponse\n }\n\n const verificationResponse = await fetch(`${this.baseUrl}/authenticate/complete`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n \"x-project-id\": this.projectId\n },\n body: JSON.stringify(completeParams)\n })\n\n const verificationResponseData: LoginCompleteResponse =\n await this.parseResponse<LoginCompleteResponse>(verificationResponse)\n\n if (!verificationResponseData.verified)\n throw new Error(\"Server could not verify authentication\")\n\n // Return success\n return {\n success: verificationResponseData.verified,\n data: {\n user: verificationResponseData.user,\n token: verificationResponseData.token,\n session: verificationResponseData.session\n }\n }\n } catch (error) {\n // Return error\n return {\n success: false,\n error: {\n message: error instanceof Error ? error.message : \"Unknown error\"\n }\n }\n }\n }\n}\n"],"mappings":";;;;;;;;;;;AAiCA,IAAa,WAAb,MAAsB;CAIpB,YAAY,WAAmB,UAAkB,+BAA+B;AAC9E,MAAI,CAAC,UAAW,OAAM,IAAI,MAAM,yBAAyB;AACzD,MAAI,CAAC,QAAS,OAAM,IAAI,MAAM,uBAAuB;AAErD,OAAK,YAAY;AACjB,OAAK,UAAU,QAAQ,QAAQ,OAAO,GAAG;;;;;;CAO3C,MAAc,cAAuB,UAAgC;EACnE,IAAIA;AAGJ,MAAI;AACF,cAAW,MAAM,SAAS,MAAM;UAC1B;AACN,SAAM,IAAI,MAAM,8CAA8C;;EAIhE,IAAIC;AAEJ,MAAI;AACF,UAAO,WAAW,KAAK,MAAM,SAAS,GAAG,EAAE;UACrC;AACN,OAAI,CAAC,SAAS,GAAI,OAAM,IAAI,MAAM,iDAAiD;AACnF,SAAM,IAAI,MAAM,oCAAoC;;AAGtD,MAAI,CAAC,SAAS,IAAI;GAEhB,MAAM,UAAU,QAAQ,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ;AACtE,SAAM,IAAI,MAAM,QAAQ;;AAG1B,SAAO;;;;;;;;CAST,MAAM,sBAAsB,UAAyD;AACnF,MAAI;GAEF,MAAMC,cAAwC,EAAE,UAAU;GAC1D,MAAM,gBAAgB,MAAM,MAAM,GAAG,KAAK,QAAQ,uBAAuB;IACvE,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,YAAY;IAClC,CAAC;GAGF,MAAM,EAAE,SAAS,SAAS,MAAM,KAAK,cAAyC,cAAc;GAG5F,MAAMC,aAAuC,MAAM,kBAAkB,EACnE,aAAa,SACd,CAAC;GAGF,MAAMC,iBAA8C;IAClD,gBAAgB,EAAE,QAAQ,KAAK,IAAI;IACnC;IACD;GAED,MAAM,mBAAmB,MAAM,MAAM,GAAG,KAAK,QAAQ,0BAA0B;IAC7E,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,eAAe;IACrC,CAAC;GAGF,MAAMC,uBACJ,MAAM,KAAK,cAA4C,iBAAiB;AAE1E,OAAI,CAAC,qBAAqB,QAAS,OAAM,IAAI,MAAM,yCAAyC;AAG5F,UAAO;IACL,SAAS,qBAAqB;IAC9B,MAAM;KACJ,MAAM,qBAAqB;KAC3B,OAAO,qBAAqB;KAC5B,YAAY,qBAAqB;KACjC,SAAS,qBAAqB;KAC/B;IACF;WACM,OAAO;AAEd,UAAO;IACL,SAAS;IACT,OAAO,EACL,SAAS,iBAAiB,QAAQ,MAAM,UAAU,iBACnD;IACF;;;;;;;;;;;CAYL,MAAM,WAAW,WAAmB,gBAA2D;AAC7F,MAAI;AAEF,OAAI,CAAC,eAAgB,OAAM,IAAI,MAAM,8BAA8B;AACnE,OAAI,CAAC,eAAe,UAAU,CAAC,eAAe,SAC5C,OAAM,IAAI,MAAM,4CAA4C;GAG9D,MAAMC,cAA0C;IAAE;IAAW;IAAgB;GAC7E,MAAM,gBAAgB,MAAM,MAAM,GAAG,KAAK,QAAQ,yBAAyB;IACzE,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,YAAY;IAClC,CAAC;GAGF,MAAM,EAAE,SAAS,SACf,MAAM,KAAK,cAA2C,cAAc;GAGtE,MAAMH,aAAuC,MAAM,kBAAkB,EACnE,aAAa,SACd,CAAC;GAGF,MAAMI,iBAAgD;IACpD,WAAW,YAAY;IACvB,gBAAgB,EAAE,QAAQ,KAAK,IAAI;IACnC;IACD;GAED,MAAM,mBAAmB,MAAM,MAAM,GAAG,KAAK,QAAQ,4BAA4B;IAC/E,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,eAAe;IACrC,CAAC;GAGF,MAAMC,uBACJ,MAAM,KAAK,cAA8C,iBAAiB;AAE5E,OAAI,CAAC,qBAAqB,QACxB,OAAM,IAAI,MAAM,iDAAiD;AAGnE,UAAO;IACL,SAAS,qBAAqB;IAC9B,MAAM;KACJ,MAAM,qBAAqB;KAC3B,OAAO,qBAAqB;KAC5B,YAAY,qBAAqB;KACjC,SAAS,qBAAqB;KAC/B;IACF;WACM,OAAO;AAEd,UAAO;IACL,SAAS;IACT,OAAO,EACL,SAAS,iBAAiB,QAAQ,MAAM,UAAU,iBACnD;IACF;;;;;;;;;;CAWL,MAAM,aAAa,gBAA8D;AAC/E,MAAI;GAEF,MAAMC,cAAiC,EAAE,gBAAgB;GACzD,MAAM,gBAAgB,MAAM,MAAM,GAAG,KAAK,QAAQ,sBAAsB;IACtE,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,YAAY;IAClC,CAAC;GAGF,MAAMC,oBACJ,MAAM,KAAK,cAAkC,cAAc;AAE7D,OAAI,CAAC,kBAAkB,QACrB,OAAM,IAAI,MAAM,qDAAqD;GAGvE,MAAMC,yBAAqD,MAAM,oBAAoB,EACnF,aAAa,kBAAkB,SAChC,CAAC;AAEF,OAAI,CAAC,uBAAwB,OAAM,IAAI,MAAM,0CAA0C;GAKvF,MAAMC,iBAAuC;IAC3C,gBAAgB,kBAAkB,aAAa;IAC/C;IACD;GAED,MAAM,uBAAuB,MAAM,MAAM,GAAG,KAAK,QAAQ,yBAAyB;IAChF,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,gBAAgB,KAAK;KACtB;IACD,MAAM,KAAK,UAAU,eAAe;IACrC,CAAC;GAEF,MAAMC,2BACJ,MAAM,KAAK,cAAqC,qBAAqB;AAEvE,OAAI,CAAC,yBAAyB,SAC5B,OAAM,IAAI,MAAM,yCAAyC;AAG3D,UAAO;IACL,SAAS,yBAAyB;IAClC,MAAM;KACJ,MAAM,yBAAyB;KAC/B,OAAO,yBAAyB;KAChC,SAAS,yBAAyB;KACnC;IACF;WACM,OAAO;AAEd,UAAO;IACL,SAAS;IACT,OAAO,EACL,SAAS,iBAAiB,QAAQ,MAAM,UAAU,iBACnD;IACF"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@plainkey/browser",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "PlainKey browser SDK for passkey registration, login and credential management",
   "type": "module",
   "main": "./dist/index.js",