netlify-cli 17.10.2 → 17.11.0

package/src/utils/detect-server-settings.js

@@ -6,21 +6,9 @@ import getPort from 'get-port';
 import { detectFrameworkSettings } from './build-info.js';
 import { NETLIFYDEVWARN, chalk, log } from './command-helpers.js';
 import { acquirePort } from './dev.js';
-import { getInternalFunctionsDir } from './functions/functions.js';
 import { getPluginsToAutoInstall } from './init/utils.js';
-/** @param {string} str */
-// @ts-expect-error TS(7006) FIXME: Parameter 'str' implicitly has an 'any' type.
 const formatProperty = (str) => chalk.magenta(`'${str}'`);
-/** @param {string} str */
-// @ts-expect-error TS(7006) FIXME: Parameter 'str' implicitly has an 'any' type.
 const formatValue = (str) => chalk.green(`'${str}'`);
-/**
- * @param {object} options
- * @param {string} options.keyFile
- * @param {string} options.certFile
- * @returns {Promise<{ key: string, cert: string, keyFilePath: string, certFilePath: string }>}
- */
-// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const readHttpsSettings = async (options) => {
     if (typeof options !== 'object' || !options.keyFile || !options.certFile) {
         throw new TypeError(`https options should be an object with ${formatProperty('keyFile')} and ${formatProperty('certFile')} string properties`);
@@ -43,23 +31,13 @@ const readHttpsSettings = async (options) => {
 };
 /**
  * Validates a property inside the devConfig to be of a given type
- * @param {import('../commands/dev/types.js').DevConfig} devConfig The devConfig
- * @param {keyof import('../commands/dev/types.js').DevConfig} property The property to validate
- * @param {'string' | 'number'} type The type it should have
  */
-// @ts-expect-error TS(7006) FIXME: Parameter 'devConfig' implicitly has an 'any' type... Remove this comment to see the full error message
 function validateProperty(devConfig, property, type) {
     if (devConfig[property] && typeof devConfig[property] !== type) {
         const formattedProperty = formatProperty(property);
         throw new TypeError(`Invalid ${formattedProperty} option provided in config. The value of ${formattedProperty} option must be of type ${type}`);
     }
 }
-/**
- *
- * @param {object} config
- * @param {import('../commands/dev/types.js').DevConfig} config.devConfig
- */
-// @ts-expect-error TS(7031) FIXME: Binding element 'devConfig' implicitly has an 'any... Remove this comment to see the full error message
 const validateFrameworkConfig = ({ devConfig }) => {
     validateProperty(devConfig, 'command', 'string');
     validateProperty(devConfig, 'port', 'number');
@@ -68,12 +46,6 @@ const validateFrameworkConfig = ({ devConfig }) => {
         throw new Error(`${formatProperty('port')} and ${formatProperty('targetPort')} options cannot have same values. Please consult the documentation for more details: https://ntl.fyi/ports-and-netlify-dev`);
     }
 };
-/**
- * @param {object} config
- * @param {import('../commands/dev/types.js').DevConfig} config.devConfig
- * @param {number=} config.detectedPort
- */
-// @ts-expect-error TS(7031) FIXME: Binding element 'detectedPort' implicitly has an '... Remove this comment to see the full error message
 const validateConfiguredPort = ({ detectedPort, devConfig }) => {
     if (devConfig.port && devConfig.port === detectedPort) {
         const formattedPort = formatProperty('port');
@@ -84,21 +56,13 @@ const DEFAULT_PORT = 8888;
 const DEFAULT_STATIC_PORT = 3999;
 /**
  * Logs a message that it was unable to determine the dist directory and falls back to the workingDir
- * @param {string} workingDir
  */
-// @ts-expect-error TS(7006) FIXME: Parameter 'workingDir' implicitly has an 'any' typ... Remove this comment to see the full error message
 const getDefaultDist = (workingDir) => {
     log(`${NETLIFYDEVWARN} Unable to determine public folder to serve files from. Using current working directory`);
     log(`${NETLIFYDEVWARN} Setup a netlify.toml file with a [dev] section to specify your dev server settings.`);
     log(`${NETLIFYDEVWARN} See docs at: https://cli.netlify.com/netlify-dev#project-detection`);
     return workingDir;
 };
-/**
- * @param {object} config
- * @param {import('../commands/dev/types.js').DevConfig} config.devConfig
- * @returns {Promise<number>}
- */
-// @ts-expect-error TS(7031) FIXME: Binding element 'devConfig' implicitly has an 'any... Remove this comment to see the full error message
 const getStaticServerPort = async ({ devConfig }) => {
     const port = await acquirePort({
         configuredPort: devConfig.staticServerPort,
@@ -107,16 +71,7 @@ const getStaticServerPort = async ({ devConfig }) => {
     });
     return port;
 };
-/**
- *
- * @param {object} config
- * @param {import('../commands/dev/types.js').DevConfig} config.devConfig
- * @param {import('commander').OptionValues} config.flags
- * @param {string} config.workingDir
- * @returns {Promise<Omit<import('./types.js').BaseServerSettings, 'command'> & {command?: string}>}
- */
-// @ts-expect-error TS(7031) FIXME: Binding element 'devConfig' implicitly has an 'any... Remove this comment to see the full error message
-const handleStaticServer = async ({ devConfig, flags, workingDir }) => {
+const handleStaticServer = async ({ devConfig, flags, workingDir, }) => {
     validateProperty(devConfig, 'staticServerPort', 'number');
     if (flags.dir) {
         log(`${NETLIFYDEVWARN} Using simple static server because ${formatProperty('--dir')} flag was specified`);
@@ -156,20 +111,11 @@ const getSettingsFromDetectedSettings = (command, settings) => {
         clearPublishDirectory: settings.clearPublishDirectory,
     };
 };
-/**
- * @param {import('../commands/dev/types.js').DevConfig} devConfig
- */
-// @ts-expect-error TS(7006) FIXME: Parameter 'devConfig' implicitly has an 'any' type... Remove this comment to see the full error message
 const hasCommandAndTargetPort = (devConfig) => devConfig.command && devConfig.targetPort;
 /**
  * Creates settings for the custom framework
- * @param {object} config
- * @param {import('../commands/dev/types.js').DevConfig} config.devConfig
- * @param {string} config.workingDir
- * @returns {import('./types.js').BaseServerSettings}
  */
-// @ts-expect-error TS(7031) FIXME: Binding element 'devConfig' implicitly has an 'any... Remove this comment to see the full error message
-const handleCustomFramework = ({ devConfig, workingDir }) => {
+const handleCustomFramework = ({ devConfig, workingDir, }) => {
     if (!hasCommandAndTargetPort(devConfig)) {
         throw new Error(`${formatProperty('command')} and ${formatProperty('targetPort')} properties are required when ${formatProperty('framework')} is set to ${formatValue('#custom')}`);
     }
@@ -183,10 +129,6 @@ const handleCustomFramework = ({ devConfig, workingDir }) => {
 };
 /**
  * Merges the framework settings with the devConfig
- * @param {object} config
- * @param {import('../commands/dev/types.js').DevConfig} config.devConfig
- * @param {string} config.workingDir
- * @param {Partial<import('./types.js').BaseServerSettings>=} config.frameworkSettings
  */
 const mergeSettings = async ({ devConfig, frameworkSettings = {}, workingDir, }) => {
     const command = devConfig.command || frameworkSettings.command;
@@ -267,25 +209,19 @@ const detectServerSettings = async (devConfig, flags, command) => {
     });
     // @ts-expect-error TS(2339) FIXME: Property 'functions' does not exist on type '{}'.
     const functionsDir = devConfig.functions || settings.functions;
-    // @ts-expect-error TS(2345) FIXME: Argument of type '{ base: any; }' is not assignabl... Remove this comment to see the full error message
-    const internalFunctionsDir = await getInternalFunctionsDir({ base: command.workingDir });
-    const shouldStartFunctionsServer = Boolean(functionsDir || internalFunctionsDir);
     return {
         ...settings,
         port: acquiredPort,
         jwtSecret: devConfig.jwtSecret || 'secret',
         jwtRolePath: devConfig.jwtRolePath || 'app_metadata.authorization.roles',
         functions: functionsDir,
-        ...(shouldStartFunctionsServer && { functionsPort: await getPort({ port: devConfig.functionsPort || 0 }) }),
+        functionsPort: await getPort({ port: devConfig.functionsPort || 0 }),
         ...(devConfig.https && { https: await readHttpsSettings(devConfig.https) }),
     };
 };
 /**
  * Returns a copy of the provided config with any plugins provided by the
  * server settings
- * @param {*} config
- * @param {Partial<import('./types.js').ServerSettings>} settings
- * @returns {*} Modified config
  */
 // @ts-expect-error TS(7006) FIXME: Parameter 'config' implicitly has an 'any' type.
 export const getConfigWithPlugins = (config, settings) => {
@@ -300,7 +236,6 @@ export const getConfigWithPlugins = (config, settings) => {
     // @ts-expect-error TS(7006) FIXME: Parameter 'plugin' implicitly has an 'any' type.
     const existingPluginNames = new Set(existingPlugins.map((plugin) => plugin.package));
     const newPlugins = settings.plugins
-        // @ts-expect-error TS(7006) FIXME: Parameter 'pluginName' implicitly has an 'any' typ... Remove this comment to see the full error message
         .map((pluginName) => {
         if (existingPluginNames.has(pluginName)) {
             return;

package/src/utils/functions/functions.js

@@ -33,18 +33,11 @@ export const getFunctionsServePath = ({ base, packagePath = '' }) => {
 };
 /**
  * Retrieves the internal functions directory and creates it if ensureExists is provided
- * @param {object} config
- * @param {string} config.base
- * @param {boolean=} config.ensureExists
- * @param {string} config.packagePath
- * @returns
  */
-// @ts-expect-error TS(7031) FIXME: Binding element 'base' implicitly has an 'any' typ... Remove this comment to see the full error message
-export const getInternalFunctionsDir = async ({ base, ensureExists, packagePath = '' }) => {
+export const getInternalFunctionsDir = async ({ base, ensureExists, packagePath = '', }) => {
     const path = resolve(base, packagePath, getPathInProject([INTERNAL_FUNCTIONS_FOLDER]));
     if (ensureExists) {
         await fs.mkdir(path, { recursive: true });
     }
-    const isDirectory = await isDirectoryAsync(path);
-    return isDirectory ? path : null;
+    return path;
 };

package/src/lib/edge-functions/internal.js

@@ -1,46 +0,0 @@
-import { readFile, stat } from 'fs/promises';
-import { dirname, join, resolve } from 'path';
-import { getPathInProject } from '../settings.js';
-import { INTERNAL_EDGE_FUNCTIONS_FOLDER } from './consts.js';
-/**
- * @param {string} workingDir
- */
-// @ts-expect-error TS(7006) FIXME: Parameter 'workingDir' implicitly has an 'any' typ... Remove this comment to see the full error message
-export const getInternalFunctions = async (workingDir) => {
-    const path = join(workingDir, getPathInProject([INTERNAL_EDGE_FUNCTIONS_FOLDER]));
-    try {
-        const stats = await stat(path);
-        if (!stats.isDirectory()) {
-            throw new Error('Internal edge functions directory expected');
-        }
-    }
-    catch {
-        return {
-            functions: [],
-            path: null,
-        };
-    }
-    try {
-        const manifestPath = join(path, 'manifest.json');
-        // @ts-expect-error TS(2345) FIXME: Argument of type 'Buffer' is not assignable to par... Remove this comment to see the full error message
-        const manifest = JSON.parse(await readFile(manifestPath));
-        if (manifest.version !== 1) {
-            throw new Error('Unsupported manifest format');
-        }
-        const data = {
-            functions: manifest.functions || [],
-            path,
-        };
-        if (manifest.import_map) {
-            // @ts-expect-error TS(2339) FIXME: Property 'importMap' does not exist on type '{ fun... Remove this comment to see the full error message
-            data.importMap = resolve(dirname(manifestPath), manifest.import_map);
-        }
-        return data;
-    }
-    catch {
-        return {
-            functions: [],
-            path,
-        };
-    }
-};