netlify-cli 17.3.1 → 17.4.0

package/src/commands/dev/types.d.ts

@@ -0,0 +1,30 @@
+import type { PollingStrategy, NetlifyTOML } from '@netlify/build-info'
+
+import type { FrameworkNames } from '../../utils/types'
+
+/** The configuration specified in the netlify.toml under [build] */
+export type BuildConfig = NonNullable<NetlifyTOML['build']>
+
+export type DevConfig = NonNullable<NetlifyTOML['dev']> & {
+  framework: FrameworkNames
+  /** Directory of the functions */
+  functions?: string
+  publish?: string
+  /** Port to serve the functions */
+  port: number
+  live: boolean
+  /** The base directory from the [build] section of the configuration file */
+  base?: string
+  staticServerPort?: number
+  functionsPort?: number
+  autoLaunch?: boolean
+  https?: {
+    keyFile: string
+    certFile: string
+  }
+  envFiles?: string[]
+
+  jwtSecret: string
+  jwtRolePath: string
+  pollingStrategies?: PollingStrategy[]
+}

package/src/commands/env/env-clone.mjs

@@ -1,16 +1,15 @@
-// @ts-check
-import { chalk, error as logError, log } from '../../utils/command-helpers.mjs'
-import { translateFromEnvelopeToMongo, translateFromMongoToEnvelope } from '../../utils/env/index.mjs'
-
+import { chalk, error as logError, log } from '../../utils/command-helpers.mjs';
+import { translateFromEnvelopeToMongo, translateFromMongoToEnvelope } from '../../utils/env/index.mjs';
+// @ts-expect-error TS(7006) FIXME: Parameter 'api' implicitly has an 'any' type.
 const safeGetSite = async (api, siteId) => {
-  try {
-    const data = await api.getSite({ siteId })
-    return { data }
-  } catch (error) {
-    return { error }
-  }
-}
-
+    try {
+        const data = await api.getSite({ siteId });
+        return { data };
+    }
+    catch (error) {
+        return { error };
+    }
+};
 /**
  * The env:clone command
  * @param {string} siteIdA Site (From)
@@ -19,207 +18,181 @@ const safeGetSite = async (api, siteId) => {
  * @param {import('../base-command.mjs').default} command
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const envClone = async (options, command) => {
-  const { api, site } = command.netlify
-
-  if (!site.id && !options.from) {
-    log(
-      'Please include the source site Id as the `--from` option, or run `netlify link` to link this folder to a Netlify site',
-    )
-    return false
-  }
-
-  const siteId = {
-    from: options.from || site.id,
-    to: options.to,
-  }
-
-  const [{ data: siteFrom, error: errorFrom }, { data: siteTo, error: errorTo }] = await Promise.all([
-    safeGetSite(api, siteId.from),
-    safeGetSite(api, siteId.to),
-  ])
-
-  if (errorFrom) {
-    logError(`Can't find site with id ${chalk.bold(siteId.from)}. Please make sure the site exists.`)
-    return false
-  }
-
-  if (errorTo) {
-    logError(`Can't find site with id ${chalk.bold(siteId.to)}. Please make sure the site exists.`)
-    return false
-  }
-
-  // determine if siteFrom and/or siteTo is on Envelope
-  let method
-  if (!siteFrom.use_envelope && !siteTo.use_envelope) {
-    method = mongoToMongo
-  } else if (!siteFrom.use_envelope && siteTo.use_envelope) {
-    method = mongoToEnvelope
-  } else if (siteFrom.use_envelope && !siteTo.use_envelope) {
-    method = envelopeToMongo
-  } else {
-    method = envelopeToEnvelope
-  }
-  const success = await method({ api, siteFrom, siteTo })
-
-  if (!success) {
-    return false
-  }
-
-  log(`Successfully cloned environment variables from ${chalk.green(siteFrom.name)} to ${chalk.green(siteTo.name)}`)
-
-  return true
-}
-
+    const { api, site } = command.netlify;
+    if (!site.id && !options.from) {
+        log('Please include the source site Id as the `--from` option, or run `netlify link` to link this folder to a Netlify site');
+        return false;
+    }
+    const siteId = {
+        from: options.from || site.id,
+        to: options.to,
+    };
+    const [{ data: siteFrom, error: errorFrom }, { data: siteTo, error: errorTo }] = await Promise.all([
+        safeGetSite(api, siteId.from),
+        safeGetSite(api, siteId.to),
+    ]);
+    if (errorFrom) {
+        logError(`Can't find site with id ${chalk.bold(siteId.from)}. Please make sure the site exists.`);
+        return false;
+    }
+    if (errorTo) {
+        logError(`Can't find site with id ${chalk.bold(siteId.to)}. Please make sure the site exists.`);
+        return false;
+    }
+    // determine if siteFrom and/or siteTo is on Envelope
+    let method;
+    if (!siteFrom.use_envelope && !siteTo.use_envelope) {
+        method = mongoToMongo;
+    }
+    else if (!siteFrom.use_envelope && siteTo.use_envelope) {
+        method = mongoToEnvelope;
+    }
+    else if (siteFrom.use_envelope && !siteTo.use_envelope) {
+        method = envelopeToMongo;
+    }
+    else {
+        method = envelopeToEnvelope;
+    }
+    const success = await method({ api, siteFrom, siteTo });
+    if (!success) {
+        return false;
+    }
+    log(`Successfully cloned environment variables from ${chalk.green(siteFrom.name)} to ${chalk.green(siteTo.name)}`);
+    return true;
+};
 /**
  * Copies the env from a site not configured with Envelope to a different site not configured with Envelope
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const mongoToMongo = async ({ api, siteFrom, siteTo }) => {
-  const [
-    {
-      build_settings: { env: envFrom = {} },
-    },
-    {
-      build_settings: { env: envTo = {} },
-    },
-  ] = [siteFrom, siteTo]
-
-  if (Object.keys(envFrom).length === 0) {
-    log(`${chalk.green(siteFrom.name)} has no environment variables, nothing to clone`)
-    return false
-  }
-
-  // Merge from site A to site B
-  const mergedEnv = {
-    ...envTo,
-    ...envFrom,
-  }
-
-  // Apply environment variable updates
-  await api.updateSite({
-    siteId: siteTo.id,
-    body: {
-      build_settings: {
-        env: mergedEnv,
-      },
-    },
-  })
-
-  return true
-}
-
+    const [{ build_settings: { env: envFrom = {} }, }, { build_settings: { env: envTo = {} }, },] = [siteFrom, siteTo];
+    if (Object.keys(envFrom).length === 0) {
+        log(`${chalk.green(siteFrom.name)} has no environment variables, nothing to clone`);
+        return false;
+    }
+    // Merge from site A to site B
+    const mergedEnv = {
+        ...envTo,
+        ...envFrom,
+    };
+    // Apply environment variable updates
+    await api.updateSite({
+        siteId: siteTo.id,
+        body: {
+            build_settings: {
+                env: mergedEnv,
+            },
+        },
+    });
+    return true;
+};
 /**
  * Copies the env from a site not configured with Envelope to a site configured with Envelope
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const mongoToEnvelope = async ({ api, siteFrom, siteTo }) => {
-  const envFrom = siteFrom.build_settings.env || {}
-  const keysFrom = Object.keys(envFrom)
-
-  if (Object.keys(envFrom).length === 0) {
-    log(`${chalk.green(siteFrom.name)} has no environment variables, nothing to clone`)
-    return false
-  }
-
-  const accountId = siteTo.account_slug
-  const siteId = siteTo.id
-
-  const envelopeTo = await api.getEnvVars({ accountId, siteId })
-
-  const envVarsToDelete = envelopeTo.filter(({ key }) => keysFrom.includes(key))
-  // delete marked env vars in parallel
-  await Promise.all(envVarsToDelete.map(({ key }) => api.deleteEnvVar({ accountId, siteId, key })))
-
-  // hit create endpoint
-  const body = translateFromMongoToEnvelope(envFrom)
-  try {
-    await api.createEnvVars({ accountId, siteId, body })
-  } catch (error) {
-    throw error.json ? error.json.msg : error
-  }
-
-  return true
-}
-
+    const envFrom = siteFrom.build_settings.env || {};
+    const keysFrom = Object.keys(envFrom);
+    if (Object.keys(envFrom).length === 0) {
+        log(`${chalk.green(siteFrom.name)} has no environment variables, nothing to clone`);
+        return false;
+    }
+    const accountId = siteTo.account_slug;
+    const siteId = siteTo.id;
+    const envelopeTo = await api.getEnvVars({ accountId, siteId });
+    // @ts-expect-error TS(7031) FIXME: Binding element 'key' implicitly has an 'any' type... Remove this comment to see the full error message
+    const envVarsToDelete = envelopeTo.filter(({ key }) => keysFrom.includes(key));
+    // delete marked env vars in parallel
+    // @ts-expect-error TS(7031) FIXME: Binding element 'key' implicitly has an 'any' type... Remove this comment to see the full error message
+    await Promise.all(envVarsToDelete.map(({ key }) => api.deleteEnvVar({ accountId, siteId, key })));
+    // hit create endpoint
+    const body = translateFromMongoToEnvelope(envFrom);
+    try {
+        await api.createEnvVars({ accountId, siteId, body });
+    }
+    catch (error) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        throw error.json ? error.json.msg : error;
+    }
+    return true;
+};
 /**
  * Copies the env from a site configured with Envelope to a site not configured with Envelope
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const envelopeToMongo = async ({ api, siteFrom, siteTo }) => {
-  const envelopeVariables = await api.getEnvVars({ accountId: siteFrom.account_slug, siteId: siteFrom.id })
-  const envFrom = translateFromEnvelopeToMongo(envelopeVariables)
-
-  if (Object.keys(envFrom).length === 0) {
-    log(`${chalk.green(siteFrom.name)} has no environment variables, nothing to clone`)
-    return false
-  }
-
-  const envTo = siteTo.build_settings.env || {}
-
-  // Merge from site A to site B
-  const mergedEnv = {
-    ...envTo,
-    ...envFrom,
-  }
-
-  // Apply environment variable updates
-  await api.updateSite({
-    siteId: siteTo.id,
-    body: {
-      build_settings: {
-        env: mergedEnv,
-      },
-    },
-  })
-
-  return true
-}
-
+    const envelopeVariables = await api.getEnvVars({ accountId: siteFrom.account_slug, siteId: siteFrom.id });
+    const envFrom = translateFromEnvelopeToMongo(envelopeVariables);
+    if (Object.keys(envFrom).length === 0) {
+        log(`${chalk.green(siteFrom.name)} has no environment variables, nothing to clone`);
+        return false;
+    }
+    const envTo = siteTo.build_settings.env || {};
+    // Merge from site A to site B
+    const mergedEnv = {
+        ...envTo,
+        ...envFrom,
+    };
+    // Apply environment variable updates
+    await api.updateSite({
+        siteId: siteTo.id,
+        body: {
+            build_settings: {
+                env: mergedEnv,
+            },
+        },
+    });
+    return true;
+};
 /**
  * Copies the env from a site configured with Envelope to a different site configured with Envelope
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 const envelopeToEnvelope = async ({ api, siteFrom, siteTo }) => {
-  const [envelopeFrom, envelopeTo] = await Promise.all([
-    api.getEnvVars({ accountId: siteFrom.account_slug, siteId: siteFrom.id }),
-    api.getEnvVars({ accountId: siteTo.account_slug, siteId: siteTo.id }),
-  ])
-
-  const keysFrom = envelopeFrom.map(({ key }) => key)
-
-  if (keysFrom.length === 0) {
-    log(`${chalk.green(siteFrom.name)} has no environment variables, nothing to clone`)
-    return false
-  }
-
-  const accountId = siteTo.account_slug
-  const siteId = siteTo.id
-  const envVarsToDelete = envelopeTo.filter(({ key }) => keysFrom.includes(key))
-  // delete marked env vars in parallel
-  await Promise.all(envVarsToDelete.map(({ key }) => api.deleteEnvVar({ accountId, siteId, key })))
-
-  // hit create endpoint
-  try {
-    await api.createEnvVars({ accountId, siteId, body: envelopeFrom })
-  } catch (error) {
-    throw error.json ? error.json.msg : error
-  }
-
-  return true
-}
-
+    const [envelopeFrom, envelopeTo] = await Promise.all([
+        api.getEnvVars({ accountId: siteFrom.account_slug, siteId: siteFrom.id }),
+        api.getEnvVars({ accountId: siteTo.account_slug, siteId: siteTo.id }),
+    ]);
+    // @ts-expect-error TS(7031) FIXME: Binding element 'key' implicitly has an 'any' type... Remove this comment to see the full error message
+    const keysFrom = envelopeFrom.map(({ key }) => key);
+    if (keysFrom.length === 0) {
+        log(`${chalk.green(siteFrom.name)} has no environment variables, nothing to clone`);
+        return false;
+    }
+    const accountId = siteTo.account_slug;
+    const siteId = siteTo.id;
+    // @ts-expect-error TS(7031) FIXME: Binding element 'key' implicitly has an 'any' type... Remove this comment to see the full error message
+    const envVarsToDelete = envelopeTo.filter(({ key }) => keysFrom.includes(key));
+    // delete marked env vars in parallel
+    // @ts-expect-error TS(7031) FIXME: Binding element 'key' implicitly has an 'any' type... Remove this comment to see the full error message
+    await Promise.all(envVarsToDelete.map(({ key }) => api.deleteEnvVar({ accountId, siteId, key })));
+    // hit create endpoint
+    try {
+        await api.createEnvVars({ accountId, siteId, body: envelopeFrom });
+    }
+    catch (error) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        throw error.json ? error.json.msg : error;
+    }
+    return true;
+};
 /**
  * Creates the `netlify env:clone` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createEnvCloneCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createEnvCloneCommand = (program) => program
     .command('env:clone')
     .alias('env:migrate')
     .option('-f, --from <from>', 'Site ID (From)')
     .requiredOption('-t, --to <to>', 'Site ID (To)')
     .description(`Clone environment variables from one site to another`)
     .addExamples(['netlify env:clone --to <to-site-id>', 'netlify env:clone --to <to-site-id> --from <from-site-id>'])
-    .action(envClone)
+    .action(envClone);

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

@@ -1,85 +1,66 @@
-// @ts-check
-import { Option } from 'commander'
-
-import { chalk, error, log, logJson } from '../../utils/command-helpers.mjs'
-import { AVAILABLE_CONTEXTS, getEnvelopeEnv, normalizeContext } from '../../utils/env/index.mjs'
-
+import { Option } from 'commander';
+import { chalk, error, log, logJson } from '../../utils/command-helpers.mjs';
+import { AVAILABLE_CONTEXTS, getEnvelopeEnv, normalizeContext } from '../../utils/env/index.mjs';
 /**
  * The env:get command
  * @param {string} name Environment variable name
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'name' implicitly has an 'any' type.
 const envGet = async (name, options, command) => {
-  const { context, scope } = options
-  const { api, cachedConfig, site } = command.netlify
-  const siteId = site.id
-
-  if (!siteId) {
-    log('No site id found, please run inside a site folder or `netlify link`')
-    return false
-  }
-
-  const { siteInfo } = cachedConfig
-  let { env } = cachedConfig
-
-  if (siteInfo.use_envelope) {
-    env = await getEnvelopeEnv({ api, context, env, key: name, scope, siteInfo })
-  } else if (context !== 'dev' || scope !== 'any') {
-    error(
-      `To specify a context or scope, please run ${chalk.yellow(
-        'netlify open:admin',
-      )} to open the Netlify UI and opt in to the new environment variables experience from Site settings`,
-    )
-    return false
-  }
-
-  const { value } = env[name] || {}
-
-  // Return json response for piping commands
-  if (options.json) {
-    logJson(value ? { [name]: value } : {})
-    return false
-  }
-
-  if (!value) {
-    const contextType = AVAILABLE_CONTEXTS.includes(context) ? 'context' : 'branch'
-    const withContext = `in the ${chalk.magenta(context)} ${contextType}`
-    const withScope = scope === 'any' ? '' : ` and the ${chalk.magenta(scope)} scope`
-    log(`No value set ${withContext}${withScope} for environment variable ${chalk.yellow(name)}`)
-    return false
-  }
-
-  log(value)
-}
-
+    const { context, scope } = options;
+    const { api, cachedConfig, site } = command.netlify;
+    const siteId = site.id;
+    if (!siteId) {
+        log('No site id found, please run inside a site folder or `netlify link`');
+        return false;
+    }
+    const { siteInfo } = cachedConfig;
+    let { env } = cachedConfig;
+    if (siteInfo.use_envelope) {
+        env = await getEnvelopeEnv({ api, context, env, key: name, scope, siteInfo });
+    }
+    else if (context !== 'dev' || scope !== 'any') {
+        error(`To specify a context or scope, please run ${chalk.yellow('netlify open:admin')} to open the Netlify UI and opt in to the new environment variables experience from Site settings`);
+        return false;
+    }
+    const { value } = env[name] || {};
+    // Return json response for piping commands
+    if (options.json) {
+        logJson(value ? { [name]: value } : {});
+        return false;
+    }
+    if (!value) {
+        const contextType = AVAILABLE_CONTEXTS.includes(context) ? 'context' : 'branch';
+        const withContext = `in the ${chalk.magenta(context)} ${contextType}`;
+        const withScope = scope === 'any' ? '' : ` and the ${chalk.magenta(scope)} scope`;
+        log(`No value set ${withContext}${withScope} for environment variable ${chalk.yellow(name)}`);
+        return false;
+    }
+    log(value);
+};
 /**
  * Creates the `netlify env:get` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createEnvGetCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createEnvGetCommand = (program) => program
     .command('env:get')
     .argument('<name>', 'Environment variable name')
-    .option(
-      '-c, --context <context>',
-      'Specify a deploy context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev")',
-      normalizeContext,
-      'dev',
-    )
-    .addOption(
-      new Option('-s, --scope <scope>', 'Specify a scope')
-        .choices(['builds', 'functions', 'post-processing', 'runtime', 'any'])
-        .default('any'),
-    )
+    .option('-c, --context <context>', 'Specify a deploy context or branch (contexts: "production", "deploy-preview", "branch-deploy", "dev")', normalizeContext, 'dev')
+    .addOption(new Option('-s, --scope <scope>', 'Specify a scope')
+    .choices(['builds', 'functions', 'post-processing', 'runtime', 'any'])
+    .default('any'))
     .addExamples([
-      'netlify env:get MY_VAR # get value for MY_VAR in dev context',
-      'netlify env:get MY_VAR --context production',
-      'netlify env:get MY_VAR --context branch:staging',
-      'netlify env:get MY_VAR --scope functions',
-    ])
+    'netlify env:get MY_VAR # get value for MY_VAR in dev context',
+    'netlify env:get MY_VAR --context production',
+    'netlify env:get MY_VAR --context branch:staging',
+    'netlify env:get MY_VAR --scope functions',
+])
     .description('Get resolved value of specified environment variable (includes netlify.toml)')
+    // @ts-expect-error TS(7006) FIXME: Parameter 'name' implicitly has an 'any' type.
     .action(async (name, options, command) => {
-      await envGet(name, options, command)
-    })
+    await envGet(name, options, command);
+});