@dustid/dust-go-connect 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ryan Sonshine
+
+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.

package/README.md

@@ -0,0 +1,108 @@
+# @dustid/dust-go-connect
+
+> DUST Go is a prototyping platform that allows developers to create
+> mobile webapps that leverage DUST Identity's platform-dependent
+> functionality without requiring an upfront investment into mobile
+> toolchains.
+
+## Install
+
+```bash
+npm install @dustid/dust-go-connect
+```
+
+## Usage
+
+```typescript
+// NOTE: connector will be undefined if running outside DUST Go
+import { connector } from @dustid/dust-go';
+
+const scans: {data: string, metadata: Record<string, unknownn>}[] = [];
+
+connector?.add("unique-id-for-this-listener", (event: ScanEvent) => {
+  if (event.type === 'scan') scans.push(event.payload)
+  if (event.type === 'hide') // do something
+  if (event.type === 'show') // do something
+});
+connector?.showScanner();
+```
+
+# API
+
+## High Level API
+
+`scanAsync()` Presents the scanner, and awaits a scan.
+Rejects if scanner is hidden.
+
+```typescript
+// scanAsync(): Promise<ScanPayload>
+const scan = await scanAsync();
+```
+
+## DUST Go Connector
+
+This is more low level, but more flexible.
+
+```typescript
+connector.showScanner(): void
+```
+
+Shows the scanner modal over the main webview.
+
+```typescript
+connector.hideScanner(): void
+```
+
+Hides the scanner modal, returning to the main webview.
+Note, this can be called even while the webview is in the "background", the
+webview isn't paused while the scanner is presented.
+
+### Events
+
+```typescript
+type ScanPayload = { data: string; metadata?: Record<string, string> };
+```
+
+| Scan Events                             |
+| --------------------------------------- |
+| `{ type: 'scan', payload: ScanPayload}` |
+| `{ type: 'show' }`                      |
+| `{ type: 'hide' }`                      |
+
+```typescript
+connector.dispatch(event: ScanEvent): void
+```
+
+Add a listener with a unique identifier.
+
+```typescript
+connector.add(id: string, cb: (event: ScanEvent) => void): void
+```
+
+Remove the listener with the provided identifier.
+
+```typescript
+connector.remove(id: string): void
+```
+
+Check if a listener has been added for the given id
+
+```typescript
+connector.has(id: string): boolean
+```
+
+Remove all event listeners
+
+```typescript
+connector.clear();
+```
+
+### Auth
+
+On some platforms, it's necessary to rewrite the redirects from the app to the OAuth2
+server to work around platform limitations. It's recommended to always wrap those
+redirects with this call, and let the connector no-op when no workaround is required.
+
+```typescript
+connector.rewriteRedirect(url: URL): URL
+```

package/package.json

@@ -0,0 +1,113 @@
+{
+  "name": "@dustid/dust-go-connect",
+  "version": "0.1.0",
+  "description": "A library for connecting a fronten application to the DUST GO react natie application",
+  "main": "./lib/index.js",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "clean": "rm -rf ./lib/",
+    "cm": "cz",
+    "lint": "eslint ./src/ --fix",
+    "semantic-release": "semantic-release",
+    "typedoc": "typedoc",
+    "test:watch": "jest --watch",
+    "test": "jest --coverage",
+    "typecheck": "tsc --noEmit"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Tristan Sweeney",
+    "email": "",
+    "url": "https://github.com/sweeneytr"
+  },
+  "engines": {
+    "node": ">=12.0"
+  },
+  "keywords": [
+    "boilerplate",
+    "template",
+    "typescript",
+    "vscode",
+    "jest",
+    "husky",
+    "commitizen",
+    "semantic-release",
+    "codecov"
+  ],
+  "homepage": "https://go.dustid.io",
+  "devDependencies": {
+    "@biomejs/biome": "^2.1.1",
+    "@ryansonshine/commitizen": "^4.2.8",
+    "@ryansonshine/cz-conventional-changelog": "^3.3.4",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^12.20.11",
+    "@typescript-eslint/eslint-plugin": "^4.22.0",
+    "@typescript-eslint/parser": "^4.22.0",
+    "conventional-changelog-conventionalcommits": "^5.0.0",
+    "husky": "^6.0.0",
+    "jest": "^27.2.0",
+    "lint-staged": "^13.2.1",
+    "semantic-release": "^21.0.1",
+    "ts-jest": "^27.0.5",
+    "ts-node": "^10.2.1",
+    "typedoc": "^0.26.6",
+    "typedoc-plugin-markdown": "^4.2.5",
+    "typescript": "^4.2.4"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/@ryansonshine/cz-conventional-changelog"
+    }
+  },
+  "lint-staged": {
+    "*.ts": "eslint --cache --cache-location .eslintcache --fix"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "type": "build",
+              "scope": "deps",
+              "release": "patch"
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "build",
+                "section": "Dependencies and Other Build Updates",
+                "hidden": false
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ]
+  }
+}