netlify 13.3.4 → 21.5.0

package/package.json

@@ -1,66 +1,160 @@
 {
   "name": "netlify",
-  "description": "Netlify Node.js API client",
-  "version": "13.3.4",
+  "description": "Netlify command line tool",
+  "version": "21.5.0",
+  "author": "Netlify Inc.",
   "type": "module",
-  "exports": "./lib/index.js",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "engines": {
+    "node": ">=18.14.0"
+  },
   "files": [
-    "lib/**"
+    "/bin",
+    "/npm-shrinkwrap.json",
+    "/scripts",
+    "/functions-templates",
+    "/dist"
   ],
-  "scripts": {
-    "prebuild": "rm -rf lib",
-    "build": "tsc",
-    "test": "ava",
-    "test:dev": "ava -w",
-    "test:ci": "c8 -r lcovonly -r text -r json ava"
-  },
-  "license": "MIT",
-  "author": "Netlify Inc.",
-  "contributors": [
-    "Mathias Biilmann <matt@netlify.com> (https://twitter.com/biilmann)",
-    "David Calavera <david@netlify.com> (https://twitter.com/calavera)",
-    "David Wells <david.wells@netlify.com> (https://davidwells.io/)",
-    "Bret Comnes <bcomnes@gmail.com> (https://bret.io)",
-    "Lukas Holzer <lukas.holzer@netlify.com> (https://twitter.com/luka5c0m)"
+  "homepage": "https://github.com/netlify/cli",
+  "keywords": [
+    "api",
+    "cli",
+    "netlify",
+    "static"
   ],
-  "homepage": "https://github.com/netlify/build",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/netlify/build.git",
-    "directory": "packages/js-client"
+  "license": "MIT",
+  "repository": "https://github.com/netlify/cli",
+  "bin": {
+    "npxnetlify": "./bin/run.js"
   },
   "bugs": {
-    "url": "https://github.com/netlify/build/issues"
+    "url": "https://github.com/netlify/cli/issues"
   },
-  "keywords": [
-    "api client",
-    "js client",
-    "netlify",
-    "node client"
-  ],
-  "dependencies": {
-    "@netlify/open-api": "^2.36.0",
-    "lodash-es": "^4.17.21",
-    "micro-api-client": "^3.3.0",
-    "node-fetch": "^3.0.0",
-    "p-wait-for": "^5.0.0",
-    "qs": "^6.9.6"
+  "scripts": {
+    "_format": "prettier --loglevel=warn \"{src,tools,scripts,tests,e2e,.github}/**/*.{mjs,cjs,js,mts,md,yml,json,html,ts}\" \"*.{mjs,cjs,js,mts,yml,json,html,ts}\" \".*.{mjs,cjs,js,yml,json,html,ts}\" \"!CHANGELOG.md\" \"!**/*/package-lock.json\" \"!.github/**/*.md\"",
+    "build": "tsc --project tsconfig.build.json",
+    "clean": "rm -rf dist/",
+    "dev": "tsc --project tsconfig.build.json --watch",
+    "docs": "npm run --prefix=site build",
+    "format": "npm run _format -- --write",
+    "format:check": "npm run _format -- --check",
+    "lint": "eslint --cache",
+    "lint:fix": "npm run lint -- --fix",
+    "start": "node ./bin/run.js",
+    "test": "run-s test:unit test:integration test:e2e",
+    "test:e2e": "vitest run --config vitest.e2e.config.ts",
+    "test:init": "run-s test:init:*",
+    "test:init:cli-help": "npm run start -- --help",
+    "test:init:cli-version": "npm run start -- --version",
+    "test:init:hugo-deps": "npm ci --prefix tests/integration/__fixtures__/hugo-site --no-audit",
+    "test:init:monorepo-deps": "cd tests/integration/__fixtures__/monorepo && pnpm install --frozen-lockfile",
+    "test:init:next-deps": "npm ci --prefix tests/integration/__fixtures__/next-app-without-config --no-audit && npm ci --prefix tests/integration/__fixtures__/next-app --no-audit",
+    "test:integration": "vitest run --retry=3 tests/integration/",
+    "test:unit": "vitest run tests/unit/",
+    "postinstall": "node ./scripts/postinstall.js",
+    "typecheck": "tsc",
+    "typecheck:watch": "tsc --watch"
   },
-  "devDependencies": {
-    "@types/lodash-es": "^4.17.6",
-    "@types/node": "^14.18.53",
-    "ava": "^4.0.0",
-    "c8": "^7.11.0",
-    "from2-string": "^1.1.0",
-    "nock": "^13.0.0",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.0.0",
-    "uuid": "^9.0.0"
+  "dependencies": {
+    "@fastify/static": "7.0.4",
+    "@netlify/api": "13.4.0",
+    "@netlify/blobs": "8.2.0",
+    "@netlify/build": "32.1.4",
+    "@netlify/build-info": "9.0.4",
+    "@netlify/config": "22.2.0",
+    "@netlify/edge-bundler": "13.0.3",
+    "@netlify/edge-functions": "2.12.0",
+    "@netlify/headers-parser": "8.0.0",
+    "@netlify/local-functions-proxy": "2.0.3",
+    "@netlify/redirect-parser": "14.5.1",
+    "@netlify/zip-it-and-ship-it": "10.1.1",
+    "@octokit/rest": "21.1.1",
+    "@opentelemetry/api": "1.8.0",
+    "@pnpm/tabtab": "0.5.4",
+    "ansi-escapes": "7.0.0",
+    "ansi-to-html": "0.7.2",
+    "ascii-table": "0.0.9",
+    "backoff": "2.5.0",
+    "boxen": "8.0.1",
+    "chalk": "5.4.1",
+    "chokidar": "3.6.0",
+    "ci-info": "4.2.0",
+    "clean-deep": "3.4.0",
+    "commander": "12.1.0",
+    "comment-json": "4.2.5",
+    "content-type": "1.0.5",
+    "cookie": "1.0.2",
+    "cron-parser": "4.9.0",
+    "debug": "4.4.0",
+    "decache": "4.6.2",
+    "dot-prop": "9.0.0",
+    "dotenv": "16.5.0",
+    "env-paths": "3.0.0",
+    "envinfo": "7.14.0",
+    "etag": "1.8.1",
+    "execa": "5.1.1",
+    "express": "4.21.2",
+    "express-logging": "1.1.1",
+    "extract-zip": "2.0.1",
+    "fastest-levenshtein": "1.0.16",
+    "fastify": "4.29.1",
+    "find-up": "7.0.0",
+    "folder-walker": "3.2.0",
+    "fuzzy": "0.1.3",
+    "get-port": "5.1.1",
+    "gh-release-fetch": "4.0.3",
+    "git-repo-info": "2.1.1",
+    "gitconfiglocal": "2.1.0",
+    "http-proxy": "1.18.1",
+    "http-proxy-middleware": "2.0.9",
+    "https-proxy-agent": "7.0.6",
+    "inquirer": "8.2.6",
+    "inquirer-autocomplete-prompt": "1.4.0",
+    "ipx": "2.1.0",
+    "is-docker": "3.0.0",
+    "is-stream": "4.0.1",
+    "is-wsl": "3.1.0",
+    "isexe": "3.1.1",
+    "jsonwebtoken": "9.0.2",
+    "jwt-decode": "4.0.0",
+    "lambda-local": "2.2.0",
+    "locate-path": "7.2.0",
+    "lodash": "4.17.21",
+    "log-update": "6.1.0",
+    "maxstache": "1.0.7",
+    "maxstache-stream": "1.0.4",
+    "multiparty": "4.2.3",
+    "nanospinner": "^1.2.2",
+    "netlify-redirector": "0.5.0",
+    "node-fetch": "3.3.2",
+    "normalize-package-data": "6.0.2",
+    "open": "10.1.2",
+    "p-filter": "4.1.0",
+    "p-map": "7.0.3",
+    "p-wait-for": "5.0.2",
+    "parallel-transform": "1.2.0",
+    "parse-github-url": "1.0.3",
+    "parse-gitignore": "2.0.0",
+    "prettyjson": "1.2.5",
+    "raw-body": "3.0.0",
+    "read-package-up": "11.0.0",
+    "readdirp": "4.1.2",
+    "semver": "7.7.1",
+    "source-map-support": "0.5.21",
+    "terminal-link": "4.0.0",
+    "toml": "3.0.0",
+    "tomlify-j0.4": "3.0.0",
+    "ulid": "3.0.0",
+    "update-notifier": "7.3.1",
+    "uuid": "11.1.0",
+    "wait-port": "1.1.0",
+    "write-file-atomic": "5.0.1",
+    "ws": "8.18.2"
   },
-  "engines": {
-    "node": "^14.16.0 || >=16.0.0"
+  "ava": {
+    "files": [
+      "tools/**/*.test.js",
+      "tests/**/*.test.cjs"
+    ]
   },
-  "gitHead": "0e4628f57a0a7d02594b5070074445a4ff69b809"
+  "main": "./dist/index.js"
 }

package/scripts/bash.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+script_link="$(command readlink "$BASH_SOURCE")" || script_link="$BASH_SOURCE"
+apparent_sdk_dir="${script_link%/*}"
+
+if [ "$apparent_sdk_dir" == "$script_link" ]; then
+  apparent_sdk_dir=.
+fi
+
+sdk_dir="$(command cd -P "$apparent_sdk_dir" >/dev/null && command pwd -P)"
+bin_path="$sdk_dir/bin"
+
+if [[ ":${PATH}:" != *":${bin_path}:"* ]]; then
+  export PATH=$bin_path:$PATH
+fi

package/scripts/fish.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env fish
+
+# Only append to PATH if it isn't already part of the list
+# `fish_add_path` - https://fishshell.com/docs/current/cmds/fish_add_path.html?highlight=fish_add_path would be a more
+# suited alternative but it's only supported in fish 3.3.x
+if not contains (dirname (status --current-filename))/bin $fish_user_paths
+  set -U fish_user_paths (dirname (status --current-filename))/bin $fish_user_paths
+end

package/scripts/netlifyPackage.js

@@ -0,0 +1,68 @@
+// @ts-check
+import assert from 'node:assert'
+import { dirname, resolve } from 'node:path'
+import { readFile, stat, writeFile } from 'node:fs/promises'
+
+import execa from 'execa'
+
+/**
+ * @import {Package} from "normalize-package-data"
+ */
+
+const packageJSON = await getPackageJSON()
+
+async function getPackageJSON() {
+  const packageJSONPath = resolve('package.json')
+
+  /**
+   * @type {Package}
+   */
+  const contents = JSON.parse(await readFile(packageJSONPath, 'utf8'))
+
+  return {
+    contents,
+    path: packageJSONPath,
+  }
+}
+
+async function preparePackageJSON() {
+  const binPath = Object.values(packageJSON.contents.bin ?? {})[0]
+  if (!binPath) {
+    throw new Error('Did not find a non-empty binary entry in `package.json`, so the `npx` flow will not work.')
+  }
+
+  const newPackageJSON = {
+    ...packageJSON.contents,
+    main: './dist/index.js',
+    name: 'netlify',
+    scripts: {
+      ...packageJSON.contents.scripts,
+
+      // We don't need the pre-publish script because we expect the work in
+      // there to be done when publishing the `netlify-cli` package. We'll
+      // ensure this is the case by throwing if a shrinkwrap file isn't found.
+      prepublishOnly: undefined,
+    },
+    bin: {
+      npxnetlify: binPath,
+    },
+  }
+
+  try {
+    const shrinkwrap = await stat(resolve(packageJSON.path, '../npm-shrinkwrap.json'))
+
+    assert.ok(shrinkwrap.isFile())
+  } catch {
+    throw new Error('Failed to find npm-shrinkwrap.json file. Did you run the pre-publish script?')
+  }
+
+  console.log(`Writing updated package.json to ${packageJSON.path}...`)
+  await writeFile(packageJSON.path, `${JSON.stringify(newPackageJSON, null, 2)}\n`)
+
+  console.log('Regenerating shrinkwrap file with updated package name...')
+  await execa('npm', ['shrinkwrap'], {
+    cwd: dirname(packageJSON.path),
+  })
+}
+
+await preparePackageJSON()

package/scripts/path.ps1

@@ -0,0 +1,35 @@
+#!/usr/bin/env pwsh
+
+$ErrorActionPreference = "Stop"
+
+# Helper functions for pretty terminal output.
+function Write-Part ([string] $Text) {
+  Write-Host $Text -NoNewline
+}
+function Write-Emphasized ([string] $Text) {
+  Write-Host $Text -NoNewLine -ForegroundColor "Yellow"
+}
+function Write-Done {
+  Write-Host " done" -NoNewline -ForegroundColor "Green";
+  Write-Host "."
+}
+
+# Get Path environment variable for the current user.
+$user = [EnvironmentVariableTarget]::User
+$path = [Environment]::GetEnvironmentVariable("PATH", $user)
+
+$install_dir = $args[0]
+
+# Add Helper to PATH
+Write-Part "Adding "; Write-Emphasized $install_dir; Write-Part " to the "
+Write-Emphasized "PATH"; Write-Part " environment variable..."
+[Environment]::SetEnvironmentVariable("PATH", "${path};${install_dir}", $user)
+# Add Helper to the PATH variable of the current terminal session
+# so `git-credential-netlify` can be used immediately without restarting the
+# terminal.
+$env:PATH += ";${install_dir}"
+Write-Done
+
+Write-Host ""
+Write-Host "Netlify Credential Helper for Git was installed successfully." -ForegroundColor "Green"
+Write-Host ""

package/scripts/postinstall.js

@@ -0,0 +1,82 @@
+/*
+ * This script runs after an end user installs the CLI. It installs command-line completion, prints
+ * a welcome message, etc.
+ */
+
+import fs from 'node:fs/promises'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import process from 'node:process'
+// eslint-disable-next-line no-restricted-imports
+import chalk from 'chalk'
+import boxen from 'boxen'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+const NETLIFY_CYAN_HEX = '#28b5ac'
+
+const postInstall = async () => {
+  const { createMainCommand } = await import('../dist/commands/index.js')
+  const { generateAutocompletion } = await import('../dist/lib/completion/index.js')
+
+  // yarn plug and play seems to have an issue with reading an esm file by building up the cache.
+  // as yarn pnp analyzes everything inside the postinstall
+  // yarn pnp executes it out of a .yarn folder .yarn/unplugged/netlify-cli-file-fb026a3a6d/node_modules/netlify-cli/scripts/postinstall.js
+  if (!process.argv[1].includes('.yarn')) {
+    // create or update the autocompletion definition
+    const program = createMainCommand()
+    generateAutocompletion(program)
+  }
+
+  console.log('')
+  console.log(
+    boxen(
+      `Success! Netlify CLI has been installed!
+
+      You can now use Netlify CLI to develop, deploy, and manage your Netlify projects.
+
+      🚀 Now get building!`,
+      {
+        padding: 1,
+        margin: 1,
+        textAlignment: 'center',
+        borderStyle: 'round',
+        borderColor: NETLIFY_CYAN_HEX,
+        // This is an intentional half-width space to work around a unicode padding math bug in boxen
+        title: '⬥ ',
+        titleAlignment: 'center',
+      },
+    ),
+  )
+  console.log('Next steps:')
+  console.log(`  ${chalk.cyanBright.bold('netlify login')}    Log in to your Netlify account`)
+  console.log(
+    `  ${chalk.cyanBright.bold('netlify init')}     Connect or create a Netlify project from the current directory`,
+  )
+  console.log(`  ${chalk.cyanBright.bold('netlify deploy')}   Deploy the latest changes to your Netlify project`)
+  console.log(`  ${chalk.cyanBright.bold('netlify help')}     Find out what else you can do 👀`)
+  console.log('')
+  console.log(`For more help with the CLI, visit ${chalk.cyanBright.bold('https://developers.netlify.com/cli')}`)
+  console.log('')
+  console.log(`For help with Netlify, visit ${chalk.cyanBright.bold('https://docs.netlify.com')}`)
+  console.log('')
+}
+
+const main = async () => {
+  // Check if this post-install script is being run by an end user installation
+  // (`npm install [-g] netlify-cli`) or during local development (`npm install`/`npm ci`)
+  let isEndUserInstall = false
+  try {
+    await fs.stat(path.resolve(__dirname, '../.git'))
+  } catch (err) {
+    if (err instanceof Error && 'code' in err && err.code === 'ENOENT') {
+      isEndUserInstall = true
+    }
+  }
+
+  if (isEndUserInstall) {
+    await postInstall()
+  }
+}
+
+await main()

package/scripts/prepublishOnly.js

@@ -0,0 +1,29 @@
+import * as cp from 'node:child_process'
+import * as fs from 'node:fs/promises'
+import * as path from 'node:path'
+
+const main = async () => {
+  // It's best practice to include a shrinkwrap when shipping a CLI. npm has a bug that makes it
+  // not ignore development dependencies in an installed package's shrinkwrap, though:
+  //
+  // https://github.com/npm/cli/issues/4323
+  //
+  // Leaving development dependencies makes the CLI installation significantly larger and increases
+  // the risk of platform-specific dependency installation issues.
+  // eslint-disable-next-line no-restricted-properties
+  const packageJSONPath = path.join(process.cwd(), 'package.json')
+  const rawPackageJSON = await fs.readFile(packageJSONPath, 'utf8')
+
+  // Remove dev dependencies from the package.json...
+  const packageJSON = JSON.parse(rawPackageJSON)
+  Reflect.deleteProperty(packageJSON, 'devDependencies')
+  await fs.writeFile(packageJSONPath, JSON.stringify(packageJSON, null, 2))
+
+  // Prune out dev dependencies (this updates the `package-lock.json` lockfile)
+  cp.spawnSync('npm', ['prune'], { stdio: 'inherit' })
+
+  // Convert `package-lock.json` lockfile to `npm-shrinkwrap.json`
+  cp.spawnSync('npm', ['shrinkwrap'], { stdio: 'inherit' })
+}
+
+await main()

package/scripts/zsh.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env zsh
+
+export PATH=${0:A:h}/bin:$PATH

package/lib/index.d.ts

@@ -1,54 +0,0 @@
-import type { DynamicMethods } from './types.js';
-type APIOptions = {
-    /** @example 'netlify/js-client' */
-    userAgent?: string;
-    /** @example 'https' */
-    scheme?: string;
-    /** @example 'api.netlify.com' */
-    host?: string;
-    /** @example '/api/v1' */
-    pathPrefix?: string;
-    accessToken?: string;
-    /** @example 'HttpsProxyAgent' */
-    agent?: string;
-    /**
-     * parameters you want available for every request.
-     * Global params are only sent of the OpenAPI spec specifies the provided params.
-     */
-    globalParams?: Record<string, unknown>;
-};
-/**
- * The Netlify API client.
- * @see {@link https://open-api.netlify.com | Open API Reference}
- * @see {@link https://docs.netlify.com/api/get-started | Online Documentation}
- *
- * @example
- * ```ts
- * const client = new NetlifyAPI('YOUR_ACCESS_TOKEN')
- * const sites = await client.listSites()
- * ```
- */
-export interface NetlifyAPI extends DynamicMethods {
-}
-export declare class NetlifyAPI {
-    #private;
-    defaultHeaders: Record<string, string>;
-    /** The protocol is used like `https` */
-    scheme: string;
-    host: string;
-    pathPrefix: string;
-    agent?: string;
-    globalParams: Record<string, unknown>;
-    constructor(options?: APIOptions);
-    constructor(accessToken: string | undefined, options?: APIOptions);
-    /** Retrieves the access token */
-    get accessToken(): string | undefined | null;
-    set accessToken(token: string | undefined | null);
-    get basePath(): string;
-    getAccessToken(ticket: any, { poll, timeout }?: {
-        poll?: number | undefined;
-        timeout?: number | undefined;
-    }): Promise<string | undefined>;
-}
-export declare const methods: any[];
-export {};

package/lib/index.js

@@ -1,78 +0,0 @@
-import pWaitFor from 'p-wait-for';
-import { getMethods } from './methods/index.js';
-import { openApiSpec } from './open_api.js';
-import { getOperations } from './operations.js';
-// 1 second
-const DEFAULT_TICKET_POLL = 1e3;
-// 1 hour
-const DEFAULT_TICKET_TIMEOUT = 3.6e6;
-// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
-export class NetlifyAPI {
-    #accessToken = null;
-    defaultHeaders = {
-        accept: 'application/json',
-    };
-    /** The protocol is used like `https` */
-    scheme;
-    host;
-    pathPrefix;
-    agent;
-    globalParams = {};
-    constructor(firstArg, secondArg) {
-        // variadic arguments
-        const [accessTokenInput, options = {}] = typeof firstArg === 'object' ? [null, firstArg] : [firstArg, secondArg];
-        this.globalParams = options.globalParams || {};
-        this.agent = options.agent;
-        this.scheme = options.scheme || openApiSpec.schemes[0];
-        this.host = options.host || openApiSpec.host;
-        this.pathPrefix = options.pathPrefix || openApiSpec.basePath;
-        // use the setter to set the header as well
-        this.accessToken = options.accessToken || accessTokenInput || null;
-        this.defaultHeaders['User-agent'] = options.userAgent || 'netlify/js-client';
-        const methods = getMethods({
-            basePath: this.basePath,
-            defaultHeaders: this.defaultHeaders,
-            agent: this.agent,
-            globalParams: this.globalParams,
-        });
-        Object.assign(this, { ...methods });
-    }
-    /** Retrieves the access token */
-    get accessToken() {
-        return this.#accessToken;
-    }
-    set accessToken(token) {
-        if (!token) {
-            delete this.defaultHeaders.Authorization;
-            this.#accessToken = null;
-            return;
-        }
-        this.#accessToken = token;
-        this.defaultHeaders.Authorization = `Bearer ${this.#accessToken}`;
-    }
-    get basePath() {
-        return `${this.scheme}://${this.host}${this.pathPrefix}`;
-    }
-    async getAccessToken(ticket, { poll = DEFAULT_TICKET_POLL, timeout = DEFAULT_TICKET_TIMEOUT } = {}) {
-        const { id } = ticket;
-        // ticket capture
-        let authorizedTicket;
-        const checkTicket = async () => {
-            const t = await this.showTicket({ ticketId: id });
-            if (t.authorized) {
-                authorizedTicket = t;
-            }
-            return Boolean(t.authorized);
-        };
-        await pWaitFor(checkTicket, {
-            interval: poll,
-            timeout,
-            message: 'Timeout while waiting for ticket grant',
-        });
-        const accessTokenResponse = await this.exchangeTicket({ ticketId: authorizedTicket.id });
-        // See https://open-api.netlify.com/#/default/exchangeTicket for shape
-        this.accessToken = accessTokenResponse.access_token;
-        return accessTokenResponse.access_token;
-    }
-}
-export const methods = getOperations();

package/lib/methods/body.d.ts

@@ -1 +0,0 @@
-export function addBody(body: any, parameters: any, opts: any): any;

package/lib/methods/body.js

@@ -1,25 +0,0 @@
-// Handle request body
-export const addBody = function (body, parameters, opts) {
-    if (!body) {
-        return opts;
-    }
-    const bodyA = typeof body === 'function' ? body() : body;
-    if (isBinaryBody(parameters)) {
-        return {
-            ...opts,
-            body: bodyA,
-            headers: { 'Content-Type': 'application/octet-stream', ...opts.headers },
-        };
-    }
-    return {
-        ...opts,
-        body: JSON.stringify(bodyA),
-        headers: { 'Content-Type': 'application/json', ...opts.headers },
-    };
-};
-const isBinaryBody = function (parameters) {
-    return Object.values(parameters.body).some(isBodyParam);
-};
-const isBodyParam = function ({ schema }) {
-    return schema && schema.format === 'binary';
-};

package/lib/methods/index.d.ts

@@ -1,6 +0,0 @@
-export function getMethods({ basePath, defaultHeaders, agent, globalParams }: {
-    basePath: any;
-    defaultHeaders: any;
-    agent: any;
-    globalParams: any;
-}): any;