Merge pull request 'add contacts DB & page' (#10) from add-contacts into master

Reviewed-on: https://gitea.anomalistdesign.com/trent_larson/kick-starter-for-time-pwa/pulls/10

project.yaml

@@ -11,7 +11,8 @@
 
 - replace user-affecting console.logs with error messages (eg. catches)
 
-- contacts
+- contacts v1:
+  - parse input correctly (with CSV lib and not commas)
 
 - commit screen
 

src/db/index.ts

@@ -1,6 +1,12 @@
-import BaseDexie from "dexie";
+import BaseDexie, { Table } from "dexie";
 import { encrypted, Encryption } from "@pvermeer/dexie-encrypted-addon";
-import { accountsSchema, AccountsTable } from "./tables/accounts";
+import { accountsSchema, Account } from "./tables/accounts";
+import { contactsSchema, Contact } from "./tables/contacts";
+
+type AllTables = {
+  accounts: Table<Account>;
+  contacts: Table<Contact>;
+};
 
 /**
  * In order to make the next line be acceptable, the program needs to have its linter suppress a rule:
@@ -10,10 +16,9 @@ import { accountsSchema, AccountsTable } from "./tables/accounts";
  *
  *   https://9to5answer.com/how-to-bypass-warning-unexpected-any-specify-a-different-type-typescript-eslint-no-explicit-any
  */
-type DexieTables = AccountsTable;
+type DexieTables = AllTables;
 export type Dexie<T extends unknown = DexieTables> = BaseDexie & T;
 export const db = new BaseDexie("kickStarter") as Dexie;
-const schema = Object.assign({}, accountsSchema);
 
 /**
  * Needed to enable a special webpack setting to allow *await* below:
@@ -27,6 +32,7 @@ const secret =
 if (localStorage.getItem("secret") == null) {
   localStorage.setItem("secret", secret);
 }
-console.log(secret);
+console.log("DB encryption secretKey:", secret);
 encrypted(db, { secretKey: secret });
-db.version(1).stores(schema);
+db.version(1).stores(accountsSchema);
+db.version(2).stores(contactsSchema);

src/db/tables/accounts.ts

@@ -1,5 +1,3 @@
-import { Table } from "dexie";
-
 export type Account = {
   id?: number;
   publicKey: string;
@@ -8,10 +6,6 @@ export type Account = {
   dateCreated: number;
 };
 
-export type AccountsTable = {
-  accounts: Table<Account>;
-};
-
 // mark encrypted field by starting with a $ character
 export const accountsSchema = {
   accounts: "++id, publicKey, $mnemonic, $identity, dateCreated",

src/db/tables/contacts.ts

@@ -0,0 +1,12 @@
+export interface Contact {
+  did: string;
+  name?: string;
+  publicKeyBase64?: string;
+  seesMe?: boolean;
+  registered?: boolean;
+}
+
+// mark encrypted field by starting with a $ character
+export const contactsSchema = {
+  contacts: "++did, name, publicKeyBase64, seesMe, registered",
+};

src/main.ts

@@ -20,6 +20,7 @@ import {
   faShareNodes,
   faQrcode,
   faUser,
+  faUsers,
   faPen,
   faPlus,
   faTrashCan,
@@ -41,6 +42,7 @@ library.add(
   faShareNodes,
   faQrcode,
   faUser,
+  faUsers,
   faPen,
   faPlus,
   faTrashCan,

src/router/index.ts

@@ -43,6 +43,12 @@ const routes: Array<RouteRecordRaw> = [
         /* webpackChunkName: "confirm-contact" */ "../views/ConfirmContactView.vue"
       ),
   },
+  {
+    path: "/contacts",
+    name: "contacts",
+    component: () =>
+      import(/* webpackChunkName: "contacts" */ "../views/ContactsView.vue"),
+  },
   {
     path: "/scan-contact",
     name: "scan-contact",

src/views/AccountViewView.vue

@@ -29,10 +29,10 @@
       <!-- Commitments -->
       <li class="basis-1/5 rounded-md text-slate-500">
         <router-link
-          :to="{ name: 'commitments' }"
+          :to="{ name: 'contacts' }"
           class="block text-center py-3 px-1"
         >
-          <fa icon="hand" class="fa-fw"></fa>
+          <fa icon="users" class="fa-fw"></fa>
         </router-link>
       </li>
       <!-- Profile -->

src/views/ContactsView.vue

@@ -0,0 +1,442 @@
+<template>
+  <!-- QUICK NAV -->
+  <nav id="QuickNav" class="fixed bottom-0 left-0 right-0 bg-slate-200">
+    <ul class="flex text-2xl p-2 gap-2">
+      <!-- Home Feed -->
+      <li class="basis-1/5 rounded-md text-slate-500">
+        <router-link :to="{ name: 'home' }" class="block text-center py-3 px-1"
+          ><fa icon="house-chimney" class="fa-fw"></fa
+        ></router-link>
+      </li>
+      <!-- Search -->
+      <li class="basis-1/5 rounded-md bg-slate-400 text-white">
+        <router-link
+          :to="{ name: 'discover' }"
+          class="block text-center py-3 px-1"
+          ><fa icon="magnifying-glass" class="fa-fw"></fa
+        ></router-link>
+      </li>
+      <!-- Contacts -->
+      <li class="basis-1/5 rounded-md text-slate-500">
+        <router-link
+          :to="{ name: 'projects' }"
+          class="block text-center py-3 px-1"
+          ><fa icon="folder-open" class="fa-fw"></fa
+        ></router-link>
+      </li>
+      <!-- Commitments -->
+      <li class="basis-1/5 rounded-md text-slate-500">
+        <router-link
+          :to="{ name: 'contacts' }"
+          class="block text-center py-3 px-1"
+          ><fa icon="users" class="fa-fw"></fa
+        ></router-link>
+      </li>
+      <!-- Profile -->
+      <li class="basis-1/5 rounded-md text-slate-500">
+        <router-link
+          :to="{ name: 'account' }"
+          class="block text-center py-3 px-1"
+          ><fa icon="circle-user" class="fa-fw"></fa
+        ></router-link>
+      </li>
+    </ul>
+  </nav>
+
+  <section id="Content" class="p-6 pb-24">
+    <!-- Heading -->
+    <h1 id="ViewHeading" class="text-4xl text-center font-light pt-4 mb-8">
+      My Contacts
+    </h1>
+
+    <!-- New Contact -->
+    <div class="mb-4 flex">
+      <input
+        type="text"
+        placeholder="DID, Name, Public Key"
+        class="block w-full rounded-l border border-r-0 border-slate-400 px-3 py-2"
+        v-model="contactInput"
+      />
+      <button
+        class="px-4 rounded-r bg-slate-200 border border-l-0 border-slate-400"
+        @click="onClickNewContact()"
+      >
+        <fa icon="plus" class="fa-fw"></fa>
+      </button>
+    </div>
+
+    <div class="flex justify-between" v-if="showGiveTotals">
+      <div class="w-full text-right">
+        Hours to Add:
+        <input
+          class="border border rounded border-slate-400 w-24 text-right"
+          type="text"
+          placeholder="1"
+          v-model="hourInput"
+        />
+        <br />
+        <input
+          class="border border rounded border-slate-400 w-48"
+          type="text"
+          placeholder="Description"
+          v-model="hourDescriptionInput"
+        />
+      </div>
+    </div>
+
+    <!-- Results List -->
+    <ul class="">
+      <li
+        class="border-b border-slate-300"
+        v-for="contact in contacts"
+        :key="contact.did"
+      >
+        <div class="grow overflow-hidden">
+          <h2 class="text-base font-semibold">
+            {{ contact.name || "(no name)" }}
+          </h2>
+          <div class="text-sm truncate">{{ contact.did }}</div>
+          <div class="text-sm truncate">{{ contact.publicKeyBase64 }}</div>
+          <div v-if="showGiveTotals" class="float-right">
+            <div class="float-right">
+              to: {{ givenByMeTotals[contact.did] || 0 }}
+              <button
+                class="text-md uppercase bg-slate-500 text-white px-1.5 py-2 rounded-md mb-6"
+                @click="onClickAddGive(identity.did, contact.did)"
+              >
+                +
+              </button>
+              by: {{ givenToMeTotals[contact.did] || 0 }}
+              <button
+                class="text-md uppercase bg-slate-500 text-white px-1.5 py-2 rounded-md mb-6"
+                @click="onClickAddGive(contact.did, identity.did)"
+              >
+                +
+              </button>
+            </div>
+          </div>
+        </div>
+      </li>
+    </ul>
+  </section>
+  <div v-bind:class="computedAlertClassNames()">
+    <button
+      class="close-button bg-slate-200 w-8 leading-loose rounded-full absolute top-2 right-2"
+      @click="onClickClose()"
+    >
+      <fa icon="xmark"></fa>
+    </button>
+    <h4 class="font-bold pr-5">{{ alertTitle }}</h4>
+    <p>{{ alertMessage }}</p>
+  </div>
+</template>
+
+<script lang="ts">
+import { AxiosError } from "axios";
+import * as didJwt from "did-jwt";
+import * as R from "ramda";
+import { Options, Vue } from "vue-class-component";
+
+import { AppString } from "@/constants/app";
+import { accessToken, SimpleSigner } from "@/libs/crypto";
+import { IIdentifier } from "@veramo/core";
+import { db } from "../db";
+import { Contact } from "../db/tables/contacts";
+
+export interface GiveVerifiableCredential {
+  "@context": string;
+  "@type": string;
+  agent: { identifier: string };
+  description?: string;
+  object: { amountOfThisGood: number; unitCode: string };
+  recipient: { identifier: string };
+}
+
+@Options({
+  components: {},
+})
+export default class ContactsView extends Vue {
+  contacts: Array<Contact> = [];
+  contactInput = "";
+  // { "did:...": amount } entry for each contact
+  givenByMeTotals: Record<string, number> = {};
+  // { "did:...": amount } entry for each contact
+  givenToMeTotals: Record<string, number> = {};
+  hourDescriptionInput = "";
+  hourInput = "0";
+  identity: IIdentifier | null = null;
+  showGiveTotals = false;
+
+  // 'created' hook runs when the Vue instance is first created
+  async created() {
+    await db.open();
+    const accounts = await db.accounts.toArray();
+    this.identity = JSON.parse(accounts[0].identity);
+    this.contacts = await db.contacts.toArray();
+
+    const params = new URLSearchParams(window.location.search);
+    this.showGiveTotals = params.get("showGiveTotals") == "true";
+    if (this.showGiveTotals) {
+      this.loadGives();
+    }
+  }
+
+  async onClickNewContact(): Promise<void> {
+    let did = this.contactInput;
+    let name, publicKeyBase64;
+    const commaPos1 = this.contactInput.indexOf(",");
+    if (commaPos1 > -1) {
+      did = this.contactInput.substring(0, commaPos1).trim();
+      name = this.contactInput.substring(commaPos1 + 1).trim();
+      const commaPos2 = this.contactInput.indexOf(",", commaPos1 + 1);
+      if (commaPos2 > -1) {
+        name = this.contactInput.substring(commaPos1 + 1, commaPos2).trim();
+        publicKeyBase64 = this.contactInput.substring(commaPos2 + 1).trim();
+      }
+    }
+    const newContact = { did, name, publicKeyBase64 };
+    await db.contacts.add(newContact);
+    this.contacts = this.contacts.concat([newContact]);
+  }
+
+  async loadGives() {
+    if (!this.identity) {
+      console.error(
+        "Attempted to load Give records with no identity available."
+      );
+      return;
+    }
+
+    const endorserApiServer = AppString.DEFAULT_ENDORSER_API_SERVER;
+
+    // load all the time I have given
+    try {
+      const url =
+        endorserApiServer +
+        "/api/v2/report/gives?agentId=" +
+        encodeURIComponent(this.identity?.did);
+      const token = await accessToken(this.identity);
+      const headers = {
+        "Content-Type": "application/json",
+        Authorization: "Bearer " + token,
+      };
+      const resp = await this.axios.get(url, { headers });
+      //console.log("Server response", resp.status, resp.data);
+      if (resp.status === 200) {
+        const contactTotals: Record<string, number> = {};
+        for (const give of resp.data.data) {
+          if (give.unit == "HUR") {
+            const recipDid: string = give.recipientDid;
+            const prevAmount = contactTotals[recipDid] || 0;
+            contactTotals[recipDid] = prevAmount + give.amount;
+          }
+        }
+        //console.log("Done retrieving gives", contactTotals);
+        this.givenByMeTotals = contactTotals;
+      }
+    } catch (error) {
+      this.alertTitle = "Error from Server";
+      this.alertMessage = error as string;
+      this.isAlertVisible = true;
+    }
+
+    // load all the time I have received
+    try {
+      const url =
+        endorserApiServer +
+        "/api/v2/report/gives?recipientId=" +
+        encodeURIComponent(this.identity.did);
+      const token = await accessToken(this.identity);
+      const headers = {
+        "Content-Type": "application/json",
+        Authorization: "Bearer " + token,
+      };
+      const resp = await this.axios.get(url, { headers });
+      //console.log("Server response", resp.status, resp.data);
+      if (resp.status === 200) {
+        const contactTotals: Record<string, number> = {};
+        for (const give of resp.data.data) {
+          if (give.unit == "HUR") {
+            const prevAmount = contactTotals[give.agentDid] || 0;
+            contactTotals[give.agentDid] = prevAmount + give.amount;
+          }
+        }
+        //console.log("Done retrieving receipts", contactTotals);
+        this.givenToMeTotals = contactTotals;
+      }
+    } catch (error) {
+      this.alertTitle = "Error from Server";
+      this.alertMessage = error as string;
+      this.isAlertVisible = true;
+    }
+  }
+
+  // from https://stackoverflow.com/a/175787/845494
+  //
+  private isNumeric(str: string): boolean {
+    return !isNaN(+str);
+  }
+
+  private nameForDid(contacts: Array<Contact>, did: string): string {
+    const contact = R.find((con) => con.did == did, contacts);
+    return contact?.name || "this unnamed user";
+  }
+
+  async onClickAddGive(fromDid: string, toDid: string): Promise<void> {
+    if (!this.isNumeric(this.hourInput)) {
+      this.alertTitle = "Input Error";
+      this.alertMessage =
+        "This is not a valid number of hours: " + this.hourInput;
+      this.isAlertVisible = true;
+    } else if (!parseFloat(this.hourInput)) {
+      this.alertTitle = "Input Error";
+      this.alertMessage = "Giving 0 hours does nothing.";
+      this.isAlertVisible = true;
+    } else if (!this.identity) {
+      this.alertTitle = "Status Error";
+      this.alertMessage = "No identity is available.";
+      this.isAlertVisible = true;
+    } else {
+      let toFrom;
+      if (fromDid == this.identity?.did) {
+        toFrom = "from you to " + this.nameForDid(this.contacts, toDid);
+      } else {
+        toFrom = "from " + this.nameForDid(this.contacts, fromDid) + " to you";
+      }
+      if (
+        confirm(
+          "Are you sure you want to record " +
+            this.hourInput +
+            " hours " +
+            toFrom +
+            "?"
+        )
+      ) {
+        this.createAndSubmitGive(
+          this.identity,
+          fromDid,
+          toDid,
+          parseFloat(this.hourInput),
+          this.hourDescriptionInput
+        );
+      }
+    }
+  }
+
+  private async createAndSubmitGive(
+    identity: IIdentifier,
+    fromDid: string,
+    toDid: string,
+    amount: number,
+    description: string
+  ): Promise<void> {
+    // Make a claim
+    const vcClaim: GiveVerifiableCredential = {
+      "@context": "https://schema.org",
+      "@type": "GiveAction",
+      agent: { identifier: fromDid },
+      object: { amountOfThisGood: amount, unitCode: "HUR" },
+      recipient: { identifier: toDid },
+    };
+    if (description) {
+      vcClaim.description = description;
+    }
+    // Make a payload for the claim
+    const vcPayload = {
+      vc: {
+        "@context": ["https://www.w3.org/2018/credentials/v1"],
+        type: ["VerifiableCredential"],
+        credentialSubject: vcClaim,
+      },
+    };
+    // Create a signature using private key of identity
+    if (identity.keys[0].privateKeyHex !== null) {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const privateKeyHex: string = identity.keys[0].privateKeyHex!;
+      const signer = await SimpleSigner(privateKeyHex);
+      const alg = undefined;
+      // Create a JWT for the request
+      const vcJwt: string = await didJwt.createJWT(vcPayload, {
+        alg: alg,
+        issuer: identity.did,
+        signer: signer,
+      });
+
+      // Make the xhr request payload
+
+      const payload = JSON.stringify({ jwtEncoded: vcJwt });
+      const endorserApiServer = AppString.DEFAULT_ENDORSER_API_SERVER;
+      const url = endorserApiServer + "/api/v2/claim";
+      const token = await accessToken(identity);
+      const headers = {
+        "Content-Type": "application/json",
+        Authorization: "Bearer " + token,
+      };
+
+      try {
+        const resp = await this.axios.post(url, payload, { headers });
+        //console.log("Got resp data:", resp.data);
+        if (resp.data?.success?.handleId) {
+          this.alertTitle = "";
+          this.alertMessage = "";
+          if (fromDid === identity.did) {
+            this.givenByMeTotals[toDid] = this.givenByMeTotals[toDid] + amount;
+            // do this to update the UI (is there a better way?)
+            // eslint-disable-next-line no-self-assign
+            this.givenByMeTotals = this.givenByMeTotals;
+          } else {
+            this.givenToMeTotals[fromDid] =
+              this.givenToMeTotals[fromDid] + amount;
+            // do this to update the UI (is there a better way?)
+            // eslint-disable-next-line no-self-assign
+            this.givenToMeTotals = this.givenToMeTotals;
+          }
+        }
+      } catch (error) {
+        let userMessage = "There was an error. See logs for more info.";
+        const serverError = error as AxiosError;
+        if (serverError) {
+          if (serverError.message) {
+            userMessage = serverError.message; // Info for the user
+          } else {
+            userMessage = JSON.stringify(serverError.toJSON());
+          }
+        } else {
+          userMessage = error as string;
+        }
+        // Now set that error for the user to see.
+        this.alertTitle = "Error with Server";
+        this.alertMessage = userMessage;
+        this.isAlertVisible = true;
+      }
+    }
+  }
+
+  alertTitle = "";
+  alertMessage = "";
+  isAlertVisible = false;
+
+  public onClickClose() {
+    this.isAlertVisible = false;
+    this.alertTitle = "";
+    this.alertMessage = "";
+  }
+
+  public computedAlertClassNames() {
+    return {
+      hidden: !this.isAlertVisible,
+      "dismissable-alert": true,
+      "bg-slate-100": true,
+      "p-5": true,
+      rounded: true,
+      "drop-shadow-lg": true,
+      absolute: true,
+      "top-3": true,
+      "inset-x-3": true,
+      "transition-transform": true,
+      "ease-in": true,
+      "duration-300": true,
+    };
+  }
+}
+</script>

src/views/DiscoverView.vue

@@ -26,8 +26,10 @@
       </li>
       <!-- Commitments -->
       <li class="basis-1/5 rounded-md text-slate-500">
-        <router-link :to="{ name: '' }" class="block text-center py-3 px-1"
+        <router-link
-          ><fa icon="hand" class="fa-fw"></fa
+          :to="{ name: 'contacts' }"
+          class="block text-center py-3 px-1"
+          ><fa icon="users" class="fa-fw"></fa
         ></router-link>
       </li>
       <!-- Profile -->

src/views/NewEditProjectView.vue

@@ -107,6 +107,7 @@ export default class NewEditProjectView extends Vue {
   isHiddenSave = false;
   isHiddenSpinner = true;
 
+  // 'created' hook runs when the Vue instance is first created
   async created() {
     if (this.projectId === "") {
       console.log("This is a new project");

src/views/ProjectViewView.vue

@@ -222,6 +222,7 @@ export default class ProjectViewView extends Vue {
     }
   }
 
+  // 'created' hook runs when the Vue instance is first created
   async created() {
     await db.open();
     const num_accounts = await db.accounts.count();

src/views/ProjectsView.vue

@@ -26,8 +26,10 @@
       </li>
       <!-- Commitments -->
       <li class="basis-1/5 rounded-md text-slate-500">
-        <router-link :to="{ name: '' }" class="block text-center py-3 px-1"
+        <router-link
-          ><fa icon="hand" class="fa-fw"></fa
+          :to="{ name: 'contacts' }"
+          class="block text-center py-3 px-1"
+          ><fa icon="users" class="fa-fw"></fa
         ></router-link>
       </li>
       <!-- Profile -->
@@ -151,6 +153,7 @@ export default class ProjectsView extends Vue {
     }
   }
 
+  // 'created' hook runs when the Vue instance is first created
   async created() {
     await db.open();
     const num_accounts = await db.accounts.count();