@shipstatic/types 0.9.11 → 1.1.0

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
@@ -38,7 +38,7 @@ export interface Deployment {
38
38
  readonly created: number;
39
39
  /** Unix timestamp (seconds) when deployment expires, null if never */
40
40
  expires: number | null;
41
- /** Screenshot URL for this deployment (e.g., 'https://screenshots.shipstatic.com/happy-cat-abc1234/a3f2c1b4d5e6f789') */
41
+ /** Full URL to the deployment screenshot (e.g., 'https://screenshots.shipstatic.com/happy-cat-abc1234/a3f2c1b4d5e6f789') */
42
42
  readonly screenshot: string;
43
43
  }
44
44
  /**
@@ -188,7 +188,7 @@ export interface Token {
188
188
  readonly account: string;
189
189
  /** SHA256 hash of the raw credential (auth lookups only, never exposed to users) */
190
190
  readonly hash: string;
191
- /** IP address locking for security, null if not locked */
191
+ /** IP-lock. Non-null = single-use (claimable only from this IP, once); null = multi-use. */
192
192
  readonly ip: string | null;
193
193
  /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */
194
194
  labels: string[];
@@ -196,7 +196,7 @@ export interface Token {
196
196
  readonly created: number;
197
197
  /** Unix timestamp (seconds) when token expires, null for never */
198
198
  readonly expires: number | null;
199
- /** Unix timestamp (seconds) when token was last used, null if never used */
199
+ /** Consumption timestamp. Single-use: gates re-use (set once). Multi-use: refreshed on every claim. Null = never claimed. */
200
200
  readonly used: number | null;
201
201
  }
202
202
  /**
@@ -212,7 +212,7 @@ export interface TokenListItem {
212
212
  readonly created: number;
213
213
  /** Unix timestamp (seconds) when token expires, null for never */
214
214
  readonly expires: number | null;
215
- /** Unix timestamp (seconds) when token was last used, null if never used */
215
+ /** Consumption timestamp. Single-use: gates re-use (set once). Multi-use: refreshed on every claim. Null = never claimed. */
216
216
  readonly used: number | null;
217
217
  }
218
218
  /**
@@ -651,7 +651,7 @@ export interface ResolvedConfig {
651
651
  apiUrl: string;
652
652
  /** API key for authenticated deployments. */
653
653
  apiKey?: string;
654
- /** Deploy token for single-use deployments. */
654
+ /** Deploy token used as the request credential (`token-{64-hex}`). */
655
655
  deployToken?: string;
656
656
  }
657
657
  /**
@@ -788,7 +788,7 @@ export interface CheckoutSession {
788
788
  * All activity event types logged in the system.
789
789
  * Uses dot notation consistently: {resource}.{action}
790
790
  */
791
- 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' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume' | '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';
791
+ 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' | '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';
792
792
  /**
793
793
  * Activity events visible to users in the dashboard
794
794
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipstatic/types",
3
- "version": "0.9.11",
3
+ "version": "1.1.0",
4
4
  "description": "Shared types for ShipStatic platform",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
package/src/index.ts CHANGED
@@ -45,7 +45,7 @@ export interface Deployment {
45
45
  readonly created: number;
46
46
  /** Unix timestamp (seconds) when deployment expires, null if never */
47
47
  expires: number | null; // Mutable - can be updated
48
- /** Screenshot URL for this deployment (e.g., 'https://screenshots.shipstatic.com/happy-cat-abc1234/a3f2c1b4d5e6f789') */
48
+ /** Full URL to the deployment screenshot (e.g., 'https://screenshots.shipstatic.com/happy-cat-abc1234/a3f2c1b4d5e6f789') */
49
49
  readonly screenshot: string;
50
50
  }
51
51
 
@@ -216,7 +216,7 @@ export interface Token {
216
216
  readonly account: string;
217
217
  /** SHA256 hash of the raw credential (auth lookups only, never exposed to users) */
218
218
  readonly hash: string;
219
- /** IP address locking for security, null if not locked */
219
+ /** IP-lock. Non-null = single-use (claimable only from this IP, once); null = multi-use. */
220
220
  readonly ip: string | null;
221
221
  /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */
222
222
  labels: string[];
@@ -224,7 +224,7 @@ export interface Token {
224
224
  readonly created: number;
225
225
  /** Unix timestamp (seconds) when token expires, null for never */
226
226
  readonly expires: number | null;
227
- /** Unix timestamp (seconds) when token was last used, null if never used */
227
+ /** Consumption timestamp. Single-use: gates re-use (set once). Multi-use: refreshed on every claim. Null = never claimed. */
228
228
  readonly used: number | null;
229
229
  }
230
230
 
@@ -241,7 +241,7 @@ export interface TokenListItem {
241
241
  readonly created: number;
242
242
  /** Unix timestamp (seconds) when token expires, null for never */
243
243
  readonly expires: number | null;
244
- /** Unix timestamp (seconds) when token was last used, null if never used */
244
+ /** Consumption timestamp. Single-use: gates re-use (set once). Multi-use: refreshed on every claim. Null = never claimed. */
245
245
  readonly used: number | null;
246
246
  }
247
247
 
@@ -1008,7 +1008,7 @@ export interface ResolvedConfig {
1008
1008
  apiUrl: string;
1009
1009
  /** API key for authenticated deployments. */
1010
1010
  apiKey?: string;
1011
- /** Deploy token for single-use deployments. */
1011
+ /** Deploy token used as the request credential (`token-{64-hex}`). */
1012
1012
  deployToken?: string;
1013
1013
  }
1014
1014
 
@@ -1178,6 +1178,7 @@ export type ActivityEvent =
1178
1178
  | 'deployment.update'
1179
1179
  | 'deployment.delete'
1180
1180
  | 'deployment.claim'
1181
+ | 'deployment.flagged' // Internal: HTML content matched a detection rule (not user-visible)
1181
1182
  // Domain events
1182
1183
  | 'domain.create'
1183
1184
  | 'domain.update'