@pithy-sh/core 0.9.0 → 0.11.0

package/src/error/payload.ts

@@ -85,6 +85,54 @@ const InvalidInputPublic = z
   })
   .describe("Input failed validation at a boundary (400).");
 
+const InputRequiredPublic = z
+  .object({
+    code: z
+      .literal("input/required")
+      .describe(
+        "A run that may not prompt reached a question with no answer. `PITHY_NONINTERACTIVE=1`, `--no-input` and `--json` each forbid a prompt; this is what one turns into, so an agent is told what to pass rather than left waiting on a question nobody will answer.",
+      ),
+    status: z.literal(400).describe("Bad Request — the call left out something it has to say."),
+    flag: z
+      .string()
+      .nullable()
+      .describe(
+        "The flag that answers the question, as it is typed (`--worker`). `null` when no flag can: only a person, or a document piped to stdin, answers it.",
+      ),
+    choices: z
+      .array(z.string().describe("One value the flag takes."))
+      .optional()
+      .describe("Every value the flag takes, when the set is known. Absent when it is open, such as a name."),
+    ...publicFields,
+  })
+  .describe("A run that may not prompt needed an answer it was not given (400).");
+
+const PreconditionFailedPublic = z
+  .object({
+    code: z
+      .literal("core/precondition_failed")
+      .describe(
+        "The call is well formed, and the state it needs is not there yet: no credentials, an environment that is not provisioned, a resource nothing has created. Distinct from `validation/invalid_input` because the remedy is a different step run first, not a different call.",
+      ),
+    status: z.literal(412).describe("Precondition Failed — the request is valid, and what it depends on is missing."),
+    ...publicFields,
+  })
+  .describe("The state this request depends on is not there yet (412).");
+
+const PersonRequiredPublic = z
+  .object({
+    code: z
+      .literal("core/person_required")
+      .describe(
+        "The step is one only a person may take: a typed confirmation phrase, or a command that is manual by design. Distinct from `input/required` because no flag value an automated caller could choose is the right answer — the right move is to stop and ask.",
+      ),
+    status: z
+      .literal(403)
+      .describe("Forbidden — the caller may not take this step for a person, however the call is phrased."),
+    ...publicFields,
+  })
+  .describe("A step only a person may take (403).");
+
 const InvalidTokenPublic = z
   .object({
     code: z.literal("auth/invalid_token").describe("The bearer/session credential is missing, expired, or invalid."),
@@ -453,6 +501,28 @@ const TurnstileConfigPublic = z
   })
   .describe("The Turnstile middleware is misconfigured (500).");
 
+const TurnstileAnalyticsWindowPublic = z
+  .object({
+    code: z
+      .literal("turnstile/analytics_window")
+      .describe(
+        "The requested challenge window reaches past what Cloudflare keeps, or is wider than one read may ask for.",
+      ),
+    status: z.literal(400).describe("Bad Request — narrow the window or move it later."),
+    ...publicFields,
+  })
+  .describe("A Turnstile-analytics window outside Cloudflare's retention or range (400).");
+
+const TurnstileAnalyticsUnavailablePublic = z
+  .object({
+    code: z
+      .literal("turnstile/analytics_unavailable")
+      .describe("Cloudflare does not serve Turnstile analytics to this account, so no outcome can be read."),
+    status: z.literal(409).describe("Conflict — the account's configuration rules the read out."),
+    ...publicFields,
+  })
+  .describe("Turnstile analytics are not served to this account (409).");
+
 // --- @pithy-sh/audit: audit-trail recorder codes ---
 
 const AuditInvalidEventPublic = z
@@ -487,6 +557,18 @@ const MediaNotFoundPublic = z
   })
   .describe("A requested media record does not exist (404).");
 
+const MediaForbiddenPublic = z
+  .object({
+    code: z
+      .literal("media/forbidden")
+      .describe(
+        "The caller may read the media record but not change it: only its owner, acting for the record's organization, or a role holding `media:manage` there may edit, delete or re-scope it.",
+      ),
+    status: z.literal(403).describe("Forbidden."),
+    ...publicFields,
+  })
+  .describe("The caller may read the record but not change it (403).");
+
 const MediaUnsupportedPublic = z
   .object({
     code: z
@@ -517,6 +599,30 @@ const MediaEnrichmentFailedPublic = z
   })
   .describe("A media AI-enrichment step failed (500).");
 
+const MediaAnalyticsWindowPublic = z
+  .object({
+    code: z
+      .literal("media/analytics_window")
+      .describe(
+        "The requested delivery window reaches past what Cloudflare keeps, or is wider than one read may ask for.",
+      ),
+    status: z.literal(400).describe("Bad Request — narrow the window or move it later."),
+    ...publicFields,
+  })
+  .describe("A delivery-analytics window outside Cloudflare's retention or range (400).");
+
+const MediaAnalyticsUnavailablePublic = z
+  .object({
+    code: z
+      .literal("media/analytics_unavailable")
+      .describe(
+        "Cloudflare does not serve the delivery analytics this read needs to this account — a Customer Metadata Boundary outside the US carries none of them.",
+      ),
+    status: z.literal(409).describe("Conflict — the account's configuration rules the read out."),
+    ...publicFields,
+  })
+  .describe("Delivery analytics are not served to this account (409).");
+
 // --- @pithy-sh/leaderboard: optional ranking capability codes ---
 
 const LeaderboardBoardNotFoundPublic = z
@@ -883,7 +989,7 @@ const StorageNotFoundPublic = z
   .object({
     code: z
       .literal("storage/not_found")
-      .describe("No object row matches, or the object exists but is not visible to this caller."),
+      .describe("No object row matches, or the object exists but this caller may not read it."),
     status: z.literal(404).describe("Not Found."),
     ...publicFields,
   })
@@ -891,18 +997,22 @@ const StorageNotFoundPublic = z
 
 const StorageForbiddenPublic = z
   .object({
-    code: z.literal("storage/forbidden").describe("The caller does not own the object and the object is not public."),
+    code: z
+      .literal("storage/forbidden")
+      .describe(
+        "The caller may read the object but not change it: only its owner, acting for the object's organization, or a role holding `storage:manage` there may.",
+      ),
     status: z.literal(403).describe("Forbidden."),
     ...publicFields,
   })
-  .describe("The caller is not the owner and the object is not public (403).");
+  .describe("The caller may read the object but not change it (403).");
 
 const StorageQuotaExceededPublic = z
   .object({
     code: z
       .literal("storage/quota_exceeded")
       .describe(
-        "The declared upload size would push the owner past their byte quota. Checked at init against pending and stored rows together, so concurrent inits cannot race past the limit.",
+        "The declared upload size would push the owner past the configured `bytesPerOwner` quota. Checked at init against pending and stored rows together, so concurrent inits cannot race past the limit. Where the `storageBytes` meter is enforced, the same refusal is `payments/quota_exceeded` (402).",
       ),
     status: z.literal(413).describe("Content Too Large."),
     ...publicFields,
@@ -1209,6 +1319,30 @@ const PaymentsSubscriptionChangeRefusedPublic = z
   })
   .describe("A subscription's state forbids the change asked of it (409).");
 
+const PaymentsOverrideStalePublic = z
+  .object({
+    code: z
+      .literal("payments/override_stale")
+      .describe(
+        "A control-plane override write named a version behind the subject's override row. Two operators share one customer: both opened the same allowance, and the second would silently overwrite the first while the first believed they had succeeded. So the write is refused and nothing is written. 409, because the request is well-formed and the same request against the version it now holds would be accepted — the caller re-reads, and tries again.",
+      ),
+    status: z.literal(409).describe("Conflict — the override changed since the caller read it."),
+    ...publicFields,
+  })
+  .describe("An override write named a stale version (409).");
+
+const PaymentsQuotaExceededPublic = z
+  .object({
+    code: z
+      .literal("payments/quota_exceeded")
+      .describe(
+        "An enforced kit meter — emails enqueued, bytes stored, media items held — would pass the subject's effective quota for the period. Nothing was written. 402 Payment Required, because it is the honest status: the plan does not allow more and the remedy is a purchase, a bigger tier, or a number pinned for this subject from the control plane. A meter refuses and never bills — the kit does not sell overage.",
+      ),
+    status: z.literal(402).describe("Payment Required — the plan's allowance for this period is used up."),
+    ...publicFields,
+  })
+  .describe("An enforced meter is at its quota for this period (402).");
+
 // --- @pithy-sh/core: the `control-plane` verification strategy ---
 //
 // NOT Cloudflare's control plane. Everywhere else in this repo "control plane" means the Cloudflare
@@ -1359,6 +1493,68 @@ const OrganizationNominationInvalidPublic = z
   })
   .describe("No standing ownership offer this caller may accept (400).");
 
+// --- @pithy-sh/artifacts: Git repositories, ownership, grants and short-lived tokens ---
+
+const ArtifactsNotFoundPublic = z
+  .object({
+    code: z
+      .literal("artifacts/not_found")
+      .describe(
+        "No such repository, **or** one the caller holds no grant on and does not own. One code for both, byte for byte: a repository's name is in its clone URL, and a refusal that told the two apart would hand it over. Also what the credential route answers for a repository with remote access off. Which it was survives in `detail`, which the HTTP codec strips.",
+      ),
+    status: z.literal(404).describe("Not Found."),
+    ...publicFields,
+  })
+  .describe("No such repository, or none this caller may see — the same answer for both (404).");
+
+const ArtifactsForbiddenPublic = z
+  .object({
+    code: z
+      .literal("artifacts/forbidden")
+      .describe(
+        "The caller can see the repository and may not do this to it: a grant holder asking for what only an owner may do, or a member of an organization whose role lacks the configured `managePower`. A 403 rather than the 404 above, because by then the caller already knows the repository exists.",
+      ),
+    status: z.literal(403).describe("Forbidden."),
+    ...publicFields,
+  })
+  .describe("The caller may see this repository and may not do this (403).");
+
+const ArtifactsInvalidNamePublic = z
+  .object({
+    code: z
+      .literal("artifacts/invalid_name")
+      .describe(
+        "A supplied repository name is outside Cloudflare's charset or the 2-to-63 cap. Refused and never shortened: a name somebody chose is in every clone URL, and a silently different one is a repository nobody can find.",
+      ),
+    status: z.literal(400).describe("Bad Request."),
+    ...publicFields,
+  })
+  .describe("A repository name breaks the naming rule (400).");
+
+const ArtifactsNameTakenPublic = z
+  .object({
+    code: z
+      .literal("artifacts/name_taken")
+      .describe(
+        "The owner already holds a repository with that display name, or a supplied physical name is already in the namespace. The second happens only where the adopter supplies names, so uniqueness is theirs.",
+      ),
+    status: z.literal(409).describe("Conflict."),
+    ...publicFields,
+  })
+  .describe("That repository name is already in use (409).");
+
+const ArtifactsInvalidConfigPublic = z
+  .object({
+    code: z
+      .literal("artifacts/invalid_config")
+      .describe(
+        "The capability's configuration cannot be honored: a `tokenTtlSeconds` above the ceiling, or `organization` composed with no `managePower` named. Raised at boot, so a mistake fails on deploy rather than at the first mint.",
+      ),
+    status: z.literal(400).describe("Bad Request — the configuration is malformed."),
+    ...publicFields,
+  })
+  .describe("The artifacts configuration is invalid (400).");
+
 // --- @pithy-sh/support: inbound inbox, taxonomy, and classification codes ---
 
 const SupportNotFoundPublic = z
@@ -1555,6 +1751,9 @@ const TestersNotConfiguredPublic = z
 export const KitPublicErrorPayload = z
   .discriminatedUnion("code", [
     InvalidInputPublic,
+    InputRequiredPublic,
+    PreconditionFailedPublic,
+    PersonRequiredPublic,
     InvalidTokenPublic,
     ForbiddenPublic,
     AuthProviderUnavailablePublic,
@@ -1588,12 +1787,17 @@ export const KitPublicErrorPayload = z
     TurnstileMissingTokenPublic,
     TurnstileFailedPublic,
     TurnstileConfigPublic,
+    TurnstileAnalyticsWindowPublic,
+    TurnstileAnalyticsUnavailablePublic,
     AuditInvalidEventPublic,
     AuditWriteFailedPublic,
     MediaNotFoundPublic,
+    MediaForbiddenPublic,
     MediaUnsupportedPublic,
     MediaStorageFailedPublic,
     MediaEnrichmentFailedPublic,
+    MediaAnalyticsWindowPublic,
+    MediaAnalyticsUnavailablePublic,
     LeaderboardBoardNotFoundPublic,
     LeaderboardEntryNotFoundPublic,
     LeaderboardScoreRejectedPublic,
@@ -1656,6 +1860,8 @@ export const KitPublicErrorPayload = z
     PaymentsEntitlementNotInCatalogPublic,
     PaymentsSubjectUnresolvedPublic,
     PaymentsSubscriptionChangeRefusedPublic,
+    PaymentsOverrideStalePublic,
+    PaymentsQuotaExceededPublic,
     ControlPlaneNotConnectedPublic,
     ControlPlaneInvalidCredentialPublic,
     ControlPlaneInsufficientScopePublic,
@@ -1668,6 +1874,11 @@ export const KitPublicErrorPayload = z
     OrganizationLastAdministratorPublic,
     OrganizationSlugTakenPublic,
     OrganizationNominationInvalidPublic,
+    ArtifactsNotFoundPublic,
+    ArtifactsForbiddenPublic,
+    ArtifactsInvalidNamePublic,
+    ArtifactsNameTakenPublic,
+    ArtifactsInvalidConfigPublic,
     SupportNotFoundPublic,
     SupportInvalidCategoryPublic,
     SupportUnparseableMessagePublic,
@@ -1690,6 +1901,11 @@ export const KitPublicErrorPayload = z
 // The full members: each public member plus the operator-only `action` and `detail`. Built as explicit consts
 // (not mapped) so the `code`-literal discriminated-union types survive for `Extract` narrowing.
 const InvalidInput = InvalidInputPublic.extend(internalFields).describe(InvalidInputPublic.description ?? "");
+const InputRequired = InputRequiredPublic.extend(internalFields).describe(InputRequiredPublic.description ?? "");
+const PreconditionFailed = PreconditionFailedPublic.extend(internalFields).describe(
+  PreconditionFailedPublic.description ?? "",
+);
+const PersonRequired = PersonRequiredPublic.extend(internalFields).describe(PersonRequiredPublic.description ?? "");
 const InvalidToken = InvalidTokenPublic.extend(internalFields).describe(InvalidTokenPublic.description ?? "");
 const Forbidden = ForbiddenPublic.extend(internalFields).describe(ForbiddenPublic.description ?? "");
 const AuthProviderUnavailable = AuthProviderUnavailablePublic.extend(internalFields).describe(
@@ -1759,6 +1975,12 @@ const TurnstileMissingToken = TurnstileMissingTokenPublic.extend(internalFields)
 );
 const TurnstileFailed = TurnstileFailedPublic.extend(internalFields).describe(TurnstileFailedPublic.description ?? "");
 const TurnstileConfig = TurnstileConfigPublic.extend(internalFields).describe(TurnstileConfigPublic.description ?? "");
+const TurnstileAnalyticsWindow = TurnstileAnalyticsWindowPublic.extend(internalFields).describe(
+  TurnstileAnalyticsWindowPublic.description ?? "",
+);
+const TurnstileAnalyticsUnavailable = TurnstileAnalyticsUnavailablePublic.extend(internalFields).describe(
+  TurnstileAnalyticsUnavailablePublic.description ?? "",
+);
 const AuditInvalidEvent = AuditInvalidEventPublic.extend(internalFields).describe(
   AuditInvalidEventPublic.description ?? "",
 );
@@ -1766,6 +1988,7 @@ const AuditWriteFailed = AuditWriteFailedPublic.extend(internalFields).describe(
   AuditWriteFailedPublic.description ?? "",
 );
 const MediaNotFound = MediaNotFoundPublic.extend(internalFields).describe(MediaNotFoundPublic.description ?? "");
+const MediaForbidden = MediaForbiddenPublic.extend(internalFields).describe(MediaForbiddenPublic.description ?? "");
 const MediaUnsupported = MediaUnsupportedPublic.extend(internalFields).describe(
   MediaUnsupportedPublic.description ?? "",
 );
@@ -1775,6 +1998,12 @@ const MediaStorageFailed = MediaStorageFailedPublic.extend(internalFields).descr
 const MediaEnrichmentFailed = MediaEnrichmentFailedPublic.extend(internalFields).describe(
   MediaEnrichmentFailedPublic.description ?? "",
 );
+const MediaAnalyticsWindow = MediaAnalyticsWindowPublic.extend(internalFields).describe(
+  MediaAnalyticsWindowPublic.description ?? "",
+);
+const MediaAnalyticsUnavailable = MediaAnalyticsUnavailablePublic.extend(internalFields).describe(
+  MediaAnalyticsUnavailablePublic.description ?? "",
+);
 const LeaderboardBoardNotFound = LeaderboardBoardNotFoundPublic.extend(internalFields).describe(
   LeaderboardBoardNotFoundPublic.description ?? "",
 );
@@ -1960,6 +2189,12 @@ const PaymentsSubjectUnresolved = PaymentsSubjectUnresolvedPublic.extend(interna
 const PaymentsSubscriptionChangeRefused = PaymentsSubscriptionChangeRefusedPublic.extend(internalFields).describe(
   PaymentsSubscriptionChangeRefusedPublic.description ?? "",
 );
+const PaymentsOverrideStale = PaymentsOverrideStalePublic.extend(internalFields).describe(
+  PaymentsOverrideStalePublic.description ?? "",
+);
+const PaymentsQuotaExceeded = PaymentsQuotaExceededPublic.extend(internalFields).describe(
+  PaymentsQuotaExceededPublic.description ?? "",
+);
 const ControlPlaneNotConnected = ControlPlaneNotConnectedPublic.extend(internalFields).describe(
   ControlPlaneNotConnectedPublic.description ?? "",
 );
@@ -2030,6 +2265,22 @@ const OrganizationNominationInvalid = OrganizationNominationInvalidPublic.extend
   OrganizationNominationInvalidPublic.description ?? "",
 );
 
+const ArtifactsNotFound = ArtifactsNotFoundPublic.extend(internalFields).describe(
+  ArtifactsNotFoundPublic.description ?? "",
+);
+const ArtifactsForbidden = ArtifactsForbiddenPublic.extend(internalFields).describe(
+  ArtifactsForbiddenPublic.description ?? "",
+);
+const ArtifactsInvalidName = ArtifactsInvalidNamePublic.extend(internalFields).describe(
+  ArtifactsInvalidNamePublic.description ?? "",
+);
+const ArtifactsNameTaken = ArtifactsNameTakenPublic.extend(internalFields).describe(
+  ArtifactsNameTakenPublic.description ?? "",
+);
+const ArtifactsInvalidConfig = ArtifactsInvalidConfigPublic.extend(internalFields).describe(
+  ArtifactsInvalidConfigPublic.description ?? "",
+);
+
 const SupportNotFound = SupportNotFoundPublic.extend(internalFields).describe(SupportNotFoundPublic.description ?? "");
 const SupportInvalidCategory = SupportInvalidCategoryPublic.extend(internalFields).describe(
   SupportInvalidCategoryPublic.description ?? "",
@@ -2053,6 +2304,9 @@ const SupportReplyFailed = SupportReplyFailedPublic.extend(internalFields).descr
 export const KitErrorPayload = z
   .discriminatedUnion("code", [
     InvalidInput,
+    InputRequired,
+    PreconditionFailed,
+    PersonRequired,
     InvalidToken,
     Forbidden,
     AuthProviderUnavailable,
@@ -2086,12 +2340,17 @@ export const KitErrorPayload = z
     TurnstileMissingToken,
     TurnstileFailed,
     TurnstileConfig,
+    TurnstileAnalyticsWindow,
+    TurnstileAnalyticsUnavailable,
     AuditInvalidEvent,
     AuditWriteFailed,
     MediaNotFound,
+    MediaForbidden,
     MediaUnsupported,
     MediaStorageFailed,
     MediaEnrichmentFailed,
+    MediaAnalyticsWindow,
+    MediaAnalyticsUnavailable,
     LeaderboardBoardNotFound,
     LeaderboardEntryNotFound,
     LeaderboardScoreRejected,
@@ -2154,6 +2413,8 @@ export const KitErrorPayload = z
     PaymentsEntitlementNotInCatalog,
     PaymentsSubjectUnresolved,
     PaymentsSubscriptionChangeRefused,
+    PaymentsOverrideStale,
+    PaymentsQuotaExceeded,
     ControlPlaneNotConnected,
     ControlPlaneInvalidCredential,
     ControlPlaneInsufficientScope,
@@ -2166,6 +2427,11 @@ export const KitErrorPayload = z
     OrganizationLastAdministrator,
     OrganizationSlugTaken,
     OrganizationNominationInvalid,
+    ArtifactsNotFound,
+    ArtifactsForbidden,
+    ArtifactsInvalidName,
+    ArtifactsNameTaken,
+    ArtifactsInvalidConfig,
     SupportNotFound,
     SupportInvalidCategory,
     SupportUnparseableMessage,

package/src/error/pithyError.ts

@@ -61,6 +61,82 @@ export class ValidationError extends PithyError {
   }
 }
 
+/**
+ * A run that may not prompt reached a question nobody gave it the answer to (#697).
+ *
+ * `flag` is the flag that answers it, or `null` when no flag can — a person, or a document on stdin, is
+ * the only answer. `choices` is every value the flag takes when that set is known, and is left off the
+ * payload rather than written empty when it is not: an empty list would claim the flag takes nothing.
+ */
+export class InputRequiredError extends PithyError {
+  declare readonly payload: Extract<ErrorPayload, { code: "input/required" }>;
+
+  constructor(
+    args: ErrorArgs & { flag?: string | null; choices?: readonly string[] } = {},
+    options?: { cause?: unknown },
+  ) {
+    super(
+      {
+        code: "input/required",
+        status: 400,
+        message: args.message ?? "An answer is required, and this run may not ask for it.",
+        action: args.action,
+        detail: args.detail,
+        params: args.params,
+        flag: args.flag ?? null,
+        ...(args.choices === undefined ? {} : { choices: [...args.choices] }),
+      },
+      options,
+    );
+  }
+}
+
+/**
+ * The call is well formed, and what it depends on is not there yet (#697): no credentials, an environment
+ * nothing has provisioned. A separate class from {@link ValidationError} because the remedy is a step to
+ * run first, not a different call — the CLI exits 3 for it and 2 for a validation failure.
+ */
+export class PreconditionFailedError extends PithyError {
+  declare readonly payload: Extract<ErrorPayload, { code: "core/precondition_failed" }>;
+
+  constructor(args: ErrorArgs = {}, options?: { cause?: unknown }) {
+    super(
+      {
+        code: "core/precondition_failed",
+        status: 412,
+        message: args.message ?? "Something this needs is not set up yet.",
+        action: args.action,
+        detail: args.detail,
+        params: args.params,
+      },
+      options,
+    );
+  }
+}
+
+/**
+ * A step only a person may take (#697): a typed confirmation phrase, or a command that is manual by
+ * design. Not {@link InputRequiredError}, which names a flag an automated caller can pass — here no value
+ * a caller could choose is the right answer, and the CLI exits 5 so an agent stops and asks.
+ */
+export class PersonRequiredError extends PithyError {
+  declare readonly payload: Extract<ErrorPayload, { code: "core/person_required" }>;
+
+  constructor(args: ErrorArgs = {}, options?: { cause?: unknown }) {
+    super(
+      {
+        code: "core/person_required",
+        status: 403,
+        message: args.message ?? "Only a person may take this step.",
+        action: args.action,
+        detail: args.detail,
+        params: args.params,
+      },
+      options,
+    );
+  }
+}
+
 export class UnauthorizedError extends PithyError {
   declare readonly payload: Extract<ErrorPayload, { code: "auth/invalid_token" }>;