feat(api): Implement the /api/pages/:project/search/titles endpoint

Author: takker99

api/pages/project/search.ts

@@ -1 +1,2 @@
 export * as query from "./search/query.ts";
+export * as titles from "./search/titles.ts";

api/pages/project/search/titles.ts

@@ -0,0 +1,117 @@
+import type {
+  NotFoundError,
+  NotLoggedInError,
+  NotMemberError,
+  SearchedTitle,
+} from "@cosense/types/rest";
+import type { ResponseOfEndpoint } from "../../../../targeted_response.ts";
+import { type BaseOptions, setDefaults } from "../../../../util.ts";
+import { cookie } from "../../../../rest/auth.ts";
+import {
+  type HTTPError,
+  makeError,
+  makeHTTPError,
+  type TypedError,
+} from "../../../../error.ts";
+
+/** Options for {@linkcode get} */
+export interface GetLinksOptions<R extends Response | undefined>
+  extends BaseOptions<R> {
+  /** ID indicating the next list of links */
+  followingId?: string;
+}
+
+/** Create a request to `GET /api/pages/:project/search/titles`
+ *
+ * @param project The project to get the links from
+ * @param options - Additional configuration options
+ * @returns A {@linkcode Request} object for fetching link data
+ */
+export const makeGetRequest = <R extends Response | undefined>(
+  project: string,
+  options?: GetLinksOptions<R>,
+): Request => {
+  const { sid, hostName, followingId } = setDefaults(options ?? {});
+
+  return new Request(
+    `https://${hostName}/api/pages/${project}/search/titles${
+      followingId ? `?followingId=${followingId}` : ""
+    }`,
+    sid ? { headers: { Cookie: cookie(sid) } } : undefined,
+  );
+};
+
+/** Retrieve link data from a specified Scrapbox project
+ *
+ * This function fetches link data from a project, supporting pagination through
+ * the {@linkcode GetLinksOptions.followingId} parameter. It returns both the link data and the next
+ * followingId for subsequent requests.
+ *
+ * @param project The project to retrieve link data from
+ * @param options Additional configuration options for the request
+ * @returns A {@linkcode Response} object containing the link data
+ */
+export const get = <R extends Response | undefined = Response>(
+  project: string,
+  options?: GetLinksOptions<R>,
+): Promise<
+  ResponseOfEndpoint<{
+    200: SearchedTitle[];
+    404: NotFoundError;
+    401: NotLoggedInError;
+    403: NotMemberError;
+    422: { message: string };
+  }, R>
+> =>
+  setDefaults(options ?? {}).fetch(
+    makeGetRequest(project, options),
+  ) as Promise<
+    ResponseOfEndpoint<{
+      200: SearchedTitle[];
+      404: NotFoundError;
+      401: NotLoggedInError;
+      403: NotMemberError;
+      422: { message: string };
+    }, R>
+  >;
+
+/** Retrieve all link data from a specified project one by one
+ *
+ * @param project The project name to list pages from
+ * @param options Additional configuration options for the request
+ * @returns An async generator that yields each link data
+ * @throws {TypedError<"NotLoggedInError" | "NotMemberError" | "NotFoundError" | "InvalidFollowingIdError"> | HTTPError}
+ */
+export async function* list(
+  project: string,
+  options?: GetLinksOptions<Response>,
+): AsyncGenerator<SearchedTitle, void, unknown> {
+  let followingId = options?.followingId ?? "";
+  do {
+    const response = await get(project, { ...options, followingId });
+    switch (response.status) {
+      case 200:
+        break;
+      case 401:
+      case 403:
+      case 404: {
+        const error = await response.json();
+        throw makeError(error.name, error.message) satisfies TypedError<
+          "NotLoggedInError" | "NotMemberError" | "NotFoundError"
+        >;
+      }
+      case 422:
+        throw makeError(
+          "InvalidFollowingIdError",
+          (await response.json()).message,
+        ) satisfies TypedError<
+          "InvalidFollowingIdError"
+        >;
+      default:
+        throw makeHTTPError(response) satisfies HTTPError;
+    }
+    const titles = await response.json();
+    yield* titles;
+    followingId = response.headers.get("X-following-id") ?? "";
+  } while (followingId);
+}

deno.jsonc

@@ -28,6 +28,7 @@
     "./unstable-api/pages/project/replace/links": "./api/pages/project/replace/links.ts",
     "./unstable-api/pages/project/search": "./api/pages/project/search.ts",
     "./unstable-api/pages/project/search/query": "./api/pages/project/search/query.ts",
+    "./unstable-api/pages/project/search/titles": "./api/pages/project/search/titles.ts",
     "./unstable-api/pages/project/title": "./api/pages/project/title.ts",
     "./unstable-api/pages/project/title/text": "./api/pages/project/title/text.ts",
     "./unstable-api/pages/project/title/icon": "./api/pages/project/title/icon.ts",