@netlify/build 18.21.5 → 18.21.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/build",
-  "version": "18.21.5",
+  "version": "18.21.6",
   "description": "Netlify build module",
   "main": "src/core/main.js",
   "types": "types/index.d.ts",

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/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>
-}