@bagooon/chatease-node-client 0.1.3 → 0.2.0

package/README.md

@@ -21,6 +21,7 @@ Node.js 向けの **[ChatEase](https://chatease.jp "ChatEase.jp") チャット
   - チャットボード生成のみ
   - チャットボード + 初期ステータス
   - チャットボード + 初期ステータス + 初期投稿
+- ワークスペース名取得メソッド `getWorkspaceName()` を提供
 - TypeScript フルサポート（型定義同梱）
 - 実行時バリデーション
   - `timeLimit` の日付妥当性（`YYYY-MM-DD` & 実在日付）
@@ -101,6 +102,10 @@ const res3 = await chatease.createBoardWithStatusAndMessage({
     content: 'ロゴデザインについて相談したいです。現在の案を添付しました。',
   },
 })
+
+// 4) ワークスペース名を取得
+//   （APIトークン＋ワークスペーススラッグが正しく設定されているかを確認する用途に利用できます。)
+const workdpaceName = await chatease.getWorkspaceName()
 ```
 
 ---
@@ -154,23 +159,17 @@ createBoard(params: CreateBoardBaseParams): Promise<CreateBoardResponse>
 ### `createBoardWithStatus(params)`
 
 ```ts
-type ChatEaseStatusKey =
-  | 'scheduled_for_proof'
-  | 'scheduled_for_response'
-  | 'scheduled_for_completion'
-  | 'waiting_for_reply'
-
 type InitialStatus =
   | {
       statusKey:
-        | 'scheduled_for_proof'
-        | 'scheduled_for_response'
-        | 'scheduled_for_completion'
+        | 'scheduled_for_proof'  // 校正予定
+        | 'scheduled_for_response'  // 返答予定
+        | 'scheduled_for_completion'  // 完了予定
       timeLimit: string // YYYY-MM-DD
     }
   | {
-      statusKey: 'waiting_for_reply'
-      timeLimit?: never
+      statusKey: 'waiting_for_reply'  // 返答待ち
+      timeLimit: never // 日付は指定できません
     }
 
 interface CreateBoardWithStatusParams extends CreateBoardBaseParams {
@@ -225,6 +224,18 @@ interface CreateBoardResponse {
 
 ---
 
+### `getWorkspaceName()`
+
+```ts
+getWorkspaceName(): Promise<string>
+```
+
+認証には既存の API トークンヘッダー（`X-Chatease-API-Token`）と、リクエストボディの `workspaceSlug` を使用します。  
+APIトークン＋ワークスペーススラッグが正しく設定されているかを確認する用途に利用できます。
+認証に失敗した場合は、例外を投げます。
+
+---
+
 ## Validation
 
 このクライアントは、API 呼び出し前に以下の実行時チェックを行います：

package/dist/client.d.ts

@@ -7,6 +7,7 @@ export declare class ChatEaseClient {
     createBoard(params: CreateBoardBaseParams): Promise<CreateBoardResponse>;
     createBoardWithStatus(params: CreateBoardWithStatusParams): Promise<CreateBoardResponse>;
     createBoardWithStatusAndMessage(params: CreateBoardWithStatusAndMessageParams): Promise<CreateBoardResponse>;
+    getWorkspaceName(): Promise<string>;
     /**
      * 実処理 + 共通バリデーション
      */

package/dist/client.js

@@ -26,6 +26,30 @@ export class ChatEaseClient {
     async createBoardWithStatusAndMessage(params) {
         return this._createBoard(params);
     }
+    async getWorkspaceName() {
+        const res = await fetch(this.buildUrl('/api/v1/board/name'), {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'X-Chatease-API-Token': this.apiToken,
+            },
+            body: JSON.stringify({
+                workspaceSlug: this.workspaceSlug,
+            }),
+        });
+        if (!res.ok) {
+            const text = await res.text().catch(() => '');
+            const message = [
+                `ChatEase API error: ${res.status} ${res.statusText}`,
+                text && `Body: ${text}`,
+            ]
+                .filter(Boolean)
+                .join(' - ');
+            throw new Error(message);
+        }
+        const json = (await res.json());
+        return json.name;
+    }
     /**
      * 実処理 + 共通バリデーション
      */

package/dist/types.d.ts

@@ -1,4 +1,3 @@
-export type ChatEaseStatusKey = 'scheduled_for_proof' | 'scheduled_for_response' | 'scheduled_for_completion' | 'waiting_for_reply';
 type ScheduledStatusKey = 'scheduled_for_proof' | 'scheduled_for_response' | 'scheduled_for_completion';
 type NonScheduledStatusKey = 'waiting_for_reply';
 export type InitialStatus = {
@@ -13,7 +12,7 @@ export type InitialStatus = {
     /**
      * scheduled 以外は timeLimit を指定させない
      */
-    timeLimit?: never;
+    timeLimit: never;
 };
 export interface ChatEaseClientOptions {
     apiToken: string;
@@ -51,4 +50,7 @@ export interface CreateBoardResponse {
     hostURL: string;
     guestURL: string;
 }
+export interface WorkspaceNameResponse {
+    name: string;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bagooon/chatease-node-client",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Node.js-only client for ChatEase board API",
   "repository": {
     "type": "git",