feat(websocket): Add /websocket submodule, which provides types about Websocket events used in Cosense

Author: takker99

change.ts

@@ -1,36 +1,36 @@
-import type { BasePage, LineId, StringLc } from "./base.ts";
+import type { LineId, StringLc } from "./base.ts";
+import type {
+  ChangeLine,
+  CharsCountChange,
+  DeleteChange,
+  DescriptionsChange,
+  FilesChange,
+  HelpFeelsChange,
+  ImageChange,
+  InfoboxDefinitionChange,
+  InsertChange,
+  LinesCountChange,
+  PinChange,
+} from "./websocket/change.ts";
 
 /** ページの変更内容 */
 export type Change =
   | InsertChange
   | UpdateChange
   | DeleteChange
   | LinksChange
+  | ProjectLinksChange
+  | IconsChange
   | DescriptionsChange
   | ImageChange
+  | FilesChange
+  | HelpFeelsChange
+  | InfoboxDefinitionChange
   | TitleChange
+  | LinesCountChange
+  | CharsCountChange
   | PinChange;
 
-/** 行を新規作成する変更 */
-export interface InsertChange {
-  /** このIDが示す行の上に挿入する
-   *
-   * 末尾に挿入するときは`"_end"`を指定する
-   */
-  _insert: LineId;
-
-  /** 挿入する行のデータ */
-  lines: NewLine;
-}
-
-export interface NewLine {
-  /** 新しく挿入する行のID */
-  id: LineId;
-
-  /** 行のテキスト */
-  text: string;
-}
-
 /** 既存の行を書き換える変更 */
 export interface UpdateChange {
   /** 書き換える行のID */
@@ -40,23 +40,6 @@ export interface UpdateChange {
   lines: ChangeLine;
 }
 
-export interface ChangeLine {
-  /**変更前の文字列*/
-  origText: string;
-
-  /**変更後の文字列*/
-  text: string;
-}
-
-/** 既存の行を削除する変更 */
-export interface DeleteChange {
-  /** 削除する行のID */
-  _delete: LineId;
-
-  /** 常に `-1` */
-  lines: -1;
-}
-
 /** ページ中のリンクが変更されると発生する */
 export interface LinksChange {
   /** 新しいリンク */
@@ -66,19 +49,22 @@ export interface LinksChange {
   linksLc: StringLc[];
 }
 
-/** ページのサムネイル本文が変更されると発生する */
-export interface DescriptionsChange {
-  /** 新しいサムネイル本文 */
-  descriptions: string[];
+/** ページ中のproject linksが変更されると発生する */
+export interface ProjectLinksChange {
+  /** 新しいリンク */
+  projectLinks: string[];
+
+  /** 新しいリンク */
+  projectLinksLc: StringLc[];
 }
 
-/** ページのサムネイルが変更されると発生する */
-export interface ImageChange {
-  /** 新しいサムネイルのURL
-   *
-   * サムネイルがなくなったときは`null`になる
-   */
-  image: string | null;
+/** ページ中のiconsが変更されると発生する */
+export interface IconsChange {
+  /** 新しいicons */
+  icons: string[];
+
+  /** 新しいicons */
+  iconsLc: StringLc[];
 }
 
 /** ページのタイトルが変更されると発生する */
@@ -89,8 +75,3 @@ export interface TitleChange {
   /** 新しいタイトル */
   titleLc: StringLc;
 }
-
-/** ページのピンの状態が変更されると発生する */
-export interface PinChange {
-  pin: BasePage["pin"];
-}

deno.jsonc

@@ -5,14 +5,15 @@
     "fix": "deno fmt && deno lint --fix && deno test --allow-read --doc --parallel --shuffle && deno publish --dry-run --allow-dirty",
     "check": "deno fmt --check && deno lint && deno test --allow-read --doc --parallel --shuffle && deno publish --dry-run",
     "coverage": "deno test --allow-read=./ --parallel --shuffle --coverage && deno coverage --html",
-    "doc": "deno doc --html rest.ts userscript.ts"
+    "doc": "deno doc --html rest.ts userscript.ts websocket.ts"
   },
   "imports": {
     "@std/testing/types": "jsr:@std/testing@0/types"
   },
   "exports": {
     "./rest": "./rest.ts",
-    "./userscript": "./userscript.ts"
+    "./userscript": "./userscript.ts",
+    "./websocket": "./websocket.ts"
   },
   "compilerOptions": {
     "lib": [

deno.lock

@@ -0,0 +1,2 @@
+export * from "./websocket/change.ts";
+export * from "./websocket/event.ts";

websocket.ts

@@ -0,0 +1,136 @@
+import type { BasePage, LineId } from "../base.ts";
+
+/** Changes to push to the cosense server */
+export type ChangeToPush =
+  | InsertChange
+  | UpdateChange
+  | DeleteChange
+  | LinksChange
+  | ProjectLinksChange
+  | IconsChange
+  | DescriptionsChange
+  | ImageChange
+  | FilesChange
+  | HelpFeelsChange
+  | InfoboxDefinitionChange
+  | TitleChange
+  | LinesCountChange
+  | CharsCountChange
+  | PinChange;
+
+/** 行を新規作成する変更 */
+export interface InsertChange {
+  /** このIDが示す行の上に挿入する
+   *
+   * 末尾に挿入するときは`"_end"`を指定する
+   */
+  _insert: LineId;
+
+  /** 挿入する行のデータ */
+  lines: NewLine;
+}
+export interface NewLine {
+  /** 新しく挿入する行のID */
+  id: LineId;
+
+  /** 行のテキスト */
+  text: string;
+}
+
+export interface UpdateChange {
+  _update: string;
+  lines: Pick<ChangeLine, "text">;
+  noTimestampUpdate?: unknown;
+}
+
+export interface ChangeLine {
+  /**変更前の文字列*/
+  origText: string;
+
+  /**変更後の文字列*/
+  text: string;
+}
+
+/** 既存の行を削除する変更 */
+export interface DeleteChange {
+  /** 削除する行のID */
+  _delete: LineId;
+
+  /** 常に `-1` */
+  lines: -1;
+}
+
+export interface LinksChange {
+  links: string[];
+}
+
+export interface ProjectLinksChange {
+  projectLinks: string[];
+}
+
+export interface IconsChange {
+  icons: string[];
+}
+
+/** ページのサムネイル本文が変更されると発生する */
+export interface DescriptionsChange {
+  /** 新しいサムネイル本文 */
+  descriptions: string[];
+}
+
+/** ページのサムネイルが変更されると発生する */
+export interface ImageChange {
+  /** 新しいサムネイルのURL
+   *
+   * サムネイルがなくなったときは`null`になる
+   */
+  image: string | null;
+}
+
+export interface TitleChange {
+  title: string;
+}
+
+export interface FilesChange {
+  /** Array of file IDs
+   *
+   * These IDs reference files that have been uploaded to the page.
+   * Files can include images, documents, or other attachments.
+   */
+  files: string[];
+}
+export interface HelpFeelsChange {
+  /** Array of Helpfeel entries without the leading "? " prefix
+   *
+   * Helpfeel is a Scrapbox notation for creating help/documentation entries.
+   * Example: "? How to use" becomes "How to use" in this array.
+   * These entries are used to build the page's help documentation.
+   */
+  helpfeels: string[];
+}
+
+export interface InfoboxDefinitionChange {
+  /** Array of trimmed lines from infobox tables
+   *
+   * Contains lines from tables marked with either `table:infobox` or `table:cosense`
+   */
+  infoboxDefinition: string[];
+}
+
+export interface LinesCountChange {
+  linesCount: number;
+}
+
+export interface CharsCountChange {
+  charsCount: number;
+}
+
+/** ページのピンの状態が変更されると発生する */
+export interface PinChange {
+  pin: BasePage["pin"];
+}
+
+export interface DeletePageChange {
+  deleted: true;
+  merged?: true;
+}