netlify-cli 17.4.0 → 17.5.0

package/npm-shrinkwrap.json

@@ -1,18 +1,18 @@
 {
   "name": "netlify-cli",
-  "version": "17.4.0",
+  "version": "17.5.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "netlify-cli",
-      "version": "17.4.0",
+      "version": "17.5.0",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {
         "@bugsnag/js": "7.20.2",
         "@fastify/static": "6.10.2",
-        "@netlify/blobs": "^6.3.0",
+        "@netlify/blobs": "6.3.0",
         "@netlify/build": "29.26.6",
         "@netlify/build-info": "7.11.1",
         "@netlify/config": "20.10.0",
@@ -119,6 +119,7 @@
         "uuid": "9.0.0",
         "wait-port": "1.0.4",
         "write-file-atomic": "5.0.1",
+        "ws": "^8.14.2",
         "zod": "3.22.4"
       },
       "bin": {
@@ -16345,6 +16346,26 @@
         "url": "https://github.com/sponsors/isaacs"
       }
     },
+    "node_modules/ws": {
+      "version": "8.14.2",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-8.14.2.tgz",
+      "integrity": "sha512-wEBG1ftX4jcglPxgFCMJmZ2PLtSbJ2Peg6TmpJFTbe9GZYOQCDPdMYu/Tm0/bGZkw8paZnJY45J4K2PZrLYq8g==",
+      "engines": {
+        "node": ">=10.0.0"
+      },
+      "peerDependencies": {
+        "bufferutil": "^4.0.1",
+        "utf-8-validate": ">=5.0.2"
+      },
+      "peerDependenciesMeta": {
+        "bufferutil": {
+          "optional": true
+        },
+        "utf-8-validate": {
+          "optional": true
+        }
+      }
+    },
     "node_modules/xdg-basedir": {
       "version": "5.1.0",
       "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz",
@@ -27885,6 +27906,12 @@
         }
       }
     },
+    "ws": {
+      "version": "8.14.2",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-8.14.2.tgz",
+      "integrity": "sha512-wEBG1ftX4jcglPxgFCMJmZ2PLtSbJ2Peg6TmpJFTbe9GZYOQCDPdMYu/Tm0/bGZkw8paZnJY45J4K2PZrLYq8g==",
+      "requires": {}
+    },
     "xdg-basedir": {
       "version": "5.1.0",
       "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "17.4.0",
+  "version": "17.5.0",
   "author": "Netlify Inc.",
   "type": "module",
   "engines": {
@@ -20,7 +20,8 @@
     "/src/lib/templates/**",
     "!/src/**/node_modules/**",
     "!/src/**/*.test.js",
-    "!/src/**/*.mts"
+    "!/src/**/*.mts",
+    "!/src/**/*.d.mts.map"
   ],
   "homepage": "https://github.com/netlify/cli",
   "keywords": [
@@ -45,7 +46,7 @@
   "dependencies": {
     "@bugsnag/js": "7.20.2",
     "@fastify/static": "6.10.2",
-    "@netlify/blobs": "^6.3.0",
+    "@netlify/blobs": "6.3.0",
     "@netlify/build": "29.26.6",
     "@netlify/build-info": "7.11.1",
     "@netlify/config": "20.10.0",
@@ -152,6 +153,7 @@
     "uuid": "9.0.0",
     "wait-port": "1.0.4",
     "write-file-atomic": "5.0.1",
+    "ws": "^8.14.2",
     "zod": "3.22.4"
   }
 }

package/src/commands/base-command.mjs

@@ -3,7 +3,6 @@ import { join, relative, resolve } from 'path';
 import process from 'process';
 import { format } from 'util';
 import { DefaultLogger, Project } from '@netlify/build-info';
-// eslint-disable-next-line import/extensions, n/no-missing-import
 import { NodeFS, NoopLogger } from '@netlify/build-info/node';
 // @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module '@net... Remove this comment to see the full error message
 import { resolveConfig } from '@netlify/config';
@@ -99,6 +98,12 @@ async function selectWorkspace(project, filter) {
     }
     return selected.path;
 }
+async function getRepositoryRoot(cwd) {
+    const res = await findUp('.git', { cwd, type: 'directory' });
+    if (res) {
+        return join(res, '..');
+    }
+}
 /** Base command class that provides tracking and config initialization */
 export default class BaseCommand extends Command {
     constructor() {
@@ -186,15 +191,11 @@ export default class BaseCommand extends Command {
                 : `${HELP_$} ${command.parent?.name()} ${command.name()} ${command.usage()}`;
             return padLeft(term, HELP_INDENT_WIDTH);
         };
-        /**
-         * @param {BaseCommand} command
-         */
-        // @ts-expect-error TS(7006) FIXME: Parameter 'command' implicitly has an 'any' type.
+        // eslint-disable-next-line unicorn/consistent-function-scoping
         const getCommands = (command) => {
             const parentCommand = this.name() === 'netlify' ? command : command.parent;
-            return (
-            // @ts-expect-error TS(7006) FIXME: Parameter 'cmd' implicitly has an 'any' type.
-            parentCommand?.commands.filter((cmd) => {
+            return (parentCommand?.commands
+                .filter((cmd) => {
                 if (cmd._hidden)
                     return false;
                 // the root command
@@ -203,16 +204,11 @@ export default class BaseCommand extends Command {
                     return !cmd.name().includes(':');
                 }
                 return cmd.name().startsWith(`${command.name()}:`);
-            }) || []);
+            })
+                // eslint-disable-next-line id-length
+                .sort((a, b) => a.name().localeCompare(b.name())) || []);
         };
-        /**
-         * override the longestSubcommandTermLength
-         * @param {BaseCommand} command
-         * @returns {number}
-         */
-        help.longestSubcommandTermLength = (command) => 
-        // @ts-expect-error TS(7006) FIXME: Parameter 'max' implicitly has an 'any' type.
-        getCommands(command).reduce((max, cmd) => Math.max(max, cmd.name().length), 0);
+        help.longestSubcommandTermLength = (command) => getCommands(command).reduce((max, cmd) => Math.max(max, cmd.name().length), 0);
         /**
          * override the longestOptionTermLength to react on hide options flag
          * @param {BaseCommand} command
@@ -224,12 +220,6 @@ export default class BaseCommand extends Command {
         (command.noBaseOptions === false &&
             helper.visibleOptions(command).reduce((max, option) => Math.max(max, helper.optionTerm(option).length), 0)) ||
             0;
-        /**
-         * override the format help function to style it correctly
-         * @param {BaseCommand} command
-         * @param {import('commander').Help} helper
-         * @returns {string}
-         */
         help.formatHelp = (command, helper) => {
             const parentCommand = this.name() === 'netlify' ? command : command.parent;
             const termWidth = helper.padWidth(command, helper);
@@ -275,7 +265,6 @@ export default class BaseCommand extends Command {
             if (argumentList.length !== 0) {
                 output = [...output, chalk.bold('ARGUMENTS'), formatHelpList(argumentList), ''];
             }
-            // @ts-expect-error TS(2551) FIXME: Property 'noBaseOptions' does not exist on type 'C... Remove this comment to see the full error message
             if (command.noBaseOptions === false) {
                 // Options
                 const optionList = helper
@@ -297,17 +286,14 @@ export default class BaseCommand extends Command {
                 const aliases = command._aliases.map((alias) => formatItem(`${parentCommand.name()} ${alias}`, null, true));
                 output = [...output, chalk.bold('ALIASES'), formatHelpList(aliases), ''];
             }
-            // @ts-expect-error TS(2339) FIXME: Property 'examples' does not exist on type 'Comman... Remove this comment to see the full error message
             if (command.examples.length !== 0) {
                 output = [
                     ...output,
                     chalk.bold('EXAMPLES'),
-                    // @ts-expect-error TS(2339) FIXME: Property 'examples' does not exist on type 'Comman... Remove this comment to see the full error message
                     formatHelpList(command.examples.map((example) => `${HELP_$} ${example}`)),
                     '',
                 ];
             }
-            // @ts-expect-error TS(7006) FIXME: Parameter 'cmd' implicitly has an 'any' type.
             const commandList = getCommands(command).map((cmd) => formatItem(cmd.name(), helper.subcommandDescription(cmd).split('\n')[0], true));
             if (commandList.length !== 0) {
                 output = [...output, chalk.bold('COMMANDS'), formatHelpList(commandList), ''];
@@ -343,12 +329,6 @@ export default class BaseCommand extends Command {
             exit(1);
         }
     }
-    /**
-     *
-     * @param {string|undefined} tokenFromFlag
-     * @returns
-     */
-    // @ts-expect-error TS(7006) FIXME: Parameter 'tokenFromFlag' implicitly has an 'any' ... Remove this comment to see the full error message
     async authenticate(tokenFromFlag) {
         const [token] = await getToken(tokenFromFlag);
         if (token) {
@@ -435,7 +415,6 @@ export default class BaseCommand extends Command {
         // if we are running inside a monorepo or not.
         // ==================================================
         // retrieve the repository root
-        // @ts-expect-error TS(2554) FIXME: Expected 1 arguments, but got 0.
         const rootDir = await getRepositoryRoot();
         // Get framework, add to analytics payload for every command, if a framework is set
         const fs = new NodeFS();
@@ -645,16 +624,3 @@ export default class BaseCommand extends Command {
         return this.name() === 'serve' ? 'production' : 'dev';
     }
 }
-/**
- * Retrieves the repository root through a git command.
- * Returns undefined if not a git project.
- * @param {string} [cwd] The optional current working directory
- * @returns {Promise<string|undefined>}
- */
-// @ts-expect-error TS(7006) FIXME: Parameter 'cwd' implicitly has an 'any' type.
-async function getRepositoryRoot(cwd) {
-    const res = await findUp('.git', { cwd, type: 'directory' });
-    if (res) {
-        return join(res, '..');
-    }
-}

package/src/commands/logs/build.mjs

@@ -0,0 +1,72 @@
+import inquirer from 'inquirer';
+import { log, chalk } from '../../utils/command-helpers.mjs';
+import { getWebSocket } from '../../utils/websockets/index.mjs';
+export function getName({ deploy, userId }) {
+    let normalisedName = '';
+    const isUserDeploy = deploy.user_id === userId;
+    switch (deploy.context) {
+        case 'branch-deploy':
+            normalisedName = 'Branch Deploy';
+            break;
+        case 'deploy-preview': {
+            // Deploys via the CLI can have the `deploy-preview` context
+            // but no review id because they don't come from a PR.
+            //
+            const id = deploy.review_id;
+            normalisedName = id ? `Deploy Preview #${id}` : 'Deploy Preview';
+            break;
+        }
+        default:
+            normalisedName = 'Production';
+    }
+    if (isUserDeploy) {
+        normalisedName += chalk.yellow('*');
+    }
+    return `(${deploy.id.slice(0, 7)}) ${normalisedName}`;
+}
+const logsBuild = async (options, command) => {
+    await command.authenticate();
+    const client = command.netlify.api;
+    const { site } = command.netlify;
+    const { id: siteId } = site;
+    const userId = command.netlify.globalConfig.get('userId');
+    const deploys = await client.listSiteDeploys({ siteId, state: 'building' });
+    if (deploys.length === 0) {
+        log('No active builds');
+        return;
+    }
+    let [deploy] = deploys;
+    if (deploys.length > 1) {
+        const { result } = await inquirer.prompt({
+            name: 'result',
+            type: 'list',
+            message: `Select a deploy\n\n${chalk.yellow('*')} indicates a deploy created by you`,
+            choices: deploys.map((dep) => ({
+                name: getName({ deploy: dep, userId }),
+                value: dep.id,
+            })),
+        });
+        deploy = deploys.find((dep) => dep.id === result);
+    }
+    const { id } = deploy;
+    const ws = getWebSocket(`wss://socketeer.services.netlify.com/build/logs`);
+    ws.on('open', function open() {
+        ws.send(JSON.stringify({ deploy_id: id, site_id: siteId, access_token: client.accessToken }));
+    });
+    ws.on('message', (data) => {
+        const { message, section, type } = JSON.parse(data);
+        log(message);
+        if (type === 'report' && section === 'building') {
+            // end of build
+            ws.close();
+        }
+    });
+    ws.on('close', () => {
+        log('---');
+    });
+};
+export const createLogsBuildCommand = (program) => program
+    .command('logs:deploy')
+    .alias('logs:build')
+    .description('(Beta) Stream the logs of deploys currently being built to the console')
+    .action(logsBuild);

package/src/commands/logs/functions.mjs

@@ -0,0 +1,73 @@
+import { Argument } from 'commander';
+import inquirer from 'inquirer';
+import { chalk, log } from '../../utils/command-helpers.mjs';
+import { getWebSocket } from '../../utils/websockets/index.mjs';
+function getLog(logData) {
+    let logString = '';
+    switch (logData.level) {
+        case 'INFO':
+            logString += chalk.blueBright(logData.level);
+            break;
+        case 'WARN':
+            logString += chalk.yellowBright(logData.level);
+            break;
+        case 'ERROR':
+            logString += chalk.redBright(logData.level);
+            break;
+        default:
+            logString += logData.level;
+            break;
+    }
+    return `${logString} ${logData.message}`;
+}
+const logsFunction = async (functionName, options, command) => {
+    const client = command.netlify.api;
+    const { site } = command.netlify;
+    const { id: siteId } = site;
+    const { functions } = await client.searchSiteFunctions({ siteId });
+    let selectedFunction;
+    if (functionName) {
+        selectedFunction = functions.find((fn) => fn.n === functionName);
+    }
+    else {
+        const { result } = await inquirer.prompt({
+            name: 'result',
+            type: 'list',
+            message: 'Select a function',
+            choices: functions.map((fn) => fn.n),
+        });
+        selectedFunction = functions.find((fn) => fn.n === result);
+    }
+    if (!selectedFunction) {
+        log(`Could not find function ${functionName}`);
+        return;
+    }
+    const { a: accountId, oid: functionId } = selectedFunction;
+    const ws = getWebSocket('wss://socketeer.services.netlify.com/function/logs');
+    ws.on('open', () => {
+        ws.send(JSON.stringify({
+            function_id: functionId,
+            site_id: siteId,
+            access_token: client.accessToken,
+            account_id: accountId,
+        }));
+    });
+    ws.on('message', (data) => {
+        const logData = JSON.parse(data);
+        log(getLog(logData));
+    });
+    ws.on('close', () => {
+        log('Connection closed');
+    });
+    ws.on('error', (err) => {
+        log('Connection error');
+        log(err);
+    });
+};
+export const createLogsFunctionCommand = (program) => program
+    .command('logs:function')
+    .alias('logs:functions')
+    .addArgument(new Argument('[functionName]', 'Name of the function to stream logs for'))
+    .addExamples(['netlify logs:function my-function', 'netlify logs:function'])
+    .description('(Beta) Stream netlify function logs to the console')
+    .action(logsFunction);

package/src/commands/logs/index.mjs

@@ -0,0 +1,12 @@
+import { createLogsBuildCommand } from './build.mjs';
+import { createLogsFunctionCommand } from './functions.mjs';
+export const createLogsCommand = (program) => {
+    createLogsBuildCommand(program);
+    createLogsFunctionCommand(program);
+    return program
+        .command('logs')
+        .alias('log')
+        .description('Stream logs from your site')
+        .addExamples(['netlify logs:deploy', 'netlify logs:function', 'netlify logs:function my-function'])
+        .action((_, command) => command.help());
+};

package/src/commands/main.mjs

@@ -26,6 +26,7 @@ import { createLinkCommand } from './link/index.mjs';
 import { createLmCommand } from './lm/index.mjs';
 import { createLoginCommand } from './login/index.mjs';
 import { createLogoutCommand } from './logout/index.mjs';
+import { createLogsCommand } from './logs/index.mjs';
 import { createOpenCommand } from './open/index.mjs';
 import { createRecipesCommand } from './recipes/index.mjs';
 import { createServeCommand } from './serve/serve.mjs';
@@ -171,6 +172,7 @@ export const createMainCommand = () => {
     createSwitchCommand(program);
     createUnlinkCommand(program);
     createWatchCommand(program);
+    createLogsCommand(program);
     program
         .version(USER_AGENT, '-V')
         .showSuggestionAfterError(true)

package/src/commands/status/status.mjs

@@ -9,7 +9,7 @@ import { createStatusHooksCommand } from './status-hooks.mjs';
  */
 // @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const status = async (options, command) => {
-    const { api, globalConfig, site } = command.netlify;
+    const { api, globalConfig, site, siteInfo } = command.netlify;
     const current = globalConfig.get('userId');
     // @ts-expect-error TS(2554) FIXME: Expected 1 arguments, but got 0.
     const [accessToken] = await getToken();
@@ -26,6 +26,7 @@ const status = async (options, command) => {
     let accounts;
     let user;
     try {
+        // eslint-disable-next-line @typescript-eslint/no-extra-semi
         ;
         [accounts, user] = await Promise.all([api.listAccountsForUser(), api.getCurrentUser()]);
     }
@@ -56,35 +57,19 @@ const status = async (options, command) => {
         warn('Did you run `netlify link` yet?');
         error(`You don't appear to be in a folder that is linked to a site`);
     }
-    let siteData;
-    try {
-        siteData = await api.getSite({ siteId });
-    }
-    catch (error_) {
-        // unauthorized
-        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
-        if (error_.status === 401) {
-            warn(`Log in with a different account or re-link to a site you have permission for`);
-            error(`Not authorized to view the currently linked site (${siteId})`);
-        }
-        // missing
-        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
-        if (error_.status === 404) {
-            error(`The site this folder is linked to can't be found`);
-        }
-        // @ts-expect-error TS(2345) FIXME: Argument of type 'unknown' is not assignable to pa... Remove this comment to see the full error message
-        error(error_);
+    if (!siteInfo) {
+        error(`No site info found for site ${siteId}`);
     }
     // Json only logs out if --json flag is passed
     if (options.json) {
         logJson({
             account: cleanAccountData,
             siteData: {
-                'site-name': `${siteData.name}`,
+                'site-name': `${siteInfo.name}`,
                 'config-path': site.configPath,
-                'admin-url': siteData.admin_url,
-                'site-url': siteData.ssl_url || siteData.url,
-                'site-id': siteData.id,
+                'admin-url': siteInfo.admin_url,
+                'site-url': siteInfo.ssl_url || siteInfo.url,
+                'site-id': siteInfo.id,
             },
         });
     }
@@ -92,11 +77,11 @@ const status = async (options, command) => {
  Netlify Site Info  │
 ────────────────────┘`);
     log(prettyjson.render({
-        'Current site': `${siteData.name}`,
+        'Current site': `${siteInfo.name}`,
         'Netlify TOML': site.configPath,
-        'Admin URL': chalk.magentaBright(siteData.admin_url),
-        'Site URL': chalk.cyanBright(siteData.ssl_url || siteData.url),
-        'Site Id': chalk.yellowBright(siteData.id),
+        'Admin URL': chalk.magentaBright(siteInfo.admin_url),
+        'Site URL': chalk.cyanBright(siteInfo.ssl_url || siteInfo.url),
+        'Site Id': chalk.yellowBright(siteInfo.id),
     }));
     log();
 };

package/src/utils/websockets/index.mjs

@@ -0,0 +1,2 @@
+import WebSocket from 'ws';
+export const getWebSocket = (url) => new WebSocket(url);