@smartcrab/contracts-management 0.1.0

package/src/workspaces.test.ts

@@ -0,0 +1,127 @@
+import { describe, expect, test } from "vitest";
+import {
+  workspaceCreateRequestSchema,
+  workspaceListResponseSchema,
+  workspaceMemberListResponseSchema,
+  workspaceMemberSchema,
+  workspaceSchema,
+  workspaceUpdateRequestSchema,
+} from "./workspaces.js";
+
+const VALID_WORKSPACE = {
+  id: `wsp_${"a".repeat(32)}`,
+  name: "Acme Inc",
+  slug: "acme-inc",
+  status: "active",
+  stripe_customer_id: "cus_abc123",
+  created_at: "2026-08-02T08:10:00Z",
+  updated_at: "2026-08-02T08:10:00Z",
+  deleted_at: null,
+};
+
+describe("workspaceSchema (design.md §11.1)", () => {
+  test("accepts a valid workspace", () => {
+    expect(workspaceSchema.safeParse(VALID_WORKSPACE).success).toBe(true);
+  });
+
+  test("accepts a null stripe_customer_id (no billing set up yet)", () => {
+    expect(
+      workspaceSchema.safeParse({ ...VALID_WORKSPACE, stripe_customer_id: null }).success,
+    ).toBe(true);
+  });
+
+  test("rejects an unknown top-level key", () => {
+    expect(
+      workspaceSchema.safeParse({ ...VALID_WORKSPACE, control_database_key: "control_01" }).success,
+    ).toBe(false);
+  });
+
+  test("rejects an unknown status value", () => {
+    expect(workspaceSchema.safeParse({ ...VALID_WORKSPACE, status: "archived" }).success).toBe(
+      false,
+    );
+  });
+});
+
+describe("workspaceCreateRequestSchema", () => {
+  test("slug is optional", () => {
+    expect(workspaceCreateRequestSchema.safeParse({ name: "Acme Inc" }).success).toBe(true);
+  });
+
+  test("rejects an unknown field (e.g. attempting to set status at creation)", () => {
+    expect(
+      workspaceCreateRequestSchema.safeParse({ name: "Acme Inc", status: "active" }).success,
+    ).toBe(false);
+  });
+});
+
+describe("workspaceUpdateRequestSchema", () => {
+  test("does not allow patching status (Owner-only lifecycle transitions, design.md §27.2)", () => {
+    expect(workspaceUpdateRequestSchema.safeParse({ status: "suspended" }).success).toBe(false);
+  });
+
+  test("accepts an empty patch", () => {
+    expect(workspaceUpdateRequestSchema.safeParse({}).success).toBe(true);
+  });
+});
+
+describe("workspaceListResponseSchema", () => {
+  test("wraps a cursor page of workspaces", () => {
+    expect(
+      workspaceListResponseSchema.safeParse({ items: [VALID_WORKSPACE], next_cursor: null })
+        .success,
+    ).toBe(true);
+  });
+});
+
+const VALID_MEMBER = {
+  platform_user_id: "usr_owner",
+  role: "owner",
+  created_at: "2026-08-02T08:10:00Z",
+  updated_at: "2026-08-02T08:10:00Z",
+};
+
+describe("workspaceMemberSchema (design.md §11.2, §27.2)", () => {
+  test("accepts a valid member", () => {
+    expect(workspaceMemberSchema.safeParse(VALID_MEMBER).success).toBe(true);
+  });
+
+  test("accepts every design.md §27.2 role", () => {
+    for (const role of ["owner", "admin", "developer", "support", "billing", "viewer"]) {
+      expect(workspaceMemberSchema.safeParse({ ...VALID_MEMBER, role }).success).toBe(true);
+    }
+  });
+
+  test("rejects an unknown role", () => {
+    expect(workspaceMemberSchema.safeParse({ ...VALID_MEMBER, role: "superadmin" }).success).toBe(
+      false,
+    );
+  });
+
+  test("rejects an unknown top-level key (no credential/session material belongs here)", () => {
+    expect(workspaceMemberSchema.safeParse({ ...VALID_MEMBER, password: "hunter2" }).success).toBe(
+      false,
+    );
+    expect(workspaceMemberSchema.safeParse({ ...VALID_MEMBER, session_token: "abc" }).success).toBe(
+      false,
+    );
+  });
+});
+
+describe("workspaceMemberListResponseSchema", () => {
+  test("wraps a cursor page of members", () => {
+    expect(
+      workspaceMemberListResponseSchema.safeParse({ items: [VALID_MEMBER], next_cursor: null })
+        .success,
+    ).toBe(true);
+  });
+
+  test("rejects an item carrying a credential field", () => {
+    expect(
+      workspaceMemberListResponseSchema.safeParse({
+        items: [{ ...VALID_MEMBER, password_hash: "abc" }],
+        next_cursor: null,
+      }).success,
+    ).toBe(false);
+  });
+});

package/src/workspaces.ts

@@ -0,0 +1,106 @@
+import { z } from "zod";
+import { cursorPageSchema, paginationQuerySchema } from "./common.js";
+import { slugSchema, workspaceIdSchema } from "./primitives.js";
+import { workspaceRoleSchema } from "./rbac.js";
+
+/**
+ * `workspaces` (design.md §11.1, §7.1). No secret/internal-routing columns
+ * exist on this table to exclude; `stripe_customer_id` is an opaque Stripe
+ * identifier (not a secret — it carries no ability to act on the customer)
+ * and is useful to dashboard/billing UI, so it is exposed as nullable.
+ */
+export const WORKSPACE_STATUSES = ["active", "past_due", "suspended", "deleted"] as const;
+export const workspaceStatusSchema = z.enum(WORKSPACE_STATUSES);
+export type WorkspaceStatus = (typeof WORKSPACE_STATUSES)[number];
+
+export const workspaceSchema = z.strictObject({
+  id: workspaceIdSchema,
+  name: z.string().min(1).max(200),
+  slug: slugSchema,
+  status: workspaceStatusSchema,
+  stripe_customer_id: z.string().min(1).nullable(),
+  created_at: z.iso.datetime(),
+  updated_at: z.iso.datetime(),
+  deleted_at: z.iso.datetime().nullable(),
+});
+export type Workspace = z.infer<typeof workspaceSchema>;
+
+// ---------------------------------------------------------------------------
+// GET /workspaces
+// ---------------------------------------------------------------------------
+
+export const workspaceListQuerySchema = paginationQuerySchema.extend({
+  status: workspaceStatusSchema.optional(),
+});
+export type WorkspaceListQuery = z.infer<typeof workspaceListQuerySchema>;
+
+export const workspaceListResponseSchema = cursorPageSchema(workspaceSchema);
+export type WorkspaceListResponse = z.infer<typeof workspaceListResponseSchema>;
+
+// ---------------------------------------------------------------------------
+// POST /workspaces
+// ---------------------------------------------------------------------------
+
+/** `slug` is optional: when omitted, the server derives one from `name` (design.md §11.1 `slug UNIQUE`). */
+export const workspaceCreateRequestSchema = z.strictObject({
+  name: z.string().min(1).max(200),
+  slug: slugSchema.optional(),
+});
+export type WorkspaceCreateRequest = z.infer<typeof workspaceCreateRequestSchema>;
+
+export const workspaceCreateResponseSchema = workspaceSchema;
+export type WorkspaceCreateResponse = z.infer<typeof workspaceCreateResponseSchema>;
+
+// ---------------------------------------------------------------------------
+// GET /workspaces/:workspaceId
+// ---------------------------------------------------------------------------
+
+export const workspaceGetResponseSchema = workspaceSchema;
+export type WorkspaceGetResponse = z.infer<typeof workspaceGetResponseSchema>;
+
+// ---------------------------------------------------------------------------
+// PATCH /workspaces/:workspaceId
+// ---------------------------------------------------------------------------
+
+/**
+ * `status` is deliberately excluded: workspace suspension/deletion are
+ * billing- and Owner-driven lifecycle transitions (design.md §27.2 "Owner: 全
+ * 操作、課金、Workspace削除"), not a generic field patch.
+ */
+export const workspaceUpdateRequestSchema = z.strictObject({
+  name: z.string().min(1).max(200).optional(),
+  slug: slugSchema.optional(),
+});
+export type WorkspaceUpdateRequest = z.infer<typeof workspaceUpdateRequestSchema>;
+
+export const workspaceUpdateResponseSchema = workspaceSchema;
+export type WorkspaceUpdateResponse = z.infer<typeof workspaceUpdateResponseSchema>;
+
+// ---------------------------------------------------------------------------
+// GET /workspaces/:workspaceId/members
+// ---------------------------------------------------------------------------
+
+/**
+ * `workspace_members` (design.md §11.2, §27.2). Exposes only the fields the
+ * assignment enumerates — `platform_user_id`/`role`/`created_at`/
+ * `updated_at` — no credential or session material (this table carries none
+ * anyway; those four columns are its entire shape). `platform_user_id` is a
+ * plain non-empty string rather than `userIdSchema`: it identifies a
+ * platform (dashboard) user of this Control Plane's own dogfooded
+ * Environment (design.md §27.1), a distinct identifier space from the
+ * `usr_...`-pattern end users `userIdSchema` models elsewhere in this
+ * package.
+ */
+export const workspaceMemberSchema = z.strictObject({
+  platform_user_id: z.string().min(1),
+  role: workspaceRoleSchema,
+  created_at: z.iso.datetime(),
+  updated_at: z.iso.datetime(),
+});
+export type WorkspaceMember = z.infer<typeof workspaceMemberSchema>;
+
+export const workspaceMemberListQuerySchema = paginationQuerySchema;
+export type WorkspaceMemberListQuery = z.infer<typeof workspaceMemberListQuerySchema>;
+
+export const workspaceMemberListResponseSchema = cursorPageSchema(workspaceMemberSchema);
+export type WorkspaceMemberListResponse = z.infer<typeof workspaceMemberListResponseSchema>;