@shipstatic/ship 3.6.0 → 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/README.md +13 -3
- package/THIRD-PARTY-LICENSES.md +1 -1
- package/dist/browser.d.ts +95 -34
- package/dist/browser.js +2 -1
- package/dist/browser.js.map +1 -1
- package/dist/cli.cjs +57 -56
- package/dist/cli.cjs.map +1 -1
- package/dist/index.cjs +2 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +95 -34
- package/dist/index.d.ts +95 -34
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
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`.
|
|
@@ -648,7 +685,10 @@ interface DomainValidateResponse {
|
|
|
648
685
|
interface Token {
|
|
649
686
|
/** 7-char management identifier (e.g., "a1b2c3d") */
|
|
650
687
|
readonly token: string;
|
|
651
|
-
/**
|
|
688
|
+
/**
|
|
689
|
+
* The token's labels, which every deployment it uploads is also born with,
|
|
690
|
+
* ahead of the upload's own. Always present, empty array when none.
|
|
691
|
+
*/
|
|
652
692
|
labels: string[];
|
|
653
693
|
/** Unix timestamp (seconds) when token was created */
|
|
654
694
|
readonly created: number;
|
|
@@ -1127,6 +1167,8 @@ declare const API_PATHS: {
|
|
|
1127
1167
|
readonly DEPLOYMENTS: "/deployments";
|
|
1128
1168
|
readonly DEPLOYMENT: (deployment: string) => string;
|
|
1129
1169
|
readonly DEPLOYMENT_CONFIG: (deployment: string) => string;
|
|
1170
|
+
/** Fills a declared deployment with more of its files. */
|
|
1171
|
+
readonly DEPLOYMENT_FILES: (deployment: string) => string;
|
|
1130
1172
|
readonly DOMAINS: "/domains";
|
|
1131
1173
|
readonly DOMAIN: (domain: string) => string;
|
|
1132
1174
|
readonly DOMAIN_VERIFY: (domain: string) => string;
|
|
@@ -1167,8 +1209,11 @@ declare const API_PATHS: {
|
|
|
1167
1209
|
declare const DEPLOY_FIELDS: {
|
|
1168
1210
|
/** One entry per file — read with `getAll`. */
|
|
1169
1211
|
readonly FILES: "files[]";
|
|
1170
|
-
/**
|
|
1171
|
-
|
|
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";
|
|
1172
1217
|
/** JSON array of label strings. */
|
|
1173
1218
|
readonly LABELS: "labels";
|
|
1174
1219
|
/** The deploying surface's {@link DeploymentVia} member. */
|
|
@@ -1198,6 +1243,19 @@ declare const DEPLOY_FIELDS: {
|
|
|
1198
1243
|
/** @internal reCAPTCHA proof — `web/www`'s public uploader only. */
|
|
1199
1244
|
readonly CAPTCHA: "captcha";
|
|
1200
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
|
+
}
|
|
1201
1259
|
/**
|
|
1202
1260
|
* The JSON deploy body's file grammar: the OTHER body both deploy doors
|
|
1203
1261
|
* accept, beside the multipart one {@link DEPLOY_FIELDS} names. A JSON caller
|
|
@@ -2186,14 +2244,16 @@ interface Journey {
|
|
|
2186
2244
|
* them.
|
|
2187
2245
|
*
|
|
2188
2246
|
* ```ts
|
|
2189
|
-
* doors.login({ token, next: '/claim/abc' })
|
|
2190
|
-
* // '/login/<token>?next=%2Fclaim%2Fabc'
|
|
2247
|
+
* doors.login.link({ token, next: '/claim/abc' })
|
|
2248
|
+
* // '/login/link/<token>?next=%2Fclaim%2Fabc'
|
|
2191
2249
|
* ```
|
|
2192
2250
|
*/
|
|
2193
2251
|
declare const doors: {
|
|
2194
|
-
readonly login: ({
|
|
2195
|
-
|
|
2196
|
-
|
|
2252
|
+
readonly login: (({ next }?: Journey) => string) & {
|
|
2253
|
+
link: ({ token, next }: Journey & {
|
|
2254
|
+
readonly token: string;
|
|
2255
|
+
}) => string;
|
|
2256
|
+
};
|
|
2197
2257
|
readonly register: ({ next }?: Journey) => string;
|
|
2198
2258
|
readonly logout: ({ next }?: Journey) => string;
|
|
2199
2259
|
readonly invitation: (invitation: string) => string;
|
|
@@ -2215,7 +2275,7 @@ declare function accountOfPath(path: string): string | null;
|
|
|
2215
2275
|
* The door a path names, or null for an account place or the operator
|
|
2216
2276
|
* partition. Every question about doors reads this one answer: which page is
|
|
2217
2277
|
* an auth page, which errand a destination carries, what a vendor must not
|
|
2218
|
-
* 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
|
|
2219
2279
|
* invitation door: a door's object is the rest of its path.
|
|
2220
2280
|
*/
|
|
2221
2281
|
declare function doorOf(path: string): DoorSegment | null;
|
|
@@ -2436,8 +2496,9 @@ interface DeploymentUploadOptions {
|
|
|
2436
2496
|
* commit sha, a uuid minted before the first try — never one minted fresh
|
|
2437
2497
|
* on each retry, which would defeat the point.
|
|
2438
2498
|
*
|
|
2439
|
-
*
|
|
2440
|
-
*
|
|
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.
|
|
2441
2502
|
*/
|
|
2442
2503
|
idempotencyKey?: string;
|
|
2443
2504
|
}
|
|
@@ -3097,9 +3158,9 @@ interface DeployBodyContext {
|
|
|
3097
3158
|
*/
|
|
3098
3159
|
via?: DeploymentViaType;
|
|
3099
3160
|
/**
|
|
3100
|
-
* Optional plaintext password to protect the deployment
|
|
3101
|
-
*
|
|
3102
|
-
*
|
|
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.
|
|
3103
3164
|
*/
|
|
3104
3165
|
password?: string;
|
|
3105
3166
|
/**
|
|
@@ -3318,6 +3379,11 @@ declare class SimpleEvents {
|
|
|
3318
3379
|
emit<K extends keyof ShipEvents>(event: K, ...args: ShipEvents[K]): void;
|
|
3319
3380
|
}
|
|
3320
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;
|
|
3321
3387
|
interface ApiHttpOptions extends ShipClientOptions {
|
|
3322
3388
|
/** Resolves the credential slot per request — async so token providers can mint/refresh. */
|
|
3323
3389
|
getAuthHeaders: () => Record<string, string> | Promise<Record<string, string>>;
|
|
@@ -3355,23 +3421,26 @@ interface DeployTransport {
|
|
|
3355
3421
|
*/
|
|
3356
3422
|
interface Transport {
|
|
3357
3423
|
request<T>(path: string, options: ShipRequestInit, operationName: string, timeoutMs?: number): Promise<T>;
|
|
3358
|
-
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>>;
|
|
3359
3425
|
readonly deploy: DeployTransport;
|
|
3360
3426
|
}
|
|
3361
3427
|
/**
|
|
3362
3428
|
* A request as THIS client composes one.
|
|
3363
3429
|
*
|
|
3364
|
-
*
|
|
3365
|
-
*
|
|
3366
|
-
*
|
|
3367
|
-
*
|
|
3368
|
-
*
|
|
3369
|
-
* them. Narrowing at RUNTIME instead would have turned an unreachable case
|
|
3370
|
-
* into a SILENT no-retry — a deploy that quietly stopped replaying because
|
|
3371
|
-
* 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.
|
|
3372
3435
|
*/
|
|
3373
3436
|
type ShipRequestInit = Omit<RequestInit, 'headers'> & {
|
|
3374
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;
|
|
3375
3444
|
};
|
|
3376
3445
|
declare class ApiHttp extends SimpleEvents implements Transport {
|
|
3377
3446
|
private readonly apiUrl;
|
|
@@ -3422,14 +3491,6 @@ declare class ApiHttp extends SimpleEvents implements Transport {
|
|
|
3422
3491
|
* is one that may be sent twice.
|
|
3423
3492
|
*/
|
|
3424
3493
|
private isRetryable;
|
|
3425
|
-
/**
|
|
3426
|
-
* Did this request carry the header that makes a repeat safe?
|
|
3427
|
-
*
|
|
3428
|
-
* Case-insensitively, because HTTP field names are — the CLI's env tier and
|
|
3429
|
-
* the SDK option both spell it canonically, but a caller composing headers
|
|
3430
|
-
* by hand is entitled not to.
|
|
3431
|
-
*/
|
|
3432
|
-
private hasIdempotencyKey;
|
|
3433
3494
|
/**
|
|
3434
3495
|
* One attempt: headers, timeout signal, the `request`/`response` events, and
|
|
3435
3496
|
* error normalization.
|
|
@@ -3453,7 +3514,7 @@ declare class ApiHttp extends SimpleEvents implements Transport {
|
|
|
3453
3514
|
* the answer: a domain upsert says create-or-update in its 201/200 and
|
|
3454
3515
|
* nowhere else in the response.
|
|
3455
3516
|
*/
|
|
3456
|
-
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>>;
|
|
3457
3518
|
private mergeHeaders;
|
|
3458
3519
|
private createTimeoutSignal;
|
|
3459
3520
|
private safeClone;
|
|
@@ -3913,7 +3974,7 @@ declare function pluralize(count: number, singular: string, plural: string, incl
|
|
|
3913
3974
|
* @file The Node half of the deploy pipeline: finding files on a filesystem.
|
|
3914
3975
|
*
|
|
3915
3976
|
* Everything after the finding is shared (`shared/core/deploy-files.ts`) —
|
|
3916
|
-
* path optimization, junk filtering, the platform's rules, the
|
|
3977
|
+
* path optimization, junk filtering, the platform's rules, the digests.
|
|
3917
3978
|
* What is genuinely Node here is a directory walk with symlink-cycle
|
|
3918
3979
|
* protection, a content path computed against the upload root, and the fact
|
|
3919
3980
|
* that a Node user can point at a project folder and mean `dist/`.
|
|
@@ -3984,6 +4045,6 @@ declare class Ship extends Ship$1 {
|
|
|
3984
4045
|
}
|
|
3985
4046
|
|
|
3986
4047
|
declare namespace Ship {
|
|
3987
|
-
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 };
|
|
3988
4049
|
}
|
|
3989
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`.
|
|
@@ -648,7 +685,10 @@ interface DomainValidateResponse {
|
|
|
648
685
|
interface Token {
|
|
649
686
|
/** 7-char management identifier (e.g., "a1b2c3d") */
|
|
650
687
|
readonly token: string;
|
|
651
|
-
/**
|
|
688
|
+
/**
|
|
689
|
+
* The token's labels, which every deployment it uploads is also born with,
|
|
690
|
+
* ahead of the upload's own. Always present, empty array when none.
|
|
691
|
+
*/
|
|
652
692
|
labels: string[];
|
|
653
693
|
/** Unix timestamp (seconds) when token was created */
|
|
654
694
|
readonly created: number;
|
|
@@ -1127,6 +1167,8 @@ declare const API_PATHS: {
|
|
|
1127
1167
|
readonly DEPLOYMENTS: "/deployments";
|
|
1128
1168
|
readonly DEPLOYMENT: (deployment: string) => string;
|
|
1129
1169
|
readonly DEPLOYMENT_CONFIG: (deployment: string) => string;
|
|
1170
|
+
/** Fills a declared deployment with more of its files. */
|
|
1171
|
+
readonly DEPLOYMENT_FILES: (deployment: string) => string;
|
|
1130
1172
|
readonly DOMAINS: "/domains";
|
|
1131
1173
|
readonly DOMAIN: (domain: string) => string;
|
|
1132
1174
|
readonly DOMAIN_VERIFY: (domain: string) => string;
|
|
@@ -1167,8 +1209,11 @@ declare const API_PATHS: {
|
|
|
1167
1209
|
declare const DEPLOY_FIELDS: {
|
|
1168
1210
|
/** One entry per file — read with `getAll`. */
|
|
1169
1211
|
readonly FILES: "files[]";
|
|
1170
|
-
/**
|
|
1171
|
-
|
|
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";
|
|
1172
1217
|
/** JSON array of label strings. */
|
|
1173
1218
|
readonly LABELS: "labels";
|
|
1174
1219
|
/** The deploying surface's {@link DeploymentVia} member. */
|
|
@@ -1198,6 +1243,19 @@ declare const DEPLOY_FIELDS: {
|
|
|
1198
1243
|
/** @internal reCAPTCHA proof — `web/www`'s public uploader only. */
|
|
1199
1244
|
readonly CAPTCHA: "captcha";
|
|
1200
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
|
+
}
|
|
1201
1259
|
/**
|
|
1202
1260
|
* The JSON deploy body's file grammar: the OTHER body both deploy doors
|
|
1203
1261
|
* accept, beside the multipart one {@link DEPLOY_FIELDS} names. A JSON caller
|
|
@@ -2186,14 +2244,16 @@ interface Journey {
|
|
|
2186
2244
|
* them.
|
|
2187
2245
|
*
|
|
2188
2246
|
* ```ts
|
|
2189
|
-
* doors.login({ token, next: '/claim/abc' })
|
|
2190
|
-
* // '/login/<token>?next=%2Fclaim%2Fabc'
|
|
2247
|
+
* doors.login.link({ token, next: '/claim/abc' })
|
|
2248
|
+
* // '/login/link/<token>?next=%2Fclaim%2Fabc'
|
|
2191
2249
|
* ```
|
|
2192
2250
|
*/
|
|
2193
2251
|
declare const doors: {
|
|
2194
|
-
readonly login: ({
|
|
2195
|
-
|
|
2196
|
-
|
|
2252
|
+
readonly login: (({ next }?: Journey) => string) & {
|
|
2253
|
+
link: ({ token, next }: Journey & {
|
|
2254
|
+
readonly token: string;
|
|
2255
|
+
}) => string;
|
|
2256
|
+
};
|
|
2197
2257
|
readonly register: ({ next }?: Journey) => string;
|
|
2198
2258
|
readonly logout: ({ next }?: Journey) => string;
|
|
2199
2259
|
readonly invitation: (invitation: string) => string;
|
|
@@ -2215,7 +2275,7 @@ declare function accountOfPath(path: string): string | null;
|
|
|
2215
2275
|
* The door a path names, or null for an account place or the operator
|
|
2216
2276
|
* partition. Every question about doors reads this one answer: which page is
|
|
2217
2277
|
* an auth page, which errand a destination carries, what a vendor must not
|
|
2218
|
-
* 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
|
|
2219
2279
|
* invitation door: a door's object is the rest of its path.
|
|
2220
2280
|
*/
|
|
2221
2281
|
declare function doorOf(path: string): DoorSegment | null;
|
|
@@ -2436,8 +2496,9 @@ interface DeploymentUploadOptions {
|
|
|
2436
2496
|
* commit sha, a uuid minted before the first try — never one minted fresh
|
|
2437
2497
|
* on each retry, which would defeat the point.
|
|
2438
2498
|
*
|
|
2439
|
-
*
|
|
2440
|
-
*
|
|
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.
|
|
2441
2502
|
*/
|
|
2442
2503
|
idempotencyKey?: string;
|
|
2443
2504
|
}
|
|
@@ -3097,9 +3158,9 @@ interface DeployBodyContext {
|
|
|
3097
3158
|
*/
|
|
3098
3159
|
via?: DeploymentViaType;
|
|
3099
3160
|
/**
|
|
3100
|
-
* Optional plaintext password to protect the deployment
|
|
3101
|
-
*
|
|
3102
|
-
*
|
|
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.
|
|
3103
3164
|
*/
|
|
3104
3165
|
password?: string;
|
|
3105
3166
|
/**
|
|
@@ -3318,6 +3379,11 @@ declare class SimpleEvents {
|
|
|
3318
3379
|
emit<K extends keyof ShipEvents>(event: K, ...args: ShipEvents[K]): void;
|
|
3319
3380
|
}
|
|
3320
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;
|
|
3321
3387
|
interface ApiHttpOptions extends ShipClientOptions {
|
|
3322
3388
|
/** Resolves the credential slot per request — async so token providers can mint/refresh. */
|
|
3323
3389
|
getAuthHeaders: () => Record<string, string> | Promise<Record<string, string>>;
|
|
@@ -3355,23 +3421,26 @@ interface DeployTransport {
|
|
|
3355
3421
|
*/
|
|
3356
3422
|
interface Transport {
|
|
3357
3423
|
request<T>(path: string, options: ShipRequestInit, operationName: string, timeoutMs?: number): Promise<T>;
|
|
3358
|
-
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>>;
|
|
3359
3425
|
readonly deploy: DeployTransport;
|
|
3360
3426
|
}
|
|
3361
3427
|
/**
|
|
3362
3428
|
* A request as THIS client composes one.
|
|
3363
3429
|
*
|
|
3364
|
-
*
|
|
3365
|
-
*
|
|
3366
|
-
*
|
|
3367
|
-
*
|
|
3368
|
-
*
|
|
3369
|
-
* them. Narrowing at RUNTIME instead would have turned an unreachable case
|
|
3370
|
-
* into a SILENT no-retry — a deploy that quietly stopped replaying because
|
|
3371
|
-
* 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.
|
|
3372
3435
|
*/
|
|
3373
3436
|
type ShipRequestInit = Omit<RequestInit, 'headers'> & {
|
|
3374
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;
|
|
3375
3444
|
};
|
|
3376
3445
|
declare class ApiHttp extends SimpleEvents implements Transport {
|
|
3377
3446
|
private readonly apiUrl;
|
|
@@ -3422,14 +3491,6 @@ declare class ApiHttp extends SimpleEvents implements Transport {
|
|
|
3422
3491
|
* is one that may be sent twice.
|
|
3423
3492
|
*/
|
|
3424
3493
|
private isRetryable;
|
|
3425
|
-
/**
|
|
3426
|
-
* Did this request carry the header that makes a repeat safe?
|
|
3427
|
-
*
|
|
3428
|
-
* Case-insensitively, because HTTP field names are — the CLI's env tier and
|
|
3429
|
-
* the SDK option both spell it canonically, but a caller composing headers
|
|
3430
|
-
* by hand is entitled not to.
|
|
3431
|
-
*/
|
|
3432
|
-
private hasIdempotencyKey;
|
|
3433
3494
|
/**
|
|
3434
3495
|
* One attempt: headers, timeout signal, the `request`/`response` events, and
|
|
3435
3496
|
* error normalization.
|
|
@@ -3453,7 +3514,7 @@ declare class ApiHttp extends SimpleEvents implements Transport {
|
|
|
3453
3514
|
* the answer: a domain upsert says create-or-update in its 201/200 and
|
|
3454
3515
|
* nowhere else in the response.
|
|
3455
3516
|
*/
|
|
3456
|
-
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>>;
|
|
3457
3518
|
private mergeHeaders;
|
|
3458
3519
|
private createTimeoutSignal;
|
|
3459
3520
|
private safeClone;
|
|
@@ -3913,7 +3974,7 @@ declare function pluralize(count: number, singular: string, plural: string, incl
|
|
|
3913
3974
|
* @file The Node half of the deploy pipeline: finding files on a filesystem.
|
|
3914
3975
|
*
|
|
3915
3976
|
* Everything after the finding is shared (`shared/core/deploy-files.ts`) —
|
|
3916
|
-
* path optimization, junk filtering, the platform's rules, the
|
|
3977
|
+
* path optimization, junk filtering, the platform's rules, the digests.
|
|
3917
3978
|
* What is genuinely Node here is a directory walk with symlink-cycle
|
|
3918
3979
|
* protection, a content path computed against the upload root, and the fact
|
|
3919
3980
|
* that a Node user can point at a project folder and mean `dist/`.
|
|
@@ -3983,4 +4044,4 @@ declare class Ship extends Ship$1 {
|
|
|
3983
4044
|
protected processInput(input: DeployInput, options: DeploymentOptions, limits: PlatformLimits): Promise<StaticFile[]>;
|
|
3984
4045
|
}
|
|
3985
4046
|
|
|
3986
|
-
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 };
|