@shipstatic/types 0.9.11 → 1.0.0

package/dist/index.d.ts

@@ -38,7 +38,7 @@ export interface Deployment {
     readonly created: number;
     /** Unix timestamp (seconds) when deployment expires, null if never */
     expires: number | null;
-    /** Screenshot URL for this deployment (e.g., 'https://screenshots.shipstatic.com/happy-cat-abc1234/a3f2c1b4d5e6f789') */
+    /** Full URL to the deployment screenshot (e.g., 'https://screenshots.shipstatic.com/happy-cat-abc1234/a3f2c1b4d5e6f789') */
     readonly screenshot: string;
 }
 /**
@@ -188,7 +188,7 @@ export interface Token {
     readonly account: string;
     /** SHA256 hash of the raw credential (auth lookups only, never exposed to users) */
     readonly hash: string;
-    /** IP address locking for security, null if not locked */
+    /** IP-lock. Non-null = single-use (claimable only from this IP, once); null = multi-use. */
     readonly ip: string | null;
     /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */
     labels: string[];
@@ -196,7 +196,7 @@ export interface Token {
     readonly created: number;
     /** Unix timestamp (seconds) when token expires, null for never */
     readonly expires: number | null;
-    /** Unix timestamp (seconds) when token was last used, null if never used */
+    /** Consumption timestamp. Single-use: gates re-use (set once). Multi-use: refreshed on every claim. Null = never claimed. */
     readonly used: number | null;
 }
 /**
@@ -212,7 +212,7 @@ export interface TokenListItem {
     readonly created: number;
     /** Unix timestamp (seconds) when token expires, null for never */
     readonly expires: number | null;
-    /** Unix timestamp (seconds) when token was last used, null if never used */
+    /** Consumption timestamp. Single-use: gates re-use (set once). Multi-use: refreshed on every claim. Null = never claimed. */
     readonly used: number | null;
 }
 /**
@@ -651,7 +651,7 @@ export interface ResolvedConfig {
     apiUrl: string;
     /** API key for authenticated deployments. */
     apiKey?: string;
-    /** Deploy token for single-use deployments. */
+    /** Deploy token used as the request credential (`token-{64-hex}`). */
     deployToken?: string;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipstatic/types",
-  "version": "0.9.11",
+  "version": "1.0.0",
   "description": "Shared types for ShipStatic platform",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -45,7 +45,7 @@ export interface Deployment {
   readonly created: number;
   /** Unix timestamp (seconds) when deployment expires, null if never */
   expires: number | null; // Mutable - can be updated
-  /** Screenshot URL for this deployment (e.g., 'https://screenshots.shipstatic.com/happy-cat-abc1234/a3f2c1b4d5e6f789') */
+  /** Full URL to the deployment screenshot (e.g., 'https://screenshots.shipstatic.com/happy-cat-abc1234/a3f2c1b4d5e6f789') */
   readonly screenshot: string;
 }
 
@@ -216,7 +216,7 @@ export interface Token {
   readonly account: string;
   /** SHA256 hash of the raw credential (auth lookups only, never exposed to users) */
   readonly hash: string;
-  /** IP address locking for security, null if not locked */
+  /** IP-lock. Non-null = single-use (claimable only from this IP, once); null = multi-use. */
   readonly ip: string | null;
   /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */
   labels: string[];
@@ -224,7 +224,7 @@ export interface Token {
   readonly created: number;
   /** Unix timestamp (seconds) when token expires, null for never */
   readonly expires: number | null;
-  /** Unix timestamp (seconds) when token was last used, null if never used */
+  /** Consumption timestamp. Single-use: gates re-use (set once). Multi-use: refreshed on every claim. Null = never claimed. */
   readonly used: number | null;
 }
 
@@ -241,7 +241,7 @@ export interface TokenListItem {
   readonly created: number;
   /** Unix timestamp (seconds) when token expires, null for never */
   readonly expires: number | null;
-  /** Unix timestamp (seconds) when token was last used, null if never used */
+  /** Consumption timestamp. Single-use: gates re-use (set once). Multi-use: refreshed on every claim. Null = never claimed. */
   readonly used: number | null;
 }
 
@@ -1008,7 +1008,7 @@ export interface ResolvedConfig {
   apiUrl: string;
   /** API key for authenticated deployments. */
   apiKey?: string;
-  /** Deploy token for single-use deployments. */
+  /** Deploy token used as the request credential (`token-{64-hex}`). */
   deployToken?: string;
 }