SDK API Reference

                      
                      interface VerifyOptions {
  secret?: string;        // HS256 secret (per-app or shared). Required when verifying HS256
  publicKey?: string;     // RS256 PEM public key. Required when verifying RS256 (roadmap)
  audience: string;       // extension app host, must equal the token's aud (required)
  issuer?: string;        // default 'gptbots-workspace'
  leewaySeconds?: number; // clock drift tolerance (seconds), default 30
  algorithms?: ('HS256' | 'RS256')[]; // default ['HS256']
}

interface WorkspaceIdentity {
  accountId: string;                  // = JWT sub
  role: 'OWNER' | 'ADMIN' | 'MEMBER'; // unknown values are normalized to MEMBER
  workspaceId: string;                // = JWT workspace_id
  username?: string; email?: string; avatar?: string; appName?: string;
  issuedAt?: number;   // = iat (seconds)
  expiresAt?: number;  // = exp (seconds)
}

                    

                      
                      interface ExchangeWorkspaceCodeOptions {
  tokenUrl: string;      // the platform /token endpoint (absolute URL)
  code: string;          // the one-time authorization code obtained on callback
  codeVerifier: string;  // the PKCE verifier corresponding to code_challenge
  fetch?: typeof fetch;  // injectable fetch (testing/legacy runtimes); default is the global fetch
  timeoutMs?: number;    // request timeout, default 10000; pass 0 to disable
}

interface WorkspaceCodeExchangeResult {
  wsa: string;           // the signed wsa, to pass to verifyWsa
  tokenType?: string;    // 'Bearer'
  expiresIn?: number;    // wsa validity period (seconds)
}

                    

                      
                      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;   // the extension app's backend verification endpoint
  fetch?: typeof fetch;  // injectable
  search?: string;       // default location.search
  paramName?: string;    // default 'wsa'
  strip?: boolean;       // default true (strips only on success)
}

                    

                      
                      interface StartWorkspaceLoginOptions {
  authorizeUrl: string;  // the platform /authorize endpoint (absolute URL)
  clientId: string;      // the extension app's app home URL
  redirectUri: string;   // the callback address, host must be same-origin as clientId
  state?: string;        // default: auto-generate a 16-byte random CSRF state
  workspaceId?: string;  // preselect a workspace, skipping the organization selection page
  storage?: StorageLike; // default sessionStorage
  redirect?: (url: string) => void; // default location.assign
  navigate?: boolean;    // false = only build the URL without redirecting (popup/testing)
}
interface WorkspaceLoginRequest { url: string; state: string; codeVerifier: string; }

                    

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

                    

                      
                      interface CompleteWorkspaceLoginOptions {
  exchangeUrl: string;   // your own backend exchange endpoint
  fetch?: typeof fetch;
  search?: string;       // default location.search
  storage?: StorageLike; // default sessionStorage
  strip?: boolean;       // default true
}

                    

                      
                      unzip workspace-extension-sdk-0.1.0.zip
# both packages have a prebuilt dist (main=dist/index.js, types=dist/index.d.ts)
npm i ./workspace-extension-sdk/packages/verify   # backend
npm i ./workspace-extension-sdk/packages/browser  # frontend

                    

                      
                      cd workspace-extension-sdk
npm install
npm run build       # tsc → dist for each package
npm test            # node --test (zero external test dependencies, requires Node ≥ 22.6 to run .ts directly)
npm run type-check  # tsc --noEmit