@spacefast/common 0.0.26 → 0.2.2

package/dist/contracts/beta.js

@@ -1,13 +1,11 @@
 import { z } from "zod";
 import { makeOffsetListSchema } from "./common.js";
 import { superadminPaginationSchema } from "./superadmin.js";
-// Private-beta enrollment contracts.
 // Two invite systems coexist: `stattic_beta_signups` (this file) is the public
-// waitlist, while `stattic_auth_invitation` stays team-membership-only — the
+// waitlist, while `stattic_auth_invitation` stays team-membership-only. The
 // two share no rows, routes, or email templates.
-// `stattic_beta_signups` state machine: pending → invited → enrolled.
-// `pending → enrolled` is possible — a team grant path can enroll the user
-// before any invite was sent; the enrolling code back-fills the matching row.
+// State machine: pending → invited → enrolled. A team grant can enroll a user
+// before any invite was sent, back-filling the matching row.
 export const betaSignupStatusValues = ["pending", "invited", "enrolled"];
 export const betaSignupStatusSchema = z
     .enum(betaSignupStatusValues)
@@ -27,9 +25,8 @@ export const betaEligibleTeamSourceValues = [
 export const betaEligibleTeamSourceSchema = z
     .enum(betaEligibleTeamSourceValues)
     .describe("Why the team is joinable by the caller.");
-// `POST /v1/beta/signups` (public). `website` is a honeypot: real browsers
-// leave it empty, and the route accepts and drops it silently either way —
-// never a validation error that would tip off bots.
+// `POST /v1/beta/signups` (public). `website` is a honeypot: the route accepts
+// and silently drops it, never erroring in a way that would tip off bots.
 export const betaSignupCreateSchema = z.object({
     email: z
         .string()
@@ -40,13 +37,22 @@ export const betaSignupCreateSchema = z.object({
         .describe("Address to put on the waitlist."),
     website: z.string().optional().describe("Honeypot field; leave empty."),
 });
-// Always the same generic body — duplicates included — so the public endpoint
+// Always the same generic body, duplicates included, so the public endpoint
 // cannot be used to enumerate the waitlist.
 export const betaSignupReceiptSchema = z.object({
     ok: z.literal(true).describe("Generic acknowledgement; identical for every outcome."),
 });
+export const betaVisitorResponseSchema = z.object({
+    earlyAccessGranted: z
+        .boolean()
+        .describe("Whether the account or trusted network grants early access."),
+    source: z
+        .enum(["account", "network"])
+        .nullable()
+        .describe("The access source, or null when early access is not granted."),
+});
 // `POST /v1/beta/accept` (authed): binds the invite token's signup row to the
-// calling account and enrolls it. Idempotent — an already-enrolled caller
+// calling account and enrolls it. Idempotent: an already-enrolled caller
 // still binds the row and gets a 200.
 export const betaAcceptSchema = z.object({
     token: z.string().trim().min(1).max(255).describe("Raw invite token from the email link."),
@@ -55,9 +61,8 @@ export const betaAcceptResponseSchema = z.object({
     enrolled: z.literal(true).describe("The calling account is enrolled in the private beta."),
 });
 // Team auto-enroll entries (`GET/POST/DELETE /v1/teams/{teamId}/auto-enroll`).
-// A match grants beta enrollment but NOT team membership — the user gets a
-// picker. Values are normalized before storage: domains IDNA-canonicalized to
-// ASCII.
+// A match grants beta enrollment but NOT team membership; the user gets a
+// picker. Domains are IDNA-canonicalized to ASCII before storage.
 export const teamAutoEnrollEntrySchema = z.object({
     id: z.string().describe("Auto-enroll entry id."),
     teamId: z.string().describe("Team the entry belongs to."),
@@ -84,14 +89,13 @@ export const SuperadminBetaSignupSchema = z.object({
     id: z.string(),
     email: z.string().email(),
     status: betaSignupStatusSchema,
-    isAutomattician: z.boolean(),
-    wpcom: z.boolean(),
+    automatticDomain: z.boolean(),
     invitedAt: z.string().datetime().nullable(),
     tokenExpiresAt: z.string().datetime().nullable(),
     invitedBy: z
         .string()
         .nullable()
-        .describe("Inviting operator user id; null when auto-approved (Automattician signup)."),
+        .describe("Inviting operator user id; null when an Automattic-domain signup is auto-approved."),
     enrolledUserId: z.string().nullable(),
     createdAt: z.string().datetime(),
 });

package/dist/contracts/billing.js

@@ -1,8 +1,7 @@
 import { z } from "zod";
 import { planCodeSchema, planLimitValueSchema } from "./features.js";
-// Billing providers a team plan can resolve from. `grant` is a
-// superadmin-assigned subscription: no payment, no transactions, just an
-// operator-issued entitlement row (optionally expiring).
+// Billing providers a team plan can resolve from. `grant` is a superadmin-issued
+// entitlement row, optionally expiring: no payment, no transactions.
 export const billingProviderValues = ["stripe", "grant"];
 export const billingProviderSchema = z.enum(billingProviderValues).describe("Billing provider.");
 export const billingIntervalValues = ["monthly", "yearly"];
@@ -37,10 +36,9 @@ export const stripeSyncEventTypes = [
     "charge.dispute.funds_withdrawn",
     "charge.dispute.funds_reinstated",
 ];
-// Transaction ledger vocabulary. Every REAL payment event lands as one row —
-// operator grants never do (no transactions by definition). Amounts are
-// micros of the payment currency (1_000_000 micros = 1 unit) so Stripe cents
-// normalize losslessly.
+// Transaction ledger vocabulary. Every REAL payment event lands as one row;
+// operator grants never do. Amounts are micros of the payment currency
+// (1_000_000 micros = 1 unit), so Stripe cents normalize losslessly.
 export const billingTransactionKindValues = [
     "purchase",
     "renewal",
@@ -52,8 +50,7 @@ export const billingTransactionKindSchema = z.enum(billingTransactionKindValues)
 export const billingTransactionScopeValues = ["plan", "seats", "domain", "other"];
 export const billingTransactionScopeSchema = z.enum(billingTransactionScopeValues);
 // Add-on entitlements (extra seats, extra storage): additive limit bumps that
-// ride the EntitlementGrant seam. `grant` source = operator-assigned, no
-// payment; `stripe` source = paid add-on synced from a Stripe subscription item.
+// ride the EntitlementGrant seam. `stripe` add-ons sync from a subscription item.
 export const billingAddonSourceValues = ["grant", "stripe"];
 export const billingAddonLimitKeyValues = [
     "teamMembers",
@@ -62,8 +59,7 @@ export const billingAddonLimitKeyValues = [
     "externalDomainGroups",
 ];
 export const billingAddonLimitKeySchema = z.enum(billingAddonLimitKeyValues);
-// One active-plan source as surfaced to operators and the team billing page:
-// where a plan claim comes from and whether it is currently effective.
+// One active-plan source, as operators and the team billing page see it.
 export const billingPlanSourceSchema = z.object({
     provider: billingProviderSchema,
     planCode: planCodeSchema,