@shipstatic/types 0.4.25 → 0.5.1

package/dist/index.d.ts

@@ -26,8 +26,8 @@ export interface Deployment {
     status: DeploymentStatusType;
     /** Whether deployment has configuration */
     readonly config?: boolean;
-    /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators) */
-    tags?: string[];
+    /** Optional array of labels for categorization and filtering (lowercase, alphanumeric with separators) */
+    labels?: string[];
     /** The client/tool used to create this deployment (e.g., 'web', 'sdk', 'cli') */
     readonly via?: string;
     /** The deployment URL */
@@ -75,8 +75,8 @@ export interface Domain {
     deployment: string | null;
     /** Current domain status */
     status: DomainStatusType;
-    /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators) */
-    tags?: string[];
+    /** Optional array of labels for categorization and filtering (lowercase, alphanumeric with separators) */
+    labels?: string[];
     /** The domain URL - internal (subdomain) or external (custom domain) */
     readonly url: string;
     /** Unix timestamp (seconds) when domain was created */
@@ -177,8 +177,8 @@ export interface Token {
     readonly account: string;
     /** Optional IP address locking for security */
     readonly ip?: string;
-    /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators) */
-    tags?: string[];
+    /** Optional array of labels for categorization and filtering (lowercase, alphanumeric with separators) */
+    labels?: string[];
     /** Unix timestamp (seconds) when token was created */
     readonly created: number;
     /** Unix timestamp (seconds) when token expires, or null for never */
@@ -236,6 +236,8 @@ export interface Account {
     readonly created: number;
     /** Unix timestamp (seconds) when account was activated (first deployment) */
     readonly activated?: number;
+    /** Last 4 characters of the API key for identification (null when no key generated) */
+    readonly hint?: string;
 }
 /**
  * Account-specific configuration overrides
@@ -452,6 +454,7 @@ export interface PingResponse {
 export declare const API_KEY_PREFIX = "ship-";
 export declare const API_KEY_HEX_LENGTH = 64;
 export declare const API_KEY_TOTAL_LENGTH: number;
+export declare const API_KEY_HINT_LENGTH = 4;
 export declare const DEPLOY_TOKEN_PREFIX = "token-";
 export declare const DEPLOY_TOKEN_HEX_LENGTH = 64;
 export declare const DEPLOY_TOKEN_TOTAL_LENGTH: number;
@@ -581,8 +584,8 @@ export type DeployInput = File[] | string | string[];
  * SDK implementations may extend with additional options (timeout, signal, callbacks, etc.).
  */
 export interface DeploymentCreateOptions {
-    /** Optional tags for categorization and filtering */
-    tags?: string[];
+    /** Optional labels for categorization and filtering */
+    labels?: string[];
     /** Optional subdomain suggestion for the deployment */
     subdomain?: string;
     /** Client identifier (e.g., 'cli', 'sdk', 'web') */
@@ -596,7 +599,7 @@ export interface DeploymentResource {
     list: () => Promise<DeploymentListResponse>;
     get: (id: string) => Promise<Deployment>;
     set: (id: string, options: {
-        tags: string[];
+        labels: string[];
     }) => Promise<Deployment>;
     remove: (id: string) => Promise<void>;
 }
@@ -606,7 +609,7 @@ export interface DeploymentResource {
 export interface DomainResource {
     set: (name: string, options?: {
         deployment?: string;
-        tags?: string[];
+        labels?: string[];
     }) => Promise<Domain>;
     list: () => Promise<DomainListResponse>;
     get: (name: string) => Promise<Domain>;
@@ -634,7 +637,7 @@ export interface AccountResource {
 export interface TokenResource {
     create: (options?: {
         ttl?: number;
-        tags?: string[];
+        labels?: string[];
     }) => Promise<TokenCreateResponse>;
     list: () => Promise<TokenListResponse>;
     remove: (token: string) => Promise<void>;
@@ -696,7 +699,7 @@ export interface KeysResource {
  * All activity event types logged in the system.
  * Uses dot notation consistently: {resource}.{action}
  */
-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.tags.update' | 'admin.deployment.delete' | 'admin.domain.delete' | 'admin.billing.sync' | 'admin.billing.terminated' | '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';
+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' | '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';
 /**
  * Activity events visible to users in the dashboard
  */
@@ -733,8 +736,8 @@ export interface ActivityMeta {
     wasVerified?: boolean;
     /** Previous deployment ID before relinking */
     previousDeployment?: string;
-    /** Tags that were set/updated */
-    tags?: string[];
+    /** Labels that were set/updated */
+    labels?: string[];
     /** OAuth provider name */
     provider?: string;
     /** Account email */
@@ -883,43 +886,43 @@ export declare function generateDeploymentUrl(deployment: string, platformDomain
  */
 export declare function generateDomainUrl(domain: string): string;
 /**
- * Tag validation constraints shared across UI and API.
- * These rules define the single source of truth for tag validation.
+ * Label validation constraints shared across UI and API.
+ * These rules define the single source of truth for label validation.
  */
-export declare const TAG_CONSTRAINTS: {
-    /** Minimum tag length in characters */
+export declare const LABEL_CONSTRAINTS: {
+    /** Minimum label length in characters */
     readonly MIN_LENGTH: 3;
-    /** Maximum tag length in characters (concise tags, matches Stack Overflow's original limit) */
+    /** Maximum label length in characters (concise labels, matches Stack Overflow's original limit) */
     readonly MAX_LENGTH: 25;
-    /** Maximum number of tags allowed per resource */
+    /** Maximum number of labels allowed per resource */
     readonly MAX_COUNT: 10;
-    /** Allowed separator characters between tag segments */
+    /** Allowed separator characters between label segments */
     readonly SEPARATORS: "._-";
 };
 /**
- * Tag validation pattern.
+ * Label validation pattern.
  * Must start and end with alphanumeric (a-z, 0-9).
  * Can contain separators (. _ -) between segments, but not consecutive.
  *
  * Valid examples: 'production', 'v1.2.3', 'api_v2', 'us-east-1'
  * Invalid examples: 'ab' (too short), '-prod' (starts with separator), 'foo--bar' (consecutive separators)
  */
-export declare const TAG_PATTERN: RegExp;
+export declare const LABEL_PATTERN: RegExp;
 /**
- * Serialize tags array to JSON string for database storage.
+ * Serialize labels array to JSON string for database storage.
  * Returns null for empty or undefined arrays.
  *
- * @example serializeTags(['web', 'production']) → '["web","production"]'
- * @example serializeTags([]) → null
- * @example serializeTags(undefined) → null
+ * @example serializeLabels(['web', 'production']) → '["web","production"]'
+ * @example serializeLabels([]) → null
+ * @example serializeLabels(undefined) → null
  */
-export declare function serializeTags(tags: string[] | undefined): string | null;
+export declare function serializeLabels(labels: string[] | undefined): string | null;
 /**
- * Deserialize tags from JSON string to array.
+ * Deserialize labels from JSON string to array.
  * Returns undefined for null/empty strings.
  *
- * @example deserializeTags('["web","production"]') → ['web', 'production']
- * @example deserializeTags(null) → undefined
- * @example deserializeTags('') → undefined
+ * @example deserializeLabels('["web","production"]') → ['web', 'production']
+ * @example deserializeLabels(null) → undefined
+ * @example deserializeLabels('') → undefined
  */
-export declare function deserializeTags(tagsJson: string | null): string[] | undefined;
+export declare function deserializeLabels(labelsJson: string | null): string[] | undefined;

package/dist/index.js

@@ -413,6 +413,7 @@ export function isAllowedMimeType(mimeType) {
 export const API_KEY_PREFIX = 'ship-';
 export const API_KEY_HEX_LENGTH = 64;
 export const API_KEY_TOTAL_LENGTH = API_KEY_PREFIX.length + API_KEY_HEX_LENGTH; // 69
+export const API_KEY_HINT_LENGTH = 4;
 // Deploy Token Configuration
 export const DEPLOY_TOKEN_PREFIX = 'token-';
 export const DEPLOY_TOKEN_HEX_LENGTH = 64;
@@ -564,57 +565,57 @@ export function generateDomainUrl(domain) {
     return `https://${domain}`;
 }
 // =============================================================================
-// TAG UTILITIES
+// LABEL UTILITIES
 // =============================================================================
 /**
- * Tag validation constraints shared across UI and API.
- * These rules define the single source of truth for tag validation.
+ * Label validation constraints shared across UI and API.
+ * These rules define the single source of truth for label validation.
  */
-export const TAG_CONSTRAINTS = {
-    /** Minimum tag length in characters */
+export const LABEL_CONSTRAINTS = {
+    /** Minimum label length in characters */
     MIN_LENGTH: 3,
-    /** Maximum tag length in characters (concise tags, matches Stack Overflow's original limit) */
+    /** Maximum label length in characters (concise labels, matches Stack Overflow's original limit) */
     MAX_LENGTH: 25,
-    /** Maximum number of tags allowed per resource */
+    /** Maximum number of labels allowed per resource */
     MAX_COUNT: 10,
-    /** Allowed separator characters between tag segments */
+    /** Allowed separator characters between label segments */
     SEPARATORS: '._-',
 };
 /**
- * Tag validation pattern.
+ * Label validation pattern.
  * Must start and end with alphanumeric (a-z, 0-9).
  * Can contain separators (. _ -) between segments, but not consecutive.
  *
  * Valid examples: 'production', 'v1.2.3', 'api_v2', 'us-east-1'
  * Invalid examples: 'ab' (too short), '-prod' (starts with separator), 'foo--bar' (consecutive separators)
  */
-export const TAG_PATTERN = /^[a-z0-9]+(?:[._-][a-z0-9]+)*$/;
+export const LABEL_PATTERN = /^[a-z0-9]+(?:[._-][a-z0-9]+)*$/;
 /**
- * Serialize tags array to JSON string for database storage.
+ * Serialize labels array to JSON string for database storage.
  * Returns null for empty or undefined arrays.
  *
- * @example serializeTags(['web', 'production']) → '["web","production"]'
- * @example serializeTags([]) → null
- * @example serializeTags(undefined) → null
+ * @example serializeLabels(['web', 'production']) → '["web","production"]'
+ * @example serializeLabels([]) → null
+ * @example serializeLabels(undefined) → null
  */
-export function serializeTags(tags) {
-    if (!tags || tags.length === 0)
+export function serializeLabels(labels) {
+    if (!labels || labels.length === 0)
         return null;
-    return JSON.stringify(tags);
+    return JSON.stringify(labels);
 }
 /**
- * Deserialize tags from JSON string to array.
+ * Deserialize labels from JSON string to array.
  * Returns undefined for null/empty strings.
  *
- * @example deserializeTags('["web","production"]') → ['web', 'production']
- * @example deserializeTags(null) → undefined
- * @example deserializeTags('') → undefined
+ * @example deserializeLabels('["web","production"]') → ['web', 'production']
+ * @example deserializeLabels(null) → undefined
+ * @example deserializeLabels('') → undefined
  */
-export function deserializeTags(tagsJson) {
-    if (!tagsJson)
+export function deserializeLabels(labelsJson) {
+    if (!labelsJson)
         return undefined;
     try {
-        const parsed = JSON.parse(tagsJson);
+        const parsed = JSON.parse(labelsJson);
         return Array.isArray(parsed) && parsed.length > 0 ? parsed : undefined;
     }
     catch {

package/package.json

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

package/src/index.ts

@@ -33,8 +33,8 @@ export interface Deployment {
   status: DeploymentStatusType; // Mutable - can be updated
   /** Whether deployment has configuration */
   readonly config?: boolean;
-  /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators) */
-  tags?: string[];
+  /** Optional array of labels for categorization and filtering (lowercase, alphanumeric with separators) */
+  labels?: string[];
   /** The client/tool used to create this deployment (e.g., 'web', 'sdk', 'cli') */
   readonly via?: string;
   /** The deployment URL */
@@ -91,8 +91,8 @@ export interface Domain {
   deployment: string | null; // Mutable - can be updated to point to different deployment
   /** Current domain status */
   status: DomainStatusType; // Mutable - can be updated
-  /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators) */
-  tags?: string[];
+  /** Optional array of labels for categorization and filtering (lowercase, alphanumeric with separators) */
+  labels?: string[];
   /** The domain URL - internal (subdomain) or external (custom domain) */
   readonly url: string;
   /** Unix timestamp (seconds) when domain was created */
@@ -204,8 +204,8 @@ export interface Token {
   readonly account: string;
   /** Optional IP address locking for security */
   readonly ip?: string;
-  /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators) */
-  tags?: string[];
+  /** Optional array of labels for categorization and filtering (lowercase, alphanumeric with separators) */
+  labels?: string[];
   /** Unix timestamp (seconds) when token was created */
   readonly created: number;
   /** Unix timestamp (seconds) when token expires, or null for never */
@@ -272,6 +272,8 @@ export interface Account {
   readonly created: number;
   /** Unix timestamp (seconds) when account was activated (first deployment) */
   readonly activated?: number;
+  /** Last 4 characters of the API key for identification (null when no key generated) */
+  readonly hint?: string;
 }
 
 /**
@@ -777,6 +779,7 @@ export interface PingResponse {
 export const API_KEY_PREFIX = 'ship-';
 export const API_KEY_HEX_LENGTH = 64;
 export const API_KEY_TOTAL_LENGTH = API_KEY_PREFIX.length + API_KEY_HEX_LENGTH; // 69
+export const API_KEY_HINT_LENGTH = 4;
 
 // Deploy Token Configuration
 export const DEPLOY_TOKEN_PREFIX = 'token-';
@@ -1003,8 +1006,8 @@ export type DeployInput = File[] | string | string[];
  * SDK implementations may extend with additional options (timeout, signal, callbacks, etc.).
  */
 export interface DeploymentCreateOptions {
-  /** Optional tags for categorization and filtering */
-  tags?: string[];
+  /** Optional labels for categorization and filtering */
+  labels?: string[];
   /** Optional subdomain suggestion for the deployment */
   subdomain?: string;
   /** Client identifier (e.g., 'cli', 'sdk', 'web') */
@@ -1018,7 +1021,7 @@ export interface DeploymentResource {
   create: (input: DeployInput, options?: DeploymentCreateOptions) => Promise<Deployment>;
   list: () => Promise<DeploymentListResponse>;
   get: (id: string) => Promise<Deployment>;
-  set: (id: string, options: { tags: string[] }) => Promise<Deployment>;
+  set: (id: string, options: { labels: string[] }) => Promise<Deployment>;
   remove: (id: string) => Promise<void>;
 }
 
@@ -1026,7 +1029,7 @@ export interface DeploymentResource {
  * Domain resource interface - the contract all implementations must follow
  */
 export interface DomainResource {
-  set: (name: string, options?: { deployment?: string; tags?: string[] }) => Promise<Domain>;
+  set: (name: string, options?: { deployment?: string; labels?: string[] }) => Promise<Domain>;
   list: () => Promise<DomainListResponse>;
   get: (name: string) => Promise<Domain>;
   remove: (name: string) => Promise<void>;
@@ -1048,7 +1051,7 @@ export interface AccountResource {
  * Token resource interface - the contract all implementations must follow
  */
 export interface TokenResource {
-  create: (options?: { ttl?: number; tags?: string[] }) => Promise<TokenCreateResponse>;
+  create: (options?: { ttl?: number; labels?: string[] }) => Promise<TokenCreateResponse>;
   list: () => Promise<TokenListResponse>;
   remove: (token: string) => Promise<void>;
 }
@@ -1149,7 +1152,7 @@ export type ActivityEvent =
   | 'admin.account.plan.update'
   | 'admin.account.ref.update'
   | 'admin.account.billing.update'
-  | 'admin.account.tags.update'
+  | 'admin.account.labels.update'
   | 'admin.deployment.delete'
   | 'admin.domain.delete'
   | 'admin.billing.sync'
@@ -1224,8 +1227,8 @@ export interface ActivityMeta {
   wasVerified?: boolean;
   /** Previous deployment ID before relinking */
   previousDeployment?: string;
-  /** Tags that were set/updated */
-  tags?: string[];
+  /** Labels that were set/updated */
+  labels?: string[];
 
   // Account events
   /** OAuth provider name */
@@ -1421,59 +1424,59 @@ export function generateDomainUrl(domain: string): string {
 }
 
 // =============================================================================
-// TAG UTILITIES
+// LABEL UTILITIES
 // =============================================================================
 
 /**
- * Tag validation constraints shared across UI and API.
- * These rules define the single source of truth for tag validation.
+ * Label validation constraints shared across UI and API.
+ * These rules define the single source of truth for label validation.
  */
-export const TAG_CONSTRAINTS = {
-  /** Minimum tag length in characters */
+export const LABEL_CONSTRAINTS = {
+  /** Minimum label length in characters */
   MIN_LENGTH: 3,
-  /** Maximum tag length in characters (concise tags, matches Stack Overflow's original limit) */
+  /** Maximum label length in characters (concise labels, matches Stack Overflow's original limit) */
   MAX_LENGTH: 25,
-  /** Maximum number of tags allowed per resource */
+  /** Maximum number of labels allowed per resource */
   MAX_COUNT: 10,
-  /** Allowed separator characters between tag segments */
+  /** Allowed separator characters between label segments */
   SEPARATORS: '._-',
 } as const;
 
 /**
- * Tag validation pattern.
+ * Label validation pattern.
  * Must start and end with alphanumeric (a-z, 0-9).
  * Can contain separators (. _ -) between segments, but not consecutive.
  *
  * Valid examples: 'production', 'v1.2.3', 'api_v2', 'us-east-1'
  * Invalid examples: 'ab' (too short), '-prod' (starts with separator), 'foo--bar' (consecutive separators)
  */
-export const TAG_PATTERN = /^[a-z0-9]+(?:[._-][a-z0-9]+)*$/;
+export const LABEL_PATTERN = /^[a-z0-9]+(?:[._-][a-z0-9]+)*$/;
 
 /**
- * Serialize tags array to JSON string for database storage.
+ * Serialize labels array to JSON string for database storage.
  * Returns null for empty or undefined arrays.
  *
- * @example serializeTags(['web', 'production']) → '["web","production"]'
- * @example serializeTags([]) → null
- * @example serializeTags(undefined) → null
+ * @example serializeLabels(['web', 'production']) → '["web","production"]'
+ * @example serializeLabels([]) → null
+ * @example serializeLabels(undefined) → null
  */
-export function serializeTags(tags: string[] | undefined): string | null {
-  if (!tags || tags.length === 0) return null;
-  return JSON.stringify(tags);
+export function serializeLabels(labels: string[] | undefined): string | null {
+  if (!labels || labels.length === 0) return null;
+  return JSON.stringify(labels);
 }
 
 /**
- * Deserialize tags from JSON string to array.
+ * Deserialize labels from JSON string to array.
  * Returns undefined for null/empty strings.
  *
- * @example deserializeTags('["web","production"]') → ['web', 'production']
- * @example deserializeTags(null) → undefined
- * @example deserializeTags('') → undefined
+ * @example deserializeLabels('["web","production"]') → ['web', 'production']
+ * @example deserializeLabels(null) → undefined
+ * @example deserializeLabels('') → undefined
  */
-export function deserializeTags(tagsJson: string | null): string[] | undefined {
-  if (!tagsJson) return undefined;
+export function deserializeLabels(labelsJson: string | null): string[] | undefined {
+  if (!labelsJson) return undefined;
   try {
-    const parsed = JSON.parse(tagsJson);
+    const parsed = JSON.parse(labelsJson);
     return Array.isArray(parsed) && parsed.length > 0 ? parsed : undefined;
   } catch {
     return undefined;