@netlify/build 29.29.4 → 29.31.0

package/types/netlify_plugin_options.d.ts

@@ -1,25 +0,0 @@
-import type { PluginInputs, StringKeys } from './config/inputs.js'
-import type { NetlifyConfig } from './config/netlify_config.js'
-import type { NetlifyPluginConstants } from './netlify_plugin_constants.js'
-import type { NetlifyPluginUtils } from './options/netlify_plugin_utils.js'
-import type { JSONValue } from './utils/json_value.js'
-
-export interface NetlifyPluginOptions<TInputs extends PluginInputs<StringKeys<TInputs>> = PluginInputs> {
-  /**
-   * 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).
-   */
-  inputs: TInputs
-  /**
-   * @see https://docs.netlify.com/configure-builds/build-plugins/create-plugins/#netlifyconfig
-   */
-  netlifyConfig: NetlifyConfig
-  /**
-   * When an event handler executes, the contents of the `package.json` in a site's base directory get passed to a plugin.
-   * 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
-  featureFlags?: Record<string, unknown>
-  systemLog?(message: string): void
-}

package/types/options/netlify_plugin_build_util.d.ts

@@ -1,7 +0,0 @@
-/**
- * Report errors or cancel builds
- */
-export type NetlifyPluginBuildUtil = Record<
-  'failBuild' | 'failPlugin' | 'cancelBuild',
-  (message: string, options?: { error?: Error }) => never
->

package/types/options/netlify_plugin_cache_util.d.ts

@@ -1,39 +0,0 @@
-import type { Many } from '../utils/many.js'
-
-/**
- * Cache files between builds
- */
-export type NetlifyPluginCacheUtil = {
-  save(
-    path: Many<string>,
-    options?: {
-      ttl?: number
-      digests?: string[]
-      /**
-       * @default `process.cwd()`
-       */
-      cwd?: string
-    },
-  ): Promise<boolean>
-  list(options?: {
-    /**
-     * @default `process.cwd()`
-     */
-    cwd?: string
-    /**
-     * @default 1
-     */
-    depth?: number
-  }): Promise<string[]>
-} & Record<
-  'restore' | 'remove' | 'has',
-  (
-    path: Many<string>,
-    options?: {
-      /**
-       * @default `process.cwd()`
-       */
-      cwd?: string
-    },
-  ) => Promise<boolean>
->

package/types/options/netlify_plugin_functions_util.d.ts

@@ -1,32 +0,0 @@
-import type { listFunctions, listFunctionsFiles } from '@netlify/zip-it-and-ship-it'
-
-type Resolved<T> = T extends Promise<infer U> ? U : T
-
-export type ListedFunction = Resolved<ReturnType<typeof listFunctions>>[0]
-export type ListedFunctionFile = Resolved<ReturnType<typeof listFunctionsFiles>>[0]
-
-export interface NetlifyPluginFunctionsUtil {
-  /**
-   * Returns the list of Netlify Functions main files as a Promise resolving to an array of objects with the following properties:
-   *
-   * - `name`: Function name, as used in the URL `https://{hostname}/.netlify/functions/{name}`
-   * - `mainFile`: absolute path to the Function's main file
-   * - `extension`: file extension of the Function's main file. For Go Functions, this might be an empty string.  For Node.js Functions, this is either `.js` or `.zip`.
-   * - `runtime` `"js" | "go"`: Function's language runtime. TypeScript Functions use the "js" runtime
-   */
-  list(): Promise<Array<ListedFunction>>
-
-  /**
-   * Same as `list()` except it also returns the files required by the Functions' main files. This is much slower. The object have the following additional member:
-   *
-   * - `srcFile`: absolute path to the file
-   */
-  listAll(): Promise<Array<ListedFunctionFile>>
-
-  /**
-   * Add a Functions file or directory to a build.
-   *
-   * @param path Path to the function file or directory.
-   */
-  add(path: string): Promise<void>
-}

package/types/options/netlify_plugin_git_util.d.ts

@@ -1,41 +0,0 @@
-/**
- * Retrieve Git-related information such as the list of modified/created/deleted files
- * @see https://github.com/netlify/build/blob/master/packages/git-utils/README.md
- */
-export interface NetlifyPluginGitUtil {
-  fileMatch(globPattern: string): readonly string[]
-  /**
-   * Array of all modified files.
-   */
-  modifiedFiles: readonly string[]
-  /**
-   * Array of all created files.
-   */
-  createdFiles: readonly string[]
-  /**
-   * Array of all deleted files.
-   */
-  deletedFiles: readonly string[]
-  /**
-   * Array of commits with details.
-   */
-  commits: ReadonlyArray<{
-    sha: string
-    parents: string
-    author: {
-      name: string
-      email: string
-      date: string
-    }
-    committer: {
-      name: string
-      email: string
-      date: string
-    }
-    message: string
-  }>
-  /**
-   * How many lines of code have changed
-   */
-  linesOfCode(): Promise<number>
-}

package/types/options/netlify_plugin_run_util.d.ts

@@ -1,24 +0,0 @@
-import type { Options as ExecaOptions, ExecaChildProcess } from 'execa'
-
-type NetlifyPluginRunUtilOptions = Omit<ExecaOptions, 'preferLocal'> & {
-  /**
-   * @default true
-   */
-  preferLocal?: ExecaOptions['preferLocal']
-}
-
-type NetlifyPluginRunUtilResult = ExecaChildProcess
-
-/**
- * Run commands and processes
- * @see https://github.com/netlify/build/blob/master/packages/run-utils/README.md
- */
-export interface NetlifyPluginRunUtil {
-  (
-    file: string,
-    // eslint-disable-next-line fp/no-arguments -- params are named `arguments` in the docs. Unrelated to JS's `arguments`
-    arguments?: readonly string[],
-    options?: NetlifyPluginRunUtilOptions,
-  ): Promise<NetlifyPluginRunUtilResult>
-  command(command: string, options?: NetlifyPluginRunUtilOptions): Promise<NetlifyPluginRunUtilResult>
-}

package/types/options/netlify_plugin_status_util.d.ts

@@ -1,24 +0,0 @@
-/**
- * Display information in the deploy summary
- */
-export interface NetlifyPluginStatusUtil {
-  /**
-   * Only one status is shown per plugin.
-   * Calling `utils.status.show()` twice overrides the previous status.
-   */
-  show(options: {
-    /**
-     * Default to the plugin's name followed by a generic title.
-     */
-    title?: string
-    /**
-     * Message below the title
-     */
-    summary: string
-    /**
-     * Detailed information shown in a collapsible section.
-     * @default ""
-     */
-    text?: string
-  }): void
-}

package/types/utils/json_value.d.ts

@@ -1 +0,0 @@
-export type JSONValue = string | number | boolean | null | { [key: string]: JSONValue } | Array<JSONValue>