@shipstatic/ship 2.4.0-beta.1 → 2.6.0-beta.1

package/dist/index.d.cts

@@ -610,15 +610,16 @@ interface Account {
      */
     readonly used?: number | null;
     /**
-     * True while the Stripe subscription's status is `past_due` and Stripe is
+     * True while the Stripe Subscription's status is `past_due` and Stripe is
      * still retrying the card. The plan is unchanged — the account keeps
      * everything it has — so this is a banner, not a gate.
      *
-     * A BOOLEAN rather than the status string: one fact for the console to
-     * act on. Stripe's own status word is mirrored on the account row for the
-     * operator surface.
+     * A BOOLEAN rather than the status string: one fact for the console to act
+     * on. It carries STRIPE'S OWN WORD (`past_due` → `pastDue`) rather than a
+     * synonym, so no reader has to hold a translation; the full status string is
+     * mirrored on the account row for the operator surface.
      */
-    readonly overdue: boolean;
+    readonly pastDue: boolean;
 }
 /**
  * Account as returned by `GET /account` — the entity plus how the request
@@ -1770,13 +1771,20 @@ interface Plan {
     /** Display name, as the marketing site and the console should print it. */
     readonly name: string;
     /**
-     * What it costs. A union rather than a nullable number, so "free" and
-     * "talk to us" are two different answers instead of two readings of the
-     * same `null`. Amounts are integer CENTS in USD, as the API's plan table
-     * states them and as Stripe's Prices are provisioned from it — the wire
-     * never carries a formatted price, because formatting is the reader's job.
+     * What it costs, per interval — integer CENTS in USD, as the API's plan
+     * table states them and as Stripe's Prices are provisioned from it. The wire
+     * never carries a formatted price: formatting is the reader's job.
+     *
+     * **A free plan costs `{ month: 0, year: 0 }`, not a sentinel.** Free IS
+     * zero, so it is a number like any other and every reader formats it with
+     * the same call; a `'free'` member bought one thing — a branch in each
+     * consumer that mapped it straight back to `$0`.
+     *
+     * `'contact'` stays, and the asymmetry is the point: "not sold at a list
+     * price" is genuinely a different KIND of answer, not a different number, so
+     * it is a different shape. Two shapes, and each earns its own.
      */
-    readonly price: 'free' | 'contact' | {
+    readonly price: 'contact' | {
         readonly month: number;
         readonly year: number;
     };
@@ -1800,14 +1808,25 @@ interface PlansResponse {
     readonly plans: readonly Plan[];
 }
 /**
- * A page Stripe hosts — a Checkout Session or a Customer Portal session — the
- * answer of `POST /billing/checkout` and `POST /billing/portal` alike.
+ * The answer of `POST /billing/checkout` — Stripe's `Checkout.Session`,
+ * projected to the one field a client needs.
  *
- * One shape for both because both say the same thing: the platform is not
- * where this happens, go here. There is nothing else to return — the
- * outcome arrives later, as a Stripe webhook.
+ * There is nothing else to return: the outcome arrives later, as a Stripe
+ * webhook. It is its own type rather than a shape shared with
+ * {@link BillingPortalSession} because Stripe has two distinct objects here,
+ * and naming one of them for both would be the reader's translation to make.
+ */
+interface CheckoutSession {
+    /** Absolute URL to redirect the browser to. Single use, short-lived. */
+    readonly url: string;
+}
+/**
+ * The answer of `POST /billing/portal` — Stripe's `BillingPortal.Session`,
+ * projected the same way. Identical in shape to {@link CheckoutSession} and
+ * deliberately not merged with it: they are two Stripe objects, and either may
+ * gain a field the other never has.
  */
-interface StripeSession {
+interface BillingPortalSession {
     /** Absolute URL to redirect the browser to. Single use, short-lived. */
     readonly url: string;
 }
@@ -3008,6 +3027,6 @@ declare class Ship extends Ship$1 {
 }
 
 declare namespace Ship {
-  export { API_KEY, API_PATHS, AUTH_BASE_PATH, Account, AccountDeleteResponse, AccountGetResponse, AccountKeyResponse, AccountPlan, AccountPlanType, AccountResource, Activity, ActivityEvent, ActivityListResponse, ActivityMeta, ApiDeployOptions, ApiHttp, ApiHttpOptions, AuthMethod, AuthMethodType, BillingInterval, BillingSyncResponse, CALLER, Caps, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_FIELDS, DEPLOY_TOKEN, DeployBodyContext, DeployFile, DeployInput, DeployTransport, Deployment, DeploymentCreateResponse, DeploymentDeleteResponse, DeploymentListResponse, DeploymentOptions, DeploymentResource, DeploymentResourceContext, DeploymentSetOptions, DeploymentStatus, DeploymentStatusType, DeploymentUploadOptions, DeploymentVia, DeploymentViaType, DnsLookup, DnsProvider, DnsRecord, DnsRecordType, Domain, DomainDeleteResponse, DomainDnsResponse, DomainListResponse, DomainRecordsResponse, DomainResource, DomainSetOptions, DomainSetResult, DomainShareResponse, DomainStatus, DomainStatusType, DomainValidateResponse, DomainVerifyResponse, ErrorResponse, ErrorType, ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, Fetch, FileValidationResult, FileValidationStatus, FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, LabelsResponse, ListOptions, ListResponse, MD5Result, MY_API_KEY_URL, OAUTH_TOKEN, OAuthScope, OAuthScopeType, PASSWORD_CONSTRAINTS, PUBLIC_DEPLOYMENT_TTL_SECONDS, PingResponse, Plan, PlansResponse, PlatformLimits, RequestResult, ResourceContext, SHIP_ENV, SIGN_IN_RETURN_PARAM, SPACheckDebug, SPACheckRequest, SPACheckResponse, SPA_CHECK_CONSTRAINTS, SPA_DEFAULT_CONFIG, SetupInstructionsResponse, ShipClientOptions, ShipError, ShipEvents, ShipRequestInit, StaticFile, StripeSession, TTL_CONSTRAINTS, Token, TokenCreateOptions, TokenCreateResponse, TokenDeleteResponse, TokenKind, TokenKindType, TokenListResponse, TokenProvider, TokenResource, Transport, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, UploadedFile, UserVisibleActivityEvent, ValidatableFile, ValidationIssue, WEB_FILE_ACCEPT, __setTestEnvironment, allValidFilesReady, assertShipJsonSyntax, calculateMD5, classifyToken, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, deserializeLabels, extractSubdomain, filterJunk, formatFileSize, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isCustomDomain, isDeployment, isPlatformDomain, isShipError, normalizeVia, optimizeDeployPaths, pluralize, processFilesForNode, readBearerValue, serializeLabels, validateApiKey, validateApiUrl, validateCaller, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validateOAuthToken, validatePassword, validateToken, validateTtl };
+  export { API_KEY, API_PATHS, AUTH_BASE_PATH, Account, AccountDeleteResponse, AccountGetResponse, AccountKeyResponse, AccountPlan, AccountPlanType, AccountResource, Activity, ActivityEvent, ActivityListResponse, ActivityMeta, ApiDeployOptions, ApiHttp, ApiHttpOptions, AuthMethod, AuthMethodType, BillingInterval, BillingPortalSession, BillingSyncResponse, CALLER, Caps, CheckoutSession, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_FIELDS, DEPLOY_TOKEN, DeployBodyContext, DeployFile, DeployInput, DeployTransport, Deployment, DeploymentCreateResponse, DeploymentDeleteResponse, DeploymentListResponse, DeploymentOptions, DeploymentResource, DeploymentResourceContext, DeploymentSetOptions, DeploymentStatus, DeploymentStatusType, DeploymentUploadOptions, DeploymentVia, DeploymentViaType, DnsLookup, DnsProvider, DnsRecord, DnsRecordType, Domain, DomainDeleteResponse, DomainDnsResponse, DomainListResponse, DomainRecordsResponse, DomainResource, DomainSetOptions, DomainSetResult, DomainShareResponse, DomainStatus, DomainStatusType, DomainValidateResponse, DomainVerifyResponse, ErrorResponse, ErrorType, ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, Fetch, FileValidationResult, FileValidationStatus, FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, LabelsResponse, ListOptions, ListResponse, MD5Result, MY_API_KEY_URL, OAUTH_TOKEN, OAuthScope, OAuthScopeType, PASSWORD_CONSTRAINTS, PUBLIC_DEPLOYMENT_TTL_SECONDS, PingResponse, Plan, PlansResponse, PlatformLimits, RequestResult, ResourceContext, SHIP_ENV, SIGN_IN_RETURN_PARAM, SPACheckDebug, SPACheckRequest, SPACheckResponse, SPA_CHECK_CONSTRAINTS, SPA_DEFAULT_CONFIG, SetupInstructionsResponse, ShipClientOptions, ShipError, ShipEvents, ShipRequestInit, StaticFile, TTL_CONSTRAINTS, Token, TokenCreateOptions, TokenCreateResponse, TokenDeleteResponse, TokenKind, TokenKindType, TokenListResponse, TokenProvider, TokenResource, Transport, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, UploadedFile, UserVisibleActivityEvent, ValidatableFile, ValidationIssue, WEB_FILE_ACCEPT, __setTestEnvironment, allValidFilesReady, assertShipJsonSyntax, calculateMD5, classifyToken, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, deserializeLabels, extractSubdomain, filterJunk, formatFileSize, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isCustomDomain, isDeployment, isPlatformDomain, isShipError, normalizeVia, optimizeDeployPaths, pluralize, processFilesForNode, readBearerValue, serializeLabels, validateApiKey, validateApiUrl, validateCaller, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validateOAuthToken, validatePassword, validateToken, validateTtl };
 }
 export = Ship;

package/dist/index.d.ts

@@ -610,15 +610,16 @@ interface Account {
      */
     readonly used?: number | null;
     /**
-     * True while the Stripe subscription's status is `past_due` and Stripe is
+     * True while the Stripe Subscription's status is `past_due` and Stripe is
      * still retrying the card. The plan is unchanged — the account keeps
      * everything it has — so this is a banner, not a gate.
      *
-     * A BOOLEAN rather than the status string: one fact for the console to
-     * act on. Stripe's own status word is mirrored on the account row for the
-     * operator surface.
+     * A BOOLEAN rather than the status string: one fact for the console to act
+     * on. It carries STRIPE'S OWN WORD (`past_due` → `pastDue`) rather than a
+     * synonym, so no reader has to hold a translation; the full status string is
+     * mirrored on the account row for the operator surface.
      */
-    readonly overdue: boolean;
+    readonly pastDue: boolean;
 }
 /**
  * Account as returned by `GET /account` — the entity plus how the request
@@ -1770,13 +1771,20 @@ interface Plan {
     /** Display name, as the marketing site and the console should print it. */
     readonly name: string;
     /**
-     * What it costs. A union rather than a nullable number, so "free" and
-     * "talk to us" are two different answers instead of two readings of the
-     * same `null`. Amounts are integer CENTS in USD, as the API's plan table
-     * states them and as Stripe's Prices are provisioned from it — the wire
-     * never carries a formatted price, because formatting is the reader's job.
+     * What it costs, per interval — integer CENTS in USD, as the API's plan
+     * table states them and as Stripe's Prices are provisioned from it. The wire
+     * never carries a formatted price: formatting is the reader's job.
+     *
+     * **A free plan costs `{ month: 0, year: 0 }`, not a sentinel.** Free IS
+     * zero, so it is a number like any other and every reader formats it with
+     * the same call; a `'free'` member bought one thing — a branch in each
+     * consumer that mapped it straight back to `$0`.
+     *
+     * `'contact'` stays, and the asymmetry is the point: "not sold at a list
+     * price" is genuinely a different KIND of answer, not a different number, so
+     * it is a different shape. Two shapes, and each earns its own.
      */
-    readonly price: 'free' | 'contact' | {
+    readonly price: 'contact' | {
         readonly month: number;
         readonly year: number;
     };
@@ -1800,14 +1808,25 @@ interface PlansResponse {
     readonly plans: readonly Plan[];
 }
 /**
- * A page Stripe hosts — a Checkout Session or a Customer Portal session — the
- * answer of `POST /billing/checkout` and `POST /billing/portal` alike.
+ * The answer of `POST /billing/checkout` — Stripe's `Checkout.Session`,
+ * projected to the one field a client needs.
  *
- * One shape for both because both say the same thing: the platform is not
- * where this happens, go here. There is nothing else to return — the
- * outcome arrives later, as a Stripe webhook.
+ * There is nothing else to return: the outcome arrives later, as a Stripe
+ * webhook. It is its own type rather than a shape shared with
+ * {@link BillingPortalSession} because Stripe has two distinct objects here,
+ * and naming one of them for both would be the reader's translation to make.
+ */
+interface CheckoutSession {
+    /** Absolute URL to redirect the browser to. Single use, short-lived. */
+    readonly url: string;
+}
+/**
+ * The answer of `POST /billing/portal` — Stripe's `BillingPortal.Session`,
+ * projected the same way. Identical in shape to {@link CheckoutSession} and
+ * deliberately not merged with it: they are two Stripe objects, and either may
+ * gain a field the other never has.
  */
-interface StripeSession {
+interface BillingPortalSession {
     /** Absolute URL to redirect the browser to. Single use, short-lived. */
     readonly url: string;
 }
@@ -3007,4 +3026,4 @@ declare class Ship extends Ship$1 {
     protected processInput(input: DeployInput, options: DeploymentOptions): Promise<StaticFile[]>;
 }
 
-export { API_KEY, API_PATHS, AUTH_BASE_PATH, type Account, type AccountDeleteResponse, type AccountGetResponse, type AccountKeyResponse, AccountPlan, type AccountPlanType, type AccountResource, type Activity, type ActivityEvent, type ActivityListResponse, type ActivityMeta, type ApiDeployOptions, ApiHttp, type ApiHttpOptions, AuthMethod, type AuthMethodType, type BillingInterval, type BillingSyncResponse, CALLER, type Caps, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_FIELDS, DEPLOY_TOKEN, type DeployBodyContext, type DeployFile, type DeployInput, type DeployTransport, type Deployment, type DeploymentCreateResponse, type DeploymentDeleteResponse, type DeploymentListResponse, type DeploymentOptions, type DeploymentResource, type DeploymentResourceContext, type DeploymentSetOptions, DeploymentStatus, type DeploymentStatusType, type DeploymentUploadOptions, DeploymentVia, type DeploymentViaType, type DnsLookup, type DnsProvider, type DnsRecord, type DnsRecordType, type Domain, type DomainDeleteResponse, type DomainDnsResponse, type DomainListResponse, type DomainRecordsResponse, type DomainResource, type DomainSetOptions, type DomainSetResult, type DomainShareResponse, DomainStatus, type DomainStatusType, type DomainValidateResponse, type DomainVerifyResponse, type ErrorResponse, ErrorType, type ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, type Fetch, type FileValidationResult, FileValidationStatus, type FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, type LabelsResponse, type ListOptions, type ListResponse, type MD5Result, MY_API_KEY_URL, OAUTH_TOKEN, OAuthScope, type OAuthScopeType, PASSWORD_CONSTRAINTS, PUBLIC_DEPLOYMENT_TTL_SECONDS, type PingResponse, type Plan, type PlansResponse, type PlatformLimits, type RequestResult, type ResourceContext, SHIP_ENV, SIGN_IN_RETURN_PARAM, type SPACheckDebug, type SPACheckRequest, type SPACheckResponse, SPA_CHECK_CONSTRAINTS, SPA_DEFAULT_CONFIG, type SetupInstructionsResponse, Ship, type ShipClientOptions, ShipError, type ShipEvents, type ShipRequestInit, type StaticFile, type StripeSession, TTL_CONSTRAINTS, type Token, type TokenCreateOptions, type TokenCreateResponse, type TokenDeleteResponse, TokenKind, type TokenKindType, type TokenListResponse, type TokenProvider, type TokenResource, type Transport, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, type UploadedFile, type UserVisibleActivityEvent, type ValidatableFile, type ValidationIssue, WEB_FILE_ACCEPT, __setTestEnvironment, allValidFilesReady, assertShipJsonSyntax, calculateMD5, classifyToken, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, Ship as default, deserializeLabels, extractSubdomain, filterJunk, formatFileSize, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isCustomDomain, isDeployment, isPlatformDomain, isShipError, normalizeVia, optimizeDeployPaths, pluralize, processFilesForNode, readBearerValue, serializeLabels, validateApiKey, validateApiUrl, validateCaller, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validateOAuthToken, validatePassword, validateToken, validateTtl };
+export { API_KEY, API_PATHS, AUTH_BASE_PATH, type Account, type AccountDeleteResponse, type AccountGetResponse, type AccountKeyResponse, AccountPlan, type AccountPlanType, type AccountResource, type Activity, type ActivityEvent, type ActivityListResponse, type ActivityMeta, type ApiDeployOptions, ApiHttp, type ApiHttpOptions, AuthMethod, type AuthMethodType, type BillingInterval, type BillingPortalSession, type BillingSyncResponse, CALLER, type Caps, type CheckoutSession, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_FIELDS, DEPLOY_TOKEN, type DeployBodyContext, type DeployFile, type DeployInput, type DeployTransport, type Deployment, type DeploymentCreateResponse, type DeploymentDeleteResponse, type DeploymentListResponse, type DeploymentOptions, type DeploymentResource, type DeploymentResourceContext, type DeploymentSetOptions, DeploymentStatus, type DeploymentStatusType, type DeploymentUploadOptions, DeploymentVia, type DeploymentViaType, type DnsLookup, type DnsProvider, type DnsRecord, type DnsRecordType, type Domain, type DomainDeleteResponse, type DomainDnsResponse, type DomainListResponse, type DomainRecordsResponse, type DomainResource, type DomainSetOptions, type DomainSetResult, type DomainShareResponse, DomainStatus, type DomainStatusType, type DomainValidateResponse, type DomainVerifyResponse, type ErrorResponse, ErrorType, type ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, type Fetch, type FileValidationResult, FileValidationStatus, type FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, type LabelsResponse, type ListOptions, type ListResponse, type MD5Result, MY_API_KEY_URL, OAUTH_TOKEN, OAuthScope, type OAuthScopeType, PASSWORD_CONSTRAINTS, PUBLIC_DEPLOYMENT_TTL_SECONDS, type PingResponse, type Plan, type PlansResponse, type PlatformLimits, type RequestResult, type ResourceContext, SHIP_ENV, SIGN_IN_RETURN_PARAM, type SPACheckDebug, type SPACheckRequest, type SPACheckResponse, SPA_CHECK_CONSTRAINTS, SPA_DEFAULT_CONFIG, type SetupInstructionsResponse, Ship, type ShipClientOptions, ShipError, type ShipEvents, type ShipRequestInit, type StaticFile, TTL_CONSTRAINTS, type Token, type TokenCreateOptions, type TokenCreateResponse, type TokenDeleteResponse, TokenKind, type TokenKindType, type TokenListResponse, type TokenProvider, type TokenResource, type Transport, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, type UploadedFile, type UserVisibleActivityEvent, type ValidatableFile, type ValidationIssue, WEB_FILE_ACCEPT, __setTestEnvironment, allValidFilesReady, assertShipJsonSyntax, calculateMD5, classifyToken, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, Ship as default, deserializeLabels, extractSubdomain, filterJunk, formatFileSize, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isCustomDomain, isDeployment, isPlatformDomain, isShipError, normalizeVia, optimizeDeployPaths, pluralize, processFilesForNode, readBearerValue, serializeLabels, validateApiKey, validateApiUrl, validateCaller, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validateOAuthToken, validatePassword, validateToken, validateTtl };