feat: item linking (#1779)

packages/services/src/Domain/Item/ItemsClientInterface.ts

@@ -4,7 +4,7 @@ import {
   FileItem,
   SNTag,
   SmartView,
-  TagNoteCountChangeObserver,
+  TagItemCountChangeObserver,
   DecryptedPayloadInterface,
   EncryptedItemInterface,
   DecryptedTransferPayload,
@@ -14,6 +14,7 @@ import {
   SNTheme,
   DisplayOptions,
   ItemsKeyInterface,
+  ItemContent,
 } from '@standardnotes/models'
 
 export interface ItemsClientInterface {
@@ -23,12 +24,12 @@ export interface ItemsClientInterface {
 
   disassociateFileWithNote(file: FileItem, note: SNNote): Promise<FileItem>
 
-  getFilesForNote(note: SNNote): FileItem[]
-
   renameFile(file: FileItem, name: string): Promise<FileItem>
 
   addTagToNote(note: SNNote, tag: SNTag, addHierarchy: boolean): Promise<SNTag[]>
 
+  addTagToFile(file: FileItem, tag: SNTag, addHierarchy: boolean): Promise<SNTag[]>
+
   /** Creates an unmanaged, un-inserted item from a payload. */
   createItemFromPayload(payload: DecryptedPayloadInterface): DecryptedItemInterface
 
@@ -54,7 +55,7 @@ export interface ItemsClientInterface {
 
   notesMatchingSmartView(view: SmartView): SNNote[]
 
-  addNoteCountChangeObserver(observer: TagNoteCountChangeObserver): () => void
+  addNoteCountChangeObserver(observer: TagItemCountChangeObserver): () => void
 
   allCountableNotesCount(): number
 
@@ -72,6 +73,14 @@ export interface ItemsClientInterface {
 
   itemsReferencingItem(itemToLookupUuidFor: DecryptedItemInterface, contentType?: ContentType): DecryptedItemInterface[]
 
+  linkNoteToNote(note: SNNote, otherNote: SNNote): Promise<SNNote>
+  linkFileToFile(file: FileItem, otherFile: FileItem): Promise<FileItem>
+
+  unlinkItem(
+    item: DecryptedItemInterface<ItemContent>,
+    itemToUnlink: DecryptedItemInterface<ItemContent>,
+  ): Promise<DecryptedItemInterface<ItemContent>>
+
   /**
    * Finds tags with title or component starting with a search query and (optionally) not associated with a note
    * @param searchQuery - The query string to match
@@ -101,10 +110,14 @@ export interface ItemsClientInterface {
 
   /**
    * Get tags for a note sorted in natural order
-   * @param note - The note whose tags will be returned
-   * @returns Array containing tags associated with a note
+   * @param item - The item whose tags will be returned
+   * @returns Array containing tags associated with an item
    */
-  getSortedTagsForNote(note: SNNote): SNTag[]
+  getSortedTagsForItem(item: DecryptedItemInterface<ItemContent>): SNTag[]
+  getSortedFilesForItem(item: DecryptedItemInterface<ItemContent>): FileItem[]
+
+  getSortedLinkedNotesForItem(item: DecryptedItemInterface<ItemContent>): SNNote[]
+  getSortedNotesLinkingToItem(item: DecryptedItemInterface<ItemContent>): SNNote[]
 
   isSmartViewTitle(title: string): boolean
 
@@ -137,4 +150,12 @@ export interface ItemsClientInterface {
    * @returns Whether the item is a template (unmanaged)
    */
   isTemplateItem(item: DecryptedItemInterface): boolean
+
+  /**
+   * @returns `'direct'` if `itemOne` has the reference to `itemTwo`, `'indirect'` if `itemTwo` has the reference to `itemOne`, `'unlinked'` if neither reference each other
+   */
+  relationshipTypeForItems(
+    itemOne: DecryptedItemInterface,
+    itemTwo: DecryptedItemInterface,
+  ): 'direct' | 'indirect' | 'unlinked'
 }