@shipstatic/ship 3.6.1 → 3.7.0-beta.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.cts CHANGED
@@ -222,6 +222,9 @@ interface DeploymentListResponse extends ListResponse {
222
222
  *
223
223
  * No prose either (`message`): an acknowledgement is data, and each surface
224
224
  * composes its own copy.
225
+ *
226
+ * It states where the deployment IS, not what the call did: a repeat finds
227
+ * the row already `deleting` and answers this same object again, at 202.
225
228
  */
226
229
  interface DeploymentDeleteResponse {
227
230
  /** The deployment hostname that was marked for removal */
@@ -546,6 +549,40 @@ declare const IDEMPOTENCY_KEY_CONSTRAINTS: {
546
549
  /** How long a stored 201 stays replayable. */
547
550
  readonly WINDOW_SECONDS: number;
548
551
  };
552
+ /**
553
+ * The most one deploy request may carry, and the framing a client counts
554
+ * toward it. A deployment larger than one request arrives in several: a
555
+ * declaration with its {@link DEPLOY_FIELDS.MANIFEST}, then
556
+ * {@link API_PATHS.DEPLOYMENT_FILES} for the rest.
557
+ *
558
+ * Framing, not plan policy, which is why it is static rather than delivered
559
+ * by `/limits`: a client splitting at a smaller number is always correct.
560
+ *
561
+ * **`MAX_BYTES` is a one-way door.** This package is bundled into every
562
+ * published client, so an installed client keeps its cap forever. Raising it
563
+ * is free (an older client splits smaller, which is always valid); lowering
564
+ * it turns every installed client's largest request into a refusal.
565
+ *
566
+ * 64 MiB because it holds the largest file any plan allows (50 MiB) with its
567
+ * framing, keeps a request inside the API's memory, finishes within the
568
+ * SDK's request timeout at 2.5 Mbit/s, and sits under the edge's 100 MiB
569
+ * request limit. Measured on the development environment at the boundary
570
+ * (2026-10-18), a request of exactly 64 MiB, one 50 MiB file and 14 MiB of
571
+ * others, stored in under half a second of CPU, sent with or without a
572
+ * `Content-Length`, alone or two at once. What a request costs when its
573
+ * files are rewritten is the API's to bound, and it does so per file.
574
+ */
575
+ declare const DEPLOY_REQUEST_CONSTRAINTS: {
576
+ /** The most one deploy request may carry, as `Content-Length` counts it. */
577
+ readonly MAX_BYTES: number;
578
+ /**
579
+ * The most multipart framing one part adds beyond its bytes and its name,
580
+ * and the body's closing delimiter at most the same. A ceiling by the
581
+ * multipart standard (a boundary is at most 70 characters), not a
582
+ * measurement.
583
+ */
584
+ readonly PART_OVERHEAD: 256;
585
+ };
549
586
  /**
550
587
  * Normalize a `via` value from any transport — trimmed, lowercased, and a
551
588
  * member of {@link DeploymentVia}, or `undefined`.
@@ -1130,6 +1167,8 @@ declare const API_PATHS: {
1130
1167
  readonly DEPLOYMENTS: "/deployments";
1131
1168
  readonly DEPLOYMENT: (deployment: string) => string;
1132
1169
  readonly DEPLOYMENT_CONFIG: (deployment: string) => string;
1170
+ /** Fills a declared deployment with more of its files. */
1171
+ readonly DEPLOYMENT_FILES: (deployment: string) => string;
1133
1172
  readonly DOMAINS: "/domains";
1134
1173
  readonly DOMAIN: (domain: string) => string;
1135
1174
  readonly DOMAIN_VERIFY: (domain: string) => string;
@@ -1170,8 +1209,11 @@ declare const API_PATHS: {
1170
1209
  declare const DEPLOY_FIELDS: {
1171
1210
  /** One entry per file — read with `getAll`. */
1172
1211
  readonly FILES: "files[]";
1173
- /** JSON array of MD5 hex digests, index-aligned with `FILES`. */
1174
- readonly CHECKSUMS: "checksums";
1212
+ /**
1213
+ * JSON array of {@link ManifestEntry}, one per file of the deployment: its
1214
+ * declaration. Optional; a request without one is the whole deployment.
1215
+ */
1216
+ readonly MANIFEST: "manifest";
1175
1217
  /** JSON array of label strings. */
1176
1218
  readonly LABELS: "labels";
1177
1219
  /** The deploying surface's {@link DeploymentVia} member. */
@@ -1201,6 +1243,19 @@ declare const DEPLOY_FIELDS: {
1201
1243
  /** @internal reCAPTCHA proof — `web/www`'s public uploader only. */
1202
1244
  readonly CAPTCHA: "captcha";
1203
1245
  };
1246
+ /**
1247
+ * One file of a deployment's declaration ({@link DEPLOY_FIELDS.MANIFEST}).
1248
+ * The wire shape both ends share and nothing more: the API owns what makes a
1249
+ * manifest valid, and a client builds one from files it has already checked.
1250
+ */
1251
+ interface ManifestEntry {
1252
+ /** The deploy path, relative to the deployment root, no leading slash. */
1253
+ path: string;
1254
+ /** The file's size in bytes. */
1255
+ size: number;
1256
+ /** The MD5 of the file's bytes, 32 lowercase hex characters. */
1257
+ md5: string;
1258
+ }
1204
1259
  /**
1205
1260
  * The JSON deploy body's file grammar: the OTHER body both deploy doors
1206
1261
  * accept, beside the multipart one {@link DEPLOY_FIELDS} names. A JSON caller
@@ -2189,14 +2244,16 @@ interface Journey {
2189
2244
  * them.
2190
2245
  *
2191
2246
  * ```ts
2192
- * doors.login({ token, next: '/claim/abc' })
2193
- * // '/login/<token>?next=%2Fclaim%2Fabc'
2247
+ * doors.login.link({ token, next: '/claim/abc' })
2248
+ * // '/login/link/<token>?next=%2Fclaim%2Fabc'
2194
2249
  * ```
2195
2250
  */
2196
2251
  declare const doors: {
2197
- readonly login: ({ token, next }?: Journey & {
2198
- readonly token?: string;
2199
- }) => string;
2252
+ readonly login: (({ next }?: Journey) => string) & {
2253
+ link: ({ token, next }: Journey & {
2254
+ readonly token: string;
2255
+ }) => string;
2256
+ };
2200
2257
  readonly register: ({ next }?: Journey) => string;
2201
2258
  readonly logout: ({ next }?: Journey) => string;
2202
2259
  readonly invitation: (invitation: string) => string;
@@ -2218,7 +2275,7 @@ declare function accountOfPath(path: string): string | null;
2218
2275
  * The door a path names, or null for an account place or the operator
2219
2276
  * partition. Every question about doors reads this one answer: which page is
2220
2277
  * an auth page, which errand a destination carries, what a vendor must not
2221
- * see. `/login/<token>` is the login door, as `/invitation/<id>` is the
2278
+ * see. `/login/link/<token>` is the login door, as `/invitation/<id>` is the
2222
2279
  * invitation door: a door's object is the rest of its path.
2223
2280
  */
2224
2281
  declare function doorOf(path: string): DoorSegment | null;
@@ -2439,8 +2496,9 @@ interface DeploymentUploadOptions {
2439
2496
  * commit sha, a uuid minted before the first try — never one minted fresh
2440
2497
  * on each retry, which would defeat the point.
2441
2498
  *
2442
- * The replay is per-caller, and it stores successes only: a failed deploy
2443
- * retries fresh under the same key.
2499
+ * A key replays within the account that sent it; an anonymous key is
2500
+ * ignored, and each anonymous deploy is a new deployment. Only successes
2501
+ * replay: a failed deploy retries fresh under the same key.
2444
2502
  */
2445
2503
  idempotencyKey?: string;
2446
2504
  }
@@ -3100,9 +3158,9 @@ interface DeployBodyContext {
3100
3158
  */
3101
3159
  via?: DeploymentViaType;
3102
3160
  /**
3103
- * Optional plaintext password to protect the deployment.
3104
- * Length: `PASSWORD_CONSTRAINTS.MIN_LENGTH` to `PASSWORD_CONSTRAINTS.MAX_LENGTH`
3105
- * characters. Whitespace is preserved verbatim — significant.
3161
+ * Optional plaintext password to protect the deployment, already through
3162
+ * `validatePassword`, which trims it: the body sends the value the rule
3163
+ * judged, and the API trims and judges it the same way.
3106
3164
  */
3107
3165
  password?: string;
3108
3166
  /**
@@ -3321,6 +3379,11 @@ declare class SimpleEvents {
3321
3379
  emit<K extends keyof ShipEvents>(event: K, ...args: ShipEvents[K]): void;
3322
3380
  }
3323
3381
 
3382
+ /**
3383
+ * The slowest upload a deploy request is sized for, in bits a second. Stated
3384
+ * here, beside the one ceiling this client derives from it.
3385
+ */
3386
+ declare const UPLOAD_FLOOR_BITS_PER_SECOND = 2500000;
3324
3387
  interface ApiHttpOptions extends ShipClientOptions {
3325
3388
  /** Resolves the credential slot per request — async so token providers can mint/refresh. */
3326
3389
  getAuthHeaders: () => Record<string, string> | Promise<Record<string, string>>;
@@ -3358,23 +3421,26 @@ interface DeployTransport {
3358
3421
  */
3359
3422
  interface Transport {
3360
3423
  request<T>(path: string, options: ShipRequestInit, operationName: string, timeoutMs?: number): Promise<T>;
3361
- requestWithStatus<T>(path: string, options: ShipRequestInit, operationName: string): Promise<RequestResult<T>>;
3424
+ requestWithStatus<T>(path: string, options: ShipRequestInit, operationName: string, timeoutMs?: number): Promise<RequestResult<T>>;
3362
3425
  readonly deploy: DeployTransport;
3363
3426
  }
3364
3427
  /**
3365
3428
  * A request as THIS client composes one.
3366
3429
  *
3367
- * Identical to `RequestInit` but for the headers, which are narrowed from the
3368
- * DOM's three-shaped `HeadersInit` to the one shape every call site here
3369
- * actually builds. That narrowing is load-bearing twice over: `mergeHeaders`
3370
- * used to reach its record through an `as` cast, and `hasIdempotencyKey` used
3371
- * to walk all three shapes to find a key that only ever arrives in one of
3372
- * them. Narrowing at RUNTIME instead would have turned an unreachable case
3373
- * into a SILENT no-retry — a deploy that quietly stopped replaying because
3374
- * someone handed the transport a `Headers`. Here that is a compile error.
3430
+ * `RequestInit`, with the headers narrowed from the DOM's three-shaped
3431
+ * `HeadersInit` to the one shape every call site here builds (so
3432
+ * `mergeHeaders` composes a record without a cast), and one field of its
3433
+ * own: `idempotent`, which the resource that knows the request is safe to
3434
+ * repeat sets, and the retry rule reads. The transport never infers it.
3375
3435
  */
3376
3436
  type ShipRequestInit = Omit<RequestInit, 'headers'> & {
3377
3437
  headers?: Record<string, string>;
3438
+ /**
3439
+ * The request may be sent twice with the same effect: a fill (every fill
3440
+ * is safe to repeat), or a declaration carrying an `Idempotency-Key`, which
3441
+ * the API answers with the deployment the key names.
3442
+ */
3443
+ idempotent?: boolean;
3378
3444
  };
3379
3445
  declare class ApiHttp extends SimpleEvents implements Transport {
3380
3446
  private readonly apiUrl;
@@ -3425,14 +3491,6 @@ declare class ApiHttp extends SimpleEvents implements Transport {
3425
3491
  * is one that may be sent twice.
3426
3492
  */
3427
3493
  private isRetryable;
3428
- /**
3429
- * Did this request carry the header that makes a repeat safe?
3430
- *
3431
- * Case-insensitively, because HTTP field names are — the CLI's env tier and
3432
- * the SDK option both spell it canonically, but a caller composing headers
3433
- * by hand is entitled not to.
3434
- */
3435
- private hasIdempotencyKey;
3436
3494
  /**
3437
3495
  * One attempt: headers, timeout signal, the `request`/`response` events, and
3438
3496
  * error normalization.
@@ -3456,7 +3514,7 @@ declare class ApiHttp extends SimpleEvents implements Transport {
3456
3514
  * the answer: a domain upsert says create-or-update in its 201/200 and
3457
3515
  * nowhere else in the response.
3458
3516
  */
3459
- requestWithStatus<T>(path: string, options: ShipRequestInit, operationName: string): Promise<RequestResult<T>>;
3517
+ requestWithStatus<T>(path: string, options: ShipRequestInit, operationName: string, timeoutMs?: number): Promise<RequestResult<T>>;
3460
3518
  private mergeHeaders;
3461
3519
  private createTimeoutSignal;
3462
3520
  private safeClone;
@@ -3916,7 +3974,7 @@ declare function pluralize(count: number, singular: string, plural: string, incl
3916
3974
  * @file The Node half of the deploy pipeline: finding files on a filesystem.
3917
3975
  *
3918
3976
  * Everything after the finding is shared (`shared/core/deploy-files.ts`) —
3919
- * path optimization, junk filtering, the platform's rules, the checksums.
3977
+ * path optimization, junk filtering, the platform's rules, the digests.
3920
3978
  * What is genuinely Node here is a directory walk with symlink-cycle
3921
3979
  * protection, a content path computed against the upload root, and the fact
3922
3980
  * that a Node user can point at a project folder and mean `dist/`.
@@ -3987,6 +4045,6 @@ declare class Ship extends Ship$1 {
3987
4045
  }
3988
4046
 
3989
4047
  declare namespace Ship {
3990
- export { ACCOUNT_HEADER, API_KEY, API_PATHS, AUTH_BASE_PATH, Account, AccountAccess, AccountDeleteResponse, AccountKeyResponse, AccountPlan, AccountPlanType, AccountRefusal, AccountRefusalType, AccountResource, AccountRole, AccountUsage, Activity, ActivityEvent, ActivityListResponse, ActivityMeta, ApiDeployOptions, ApiHttp, ApiHttpOptions, AuthMethod, AuthMethodType, BUILD_SETTINGS, BillingInterval, BillingPortalSession, BillingSyncResponse, BuildFailureDetails, CALLER, Caps, ConsoleErrand, ConsolePaths, ConsoleSection, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_FIELDS, DEPLOY_FILE_GRAMMAR, DEPLOY_TOKEN, DeployBodyContext, DeployFile, DeployFileEncoding, DeployFileSpec, DeployInput, DeployTransport, Deployment, DeploymentCreateResponse, DeploymentDeleteResponse, DeploymentListResponse, DeploymentOptions, DeploymentResource, DeploymentResourceContext, DeploymentSetOptions, DeploymentStatus, DeploymentStatusType, DeploymentUploadOptions, DeploymentVia, DeploymentViaType, DnsLookup, DnsProvider, DnsRecord, DnsRecordType, Domain, DomainDeleteResponse, DomainDnsResponse, DomainListResponse, DomainRecordsResponse, DomainResource, DomainSetOptions, DomainSetResult, DomainShareResponse, DomainStatus, DomainStatusType, DomainValidateResponse, DomainVerification, DomainVerificationType, DomainVerifyResponse, DoorSegment, ErrorResponse, ErrorType, ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, Fetch, FileValidationResult, FileValidationStatus, FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, LabelsResponse, ListOptions, ListResponse, MD5Result, MY_API_KEY_URL, OAUTH_TOKEN, OAuthScope, OAuthScopeType, PASSWORD_CONSTRAINTS, PUBLIC_DEPLOYMENT_TTL_SECONDS, PingResponse, Plan, PlanChangeRefusalDetails, PlanChangeRequest, PlanChangeResponse, PlanDestination, PlansResponse, PlatformLimitKey, PlatformLimits, RequestResult, ResourceContext, SECTIONS, SETUP_TROUBLESHOOTING_ANCHOR, SHIP_ENV, SHIP_VIA_ENV, SPACheckRequest, SPACheckResponse, SPA_CHECK_CONSTRAINTS, SPA_DEFAULT_CONFIG, ScheduledChange, SettingsFragment, SetupInstructionsResponse, ShipClientOptions, ShipError, ShipEvents, ShipRequestInit, StaticFile, TTL_CONSTRAINTS, Token, TokenCreateOptions, TokenCreateResponse, TokenDeleteResponse, TokenKind, TokenKindType, TokenListResponse, TokenProvider, TokenResource, Transport, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, USAGE_KIND, USER_VISIBLE_EVENTS, UploadedFile, UserVisibleActivityEvent, ValidatableFile, ValidationIssue, WEB_FILE_ACCEPT, __setTestEnvironment, accountOfPath, allValidFilesReady, assertShipJsonSyntax, billingReturnOf, calculateMD5, classifyToken, consolePaths, countPhrase, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, deserializeLabels, doorOf, doors, errandOf, excessOver, extractSubdomain, filterJunk, fitPhrase, formatDuration, formatFileSize, formatTimeRemaining, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isClaimPath, isCustomDomain, isDeployment, isPlatformDomain, isShipError, isUpgradePath, normalizeVia, optimizeDeployPaths, personName, personShortName, placesTaken, pluralize, processFilesForNode, readBearerValue, serializeLabels, validateApiKey, validateApiUrl, validateBuildCommand, validateCaller, validateDeployCount, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validateLabel, validateLabels, validateOAuthToken, validateOutputDir, validatePassword, validateToken, validateTtl };
4048
+ export { ACCOUNT_HEADER, API_KEY, API_PATHS, AUTH_BASE_PATH, Account, AccountAccess, AccountDeleteResponse, AccountKeyResponse, AccountPlan, AccountPlanType, AccountRefusal, AccountRefusalType, AccountResource, AccountRole, AccountUsage, Activity, ActivityEvent, ActivityListResponse, ActivityMeta, ApiDeployOptions, ApiHttp, ApiHttpOptions, AuthMethod, AuthMethodType, BUILD_SETTINGS, BillingInterval, BillingPortalSession, BillingSyncResponse, BuildFailureDetails, CALLER, Caps, ConsoleErrand, ConsolePaths, ConsoleSection, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_FIELDS, DEPLOY_FILE_GRAMMAR, DEPLOY_REQUEST_CONSTRAINTS, DEPLOY_TOKEN, DeployBodyContext, DeployFile, DeployFileEncoding, DeployFileSpec, DeployInput, DeployTransport, Deployment, DeploymentCreateResponse, DeploymentDeleteResponse, DeploymentListResponse, DeploymentOptions, DeploymentResource, DeploymentResourceContext, DeploymentSetOptions, DeploymentStatus, DeploymentStatusType, DeploymentUploadOptions, DeploymentVia, DeploymentViaType, DnsLookup, DnsProvider, DnsRecord, DnsRecordType, Domain, DomainDeleteResponse, DomainDnsResponse, DomainListResponse, DomainRecordsResponse, DomainResource, DomainSetOptions, DomainSetResult, DomainShareResponse, DomainStatus, DomainStatusType, DomainValidateResponse, DomainVerification, DomainVerificationType, DomainVerifyResponse, DoorSegment, ErrorResponse, ErrorType, ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, Fetch, FileValidationResult, FileValidationStatus, FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, LabelsResponse, ListOptions, ListResponse, MD5Result, MY_API_KEY_URL, ManifestEntry, OAUTH_TOKEN, OAuthScope, OAuthScopeType, PASSWORD_CONSTRAINTS, PUBLIC_DEPLOYMENT_TTL_SECONDS, PingResponse, Plan, PlanChangeRefusalDetails, PlanChangeRequest, PlanChangeResponse, PlanDestination, PlansResponse, PlatformLimitKey, PlatformLimits, RequestResult, ResourceContext, SECTIONS, SETUP_TROUBLESHOOTING_ANCHOR, SHIP_ENV, SHIP_VIA_ENV, SPACheckRequest, SPACheckResponse, SPA_CHECK_CONSTRAINTS, SPA_DEFAULT_CONFIG, ScheduledChange, SettingsFragment, SetupInstructionsResponse, ShipClientOptions, ShipError, ShipEvents, ShipRequestInit, StaticFile, TTL_CONSTRAINTS, Token, TokenCreateOptions, TokenCreateResponse, TokenDeleteResponse, TokenKind, TokenKindType, TokenListResponse, TokenProvider, TokenResource, Transport, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, UPLOAD_FLOOR_BITS_PER_SECOND, USAGE_KIND, USER_VISIBLE_EVENTS, UploadedFile, UserVisibleActivityEvent, ValidatableFile, ValidationIssue, WEB_FILE_ACCEPT, __setTestEnvironment, accountOfPath, allValidFilesReady, assertShipJsonSyntax, billingReturnOf, calculateMD5, classifyToken, consolePaths, countPhrase, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, deserializeLabels, doorOf, doors, errandOf, excessOver, extractSubdomain, filterJunk, fitPhrase, formatDuration, formatFileSize, formatTimeRemaining, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isClaimPath, isCustomDomain, isDeployment, isPlatformDomain, isShipError, isUpgradePath, normalizeVia, optimizeDeployPaths, personName, personShortName, placesTaken, pluralize, processFilesForNode, readBearerValue, serializeLabels, validateApiKey, validateApiUrl, validateBuildCommand, validateCaller, validateDeployCount, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validateLabel, validateLabels, validateOAuthToken, validateOutputDir, validatePassword, validateToken, validateTtl };
3991
4049
  }
3992
4050
  export = Ship;
package/dist/index.d.ts CHANGED
@@ -222,6 +222,9 @@ interface DeploymentListResponse extends ListResponse {
222
222
  *
223
223
  * No prose either (`message`): an acknowledgement is data, and each surface
224
224
  * composes its own copy.
225
+ *
226
+ * It states where the deployment IS, not what the call did: a repeat finds
227
+ * the row already `deleting` and answers this same object again, at 202.
225
228
  */
226
229
  interface DeploymentDeleteResponse {
227
230
  /** The deployment hostname that was marked for removal */
@@ -546,6 +549,40 @@ declare const IDEMPOTENCY_KEY_CONSTRAINTS: {
546
549
  /** How long a stored 201 stays replayable. */
547
550
  readonly WINDOW_SECONDS: number;
548
551
  };
552
+ /**
553
+ * The most one deploy request may carry, and the framing a client counts
554
+ * toward it. A deployment larger than one request arrives in several: a
555
+ * declaration with its {@link DEPLOY_FIELDS.MANIFEST}, then
556
+ * {@link API_PATHS.DEPLOYMENT_FILES} for the rest.
557
+ *
558
+ * Framing, not plan policy, which is why it is static rather than delivered
559
+ * by `/limits`: a client splitting at a smaller number is always correct.
560
+ *
561
+ * **`MAX_BYTES` is a one-way door.** This package is bundled into every
562
+ * published client, so an installed client keeps its cap forever. Raising it
563
+ * is free (an older client splits smaller, which is always valid); lowering
564
+ * it turns every installed client's largest request into a refusal.
565
+ *
566
+ * 64 MiB because it holds the largest file any plan allows (50 MiB) with its
567
+ * framing, keeps a request inside the API's memory, finishes within the
568
+ * SDK's request timeout at 2.5 Mbit/s, and sits under the edge's 100 MiB
569
+ * request limit. Measured on the development environment at the boundary
570
+ * (2026-10-18), a request of exactly 64 MiB, one 50 MiB file and 14 MiB of
571
+ * others, stored in under half a second of CPU, sent with or without a
572
+ * `Content-Length`, alone or two at once. What a request costs when its
573
+ * files are rewritten is the API's to bound, and it does so per file.
574
+ */
575
+ declare const DEPLOY_REQUEST_CONSTRAINTS: {
576
+ /** The most one deploy request may carry, as `Content-Length` counts it. */
577
+ readonly MAX_BYTES: number;
578
+ /**
579
+ * The most multipart framing one part adds beyond its bytes and its name,
580
+ * and the body's closing delimiter at most the same. A ceiling by the
581
+ * multipart standard (a boundary is at most 70 characters), not a
582
+ * measurement.
583
+ */
584
+ readonly PART_OVERHEAD: 256;
585
+ };
549
586
  /**
550
587
  * Normalize a `via` value from any transport — trimmed, lowercased, and a
551
588
  * member of {@link DeploymentVia}, or `undefined`.
@@ -1130,6 +1167,8 @@ declare const API_PATHS: {
1130
1167
  readonly DEPLOYMENTS: "/deployments";
1131
1168
  readonly DEPLOYMENT: (deployment: string) => string;
1132
1169
  readonly DEPLOYMENT_CONFIG: (deployment: string) => string;
1170
+ /** Fills a declared deployment with more of its files. */
1171
+ readonly DEPLOYMENT_FILES: (deployment: string) => string;
1133
1172
  readonly DOMAINS: "/domains";
1134
1173
  readonly DOMAIN: (domain: string) => string;
1135
1174
  readonly DOMAIN_VERIFY: (domain: string) => string;
@@ -1170,8 +1209,11 @@ declare const API_PATHS: {
1170
1209
  declare const DEPLOY_FIELDS: {
1171
1210
  /** One entry per file — read with `getAll`. */
1172
1211
  readonly FILES: "files[]";
1173
- /** JSON array of MD5 hex digests, index-aligned with `FILES`. */
1174
- readonly CHECKSUMS: "checksums";
1212
+ /**
1213
+ * JSON array of {@link ManifestEntry}, one per file of the deployment: its
1214
+ * declaration. Optional; a request without one is the whole deployment.
1215
+ */
1216
+ readonly MANIFEST: "manifest";
1175
1217
  /** JSON array of label strings. */
1176
1218
  readonly LABELS: "labels";
1177
1219
  /** The deploying surface's {@link DeploymentVia} member. */
@@ -1201,6 +1243,19 @@ declare const DEPLOY_FIELDS: {
1201
1243
  /** @internal reCAPTCHA proof — `web/www`'s public uploader only. */
1202
1244
  readonly CAPTCHA: "captcha";
1203
1245
  };
1246
+ /**
1247
+ * One file of a deployment's declaration ({@link DEPLOY_FIELDS.MANIFEST}).
1248
+ * The wire shape both ends share and nothing more: the API owns what makes a
1249
+ * manifest valid, and a client builds one from files it has already checked.
1250
+ */
1251
+ interface ManifestEntry {
1252
+ /** The deploy path, relative to the deployment root, no leading slash. */
1253
+ path: string;
1254
+ /** The file's size in bytes. */
1255
+ size: number;
1256
+ /** The MD5 of the file's bytes, 32 lowercase hex characters. */
1257
+ md5: string;
1258
+ }
1204
1259
  /**
1205
1260
  * The JSON deploy body's file grammar: the OTHER body both deploy doors
1206
1261
  * accept, beside the multipart one {@link DEPLOY_FIELDS} names. A JSON caller
@@ -2189,14 +2244,16 @@ interface Journey {
2189
2244
  * them.
2190
2245
  *
2191
2246
  * ```ts
2192
- * doors.login({ token, next: '/claim/abc' })
2193
- * // '/login/<token>?next=%2Fclaim%2Fabc'
2247
+ * doors.login.link({ token, next: '/claim/abc' })
2248
+ * // '/login/link/<token>?next=%2Fclaim%2Fabc'
2194
2249
  * ```
2195
2250
  */
2196
2251
  declare const doors: {
2197
- readonly login: ({ token, next }?: Journey & {
2198
- readonly token?: string;
2199
- }) => string;
2252
+ readonly login: (({ next }?: Journey) => string) & {
2253
+ link: ({ token, next }: Journey & {
2254
+ readonly token: string;
2255
+ }) => string;
2256
+ };
2200
2257
  readonly register: ({ next }?: Journey) => string;
2201
2258
  readonly logout: ({ next }?: Journey) => string;
2202
2259
  readonly invitation: (invitation: string) => string;
@@ -2218,7 +2275,7 @@ declare function accountOfPath(path: string): string | null;
2218
2275
  * The door a path names, or null for an account place or the operator
2219
2276
  * partition. Every question about doors reads this one answer: which page is
2220
2277
  * an auth page, which errand a destination carries, what a vendor must not
2221
- * see. `/login/<token>` is the login door, as `/invitation/<id>` is the
2278
+ * see. `/login/link/<token>` is the login door, as `/invitation/<id>` is the
2222
2279
  * invitation door: a door's object is the rest of its path.
2223
2280
  */
2224
2281
  declare function doorOf(path: string): DoorSegment | null;
@@ -2439,8 +2496,9 @@ interface DeploymentUploadOptions {
2439
2496
  * commit sha, a uuid minted before the first try — never one minted fresh
2440
2497
  * on each retry, which would defeat the point.
2441
2498
  *
2442
- * The replay is per-caller, and it stores successes only: a failed deploy
2443
- * retries fresh under the same key.
2499
+ * A key replays within the account that sent it; an anonymous key is
2500
+ * ignored, and each anonymous deploy is a new deployment. Only successes
2501
+ * replay: a failed deploy retries fresh under the same key.
2444
2502
  */
2445
2503
  idempotencyKey?: string;
2446
2504
  }
@@ -3100,9 +3158,9 @@ interface DeployBodyContext {
3100
3158
  */
3101
3159
  via?: DeploymentViaType;
3102
3160
  /**
3103
- * Optional plaintext password to protect the deployment.
3104
- * Length: `PASSWORD_CONSTRAINTS.MIN_LENGTH` to `PASSWORD_CONSTRAINTS.MAX_LENGTH`
3105
- * characters. Whitespace is preserved verbatim — significant.
3161
+ * Optional plaintext password to protect the deployment, already through
3162
+ * `validatePassword`, which trims it: the body sends the value the rule
3163
+ * judged, and the API trims and judges it the same way.
3106
3164
  */
3107
3165
  password?: string;
3108
3166
  /**
@@ -3321,6 +3379,11 @@ declare class SimpleEvents {
3321
3379
  emit<K extends keyof ShipEvents>(event: K, ...args: ShipEvents[K]): void;
3322
3380
  }
3323
3381
 
3382
+ /**
3383
+ * The slowest upload a deploy request is sized for, in bits a second. Stated
3384
+ * here, beside the one ceiling this client derives from it.
3385
+ */
3386
+ declare const UPLOAD_FLOOR_BITS_PER_SECOND = 2500000;
3324
3387
  interface ApiHttpOptions extends ShipClientOptions {
3325
3388
  /** Resolves the credential slot per request — async so token providers can mint/refresh. */
3326
3389
  getAuthHeaders: () => Record<string, string> | Promise<Record<string, string>>;
@@ -3358,23 +3421,26 @@ interface DeployTransport {
3358
3421
  */
3359
3422
  interface Transport {
3360
3423
  request<T>(path: string, options: ShipRequestInit, operationName: string, timeoutMs?: number): Promise<T>;
3361
- requestWithStatus<T>(path: string, options: ShipRequestInit, operationName: string): Promise<RequestResult<T>>;
3424
+ requestWithStatus<T>(path: string, options: ShipRequestInit, operationName: string, timeoutMs?: number): Promise<RequestResult<T>>;
3362
3425
  readonly deploy: DeployTransport;
3363
3426
  }
3364
3427
  /**
3365
3428
  * A request as THIS client composes one.
3366
3429
  *
3367
- * Identical to `RequestInit` but for the headers, which are narrowed from the
3368
- * DOM's three-shaped `HeadersInit` to the one shape every call site here
3369
- * actually builds. That narrowing is load-bearing twice over: `mergeHeaders`
3370
- * used to reach its record through an `as` cast, and `hasIdempotencyKey` used
3371
- * to walk all three shapes to find a key that only ever arrives in one of
3372
- * them. Narrowing at RUNTIME instead would have turned an unreachable case
3373
- * into a SILENT no-retry — a deploy that quietly stopped replaying because
3374
- * someone handed the transport a `Headers`. Here that is a compile error.
3430
+ * `RequestInit`, with the headers narrowed from the DOM's three-shaped
3431
+ * `HeadersInit` to the one shape every call site here builds (so
3432
+ * `mergeHeaders` composes a record without a cast), and one field of its
3433
+ * own: `idempotent`, which the resource that knows the request is safe to
3434
+ * repeat sets, and the retry rule reads. The transport never infers it.
3375
3435
  */
3376
3436
  type ShipRequestInit = Omit<RequestInit, 'headers'> & {
3377
3437
  headers?: Record<string, string>;
3438
+ /**
3439
+ * The request may be sent twice with the same effect: a fill (every fill
3440
+ * is safe to repeat), or a declaration carrying an `Idempotency-Key`, which
3441
+ * the API answers with the deployment the key names.
3442
+ */
3443
+ idempotent?: boolean;
3378
3444
  };
3379
3445
  declare class ApiHttp extends SimpleEvents implements Transport {
3380
3446
  private readonly apiUrl;
@@ -3425,14 +3491,6 @@ declare class ApiHttp extends SimpleEvents implements Transport {
3425
3491
  * is one that may be sent twice.
3426
3492
  */
3427
3493
  private isRetryable;
3428
- /**
3429
- * Did this request carry the header that makes a repeat safe?
3430
- *
3431
- * Case-insensitively, because HTTP field names are — the CLI's env tier and
3432
- * the SDK option both spell it canonically, but a caller composing headers
3433
- * by hand is entitled not to.
3434
- */
3435
- private hasIdempotencyKey;
3436
3494
  /**
3437
3495
  * One attempt: headers, timeout signal, the `request`/`response` events, and
3438
3496
  * error normalization.
@@ -3456,7 +3514,7 @@ declare class ApiHttp extends SimpleEvents implements Transport {
3456
3514
  * the answer: a domain upsert says create-or-update in its 201/200 and
3457
3515
  * nowhere else in the response.
3458
3516
  */
3459
- requestWithStatus<T>(path: string, options: ShipRequestInit, operationName: string): Promise<RequestResult<T>>;
3517
+ requestWithStatus<T>(path: string, options: ShipRequestInit, operationName: string, timeoutMs?: number): Promise<RequestResult<T>>;
3460
3518
  private mergeHeaders;
3461
3519
  private createTimeoutSignal;
3462
3520
  private safeClone;
@@ -3916,7 +3974,7 @@ declare function pluralize(count: number, singular: string, plural: string, incl
3916
3974
  * @file The Node half of the deploy pipeline: finding files on a filesystem.
3917
3975
  *
3918
3976
  * Everything after the finding is shared (`shared/core/deploy-files.ts`) —
3919
- * path optimization, junk filtering, the platform's rules, the checksums.
3977
+ * path optimization, junk filtering, the platform's rules, the digests.
3920
3978
  * What is genuinely Node here is a directory walk with symlink-cycle
3921
3979
  * protection, a content path computed against the upload root, and the fact
3922
3980
  * that a Node user can point at a project folder and mean `dist/`.
@@ -3986,4 +4044,4 @@ declare class Ship extends Ship$1 {
3986
4044
  protected processInput(input: DeployInput, options: DeploymentOptions, limits: PlatformLimits): Promise<StaticFile[]>;
3987
4045
  }
3988
4046
 
3989
- export { ACCOUNT_HEADER, API_KEY, API_PATHS, AUTH_BASE_PATH, type Account, type AccountAccess, type AccountDeleteResponse, type AccountKeyResponse, AccountPlan, type AccountPlanType, AccountRefusal, type AccountRefusalType, type AccountResource, type AccountRole, type AccountUsage, type Activity, type ActivityEvent, type ActivityListResponse, type ActivityMeta, type ApiDeployOptions, ApiHttp, type ApiHttpOptions, AuthMethod, type AuthMethodType, BUILD_SETTINGS, type BillingInterval, type BillingPortalSession, type BillingSyncResponse, type BuildFailureDetails, CALLER, type Caps, type ConsoleErrand, type ConsolePaths, type ConsoleSection, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_FIELDS, DEPLOY_FILE_GRAMMAR, DEPLOY_TOKEN, type DeployBodyContext, type DeployFile, type DeployFileEncoding, type DeployFileSpec, type DeployInput, type DeployTransport, type Deployment, type DeploymentCreateResponse, type DeploymentDeleteResponse, type DeploymentListResponse, type DeploymentOptions, type DeploymentResource, type DeploymentResourceContext, type DeploymentSetOptions, DeploymentStatus, type DeploymentStatusType, type DeploymentUploadOptions, DeploymentVia, type DeploymentViaType, type DnsLookup, type DnsProvider, type DnsRecord, type DnsRecordType, type Domain, type DomainDeleteResponse, type DomainDnsResponse, type DomainListResponse, type DomainRecordsResponse, type DomainResource, type DomainSetOptions, type DomainSetResult, type DomainShareResponse, DomainStatus, type DomainStatusType, type DomainValidateResponse, DomainVerification, type DomainVerificationType, type DomainVerifyResponse, type DoorSegment, type ErrorResponse, ErrorType, type ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, type Fetch, type FileValidationResult, FileValidationStatus, type FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, type LabelsResponse, type ListOptions, type ListResponse, type MD5Result, MY_API_KEY_URL, OAUTH_TOKEN, OAuthScope, type OAuthScopeType, PASSWORD_CONSTRAINTS, PUBLIC_DEPLOYMENT_TTL_SECONDS, type PingResponse, type Plan, type PlanChangeRefusalDetails, type PlanChangeRequest, type PlanChangeResponse, type PlanDestination, type PlansResponse, type PlatformLimitKey, type PlatformLimits, type RequestResult, type ResourceContext, SECTIONS, SETUP_TROUBLESHOOTING_ANCHOR, SHIP_ENV, SHIP_VIA_ENV, type SPACheckRequest, type SPACheckResponse, SPA_CHECK_CONSTRAINTS, SPA_DEFAULT_CONFIG, type ScheduledChange, type SettingsFragment, type SetupInstructionsResponse, Ship, type ShipClientOptions, ShipError, type ShipEvents, type ShipRequestInit, type StaticFile, TTL_CONSTRAINTS, type Token, type TokenCreateOptions, type TokenCreateResponse, type TokenDeleteResponse, TokenKind, type TokenKindType, type TokenListResponse, type TokenProvider, type TokenResource, type Transport, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, USAGE_KIND, USER_VISIBLE_EVENTS, type UploadedFile, type UserVisibleActivityEvent, type ValidatableFile, type ValidationIssue, WEB_FILE_ACCEPT, __setTestEnvironment, accountOfPath, allValidFilesReady, assertShipJsonSyntax, billingReturnOf, calculateMD5, classifyToken, consolePaths, countPhrase, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, Ship as default, deserializeLabels, doorOf, doors, errandOf, excessOver, extractSubdomain, filterJunk, fitPhrase, formatDuration, formatFileSize, formatTimeRemaining, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isClaimPath, isCustomDomain, isDeployment, isPlatformDomain, isShipError, isUpgradePath, normalizeVia, optimizeDeployPaths, personName, personShortName, placesTaken, pluralize, processFilesForNode, readBearerValue, serializeLabels, validateApiKey, validateApiUrl, validateBuildCommand, validateCaller, validateDeployCount, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validateLabel, validateLabels, validateOAuthToken, validateOutputDir, validatePassword, validateToken, validateTtl };
4047
+ export { ACCOUNT_HEADER, API_KEY, API_PATHS, AUTH_BASE_PATH, type Account, type AccountAccess, type AccountDeleteResponse, type AccountKeyResponse, AccountPlan, type AccountPlanType, AccountRefusal, type AccountRefusalType, type AccountResource, type AccountRole, type AccountUsage, type Activity, type ActivityEvent, type ActivityListResponse, type ActivityMeta, type ApiDeployOptions, ApiHttp, type ApiHttpOptions, AuthMethod, type AuthMethodType, BUILD_SETTINGS, type BillingInterval, type BillingPortalSession, type BillingSyncResponse, type BuildFailureDetails, CALLER, type Caps, type ConsoleErrand, type ConsolePaths, type ConsoleSection, DEFAULT_API, DEPLOYMENT_CONFIG_FILENAME, DEPLOY_FIELDS, DEPLOY_FILE_GRAMMAR, DEPLOY_REQUEST_CONSTRAINTS, DEPLOY_TOKEN, type DeployBodyContext, type DeployFile, type DeployFileEncoding, type DeployFileSpec, type DeployInput, type DeployTransport, type Deployment, type DeploymentCreateResponse, type DeploymentDeleteResponse, type DeploymentListResponse, type DeploymentOptions, type DeploymentResource, type DeploymentResourceContext, type DeploymentSetOptions, DeploymentStatus, type DeploymentStatusType, type DeploymentUploadOptions, DeploymentVia, type DeploymentViaType, type DnsLookup, type DnsProvider, type DnsRecord, type DnsRecordType, type Domain, type DomainDeleteResponse, type DomainDnsResponse, type DomainListResponse, type DomainRecordsResponse, type DomainResource, type DomainSetOptions, type DomainSetResult, type DomainShareResponse, DomainStatus, type DomainStatusType, type DomainValidateResponse, DomainVerification, type DomainVerificationType, type DomainVerifyResponse, type DoorSegment, type ErrorResponse, ErrorType, type ExecutionEnvironment, FileValidationStatus as FILE_VALIDATION_STATUS, type Fetch, type FileValidationResult, FileValidationStatus, type FileValidationStatusType, IDEMPOTENCY_KEY_CONSTRAINTS, JUNK_DIRECTORIES, LABEL_CONSTRAINTS, LABEL_PATTERN, type LabelsResponse, type ListOptions, type ListResponse, type MD5Result, MY_API_KEY_URL, type ManifestEntry, OAUTH_TOKEN, OAuthScope, type OAuthScopeType, PASSWORD_CONSTRAINTS, PUBLIC_DEPLOYMENT_TTL_SECONDS, type PingResponse, type Plan, type PlanChangeRefusalDetails, type PlanChangeRequest, type PlanChangeResponse, type PlanDestination, type PlansResponse, type PlatformLimitKey, type PlatformLimits, type RequestResult, type ResourceContext, SECTIONS, SETUP_TROUBLESHOOTING_ANCHOR, SHIP_ENV, SHIP_VIA_ENV, type SPACheckRequest, type SPACheckResponse, SPA_CHECK_CONSTRAINTS, SPA_DEFAULT_CONFIG, type ScheduledChange, type SettingsFragment, type SetupInstructionsResponse, Ship, type ShipClientOptions, ShipError, type ShipEvents, type ShipRequestInit, type StaticFile, TTL_CONSTRAINTS, type Token, type TokenCreateOptions, type TokenCreateResponse, type TokenDeleteResponse, TokenKind, type TokenKindType, type TokenListResponse, type TokenProvider, type TokenResource, type Transport, UNBUILT_PROJECT_MARKERS, UNSAFE_FILENAME_CHARS, UPLOAD_FLOOR_BITS_PER_SECOND, USAGE_KIND, USER_VISIBLE_EVENTS, type UploadedFile, type UserVisibleActivityEvent, type ValidatableFile, type ValidationIssue, WEB_FILE_ACCEPT, __setTestEnvironment, accountOfPath, allValidFilesReady, assertShipJsonSyntax, billingReturnOf, calculateMD5, classifyToken, consolePaths, countPhrase, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, Ship as default, deserializeLabels, doorOf, doors, errandOf, excessOver, extractSubdomain, filterJunk, fitPhrase, formatDuration, formatFileSize, formatTimeRemaining, generateDeploymentUrl, generateDomainUrl, getENV, getValidFiles, hasUnbuiltMarker, hasUnsafeChars, isBlockedExtension, isClaimPath, isCustomDomain, isDeployment, isPlatformDomain, isShipError, isUpgradePath, normalizeVia, optimizeDeployPaths, personName, personShortName, placesTaken, pluralize, processFilesForNode, readBearerValue, serializeLabels, validateApiKey, validateApiUrl, validateBuildCommand, validateCaller, validateDeployCount, validateDeployFile, validateDeployPath, validateDeployToken, validateFileName, validateFiles, validateIdempotencyKey, validateLabel, validateLabels, validateOAuthToken, validateOutputDir, validatePassword, validateToken, validateTtl };