@shipstatic/types 2.21.2 → 2.22.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -326,6 +326,12 @@ export interface DnsRecord {
326
326
  export interface DnsProvider {
327
327
  /** Provider name (e.g., "Cloudflare", "GoDaddy"), null if unknown */
328
328
  name: string | null;
329
+ /**
330
+ * The provider's DNS dashboard, where the records get added, null where the
331
+ * provider is unknown or has no known console. Optional on the type by the
332
+ * additive-evolution law: published API versions may predate the field.
333
+ */
334
+ url?: string | null;
329
335
  }
330
336
  /**
331
337
  * Response for domain DNS provider lookup
@@ -616,7 +622,14 @@ export interface Account {
616
622
  readonly name: string | null;
617
623
  /** User profile picture URL, null if not set */
618
624
  readonly picture: string | null;
619
- /** The account's tier. */
625
+ /**
626
+ * The tier the account stands at. A sponsored account is Pro that nobody
627
+ * bills, so it reports `pro` here with {@link billed} false; the grant
628
+ * itself is the operator's fact, seen on the operator's surfaces and never
629
+ * here. A console therefore treats a sponsored account exactly as a Pro one
630
+ * everywhere, and the one difference it can see is the one that is real:
631
+ * there is no Subscription.
632
+ */
620
633
  readonly plan: AccountPlanType;
621
634
  /**
622
635
  * True while the operator has suspended the account: reads and deletes
@@ -666,11 +679,10 @@ export interface Account {
666
679
  readonly billed: boolean;
667
680
  /**
668
681
  * The next plan up the ladder this account could move to, or `null` when
669
- * there is none: the top billed tier, every granted plan, and any plan not
670
- * on the menu answer `null`. One server-side fact so that no surface
671
- * derives "can this account upgrade, and to what" from the menu — a
672
- * grandfathered row has no menu price to compare, and a granted account
673
- * must never be sent to Checkout.
682
+ * there is none: the top billed tier, a plan sold by conversation, and any
683
+ * plan not on the menu answer `null`. One server-side fact so that no surface derives "can this account
684
+ * upgrade, and to what" from the menu — a grandfathered row has no menu
685
+ * price to compare, and a conversation plan must never be sent to Checkout.
674
686
  */
675
687
  readonly upgrade: AccountPlanType | null;
676
688
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipstatic/types",
3
- "version": "2.21.2",
3
+ "version": "2.22.0-beta.2",
4
4
  "description": "Shared TypeScript types for the ShipStatic platform.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
package/src/index.ts CHANGED
@@ -354,6 +354,12 @@ export interface DnsRecord {
354
354
  export interface DnsProvider {
355
355
  /** Provider name (e.g., "Cloudflare", "GoDaddy"), null if unknown */
356
356
  name: string | null;
357
+ /**
358
+ * The provider's DNS dashboard, where the records get added, null where the
359
+ * provider is unknown or has no known console. Optional on the type by the
360
+ * additive-evolution law: published API versions may predate the field.
361
+ */
362
+ url?: string | null;
357
363
  }
358
364
 
359
365
  /**
@@ -691,7 +697,14 @@ export interface Account {
691
697
  readonly name: string | null;
692
698
  /** User profile picture URL, null if not set */
693
699
  readonly picture: string | null;
694
- /** The account's tier. */
700
+ /**
701
+ * The tier the account stands at. A sponsored account is Pro that nobody
702
+ * bills, so it reports `pro` here with {@link billed} false; the grant
703
+ * itself is the operator's fact, seen on the operator's surfaces and never
704
+ * here. A console therefore treats a sponsored account exactly as a Pro one
705
+ * everywhere, and the one difference it can see is the one that is real:
706
+ * there is no Subscription.
707
+ */
695
708
  readonly plan: AccountPlanType;
696
709
  /**
697
710
  * True while the operator has suspended the account: reads and deletes
@@ -741,11 +754,10 @@ export interface Account {
741
754
  readonly billed: boolean;
742
755
  /**
743
756
  * The next plan up the ladder this account could move to, or `null` when
744
- * there is none: the top billed tier, every granted plan, and any plan not
745
- * on the menu answer `null`. One server-side fact so that no surface
746
- * derives "can this account upgrade, and to what" from the menu — a
747
- * grandfathered row has no menu price to compare, and a granted account
748
- * must never be sent to Checkout.
757
+ * there is none: the top billed tier, a plan sold by conversation, and any
758
+ * plan not on the menu answer `null`. One server-side fact so that no surface derives "can this account
759
+ * upgrade, and to what" from the menu — a grandfathered row has no menu
760
+ * price to compare, and a conversation plan must never be sent to Checkout.
749
761
  */
750
762
  readonly upgrade: AccountPlanType | null;
751
763
  /**