# 機能設計書 1-ワークスペース作成

## 概要

本ドキュメントは、Giselleにおけるワークスペース作成機能の設計を定義する。ワークスペースはAIワークフローを構築・実行するための基盤となるコンテナであり、本機能はその初期化処理を担当する。

### 本機能の処理概要

ワークスペース作成機能は、ユーザーが新しいAIワークフローを設計・実行するための空のコンテナ（ワークスペース）を生成し、永続化ストレージに保存する機能である。

**業務上の目的・背景**：Giselleはビジュアルワークフローエディタを提供するAIプラットフォームであり、ユーザーがAIワークフローを設計するには、まずワークスペースという作業領域を作成する必要がある。ワークスペースは、ノード（処理単位）や接続（データフロー）を配置する「キャンバス」として機能し、ワークフロー全体の状態を管理する。本機能により、ユーザーは何も存在しない初期状態のワークスペースを瞬時に生成でき、そこからワークフローの構築を開始できる。

**機能の利用シーン**：ロビー画面やワークスペース一覧画面で「新規ワークスペース作成」ボタンをクリックした際、またはテンプレートからワークフローを開始する際の基盤として利用される。新規プロジェクト開始時、既存ワークフローを参考にせず一から構築したい場合に活用される。

**主要な処理内容**：
1. 一意のワークスペースID（wrks_プレフィックス）を生成
2. 初期ワークスペースオブジェクト（空のノード配列、空の接続配列、デフォルトUI状態）を構築
3. Zodスキーマによるバリデーションを実行
4. ストレージにJSON形式で永続化

**関連システム・外部連携**：GiselleStorageインターフェースを通じてファイルシステムまたはクラウドストレージ（Vercel Blob等）と連携する。

**権限による制御**：本機能自体にはロールベースの制限はないが、呼び出し元のAPIエンドポイントにおいてチームメンバーシップの確認が行われる。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 15 | ロビー画面（V2） | 主機能 | チュートリアル、クイックアクションからの新規ワークスペース作成 |
| 16 | ワークスペース一覧画面 | 補助機能 | 新規ワークスペース作成ダイアログからの作成処理 |

## 機能種別

CRUD操作（Create）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| context | GiselleContext | Yes | Giselleの実行コンテキスト（ストレージ等を含む） | 型チェック |

### 入力データソース

- 実行コンテキスト: アプリケーション初期化時に構築されるGiselleContextオブジェクト
- ID生成: crypto.randomUUID()を使用した自動生成

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| id | WorkspaceId | ワークスペースの一意識別子（wrks_プレフィックス） |
| schemaVersion | "20250221" | スキーマバージョン |
| name | string \| undefined | ワークスペース名（初期値は未設定） |
| nodes | NodeLike[] | ノード配列（初期値は空配列） |
| connections | Connection[] | 接続配列（初期値は空配列） |
| ui | UIState | UI状態（ビューポート位置、ノード選択状態等） |

### 出力先

- ストレージ: `workspaces/{workspaceId}/workspace.json` パスにJSON形式で保存
- 戻り値: 呼び出し元に生成されたWorkspaceオブジェクトを返却

## 処理フロー

### 処理シーケンス

```
1. generateInitialWorkspace()を呼び出し
   └─ WorkspaceId.generate()で新しいワークスペースIDを生成
   └─ デフォルト値（空のノード・接続、初期ビューポート）で初期オブジェクトを構築

2. Workspace.parse()でバリデーション
   └─ Zodスキーマによるランタイム型検証を実行

3. setWorkspace()でストレージに保存
   └─ context.storage.setJson()でJSON形式で永続化
   └─ パス: workspaces/{workspaceId}/workspace.json

4. 生成されたWorkspaceオブジェクトを返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[generateInitialWorkspace呼び出し]
    B --> C[ワークスペースID生成]
    C --> D[初期オブジェクト構築]
    D --> E[Zodスキーマバリデーション]
    E --> F{バリデーション成功?}
    F -->|Yes| G[ストレージに保存]
    F -->|No| H[エラー終了]
    G --> I[Workspaceオブジェクト返却]
    I --> J[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 一意ID生成 | ワークスペースIDは必ずwrks_プレフィックスで始まり、UUIDベースの一意な値となる | 常に適用 |
| BR-002 | スキーマバージョン | 新規作成時は常に最新のスキーマバージョン（20250221）を使用 | 常に適用 |
| BR-003 | 初期状態 | 新規ワークスペースはノード・接続が空で、ビューポートは原点（0,0）、ズーム1.0 | 常に適用 |

### 計算ロジック

特になし

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ワークスペース保存 | ストレージ（Blob/ファイル） | INSERT | workspace.jsonとして保存 |

### テーブル別操作詳細

本機能はファイルベースのストレージを使用するため、RDBテーブル操作は発生しない。

#### ストレージ操作

| 操作 | パス | 内容 |
|-----|------|------|
| 保存 | workspaces/{workspaceId}/workspace.json | Workspaceオブジェクト全体をJSON形式で保存 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| VALIDATION_ERROR | バリデーションエラー | Zodスキーマ検証失敗 | 入力データの確認、スキーマ整合性の確認 |
| STORAGE_ERROR | ストレージエラー | ストレージへの書き込み失敗 | ストレージ接続確認、リトライ |

### リトライ仕様

ストレージ書き込み失敗時は呼び出し元でリトライを検討する。本機能自体にはリトライロジックは含まれない。

## トランザクション仕様

ファイルベースストレージのため、RDBトランザクションは発生しない。ストレージへの書き込みは単一操作で完了する。

## パフォーマンス要件

- レスポンス時間: 100ms以内（ストレージ書き込み含む）
- 同時実行: 制限なし（各ワークスペースは独立したファイルに保存）

## セキュリティ考慮事項

- ワークスペースIDはUUIDベースで推測困難
- ストレージパスにワークスペースIDを含み、他ワークスペースへのアクセスを防止
- 認証・認可は呼び出し元のAPIレイヤーで実施

## 備考

- ワークスペース作成後、ユーザーはワークフローエディタ画面でノードの追加や接続の設定を行う
- サンプルワークスペース作成やコピー機能とは異なり、完全に空の状態で作成される

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

ワークスペースの型定義を理解することが最初のステップである。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | id.ts | `packages/protocol/src/workspace/id.ts` | WorkspaceIdの生成規則（wrks_プレフィックス） |
| 1-2 | index.ts | `packages/protocol/src/workspace/index.ts` | Workspaceスキーマの全体構造、UIState、Viewport定義 |
| 1-3 | base.ts | `packages/protocol/src/node/base.ts` | NodeId、InputId、OutputIdの基本型定義 |
| 1-4 | connection.ts | `packages/protocol/src/connection.ts` | Connection型の構造 |

**読解のコツ**: Zodスキーマ定義を読む際は、`z.object()`で定義されたフィールドと、`z.infer<typeof Schema>`による型推論の関係を理解する。`createIdGenerator`はID生成とZodスキーマを統合したユーティリティである。

#### Step 2: エントリーポイントを理解する

機能の起点となるファイルを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | create-workspace.ts | `packages/giselle/src/workspaces/create-workspace.ts` | メイン関数の全体フロー |

**主要処理フロー**:
1. **5-6行目**: `generateInitialWorkspace()`を呼び出し、初期ワークスペースオブジェクトを生成
2. **7-11行目**: `setWorkspace()`を呼び出し、ストレージに保存
3. **12行目**: 生成されたワークスペースを返却

#### Step 3: ワークスペース初期化ロジックを理解する

generateInitialWorkspace関数の詳細を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | index.ts | `packages/protocol/src/workspace/index.ts` | generateInitialWorkspace関数（38-54行目） |

**主要処理フロー**:
- **40行目**: `WorkspaceId.generate()`で新しいIDを生成
- **41行目**: スキーマバージョン"20250221"を設定
- **42-43行目**: 空のノード・接続配列で初期化
- **44-52行目**: デフォルトのUI状態を設定

#### Step 4: ストレージ保存処理を理解する

ワークスペースの永続化処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | utils.ts | `packages/giselle/src/workspaces/utils.ts` | setWorkspace関数（20-33行目）、workspacePath関数（16-18行目） |

**主要処理フロー**:
- **16-18行目**: ストレージパスの生成規則（`workspaces/{workspaceId}/workspace.json`）
- **29-32行目**: `context.storage.setJson()`でJSON形式で保存

### プログラム呼び出し階層図

```
createWorkspace (create-workspace.ts)
    │
    ├─ generateInitialWorkspace (workspace/index.ts)
    │      └─ WorkspaceId.generate (workspace/id.ts)
    │
    └─ setWorkspace (utils.ts)
           └─ context.storage.setJson (GiselleStorage interface)
```

### データフロー図

```
[入力]               [処理]                    [出力]

GiselleContext ───▶ generateInitialWorkspace ───▶ Workspace Object
                           │
                           ▼
                    setWorkspace
                           │
                           ▼
                    Storage (Blob/File)
                    workspaces/{id}/workspace.json
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| create-workspace.ts | `packages/giselle/src/workspaces/create-workspace.ts` | ソース | メイン機能実装 |
| utils.ts | `packages/giselle/src/workspaces/utils.ts` | ソース | ストレージ操作ユーティリティ |
| index.ts | `packages/protocol/src/workspace/index.ts` | ソース | Workspaceスキーマ定義、初期化関数 |
| id.ts | `packages/protocol/src/workspace/id.ts` | ソース | WorkspaceId生成器 |
| base.ts | `packages/protocol/src/node/base.ts` | ソース | ノード基本型定義 |
| connection.ts | `packages/protocol/src/connection.ts` | ソース | Connection型定義 |
| types.ts | `packages/giselle/src/types.ts` | ソース | GiselleContext型定義 |
