initial commit

Author: connerdouglass

.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: Docs
+
+on:
+ push:
+ branches:
+ - master
+
+jobs:
+ docs:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Setup Node.js
+ uses: actions/setup-node@v2
+
+ - name: Install dependencies
+ run: npm ci
+
+ - name: Test to see if the project compiles
+ run: npm run build:check
+
+ - name: Create the docs directory locally in CI
+ run: npm run docs
+
+ - name: Deploy 🚀
+ uses: JamesIves/github-pages-deploy-action@4.1.4
+ with:
+ branch: gh-pages
+ folder: docs

.github/workflows/release.yml

@@ -0,0 +1,22 @@
+on:
+ release:
+ types: [created]
+
+name: Release
+
+jobs:
+ release:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Setup Node.js
+ uses: actions/setup-node@v2
+
+ - name: Install dependencies
+ run: npm ci
+
+ - uses: JS-DevTools/npm-publish@v1
+ with:
+ token: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+
+on:
+ pull_request:
+ push:
+ branches:
+ - master
+
+jobs:
+ test:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout the repository
+ uses: actions/checkout@v2
+
+ - name: Setup Node.js
+ uses: actions/setup-node@v2
+
+ - name: Install dependencies
+ run: npm ci
+
+ - name: Test to see if the project compiles
+ run: npm run build:check
+
+ - name: Check code formatting with ESLint
+ run: npm run lint:check

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+/node_modules
+/dist
+/docs

.prettierignore

@@ -0,0 +1,7 @@
+.github
+node_modules
+dist
+docs
+out
+.eslintrc.js
+*.min.js

.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+trailingComma: 'es5',
+useTabs: true,
+tabWidth: 4,
+semi: true,
+singleQuote: true,
+};

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Spire Technology Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,45 @@
+# js-webauthn
+
+A TypeScript / JavaScript library for registering and authenticating with WebAuthn.
+
+This library is intended to integrate with the Go backend library [spiretechnology/go-webauthn](https://github.com/spiretechnology/go-webauthn). Together, these two libraries will abstract away the complexities of WebAuthn encoding, decoding, verification, etc.
+
+## Installation
+
+```sh
+npm install --save @spiretechnology/js-webauthn
+```
+
+## Example usage
+
+```ts
+import { WebAuthnClient } from '@spiretechnology/js-webauthn';
+
+const client = new WebAuthnClient();
+
+async function register() {
+ // Request a challenge from the server
+ const challenge = //...
+
+ // Register a device with the WebAuthn client
+ const response = await client.register(challenge);
+
+ // Send the response to the server
+ // ...
+}
+
+async function authenticate() {
+ // Request a challenge from the server
+ const challenge = //...
+
+ // Authenticate with the WebAuthn client
+ const response = await client.authenticate(challenge);
+
+ // Send the response to the server
+ // ...
+}
+```
+
+## Other resources
+
+- [spiretechnology/go-webauthn](https://github.com/spiretechnology/go-webauthn) - WebAuthn backend library for Go.

jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+transform: { '^.+\\.ts?$': 'ts-jest' },
+testEnvironment: 'node',
+testRegex: '/src/.*\\.(test|spec)?\\.(ts|tsx)$',
+moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+};