contacts-pane 2.4.8 → 2.4.12-beta4

package/.eslintrc

@@ -1,10 +1,12 @@
 {
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
   "env": {
     "browser": true,
     "es6": true,
     "node": true
   },
-  "extends": "standard",
   "globals": {
     "Atomics": "readonly",
     "SharedArrayBuffer": "readonly"

package/.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - "**"
+  pull_request:
+    branches:
+      - "**"  
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version:
+          - 16.x
+          - 18.x
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test
+      - run: npm run build
+      - name: Save build
+        if: matrix.node-version == '16.x'
+        uses: actions/upload-artifact@v2
+        with:
+          name: build
+          path: |
+            .
+            !node_modules
+          retention-days: 1
+
+  npm-publish-build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v2
+        with:
+          name: build
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16.x
+      - uses: rlespinasse/github-slug-action@v3.x
+      - name: Append commit hash to package version
+        run: 'sed -i -E "s/(\"version\": *\"[^\"]+)/\1-${GITHUB_SHA_SHORT}/" package.json'
+      - name: Disable pre- and post-publish actions
+        run: 'sed -i -E "s/\"((pre|post)publish)/\"ignore:\1/" package.json'
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          tag: ${{ env.GITHUB_REF_SLUG }}
+  npm-publish-latest:
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - uses: actions/download-artifact@v2
+        with:
+          name: build
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16.x
+      - name: Disable pre- and post-publish actions
+        run: 'sed -i -E "s/\"((pre|post)publish)/\"ignore:\1/" package.json'
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          tag: latest

package/.nvmrc

@@ -1 +1 @@
-v12.7.0
+v18.19.0

package/__tests__/unit/data-reformat-test.js

@@ -0,0 +1,166 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { getDataModelIssues } from '../../contactLogic';
+import fetchMock from "jest-fetch-mock";
+import pane from "../../contactsPane";
+import { parse } from "rdflib";
+import { context, doc, mockFetchFunction, mockUpdate, ns, store, prefixes, web } from "./setup";
+// This was at testingsolidos.solidcommunity.net
+const base = doc.dir().uri;
+const webid1 = store.sym(base + 'People/localPerson/index.ttl#this');
+const exampleData = prefixes + `
+
+:homeGroup1 a vcard:Group;
+    vcard:fn "Happy Home";
+    vcard:hasMember ${webid1} .
+
+:homeGroup2 a vcard:Group;
+    vcard:fn "Home";
+    vcard:hasMember :localPerson.
+
+:homeGroup3 a vcard:Group;
+    vcard:fn "Home";
+    vcard:hasMember :localPerson.
+
+`;
+const book = store.sym(base + 'book.ttl#this');
+const aliceLocal = store.sym(base + 'People/aaaaaaaaaa/index.ttl#this');
+const aliceWebId = store.sym('https://alice.example/card#me');
+web[aliceLocal.doc().uri] = `<#this> a vcard:Individual, schema:Person; vcard:fn "Alice".`;
+const bobLocal = store.sym(base + 'People/bbbbbbbbbb/index.ttl#this');
+const bobWebId = store.sym('https://bob.example.net/#me');
+web[bobLocal.doc().uri] = `<#this> a vcard:Individual, schema:Person;
+   vcard:hasURL [ vcard:type vcard:WebId; vcard:value ${bobWebId} ];
+   vcard:fn "Bob".`;
+web[base + 'book.ttl'] = `
+<#this> a vcard:AddressBook;
+    vcard:fn """Contacts: Test address book""";
+    vcard:nameEmailIndex <people.ttl>;
+    vcard:groupIndex <groups.ttl>.
+`;
+web[base + 'groups.ttl'] = `
+<Group/Test.ttl#this> a vcard:Group ;
+    vcard:fn "Test group".
+<Group/Home.ttl#this> a vcard:Group ;
+    vcard:fn "Home group".
+<Group/Work.ttl#this> a vcard:Group ;
+    vcard:fn "Work group".
+`;
+const testGroup = store.sym(base + 'Group/Test.ttl#this');
+web[testGroup.doc().uri] = `
+<#this> a vcard:Group;
+    vcard:fn "Test Group";
+    vcard:hasMember ${aliceLocal} .
+#                    <https://alice.example/card#me>,
+#                    <../People/aaaaaaaaaa/index.ttl#this>,
+#                    <../People/bbbbbbbbbbb/index.ttl#this> .
+
+    ${aliceLocal} = ${aliceWebId} .
+`;
+const homeGroup = store.sym(base + 'Group/Home.ttl#this');
+web[homeGroup.doc().uri] = `
+<#this> a vcard:Group;
+    vcard:fn "Home Group";
+    vcard:hasMember
+                    <../People/aaaaaaaaaa/index.ttl#this>,
+                    <../People/bbbbbbbbbb/index.ttl#this> .
+`;
+const workGroup = store.sym(base + 'Group/Work.ttl#this');
+web[workGroup.doc().uri] = `
+<#this> a vcard:Group;
+    vcard:fn "Work Group";
+    vcard:hasMember
+        <https://alice.example/card#me>,
+        <https://bob.example/card#me>,
+        <https://charlie.example/card#me> .`;
+web[base + 'People/aaaaaaaaaa/index.ttl'] = `
+    <#this> vcard:fn "Alice" .
+`;
+const groups = [testGroup, homeGroup, workGroup];
+for (const uri in web) {
+    console.log(`  parsing "${uri}"  (${web[uri].length})`);
+    parse(prefixes + web[uri], store, uri);
+}
+describe("contacts-pane", () => {
+    describe("returns right label", () => {
+        beforeAll(() => __awaiter(void 0, void 0, void 0, function* () {
+            store.removeDocument(doc);
+            // parse(exampleData, store, doc.uri);
+            // const label = pane.label(subject, context);
+        }));
+        /*
+        if (t[ns.vcard('Individual').uri]) return 'Contact'
+        if (t[ns.vcard('Organization').uri]) return 'contact'
+        if (t[ns.foaf('Person').uri]) return 'Person'
+        if (t[ns.schema('Person').uri]) return 'Person'
+        if (t[ns.vcard('Group').uri]) return 'Group'
+        if (t[ns.vcard('AddressBook').uri]) return 'Address book'
+        */
+        it("returns a good label contact if Organization", () => {
+            let thing = store.sym(base + 'thing1');
+            store.add(thing, ns.rdf('type'), ns.vcard('Organization'), doc);
+            expect(pane.label(thing, context)).toEqual('contact');
+        });
+        it("returns a good label Contact for Individual", () => {
+            let thing = store.sym(base + 'thing2');
+            store.add(thing, ns.rdf('type'), ns.vcard('Individual'), doc);
+            expect(pane.label(thing, context)).toEqual('Contact');
+        });
+        it("returns a good label Person if Person", () => {
+            let thing = store.sym(base + 'thing3');
+            store.add(thing, ns.rdf('type'), ns.schema('Person'), doc);
+            expect(pane.label(thing, context)).toEqual('Person');
+        });
+        it("returns a good label Person if foaf:Person", () => {
+            let thing = store.sym(base + 'thing4');
+            store.add(thing, ns.rdf('type'), ns.foaf('Person'), doc);
+            expect(pane.label(thing, context)).toEqual('Person');
+        });
+        it("returns a good label Group if Group", () => {
+            let thing = store.sym(base + 'thing5');
+            store.add(thing, ns.rdf('type'), ns.vcard('Group'), doc);
+            expect(pane.label(thing, context)).toEqual('Group');
+        });
+        it("returns a good label AddressBook if AddressBook", () => {
+            let thing = store.sym(base + 'thing6');
+            store.add(thing, ns.rdf('type'), ns.vcard('AddressBook'), doc);
+            expect(pane.label(thing, context)).toEqual('Address book');
+        });
+        it("returns a null label if not a person", () => {
+            let thing = store.sym(base + 'thing7');
+            expect(pane.label(store.sym('https://random.example.com/'), context)).toEqual(null);
+            // done()
+        });
+    }); // label tests
+    describe("render tests", () => {
+        it("renders an empty UI of an address book", () => {
+            const div = pane.render(book, context);
+            expect(div.outerHTML).toMatch("<div class=\"contactPane\"></div>");
+            expect(div.innerHTML).toMatch("");
+        });
+    }); // render tests
+    describe("data format tests", () => {
+        beforeAll(() => __awaiter(void 0, void 0, void 0, function* () {
+            store.removeDocument(doc);
+            parse(exampleData, store, doc.uri);
+            fetchMock.mockIf(/^https?.*$/, mockFetchFunction);
+        }));
+        it("converts a bad format into a good one", () => __awaiter(void 0, void 0, void 0, function* () {
+            expect(store.the(testGroup, ns.vcard('hasMember'), null, testGroup.doc())).toEqual(aliceLocal);
+            const { del, ins } = yield getDataModelIssues(groups);
+            expect(del.length).toEqual(1);
+            expect(ins.length).toEqual(1);
+            expect(del.toString()).toEqual('<https://janedoe.example/profile/Group/Test.ttl#this> <http://www.w3.org/2006/vcard/ns#hasMember> <https://janedoe.example/profile/People/aaaaaaaaaa/index.ttl#this> .');
+            expect(ins.toString()).toEqual('<https://janedoe.example/profile/Group/Test.ttl#this> <http://www.w3.org/2006/vcard/ns#hasMember> <https://alice.example/card#me> .');
+            mockUpdate(store, del, ins);
+            expect(store.the(testGroup, ns.vcard('hasMember'), null, testGroup.doc())).toEqual(aliceWebId);
+        }));
+    }); // data format tests
+}); // all tests

package/__tests__/unit/data-reformat-test.ts

@@ -0,0 +1,185 @@
+import { getDataModelIssues } from '../../contactLogic'
+import fetchMock from "jest-fetch-mock";
+
+import pane from "../../contactsPane";
+import { parse, NamedNode } from "rdflib";
+import { context, doc, subject, mockFetchFunction, mockUpdate, ns, store, prefixes, web } from "./setup";
+
+// This was at testingsolidos.solidcommunity.net
+
+const base = doc.dir().uri
+const webid1 = store.sym(base + 'People/localPerson/index.ttl#this')
+
+const exampleData = prefixes + `
+
+:homeGroup1 a vcard:Group;
+    vcard:fn "Happy Home";
+    vcard:hasMember ${webid1} .
+
+:homeGroup2 a vcard:Group;
+    vcard:fn "Home";
+    vcard:hasMember :localPerson.
+
+:homeGroup3 a vcard:Group;
+    vcard:fn "Home";
+    vcard:hasMember :localPerson.
+
+`
+
+const book = store.sym(base + 'book.ttl#this')
+
+const aliceLocal = store.sym(base + 'People/aaaaaaaaaa/index.ttl#this');
+const aliceWebId = store.sym('https://alice.example/card#me')
+
+web[aliceLocal.doc().uri] = `<#this> a vcard:Individual, schema:Person; vcard:fn "Alice".`;
+
+const bobLocal = store.sym(base + 'People/bbbbbbbbbb/index.ttl#this')
+const bobWebId = store.sym('https://bob.example.net/#me')
+web[bobLocal.doc().uri] = `<#this> a vcard:Individual, schema:Person;
+   vcard:hasURL [ vcard:type vcard:WebId; vcard:value ${bobWebId} ];
+   vcard:fn "Bob".`;
+
+
+
+web[base + 'book.ttl'] =  `
+<#this> a vcard:AddressBook;
+    vcard:fn """Contacts: Test address book""";
+    vcard:nameEmailIndex <people.ttl>;
+    vcard:groupIndex <groups.ttl>.
+`;
+
+web[base + 'groups.ttl'] = `
+<Group/Test.ttl#this> a vcard:Group ;
+    vcard:fn "Test group".
+<Group/Home.ttl#this> a vcard:Group ;
+    vcard:fn "Home group".
+<Group/Work.ttl#this> a vcard:Group ;
+    vcard:fn "Work group".
+`;
+
+const testGroup = store.sym(base + 'Group/Test.ttl#this')
+web[testGroup.doc().uri] = `
+<#this> a vcard:Group;
+    vcard:fn "Test Group";
+    vcard:hasMember ${aliceLocal} .
+#                    <https://alice.example/card#me>,
+#                    <../People/aaaaaaaaaa/index.ttl#this>,
+#                    <../People/bbbbbbbbbbb/index.ttl#this> .
+
+    ${aliceLocal} = ${aliceWebId} .
+`;
+const homeGroup = store.sym(base + 'Group/Home.ttl#this')
+web[homeGroup.doc().uri] = `
+<#this> a vcard:Group;
+    vcard:fn "Home Group";
+    vcard:hasMember
+                    <../People/aaaaaaaaaa/index.ttl#this>,
+                    <../People/bbbbbbbbbb/index.ttl#this> .
+`;
+
+const workGroup = store.sym(base + 'Group/Work.ttl#this')
+web[workGroup.doc().uri] = `
+<#this> a vcard:Group;
+    vcard:fn "Work Group";
+    vcard:hasMember
+        <https://alice.example/card#me>,
+        <https://bob.example/card#me>,
+        <https://charlie.example/card#me> .`;
+
+web[base + 'People/aaaaaaaaaa/index.ttl'] = `
+    <#this> vcard:fn "Alice" .
+`;
+
+const groups = [ testGroup, homeGroup, workGroup ];
+
+for (const uri in web) {
+  console.log(`  parsing "${uri}"  (${web[uri].length})`)
+  parse(prefixes + web[uri], store, uri);
+}
+
+describe("contacts-pane", () => {
+
+  describe("returns right label", () => {
+    beforeAll(async () => {
+      store.removeDocument(doc);
+      // parse(exampleData, store, doc.uri);
+      // const label = pane.label(subject, context);
+    });
+/*
+if (t[ns.vcard('Individual').uri]) return 'Contact'
+if (t[ns.vcard('Organization').uri]) return 'contact'
+if (t[ns.foaf('Person').uri]) return 'Person'
+if (t[ns.schema('Person').uri]) return 'Person'
+if (t[ns.vcard('Group').uri]) return 'Group'
+if (t[ns.vcard('AddressBook').uri]) return 'Address book'
+*/
+  it("returns a good label contact if Organization", () => {
+    let thing = store.sym(base + 'thing1')
+    store.add(thing, ns.rdf('type'),  ns.vcard('Organization'), doc)
+    expect(pane.label(thing, context)).toEqual('contact');
+  });
+
+  it("returns a good label Contact for Individual", () => {
+    let thing = store.sym(base + 'thing2')
+    store.add(thing, ns.rdf('type'),  ns.vcard('Individual'), doc)
+    expect(pane.label(thing, context)).toEqual('Contact');
+  });
+  it("returns a good label Person if Person", () => {
+    let thing = store.sym(base + 'thing3')
+    store.add(thing, ns.rdf('type'),  ns.schema('Person'), doc)
+    expect(pane.label(thing, context)).toEqual('Person');
+  });
+  it("returns a good label Person if foaf:Person", () => {
+    let thing = store.sym(base + 'thing4')
+    store.add(thing, ns.rdf('type'),  ns.foaf('Person'), doc)
+    expect(pane.label(thing, context)).toEqual('Person');
+  });
+  it("returns a good label Group if Group", () => {
+    let thing = store.sym(base + 'thing5')
+
+    store.add(thing, ns.rdf('type'),  ns.vcard('Group'), doc)
+    expect(pane.label(thing, context)).toEqual('Group');
+  });
+  it("returns a good label AddressBook if AddressBook", () => {
+    let thing = store.sym(base + 'thing6')
+    store.add(thing, ns.rdf('type'),  ns.vcard('AddressBook'), doc)
+    expect(pane.label(thing, context)).toEqual('Address book');
+  });
+    it("returns a null label if not a person", () => {
+      let thing = store.sym(base + 'thing7')
+      expect(pane.label(store.sym('https://random.example.com/'), context)).toEqual(null);
+      // done()
+    });
+
+  }); // label tests
+
+  describe("render tests", () => { // How to get the UI which comes over time?
+    it("renders an empty UI of an address book", () => {
+      const div = pane.render(book, context)
+      expect(div.outerHTML).toMatch("<div class=\"contactPane\"></div>");
+      expect(div.innerHTML).toMatch("");
+    });
+  }); // render tests
+
+  describe("data format tests", () => {
+    beforeAll(async () => {
+      store.removeDocument(doc);
+      parse(exampleData, store, doc.uri);
+      fetchMock.mockIf(/^https?.*$/, mockFetchFunction)
+    });
+
+    it("converts a bad format into a good one", async () => {
+      expect(store.the(testGroup, ns.vcard('hasMember'), null, testGroup.doc())).toEqual(aliceLocal)
+      const { del, ins } = await getDataModelIssues(groups)
+      expect(del.length).toEqual(1)
+      expect(ins.length).toEqual(1)
+      expect(del.toString()).toEqual('<https://janedoe.example/profile/Group/Test.ttl#this> <http://www.w3.org/2006/vcard/ns#hasMember> <https://janedoe.example/profile/People/aaaaaaaaaa/index.ttl#this> .')
+      expect(ins.toString()).toEqual('<https://janedoe.example/profile/Group/Test.ttl#this> <http://www.w3.org/2006/vcard/ns#hasMember> <https://alice.example/card#me> .')
+      mockUpdate(store, del, ins)
+      expect(store.the(testGroup, ns.vcard('hasMember'), null, testGroup.doc())).toEqual(aliceWebId)
+
+    });
+
+  }); // data format tests
+
+}); // all tests

package/__tests__/unit/setup.js

@@ -0,0 +1,74 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { ns, store } from "solid-ui";
+export { ns, store, rdf } from "solid-ui";
+// console.log('@@ store', store)
+// console.log('@@ store.sym', store.sym)
+export const subject = store.sym("https://janedoe.example/profile/card#me");
+export const doc = subject.doc();
+export const context = {
+    dom: document,
+    getOutliner: () => null,
+    session: {
+        paneRegistry: {
+            byName: (name) => {
+                return {
+                    render: () => {
+                        return document.createElement('div')
+                            .appendChild(document.createTextNode(`mock ${name} pane`));
+                    }
+                };
+            }
+        },
+        store,
+        logic: {},
+    },
+};
+const prefs = Object.keys(ns).filter(x => x !== 'default'); // default is bogus value
+export const prefixes = prefs.map(prefix => `@prefix ${prefix}: ${ns[prefix]('')}.\n`).join(''); // In turtle
+export let web = {};
+export let requests = [];
+export function mockFetchFunction(req) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (req.method !== 'GET') {
+            requests.push(req);
+            if (req.method === 'PUT') {
+                const contents = yield req.text();
+                web[req.url] = contents; // Update our dummy web
+                console.log(`Tetst: Updated ${req.url} on PUT to <<<${web[req.url]}>>>`);
+            }
+            return { status: 200 };
+        }
+        const contents = web[req.url];
+        if (contents !== undefined) { //
+            return {
+                body: prefixes + contents,
+                status: 200,
+                headers: {
+                    "Content-Type": "text/turtle",
+                    "WAC-Allow": 'user="write", public="read"',
+                    "Accept-Patch": "application/sparql-update"
+                }
+            };
+        } // if contents
+        return {
+            status: 404,
+            body: 'Not Found'
+        };
+    });
+}
+export function mockUpdate(store, del, ins) {
+    for (const st of del) {
+        store.remove(st);
+    }
+    for (const st of ins) {
+        store.addStatement(st);
+    }
+}

package/__tests__/unit/setup.ts

@@ -0,0 +1,77 @@
+import { DataBrowserContext, PaneRegistry } from "pane-registry";
+
+import  { Statement, LiveStore } from "rdflib";
+import { ns, store, rdf } from "solid-ui"
+export { ns, store, rdf } from "solid-ui"
+
+import { SolidLogic } from "solid-logic";
+
+// console.log('@@ store', store)
+// console.log('@@ store.sym', store.sym)
+
+export const subject = store.sym("https://janedoe.example/profile/card#me");
+export const doc = subject.doc();
+
+export const context = {
+    dom: document,
+    getOutliner: () => null,
+    session: {
+        paneRegistry: {
+            byName: (name: string) => {
+                return {
+                    render: () => {
+                        return document.createElement('div')
+                            .appendChild(
+                                document.createTextNode(`mock ${name} pane`)
+                            );
+                    }
+                }
+            }
+        } as PaneRegistry,
+        store,
+        logic: {} as SolidLogic,
+    },
+} as unknown as DataBrowserContext;
+
+const  prefs = Object.keys(ns).filter(x => x !== 'default') // default is bogus value
+export const prefixes = prefs.map(prefix => `@prefix ${prefix}: ${ns[prefix]('')}.\n`).join('') // In turtle
+
+export let web = {}
+export let requests = []
+
+export async function mockFetchFunction (req) {
+    if (req.method !== 'GET') {
+        requests.push(req)
+        if (req.method === 'PUT') {
+            const contents = await req.text()
+            web[req.url] = contents // Update our dummy web
+            console.log(`Tetst: Updated ${req.url} on PUT to <<<${web[req.url]}>>>`)
+        }
+        return { status: 200 }
+    }
+    const contents = web[req.url]
+    if (contents !== undefined) { //
+        return {
+            body: prefixes + contents, // Add namespaces to anything
+            status: 200,
+            headers: {
+                "Content-Type": "text/turtle",
+                "WAC-Allow": 'user="write", public="read"',
+                "Accept-Patch": "application/sparql-update"
+            }
+        }
+    } // if contents
+    return {
+        status: 404,
+        body: 'Not Found'
+    }
+}
+
+export function mockUpdate (store: LiveStore, del: Statement[], ins: Statement[]) {
+  for (const st of del) {
+    store.remove(st)
+  }
+  for (const st of ins) {
+    store.addStatement(st)
+  }
+}

package/babel.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  presets: [
+    [
+      "@babel/preset-env",
+      {
+        targets: {
+          node: "current",
+        },
+      },
+    ],
+    "@babel/preset-typescript",
+  ],
+};