@loginid/websdk3 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 1.0.0 (2024-2-23)
+
+
+### Features
+
+* **autofill passkeys:** added conditional UI capability to passkey authentication ([7222cf2](https://gitlab.com/loginid/software/sdks/websdk3/commit/7222cf274c7a566e8fa04bc12fc98952fc4b06b8))
+* **conditional ui check:** added conditional UI availability helper function ([f6be2f0](https://gitlab.com/loginid/software/sdks/websdk3/commit/f6be2f028a3d1a8947aa6815994561e09e5d93a7))
+* **initalization:** initial implementation of the sdk ([700d37b](https://gitlab.com/loginid/software/sdks/websdk3/commit/700d37beb198d50358a0c414237d669a05290d7f))
+* **passkeyerror:** identify passkey errors with PasskeyError to provide better error messages ([bde5a4c](https://gitlab.com/loginid/software/sdks/websdk3/commit/bde5a4c9b71c57950e636a94f07bfafea76e865c))

package/README.md

@@ -0,0 +1,50 @@
+# LoginID Web SDK
+
+The LoginID Web SDK provides a comprehensive solution for integrating passkey-based authentication into web applications. This SDK leverages the Web Authentication (WebAuthn) API for creating and managing passkeys, facilitating a more secure and user-friendly authentication experience.
+
+## Features
+
+- **Passkey Authentication**: Simplifies the process of authenticating users with passkeys, aligning with modern security standards.
+- **Device Compatibility Checks**: Includes utilities to determine if the user's device supports passkeys.
+- **WebAuthn Integration**: Utilizes the WebAuthn standard for creating and retrieving credentials, offering robust security features.
+- **Comprehensive Passkey Management**: Offers functionalities to manage passkeys, including creation, registration, and authentication, as well as managing passkey details (e.g., renaming, listing, and deletion).
+
+## Installation
+
+To integrate the LoginID Web SDK into your project, run the following command:
+
+```sh
+npm install @loginid/websdk3
+```
+
+## How to Use
+
+- visit our [API Reference documentation](https://docs.loginid.io/Client-SDKs/Web/web) for package implementation.
+
+## License
+
+This project is licensed under the ISC License.
+
+### ISC License (Internet Systems Consortium License)
+
+The ISC License is a simple and permissive open-source software license. It is similar in spirit to the MIT and BSD licenses. Here are the key points to understand about the ISC License:
+
+- **Permission to Use:** You are granted the permission to use, copy, modify, and distribute the software for any purpose, whether for personal, educational, or commercial use.
+- **No Warranty:** The software is provided "as is," without any warranties. The author or maintainer of the software is not liable for any issues or damages arising from its use.
+- **Redistribution:** You are free to redistribute the software in its original source code or compiled binary form, provided you include the original copyright notice and the ISC License text.
+- **Minimalistic:** The ISC License is known for its minimalistic and concise text, making it easy to understand and comply with.
+
+### Summary
+
+The ISC License is a straightforward and permissive license that encourages collaboration and the free use of software in your projects. It offers the freedom to modify, share, and build upon software while requiring minimal legal documentation. You can use software under the ISC License for personal, educational, or commercial purposes.
+
+For more details, please refer to the [full text of the ISC License](https://opensource.org/license/isc-license-txt/).
+
+Link to ISC License
+[ISC License (Full Text)](./LICENSE.md)
+
+## Contact and Support
+
+- **Email**: [support@loginid.io](mailto:support@loginid.io)
+- **Community Chat**: [Join our Slack](https://loginidiocommunity.slack.com)
+- **Documentation**: [Read our full documentation](https://docs.loginid.io)

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@loginid/websdk3",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --noEmit & tsup ./src/index.ts --no-config  --sourcemap --format esm,cjs --dts --minify",
+    "build:watch": "tsc --noEmit & tsup ./src/index.ts --watch --no-config --format esm,cjs --dts --minify",
+    "commit:pre": "npm run lint && npm run format",
+    "delete-maps": "npm run delete-map-files && npm run delete-references-to-map-files",
+    "delete-map-files": "find ./dist -name '*.map' -delete",
+    "delete-references-to-map-files": "find ./dist -name '*.js' -or -name '*.mjs' -exec sed -i -e 's/sourceMappingURL=[^ ]*.map//g' {} +",
+    "format": "pretty-quick --staged",
+    "gen": "openapi --input ./openapi.yaml --output ./src/api --name LoginIDService --useOptions --useUnionTypes",
+    "commit": "cz",
+    "lint": "eslint \"src/**/*.ts?(x)\"",
+    "lint:fix": "eslint \"src/**/*.ts?(x)\" --fix",
+    "log:env": "echo Using MODE: $MODE && echo Using APP_ENV: $APP_ENV",
+    "test": "jest"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run commit:pre"
+    }
+  },
+  "author": "LoginID Inc.",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/ua-parser-js": "^0.7.39",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "commitizen": "^4.3.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.56.0",
+    "husky": "^9.0.10",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "openapi-typescript-codegen": "^0.27.0",
+    "pretty-quick": "^4.0.0",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3"
+  },
+  "keywords": [
+    "authentication",
+    "passkey",
+    "fido2",
+    "biometrics",
+    "webauthn",
+    "passwordless"
+  ],
+  "dependencies": {
+    "ua-parser-js": "^1.0.37"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  }
+}