@plainkey/vue 0.6.0 → 0.6.3

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { PlainKey } from "@plainkey/browser";
+import * as _plainkey_types0 from "@plainkey/types";
+import { UserIdentifier } from "@plainkey/types";
 
 //#region src/usePlainkey/index.d.ts
 
@@ -12,7 +13,11 @@ import { PlainKey } from "@plainkey/browser";
  * @example
  * const { login, createUserWithPasskey, addPasskey } = usePlainKey("projectId")
  */
-declare function usePlainKey(projectId: string, baseUrl?: string): PlainKey;
+declare function usePlainKey(projectId: string, baseUrl?: string): {
+  authenticate: (userIdentifier?: UserIdentifier) => Promise<_plainkey_types0.AuthenticateResult>;
+  createUserWithPasskey: (userName?: string) => Promise<_plainkey_types0.CreateUserWithPasskeyResult>;
+  addPasskey: (userToken: string, userIdentifier: UserIdentifier) => Promise<_plainkey_types0.AddPasskeyResult>;
+};
 //#endregion
 export { usePlainKey };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/usePlainkey/index.ts"],"sourcesContent":[],"mappings":";;;;;;AAYA;;;;;;;;iBAAgB,WAAA,uCAA+C"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/usePlainkey/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAaA;;;;;;;AA+BuE,iBA/BvD,WAAA,CA+BuD,SAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAAA,MAAA,CAAA,EAAA;EAAA,YAAA,EAAA,CAAA,cAAA,CAAA,EAtB9B,cAsB8B,EAAA,GAtBhB,OAsBgB,CAtBhB,gBAAA,CAAA,kBAAA,CAsBgB;EAAA,qBAAA,EAAA,CAAA,QAAA,CAAA,EAAA,MAAA,EAAA,GAZrB,OAYqB,CAtBhB,gBAAA,CAUL,2BAAA,CAYqB;kDAAd,mBAAc,QAAA,gBAAA,CAAA,gBAAA"}

package/dist/index.js

@@ -12,7 +12,41 @@ import { PlainKey } from "@plainkey/browser";
 * const { login, createUserWithPasskey, addPasskey } = usePlainKey("projectId")
 */
 function usePlainKey(projectId, baseUrl) {
-	return new PlainKey(projectId, baseUrl);
+	const plainKey = new PlainKey(projectId, baseUrl);
+	/**
+	* 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.
+	*/
+	function authenticate(userIdentifier) {
+		return plainKey.authenticate(userIdentifier);
+	}
+	/**
+	* 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.
+	*/
+	function createUserWithPasskey(userName) {
+		return plainKey.createUserWithPasskey(userName);
+	}
+	/**
+	* Adds a passkey to an existing user. Will require user interaction to create a passkey.
+	*
+	* @param userToken - The user authentication token, obtained from login.
+	* 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.
+	*/
+	function addPasskey(userToken, userIdentifier) {
+		return plainKey.addPasskey(userToken, userIdentifier);
+	}
+	return {
+		authenticate,
+		createUserWithPasskey,
+		addPasskey
+	};
 }
 
 //#endregion

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/usePlainkey/index.ts"],"sourcesContent":["import { PlainKey } from \"@plainkey/browser\"\n\n/**\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 *\n * Docs: https://plainkey.io/docs\n *\n * @example\n * const { login, createUserWithPasskey, addPasskey } = usePlainKey(\"projectId\")\n */\nexport function usePlainKey(projectId: string, baseUrl?: string) {\n  return new PlainKey(projectId, baseUrl)\n}\n"],"mappings":";;;;;;;;;;;;;AAYA,SAAgB,YAAY,WAAmB,SAAkB;AAC/D,QAAO,IAAI,SAAS,WAAW,QAAQ"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/usePlainkey/index.ts"],"sourcesContent":["import { PlainKey } from \"@plainkey/browser\"\nimport { UserIdentifier } from \"@plainkey/types\"\n\n/**\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 *\n * Docs: https://plainkey.io/docs\n *\n * @example\n * const { login, createUserWithPasskey, addPasskey } = usePlainKey(\"projectId\")\n */\nexport function usePlainKey(projectId: string, baseUrl?: string) {\n  const plainKey = new PlainKey(projectId, baseUrl)\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  function authenticate(userIdentifier?: UserIdentifier) {\n    return plainKey.authenticate(userIdentifier)\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  function createUserWithPasskey(userName?: string) {\n    return plainKey.createUserWithPasskey(userName)\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  function addPasskey(userToken: string, userIdentifier: UserIdentifier) {\n    return plainKey.addPasskey(userToken, userIdentifier)\n  }\n\n  return {\n    authenticate,\n    createUserWithPasskey,\n    addPasskey\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAaA,SAAgB,YAAY,WAAmB,SAAkB;CAC/D,MAAM,WAAW,IAAI,SAAS,WAAW,QAAQ;;;;;;;CAQjD,SAAS,aAAa,gBAAiC;AACrD,SAAO,SAAS,aAAa,eAAe;;;;;;;;CAS9C,SAAS,sBAAsB,UAAmB;AAChD,SAAO,SAAS,sBAAsB,SAAS;;;;;;;;;;CAWjD,SAAS,WAAW,WAAmB,gBAAgC;AACrE,SAAO,SAAS,WAAW,WAAW,eAAe;;AAGvD,QAAO;EACL;EACA;EACA;EACD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plainkey/vue",
-  "version": "0.6.0",
+  "version": "0.6.3",
   "description": "PlainKey Vue SDK (composable)",
   "type": "module",
   "main": "./dist/index.js",