Update README examples

Author: tylerccarson

.github/workflows/main.yml

@@ -39,15 +39,15 @@ jobs:
         working-directory: ./keeperapi
 
       - name: Examples (node) - Installation
-        run: npm run link-local
+        run: npm i
         working-directory: ./examples/print-vault-node
 
       - name: Examples (node) - Check Types
         run: npm run types:ci
         working-directory: ./examples/print-vault-node
 
       - name: Examples (browser) - Installation
-        run: npm run link-local
+        run: npm i
         working-directory: ./examples/print-vault-browser
 
       - name: Examples (browser) - Check Types

README.md

@@ -11,31 +11,23 @@ This SDK can be used from Node or from the browser
 Usage:
 
 ```bash
-npm install keeperapi
+npm install @keeper-security/keeperapi
 ```
 
-```typescript
-    try {
-        let auth = new Auth({
-            host: KeeperEnvironment.DEV
-        });
-        await auth.login(username, password);
-        console.log("login successful");
-        let vault = new Vault(auth);
-        await vault.syncDown();
-        vault.records.forEach(x => console.log(JSON.stringify(x)));
-    } catch (e) {
-        console.log(e);
-    }
-```
+## Examples
+
+Check out the example projects to see the SDK in action:
 
-For local development, 
+- [Node.js Example](examples/print-vault-node) - Print vault contents using Node.js
+- [Browser Example](examples/print-vault-browser) - Print vault contents in a React web app
+
+## Local Development
 
 ```bash
 npm run build
 ```
  from "keeperapi" folder, then
- 
+
 ```bash
 npm link ../../keeperapi
 ```

examples/print-vault-browser/README.md

@@ -5,4 +5,4 @@
 - `npm start`
 
 ### NOTES
-- By default, the `preinstall` script links the installed version of `keeperapi` to the local version in this repo
+- This example automatically uses the local `keeperapi` package from the monorepo via `file:` reference

examples/print-vault-browser/package.json

@@ -4,12 +4,11 @@
   "private": true,
   "scripts": {
     "start": "react-scripts start",
-    "link-local": "npm link ../../keeperapi",
     "types": "tsc --watch",
     "types:ci": "tsc"
   },
   "dependencies": {
-    "keeperapi": "0.2.0",
+    "@keeper-security/keeperapi": "file:../../keeperapi",
     "react": "^16.8.6",
     "react-dom": "^16.8.6"
   },

examples/print-vault-browser/src/App.tsx

@@ -57,14 +57,13 @@ class App extends Component<{}, AppState> implements AuthUI {
             newState.status.push('Logged In, querying records...')
             newState.loggedIn = true
             this.setState(newState)
-            const records = [] as DRecord[]
             const storage = {} as VaultStorage
             await syncDown({
               auth,
               storage,
             })
             newState = {...this.state}
-            newState.records = [...records.map(x => JSON.stringify(x))]
+            newState.records = [...storage.records.map(x => JSON.stringify(x))]
             this.setState(newState)
         } catch (e) {
             console.log(e)

examples/print-vault-node/README.md

@@ -5,4 +5,4 @@
 - `npm start`
 
 ### NOTES
-- By default, the `preinstall` script links the installed version of `keeperapi` to the local version in this repo
+- This example automatically uses the local `keeperapi` package from the monorepo via `file:` reference

examples/print-vault-node/package-lock.json

@@ -8,12 +8,11 @@
   "license": "ISC",
   "scripts": {
     "start": "ts-node src/index.ts",
-    "link-local": "npm link ../../keeperapi",
     "types": "tsc --watch",
     "types:ci": "tsc"
   },
   "dependencies": {
-    "@keeper-security/keeperapi": "16.0.5",
+    "@keeper-security/keeperapi": "file:../../keeperapi",
     "@types/node": "^17.0.25",
     "ts-node": "^10.7.0",
     "typescript": "^4.6.3"

examples/print-vault-node/package.json

@@ -4,26 +4,41 @@ import LoginType = Authentication.LoginType;
 
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'
 
-const clientVersion = 'w16.4.0'
+const clientVersion = 'w17.5.0'
 
 async function printVault(username: string, password: string) {
     try {
         let auth = new Auth({
             host: KeeperEnvironment.DEV,
-            clientVersion: clientVersion
+            clientVersion: clientVersion,
+            deviceConfig: { deviceName: "JS SDK Example" },
         })
         await auth.loginV3({username, password, loginType: LoginType.NORMAL})
-        console.log('login successful')
 
-        const records = [] as DRecord[]
-        const storage = {} as VaultStorage
+        const storage: VaultStorage = {
+           async put(data) {
+                if (data.kind === 'record') {
+                    console.log(JSON.stringify(data, null, 2))
+                }
+           },
+           // remaing methods are no-ops
+           async getDependencies(uid) { return undefined },
+           async addDependencies() { return },
+           async removeDependencies() { return },
+           async clear() { return },
+           async get(kind, uid) { return undefined },
+           async delete(kind, uid) { return },
+           async getKeyBytes() { return undefined },
+           async saveKeyBytes() {}
+        }
         await syncDown({
           auth,
           storage,
         })
-        records.forEach(x => console.log(JSON.stringify(x)))
+        process.exit(0)
     } catch (e) {
         console.log(e)
+        process.exit(1)
     }
 }
 

examples/print-vault-node/src/index.ts

@@ -8,5 +8,8 @@
   },
   "exclude": [
     "node_modules"
-  ]
+  ],
+  "ts-node": {
+    "emit": false
+  }
 }