feat(api): Implement the /api/pages/:project/replace/links endpoint

Author: takker99

api/pages/project.ts

@@ -136,3 +136,4 @@ export async function* list(
 }
 
 export * as title from "./project/title.ts";
+export * as replace from "./project/replace.ts";

api/pages/project/replace.ts

@@ -0,0 +1 @@
+export * as links from "./replace/links.ts";

api/pages/project/replace/links.ts

@@ -0,0 +1,85 @@
+import type {
+  NotFoundError,
+  NotLoggedInError,
+  NotMemberError,
+} from "@cosense/types/rest";
+import type { ResponseOfEndpoint } from "../../../../targeted_response.ts";
+import { type ExtendedOptions, setDefaults } from "../../../../util.ts";
+import { cookie } from "../../../../rest/auth.ts";
+import { get } from "../../../users/me.ts";
+
+/** Constructs a request for the `/api/pages/:project/replace/links` endpoint
+ *
+ * @param project - The project name where all links will be replaced
+ * @param from - The original link text to be replaced
+ * @param to - The new link text to replace with
+ * @param init - Additional configuration options
+ * @returns A {@linkcode Request} object for replacing links in `project`
+ */
+export const makePostRequest = <R extends Response | undefined>(
+  project: string,
+  from: string,
+  to: string,
+  init?: ExtendedOptions<R>,
+): Request => {
+  const { sid, hostName, csrf } = setDefaults(init ?? {});
+
+  return new Request(
+    `https://${hostName}/api/pages/${project}/replace/links`,
+    {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json;charset=utf-8",
+        "X-CSRF-TOKEN": csrf ?? "",
+        ...(sid ? { Cookie: cookie(sid) } : {}),
+      },
+      body: JSON.stringify({ from, to }),
+    },
+  );
+};
+
+/** Retrieves JSON data for a specified page
+ *
+ * @param project - The project name where all links will be replaced
+ * @param from - The original link text to be replaced
+ * @param to - The new link text to replace with
+ * @param init - Additional configuration options
+ * @returns A {@linkcode Result}<{@linkcode unknown}, {@linkcode Error}> containing:
+ *          - Success: The page data in JSON format
+ *          - Error: One of several possible errors:
+ *            - {@linkcode NotFoundError}: Page not found
+ *            - {@linkcode NotLoggedInError}: Authentication required
+ *            - {@linkcode NotMemberError}: User lacks access
+ */
+export const post = async <R extends Response | undefined = Response>(
+  project: string,
+  from: string,
+  to: string,
+  init?: ExtendedOptions<R>,
+): Promise<
+  ResponseOfEndpoint<{
+    200: string;
+    404: NotFoundError;
+    401: NotLoggedInError;
+    403: NotMemberError;
+  }, R>
+> => {
+  let { csrf, fetch, ...init2 } = setDefaults(init ?? {});
+
+  if (!csrf) {
+    const res = await get(init2);
+    if (!res.ok) return res;
+    csrf = (await res.json()).csrfToken;
+  }
+
+  return fetch(
+    makePostRequest(project, from, to, { csrf, ...init2 }),
+  ) as Promise<
+    ResponseOfEndpoint<{
+      200: string;
+      404: NotFoundError;
+      401: NotLoggedInError;
+      403: NotMemberError;
+    }, R>
+  >;
+};

deno.jsonc

@@ -27,6 +27,8 @@
     "./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",
+    "./unstable-api/pages/project/replace": "./api/pages/project/replace.ts",
+    "./unstable-api/pages/project/replace/links": "./api/pages/project/replace/links.ts",
     "./unstable-api/users": "./api/users.ts",
     "./unstable-api/users/me": "./api/users/me.ts"
   },

util.ts

@@ -54,6 +54,20 @@ export interface OAuthOptions<R extends Response | undefined>
   accessToken: string;
 }
 
+/** Extended options including CSRF token configuration
+ *
+ * Extends BaseOptions with CSRF token support for endpoints
+ * that require CSRF protection.
+ */
+export interface ExtendedOptions<R extends Response | undefined>
+  extends BaseOptions<R> {
+  /** CSRF token
+   *
+   * If it isn't set, automatically get CSRF token from scrapbox.io server.
+   */
+  csrf?: string;
+}
+
 /** Set default values for {@linkcode BaseOptions}
  *
  * Ensures all required fields have appropriate default values while