@spacefast/common 0.0.2

package/dist/contracts/superadmin.js

@@ -0,0 +1,309 @@
+import { z } from "zod";
+import { makeOffsetListSchema } from "./common.js";
+import { buildStatus } from "./enums.js";
+// Operator-only offset pagination. The platform API uses opaque cursors exclusively
+// (contracts/common.ts); the superadmin surface is the one sanctioned exception.
+export const superadminPaginationSchema = z.object({
+    count: z.number().int().nonnegative(),
+    next: z.number().int().nonnegative().nullable(),
+    prev: z.number().int().nonnegative().nullable(),
+});
+export const SuperadminAccessSchema = z.object({
+    allowed: z.boolean(),
+    userId: z.string().nullable(),
+    role: z.string().nullable(),
+});
+export const SuperadminUserProfileSchema = z.object({
+    tenantId: z.string(),
+    analyticsId: z.string(),
+    image: z.string().nullable(),
+    username: z.string().nullable(),
+    displayUsername: z.string().nullable(),
+    emailVerified: z.boolean(),
+    isAutomattician: z.boolean(),
+    wpcom: z.boolean(),
+    betaEnrolledAt: z.string().datetime().nullable(),
+    stripeCustomerId: z.string().nullable(),
+    twoFactorEnabled: z.boolean(),
+    theme: z.string(),
+    wpcomProfileJson: z.record(z.string(), z.unknown()).nullable(),
+});
+export const SuperadminUserTeamSchema = z.object({
+    membershipId: z.string(),
+    membershipRole: z.string(),
+    membershipCreatedAt: z.string().datetime(),
+    teamId: z.string(),
+    teamSlug: z.string(),
+    teamName: z.string(),
+    teamTenantId: z.string(),
+    teamCreatedAt: z.string().datetime(),
+});
+export const SuperadminUserSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    email: z.string().email(),
+    role: z.string().nullable(),
+    banned: z.boolean(),
+    banReason: z.string().nullable(),
+    banExpires: z.string().datetime().nullable(),
+    createdAt: z.string().datetime(),
+    updatedAt: z.string().datetime(),
+    profile: SuperadminUserProfileSchema,
+    teams: z.array(SuperadminUserTeamSchema),
+});
+export const superadminUserListQuerySchema = z.object({
+    limit: z.coerce.number().int().min(1).max(100).default(25),
+    offset: z.coerce.number().int().min(0).default(0),
+    search: z.string().trim().optional(),
+});
+export const SuperadminUserListSchema = makeOffsetListSchema("users", SuperadminUserSchema, superadminPaginationSchema);
+export const superadminUserRoleUpdateSchema = z.object({
+    role: z.union([z.string().min(1), z.array(z.string().min(1)).min(1)]),
+});
+export const superadminUserBanSchema = z.object({
+    banReason: z.string().trim().optional(),
+    banExpiresInSeconds: z.number().int().positive().optional(),
+});
+export const superadminBuildInventoryQuerySchema = z.object({
+    status: z.union([z.literal("all"), buildStatus]).default("all"),
+    driver: z.enum(["all", "e2b", "local"]).default("all"),
+    repository: z.string().trim().optional(),
+});
+export const SuperadminBuildInventoryItemSchema = z.object({
+    id: z.string(),
+    ref: z.string(),
+    status: z.string(),
+    spaceId: z.string(),
+    spaceSlug: z.string().nullable(),
+    teamId: z.string().nullable(),
+    repository: z.string().nullable(),
+    branch: z.string().nullable(),
+    pullRequestNumber: z.number().int().positive().nullable(),
+    commitSha: z.string().nullable(),
+    driver: z.string().nullable(),
+    sandboxId: z.string().nullable(),
+    runnerJobId: z.string().nullable(),
+    region: z.string().nullable(),
+    executionMetadataKeys: z.array(z.string()),
+    e2bTemplateId: z.string().nullable(),
+    failureCode: z.string().nullable(),
+    failureMessage: z.string().nullable(),
+    durationMs: z.number().nullable(),
+    outputBytes: z.number().nullable(),
+    updatedAt: z.string().datetime(),
+});
+export const SuperadminWebhookDeliverySchema = z.object({
+    id: z.string(),
+    deliveryId: z.string(),
+    eventName: z.string(),
+    action: z.string().nullable(),
+    repositoryFullName: z.string().nullable(),
+    status: z.string(),
+    statusMessage: z.string().nullable(),
+    createdAt: z.string().datetime(),
+    updatedAt: z.string().datetime(),
+});
+export const SuperadminBuildInventorySchema = z.object({
+    builds: z.array(SuperadminBuildInventoryItemSchema),
+    webhookDeliveries: z.array(SuperadminWebhookDeliverySchema),
+});
+// Superadmin-assigned subscriptions ("plan grants"): operator-issued plan
+// entitlements with no payment provider and no transactions behind them.
+export const superadminPlanGrantCreateSchema = z.object({
+    team: z.string().trim().min(1).describe("Team id or slug."),
+    plan: z.enum(["personal", "work", "enterprise", "internal"]),
+    note: z.string().trim().max(500).optional(),
+    /** Omit for a non-expiring grant. */
+    expiresAt: z.string().datetime().optional(),
+});
+export const SuperadminPlanGrantSchema = z.object({
+    id: z.string(),
+    teamId: z.string(),
+    teamSlug: z.string().nullable(),
+    teamName: z.string().nullable(),
+    planCode: z.string(),
+    note: z.string().nullable(),
+    grantedBy: z.string(),
+    expiresAt: z.string().datetime().nullable(),
+    revokedAt: z.string().datetime().nullable(),
+    revokedBy: z.string().nullable(),
+    active: z.boolean(),
+    createdAt: z.string().datetime(),
+});
+export const superadminPlanGrantListQuerySchema = z.object({
+    limit: z.coerce.number().int().min(1).max(100).default(25),
+    offset: z.coerce.number().int().min(0).default(0),
+    team: z.string().trim().optional().describe("Filter by team id or slug."),
+    includeInactive: z.coerce.boolean().default(false),
+});
+export const SuperadminPlanGrantListSchema = makeOffsetListSchema("grants", SuperadminPlanGrantSchema, superadminPaginationSchema);
+// Entitlement add-ons: extra seats / storage / domain groups on top of the
+// plan. Operator-assigned ones carry no payment; Stripe-paid ones land in the
+// same ledger via webhook sync.
+export const superadminAddonCreateSchema = z.object({
+    team: z.string().trim().min(1).describe("Team id or slug."),
+    limit: z.enum(["teamMembers", "subTeams", "storageBytes", "externalDomainGroups"]),
+    amount: z.number().int().positive().describe("Additive amount (seats count, bytes, ...)."),
+    note: z.string().trim().max(500).optional(),
+    expiresAt: z.string().datetime().optional(),
+});
+export const SuperadminAddonSchema = z.object({
+    id: z.string(),
+    teamId: z.string(),
+    teamSlug: z.string().nullable(),
+    teamName: z.string().nullable(),
+    limitKey: z.string(),
+    amount: z.number(),
+    quantity: z.number().int(),
+    source: z.enum(["grant", "stripe"]),
+    reference: z.string().nullable(),
+    note: z.string().nullable(),
+    grantedBy: z.string().nullable(),
+    expiresAt: z.string().datetime().nullable(),
+    revokedAt: z.string().datetime().nullable(),
+    active: z.boolean(),
+    createdAt: z.string().datetime(),
+});
+export const superadminAddonListQuerySchema = z.object({
+    limit: z.coerce.number().int().min(1).max(100).default(25),
+    offset: z.coerce.number().int().min(0).default(0),
+    team: z.string().trim().optional(),
+    includeInactive: z.coerce.boolean().default(false),
+});
+export const SuperadminAddonListSchema = makeOffsetListSchema("addons", SuperadminAddonSchema, superadminPaginationSchema);
+// Transaction ledger rows: actual paid amounts in micros of `currency`,
+// negative for refunds, with provider discount identifiers verbatim.
+export const SuperadminBillingTransactionSchema = z.object({
+    id: z.string(),
+    teamId: z.string().nullable(),
+    teamSlug: z.string().nullable(),
+    teamName: z.string().nullable(),
+    provider: z.enum(["stripe", "app_store", "google_play"]),
+    kind: z.enum(["purchase", "renewal", "refund", "adjustment"]),
+    scope: z.enum(["plan", "seats", "domain", "other"]),
+    planCode: z.string().nullable(),
+    productId: z.string().nullable(),
+    providerReference: z.string(),
+    amountMicros: z.number().nullable(),
+    currency: z.string().nullable(),
+    offerId: z.string().nullable(),
+    offerType: z.string().nullable(),
+    discountAmountMicros: z.number().nullable(),
+    occurredAt: z.string().datetime().nullable(),
+    createdAt: z.string().datetime(),
+});
+export const superadminBillingTransactionListQuerySchema = z.object({
+    limit: z.coerce.number().int().min(1).max(100).default(25),
+    offset: z.coerce.number().int().min(0).default(0),
+    team: z.string().trim().optional(),
+});
+export const SuperadminBillingTransactionListSchema = makeOffsetListSchema("transactions", SuperadminBillingTransactionSchema, superadminPaginationSchema);
+export const SuperadminTeamBillingOverviewSchema = z.object({
+    team: z.object({
+        id: z.string(),
+        slug: z.string(),
+        name: z.string(),
+    }),
+    planCode: z.string(),
+    sources: z.array(z.object({
+        provider: z.enum(["stripe", "app_store", "google_play", "grant"]),
+        planCode: z.string(),
+        active: z.boolean(),
+        detail: z.string(),
+        expiresAt: z.string().datetime().nullable(),
+    })),
+    cacheNote: z.string(),
+});
+export const SuperadminWpCloudSiteSchema = z.object({
+    providerSiteId: z.string(),
+    placementId: z.string().nullable(),
+    placementKind: z.enum(["anonymous_pool", "shared_org", "dedicated_space"]).nullable(),
+    placementState: z.string().nullable().optional(),
+    placementStatus: z.string().nullable().optional(),
+    placementPrimaryHostname: z.string().nullable(),
+    placementDatacenterId: z.string().nullable().optional(),
+    placementRegion: z.string().nullable().optional(),
+    placementGeoAffinity: z.string().nullable(),
+    anonymousPoolId: z.string().nullable(),
+    anonymousPoolState: z.enum(["active", "draining", "disabled"]).nullable(),
+    anonymousPoolAssignedSpaceCount: z.number().int().nonnegative().nullable(),
+    assignedSpaceCount: z.number().int().nonnegative(),
+    assignedSpaces: z.array(z.object({
+        id: z.string(),
+        title: z.string(),
+        slug: z.string(),
+        status: z.string(),
+        teamId: z.string().nullable(),
+        teamSlug: z.string().nullable(),
+        teamName: z.string().nullable(),
+        liveHostname: z.string().nullable(),
+    })),
+    domainName: z.string().nullable(),
+    createdAt: z.string().nullable(),
+    spaceUsed: z.number().nullable(),
+    orphaned: z.boolean(),
+    routingStatus: z.enum([
+        "in_sync",
+        "assigned_missing_meta",
+        "assigned_out_of_sync",
+        "foreign_environment",
+        "orphaned_stale_meta",
+        "provider_orphaned",
+    ]),
+    needsAttention: z.boolean(),
+    issueCount: z.number().int().nonnegative(),
+    localTargetId: z.string().nullable(),
+    localTargetState: z.string().nullable(),
+    localPrimaryHostname: z.string().nullable(),
+    spaceId: z.string().nullable(),
+    spaceSlug: z.string().nullable(),
+    spaceTitle: z.string().nullable(),
+    spaceState: z.string().nullable(),
+    teamId: z.string().nullable(),
+    teamSlug: z.string().nullable(),
+    teamName: z.string().nullable(),
+    metaTargetId: z.string().nullable(),
+    metaSlug: z.string().nullable(),
+    metaTitle: z.string().nullable(),
+    metaPrimaryHostname: z.string().nullable(),
+    metaEnvironment: z.string().nullable(),
+    metaControlPlaneUrl: z.string().nullable(),
+    metaProviderClientName: z.string().nullable(),
+});
+export const SuperadminWpCloudSiteListSchema = z.object({
+    sites: z.array(SuperadminWpCloudSiteSchema),
+    pagination: superadminPaginationSchema,
+});
+export const SuperadminAnonymousPoolSchema = z.object({
+    id: z.string(),
+    providerSiteId: z.string(),
+    datacenterId: z.string(),
+    geoAffinity: z.string().nullable(),
+    state: z.enum(["active", "draining", "disabled"]),
+    assignedSpaceCount: z.number().int().nonnegative(),
+    createdAt: z.string(),
+    updatedAt: z.string(),
+    placementId: z.string().nullable(),
+    placementState: z.string().nullable(),
+    primaryHostname: z.string().nullable(),
+    providerDomainName: z.string().nullable(),
+    providerCreatedAt: z.string().nullable(),
+    providerSpaceUsed: z.number().nullable(),
+    providerPresent: z.boolean(),
+});
+export const SuperadminAnonymousPoolSummarySchema = z.object({
+    totalPools: z.number().int().nonnegative(),
+    activePools: z.number().int().nonnegative(),
+    drainingPools: z.number().int().nonnegative(),
+    disabledPools: z.number().int().nonnegative(),
+    missingPlacements: z.number().int().nonnegative(),
+    missingProviderSites: z.number().int().nonnegative(),
+    assignedSpaces: z.number().int().nonnegative(),
+});
+export const SuperadminAnonymousPoolListSchema = z.object({
+    pools: z.array(SuperadminAnonymousPoolSchema),
+    summary: SuperadminAnonymousPoolSummarySchema,
+});
+export const superadminWpCloudAssignSchema = z.object({
+    spaceId: z.string().min(1),
+});