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
# 兩個套件已預建置 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（零外部測試相依，需 Node ≥ 22.6 以直跑 .ts）
npm run type-check  # tsc --noEmit