@plainkey/vue 0.16.0

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import * as _plainkey_types0 from "@plainkey/types";
+import { UserIdentifier } from "@plainkey/types";
+
+//#region src/usePlainkey/index.d.ts
+
+/**
+ *
+ * @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/browser. 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: (authenticationToken: string, userName?: string) => Promise<_plainkey_types0.AddPasskeyResult>;
+};
+//#endregion
+export { usePlainKey };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/usePlainkey/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAaA;;;;;;;AA+BoE,iBA/BpD,WAAA,CA+BoD,SAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAAA,MAAA,CAAA,EAAA;EAAA,YAAA,EAAA,CAAA,cAAA,CAAA,EAtB3B,cAsB2B,EAAA,GAtBb,OAsBa,CAtBb,gBAAA,CAAA,kBAAA,CAsBa;gDAZlB,QAVK,gBAAA,CAUL,2BAAA;kEAYkB,QAZlB,gBAAA,CAYkB,gBAAA"}

package/dist/index.js

@@ -0,0 +1,54 @@
+import { PlainKey } from "@plainkey/browser";
+
+//#region src/usePlainkey/index.ts
+/**
+*
+* @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/browser. 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);
+	}
+	/**
+	* 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 authenticationToken - The user authentication token, is returned from .authenticate() or createUserWithPasskey().
+	* Do NOT store it in local storage, database, etc. Always keep it in memory.
+	* @param userName - A stable unique identifier for the user, like an email address or username.
+	* If not provided, the user's stored userName will be used.
+	*/
+	function addPasskey(authenticationToken, userName) {
+		return plainKey.addPasskey(authenticationToken, userName);
+	}
+	return {
+		authenticate,
+		createUserWithPasskey,
+		addPasskey
+	};
+}
+
+//#endregion
+export { usePlainKey };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/usePlainkey/index.ts"],"sourcesContent":["import { PlainKey } from \"@plainkey/browser\"\nimport type { 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/browser. 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 authenticationToken - The user authentication token, is returned from .authenticate() or createUserWithPasskey().\n   * Do NOT store it in local storage, database, etc. Always keep it in memory.\n   * @param userName - A stable unique identifier for the user, like an email address or username.\n   * If not provided, the user's stored userName will be used.\n   */\n  function addPasskey(authenticationToken: string, userName?: string) {\n    return plainKey.addPasskey(authenticationToken, userName)\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,qBAA6B,UAAmB;AAClE,SAAO,SAAS,WAAW,qBAAqB,SAAS;;AAG3D,QAAO;EACL;EACA;EACA;EACD"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@plainkey/vue",
+  "version": "0.16.0",
+  "description": "PlainKey Vue SDK. Experimental!",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "vue": "^3.4.0"
+  },
+  "dependencies": {
+    "@plainkey/browser": "0.16.0",
+    "@plainkey/types": "0.16.0"
+  },
+  "scripts": {
+    "build": "tsdown --clean --config tsdown.config.ts",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "tsdown": "^0.15.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}