@shipstatic/types 2.21.1 → 2.22.0-beta.1

package/README.md

@@ -16,7 +16,7 @@ npm install @shipstatic/types
 
 ## What's included
 
-### Core Entities
+### Core entities
 
 ```typescript
 import type {
@@ -38,7 +38,7 @@ survives, otherwise the `*DeleteResponse` shape: the resource noun carrying
 the canonical key, plus the resource's own state field where the resource is
 mid-transition. No `message`, no `success`, no constant flags.
 
-### Error System
+### Error system
 
 ```typescript
 import { ShipError, ErrorType, isShipError } from '@shipstatic/types';
@@ -84,7 +84,7 @@ catch (cause) { throw ShipError.fromFetchError(cause, 'Get account'); }
 
 Both helpers accept an optional operation-name string for contextual messages (`"Get account was cancelled"`, `"Get account failed: ..."`).
 
-### Status Constants
+### Status constants
 
 ```typescript
 import {
@@ -109,7 +109,7 @@ import type {
 } from '@shipstatic/types';
 ```
 
-### Resource Contracts
+### Resource contracts
 
 SDK interface definitions:
 
@@ -122,7 +122,7 @@ import type {
 } from '@shipstatic/types';
 ```
 
-### Validation Utilities
+### Validation utilities
 
 ```typescript
 import {
@@ -146,7 +146,7 @@ const limits = await ship.getLimits();
 isBlockedExtension('virus.exe', limits.blockedExtensions ?? []);
 ```
 
-### File Upload Types
+### File upload types
 
 ```typescript
 import type {
@@ -157,7 +157,7 @@ import type {
 } from '@shipstatic/types';
 ```
 
-### Domain Utilities
+### Domain utilities
 
 ```typescript
 import {
@@ -169,7 +169,7 @@ import {
 } from '@shipstatic/types';
 ```
 
-### Label Utilities
+### Label utilities
 
 ```typescript
 import {
@@ -180,7 +180,7 @@ import {
 } from '@shipstatic/types';
 ```
 
-### Password Utilities
+### Password utilities
 
 ```typescript
 import {

package/dist/index.d.ts

@@ -326,6 +326,12 @@ export interface DnsRecord {
 export interface DnsProvider {
     /** Provider name (e.g., "Cloudflare", "GoDaddy"), null if unknown */
     name: string | null;
+    /**
+     * The provider's DNS dashboard, where the records get added, null where the
+     * provider is unknown or has no known console. Optional on the type by the
+     * additive-evolution law: published API versions may predate the field.
+     */
+    url?: string | null;
 }
 /**
  * Response for domain DNS provider lookup
@@ -616,8 +622,18 @@ export interface Account {
     readonly name: string | null;
     /** User profile picture URL, null if not set */
     readonly picture: string | null;
-    /** The account's tier. */
+    /** The account's plan: the row it is on. */
     readonly plan: AccountPlanType;
+    /**
+     * The billed tier the account STANDS AT: its plan for a billed or free
+     * account, and the plan a gift copies for a sponsored one (`sponsored`
+     * stands at `pro`). Every question of position, which row is "current",
+     * which rows are above, is asked of this rather than of `plan`, so a
+     * sponsored account sees exactly what a Pro account sees. Optional on the
+     * type by the additive-evolution law: published SDK versions may predate
+     * the field, so consumers read it when present and fall back to `plan`.
+     */
+    readonly tier?: AccountPlanType;
     /**
      * True while the operator has suspended the account: reads and deletes
      * still work, every write is refused. The plan is unchanged underneath.
@@ -666,11 +682,12 @@ export interface Account {
     readonly billed: boolean;
     /**
      * The next plan up the ladder this account could move to, or `null` when
-     * there is none: the top billed tier, every granted plan, and any plan not
-     * on the menu answer `null`. One server-side fact so that no surface
-     * derives "can this account upgrade, and to what" from the menu — a
-     * grandfathered row has no menu price to compare, and a granted account
-     * must never be sent to Checkout.
+     * there is none: the top billed tier, a plan sold by conversation, and any
+     * plan not on the menu answer `null`. Asked from where the account stands
+     * ({@link tier}), so a sponsored account is offered Team as a Pro account
+     * is. One server-side fact so that no surface derives "can this account
+     * upgrade, and to what" from the menu — a grandfathered row has no menu
+     * price to compare, and a conversation plan must never be sent to Checkout.
      */
     readonly upgrade: AccountPlanType | null;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipstatic/types",
-  "version": "2.21.1",
+  "version": "2.22.0-beta.1",
   "description": "Shared TypeScript types for the ShipStatic platform.",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -354,6 +354,12 @@ export interface DnsRecord {
 export interface DnsProvider {
   /** Provider name (e.g., "Cloudflare", "GoDaddy"), null if unknown */
   name: string | null;
+  /**
+   * The provider's DNS dashboard, where the records get added, null where the
+   * provider is unknown or has no known console. Optional on the type by the
+   * additive-evolution law: published API versions may predate the field.
+   */
+  url?: string | null;
 }
 
 /**
@@ -691,8 +697,18 @@ export interface Account {
   readonly name: string | null;
   /** User profile picture URL, null if not set */
   readonly picture: string | null;
-  /** The account's tier. */
+  /** The account's plan: the row it is on. */
   readonly plan: AccountPlanType;
+  /**
+   * The billed tier the account STANDS AT: its plan for a billed or free
+   * account, and the plan a gift copies for a sponsored one (`sponsored`
+   * stands at `pro`). Every question of position, which row is "current",
+   * which rows are above, is asked of this rather than of `plan`, so a
+   * sponsored account sees exactly what a Pro account sees. Optional on the
+   * type by the additive-evolution law: published SDK versions may predate
+   * the field, so consumers read it when present and fall back to `plan`.
+   */
+  readonly tier?: AccountPlanType;
   /**
    * True while the operator has suspended the account: reads and deletes
    * still work, every write is refused. The plan is unchanged underneath.
@@ -741,11 +757,12 @@ export interface Account {
   readonly billed: boolean;
   /**
    * The next plan up the ladder this account could move to, or `null` when
-   * there is none: the top billed tier, every granted plan, and any plan not
-   * on the menu answer `null`. One server-side fact so that no surface
-   * derives "can this account upgrade, and to what" from the menu — a
-   * grandfathered row has no menu price to compare, and a granted account
-   * must never be sent to Checkout.
+   * there is none: the top billed tier, a plan sold by conversation, and any
+   * plan not on the menu answer `null`. Asked from where the account stands
+   * ({@link tier}), so a sponsored account is offered Team as a Pro account
+   * is. One server-side fact so that no surface derives "can this account
+   * upgrade, and to what" from the menu — a grandfathered row has no menu
+   * price to compare, and a conversation plan must never be sent to Checkout.
    */
   readonly upgrade: AccountPlanType | null;
   /**