@shipstatic/types 2.9.0 → 2.11.0-beta.1

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
@@ -73,12 +73,14 @@ export declare const DeploymentVia: {
73
73
  * A deploy that reached the REST API naming no origin at all — the
74
74
  * platform-wide fallback, one altitude below `mcp`'s family fallback.
75
75
  *
76
- * **Declared ahead of its emitter, deliberately.** Nothing sends it yet and
77
- * the server still records an unattributed deploy as `null`. Vocabulary must
78
- * exist before a consumer can adopt it, and adding a member costs a full
79
- * constellation convoy — so the word ships first and the API adopts it as a
80
- * default whenever that decision is taken, with no convoy standing between
81
- * the decision and the deploy.
76
+ * **The API stamps it, since 2026-08-15.** A deploy that names no origin —
77
+ * or names one this vocabulary does not know — is stored as `api`, so a
78
+ * stored `null` now means only that the row predates attribution.
79
+ *
80
+ * It was declared one wave ahead of that decision, deliberately: vocabulary
81
+ * must exist before a consumer can adopt it, and adding a member costs a
82
+ * full constellation convoy, so the word shipped first and the server
83
+ * adopted it with no convoy standing between the decision and the deploy.
82
84
  */
83
85
  readonly API: "api";
84
86
  };
@@ -104,7 +106,10 @@ export interface Deployment {
104
106
  /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */
105
107
  labels: string[];
106
108
  /**
107
- * The client/tool that created this deployment, null if unknown.
109
+ * The client/tool that created this deployment. Every deployment created
110
+ * today names one — {@link DeploymentVia.API} when the caller named nothing
111
+ * the vocabulary knows — so `null` is historical: the row predates
112
+ * attribution.
108
113
  *
109
114
  * Deliberately wider than {@link DeploymentViaType}: this is stored data,
110
115
  * and rows predate the vocabulary being closed. Narrowing the ENTITY would
@@ -622,6 +627,20 @@ export interface AccountKeyResponse {
622
627
  /** The raw API key (shown once at mint, then never again) */
623
628
  readonly secret: string;
624
629
  }
630
+ /**
631
+ * What `GET /account/claim` answers — the render half of the claim door: the
632
+ * deployment a claim code names, and whether it is still there for THIS
633
+ * caller to take. Claimability is a fact of code-plus-caller only the API can
634
+ * compute; consumers must never infer it from `expires`, an entitlement
635
+ * detail that is free to diverge. (The POST — the intent half — answers the
636
+ * bare {@link Deployment} it moved.)
637
+ */
638
+ export interface ClaimResolveResponse {
639
+ /** The deployment the code names, as the caller may see it. */
640
+ readonly deployment: Deployment;
641
+ /** Still the public account's to take — false once it is the caller's own. */
642
+ readonly claimable: boolean;
643
+ }
625
644
  /**
626
645
  * Account-specific configuration overrides
627
646
  * Allows per-account customization of limits without changing plan
@@ -1117,6 +1136,20 @@ export interface PingResponse {
1117
1136
  * already share the credential prefixes below.
1118
1137
  */
1119
1138
  export declare const AUTH_BASE_PATH = "/auth";
1139
+ /**
1140
+ * The query marker a completed sign-in LANDS with.
1141
+ *
1142
+ * The API's magic-link verify leg stamps `?signing-in=1` onto its success
1143
+ * redirect, and the console boots into its wait screen on seeing it — two
1144
+ * repos, one spelling, which is why it lives here. Success is marked and the
1145
+ * error leg deliberately is NOT: the console gives the marker precedence, so
1146
+ * a marked error would render a wait that resolves to bare doors with the
1147
+ * error's sentence lost. If the spellings ever diverged the failure would be
1148
+ * invisible to every suite — email landings would flash the doors for one
1149
+ * round trip instead of waiting — which is exactly the silent-drift class
1150
+ * this constitution exists to delete.
1151
+ */
1152
+ export declare const SIGN_IN_RETURN_PARAM = "signing-in";
1120
1153
  /**
1121
1154
  * How a request (or recorded activity) was authorized.
1122
1155
  *
@@ -1754,7 +1787,7 @@ export interface CheckoutSession {
1754
1787
  * All activity event types logged in the system.
1755
1788
  * Uses dot notation consistently: {resource}.{action}
1756
1789
  */
1757
- export type ActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.paid' | 'account.plan.transition' | 'account.suspended' | 'deployment.create' | 'deployment.update' | 'deployment.delete' | 'deployment.claim' | 'deployment.flagged' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume' | 'token.delete' | 'admin.account.plan.update' | 'admin.account.ref.update' | 'admin.account.billing.update' | 'admin.account.labels.update' | 'admin.deployment.delete' | 'admin.domain.delete' | 'admin.billing.sync' | 'admin.billing.terminated' | 'admin.impersonate' | 'billing.active' | 'billing.canceled' | 'billing.paused' | 'billing.expired' | 'billing.paid' | 'billing.trialing' | 'billing.scheduled_cancel' | 'billing.unpaid' | 'billing.update' | 'billing.past_due' | 'refund.created' | 'dispute.created' | 'billing.sync' | 'billing.stale' | 'billing.race';
1790
+ export type ActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.paid' | 'account.plan.transition' | 'account.suspended' | 'deployment.create' | 'deployment.update' | 'deployment.delete' | 'deployment.claim' | 'deployment.flagged' | 'deployment.open' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume' | 'token.delete' | 'admin.account.plan.update' | 'admin.account.ref.update' | 'admin.account.billing.update' | 'admin.account.labels.update' | 'admin.deployment.delete' | 'admin.domain.delete' | 'admin.billing.sync' | 'admin.billing.terminated' | 'admin.impersonate' | 'billing.active' | 'billing.canceled' | 'billing.paused' | 'billing.expired' | 'billing.paid' | 'billing.trialing' | 'billing.scheduled_cancel' | 'billing.unpaid' | 'billing.update' | 'billing.past_due' | 'refund.created' | 'dispute.created' | 'billing.sync' | 'billing.stale' | 'billing.race';
1758
1791
  /**
1759
1792
  * Activity events visible to users in the dashboard
1760
1793
  */
@@ -1793,6 +1826,17 @@ export interface ActivityMeta {
1793
1826
  hasConfig?: boolean;
1794
1827
  /** Whether deployment has a password set */
1795
1828
  hasPassword?: boolean;
1829
+ /**
1830
+ * The client/tool that created the deployment.
1831
+ *
1832
+ * Narrower than {@link Deployment.via}, deliberately: the entity is
1833
+ * `string | null` because stored rows predate the vocabulary, while an
1834
+ * activity is only ever written by code that names one. It is here rather
1835
+ * than read off the deployment because the deployment row is deleted at
1836
+ * expiry or on request and the activity is not — this is where a deploy's
1837
+ * origin stays answerable afterwards.
1838
+ */
1839
+ via?: DeploymentViaType;
1796
1840
  /** Whether this was an update (vs create) */
1797
1841
  isUpdate?: boolean;
1798
1842
  /** Whether domain was already verified */
package/dist/index.js CHANGED
@@ -75,12 +75,14 @@ export const DeploymentVia = {
75
75
  * A deploy that reached the REST API naming no origin at all — the
76
76
  * platform-wide fallback, one altitude below `mcp`'s family fallback.
77
77
  *
78
- * **Declared ahead of its emitter, deliberately.** Nothing sends it yet and
79
- * the server still records an unattributed deploy as `null`. Vocabulary must
80
- * exist before a consumer can adopt it, and adding a member costs a full
81
- * constellation convoy — so the word ships first and the API adopts it as a
82
- * default whenever that decision is taken, with no convoy standing between
83
- * the decision and the deploy.
78
+ * **The API stamps it, since 2026-08-15.** A deploy that names no origin —
79
+ * or names one this vocabulary does not know — is stored as `api`, so a
80
+ * stored `null` now means only that the row predates attribution.
81
+ *
82
+ * It was declared one wave ahead of that decision, deliberately: vocabulary
83
+ * must exist before a consumer can adopt it, and adding a member costs a
84
+ * full constellation convoy, so the word shipped first and the server
85
+ * adopted it with no convoy standing between the decision and the deploy.
84
86
  */
85
87
  API: 'api',
86
88
  };
@@ -1108,6 +1110,20 @@ export function hasUnbuiltMarker(filePath) {
1108
1110
  * already share the credential prefixes below.
1109
1111
  */
1110
1112
  export const AUTH_BASE_PATH = '/auth';
1113
+ /**
1114
+ * The query marker a completed sign-in LANDS with.
1115
+ *
1116
+ * The API's magic-link verify leg stamps `?signing-in=1` onto its success
1117
+ * redirect, and the console boots into its wait screen on seeing it — two
1118
+ * repos, one spelling, which is why it lives here. Success is marked and the
1119
+ * error leg deliberately is NOT: the console gives the marker precedence, so
1120
+ * a marked error would render a wait that resolves to bare doors with the
1121
+ * error's sentence lost. If the spellings ever diverged the failure would be
1122
+ * invisible to every suite — email landings would flash the doors for one
1123
+ * round trip instead of waiting — which is exactly the silent-drift class
1124
+ * this constitution exists to delete.
1125
+ */
1126
+ export const SIGN_IN_RETURN_PARAM = 'signing-in';
1111
1127
  /**
1112
1128
  * How a request (or recorded activity) was authorized.
1113
1129
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipstatic/types",
3
- "version": "2.9.0",
3
+ "version": "2.11.0-beta.1",
4
4
  "description": "Shared types for ShipStatic platform",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
package/src/index.ts CHANGED
@@ -80,12 +80,14 @@ export const DeploymentVia = {
80
80
  * A deploy that reached the REST API naming no origin at all — the
81
81
  * platform-wide fallback, one altitude below `mcp`'s family fallback.
82
82
  *
83
- * **Declared ahead of its emitter, deliberately.** Nothing sends it yet and
84
- * the server still records an unattributed deploy as `null`. Vocabulary must
85
- * exist before a consumer can adopt it, and adding a member costs a full
86
- * constellation convoy — so the word ships first and the API adopts it as a
87
- * default whenever that decision is taken, with no convoy standing between
88
- * the decision and the deploy.
83
+ * **The API stamps it, since 2026-08-15.** A deploy that names no origin —
84
+ * or names one this vocabulary does not know — is stored as `api`, so a
85
+ * stored `null` now means only that the row predates attribution.
86
+ *
87
+ * It was declared one wave ahead of that decision, deliberately: vocabulary
88
+ * must exist before a consumer can adopt it, and adding a member costs a
89
+ * full constellation convoy, so the word shipped first and the server
90
+ * adopted it with no convoy standing between the decision and the deploy.
89
91
  */
90
92
  API: 'api',
91
93
  } as const;
@@ -113,7 +115,10 @@ export interface Deployment {
113
115
  /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */
114
116
  labels: string[];
115
117
  /**
116
- * The client/tool that created this deployment, null if unknown.
118
+ * The client/tool that created this deployment. Every deployment created
119
+ * today names one — {@link DeploymentVia.API} when the caller named nothing
120
+ * the vocabulary knows — so `null` is historical: the row predates
121
+ * attribution.
117
122
  *
118
123
  * Deliberately wider than {@link DeploymentViaType}: this is stored data,
119
124
  * and rows predate the vocabulary being closed. Narrowing the ENTITY would
@@ -701,6 +706,21 @@ export interface AccountKeyResponse {
701
706
  readonly secret: string;
702
707
  }
703
708
 
709
+ /**
710
+ * What `GET /account/claim` answers — the render half of the claim door: the
711
+ * deployment a claim code names, and whether it is still there for THIS
712
+ * caller to take. Claimability is a fact of code-plus-caller only the API can
713
+ * compute; consumers must never infer it from `expires`, an entitlement
714
+ * detail that is free to diverge. (The POST — the intent half — answers the
715
+ * bare {@link Deployment} it moved.)
716
+ */
717
+ export interface ClaimResolveResponse {
718
+ /** The deployment the code names, as the caller may see it. */
719
+ readonly deployment: Deployment;
720
+ /** Still the public account's to take — false once it is the caller's own. */
721
+ readonly claimable: boolean;
722
+ }
723
+
704
724
  /**
705
725
  * Account-specific configuration overrides
706
726
  * Allows per-account customization of limits without changing plan
@@ -1792,6 +1812,21 @@ export interface PingResponse {
1792
1812
  */
1793
1813
  export const AUTH_BASE_PATH = '/auth';
1794
1814
 
1815
+ /**
1816
+ * The query marker a completed sign-in LANDS with.
1817
+ *
1818
+ * The API's magic-link verify leg stamps `?signing-in=1` onto its success
1819
+ * redirect, and the console boots into its wait screen on seeing it — two
1820
+ * repos, one spelling, which is why it lives here. Success is marked and the
1821
+ * error leg deliberately is NOT: the console gives the marker precedence, so
1822
+ * a marked error would render a wait that resolves to bare doors with the
1823
+ * error's sentence lost. If the spellings ever diverged the failure would be
1824
+ * invisible to every suite — email landings would flash the doors for one
1825
+ * round trip instead of waiting — which is exactly the silent-drift class
1826
+ * this constitution exists to delete.
1827
+ */
1828
+ export const SIGN_IN_RETURN_PARAM = 'signing-in';
1829
+
1795
1830
  /**
1796
1831
  * How a request (or recorded activity) was authorized.
1797
1832
  *
@@ -2639,6 +2674,7 @@ export type ActivityEvent =
2639
2674
  | 'deployment.delete'
2640
2675
  | 'deployment.claim'
2641
2676
  | 'deployment.flagged' // Internal: HTML content matched a detection rule (not user-visible)
2677
+ | 'deployment.open' // Internal: an operator opened hosted content for moderation (not user-visible)
2642
2678
  // Domain events
2643
2679
  | 'domain.create'
2644
2680
  | 'domain.update'
@@ -2733,6 +2769,17 @@ export interface ActivityMeta {
2733
2769
  hasConfig?: boolean;
2734
2770
  /** Whether deployment has a password set */
2735
2771
  hasPassword?: boolean;
2772
+ /**
2773
+ * The client/tool that created the deployment.
2774
+ *
2775
+ * Narrower than {@link Deployment.via}, deliberately: the entity is
2776
+ * `string | null` because stored rows predate the vocabulary, while an
2777
+ * activity is only ever written by code that names one. It is here rather
2778
+ * than read off the deployment because the deployment row is deleted at
2779
+ * expiry or on request and the activity is not — this is where a deploy's
2780
+ * origin stays answerable afterwards.
2781
+ */
2782
+ via?: DeploymentViaType;
2736
2783
 
2737
2784
  // Domain events
2738
2785
  /** Whether this was an update (vs create) */