TypeScript SDK

{
  "dependencies": {
    "@misar/workspace": "workspace:*"
  }
}

import { createWorkspaceClient } from "@misar/workspace";

const workspaces = createWorkspaceClient({
  baseUrl: "https://api.misar.io/io/workspaces",
  serviceKey: process.env.WORKSPACE_SERVICE_KEY,
});

import type {
  Workspace,
  WorkspaceMember,
  WorkspaceRole,
  WorkspaceMemberStatus,
  AccessResult,
} from "@misar/workspace";

type WorkspaceRole = "owner" | "admin" | "member";
type WorkspaceMemberStatus = "active" | "invited" | "removed";

interface Workspace {
  id: string;
  name: string;
  slug: string | null;
  owner_id: string;
  created_at: string;
  updated_at: string;
}

interface WorkspaceMember {
  id: string;
  workspace_id: string;
  user_id: string | null;      // null for a pending invite
  invited_email: string | null;
  role: WorkspaceRole;
  status: WorkspaceMemberStatus;
  invited_by: string | null;
  created_at: string;
}

interface AccessResult {
  allowed: boolean;
  role: WorkspaceRole | null;
}

// List the workspaces a user owns or is an active member of
const list: Workspace[] = await workspaces.getWorkspaces(userId);

// Create a workspace (the user becomes owner)
const created: Workspace = await workspaces.createWorkspace(userId, "Acme Agency");

// Get one workspace + the user's role in it (member+)
const { workspace, role } = await workspaces.getWorkspace(userId, wsId);

// Rename a workspace (admin+)
const renamed: Workspace = await workspaces.updateWorkspace(userId, wsId, { name: "Acme Studios" });

// Delete a workspace (owner only)
await workspaces.deleteWorkspace(userId, wsId);

// List members (member+)
const { workspace: ws, members } = await workspaces.listMembers(userId, wsId);

// Invite / add a member by email (admin+); role defaults to "member"
const member: WorkspaceMember = await workspaces.inviteMember(userId, wsId, "teammate@example.com", "admin");

// Soft-remove a member by membership id (admin+; owner protected)
await workspaces.removeMember(userId, wsId, memberId);

// Gate access — the check products call before serving workspace data
const { allowed, role: accessRole } = await workspaces.checkAccess(userId, wsId);

import { WorkspaceError } from "@misar/workspace";

try {
  await workspaces.deleteWorkspace(userId, wsId);
} catch (err) {
  if (err instanceof WorkspaceError) {
    console.error(err.status, err.message);
    // err.status === 403 → caller is not the owner
  }
}