aboutsummaryrefslogtreecommitdiffstats
path: root/packages/e2e_tests/tests/api/lists.test.ts
blob: b90a6267bd8a752ad52d326b61703c87c74d8658 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
import { beforeEach, describe, expect, inject, it } from "vitest";

import { createKarakeepClient } from "@karakeep/sdk";

import { createTestUser } from "../../utils/api";

describe("Lists API", () => {
  const port = inject("karakeepPort");

  if (!port) {
    throw new Error("Missing required environment variables");
  }

  let client: ReturnType<typeof createKarakeepClient>;
  let apiKey: string;

  beforeEach(async () => {
    apiKey = await createTestUser();
    client = createKarakeepClient({
      baseUrl: `http://localhost:${port}/api/v1/`,
      headers: {
        "Content-Type": "application/json",
        authorization: `Bearer ${apiKey}`,
      },
    });
  });

  it("should list all lists", async () => {
    // Create multiple lists
    const { data: list1 } = await client.POST("/lists", {
      body: {
        name: "First List",
        icon: "🚀",
      },
    });

    const { data: list2 } = await client.POST("/lists", {
      body: {
        name: "Second List",
        icon: "📚",
        type: "smart",
        query: "is:fav",
      },
    });

    // Get all lists
    const { data: allLists, response: getResponse } = await client.GET(
      "/lists",
      {
        params: {},
      },
    );

    expect(getResponse.status).toBe(200);
    expect(allLists).toBeDefined();
    expect(allLists!.lists.length).toBeGreaterThanOrEqual(2);

    const listIds = allLists!.lists.map((l) => l.id);
    expect(listIds).toContain(list1!.id);
    expect(listIds).toContain(list2!.id);
  });

  it("should create, get, update and delete a list", async () => {
    // Create a new list
    const { data: createdList, response: createResponse } = await client.POST(
      "/lists",
      {
        body: {
          name: "Test List",
          icon: "🚀",
        },
      },
    );

    expect(createResponse.status).toBe(201);
    expect(createdList).toBeDefined();
    expect(createdList?.id).toBeDefined();
    expect(createdList?.name).toBe("Test List");

    // Get the created list
    const { data: retrievedList, response: getResponse } = await client.GET(
      "/lists/{listId}",
      {
        params: {
          path: {
            listId: createdList!.id,
          },
        },
      },
    );

    expect(getResponse.status).toBe(200);
    expect(retrievedList!.id).toBe(createdList!.id);
    expect(retrievedList!.name).toBe("Test List");

    // Update the list
    const { data: updatedList, response: updateResponse } = await client.PATCH(
      "/lists/{listId}",
      {
        params: {
          path: {
            listId: createdList!.id,
          },
        },
        body: {
          name: "Updated List",
        },
      },
    );

    expect(updateResponse.status).toBe(200);
    expect(updatedList!.name).toBe("Updated List");

    // Delete the list
    const { response: deleteResponse } = await client.DELETE(
      "/lists/{listId}",
      {
        params: {
          path: {
            listId: createdList!.id,
          },
        },
      },
    );

    expect(deleteResponse.status).toBe(204);

    // Verify it's deleted
    const { response: getDeletedResponse } = await client.GET(
      "/lists/{listId}",
      {
        params: {
          path: {
            listId: createdList!.id,
          },
        },
      },
    );

    expect(getDeletedResponse.status).toBe(404);
  });

  it("should manage bookmarks in a list", async () => {
    // Create a list
    const { data: createdList } = await client.POST("/lists", {
      body: {
        name: "Test List",
        icon: "🚀",
      },
    });

    // Create a bookmark
    const { data: createdBookmark } = await client.POST("/bookmarks", {
      body: {
        type: "text",
        title: "Test Bookmark",
        text: "This is a test bookmark",
      },
    });

    // Add bookmark to list
    const { response: addResponse } = await client.PUT(
      "/lists/{listId}/bookmarks/{bookmarkId}",
      {
        params: {
          path: {
            listId: createdList!.id,
            bookmarkId: createdBookmark!.id,
          },
        },
      },
    );

    expect(addResponse.status).toBe(204);

    // Get bookmarks in list
    const { data: listBookmarks, response: getResponse } = await client.GET(
      "/lists/{listId}/bookmarks",
      {
        params: {
          path: {
            listId: createdList!.id,
          },
        },
      },
    );

    expect(getResponse.status).toBe(200);
    expect(listBookmarks!.bookmarks.length).toBe(1);
    expect(listBookmarks!.bookmarks[0].id).toBe(createdBookmark!.id);

    // Remove bookmark from list
    const { response: removeResponse } = await client.DELETE(
      "/lists/{listId}/bookmarks/{bookmarkId}",
      {
        params: {
          path: {
            listId: createdList!.id,
            bookmarkId: createdBookmark!.id,
          },
        },
      },
    );

    expect(removeResponse.status).toBe(204);

    // Verify bookmark is removed
    const { data: updatedListBookmarks } = await client.GET(
      "/lists/{listId}/bookmarks",
      {
        params: {
          path: {
            listId: createdList!.id,
          },
        },
      },
    );

    expect(updatedListBookmarks!.bookmarks.length).toBe(0);
  });

  it("should support smart lists", async () => {
    // Create a bookmark
    const { data: createdBookmark1 } = await client.POST("/bookmarks", {
      body: {
        type: "text",
        title: "Test Bookmark",
        text: "This is a test bookmark",
        favourited: true,
      },
    });

    const { data: _ } = await client.POST("/bookmarks", {
      body: {
        type: "text",
        title: "Test Bookmark",
        text: "This is a test bookmark",
        favourited: false,
      },
    });

    // Create a list
    const { data: createdList } = await client.POST("/lists", {
      body: {
        name: "Test List",
        icon: "🚀",
        type: "smart",
        query: "is:fav",
      },
    });

    // Get bookmarks in list
    const { data: listBookmarks, response: getResponse } = await client.GET(
      "/lists/{listId}/bookmarks",
      {
        params: {
          path: {
            listId: createdList!.id,
          },
        },
      },
    );

    expect(getResponse.status).toBe(200);
    expect(listBookmarks!.bookmarks.length).toBe(1);
    expect(listBookmarks!.bookmarks[0].id).toBe(createdBookmark1!.id);
  });
});