@plainkey/vue 0.5.2 → 0.6.2

package/dist/index.d.ts

@@ -1,41 +1,23 @@
-import { Ref } from "vue";
-import { LoginBeginRequest, LoginCompleteResponse, RegistrationBeginRequest, RegistrationCompleteResponse, UserCredentialBeginRequest, UserCredentialCompleteResponse } from "@plainkey/types";
+import * as _plainkey_types0 from "@plainkey/types";
+import { UserIdentifier } from "@plainkey/types";
 
 //#region src/usePlainkey/index.d.ts
-type ErrorResponse = {
-  error: string;
-};
-type usePlainKeyParams = {
-  projectId: string;
-  baseUrl?: string;
-};
-type LoginParams = LoginBeginRequest;
-type AddCredentialParams = UserCredentialBeginRequest;
-type RegisterParams = RegistrationBeginRequest;
-declare function usePlainKey(usePlainKeyParams: usePlainKeyParams): {
-  register: (registerParams: RegisterParams) => Promise<RegistrationCompleteResponse | ErrorResponse>;
-  isRegistering: Ref<boolean, boolean>;
-  error: Ref<string | null, string | null>;
-  registerSuccess: Ref<boolean, boolean>;
-  registeredCredential: Ref<{
-    id: string;
-    webAuthnId: string;
-  } | null, {
-    id: string;
-    webAuthnId: string;
-  } | null>;
-  registeredResponse: Ref<RegistrationCompleteResponse | null, RegistrationCompleteResponse | null>;
-  addCredential: (addCredentialParams: AddCredentialParams) => Promise<UserCredentialCompleteResponse | ErrorResponse>;
-  isAddingCredential: Ref<boolean, boolean>;
-  addCredentialError: Ref<string | null, string | null>;
-  addCredentialSuccess: Ref<boolean, boolean>;
-  addedCredentialResponse: Ref<UserCredentialCompleteResponse | null, UserCredentialCompleteResponse | null>;
-  login: (loginParams: LoginParams) => Promise<LoginCompleteResponse>;
-  isLoggingIn: Ref<boolean, boolean>;
-  loginError: Ref<string | null, string | null>;
-  loginSuccess: Ref<boolean, boolean>;
-  loggedInResponse: Ref<LoginCompleteResponse | null, LoginCompleteResponse | null>;
+
+/**
+ *
+ * @param projectId - Your PlainKey project ID. You can find it in the PlainKey admin dashboard.
+ * @param baseUrl - Set by default to https://api.plainkey.io/api. Change only for development purposes.
+ *
+ * Docs: https://plainkey.io/docs
+ *
+ * @example
+ * const { login, createUserWithPasskey, addPasskey } = usePlainKey("projectId")
+ */
+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 { AddCredentialParams, ErrorResponse, LoginParams, RegisterParams, usePlainKey, usePlainKeyParams };
+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":";;;;KAcY,aAAA;EAAA,KAAA,EAAA,MAAA;AAIZ,CAAA;AAKY,KALA,iBAAA,GAKc;EACd,SAAA,EAAA,MAAA;EACA,OAAA,CAAA,EAAA,MAAA;AAEZ,CAAA;AAA+C,KAJnC,WAAA,GAAc,iBAIqB;AAwB3B,KA3BR,mBAAA,GAAsB,0BA2Bd;AACP,KA3BD,cAAA,GAAiB,wBA2BhB;AAA+B,iBAzB5B,WAAA,CAyB4B,iBAAA,EAzBG,iBAyBH,CAAA,EAAA;EAAvC,QAAA,EAAA,CAAA,cAAA,EADe,cACf,EAAA,GAAA,OAAA,CAAQ,4BAAR,GAAuC,aAAvC,CAAA;;;;;;;;IA4BoB,EAAA,EAAA,MAAA;IACZ,UAAA,EAAA,MAAA;EAAiC,CAAA,GAAA,IAAA,CAAA;EAAzC,kBAAA,KAAA,6BAAA,GAAA,IAAA,8BAAA,GAAA,IAAA,CAAA;uCADoB,wBACpB,QAAQ,iCAAiC;;;;;uBAuBV,gBAAc,QAAQ;EAAtB,WAAA,KAAA,CAAA,OAAA,EAAA,OAAA,CAAA;EAAsB,UAAA,KAAA,CAAA,MAAA,GAAA,IAAA,EAAA,MAAA,GAAA,IAAA,CAAA;EAAR,YAAA,KAAA,CAAA,OAAA,EAAA,OAAA,CAAA"}
+{"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,EAtB/B,cAsB+B,EAAA,GAtBjB,OAsBiB,CAtBjB,gBAAA,CAAA,kBAAA,CAsBiB;EAAA,qBAAA,EAAA,CAAA,QAAA,CAAA,EAAA,MAAA,EAAA,GAZrB,OAYqB,CAtBjB,gBAAA,CAUJ,2BAAA,CAYqB;kDAAd,mBAAc,QAAA,gBAAA,CAAA,gBAAA"}

package/dist/index.js

@@ -1,111 +1,51 @@
-import { ref } from "vue";
-import { PlainKeyClient } from "@plainkey/browser";
+import { PlainKey } from "@plainkey/browser";
 
 //#region src/usePlainkey/index.ts
-function usePlainKey(usePlainKeyParams) {
-	const { projectId, baseUrl } = usePlainKeyParams;
-	const plainKeyClient = new PlainKeyClient({
-		projectId,
-		baseUrl
-	});
-	const isRegistering = ref(false);
-	const registerError = ref(null);
-	const registerSuccess = ref(false);
-	const registeredCredential = ref(null);
-	const registeredResponse = ref(null);
-	const isAddingCredential = ref(false);
-	const addCredentialError = ref(null);
-	const addCredentialSuccess = ref(false);
-	const addedCredentialResponse = ref(null);
-	const isLoggingIn = ref(false);
-	const loginError = ref(null);
-	const loginSuccess = ref(false);
-	const loggedInResponse = ref(null);
-	async function register(registerParams) {
-		try {
-			isRegistering.value = true;
-			registerError.value = null;
-			registerSuccess.value = false;
-			registeredCredential.value = null;
-			const registrationResult = await plainKeyClient.Registration({ userName: registerParams?.userName });
-			registerSuccess.value = registrationResult.success;
-			registeredCredential.value = registrationResult.credential;
-			registeredResponse.value = registrationResult;
-			return registrationResult;
-		} catch (err) {
-			registerError.value = err instanceof Error ? err.message : "Registration failed";
-			return { error: registerError.value };
-		} finally {
-			isRegistering.value = false;
-		}
+/**
+*
+* @param projectId - Your PlainKey project ID. You can find it in the PlainKey admin dashboard.
+* @param baseUrl - Set by default to https://api.plainkey.io/api. Change only for development purposes.
+*
+* Docs: https://plainkey.io/docs
+*
+* @example
+* const { login, createUserWithPasskey, addPasskey } = usePlainKey("projectId")
+*/
+function usePlainKey(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);
 	}
 	/**
-	* The user must be logged in first. Pass in their user token and project ID in beginParams.
-	* However, do not store the token in local storage, database, etc. Always keep it in memory.
+	* 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.
 	*/
-	async function addCredential(addCredentialParams) {
-		try {
-			isAddingCredential.value = true;
-			addCredentialError.value = null;
-			addCredentialSuccess.value = false;
-			addedCredentialResponse.value = null;
-			const credentialResult = await plainKeyClient.AddCredential({
-				userIdentifier: addCredentialParams.userIdentifier,
-				userToken: addCredentialParams.userToken
-			});
-			addCredentialSuccess.value = credentialResult.success;
-			addedCredentialResponse.value = credentialResult;
-			return credentialResult;
-		} catch (err) {
-			addCredentialError.value = err instanceof Error ? err.message : "Add credential failed";
-			return { error: addCredentialError.value };
-		} finally {
-			isAddingCredential.value = false;
-		}
+	function createUserWithPasskey(userName) {
+		return plainKey.createUserWithPasskey(userName);
 	}
-	async function login(loginParams) {
-		try {
-			isLoggingIn.value = true;
-			loginError.value = null;
-			loginSuccess.value = false;
-			loggedInResponse.value = null;
-			const loginResult = await plainKeyClient.Login({ userIdentifier: loginParams.userIdentifier });
-			loginSuccess.value = loginResult.verified;
-			loggedInResponse.value = loginResult;
-			return loginResult;
-		} catch (err) {
-			loginError.value = err instanceof Error ? err.message : "Login failed";
-			return {
-				verified: false,
-				user: { id: "" },
-				token: {
-					token: "",
-					expiresInSeconds: 0,
-					tokenType: ""
-				},
-				session: void 0
-			};
-		} finally {
-			isLoggingIn.value = false;
-		}
+	/**
+	* 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 {
-		register,
-		isRegistering,
-		error: registerError,
-		registerSuccess,
-		registeredCredential,
-		registeredResponse,
-		addCredential,
-		isAddingCredential,
-		addCredentialError,
-		addCredentialSuccess,
-		addedCredentialResponse,
-		login,
-		isLoggingIn,
-		loginError,
-		loginSuccess,
-		loggedInResponse
+		authenticate,
+		createUserWithPasskey,
+		addPasskey
 	};
 }
 

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["registerError: Ref<string | null>","registeredCredential: Ref<RegistrationCompleteResponse[\"credential\"] | null>","registeredResponse: Ref<RegistrationCompleteResponse | null>","addCredentialError: Ref<string | null>","addedCredentialResponse: Ref<UserCredentialCompleteResponse | null>","loginError: Ref<string | null>","loggedInResponse: Ref<LoginCompleteResponse | null>","registrationResult: RegistrationCompleteResponse","credentialResult: UserCredentialCompleteResponse","loginResult: LoginCompleteResponse"],"sources":["../src/usePlainkey/index.ts"],"sourcesContent":["import { Ref, ref } from \"vue\"\nimport { PlainKeyClient } from \"@plainkey/browser\"\nimport type {\n  RegistrationCompleteResponse,\n  UserCredentialCompleteResponse,\n  LoginCompleteResponse\n} from \"@plainkey/types\"\n\nimport type {\n  LoginBeginRequest,\n  RegistrationBeginRequest,\n  UserCredentialBeginRequest\n} from \"@plainkey/types\"\n\nexport type ErrorResponse = {\n  error: string\n}\n\nexport type usePlainKeyParams = {\n  projectId: string\n  baseUrl?: string\n}\n\nexport type LoginParams = LoginBeginRequest\nexport type AddCredentialParams = UserCredentialBeginRequest\nexport type RegisterParams = RegistrationBeginRequest\n\nexport function usePlainKey(usePlainKeyParams: usePlainKeyParams) {\n  const { projectId, baseUrl } = usePlainKeyParams\n  const plainKeyClient = new PlainKeyClient({ projectId, baseUrl })\n\n  // Registration (user creation + passkey registration)\n  const isRegistering = ref(false)\n  const registerError: Ref<string | null> = ref(null)\n  const registerSuccess = ref(false)\n  const registeredCredential: Ref<RegistrationCompleteResponse[\"credential\"] | null> = ref(null)\n  const registeredResponse: Ref<RegistrationCompleteResponse | null> = ref(null)\n\n  // Credential registration (passkey registration to existing user)\n  const isAddingCredential = ref(false)\n  const addCredentialError: Ref<string | null> = ref(null)\n  const addCredentialSuccess = ref(false)\n  const addedCredentialResponse: Ref<UserCredentialCompleteResponse | null> = ref(null)\n\n  // Login\n  const isLoggingIn = ref(false)\n  const loginError: Ref<string | null> = ref(null)\n  const loginSuccess = ref(false)\n  const loggedInResponse: Ref<LoginCompleteResponse | null> = ref(null)\n\n  async function register(\n    registerParams: RegisterParams\n  ): Promise<RegistrationCompleteResponse | ErrorResponse> {\n    try {\n      isRegistering.value = true\n      registerError.value = null\n      registerSuccess.value = false\n      registeredCredential.value = null\n\n      const registrationResult: RegistrationCompleteResponse = await plainKeyClient.Registration({\n        userName: registerParams?.userName\n      } satisfies RegistrationBeginRequest)\n\n      registerSuccess.value = registrationResult.success\n      registeredCredential.value = registrationResult.credential\n      registeredResponse.value = registrationResult\n      return registrationResult\n    } catch (err) {\n      registerError.value = err instanceof Error ? err.message : \"Registration failed\"\n      return { error: registerError.value }\n    } finally {\n      isRegistering.value = false\n    }\n  }\n\n  /**\n   * The user must be logged in first. Pass in their user token and project ID in beginParams.\n   * However, do not store the token in local storage, database, etc. Always keep it in memory.\n   */\n  async function addCredential(\n    addCredentialParams: AddCredentialParams\n  ): Promise<UserCredentialCompleteResponse | ErrorResponse> {\n    try {\n      isAddingCredential.value = true\n      addCredentialError.value = null\n      addCredentialSuccess.value = false\n      addedCredentialResponse.value = null\n\n      const credentialResult: UserCredentialCompleteResponse = await plainKeyClient.AddCredential({\n        userIdentifier: addCredentialParams.userIdentifier,\n        userToken: addCredentialParams.userToken\n      } satisfies UserCredentialBeginRequest)\n\n      addCredentialSuccess.value = credentialResult.success\n      addedCredentialResponse.value = credentialResult\n      return credentialResult\n    } catch (err) {\n      addCredentialError.value = err instanceof Error ? err.message : \"Add credential failed\"\n      return { error: addCredentialError.value }\n    } finally {\n      isAddingCredential.value = false\n    }\n  }\n\n  async function login(loginParams: LoginParams): Promise<LoginCompleteResponse> {\n    try {\n      isLoggingIn.value = true\n      loginError.value = null\n      loginSuccess.value = false\n      loggedInResponse.value = null\n\n      const loginResult: LoginCompleteResponse = await plainKeyClient.Login({\n        userIdentifier: loginParams.userIdentifier\n      } satisfies LoginBeginRequest)\n\n      // Update refs\n      loginSuccess.value = loginResult.verified\n      loggedInResponse.value = loginResult\n      return loginResult\n    } catch (err) {\n      loginError.value = err instanceof Error ? err.message : \"Login failed\"\n      return {\n        verified: false,\n        user: { id: \"\" },\n        token: { token: \"\", expiresInSeconds: 0, tokenType: \"\" },\n        session: undefined\n      }\n    } finally {\n      isLoggingIn.value = false\n    }\n  }\n\n  return {\n    register,\n    isRegistering,\n    error: registerError,\n    registerSuccess,\n    registeredCredential,\n    registeredResponse,\n    addCredential,\n    isAddingCredential,\n    addCredentialError,\n    addCredentialSuccess,\n    addedCredentialResponse,\n    login,\n    isLoggingIn,\n    loginError,\n    loginSuccess,\n    loggedInResponse\n  }\n}\n"],"mappings":";;;;AA2BA,SAAgB,YAAY,mBAAsC;CAChE,MAAM,EAAE,WAAW,YAAY;CAC/B,MAAM,iBAAiB,IAAI,eAAe;EAAE;EAAW;EAAS,CAAC;CAGjE,MAAM,gBAAgB,IAAI,MAAM;CAChC,MAAMA,gBAAoC,IAAI,KAAK;CACnD,MAAM,kBAAkB,IAAI,MAAM;CAClC,MAAMC,uBAA+E,IAAI,KAAK;CAC9F,MAAMC,qBAA+D,IAAI,KAAK;CAG9E,MAAM,qBAAqB,IAAI,MAAM;CACrC,MAAMC,qBAAyC,IAAI,KAAK;CACxD,MAAM,uBAAuB,IAAI,MAAM;CACvC,MAAMC,0BAAsE,IAAI,KAAK;CAGrF,MAAM,cAAc,IAAI,MAAM;CAC9B,MAAMC,aAAiC,IAAI,KAAK;CAChD,MAAM,eAAe,IAAI,MAAM;CAC/B,MAAMC,mBAAsD,IAAI,KAAK;CAErE,eAAe,SACb,gBACuD;AACvD,MAAI;AACF,iBAAc,QAAQ;AACtB,iBAAc,QAAQ;AACtB,mBAAgB,QAAQ;AACxB,wBAAqB,QAAQ;GAE7B,MAAMC,qBAAmD,MAAM,eAAe,aAAa,EACzF,UAAU,gBAAgB,UAC3B,CAAoC;AAErC,mBAAgB,QAAQ,mBAAmB;AAC3C,wBAAqB,QAAQ,mBAAmB;AAChD,sBAAmB,QAAQ;AAC3B,UAAO;WACA,KAAK;AACZ,iBAAc,QAAQ,eAAe,QAAQ,IAAI,UAAU;AAC3D,UAAO,EAAE,OAAO,cAAc,OAAO;YAC7B;AACR,iBAAc,QAAQ;;;;;;;CAQ1B,eAAe,cACb,qBACyD;AACzD,MAAI;AACF,sBAAmB,QAAQ;AAC3B,sBAAmB,QAAQ;AAC3B,wBAAqB,QAAQ;AAC7B,2BAAwB,QAAQ;GAEhC,MAAMC,mBAAmD,MAAM,eAAe,cAAc;IAC1F,gBAAgB,oBAAoB;IACpC,WAAW,oBAAoB;IAChC,CAAsC;AAEvC,wBAAqB,QAAQ,iBAAiB;AAC9C,2BAAwB,QAAQ;AAChC,UAAO;WACA,KAAK;AACZ,sBAAmB,QAAQ,eAAe,QAAQ,IAAI,UAAU;AAChE,UAAO,EAAE,OAAO,mBAAmB,OAAO;YAClC;AACR,sBAAmB,QAAQ;;;CAI/B,eAAe,MAAM,aAA0D;AAC7E,MAAI;AACF,eAAY,QAAQ;AACpB,cAAW,QAAQ;AACnB,gBAAa,QAAQ;AACrB,oBAAiB,QAAQ;GAEzB,MAAMC,cAAqC,MAAM,eAAe,MAAM,EACpE,gBAAgB,YAAY,gBAC7B,CAA6B;AAG9B,gBAAa,QAAQ,YAAY;AACjC,oBAAiB,QAAQ;AACzB,UAAO;WACA,KAAK;AACZ,cAAW,QAAQ,eAAe,QAAQ,IAAI,UAAU;AACxD,UAAO;IACL,UAAU;IACV,MAAM,EAAE,IAAI,IAAI;IAChB,OAAO;KAAE,OAAO;KAAI,kBAAkB;KAAG,WAAW;KAAI;IACxD,SAAS;IACV;YACO;AACR,eAAY,QAAQ;;;AAIxB,QAAO;EACL;EACA;EACA,OAAO;EACP;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACD"}
+{"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,gBAAgC;AACpD,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.5.2",
+  "version": "0.6.2",
   "description": "PlainKey Vue SDK (composable)",
   "type": "module",
   "main": "./dist/index.js",