@shipstatic/types 2.10.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
@@ -627,6 +627,20 @@ export interface AccountKeyResponse {
627
627
  /** The raw API key (shown once at mint, then never again) */
628
628
  readonly secret: string;
629
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
+ }
630
644
  /**
631
645
  * Account-specific configuration overrides
632
646
  * Allows per-account customization of limits without changing plan
@@ -1122,6 +1136,20 @@ export interface PingResponse {
1122
1136
  * already share the credential prefixes below.
1123
1137
  */
1124
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";
1125
1153
  /**
1126
1154
  * How a request (or recorded activity) was authorized.
1127
1155
  *
@@ -1759,7 +1787,7 @@ export interface CheckoutSession {
1759
1787
  * All activity event types logged in the system.
1760
1788
  * Uses dot notation consistently: {resource}.{action}
1761
1789
  */
1762
- 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';
1763
1791
  /**
1764
1792
  * Activity events visible to users in the dashboard
1765
1793
  */
package/dist/index.js CHANGED
@@ -1110,6 +1110,20 @@ export function hasUnbuiltMarker(filePath) {
1110
1110
  * already share the credential prefixes below.
1111
1111
  */
1112
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';
1113
1127
  /**
1114
1128
  * How a request (or recorded activity) was authorized.
1115
1129
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipstatic/types",
3
- "version": "2.10.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
@@ -706,6 +706,21 @@ export interface AccountKeyResponse {
706
706
  readonly secret: string;
707
707
  }
708
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
+
709
724
  /**
710
725
  * Account-specific configuration overrides
711
726
  * Allows per-account customization of limits without changing plan
@@ -1797,6 +1812,21 @@ export interface PingResponse {
1797
1812
  */
1798
1813
  export const AUTH_BASE_PATH = '/auth';
1799
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
+
1800
1830
  /**
1801
1831
  * How a request (or recorded activity) was authorized.
1802
1832
  *
@@ -2644,6 +2674,7 @@ export type ActivityEvent =
2644
2674
  | 'deployment.delete'
2645
2675
  | 'deployment.claim'
2646
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)
2647
2678
  // Domain events
2648
2679
  | 'domain.create'
2649
2680
  | 'domain.update'