contacts: add tsdoc and changelog for createNewGroup

Author: angelo-v

contacts/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this module will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+### Added
+
+- [createNewGroup](https://solid-contrib.github.io/data-modules/contacts-rdflib-api/interfaces/ContactsModule.html#createNewGroup)
+
 ## 0.2.1
 
 ### Fixed

contacts/src/index.ts

@@ -34,6 +34,16 @@ export interface ContactsModule {
    * @return Contact name, email addresses and phone numbers
    */
   readContact(uri: string): Promise<FullContact>;
+
+  /**
+   * Creates a new group within a given address book
+   * @param command
+   * @return The URI of the newly created group
+   */
+  createNewGroup({
+    addressBookUri,
+    groupName,
+  }: CreateNewGroupCommand): Promise<string>;
 }
 
 /**
@@ -122,7 +132,16 @@ export interface PhoneNumber {
  */
 export interface Group {}
 
+/**
+ * Data needed to create a new group within an address book
+ */
 export interface CreateNewGroupCommand {
+  /**
+   * The URI of an existing address book the new group should be added to
+   */
   addressBookUri: string;
+  /**
+   * The name of the group to create
+   */
   groupName: string;
 }