@shipstatic/types 0.9.10 → 1.0.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,6 +38,8 @@ 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
+ /** Full URL to the deployment screenshot (e.g., 'https://screenshots.shipstatic.com/happy-cat-abc1234/a3f2c1b4d5e6f789') */
42
+ readonly screenshot: string;
41
43
  }
42
44
  /**
43
45
  * Response from deployment creation. Extends Deployment with one-time fields
@@ -186,7 +188,7 @@ export interface Token {
186
188
  readonly account: string;
187
189
  /** SHA256 hash of the raw credential (auth lookups only, never exposed to users) */
188
190
  readonly hash: string;
189
- /** 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. */
190
192
  readonly ip: string | null;
191
193
  /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */
192
194
  labels: string[];
@@ -194,7 +196,7 @@ export interface Token {
194
196
  readonly created: number;
195
197
  /** Unix timestamp (seconds) when token expires, null for never */
196
198
  readonly expires: number | null;
197
- /** 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. */
198
200
  readonly used: number | null;
199
201
  }
200
202
  /**
@@ -210,7 +212,7 @@ export interface TokenListItem {
210
212
  readonly created: number;
211
213
  /** Unix timestamp (seconds) when token expires, null for never */
212
214
  readonly expires: number | null;
213
- /** 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. */
214
216
  readonly used: number | null;
215
217
  }
216
218
  /**
@@ -649,7 +651,7 @@ export interface ResolvedConfig {
649
651
  apiUrl: string;
650
652
  /** API key for authenticated deployments. */
651
653
  apiKey?: string;
652
- /** Deploy token for single-use deployments. */
654
+ /** Deploy token used as the request credential (`token-{64-hex}`). */
653
655
  deployToken?: string;
654
656
  }
655
657
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipstatic/types",
3
- "version": "0.9.10",
3
+ "version": "1.0.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,6 +45,8 @@ 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
+ /** Full URL to the deployment screenshot (e.g., 'https://screenshots.shipstatic.com/happy-cat-abc1234/a3f2c1b4d5e6f789') */
49
+ readonly screenshot: string;
48
50
  }
49
51
 
50
52
 
@@ -214,7 +216,7 @@ export interface Token {
214
216
  readonly account: string;
215
217
  /** SHA256 hash of the raw credential (auth lookups only, never exposed to users) */
216
218
  readonly hash: string;
217
- /** 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. */
218
220
  readonly ip: string | null;
219
221
  /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */
220
222
  labels: string[];
@@ -222,7 +224,7 @@ export interface Token {
222
224
  readonly created: number;
223
225
  /** Unix timestamp (seconds) when token expires, null for never */
224
226
  readonly expires: number | null;
225
- /** 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. */
226
228
  readonly used: number | null;
227
229
  }
228
230
 
@@ -239,7 +241,7 @@ export interface TokenListItem {
239
241
  readonly created: number;
240
242
  /** Unix timestamp (seconds) when token expires, null for never */
241
243
  readonly expires: number | null;
242
- /** 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. */
243
245
  readonly used: number | null;
244
246
  }
245
247
 
@@ -1006,7 +1008,7 @@ export interface ResolvedConfig {
1006
1008
  apiUrl: string;
1007
1009
  /** API key for authenticated deployments. */
1008
1010
  apiKey?: string;
1009
- /** Deploy token for single-use deployments. */
1011
+ /** Deploy token used as the request credential (`token-{64-hex}`). */
1010
1012
  deployToken?: string;
1011
1013
  }
1012
1014