@shipstatic/types 0.8.6 → 0.8.8

package/dist/index.d.ts

@@ -585,6 +585,17 @@ export interface DeploymentUploadOptions {
     labels?: string[];
     /** Client identifier (e.g., 'cli', 'sdk', 'web') */
     via?: string;
+    /**
+     * Optional password that gates public access to 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.
+     */
+    password?: string;
     /** @internal Trigger server-side build. Only available via /upload endpoint. */
     build?: boolean;
     /** @internal Trigger server-side prerender. Only available via /upload endpoint. */
@@ -912,3 +923,17 @@ export declare function serializeLabels(labels: string[] | undefined): string |
  * @example deserializeLabels('') → []
  */
 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.
+ */
+export declare const PASSWORD_CONSTRAINTS: {
+    /** Minimum password length in characters */
+    readonly MIN_LENGTH: 6;
+    /** Maximum password length in characters */
+    readonly MAX_LENGTH: 128;
+};

package/dist/index.js

@@ -512,3 +512,20 @@ export function deserializeLabels(labelsJson) {
         return [];
     }
 }
+// =============================================================================
+// 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.
+ */
+export const PASSWORD_CONSTRAINTS = {
+    /** Minimum password length in characters */
+    MIN_LENGTH: 6,
+    /** Maximum password length in characters */
+    MAX_LENGTH: 128,
+};

package/package.json

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

package/src/index.ts

@@ -888,6 +888,17 @@ export interface DeploymentUploadOptions {
   labels?: string[];
   /** Client identifier (e.g., 'cli', 'sdk', 'web') */
   via?: string;
+  /**
+   * Optional password that gates public access to 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.
+   */
+  password?: string;
   /** @internal Trigger server-side build. Only available via /upload endpoint. */
   build?: boolean;
   /** @internal Trigger server-side prerender. Only available via /upload endpoint. */
@@ -1351,4 +1362,23 @@ export function deserializeLabels(labelsJson: string | null): string[] {
   } catch {
     return [];
   }
-}
+}
+
+// =============================================================================
+// 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.
+ */
+export const PASSWORD_CONSTRAINTS = {
+  /** Minimum password length in characters */
+  MIN_LENGTH: 6,
+  /** Maximum password length in characters */
+  MAX_LENGTH: 128,
+} as const;