Merge pull request #70 from solid-contrib/contacts/read-group

Contacts/read group

Author: angelo-v

contacts/CHANGELOG.md

@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Added
 
 - [createNewGroup](https://solid-contrib.github.io/data-modules/contacts-rdflib-api/interfaces/ContactsModule.html#createNewGroup)
+- [readGroup](https://solid-contrib.github.io/data-modules/contacts-rdflib-api/interfaces/ContactsModule.html#readGroup)
 
 ## 0.2.1
 

contacts/examples/read-group.mjs

@@ -0,0 +1,10 @@
+import {ContactsModuleRdfLib as ContactsModule} from '../dist/index.js';
+import {Fetcher, graph, UpdateManager} from "rdflib";
+
+const store = graph()
+const fetcher = new Fetcher(store)
+const updater = new UpdateManager(store)
+const contacts = new ContactsModule({store, fetcher, updater})
+
+const result = await contacts.readGroup("http://localhost:3000/alice/public-contacts/Group/officials.ttl#this")
+console.log(result)

contacts/src/e2e-tests/contacts.e2e.spec.ts

@@ -119,6 +119,28 @@ describe("contacts module", () => {
       name: groupName,
     });
   });
+
+  it("can read a group to get the name and a list all of its members", async () => {
+    {
+      const contacts = setupModule();
+
+      const groupUri =
+        "http://localhost:3456/4243dbb6-3126-4bf9-9ea7-45e35c3c8d9d/Group/1f0d98b1-5eac-4c44-b6e2-29d9784c40cb/index.ttl#this";
+
+      const result = await contacts.readGroup(groupUri);
+
+      expect(result).toEqual({
+        uri: "http://localhost:3456/4243dbb6-3126-4bf9-9ea7-45e35c3c8d9d/Group/1f0d98b1-5eac-4c44-b6e2-29d9784c40cb/index.ttl#this",
+        name: "Officials",
+        members: [
+          {
+            uri: "http://localhost:3456/4243dbb6-3126-4bf9-9ea7-45e35c3c8d9d/Person/1973dcec-e71c-476c-87db-0d3332291214/index.ttl#this",
+            name: "Molly Braaten",
+          },
+        ],
+      });
+    }
+  });
 });
 
 function setupModule() {

contacts/src/e2e-tests/test-data/4243dbb6-3126-4bf9-9ea7-45e35c3c8d9d/Group/1f0d98b1-5eac-4c44-b6e2-29d9784c40cb/index.ttl

@@ -0,0 +1,8 @@
+<#this>
+    <http://www.w3.org/2006/vcard/ns#fn>        "Officials" ;
+    a                                           <http://www.w3.org/2006/vcard/ns#Group> ;
+    <http://www.w3.org/2006/vcard/ns#hasMember> <../../Person/1973dcec-e71c-476c-87db-0d3332291214/index.ttl#this> ;
+.
+
+<../../Person/1973dcec-e71c-476c-87db-0d3332291214/index.ttl#this>
+    <http://www.w3.org/2006/vcard/ns#fn> "Molly Braaten" .

contacts/src/index.ts

@@ -31,7 +31,7 @@ export interface ContactsModule {
   /**
    * Fetches the given contact and returns available information
    * @param uri - The URI of the contact to read
-   * @return Contact name, email addresses and phone numbers
+   * @return FullContact name, email addresses and phone numbers
    */
   readContact(uri: string): Promise<FullContact>;
 
@@ -44,6 +44,13 @@ export interface ContactsModule {
     addressBookUri,
     groupName,
   }: CreateNewGroupCommand): Promise<string>;
+
+  /**
+   * Fetches the given group and returns available information
+   * @param uri - The URI of the contact to read
+   * @return FullGroup name and list of group members
+   */
+  readGroup(uri: string): Promise<FullGroup>;
 }
 
 /**
@@ -94,10 +101,16 @@ export interface AddressBook {
 }
 
 /**
- * Partial contact data listed when reading an address book
+ * Partial contact data listed when reading an address book or a group
  */
 export interface Contact {
+  /**
+   * The URI identifying the contact
+   */
   uri: string;
+  /**
+   * The human-readable name of the contact
+   */
   name: string;
 }
 
@@ -130,7 +143,34 @@ export interface PhoneNumber {
 /**
  * Partial group data listed when reading an address book
  */
-export interface Group {}
+export interface Group {
+  /**
+   * The URI identifying the group
+   */
+  uri: string;
+  /**
+   * The human-readable name of the group
+   */
+  name: string;
+}
+
+/**
+ * Extensive contact data returned when reading a contact
+ */
+export interface FullGroup {
+  /**
+   * The URI identifying the group
+   */
+  uri: string;
+  /**
+   * The human-readable name of the group
+   */
+  name: string;
+  /**
+   * List of group members
+   */
+  members: Contact[];
+}
 
 /**
  * Data needed to create a new group within an address book

contacts/src/rdflib/ContactsModuleRdfLib.ts

@@ -6,12 +6,14 @@ import {
   CreateNewContactCommand,
   CreateNewGroupCommand,
   FullContact,
+  FullGroup,
 } from "..";
 import { AddressBookQuery, ContactQuery } from "./queries";
 import { createAddressBook, createNewContact } from "./update-operations";
 import { executeUpdate } from "./web-operations/executeUpdate";
 import { fetchNode } from "./web-operations/fetchNode";
 import { createNewGroup } from "./update-operations/createNewGroup";
+import { GroupQuery } from "./queries/GroupQuery";
 
 interface ModuleConfig {
   store: IndexedFormula;
@@ -99,4 +101,17 @@ export class ContactsModuleRdfLib implements ContactsModule {
     await executeUpdate(this.fetcher, this.updater, operation);
     return operation.uri;
   }
+
+  async readGroup(uri: string): Promise<FullGroup> {
+    const groupNode = sym(uri);
+    await this.fetchNode(groupNode);
+    const query = new GroupQuery(this.store, groupNode);
+    const name = query.queryName();
+    const members = query.queryMembers();
+    return {
+      uri,
+      name,
+      members,
+    };
+  }
 }