@miosa/sdk 1.0.0 → 1.2.0

package/src/resources/workspace-members.ts

@@ -0,0 +1,143 @@
+/**
+ * Workspace Members — per-workspace user roster.
+ *
+ * Endpoints:
+ *   GET    /workspaces/:id/members
+ *   POST   /workspaces/:id/members
+ *   PATCH  /workspaces/:id/members/:user_id
+ *   DELETE /workspaces/:id/members/:user_id
+ */
+
+import type { HttpClient } from "../http.js";
+
+// ── Resource shapes ──────────────────────────────────────────────────────────
+
+/** Role a user can hold within a workspace. */
+export type WorkspaceRole = "owner" | "admin" | "member" | "viewer";
+
+/**
+ * Workspace member as returned by `list` — includes denormalised user fields
+ * for display.
+ */
+export interface WorkspaceMember {
+  user_id: string;
+  email: string | null;
+  name: string | null;
+  avatar_url: string | null;
+  role: WorkspaceRole;
+  joined_at: string | null;
+  added_by: string | null;
+}
+
+/** Raw workspace_members row returned after add/update operations. */
+export interface WorkspaceMemberRecord {
+  user_id: string;
+  workspace_id: string;
+  role: WorkspaceRole;
+  joined_at: string | null;
+  added_by: string | null;
+}
+
+// ── Request payloads ─────────────────────────────────────────────────────────
+
+export interface AddWorkspaceMemberParams {
+  /** UUID of the tenant user to add. Must already be an org member. */
+  user_id: string;
+  /** Role to assign; defaults to `"member"`. */
+  role?: WorkspaceRole;
+}
+
+export interface UpdateWorkspaceMemberRoleParams {
+  role: WorkspaceRole;
+}
+
+// ── Response envelopes ───────────────────────────────────────────────────────
+
+export interface WorkspaceMemberListResponse {
+  data: WorkspaceMember[];
+}
+
+export interface WorkspaceMemberRecordResponse {
+  data: WorkspaceMemberRecord;
+}
+
+export interface WorkspaceMemberDeleteResponse {
+  deleted: boolean;
+}
+
+// ── Main resource ─────────────────────────────────────────────────────────────
+
+export class WorkspaceMembers {
+  constructor(private readonly http: HttpClient) {}
+
+  /**
+   * List all members of a workspace.
+   *
+   * `GET /workspaces/:id/members`
+   */
+  async list(workspaceId: string): Promise<WorkspaceMember[]> {
+    const res = await this.http.get<WorkspaceMemberListResponse>(
+      `/workspaces/${workspaceId}/members`,
+    );
+    return res.data ?? (res as unknown as WorkspaceMember[]);
+  }
+
+  /**
+   * Add an existing tenant user to a workspace.
+   *
+   * The `user_id` must already hold a `tenant_members` row for the parent org.
+   * Use {@link WorkspaceInvites.create} to invite someone who is not yet an org
+   * member.
+   *
+   * `POST /workspaces/:id/members`
+   *
+   * @throws `MiosaError` with code `NOT_TENANT_MEMBER` if the user is not an
+   *   org member.
+   */
+  async add(
+    workspaceId: string,
+    params: AddWorkspaceMemberParams,
+  ): Promise<WorkspaceMemberRecord> {
+    const res = await this.http.post<WorkspaceMemberRecordResponse>(
+      `/workspaces/${workspaceId}/members`,
+      params,
+    );
+    return res.data ?? (res as unknown as WorkspaceMemberRecord);
+  }
+
+  /**
+   * Change a workspace member's role.
+   *
+   * `PATCH /workspaces/:id/members/:user_id`
+   */
+  async updateRole(
+    workspaceId: string,
+    userId: string,
+    params: UpdateWorkspaceMemberRoleParams,
+  ): Promise<WorkspaceMemberRecord> {
+    const res = await this.http.patch<WorkspaceMemberRecordResponse>(
+      `/workspaces/${workspaceId}/members/${userId}`,
+      params,
+    );
+    return res.data ?? (res as unknown as WorkspaceMemberRecord);
+  }
+
+  /**
+   * Remove a user from a workspace.
+   *
+   * The last `owner` of a workspace cannot be removed. Promote another member
+   * to `owner` first using {@link updateRole}.
+   *
+   * `DELETE /workspaces/:id/members/:user_id`
+   *
+   * @throws `MiosaError` with code `LAST_OWNER` if the target is the sole owner.
+   */
+  async remove(
+    workspaceId: string,
+    userId: string,
+  ): Promise<WorkspaceMemberDeleteResponse> {
+    return this.http.delete<WorkspaceMemberDeleteResponse>(
+      `/workspaces/${workspaceId}/members/${userId}`,
+    );
+  }
+}

package/src/resources/workspaces.ts

@@ -0,0 +1,285 @@
+/**
+ * Workspaces resource — top-level tenant workspaces grouping computers.
+ *
+ * A workspace is a logical bucket of computers (handy for teams / projects).
+ * Accessed via `miosa.workspaces` on the top-level client.
+ *
+ * @example
+ * ```ts
+ * const ws = await miosa.workspaces.create({ name: "prod" });
+ * const computers = await miosa.workspaces.listComputers(ws.id);
+ * ```
+ */
+
+import type { HttpClient } from "../http.js";
+import type { ComputerData } from "../types.js";
+import { Computer } from "./computer.js";
+
+// ── Branded IDs ──────────────────────────────────────────────────────────────
+
+export type WorkspaceId = string & { readonly __brand: "WorkspaceId" };
+
+// ── Resource shapes ──────────────────────────────────────────────────────────
+
+export interface WorkspaceData {
+  id: WorkspaceId;
+  tenant_id: string;
+  name: string;
+  slug?: string | null;
+  description?: string | null;
+  metadata?: Record<string, unknown> | null;
+  settings?: Record<string, unknown> | null;
+  created_at?: string;
+  updated_at?: string;
+  [key: string]: unknown;
+}
+
+// ── Request payloads ─────────────────────────────────────────────────────────
+
+export interface WorkspaceCreateParams {
+  name: string;
+  slug?: string;
+  description?: string;
+  metadata?: Record<string, unknown>;
+}
+
+export interface WorkspaceUpdateParams {
+  name?: string;
+  description?: string;
+  metadata?: Record<string, unknown>;
+}
+
+export interface WorkspaceComputerTemplateCreateParams {
+  name: string;
+  templateType?: string;
+  template_type?: string;
+  description?: string;
+  [key: string]: unknown;
+}
+
+// ── Helpers ───────────────────────────────────────────────────────────────────
+
+function unwrap<T>(payload: unknown): T {
+  if (payload && typeof payload === "object" && "data" in (payload as object)) {
+    return (payload as { data: T }).data;
+  }
+  return payload as T;
+}
+
+function listItems<T>(
+  payload: unknown,
+  candidateKeys: string[] = ["data", "items"],
+): T[] {
+  if (Array.isArray(payload)) return payload;
+  if (!payload || typeof payload !== "object") return [];
+  const p = payload as Record<string, unknown>;
+  if (Array.isArray(p.data)) return p.data as T[];
+  for (const key of candidateKeys) {
+    if (Array.isArray(p[key])) return p[key] as T[];
+  }
+  return [];
+}
+
+// ── Workspaces resource ───────────────────────────────────────────────────────
+
+export class Workspaces {
+  private readonly http: HttpClient;
+
+  constructor(http: HttpClient) {
+    this.http = http;
+  }
+
+  /**
+   * Create a new workspace.
+   */
+  async create(params: WorkspaceCreateParams): Promise<WorkspaceData> {
+    const payload = await this.http.post<unknown>("/workspaces", params);
+    return unwrap<WorkspaceData>(payload);
+  }
+
+  /**
+   * List all workspaces visible to the current credential.
+   */
+  async list(): Promise<WorkspaceData[]> {
+    const payload = await this.http.get<unknown>("/workspaces");
+    if (
+      payload &&
+      typeof payload === "object" &&
+      "workspaces" in (payload as object)
+    ) {
+      const p = payload as Record<string, unknown>;
+      return (p["workspaces"] as WorkspaceData[]) ?? [];
+    }
+    return listItems<WorkspaceData>(payload, ["data", "workspaces", "items"]);
+  }
+
+  /**
+   * Get a single workspace by ID.
+   */
+  async get(id: WorkspaceId | string): Promise<WorkspaceData> {
+    const payload = await this.http.get<unknown>(`/workspaces/${id}`);
+    return unwrap<WorkspaceData>(payload);
+  }
+
+  /**
+   * Update a workspace's metadata.
+   */
+  async update(
+    id: WorkspaceId | string,
+    params: WorkspaceUpdateParams,
+  ): Promise<WorkspaceData> {
+    const payload = await this.http.patch<unknown>(`/workspaces/${id}`, params);
+    return unwrap<WorkspaceData>(payload);
+  }
+
+  /**
+   * Delete a workspace. Does not delete member computers.
+   */
+  async delete(id: WorkspaceId | string): Promise<void> {
+    await this.http.delete<void>(`/workspaces/${id}`);
+  }
+
+  /**
+   * Update workspace-level settings.
+   */
+  async updateSettings(
+    id: WorkspaceId | string,
+    settings: Record<string, unknown>,
+  ): Promise<WorkspaceData> {
+    const payload = await this.http.put<unknown>(
+      `/workspaces/${id}/settings`,
+      settings,
+    );
+    return unwrap<WorkspaceData>(payload);
+  }
+
+  /**
+   * List all computers that belong to the given workspace.
+   */
+  async listComputers(id: WorkspaceId | string): Promise<Computer[]> {
+    const payload = await this.http.get<unknown>(`/workspaces/${id}/computers`);
+    const items = listItems<ComputerData>(payload, [
+      "data",
+      "computers",
+      "items",
+    ]);
+    return items.map((d) => new Computer(this.http, d));
+  }
+
+  /**
+   * List all sandboxes that belong to this workspace.
+   */
+  async listSandboxes(
+    id: WorkspaceId | string,
+  ): Promise<Record<string, unknown>[]> {
+    const payload = await this.http.get<unknown>(`/workspaces/${id}/sandboxes`);
+    return listItems<Record<string, unknown>>(payload, [
+      "data",
+      "sandboxes",
+      "items",
+    ]);
+  }
+
+  /**
+   * List all deployments that belong to this workspace.
+   */
+  async listDeployments(
+    id: WorkspaceId | string,
+  ): Promise<Record<string, unknown>[]> {
+    const payload = await this.http.get<unknown>(
+      `/workspaces/${id}/deployments`,
+    );
+    return listItems<Record<string, unknown>>(payload, [
+      "data",
+      "deployments",
+      "items",
+    ]);
+  }
+
+  /**
+   * List all managed databases that belong to this workspace.
+   */
+  async listDatabases(
+    id: WorkspaceId | string,
+  ): Promise<Record<string, unknown>[]> {
+    const payload = await this.http.get<unknown>(`/workspaces/${id}/databases`);
+    return listItems<Record<string, unknown>>(payload, [
+      "data",
+      "databases",
+      "items",
+    ]);
+  }
+
+  /**
+   * List all projects that belong to this workspace.
+   */
+  async listProjects(
+    id: WorkspaceId | string,
+  ): Promise<Record<string, unknown>[]> {
+    const payload = await this.http.get<unknown>(`/workspaces/${id}/projects`);
+    return listItems<Record<string, unknown>>(payload, [
+      "data",
+      "projects",
+      "items",
+    ]);
+  }
+
+  /**
+   * Return aggregate resource stats for this workspace.
+   */
+  async stats(id: WorkspaceId | string): Promise<Record<string, unknown>> {
+    const payload = await this.http.get<unknown>(`/workspaces/${id}/stats`);
+    return unwrap<Record<string, unknown>>(payload);
+  }
+
+  /**
+   * Return metered usage data for this workspace.
+   */
+  async usage(id: WorkspaceId | string): Promise<Record<string, unknown>> {
+    const payload = await this.http.get<unknown>(`/workspaces/${id}/usage`);
+    return unwrap<Record<string, unknown>>(payload);
+  }
+
+  /**
+   * Return activity feed for this workspace.
+   */
+  async activity(id: WorkspaceId | string): Promise<Record<string, unknown>[]> {
+    const payload = await this.http.get<unknown>(`/workspaces/${id}/activity`);
+    return listItems<Record<string, unknown>>(payload, [
+      "data",
+      "activity",
+      "events",
+      "items",
+    ]);
+  }
+
+  /**
+   * List computer templates available in this workspace.
+   */
+  async listComputerTemplates(
+    id: WorkspaceId | string,
+  ): Promise<Record<string, unknown>[]> {
+    const payload = await this.http.get<unknown>(
+      `/workspaces/${id}/computer-templates`,
+    );
+    return listItems<Record<string, unknown>>(payload, [
+      "data",
+      "templates",
+      "items",
+    ]);
+  }
+
+  /**
+   * Create a computer template scoped to this workspace.
+   */
+  async createComputerTemplate(
+    id: WorkspaceId | string,
+    params: WorkspaceComputerTemplateCreateParams,
+  ): Promise<Record<string, unknown>> {
+    const payload = await this.http.post<unknown>(
+      `/workspaces/${id}/computer-templates`,
+      params,
+    );
+    return unwrap<Record<string, unknown>>(payload);
+  }
+}