@netlify/build 18.21.4 → 18.21.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "18.21.4",
+  "version": "18.21.8",
   "description": "Netlify build module",
   "main": "src/core/main.js",
   "types": "types/index.d.ts",
@@ -61,7 +61,7 @@
     "@netlify/plugin-edge-handlers": "^1.11.22",
     "@netlify/plugins-list": "^4.1.0",
     "@netlify/run-utils": "^2.0.0",
-    "@netlify/zip-it-and-ship-it": "^4.29.0",
+    "@netlify/zip-it-and-ship-it": "^4.29.1",
     "@sindresorhus/slugify": "^1.1.0",
     "@ungap/from-entries": "^0.2.1",
     "ansi-escapes": "^4.3.2",
@@ -80,7 +80,7 @@
     "log-process-errors": "^6.0.0",
     "make-dir": "^3.0.2",
     "map-obj": "^4.0.0",
-    "memoize-one": "^5.2.1",
+    "memoize-one": "^6.0.0",
     "os-name": "^4.0.1",
     "p-event": "^4.1.0",
     "p-every": "^2.0.0",
@@ -123,7 +123,7 @@
     "moize": "^6.0.0",
     "path-key": "^3.1.1",
     "process-exists": "^4.0.0",
-    "sinon": "^11.0.0",
+    "sinon": "^12.0.0",
     "yarn": "^1.22.4"
   },
   "engines": {

package/types/config/functions.d.ts

@@ -3,36 +3,34 @@ type GlobPattern = string
 /* eslint-disable camelcase -- some properties are named in snake case in this API */
 type FunctionsObject = {
   /**
-   * string that includes the path to a site's [functions directory](https://docs.netlify.com/functions/configure-and-deploy/#configure-the-functions-folder)
+   * a list of additional paths to include in the function bundle. Although our build system includes statically referenced files (like `require("./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).
    */
-  directory: string
+  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'
+      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'
+      node_bundler?: 'esbuild'
 
       /**
        * 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[]
+      external_node_modules?: string[]
 
-      /**
-       * a list of additional paths to include in the function bundle. Although our build system includes statically referenced files (like `require("./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[]
-
-      ignored_node_modules: string[]
+      ignored_node_modules?: string[]
     }
 )
 /* eslint-enable camelcase */
 
-export type Functions = Record<GlobPattern, FunctionsObject>
+export type Functions = {
+  '*': FunctionsObject
+  [pattern: GlobPattern]: FunctionsObject
+}

package/types/index.d.ts

@@ -1 +1,6 @@
 export { NetlifyPlugin } from './netlify_plugin'
+export { NetlifyPluginOptions } from './netlify_plugin_options'
+export { OnBuild, OnEnd, OnError, OnPostBuild, OnPreBuild, OnSuccess } from './netlify_event_handler'
+export { NetlifyConfig } from './config/netlify_config'
+export { NetlifyPluginUtils } from './options'
+export { NetlifyPluginConstants } from './netlify_plugin_constants'

package/types/netlify_event_handler.d.ts

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

package/types/netlify_plugin.d.ts

@@ -1,30 +1,29 @@
 import { PluginInputs } from './config/inputs'
-import { NetlifyEvent } from './netlify_event'
-import { NetlifyPluginOptions } from './netlify_plugin_options'
+import { OnBuild, OnEnd, OnError, OnPostBuild, OnPreBuild, OnSuccess } from './netlify_event_handler'
 
 export interface NetlifyPlugin<TInputs extends PluginInputs = PluginInputs> {
   /**
    * Runs before the build command is executed.
    */
-  onPreBuild?: NetlifyEvent<NetlifyPluginOptions<TInputs>>
+  onPreBuild?: OnPreBuild<TInputs>
   /**
    * runs directly after the build command is executed and before Functions? bundling and Edge Handlers bundling.
    */
-  onBuild?: NetlifyEvent<NetlifyPluginOptions<TInputs>>
+  onBuild?: OnBuild<TInputs>
   /**
    * runs after the build command completes; after onBuild? tasks, Functions? bundling, and Edge Handlers bundling are executed; and before the deploy stage. Can be used to prevent a build from being deployed.
    */
-  onPostBuild?: NetlifyEvent<NetlifyPluginOptions<TInputs>>
+  onPostBuild?: OnPostBuild<TInputs>
   /**
    * runs when an error occurs in the build or deploy stage, failing the build. Can’t be used to prevent a build from being deployed.
    */
-  onError?: NetlifyEvent<NetlifyPluginOptions<TInputs> & { error: Error }>
+  onError?: OnError<TInputs>
   /**
    * runs when the deploy succeeds. Can’t be used to prevent a build from being deployed.
    */
-  onSuccess?: NetlifyEvent<NetlifyPluginOptions<TInputs>>
+  onSuccess?: OnSuccess<TInputs>
   /**
    * runs after completion of the deploy stage, regardless of build error or success; is useful for resources cleanup. Can’t be used to prevent a build from being deployed.
    */
-  onEnd?: NetlifyEvent<NetlifyPluginOptions<TInputs> & { error?: Error }>
+  onEnd?: OnEnd<TInputs>
 }

package/types/netlify_plugin_constants.d.ts

@@ -0,0 +1,42 @@
+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 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 Edge Handlers source code lives.
+   * `undefined` if no `netlify/edge-handlers` directory exists in the base directory and if not specified in `netlify.toml`.
+   */
+  EDGE_HANDLERS_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
+}

package/types/netlify_plugin_options.d.ts

@@ -1,51 +1,10 @@
 import { PluginInputs } from './config/inputs'
 import { NetlifyConfig } from './config/netlify_config'
+import { NetlifyPluginConstants } from './netlify_plugin_constants'
 import { NetlifyPluginUtils } from './options/netlify_plugin_utils'
 import { JSONValue } from './utils/json_value'
 
 export interface NetlifyPluginOptions<TInputs extends PluginInputs = PluginInputs> {
-  constants: {
-    /**
-     * 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 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 Edge Handlers source code lives.
-     * `undefined` if no `netlify/edge-handlers` directory exists in the base directory and if not specified in `netlify.toml`.
-     */
-    EDGE_HANDLERS_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
-  }
   /**
    * If your plugin requires additional values from the user, you can specify these requirements in an `inputs` array in the plugin’s [`manifest.yml` file](https://docs.netlify.com/configure-builds/build-plugins/create-plugins/#anatomy-of-a-plugin).
    */
@@ -59,5 +18,6 @@ export interface NetlifyPluginOptions<TInputs extends PluginInputs = PluginInput
    * The data fields are normalized to prevent plugin errors. If the site has no `package.json`, the argument is an empty object.
    */
   packageJson: Partial<Record<string, JSONValue>>
+  constants: NetlifyPluginConstants
   utils: NetlifyPluginUtils
 }

package/types/options/index.d.ts

@@ -1 +1 @@
-export * from './netlify_plugin_utils'
+export { NetlifyPluginUtils } from './netlify_plugin_utils'

package/types/options/netlify_plugin_build_util.d.ts

@@ -3,5 +3,5 @@
  */
 export type NetlifyPluginBuildUtil = Record<
   'failBuild' | 'failPlugin' | 'cancelBuild',
-  (message: string, options?: { error?: Error }) => void
+  (message: string, options?: { error?: Error }) => never
 >

package/types/netlify_event.d.ts

@@ -1,5 +0,0 @@
-import { NetlifyPluginOptions } from './netlify_plugin_options'
-
-export interface NetlifyEvent<PluginOptions extends NetlifyPluginOptions = NetlifyPluginOptions> {
-  (options: PluginOptions): void | Promise<void>
-}