The History PR: I - Move to redux (#1156)

src/api/history/dto-methods.ts

@@ -0,0 +1,33 @@
+/*
+ * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import { HistoryEntry, HistoryEntryOrigin } from '../../redux/history/types'
+import { HistoryEntryDto, HistoryEntryPutDto, HistoryEntryUpdateDto } from './types'
+
+export const historyEntryDtoToHistoryEntry = (entryDto: HistoryEntryDto): HistoryEntry => {
+  return {
+    origin: HistoryEntryOrigin.REMOTE,
+    title: entryDto.title,
+    pinStatus: entryDto.pinStatus,
+    identifier: entryDto.identifier,
+    tags: entryDto.tags,
+    lastVisited: entryDto.lastVisited
+  }
+}
+
+export const historyEntryToHistoryEntryPutDto = (entry: HistoryEntry): HistoryEntryPutDto => {
+  return {
+    pinStatus: entry.pinStatus,
+    lastVisited: entry.lastVisited,
+    note: entry.identifier
+  }
+}
+
+export const historyEntryToHistoryEntryUpdateDto = (entry: HistoryEntry): HistoryEntryUpdateDto => {
+  return {
+    pinStatus: entry.pinStatus
+  }
+}

src/api/history/index.ts

@@ -4,22 +4,37 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { HistoryEntry } from '../../components/history-page/history-page'
 import { defaultFetchConfig, expectResponseCode, getApiUrl } from '../utils'
+import { HistoryEntryDto, HistoryEntryPutDto, HistoryEntryUpdateDto } from './types'
 
-export const getHistory = async (): Promise<HistoryEntry[]> => {
+export const getHistory = async (): Promise<HistoryEntryDto[]> => {
   const response = await fetch(getApiUrl() + '/history')
   expectResponseCode(response)
-  return await response.json() as Promise<HistoryEntry[]>
+  return await response.json() as Promise<HistoryEntryDto[]>
 }
 
-export const setHistory = async (entries: HistoryEntry[]): Promise<void> => {
+export const postHistory = async (entries: HistoryEntryPutDto[]): Promise<void> => {
   const response = await fetch(getApiUrl() + '/history', {
     ...defaultFetchConfig,
     method: 'POST',
-    body: JSON.stringify({
-      history: entries
-    })
+    body: JSON.stringify(entries)
+  })
+  expectResponseCode(response)
+}
+
+export const updateHistoryEntryPinStatus = async (noteId: string, entry: HistoryEntryUpdateDto): Promise<void> => {
+  const response = await fetch(getApiUrl() + '/history/' + noteId, {
+    ...defaultFetchConfig,
+    method: 'PUT',
+    body: JSON.stringify(entry)
+  })
+  expectResponseCode(response)
+}
+
+export const deleteHistoryEntry = async (noteId: string): Promise<void> => {
+  const response = await fetch(getApiUrl() + '/history/' + noteId, {
+    ...defaultFetchConfig,
+    method: 'DELETE'
   })
   expectResponseCode(response)
 }
@@ -31,21 +46,3 @@ export const deleteHistory = async (): Promise<void> => {
   })
   expectResponseCode(response)
 }
-
-export const updateHistoryEntry = async (noteId: string, entry: HistoryEntry): Promise<HistoryEntry> => {
-  const response = await fetch(getApiUrl() + '/history/' + noteId, {
-    ...defaultFetchConfig,
-    method: 'PUT',
-    body: JSON.stringify(entry)
-  })
-  expectResponseCode(response)
-  return await response.json() as Promise<HistoryEntry>
-}
-
-export const deleteHistoryEntry = async (noteId: string): Promise<void> => {
-  const response = await fetch(getApiUrl() + '/history/' + noteId, {
-    ...defaultFetchConfig,
-    method: 'DELETE'
-  })
-  expectResponseCode(response)
-}

src/api/history/types.d.ts

@@ -0,0 +1,23 @@
+/*
+ * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+export interface HistoryEntryPutDto {
+  note: string
+  pinStatus: boolean
+  lastVisited: string
+}
+
+export interface HistoryEntryUpdateDto {
+  pinStatus: boolean
+}
+
+export interface HistoryEntryDto {
+  identifier: string
+  title: string
+  lastVisited: string
+  tags: string[]
+  pinStatus: boolean
+}