netlify-cli 17.3.1 → 17.4.0

package/src/commands/blobs/blobs-delete.mjs

@@ -0,0 +1,35 @@
+import { getStore } from '@netlify/blobs';
+import { chalk, error as printError } from '../../utils/command-helpers.mjs';
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs';
+/**
+ * The blobs:delete command
+ */
+const blobsDelete = async (storeName, key, _options, command) => {
+    const { api, siteInfo } = command.netlify;
+    const store = getStore({
+        apiURL: `${api.scheme}://${api.host}`,
+        name: storeName,
+        siteID: siteInfo.id ?? '',
+        token: api.accessToken ?? '',
+    });
+    try {
+        await store.delete(key);
+    }
+    catch {
+        return printError(`Could not delete blob ${chalk.yellow(key)} from store ${chalk.yellow(storeName)}`);
+    }
+};
+/**
+ * Creates the `netlify blobs:delete` command
+ * @param {import('../base-command.mjs').default} program
+ * @returns
+ */
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createBlobsDeleteCommand = (program) => program
+    .command('blobs:delete')
+    .description(`(Beta) Deletes an object with a given key, if it exists, from a Netlify Blobs store`)
+    .argument('<store>', 'Name of the store')
+    .argument('<key>', 'Object key')
+    .alias('blob:delete')
+    .hook('preAction', requiresSiteInfo)
+    .action(blobsDelete);

package/src/commands/blobs/blobs-get.mjs

@@ -0,0 +1,44 @@
+import { promises as fs } from 'fs';
+import { resolve } from 'path';
+import { getStore } from '@netlify/blobs';
+import { chalk, error as printError } from '../../utils/command-helpers.mjs';
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs';
+const blobsGet = async (storeName, key, options, command) => {
+    const { api, siteInfo } = command.netlify;
+    const { output } = options;
+    const store = getStore({
+        apiURL: `${api.scheme}://${api.host}`,
+        name: storeName,
+        siteID: siteInfo?.id ?? '',
+        token: api.accessToken ?? '',
+    });
+    let blob;
+    try {
+        blob = await store.get(key);
+    }
+    catch {
+        return printError(`Could not retrieve blob ${chalk.yellow(key)} from store ${chalk.yellow(storeName)}`);
+    }
+    if (blob === null) {
+        return printError(`Blob ${chalk.yellow(key)} does not exist in store ${chalk.yellow(storeName)}`);
+    }
+    if (output) {
+        const path = resolve(output);
+        await fs.writeFile(path, blob);
+    }
+    else {
+        console.log(blob);
+    }
+};
+/**
+ * Creates the `netlify blobs:get` command
+ */
+export const createBlobsGetCommand = (program) => program
+    .command('blobs:get')
+    .description(`(Beta) Reads an object with a given key from a Netlify Blobs store and, if it exists, prints the content to the terminal or saves it to a file`)
+    .argument('<store>', 'Name of the store')
+    .argument('<key>', 'Object key')
+    .option('-o, --output <path>', 'Defines the filesystem path where the blob data should be persisted')
+    .alias('blob:get')
+    .hook('preAction', requiresSiteInfo)
+    .action(blobsGet);

package/src/commands/blobs/blobs-list.mjs

@@ -0,0 +1,48 @@
+import { getStore } from '@netlify/blobs';
+import AsciiTable from 'ascii-table';
+import { chalk, error as printError, log, logJson } from '../../utils/command-helpers.mjs';
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs';
+const blobsList = async (storeName, options, command) => {
+    const { api, siteInfo } = command.netlify;
+    const store = getStore({
+        apiURL: `${api.scheme}://${api.host}`,
+        name: storeName,
+        siteID: siteInfo?.id ?? '',
+        token: api.accessToken ?? '',
+    });
+    try {
+        const { blobs, directories } = await store.list({
+            directories: Boolean(options.directories),
+            prefix: options.prefix,
+        });
+        if (options.json) {
+            logJson({ blobs, directories });
+            return;
+        }
+        const table = new AsciiTable(`Netlify Blobs (${storeName})`);
+        table.setHeading('Key', 'ETag');
+        directories.forEach((directory) => {
+            table.addRow(directory, '(directory)');
+        });
+        blobs.forEach((blob) => {
+            table.addRow(blob.key, blob.etag);
+        });
+        log(table.toString());
+    }
+    catch {
+        return printError(`Could not list blobs from store ${chalk.yellow(storeName)}`);
+    }
+};
+/**
+ * Creates the `netlify blobs:list` command
+ */
+export const createBlobsListCommand = (program) => program
+    .command('blobs:list')
+    .description(`(Beta) Lists objects in a Netlify Blobs store`)
+    .argument('<store>', 'Name of the store')
+    .option('-d, --directories', `Indicates that keys with the '/' character should be treated as directories, returning a list of sub-directories at a given level rather than all the keys inside them`)
+    .option('-p, --prefix <prefix>', `A string for filtering down the entries; when specified, only the entries whose key starts with that prefix are returned`)
+    .option('--json', `Output list contents as JSON`)
+    .alias('blob:list')
+    .hook('preAction', requiresSiteInfo)
+    .action(blobsList);

package/src/commands/blobs/blobs-set.mjs

@@ -0,0 +1,54 @@
+import { promises as fs } from 'fs';
+import { resolve } from 'path';
+import { getStore } from '@netlify/blobs';
+import { chalk, error as printError, isNodeError } from '../../utils/command-helpers.mjs';
+import requiresSiteInfo from '../../utils/hooks/requires-site-info.mjs';
+// eslint-disable-next-line max-params
+const blobsSet = async (storeName, key, valueParts, options, command) => {
+    const { api, siteInfo } = command.netlify;
+    const { input } = options;
+    const store = getStore({
+        apiURL: `${api.scheme}://${api.host}`,
+        name: storeName,
+        siteID: siteInfo.id ?? '',
+        token: api.accessToken ?? '',
+    });
+    let value = valueParts.join(' ');
+    if (input) {
+        const inputPath = resolve(input);
+        try {
+            value = await fs.readFile(inputPath, 'utf8');
+        }
+        catch (error) {
+            if (isNodeError(error) && error.code === 'ENOENT') {
+                return printError(`Could not set blob ${chalk.yellow(key)} because the file ${chalk.underline(inputPath)} does not exist`);
+            }
+            if (isNodeError(error) && error.code === 'EISDIR') {
+                return printError(`Could not set blob ${chalk.yellow(key)} because the path ${chalk.underline(inputPath)} is a directory`);
+            }
+            return printError(`Could not set blob ${chalk.yellow(key)} because the path ${chalk.underline(inputPath)} could not be read`);
+        }
+    }
+    else if (!value) {
+        return printError(`You must provide a value as a command-line parameter (e.g. 'netlify blobs:set my-store my-key my value') or specify the path to a file from where the value should be read (e.g. 'netlify blobs:set my-store my-key --input ./my-file.txt')`);
+    }
+    try {
+        await store.set(key, value);
+    }
+    catch {
+        return printError(`Could not set blob ${chalk.yellow(key)} in store ${chalk.yellow(storeName)}`);
+    }
+};
+/**
+ * Creates the `netlify blobs:set` command
+ */
+export const createBlobsSetCommand = (program) => program
+    .command('blobs:set')
+    .description(`(Beta) Writes to a Netlify Blobs store an object with the data provided in the command or the contents of a file defined by the 'input' parameter`)
+    .argument('<store>', 'Name of the store')
+    .argument('<key>', 'Object key')
+    .argument('[value...]', 'Object value')
+    .option('-i, --input <path>', 'Defines the filesystem path where the blob data should be read from')
+    .alias('blob:set')
+    .hook('preAction', requiresSiteInfo)
+    .action(blobsSet);

package/src/commands/blobs/blobs.mjs

@@ -0,0 +1,32 @@
+import { createBlobsDeleteCommand } from './blobs-delete.mjs';
+import { createBlobsGetCommand } from './blobs-get.mjs';
+import { createBlobsListCommand } from './blobs-list.mjs';
+import { createBlobsSetCommand } from './blobs-set.mjs';
+/**
+ * The blobs command
+ */
+const blobs = (_options, command) => {
+    command.help();
+};
+/**
+ * Creates the `netlify blobs` command
+ */
+export const createBlobsCommand = (program) => {
+    createBlobsDeleteCommand(program);
+    createBlobsGetCommand(program);
+    createBlobsListCommand(program);
+    createBlobsSetCommand(program);
+    return program
+        .command('blobs')
+        .alias('blob')
+        .description(`(Beta) Manage objects in Netlify Blobs`)
+        .addExamples([
+        'netlify blobs:get my-store my-key',
+        'netlify blobs:set my-store my-key This will go in a blob',
+        'netlify blobs:set my-store my-key --input ./some-file.txt',
+        'netlify blobs:delete my-store my-key',
+        'netlify blobs:list my-store',
+        'netlify blobs:list my-store --json',
+    ])
+        .action(blobs);
+};

package/src/commands/blobs/index.mjs

@@ -0,0 +1 @@
+export { createBlobsCommand } from './blobs.mjs';

package/src/commands/build/build.mjs

@@ -1,88 +1,76 @@
-// @ts-check
-import process from 'process'
-
-import { getBuildOptions, runBuild } from '../../lib/build.mjs'
-import { detectFrameworkSettings } from '../../utils/build-info.mjs'
-import { error, exit, getToken } from '../../utils/command-helpers.mjs'
-import { getEnvelopeEnv, normalizeContext } from '../../utils/env/index.mjs'
-
+import process from 'process';
+import { getBuildOptions, runBuild } from '../../lib/build.mjs';
+import { detectFrameworkSettings } from '../../utils/build-info.mjs';
+import { error, exit, getToken } from '../../utils/command-helpers.mjs';
+import { getEnvelopeEnv, normalizeContext } from '../../utils/env/index.mjs';
 /**
  * @param {import('../../lib/build.mjs').BuildConfig} options
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'token' implicitly has an 'any' ty... Remove this comment to see the full error message
 export const checkOptions = ({ cachedConfig: { siteInfo = {} }, token }) => {
-  if (!siteInfo.id) {
-    error(
-      'Could not find the site ID. If your site is not on Netlify, please run `netlify init` or `netlify deploy` first. If it is, please run `netlify link`.',
-    )
-  }
-
-  if (!token) {
-    error('Could not find the access token. Please run netlify login.')
-  }
-}
-
+    // @ts-expect-error TS(2339) FIXME: Property 'id' does not exist on type '{}'.
+    if (!siteInfo.id) {
+        error('Could not find the site ID. If your site is not on Netlify, please run `netlify init` or `netlify deploy` first. If it is, please run `netlify link`.');
+    }
+    if (!token) {
+        error('Could not find the access token. Please run netlify login.');
+    }
+};
+// @ts-expect-error TS(7006) FIXME: Parameter 'command' implicitly has an 'any' type.
 const injectEnv = async function (command, { api, buildOptions, context, siteInfo }) {
-  const isUsingEnvelope = siteInfo && siteInfo.use_envelope
-
-  const { env } = buildOptions.cachedConfig
-  if (isUsingEnvelope) {
-    buildOptions.cachedConfig.env = await getEnvelopeEnv({ api, context, env, siteInfo })
-  }
-}
-
+    const isUsingEnvelope = siteInfo && siteInfo.use_envelope;
+    const { env } = buildOptions.cachedConfig;
+    if (isUsingEnvelope) {
+        buildOptions.cachedConfig.env = await getEnvelopeEnv({ api, context, env, siteInfo });
+    }
+};
 /**
  * The build command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const build = async (options, command) => {
-  const { cachedConfig, siteInfo } = command.netlify
-  command.setAnalyticsPayload({ dry: options.dry })
-  // Retrieve Netlify Build options
-  const [token] = await getToken()
-  const settings = await detectFrameworkSettings(command, 'build')
-
-  // override the build command with the detection result if no command is specified through the config
-  if (!cachedConfig.config.build.command) {
-    cachedConfig.config.build.command = settings?.buildCommand
-    cachedConfig.config.build.commandOrigin = 'heuristics'
-  }
-
-  const buildOptions = await getBuildOptions({
-    cachedConfig,
-    packagePath: command.workspacePackage,
-    currentDir: command.workingDir,
-    token,
-    options,
-  })
-
-  if (!options.offline) {
-    checkOptions(buildOptions)
-    const { api, site } = command.netlify
-    const { context } = options
-    await injectEnv(command, { api, buildOptions, context, site, siteInfo })
-  }
-
-  const { exitCode } = await runBuild(buildOptions)
-  exit(exitCode)
-}
-
+    const { cachedConfig, siteInfo } = command.netlify;
+    command.setAnalyticsPayload({ dry: options.dry });
+    // Retrieve Netlify Build options
+    // @ts-expect-error TS(2554) FIXME: Expected 1 arguments, but got 0.
+    const [token] = await getToken();
+    const settings = await detectFrameworkSettings(command, 'build');
+    // override the build command with the detection result if no command is specified through the config
+    if (!cachedConfig.config.build.command) {
+        cachedConfig.config.build.command = settings?.buildCommand;
+        cachedConfig.config.build.commandOrigin = 'heuristics';
+    }
+    // @ts-expect-error TS(2345) FIXME: Argument of type '{ cachedConfig: any; packagePath... Remove this comment to see the full error message
+    const buildOptions = await getBuildOptions({
+        cachedConfig,
+        packagePath: command.workspacePackage,
+        currentDir: command.workingDir,
+        token,
+        options,
+    });
+    if (!options.offline) {
+        checkOptions(buildOptions);
+        const { api, site } = command.netlify;
+        const { context } = options;
+        // @ts-expect-error TS(2345) FIXME: Argument of type '{ api: any; buildOptions: { cach... Remove this comment to see the full error message
+        await injectEnv(command, { api, buildOptions, context, site, siteInfo });
+    }
+    const { exitCode } = await runBuild(buildOptions);
+    exit(exitCode);
+};
 /**
  * Creates the `netlify build` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createBuildCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createBuildCommand = (program) => program
     .command('build')
     .description('Build on your local machine')
-    .option(
-      '--context <context>',
-      'Specify a build context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev")',
-      normalizeContext,
-      process.env.CONTEXT || 'production',
-    )
+    .option('--context <context>', 'Specify a build context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev")', normalizeContext, process.env.CONTEXT || 'production')
     .option('--dry', 'Dry run: show instructions without running them', false)
     .option('-o, --offline', 'disables any features that require network access', false)
     .addExamples(['netlify build'])
-    .action(build)
+    .action(build);

package/src/commands/build/index.mjs

@@ -1 +1 @@
-export { createBuildCommand } from './build.mjs'
+export { createBuildCommand } from './build.mjs';

package/src/commands/completion/completion.mjs

@@ -1,58 +1,53 @@
-import { dirname, join } from 'path'
-import { fileURLToPath } from 'url'
-
-import { install, uninstall } from 'tabtab'
-
-import { generateAutocompletion } from '../../lib/completion/index.mjs'
-
-const completer = join(dirname(fileURLToPath(import.meta.url)), '../../lib/completion/script.mjs')
-
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'tabt... Remove this comment to see the full error message
+import { install, uninstall } from 'tabtab';
+import { generateAutocompletion } from '../../lib/completion/index.mjs';
+const completer = join(dirname(fileURLToPath(import.meta.url)), '../../lib/completion/script.mjs');
 /**
  * The completion:generate command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const completionGenerate = async (options, command) => {
-  const { parent } = command
-
-  generateAutocompletion(parent)
-
-  await install({
-    name: parent.name(),
-    completer,
-  })
-
-  console.log(`Completion for ${parent.name()} successful installed!`)
-}
-
+    const { parent } = command;
+    generateAutocompletion(parent);
+    await install({
+        name: parent.name(),
+        completer,
+    });
+    console.log(`Completion for ${parent.name()} successful installed!`);
+};
 /**
  * Creates the `netlify completion` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
 export const createCompletionCommand = (program) => {
-  program
-    .command('completion:install')
-    .alias('completion:generate')
-    .description('Generates completion script for your preferred shell')
-    .action(completionGenerate)
-
-  program
-    .command('completion:uninstall', { hidden: true })
-    .alias('completion:remove')
-    .description('Uninstalls the installed completions')
-    .addExamples(['netlify completion:uninstall'])
-    .action(async (options, command) => {
-      await uninstall({
-        name: command.parent.name(),
-      })
-    })
-
-  return program
-    .command('completion')
-    .description('Generate shell completion script\nRun this command to see instructions for your shell.')
-    .addExamples(['netlify completion:install'])
-    .action((options, command) => {
-      command.help()
-    })
-}
+    program
+        .command('completion:install')
+        .alias('completion:generate')
+        .description('Generates completion script for your preferred shell')
+        .action(completionGenerate);
+    program
+        .command('completion:uninstall', { hidden: true })
+        .alias('completion:remove')
+        .description('Uninstalls the installed completions')
+        .addExamples(['netlify completion:uninstall'])
+        // @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
+        .action(async (options, command) => {
+        await uninstall({
+            name: command.parent.name(),
+        });
+    });
+    return program
+        .command('completion')
+        .description('Generate shell completion script\nRun this command to see instructions for your shell.')
+        .addExamples(['netlify completion:install'])
+        // @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
+        .action((options, command) => {
+        command.help();
+    });
+};

package/src/commands/completion/index.mjs

@@ -1 +1 @@
-export { createCompletionCommand } from './completion.mjs'
+export { createCompletionCommand } from './completion.mjs';