Translate Japanese comments in API files and error types

Co-authored-by: takker99 <37929109+takker99@users.noreply.github.com>

Author: Copilot

api/page-data/export/project.ts

@@ -1,13 +1,13 @@
 import type { BaseLine, UnixTime } from "../../../base.ts";
 import type { Page, UserInfo } from "../../pages/project/title.ts";
 
-/** exportしたときのページデータ */
+/** page data when exported */
 export interface ExportedPage<hasMetadata extends true | false = false>
   extends Pick<Page, "title" | "updated" | "created" | "id" | "views"> {
-  /** ページ本文
+  /** page content
    *
-   * `hasMetadata === true`のときは行のmetadataが入る
-   * それ以外の場合は行のテキストが入る
+   * when `hasMetadata === true`, line metadata is included
+   * otherwise, line text is included
    */
   lines: hasMetadata extends true ? Omit<BaseLine, "id">[] : string[];
 }
@@ -20,7 +20,7 @@ export interface ExportedData<hasMetadata extends true | false = false> {
   /** project's display name */
   displayName: string;
 
-  /** このデータを生成した日時 (UNIX時刻) */
+  /** date and time when this data was generated (UNIX time) */
   exported: UnixTime;
 
   /** project members */

api/page-data/import/project.ts

@@ -6,7 +6,7 @@ export interface ImportedData<hasMetadata extends true | false = false> {
   pages: hasMetadata extends true ? ImportedPage[] : ImportedLightPage[];
 }
 
-/** メタデータ無しインポート用ページデータ */
+/** import page data without metadata */
 export interface ImportedLightPage {
   /** page's title
    *
@@ -20,18 +20,18 @@ export interface ImportedLightPage {
    */
   lines: string[];
 }
-/** インポート用メタデータ付き行データ */
+/** import line data with metadata */
 export interface ImportedLine {
   /** line text */
   text: string;
 
-  /** 行の最終更新日時 (UNIX時刻) */
+  /** line last update date and time (UNIX time) */
   updated?: UnixTime;
 
-  /** 行の最終作成日時 (UNIX時刻) */
+  /** line last creation date and time (UNIX time) */
   created?: UnixTime;
 }
-/** メタデータ付きインポート用ページデータ */
+/** import page data with metadata */
 export interface ImportedPage {
   /** page's title
    *

api/page-snapshots/project/pageId/timestampId.ts

@@ -15,12 +15,12 @@ export interface PageWithSnapshot extends BasePage {
 
 /** a page snapshot */
 export interface Snapshot {
-  /** snapshotを撮ったときのページタイトル */
+  /** page title when the snapshot was taken */
   title: string;
 
-  /** snapshotの作成日時 */
+  /** snapshot creation date and time */
   created: UnixTime;
 
-  /** snapshotしたページ本文 */
+  /** page content that was snapshotted */
   lines: BaseLine[];
 }

api/pages/project.ts

@@ -2,19 +2,19 @@ import type { PageId, UnixTime, UserId } from "../../base.ts";
 
 /** the response type of https://scrpabox.io/api/pages/:projectname */
 export interface PageList {
-  /** data取得先のproject名 */
+  /** project name from which data was retrieved */
   projectName: string;
 
-  /** parameterに渡したskipと同じ */
+  /** same as skip passed in parameter */
   skip: number;
 
-  /** parameterに渡したlimitと同じ */
+  /** same as limit passed in parameter */
   limit: number;
 
-  /** projectの全ページ数 (中身のないページを除く) */
+  /** total number of pages in the project (excluding pages with no content) */
   count: number;
 
-  /** 取得できたページ情報 */
+  /** page information that could be retrieved */
   pages: PageSummary[];
 }
 

api/pages/project/search/query.ts

@@ -5,7 +5,7 @@ export interface SearchResult {
   /** 検索したprojectの名前 */
   projectName: string;
 
-  /** 検索文字列 */
+  /** search string */
   searchQuery: string;
 
   /** 検索語句 */
@@ -17,7 +17,7 @@ export interface SearchResult {
   /** 検索件数 */
   count: number;
 
-  /** 検索文字列と完全一致するタイトルが見つかったら`true` */
+  /** `true` if a title with exact match to the search string is found */
   existsExactTitleMatch: boolean;
 
   field: "title" | "helpfeels" | "lines";

api/pages/project/search/watch-list.ts

@@ -3,7 +3,7 @@ import type { SearchQuery } from "./query.ts";
 
 /** the response type of /api/projects/search/query and /api/projects/search/watch-list */
 export interface ProjectSearchResult {
-  /** 検索文字列 */
+  /** search string */
   searchQuery: string;
 
   /** 検索語句 */

api/project-backup/project/backupId.ts

@@ -2,13 +2,13 @@ import type { BaseLine, StringLc, UnixTime } from "../../../base.ts";
 import type { UserForExport } from "../../page-data/export/project.ts";
 import type { Page } from "../../pages/project/title.ts";
 
-/** backupされるページデータ */
+/** page data to be backed up */
 export interface BackupedPage
   extends Pick<Page, "title" | "updated" | "created" | "id" | "views"> {
-  /** ページ本文 */
+  /** page content */
   lines: Pick<BaseLine, "text" | "created" | "updated" | "userId">[];
 
-  /** ページに含まれているリンク*/
+  /** links contained in the page */
   linksLc: StringLc[];
 }
 
@@ -20,7 +20,7 @@ export interface BackupData {
   /** project's display name */
   displayName: string;
 
-  /** このデータを生成した日時 (UNIX時刻) */
+  /** date and time when this data was generated (UNIX time) */
   exported: UnixTime;
 
   /** project members */

error.ts

@@ -1,6 +1,6 @@
-/** Scrapbox REST APIが返すエラーの型
+/** error types returned by Scrapbox REST API
  *
- * `name`はないことがある
+ * `name` may not exist
  */
 export interface ErrorLike {
   /** error name */
@@ -9,35 +9,35 @@ export interface ErrorLike {
   message: string;
 }
 
-/** 参加していないprivate projectに対してAPIを叩いたときに発生するエラー */
+/** error that occurs when calling API on a private project you haven't joined */
 export interface NotMemberError extends ErrorLike {
   /** error name */
   name: "NotMemberError";
 }
 
-/** 指定したprojectやpageが見つからないときに発生するエラー */
+/** error that occurs when the specified project or page is not found */
 export interface NotFoundError extends ErrorLike {
   /** error name */
   name: "NotFoundError";
 }
 
-/** owner/admin権限が不足しているときに発生するエラー */
+/** error that occurs when owner/admin privileges are insufficient */
 export interface NotPrivilegeError extends ErrorLike {
   /** error name */
   name: "NotPrivilegeError";
 }
 
-/** Loginが必要なAPIをloginせずに叩いたときに発生するエラー */
+/** error that occurs when calling an API that requires login without being logged in */
 export interface NotLoggedInError extends ErrorLike {
   /** error name */
   name: "NotLoggedInError";
 
-  /** 詳細情報 */
+  /** detailed information */
   details: {
-    /** 取得しようとしたprojectの名前 */
+    /** name of the project you tried to access */
     project: string;
 
-    /** 使用できるログイン方法 */
+    /** available login methods */
     loginStrategies: (
       | "google"
       | "github"
@@ -50,54 +50,54 @@ export interface NotLoggedInError extends ErrorLike {
   };
 }
 
-/** CSRF tokenが不正なときに発生するエラー */
+/** error that occurs when CSRF token is invalid */
 export interface SessionError extends ErrorLike {
   /** error name */
   name: "SessionError";
 }
 
-/** 不正なURLを渡したときに返ってくるエラー
+/** error returned when passing an invalid URL
  *
- * 実際のresponseではmessageしか返ってこないことに注意
+ * note that in actual response, only message is returned
  */
 export interface InvalidURLError extends ErrorLike {
   /** error name */
   name: "InvalidURLError";
 }
 
-/** URL先ページから正常な応答が返ってこなかったときのエラー */
+/** error when normal response is not returned from the URL destination page */
 export interface BadRequestError extends ErrorLike {
   /** error name */
   name: "BadRequestError";
 }
 
-/** 検索文字列を渡さないと出てくるエラー
+/** error that appears when you don't pass a search string
  *
- * 実際のresponseではmessageしか返ってこないことに注意
+ * note that in actual response, only message is returned
  */
 export interface NoQueryError extends ErrorLike {
   /** error name */
   name: "NoQueryError";
 }
-/** 不正なfollowingIdを渡されたときに発生するエラー
+/** error that occurs when an invalid followingId is passed
  *
- * 実際のresponseではmessageしか返ってこないことに注意
+ * note that in actual response, only message is returned
  */
 export interface InvalidFollowingIdError extends ErrorLike {
   name: "InvalidFollowingIdError";
 }
 
-/** 容量を使い切ったときに発生するerror
+/** error that occurs when capacity is exhausted
  *
- * 実際のresponseではmessageしか返ってこないことに注意
+ * note that in actual response, only message is returned
  */
 export interface FileCapacityError extends ErrorLike {
   name: "FileCapacityError";
 }
 
-/** Google Cloud Storage XML APIのerror
+/** Google Cloud Storage XML API error
  *
- * `message`には[この形式](https://cloud.google.com/storage/docs/xml-api/reference-status#http-status-and-error-codes)のXMLが入る
+ * `message` contains XML in [this format](https://cloud.google.com/storage/docs/xml-api/reference-status#http-status-and-error-codes)
  */
 export interface GCSError extends ErrorLike {
   name: "GCSError";