@shipstatic/types 0.8.8 → 0.8.10

package/dist/index.d.ts

@@ -26,8 +26,10 @@ export interface Deployment {
     readonly size: number;
     /** Current deployment status */
     status: DeploymentStatusType;
-    /** Whether deployment has configuration */
+    /** Whether deployment has a ship.json config */
     readonly config: boolean;
+    /** Whether deployment has a password set */
+    readonly password: boolean;
     /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */
     labels: string[];
     /** The client/tool used to create this deployment (e.g., 'web', 'sdk', 'cli'), null if unknown */
@@ -586,14 +588,13 @@ export interface DeploymentUploadOptions {
     /** Client identifier (e.g., 'cli', 'sdk', 'web') */
     via?: string;
     /**
-     * Optional password that gates public access to this deployment.
+     * Optional password that protects this deployment.
      *
      * Length: {@link PASSWORD_CONSTRAINTS.MIN_LENGTH} to
-     * {@link PASSWORD_CONSTRAINTS.MAX_LENGTH} characters. Plaintext on the wire;
-     * the API hashes it once (SHA-256) and stores the hex digest. The Router
-     * serves a lock page to visitors who don't present the matching cookie. If
-     * the deployment is linked to a custom domain, the same gate applies there
-     * too. Revocation is redeployment.
+     * {@link PASSWORD_CONSTRAINTS.MAX_LENGTH} characters; whitespace is
+     * significant. Visitors are prompted to enter the password before they can
+     * view the deployment — including on any custom domains pointing at it.
+     * To remove protection, redeploy without a password.
      */
     password?: string;
     /** @internal Trigger server-side build. Only available via /upload endpoint. */
@@ -738,8 +739,10 @@ export interface ActivityMeta {
     files?: number;
     /** Total size in bytes */
     size?: number;
-    /** Whether deployment has config */
+    /** Whether deployment has a ship.json config */
     hasConfig?: boolean;
+    /** Whether deployment has a password set */
+    hasPassword?: boolean;
     /** Whether this was an update (vs create) */
     isUpdate?: boolean;
     /** Whether domain was already verified */
@@ -924,12 +927,9 @@ export declare function serializeLabels(labels: string[] | undefined): string |
  */
 export declare function deserializeLabels(labelsJson: string | null): string[];
 /**
- * Deployment password validation constraints, shared across UI, SDK, and API.
- * Single source of truth for the length rule applied to the optional
- * `DeploymentUploadOptions.password` field.
- *
- * Plaintext is hashed once server-side (SHA-256) and never persisted in its
- * original form; see `cloudflare/shared/password.ts` for the protocol.
+ * Length constraints for the optional deployment password
+ * (`DeploymentUploadOptions.password`). Single source of truth shared across
+ * platform consumers.
  */
 export declare const PASSWORD_CONSTRAINTS: {
     /** Minimum password length in characters */

package/dist/index.js

@@ -516,12 +516,9 @@ export function deserializeLabels(labelsJson) {
 // PASSWORD UTILITIES
 // =============================================================================
 /**
- * Deployment password validation constraints, shared across UI, SDK, and API.
- * Single source of truth for the length rule applied to the optional
- * `DeploymentUploadOptions.password` field.
- *
- * Plaintext is hashed once server-side (SHA-256) and never persisted in its
- * original form; see `cloudflare/shared/password.ts` for the protocol.
+ * Length constraints for the optional deployment password
+ * (`DeploymentUploadOptions.password`). Single source of truth shared across
+ * platform consumers.
  */
 export const PASSWORD_CONSTRAINTS = {
     /** Minimum password length in characters */

package/package.json

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

package/src/index.ts

@@ -33,8 +33,10 @@ export interface Deployment {
   readonly size: number;
   /** Current deployment status */
   status: DeploymentStatusType; // Mutable - can be updated
-  /** Whether deployment has configuration */
+  /** Whether deployment has a ship.json config */
   readonly config: boolean;
+  /** Whether deployment has a password set */
+  readonly password: boolean;
   /** Labels for categorization and filtering (lowercase, alphanumeric with separators). Always present, empty array when none. */
   labels: string[];
   /** The client/tool used to create this deployment (e.g., 'web', 'sdk', 'cli'), null if unknown */
@@ -889,14 +891,13 @@ export interface DeploymentUploadOptions {
   /** Client identifier (e.g., 'cli', 'sdk', 'web') */
   via?: string;
   /**
-   * Optional password that gates public access to this deployment.
+   * Optional password that protects this deployment.
    *
    * Length: {@link PASSWORD_CONSTRAINTS.MIN_LENGTH} to
-   * {@link PASSWORD_CONSTRAINTS.MAX_LENGTH} characters. Plaintext on the wire;
-   * the API hashes it once (SHA-256) and stores the hex digest. The Router
-   * serves a lock page to visitors who don't present the matching cookie. If
-   * the deployment is linked to a custom domain, the same gate applies there
-   * too. Revocation is redeployment.
+   * {@link PASSWORD_CONSTRAINTS.MAX_LENGTH} characters; whitespace is
+   * significant. Visitors are prompted to enter the password before they can
+   * view the deployment — including on any custom domains pointing at it.
+   * To remove protection, redeploy without a password.
    */
   password?: string;
   /** @internal Trigger server-side build. Only available via /upload endpoint. */
@@ -1113,8 +1114,10 @@ export interface ActivityMeta {
   files?: number;
   /** Total size in bytes */
   size?: number;
-  /** Whether deployment has config */
+  /** Whether deployment has a ship.json config */
   hasConfig?: boolean;
+  /** Whether deployment has a password set */
+  hasPassword?: boolean;
 
   // Domain events
   /** Whether this was an update (vs create) */
@@ -1369,12 +1372,9 @@ export function deserializeLabels(labelsJson: string | null): string[] {
 // =============================================================================
 
 /**
- * Deployment password validation constraints, shared across UI, SDK, and API.
- * Single source of truth for the length rule applied to the optional
- * `DeploymentUploadOptions.password` field.
- *
- * Plaintext is hashed once server-side (SHA-256) and never persisted in its
- * original form; see `cloudflare/shared/password.ts` for the protocol.
+ * Length constraints for the optional deployment password
+ * (`DeploymentUploadOptions.password`). Single source of truth shared across
+ * platform consumers.
  */
 export const PASSWORD_CONSTRAINTS = {
   /** Minimum password length in characters */