SDK API リファレンス

                      
                      interface VerifyOptions {
  secret?: string;        // HS256 シークレット（per-app または共有）。HS256 検証時は必須
  publicKey?: string;     // RS256 PEM 公開鍵。RS256 検証時は必須（ロードマップ）
  audience: string;       // 拡張アプリの host、トークンの aud と一致する必要がある（必須）
  issuer?: string;        // デフォルト 'gptbots-workspace'
  leewaySeconds?: number; // 時計のずれの許容（秒）、デフォルト 30
  algorithms?: ('HS256' | 'RS256')[]; // デフォルト ['HS256']
}

interface WorkspaceIdentity {
  accountId: string;                  // = JWT sub
  role: 'OWNER' | 'ADMIN' | 'MEMBER'; // 未知の値は MEMBER に正規化
  workspaceId: string;                // = JWT workspace_id
  username?: string; email?: string; avatar?: string; appName?: string;
  issuedAt?: number;   // = iat（秒）
  expiresAt?: number;  // = exp（秒）
}

                    

                      
                      interface ExchangeWorkspaceCodeOptions {
  tokenUrl: string;      // プラットフォームの /token エンドポイント（絶対 URL）
  code: string;          // コールバックで取得した使い捨ての認可コード
  codeVerifier: string;  // code_challenge に対応する PKCE verifier
  fetch?: typeof fetch;  // fetch を注入可能（テスト/古いランタイム）；デフォルトはグローバル fetch
  timeoutMs?: number;    // リクエストタイムアウト、デフォルト 10000；0 を渡すと無効
}

interface WorkspaceCodeExchangeResult {
  wsa: string;           // 署名済みの wsa、verifyWsa に渡す
  tokenType?: string;    // 'Bearer'
  expiresIn?: number;    // wsa の有効期限（秒）
}

                    

                      
                      import { verifyWsa, WsaVerificationError } from '@gptbots/workspace-extension-verify';

export function requireWorkspaceIdentity(secret: string, audience: string) {
  return (req, res, next) => {
    try {
      req.identity = verifyWsa(req.body.wsa, { secret, audience });
      next();
    } catch (e) {
      const code = e instanceof WsaVerificationError ? e.code : 'Error';
      res.status(401).json({ code });
    }
  };
}

                    

                      
                      interface ConsumeHandoffOptions {
  exchangeUrl: string;   // 拡張アプリのバックエンド検証インターフェース
  fetch?: typeof fetch;  // 注入可能
  search?: string;       // デフォルト location.search
  paramName?: string;    // デフォルト 'wsa'
  strip?: boolean;       // デフォルト true（成功時のみ消去）
}

                    

                      
                      interface StartWorkspaceLoginOptions {
  authorizeUrl: string;  // プラットフォームの /authorize エンドポイント（絶対 URL）
  clientId: string;      // 拡張アプリの app home URL
  redirectUri: string;   // コールバックアドレス、host は clientId と同一ドメインでなければならない
  state?: string;        // デフォルトで 16 バイトのランダム CSRF state を自動生成
  workspaceId?: string;  // ワークスペースを事前選択し、組織選択ページをスキップ
  storage?: StorageLike; // デフォルト sessionStorage
  redirect?: (url: string) => void; // デフォルト location.assign
  navigate?: boolean;    // false = URL を構築するだけで遷移しない（popup/テスト）
}
interface WorkspaceLoginRequest { url: string; state: string; codeVerifier: string; }

                    

                      
                      interface AuthorizeCallback { code: string; state: string | null; codeVerifier: string; }

                    

                      
                      interface CompleteWorkspaceLoginOptions {
  exchangeUrl: string;   // あなた自身のバックエンド交換インターフェース
  fetch?: typeof fetch;
  search?: string;       // デフォルト location.search
  storage?: StorageLike; // デフォルト sessionStorage
  strip?: boolean;       // デフォルト true
}

                    

                      
                      unzip workspace-extension-sdk-0.1.0.zip
# 2 つのパッケージはビルド済みの dist（main=dist/index.js, types=dist/index.d.ts）
npm i ./workspace-extension-sdk/packages/verify   # バックエンド
npm i ./workspace-extension-sdk/packages/browser  # フロントエンド

                    

                      
                      cd workspace-extension-sdk
npm install
npm run build       # tsc → 各パッケージの dist
npm test            # node --test（外部テスト依存ゼロ、.ts を直接実行するには Node ≥ 22.6 が必要）
npm run type-check  # tsc --noEmit