@netlify/build 29.29.4 → 29.31.0

package/lib/core/constants.d.ts

@@ -1,4 +1,77 @@
-export function getConstants({ configPath, buildDir, packagePath, functionsDistDir, edgeFunctionsDistDir, cacheDir, netlifyConfig, siteInfo: { id: siteId }, apiHost, token, mode, }: {
+export interface NetlifyPluginConstants {
+    /**
+     * path to the Netlify configuration file.
+     * `undefined` if none was used.
+     */
+    CONFIG_PATH?: string;
+    /**
+     * directory that contains the deploy-ready HTML files and assets generated by the build. Its value is always defined, but the target might not have been created yet.
+     */
+    PUBLISH_DIR: string;
+    /**
+     * the directory where function source code lives.
+     * `undefined` if no `netlify/functions` directory exists in the base directory and if not specified by the user.
+     */
+    FUNCTIONS_SRC?: string;
+    /**
+     * the directory inside a mono repository where it collects the settings from.
+     * This is the value of the package directory field of the build settings
+     * `undefined` if none is set.
+     */
+    PACKAGE_PATH?: string;
+    /**
+     * the directory where internal Edge Functions source code lives. This is where build plugins should place auto-generated functions.
+     * `undefined` if the version of @netlify/build does not support internal Edge Functions
+     */
+    INTERNAL_EDGE_FUNCTIONS_SRC?: string;
+    /**
+     * the directory where internal function source code lives. This is where build plugins should place auto-generated functions.
+     * `undefined` if the version of @netlify/build does not support internal functions
+     */
+    INTERNAL_FUNCTIONS_SRC?: string;
+    /**
+     * the directory where built serverless functions are placed before deployment. Its value is always defined, but the target might not have been created yet.
+     */
+    FUNCTIONS_DIST: string;
+    /**
+     * the directory where built Edge Functions are placed before deployment. Its value is always defined, but the target might not have been created yet.
+     */
+    EDGE_FUNCTIONS_DIST: string;
+    /**
+     * the directory where Edge Functions source code lives.
+     * `undefined` if no `netlify/edge-functions` directory exists.
+     */
+    EDGE_FUNCTIONS_SRC?: string;
+    /**
+     * boolean indicating whether the build was [run locally](https://docs.netlify.com/cli/get-started/#run-builds-locally) or on Netlify
+     */
+    IS_LOCAL: boolean;
+    /**
+     * version of Netlify Build as a `major.minor.patch` string
+     */
+    NETLIFY_BUILD_VERSION: string;
+    /**
+     * the Netlify site ID
+     */
+    SITE_ID: string;
+    /**
+     * the Netlify API access token
+     */
+    NETLIFY_API_TOKEN?: string;
+    /**
+     * the Netlify API host
+     */
+    NETLIFY_API_HOST?: string;
+    /**
+     * The directory that is used for caching
+     * @default '.netlify/cache'
+     */
+    CACHE_DIR: string;
+}
+/**
+ * Retrieve constants passed to plugins
+ */
+export declare const getConstants: ({ configPath, buildDir, packagePath, functionsDistDir, edgeFunctionsDistDir, cacheDir, netlifyConfig, siteInfo: { id: siteId }, apiHost, token, mode, }: {
     configPath: any;
     buildDir: any;
     packagePath: any;
@@ -12,8 +85,8 @@ export function getConstants({ configPath, buildDir, packagePath, functionsDistD
     apiHost: any;
     token: any;
     mode: any;
-}): Promise<Record<string, any> & Record<string, unknown>>;
-export function addMutableConstants({ constants, buildDir, netlifyConfig: { build: { publish, edge_functions: edgeFunctions }, functionsDirectory, }, }: {
+}) => Promise<NetlifyPluginConstants>;
+export declare const addMutableConstants: ({ constants, buildDir, netlifyConfig: { build: { publish, edge_functions: edgeFunctions }, functionsDirectory, }, }: {
     constants: any;
     buildDir: any;
     netlifyConfig: {
@@ -23,4 +96,20 @@ export function addMutableConstants({ constants, buildDir, netlifyConfig: { buil
         };
         functionsDirectory: any;
     };
-}): Promise<Record<string, any> & Record<string, unknown>>;
+}) => Promise<{
+    FUNCTIONS_SRC: string | undefined;
+    EDGE_FUNCTIONS_SRC: string | undefined;
+    CONFIG_PATH: string | undefined;
+    PUBLISH_DIR: string | undefined;
+    FUNCTIONS_DIST: string | undefined;
+    INTERNAL_EDGE_FUNCTIONS_SRC: string | undefined;
+    INTERNAL_FUNCTIONS_SRC: string | undefined;
+    EDGE_FUNCTIONS_DIST: string | undefined;
+    CACHE_DIR: string | undefined;
+    PACKAGE_PATH: string | undefined;
+    IS_LOCAL: string | undefined;
+    NETLIFY_BUILD_VERSION: string | undefined;
+    SITE_ID: string | undefined;
+    NETLIFY_API_TOKEN: string | undefined;
+    NETLIFY_API_HOST: string | undefined;
+}>;

package/lib/core/constants.js

@@ -3,7 +3,9 @@ import { getCacheDir } from '@netlify/cache-utils';
 import mapObj from 'map-obj';
 import { pathExists } from 'path-exists';
 import { ROOT_PACKAGE_JSON } from '../utils/json.js';
-// Retrieve constants passed to plugins
+/**
+ * Retrieve constants passed to plugins
+ */
 export const getConstants = async function ({ configPath, buildDir, packagePath, functionsDistDir, edgeFunctionsDistDir, cacheDir, netlifyConfig, siteInfo: { id: siteId }, apiHost, token, mode, }) {
     const isLocal = mode !== 'buildbot';
     const normalizedCacheDir = getCacheDir({ cacheDir, cwd: buildDir });
@@ -39,8 +41,7 @@ export const getConstants = async function ({ configPath, buildDir, packagePath,
         // via plugins or others) live
         INTERNAL_EDGE_FUNCTIONS_SRC: join(buildDir, packagePath || '', INTERNAL_EDGE_FUNCTIONS_SRC),
     };
-    const constantsA = await addMutableConstants({ constants, buildDir, netlifyConfig });
-    return constantsA;
+    return (await addMutableConstants({ constants, buildDir, netlifyConfig }));
 };
 const INTERNAL_EDGE_FUNCTIONS_SRC = '.netlify/edge-functions';
 const INTERNAL_FUNCTIONS_SRC = '.netlify/functions-internal';
@@ -94,7 +95,7 @@ const normalizeConstantsPaths = function (constants, buildDir) {
 // Instead of passing absolute paths, we pass paths relative to `buildDir`, so
 // that logs are less verbose.
 const normalizePath = function (path, buildDir, key) {
-    if (isEmptyValue(path) || !CONSTANT_PATHS.has(key)) {
+    if (path === undefined || path === '' || !CONSTANT_PATHS.has(key)) {
         return path;
     }
     const pathA = normalize(path);

package/lib/core/types.d.ts

@@ -1,4 +1,4 @@
-import { NetlifyConfig, NetlifyPlugin } from '../../types/index.js';
+import { NetlifyConfig, NetlifyPlugin } from '../index.js';
 export type Mode = 'buildbot' | 'cli' | 'require';
 export type BuildCLIFlags = {
     cachedConfig: Record<string, unknown>;

package/lib/index.d.ts

@@ -1,5 +1,11 @@
 import { buildSite } from './core/main.js';
-export type * from '../types/index.js';
+export { NetlifyPluginConstants } from './core/constants.js';
+export type { NetlifyPlugin } from './types/netlify_plugin.js';
+export type { NetlifyPluginOptions } from './types/netlify_plugin_options.js';
+export type { OnBuild, OnEnd, OnError, OnPostBuild, OnPreBuild, OnSuccess } from './types/netlify_event_handler.js';
+export type { NetlifyConfig } from './types/config/netlify_config.js';
+export type { NetlifyPluginUtils } from './types/options/netlify_plugin_utils.js';
+export type { ListedFunction, ListedFunctionFile } from './types/options/netlify_plugin_functions_util.js';
 export { startDev } from './core/dev.js';
 export { runCoreSteps } from './steps/run_core_steps.js';
 export default buildSite;

package/lib/plugins/child/systemLog.d.ts

@@ -1 +1 @@
-export function getSystemLog(): ((message: any) => void) | undefined;
+export declare const getSystemLog: () => ((message: unknown) => void) | undefined;

package/lib/plugins/child/systemLog.js

@@ -1,14 +1,16 @@
 import { appendFileSync, openSync } from 'fs';
+import { inspect } from 'util';
 const systemLogLocation = '/dev/fd/4';
 export const getSystemLog = () => {
     try {
         // throws if system log wasn't hooked up
         const fd = openSync(systemLogLocation, 'a');
         return (message) => {
-            appendFileSync(fd, `${message}\n`);
+            const stringifiedMessage = typeof message === 'string' ? message : inspect(message);
+            appendFileSync(fd, `${stringifiedMessage}\n`);
         };
     }
     catch {
-        return;
+        // not accessible
     }
 };

package/lib/plugins_core/blobs_upload/index.d.ts

@@ -1,26 +1,2 @@
-export declare const uploadBlobs: {
-    event: string;
-    coreStep: ({ debug, logs, deployId, buildDir, quiet, constants: { PUBLISH_DIR, SITE_ID, NETLIFY_API_TOKEN, API_URL }, }: {
-        debug: any;
-        logs: any;
-        deployId: any;
-        buildDir: any;
-        quiet: any;
-        constants: {
-            PUBLISH_DIR: any;
-            SITE_ID: any;
-            NETLIFY_API_TOKEN: any;
-            API_URL: any;
-        };
-    }) => Promise<{}>;
-    coreStepId: string;
-    coreStepName: string;
-    coreStepDescription: () => string;
-    condition: ({ deployId, buildDir, constants: { PUBLISH_DIR } }: {
-        deployId: any;
-        buildDir: any;
-        constants: {
-            PUBLISH_DIR: any;
-        };
-    }) => Promise<boolean>;
-};
+import { CoreStep } from '../types.js';
+export declare const uploadBlobs: CoreStep;

package/lib/plugins_core/blobs_upload/index.js

@@ -5,19 +5,25 @@ import semver from 'semver';
 import { log, logError } from '../../log/logger.js';
 import { anyBlobsToUpload, getBlobsDir } from '../../utils/blobs.js';
 import { getKeysToUpload, getFileWithMetadata } from './utils.js';
-const coreStep = async function ({ debug, logs, deployId, buildDir, quiet, constants: { PUBLISH_DIR, SITE_ID, NETLIFY_API_TOKEN, API_URL }, }) {
+const coreStep = async function ({ debug, logs, deployId, buildDir, quiet, packagePath, constants: { SITE_ID, NETLIFY_API_TOKEN, NETLIFY_API_HOST }, }) {
+    // This should never happen due to the condition check
+    if (!deployId || !NETLIFY_API_TOKEN) {
+        return {};
+    }
+    // for cli deploys with `netlify deploy --build` the `NETLIFY_API_HOST` is undefined
+    const apiHost = NETLIFY_API_HOST || 'api.netlify.com';
     const storeOpts = {
         siteID: SITE_ID,
         deployID: deployId,
         token: NETLIFY_API_TOKEN,
-        apiURL: API_URL,
+        apiURL: `https://${apiHost}`,
     };
     if (semver.lt(nodeVersion, '18.0.0')) {
         const nodeFetch = await import('node-fetch');
         storeOpts.fetch = nodeFetch.default;
     }
     const blobStore = getDeployStore(storeOpts);
-    const blobsDir = getBlobsDir({ buildDir, publishDir: PUBLISH_DIR });
+    const blobsDir = getBlobsDir(buildDir, packagePath);
     const keys = await getKeysToUpload(blobsDir);
     // We checked earlier, but let's be extra safe
     if (keys.length === 0) {
@@ -48,9 +54,7 @@ const coreStep = async function ({ debug, logs, deployId, buildDir, quiet, const
     }
     return {};
 };
-const deployAndBlobsPresent = async function ({ deployId, buildDir, constants: { PUBLISH_DIR } }) {
-    return deployId && (await anyBlobsToUpload({ buildDir, publishDir: PUBLISH_DIR }));
-};
+const deployAndBlobsPresent = async ({ deployId, buildDir, packagePath, constants: { NETLIFY_API_TOKEN }, }) => Boolean(NETLIFY_API_TOKEN && deployId && (await anyBlobsToUpload(buildDir, packagePath)));
 export const uploadBlobs = {
     event: 'onPostBuild',
     coreStep,

package/lib/plugins_core/functions/index.d.ts

@@ -44,7 +44,7 @@ export declare const bundleFunctions: {
     }) => Promise<boolean>;
 };
 export declare const zipItAndShipIt: {
-    zipFunctions(args_0: string | string[], args_1: string, args_2?: import("@netlify/zip-it-and-ship-it").ZipFunctionsOptions | undefined): Promise<(Omit<import("@netlify/zip-it-and-ship-it/dist/function.js").FunctionArchive, "runtime"> & {
+    zipFunctions(relativeSrcFolders: string | string[], destFolder: string, args_2?: import("@netlify/zip-it-and-ship-it").ZipFunctionsOptions | undefined): Promise<(Omit<import("@netlify/zip-it-and-ship-it/dist/function.js").FunctionArchive, "runtime"> & {
         routes?: import("@netlify/zip-it-and-ship-it/dist/utils/routes.js").Route[] | undefined;
         runtime: import("@netlify/zip-it-and-ship-it").RuntimeName;
         schedule?: string | undefined;

package/lib/plugins_core/pre_cleanup/index.d.ts

@@ -1,18 +1,2 @@
-export declare const preCleanup: {
-    event: string;
-    coreStep: ({ buildDir, constants: { PUBLISH_DIR } }: {
-        buildDir: any;
-        constants: {
-            PUBLISH_DIR: any;
-        };
-    }) => Promise<{}>;
-    coreStepId: string;
-    coreStepName: string;
-    coreStepDescription: () => string;
-    condition: ({ buildDir, constants: { PUBLISH_DIR } }: {
-        buildDir: any;
-        constants: {
-            PUBLISH_DIR: any;
-        };
-    }) => Promise<boolean>;
-};
+import { CoreStep } from '../types.js';
+export declare const preCleanup: CoreStep;

package/lib/plugins_core/pre_cleanup/index.js

@@ -1,7 +1,7 @@
 import { rm } from 'node:fs/promises';
 import { anyBlobsToUpload, getBlobsDir } from '../../utils/blobs.js';
-const coreStep = async function ({ buildDir, constants: { PUBLISH_DIR } }) {
-    const blobsDir = getBlobsDir({ buildDir, publishDir: PUBLISH_DIR });
+const coreStep = async ({ buildDir, packagePath }) => {
+    const blobsDir = getBlobsDir(buildDir, packagePath);
     try {
         await rm(blobsDir, { recursive: true, force: true });
     }
@@ -10,9 +10,7 @@ const coreStep = async function ({ buildDir, constants: { PUBLISH_DIR } }) {
     }
     return {};
 };
-const blobsPresent = async function ({ buildDir, constants: { PUBLISH_DIR } }) {
-    return await anyBlobsToUpload({ buildDir, publishDir: PUBLISH_DIR });
-};
+const blobsPresent = ({ buildDir, packagePath }) => anyBlobsToUpload(buildDir, packagePath);
 export const preCleanup = {
     event: 'onPreBuild',
     coreStep,

package/lib/plugins_core/pre_dev_cleanup/index.d.ts

@@ -0,0 +1,2 @@
+import { CoreStep } from '../types.js';
+export declare const preDevCleanup: CoreStep;

package/lib/plugins_core/pre_dev_cleanup/index.js

@@ -0,0 +1,42 @@
+import { rm, stat } from 'node:fs/promises';
+import { resolve } from 'node:path';
+import { log } from '../../log/logger.js';
+const dirExists = async (path) => {
+    try {
+        await stat(path);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+};
+const getDirtyDirs = async function ({ buildDir, constants: { INTERNAL_EDGE_FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC }, }) {
+    const dirs = [];
+    if (INTERNAL_FUNCTIONS_SRC && (await dirExists(resolve(buildDir, INTERNAL_FUNCTIONS_SRC)))) {
+        dirs.push(INTERNAL_FUNCTIONS_SRC);
+    }
+    if (INTERNAL_EDGE_FUNCTIONS_SRC && (await dirExists(resolve(buildDir, INTERNAL_EDGE_FUNCTIONS_SRC)))) {
+        dirs.push(INTERNAL_EDGE_FUNCTIONS_SRC);
+    }
+    return dirs;
+};
+const coreStep = async (input) => {
+    const dirs = await getDirtyDirs(input);
+    for (const dir of dirs) {
+        await rm(resolve(input.buildDir, dir), { recursive: true, force: true });
+    }
+    log(input.logs, `Cleaned up ${dirs.join(', ')}.`);
+    return {};
+};
+const condition = async (input) => {
+    const dirs = await getDirtyDirs(input);
+    return dirs.length > 0;
+};
+export const preDevCleanup = {
+    event: 'onPreDev',
+    coreStep,
+    coreStepId: 'pre_dev_cleanup',
+    coreStepName: 'Pre Dev cleanup',
+    coreStepDescription: () => 'Cleaning up leftover files from previous builds',
+    condition,
+};

package/lib/plugins_core/secrets_scanning/index.d.ts

@@ -1,16 +1,2 @@
-export declare const scanForSecrets: {
-    event: string;
-    coreStep: ({ buildDir, logs, netlifyConfig, explicitSecretKeys, systemLog }: {
-        buildDir: any;
-        logs: any;
-        netlifyConfig: any;
-        explicitSecretKeys: any;
-        systemLog: any;
-    }) => Promise<{}>;
-    coreStepId: string;
-    coreStepName: string;
-    coreStepDescription: () => string;
-    condition: ({ explicitSecretKeys }: {
-        explicitSecretKeys: any;
-    }) => boolean;
-};
+import { CoreStep } from '../types.js';
+export declare const scanForSecrets: CoreStep;

package/lib/plugins_core/secrets_scanning/index.js

@@ -8,7 +8,7 @@ const coreStep = async function ({ buildDir, logs, netlifyConfig, explicitSecret
     const stepResults = {};
     const passedSecretKeys = (explicitSecretKeys || '').split(',');
     const envVars = netlifyConfig.build.environment;
-    systemLog({ passedSecretKeys, buildDir });
+    systemLog?.({ passedSecretKeys, buildDir });
     if (!isSecretsScanningEnabled(envVars)) {
         logSecretsScanSkipMessage(logs, 'Secrets scanning disabled via SECRETS_SCAN_ENABLED flag set to false.');
         return stepResults;
@@ -47,7 +47,7 @@ const coreStep = async function ({ buildDir, logs, netlifyConfig, explicitSecret
             secretsFilesCount: scanResults.scannedFilesCount,
             keysToSearchFor,
         };
-        systemLog(attributesForLogsAndSpan);
+        systemLog?.(attributesForLogsAndSpan);
         span.setAttributes(attributesForLogsAndSpan);
         span.end();
     });

package/lib/plugins_core/types.d.ts

@@ -0,0 +1,40 @@
+import { NetlifyPluginConstants } from '../core/constants.js';
+import { BufferedLogs } from '../log/logger.js';
+import { NetlifyConfig } from '../types/config/netlify_config.js';
+type $TSFixme = any;
+export type CoreStepFunctionArgs = {
+    /**
+     * The absolute process working directory of a build
+     */
+    buildDir: string;
+    /**
+     * the directory inside a mono repository where it collects the settings from.
+     * This is the value of the package directory field of the build settings
+     * `undefined` if none is set.
+     */
+    packagePath?: string;
+    deployId?: string;
+    saveConfig: boolean;
+    constants: NetlifyPluginConstants;
+    quiet?: boolean;
+    debug?: boolean;
+    logs?: BufferedLogs;
+    systemLog?: (message: unknown) => void;
+    edgeFunctionsBootstrapURL?: string;
+    featureFlags?: Record<string, any>;
+    netlifyConfig: NetlifyConfig;
+    explicitSecretKeys: $TSFixme;
+    buildbotServerSocket: $TSFixme;
+};
+export type CoreStepFunction = (args: CoreStepFunctionArgs) => Promise<object>;
+export type CoreStepCondition = (args: CoreStepFunctionArgs) => Promise<boolean> | boolean;
+type Event = 'onPreBuild' | 'onBuild' | 'onPostBuild' | 'onPreDev' | 'onDev' | 'onPostDev';
+export type CoreStep = {
+    event: Event;
+    coreStep: CoreStepFunction;
+    coreStepId: string;
+    coreStepName: string;
+    coreStepDescription: () => string;
+    condition: CoreStepCondition;
+};
+export {};

package/lib/plugins_core/types.js

@@ -0,0 +1 @@
+export {};

package/lib/steps/get.d.ts

@@ -1,8 +1,8 @@
-export function getSteps(steps: any, eventHandlers: any): {
+export declare const getSteps: (steps: any, eventHandlers?: any[]) => {
     steps: any;
-    events: any[];
+    events: unknown[];
 };
-export function getDevSteps(command: any, steps: any, eventHandlers: any): {
+export declare const getDevSteps: (command: any, steps: any, eventHandlers?: any[]) => {
     steps: any;
-    events: any[];
+    events: unknown[];
 };

package/lib/steps/get.js

@@ -6,6 +6,7 @@ import { deploySite } from '../plugins_core/deploy/index.js';
 import { bundleEdgeFunctions } from '../plugins_core/edge_functions/index.js';
 import { bundleFunctions } from '../plugins_core/functions/index.js';
 import { preCleanup } from '../plugins_core/pre_cleanup/index.js';
+import { preDevCleanup } from '../plugins_core/pre_dev_cleanup/index.js';
 import { saveArtifacts } from '../plugins_core/save_artifacts/index.js';
 import { scanForSecrets } from '../plugins_core/secrets_scanning/index.js';
 // Get all build steps
@@ -30,7 +31,7 @@ export const getDevSteps = function (command, steps, eventHandlers) {
         coreStepDescription: () => 'Run command for local development',
     };
     const eventSteps = getEventSteps(eventHandlers);
-    const sortedSteps = sortSteps([...steps, eventSteps, devCommandStep], DEV_EVENTS);
+    const sortedSteps = sortSteps([...steps, eventSteps, preDevCleanup, devCommandStep], DEV_EVENTS);
     const events = getEvents(sortedSteps);
     return { steps: sortedSteps, events };
 };

package/lib/types/config/build.d.ts

@@ -0,0 +1,45 @@
+export interface Build {
+    /**
+     * Includes a site's [build command](https://docs.netlify.com/configure-builds/get-started/#definitions)
+     */
+    command?: string;
+    /**
+     * the path to your static content folder
+     */
+    publish: string;
+    base: string;
+    services: Record<string, unknown>;
+    /**
+     * Allows specifying a Bash command that will be run from the base directory to determine whether the site needs rebuilding or not.
+     * Check out our [ignore builds](https://docs.netlify.com/configure-builds/common-configurations/ignore-builds/) doc for more information on the default ignore behavior and details about constructing a custom ignore command.
+     */
+    ignore?: string;
+    /**
+     * Includes the path to a site's [Edge Handlers directory](https://docs.netlify.com/edge-handlers/configure-and-build/#choose-an-edge-handlers-directory)
+     */
+    edge_handlers?: string;
+    /**
+     * Contains a site's [environment variables](https://docs.netlify.com/configure-builds/environment-variables/#netlify-configuration-variables)
+     */
+    environment: Partial<Record<string, string>>;
+    /**
+     * Includes options for [post processing](https://docs.netlify.com/configure-builds/file-based-configuration/#post-processing) HTML, CSS, JavaScript, and images
+     */
+    processing: {
+        skip_processing?: boolean;
+        css: {
+            bundle?: boolean;
+            minify?: boolean;
+        };
+        js: {
+            bundle?: boolean;
+            minify?: boolean;
+        };
+        html: {
+            pretty_url?: boolean;
+        };
+        images: {
+            compress?: boolean;
+        };
+    };
+}

package/lib/types/config/build.js

@@ -0,0 +1 @@
+export {};

package/lib/types/config/functions.d.ts

@@ -0,0 +1,30 @@
+type GlobPattern = string;
+type FunctionsObject = {
+    /**
+     * a list of additional paths to include in the function bundle. Although our build system includes statically referenced files (like `import * from "./some-file.js"`) by default, `included_files` lets you specify additional files or directories and reference them dynamically in function code. You can use `*` to match any character or prefix an entry with `!` to exclude files. Paths are relative to the [base directory](https://docs.netlify.com/configure-builds/get-started/#definitions-1).
+     */
+    included_files?: string[];
+} & ({
+    /**
+     * the function bundling method used in [`@netlify/zip-it-and-ship-it`](https://github.com/netlify/zip-it-and-ship-it).
+     */
+    node_bundler?: 'zisi' | 'nft';
+} | {
+    /**
+     * the function bundling method used in [`@netlify/zip-it-and-ship-it`](https://github.com/netlify/zip-it-and-ship-it).
+     */
+    node_bundler?: 'esbuild' | 'none';
+    /**
+     * a list of Node.js modules that are copied to the bundled artifact without adjusting their source or references during the bundling process.
+     * This property helps handle dependencies that can’t be inlined, such as modules with native add-ons.
+     */
+    external_node_modules?: string[];
+    ignored_node_modules?: string[];
+});
+export type Functions = {
+    '*': FunctionsObject & {
+        deno_import_map?: string;
+    };
+    [pattern: GlobPattern]: FunctionsObject;
+};
+export {};

package/lib/types/config/functions.js

@@ -0,0 +1 @@
+export {};

package/lib/types/config/inputs.d.ts

@@ -0,0 +1,3 @@
+import type { JSONValue } from '../utils/json_value.js';
+export type StringKeys<TObject extends object> = keyof TObject & string;
+export type PluginInputs<Keys extends string = string> = Partial<Record<Keys, JSONValue>>;

package/lib/types/config/inputs.js

@@ -0,0 +1 @@
+export {};

package/lib/types/config/netlify_config.d.ts

@@ -0,0 +1,55 @@
+import type { Many } from '../utils/many.js';
+import type { Build } from './build.js';
+import type { Functions } from './functions.js';
+import type { PluginInputs } from './inputs.js';
+type HttpStatusCode = number;
+interface Redirect {
+    from: string;
+    to?: string;
+    status?: HttpStatusCode;
+    force?: boolean;
+    signed?: string;
+    query?: Partial<Record<string, string>>;
+    headers?: Partial<Record<string, string>>;
+    conditions?: Partial<Record<'Language' | 'Role' | 'Country' | 'Cookie', readonly string[]>>;
+}
+interface Header {
+    for: string;
+    values: Partial<Record<string, Many<string, 'mutable'>>>;
+}
+interface EdgeFunction {
+    path?: `/${string}`;
+    function: string;
+}
+interface NetlifyPlugin {
+    package: string;
+    inputs: PluginInputs;
+}
+interface ImagesConfig {
+    remote_images: string[];
+}
+export interface NetlifyConfig {
+    /**
+     * array of redirects with their modifiable options
+     */
+    redirects: Redirect[];
+    /**
+     * array of headers with their modifiable options
+     */
+    headers: Header[];
+    /**
+     * array of Edge Functions with their modifiable options
+     */
+    edge_functions: EdgeFunction[];
+    /**
+     * object with options for modifying [functions](https://docs.netlify.com/configure-builds/file-based-configuration/#functions)
+     */
+    functions: Functions;
+    build: Build;
+    plugins: readonly NetlifyPlugin[];
+    /**
+     * object with options for image transforms
+     */
+    images: ImagesConfig;
+}
+export {};

package/lib/types/config/netlify_config.js

@@ -0,0 +1 @@
+export {};

package/lib/types/netlify_event_handler.d.ts

@@ -0,0 +1,16 @@
+import type { PluginInputs, StringKeys } from './config/inputs.js';
+import type { NetlifyPluginOptions } from './netlify_plugin_options.js';
+interface NetlifyEventHandler<PluginOptions extends NetlifyPluginOptions = NetlifyPluginOptions> {
+    (options: PluginOptions): void | Promise<void>;
+}
+export type OnPreBuild<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<NetlifyPluginOptions<TInputs>>;
+export type OnBuild<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<NetlifyPluginOptions<TInputs>>;
+export type OnPostBuild<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<NetlifyPluginOptions<TInputs>>;
+export type OnError<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<NetlifyPluginOptions<TInputs> & {
+    error: Error;
+}>;
+export type OnSuccess<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<NetlifyPluginOptions<TInputs>>;
+export type OnEnd<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> = NetlifyEventHandler<NetlifyPluginOptions<TInputs> & {
+    error?: Error;
+}>;
+export {};

package/lib/types/netlify_event_handler.js

@@ -0,0 +1 @@
+export {};