Merge pull request #12 from takker99/add-listpages

Add `listPages()`

Author: takker99

deps/scrapbox.ts

@@ -11,6 +11,7 @@ export type {
   NotMemberProject,
   NotPrivilegeError,
   Page,
+  PageList,
   Scrapbox,
 } from "https://raw.githubusercontent.com/scrapbox-jp/types/0.0.8/mod.ts";
 import type { Page } from "https://raw.githubusercontent.com/scrapbox-jp/types/0.0.8/mod.ts";

rest/pages.ts

@@ -3,13 +3,10 @@ import type {
   NotLoggedInError,
   NotMemberError,
   Page,
+  PageList,
 } from "../deps/scrapbox.ts";
-import {
-  cookie,
-  encodeTitle,
-  makeCustomError,
-  tryToErrorLike,
-} from "./utils.ts";
+import { cookie, makeCustomError, tryToErrorLike } from "./utils.ts";
+import { encodeTitleURI } from "../title.ts";
 import type { Result } from "./utils.ts";
 
 /** Options for `getPage()` */
@@ -34,7 +31,7 @@ export async function getPage(
   >
 > {
   const path = `https://scrapbox.io/api/pages/${project}/${
-    encodeTitle(title)
+    encodeTitleURI(title)
   }?followRename=${options?.followRename ?? true}`;
 
   const res = await fetch(
@@ -68,3 +65,84 @@ export async function getPage(
   const value = (await res.json()) as Page;
   return { ok: true, value };
 }
+
+/** Options for `listPages()` */
+export interface ListPagesOption {
+  /** the sort of page list to return
+   *
+   * @default "updated"
+   */
+  sort?:
+    | "updatedWithMe"
+    | "updated"
+    | "created"
+    | "accessed"
+    | "pageRank"
+    | "linked"
+    | "views"
+    | "title";
+  /** the index getting page list from
+   *
+   * @default 0
+   */
+  skip?: number;
+  /** threshold of the length of page list
+   *
+   * @default 100
+   */
+  limit?: number;
+  /** connect.sid */
+  sid?: string;
+}
+/** 指定したprojectのページを一覧する
+ *
+ * @param project 一覧したいproject
+ * @param options オプション 取得範囲や並び順を決める
+ */
+export async function listPages(
+  project: string,
+  options?: ListPagesOption,
+): Promise<
+  Result<
+    PageList,
+    NotFoundError | NotLoggedInError | NotMemberError
+  >
+> {
+  const { sort, limit, skip } = options ?? {};
+  const params = new URLSearchParams();
+  if (sort !== undefined) params.append("sort", sort);
+  if (limit !== undefined) params.append("limit", `${limit}`);
+  if (skip !== undefined) params.append("skip", `${skip}`);
+  const path = `https://scrapbox.io/api/pages/${project}?${params.toString()}`;
+
+  const res = await fetch(
+    path,
+    options?.sid
+      ? {
+        headers: {
+          Cookie: cookie(options.sid),
+        },
+      }
+      : undefined,
+  );
+
+  if (!res.ok) {
+    const value = tryToErrorLike(await res.text()) as
+      | false
+      | NotFoundError
+      | NotLoggedInError
+      | NotMemberError;
+    if (!value) {
+      throw makeCustomError(
+        "UnexpectedError",
+        `Unexpected error has occuerd when fetching "${path}"`,
+      );
+    }
+    return {
+      ok: false,
+      value,
+    };
+  }
+  const value = (await res.json()) as PageList;
+  return { ok: true, value };
+}

rest/utils.ts

@@ -56,11 +56,3 @@ export function makeCustomError(name: string, message: string) {
   error.message = message;
   return error;
 }
-
-export const toTitleLc = (title: string) =>
-  title.toLowerCase().replaceAll(" ", "_");
-export const encodeTitle = (title: string) =>
-  title.replaceAll(" ", "_").replace(
-    /[/?#\{}^|<>]/g,
-    (char) => encodeURIComponent(char),
-  );