@cloudflare/deploy-helpers 0.1.0 → 0.1.2

package/dist/index.d.mts

@@ -1,7 +1,24 @@
 import { ContainerNormalizedConfig } from '@cloudflare/containers-shared';
-import { Config, Entry, AssetsOptions, CfPlacement, EphemeralDirectory, LegacyAssetPaths, Route } from '@cloudflare/workers-utils';
+import { FetchResultFetcher, FetchListResultFetcher, Logger, Config, Entry, AssetsOptions, CfPlacement, EphemeralDirectory, LegacyAssetPaths, Route, ComplianceConfig, ZoneIdRoute, ZoneNameRoute, CustomDomainRoute } from '@cloudflare/workers-utils';
 import { NodeJSCompatMode } from 'miniflare';
 
+/**
+ * client needs to handle logger and fetch/auth implementation
+ * these are passed into this package to handle any API requests/logs
+ */
+type DeployHelpersContext = {
+    fetchResult: FetchResultFetcher;
+    fetchListResult: FetchListResultFetcher;
+    logger: Logger;
+    confirm: (text: string, options?: {
+        defaultValue?: boolean;
+        fallbackValue?: boolean;
+    }) => Promise<boolean>;
+    prompt: (text: string, options?: {
+        defaultValue?: string;
+    }) => Promise<string>;
+    isNonInteractiveOrCI: () => boolean;
+};
 /**
  * Shared fields produced by merging CLI args with wrangler config.
  * After this point, no raw config/arg merging should happen.
@@ -101,5 +118,177 @@ type VersionsUploadProps = SharedDeployVersionsProps & {
     /** CLI-only (--preview-alias), or auto-generated from CI branch name. */
     previewAlias: string | undefined;
 };
+interface TriggerDeployment {
+    targets: string[];
+    error?: Error;
+}
+type TriggerProps = {
+    config: Config;
+    accountId: string;
+    scriptName: string;
+    env: string | undefined;
+    crons: string[] | undefined;
+    routes: Route[];
+    useServiceEnvironments: boolean;
+    firstDeploy: boolean;
+};
+
+declare function triggersDeploy(props: TriggerProps, ctx: DeployHelpersContext): Promise<string[] | void>;
+declare function getSubdomainValues(config_workers_dev: boolean | undefined, config_preview_urls: boolean | undefined, routes: Route[]): {
+    workers_dev: boolean;
+    preview_urls?: boolean;
+};
+declare function getSubdomainValuesAPIMock(config_workers_dev: boolean | undefined, config_preview_urls: boolean | undefined, routes: Route[]): {
+    workers_dev: boolean;
+    preview_urls: boolean;
+};
+
+type WorkersDevSubdomainRegistrationContext = "workers_dev" | "workflows";
+type GetWorkersDevSubdomainOptions = {
+    configPath?: string | undefined;
+    abortSignal?: AbortSignal | undefined;
+    registrationContext?: WorkersDevSubdomainRegistrationContext | undefined;
+};
+/**
+ * Gets the <user-subdomain>.(fed.)workers.dev URL for the given account.
+ */
+declare function getWorkersDevSubdomain(complianceConfig: ComplianceConfig, accountId: string, ctx: DeployHelpersContext, options?: GetWorkersDevSubdomainOptions): Promise<string>;
+
+interface Zone {
+    id: string;
+    host: string;
+}
+type ZoneIdCache = Map<string, Promise<string | null>>;
+declare function getZoneForRoute(complianceConfig: ComplianceConfig, from: {
+    route: Route;
+    accountId: string;
+}, ctx: DeployHelpersContext, zoneIdCache?: ZoneIdCache): Promise<Zone | undefined>;
+/**
+ * Given something that resembles a host, try to infer a zone id from it.
+ *
+ * It's hard to get a 'valid' domain from a string, so we don't even try to validate TLDs, etc.
+ * For each domain-like part of the host (e.g. w.x.y.z) try to get a zone id for it by
+ * lopping off subdomains until we get a hit from the API.
+ */
+declare function getZoneIdFromHost(complianceConfig: ComplianceConfig, from: {
+    host: string;
+    accountId: string;
+}, ctx: DeployHelpersContext, zoneIdCache?: ZoneIdCache): Promise<string>;
+
+type RouteObject = ZoneIdRoute | ZoneNameRoute | CustomDomainRoute;
+type CustomDomain = {
+    id: string;
+    zone_id: string;
+    zone_name: string;
+    hostname: string;
+    service: string;
+    environment: string;
+    enabled: boolean;
+    previews_enabled: boolean;
+};
+type UpdatedCustomDomain = CustomDomain & {
+    modified: boolean;
+};
+type ConflictingCustomDomain = CustomDomain & {
+    external_dns_record_id?: string | null;
+    external_cert_id?: string;
+};
+type CustomDomainChangeset = {
+    added: CustomDomain[];
+    removed: CustomDomain[];
+    updated: UpdatedCustomDomain[];
+    conflicting: ConflictingCustomDomain[];
+};
+declare function renderRoute(route: Route): string;
+/**
+ * Associate the newly deployed Worker with the given routes.
+ */
+declare function publishRoutes(complianceConfig: ComplianceConfig, routes: Route[], { workerUrl, scriptName, useServiceEnvironments, accountId, }: {
+    workerUrl: string;
+    scriptName: string;
+    useServiceEnvironments: boolean;
+    accountId: string;
+}, ctx: DeployHelpersContext): Promise<string[]>;
+declare function publishCustomDomains(complianceConfig: ComplianceConfig, workerUrl: string, accountId: string, domains: Array<RouteObject>, ctx: DeployHelpersContext): Promise<TriggerDeployment>;
+
+interface PostQueueBody {
+    queue_name: string;
+    settings?: QueueSettings;
+}
+interface QueueSettings {
+    delivery_delay?: number;
+    delivery_paused?: boolean;
+    message_retention_period?: number;
+}
+interface PostQueueResponse {
+    queue_id: string;
+    queue_name: string;
+    settings?: QueueSettings;
+    created_on: string;
+    modified_on: string;
+}
+interface QueueResponse {
+    queue_id: string;
+    queue_name: string;
+    created_on: string;
+    modified_on: string;
+    producers: Producer[];
+    producers_total_count: number;
+    consumers: Consumer[];
+    consumers_total_count: number;
+    settings?: QueueSettings;
+}
+interface ScriptReference {
+    namespace?: string;
+    script?: string;
+    service?: string;
+    environment?: string;
+}
+type Producer = ScriptReference & {
+    type: string;
+    bucket_name?: string;
+};
+type Consumer = ScriptReference & {
+    dead_letter_queue?: string;
+    settings: ConsumerSettings;
+    consumer_id: string;
+    bucket_name?: string;
+    type: string;
+};
+interface TypedConsumerResponse extends Consumer {
+    queue_name: string;
+    created_on: string;
+}
+interface PostTypedConsumerBody {
+    type: string;
+    script_name?: string;
+    environment_name?: string;
+    settings: ConsumerSettings;
+    dead_letter_queue?: string;
+}
+interface ConsumerSettings {
+    batch_size?: number;
+    max_retries?: number;
+    max_wait_time_ms?: number;
+    max_concurrency?: number | null;
+    visibility_timeout_ms?: number;
+    retry_delay?: number;
+}
+interface PurgeQueueBody {
+    delete_messages_permanently: boolean;
+}
+interface PurgeQueueResponse {
+    started_at: string;
+    complete: boolean;
+}
+declare function listQueues(complianceConfig: ComplianceConfig, accountId: string, ctx: DeployHelpersContext, page?: number, name?: string): Promise<QueueResponse[]>;
+declare function getQueue(complianceConfig: ComplianceConfig, accountId: string, queueName: string, ctx: DeployHelpersContext): Promise<QueueResponse>;
+declare function postConsumer(complianceConfig: ComplianceConfig, accountId: string, queueName: string, body: PostTypedConsumerBody, ctx: DeployHelpersContext): Promise<TypedConsumerResponse>;
+declare function putConsumerById(complianceConfig: ComplianceConfig, accountId: string, queueId: string, consumerId: string, body: PostTypedConsumerBody, ctx: DeployHelpersContext): Promise<TypedConsumerResponse>;
+declare function putConsumer(complianceConfig: ComplianceConfig, accountId: string, queueName: string, scriptName: string, envName: string | undefined, body: PostTypedConsumerBody, ctx: DeployHelpersContext): Promise<TypedConsumerResponse>;
+declare function deletePullConsumer(complianceConfig: ComplianceConfig, accountId: string, queueName: string, ctx: DeployHelpersContext): Promise<void>;
+declare function listConsumers(complianceConfig: ComplianceConfig, accountId: string, queueName: string, ctx: DeployHelpersContext): Promise<Consumer[]>;
+declare function deleteWorkerConsumer(complianceConfig: ComplianceConfig, accountId: string, queueName: string, scriptName: string, envName: string | undefined, ctx: DeployHelpersContext): Promise<void>;
+declare function updateQueueConsumers(complianceConfig: ComplianceConfig, accountId: string, scriptName: string, config: Config, ctx: DeployHelpersContext): Promise<Promise<TriggerDeployment>[]>;
 
-export type { DeployProps, SharedDeployVersionsProps, VersionsUploadProps };
+export { type Consumer, type ConsumerSettings, type CustomDomain, type CustomDomainChangeset, type DeployHelpersContext, type DeployProps, type PostQueueBody, type PostQueueResponse, type PostTypedConsumerBody, type Producer, type PurgeQueueBody, type PurgeQueueResponse, type QueueResponse, type QueueSettings, type RouteObject, type ScriptReference, type SharedDeployVersionsProps, type TriggerDeployment, type TriggerProps, type TypedConsumerResponse, type VersionsUploadProps, type Zone, type ZoneIdCache, deletePullConsumer, deleteWorkerConsumer, getQueue, getSubdomainValues, getSubdomainValuesAPIMock, getWorkersDevSubdomain, getZoneForRoute, getZoneIdFromHost, listConsumers, listQueues, postConsumer, publishCustomDomains, publishRoutes, putConsumer, putConsumerById, renderRoute, triggersDeploy, updateQueueConsumers };