@junobuild/cli-tools/dist/types/commands/deploy.d.ts

A collection of tools for Juno CLIs and Plugins.

import type { CliConfig } from '@junobuild/config';
import type { DeployParams, DeployResult, DeployResultWithProposal, UploadFileWithProposal } from '../types/deploy';
import type { ProposeChangesParams } from '../types/proposal';
/**
 * Executes all configured pre-deploy hooks defined in the Juno configuration.
 *
 * This function is typically run before uploading or deploying any assets to
 * perform validations, code generation, or other preparatory tasks.
 *
 * @param {Object} options - The function parameters.
 * @param {CliConfig} options.config - The full configuration object containing hook definitions.
 * @returns {Promise<void>} Resolves once all predeploy hooks have been executed.
 */
export declare const preDeploy: ({ config: { predeploy } }: {
    config: CliConfig;
}) => Promise<void>;
/**
 * Executes all configured post-deploy hooks defined in the Juno configuration.
 *
 * This function is typically run after a successful deployment to perform cleanup,
 * logging, or integration tasks (e.g., sending Slack notifications).
 *
 * @param {Object} options - The function parameters.
 * @param {CliConfig} options.config - The full configuration object containing hook definitions.
 * @returns {Promise<void>} Resolves once all postdeploy hooks have been executed.
 */
export declare const postDeploy: ({ config: { postdeploy } }: {
    config: CliConfig;
}) => Promise<void>;
/**
 * Prepares and uploads dapp assets to a satellite.
 *
 * This function handles:
 * 1. Resolving source files to upload.
 * 2. Verifying that enough memory is available (via `assertMemory`).
 * 3. Uploading all valid files using the provided `uploadFile` function.
 *
 * If no files are detected (e.g., all files are unchanged), the deploy is skipped.
 *
 * @param {Object} options - Deployment options.
 * @param {CliConfig} options.config - The CLI configuration object.
 * @param {ListAssets} options.listAssets - A function to list existing files on the target.
 * @param {Function} [options.assertSourceDirExists] - Optional check to ensure source directory exists.
 * @param {Function} options.assertMemory - A function to ensure enough memory is available.
 * @param {UploadFile} options.uploadFile - A function responsible for uploading a single file.
 *
 * @returns {Promise<DeployResult>} An object containing the result of the deploy:
 *   - `skipped` if no files were found.
 *   - `deployed` and a list of uploaded files if the deploy succeeded.
 */
export declare const deploy: ({ uploadFile, ...rest }: DeployParams) => Promise<DeployResult>;
/**
 * Prepares and uploads assets as part of a proposal-based workflow.
 *
 * This function:
 * 1. Prepares the list of files to be uploaded.
 * 2. If no files are found (i.e. nothing to upload), the process is skipped.
 * 3. If files exist, uploads them a proposal flow.
 * 4. Optionally commits - apply - the proposal if `autoCommit` is `true`.
 *
 * @param {Object} options - The deployment and proposal options.
 * @param {DeployParams} options.deploy - Deployment-related parameters (file system, memory check, upload function).
 * @param {Object} options.proposal - Proposal-related options.
 * @param {CdnParameters} options.proposal.cdn - Parameters for interacting with the CDN and governance.
 * @param {boolean} options.proposal.autoCommit - If `true`, automatically commits the proposal after submission.
 * @param {boolean} [options.proposal.clearAssets] - Whether to clear existing assets before upload (optional).
 *
 * @returns {Promise<DeployResultWithProposal>} The result of the deployment process:
 *   - `{result: 'skipped'}` if no files were found for upload.
 *   - `{result: 'submitted', files, proposalId}` if the upload and proposal submission succeeded.
 *   - `{result: 'deployed', files, proposalId}` if the upload and proposal was applied automatically committed.
 */
export declare const deployWithProposal: ({ deploy: { uploadFile, ...rest }, proposal: { clearAssets, ...restProposal } }: {
    deploy: DeployParams<UploadFileWithProposal>;
    proposal: Pick<ProposeChangesParams, "cdn" | "autoCommit"> & {
        clearAssets?: boolean;
    };
}) => Promise<DeployResultWithProposal>;