@twilio-labs/serverless-api/dist/types/deploy.d.ts

API-wrapper for the Twilio Serverless API

/** @module @twilio-labs/serverless-api */
import { PackageJson } from 'type-fest';
import { ClientConfig } from './client';
import { DeployStatus } from './consts';
import { AssetResource, EnvironmentVariables, FunctionResource, ServerlessResourceConfig } from './generic';
import { Sid } from './serverless-api';
/**
 * Shared configuration of Deploy functions
 */
type DeployProjectConfigBase = {
    /**
     * Object of environment variables that should be set
     */
    env: EnvironmentVariables;
    /**
     * Optional Service SID of Serverless Service to create deployment for
     */
    serviceSid?: string;
    /**
     * An package.json object. `dependencies` in here will be installed in deployment
     */
    pkgJson: PackageJson;
    /**
     * Name, used as `UniqueName` for Serverless Service.
     */
    serviceName: string;
    /**
     * Name of Functions environment to deploy to. Will be used as domain suffix and `${value}-environment` for `UniqueName`
     */
    functionsEnv: string;
    /**
     * Run deployment in force mode
     */
    force?: boolean;
    /**
     * If no `serviceSid` is specified but a service with `serviceName` is found, it will deploy to that one.
     */
    overrideExistingService?: boolean;
    /**
     * Version of Node.js to deploy with in Twilio Runtime. Can be "node18"
     */
    runtime?: string;
    /**
     * Whether the Service's properties and subresources can be edited via the UI. The default value is false.
     */
    uiEditable?: boolean;
};
/**
 * Config for `client.deployProject`
 */
export type DeployProjectConfig = ClientConfig & DeployProjectConfigBase & {
    /**
     * List of functions that should be deployed
     */
    functions: ServerlessResourceConfig[];
    /**
     * List of assets that should be deployed
     */
    assets: ServerlessResourceConfig[];
};
/**
 * Config for `client.deployLocalProject`
 */
export type DeployLocalProjectConfig = ClientConfig & DeployProjectConfigBase & {
    /**
     * Root path used to check for functions and assets.
     * Will be used to search for `functions`, `src`, `assets` and `static` directories
     *
     * @type {string}
     */
    cwd: string;
    /**
     * Path to ".env" file
     * @type {string}
     */
    envPath: string;
    /**
     * Name of the folder containing assets
     * @type {string}
     */
    assetsFolderName?: string;
    /**
     * Name of the folder containing functions
     * @type {string}
     */
    functionsFolderName?: string;
    /**
     * Don't upload any functions
     * @type {boolean}
     */
    noFunctions?: boolean;
    /**
     * Don't upload any assets
     * @type {boolean}
     */
    noAssets?: boolean;
};
export type DeployResult = {
    serviceSid: Sid;
    environmentSid: Sid;
    buildSid: Sid;
    domain: string;
    functionResources: FunctionResource[];
    assetResources: AssetResource[];
    runtime: string;
    serviceName: string;
};
export type StatusUpdate = {
    status: DeployStatus;
    message: string;
};
export type StatusUpdateCallback = (update: StatusUpdate) => void;
export {};