updates on bookmark endpoints and api keys

Author: kayode0x

src/sdks/bookmarks.ts

@@ -1,6 +1,7 @@
 import type {
 	BookmarkFileEntry,
 	BookmarkPagination,
+	BookmarkTabsEntry,
 	ImageUploadType,
 	ManualBookmarkEntry,
 	ManualBookmarkEntryPayload,
@@ -25,12 +26,12 @@ export const bookmarks = sdk(client => ({
 	},
 
 	/**
-	 * Get the article content of a bookmark
+	 * Get the reader (article) content of a bookmark
 	 *
 	 * @param {String} id - The ID of the bookmark
 	 */
-	async getArticle(id: string) {
-		return await client.get('v1/bookmarks/:id/article', {id});
+	async getReader(id: string) {
+		return await client.get('v1/bookmarks/:id/reader', {id});
 	},
 
 	/**
@@ -45,8 +46,8 @@ export const bookmarks = sdk(client => ({
 	 *
 	 * @param {String} url - The URL of the bookmark
 	 */
-	async exists(url: string) {
-		return await client.post('v1/bookmarks/exists', {url}, {});
+	async exists(url: string, collection: string | null = null) {
+		return await client.post('v1/bookmarks/exists', {url, collection}, {});
 	},
 
 	/**
@@ -94,29 +95,12 @@ export const bookmarks = sdk(client => ({
 		collection: string | null = null,
 	) {
 		return await client.post(
-			'v1/bookmarks/from-parsed-data',
+			'v1/bookmarks/from-parsed-link',
 			{data, collection},
 			{},
 		);
 	},
 
-	/**
-	 * Create a new bookmark from manual data
-	 */
-	async createFromEntry(data: ManualBookmarkEntry) {
-		let payload = {} as ManualBookmarkEntryPayload;
-
-		data.tags
-			? (payload = {...data, tags: data.tags.join(',')})
-			: (payload = data as unknown as ManualBookmarkEntryPayload);
-
-		if (data.cover) {
-			payload = {...payload, coverType: 'default'};
-		}
-
-		return await client.post('v1/bookmarks/manual', payload, {});
-	},
-
 	/**
 	 * Create a new bookmark from file upload
 	 */
@@ -143,6 +127,30 @@ export const bookmarks = sdk(client => ({
 		return await client.post('v1/bookmarks/file', formData, {});
 	},
 
+	/**
+	 * Create a new bookmark from browser extension tabs upload
+	 */
+	async createFromTabs(data: BookmarkTabsEntry) {
+		return await client.post('v1/bookmarks/tabs', data, {});
+	},
+
+	/**
+	 * Create a new bookmark from manual data
+	 */
+	async createFromEntry(data: ManualBookmarkEntry) {
+		let payload = {} as ManualBookmarkEntryPayload;
+
+		data.tags
+			? (payload = {...data, tags: data.tags.join(',')})
+			: (payload = data as unknown as ManualBookmarkEntryPayload);
+
+		if (data.cover) {
+			payload = {...payload, coverType: 'default'};
+		}
+
+		return await client.post('v1/bookmarks/manual', payload, {});
+	},
+
 	/**
 	 * Re-parse the data of a bookmark
 	 *

src/types/api-keys.ts

@@ -0,0 +1,50 @@
+import type {OBJECT_ID} from './generic';
+export type APIStatus = 'active' | 'inactive';
+
+export type APIKey = {
+	id: string;
+
+	/**
+	 * The secret key of the API key
+	 *
+	 * This can only be fetched once.
+	 */
+	secret?: string;
+
+	/**
+	 * The last time the API key was used
+	 *
+	 * Updated whenever a call is made using the API key
+	 */
+	lastUsed: number;
+
+	/**
+	 * The last time the API key was edited
+	 */
+	updateAt: number;
+
+	/**
+	 * The time the API key was created
+	 */
+	createdAt: number;
+
+	/**
+	 * The ID of the user who created the API key
+	 */
+	owner: OBJECT_ID;
+
+	/**
+	 * Current status of the API key
+	 */
+	status: APIStatus;
+
+	/**
+	 * The name of the API key
+	 */
+	name: string;
+
+	/**
+	 * Amount of requests made using the API key
+	 */
+	usageCount: number;
+};