@netlify/dev 2.2.2 → 2.3.1

package/README.md

@@ -21,7 +21,7 @@ Functions, Blobs, Static files, and Redirects.
 | Cache API              | ✅ Yes    |
 | Redirects and Rewrites | ✅ Yes    |
 | Headers                | ❌ No     |
-| Environment Variables  | ❌ No     |
+| Environment Variables  | ✅ Yes    |
 
 > Note: Missing features will be added incrementally. This module is **not** intended to be a full replacement for the
 > Netlify CLI.

package/dist/main.cjs

@@ -33,6 +33,7 @@ __export(main_exports, {
   NetlifyDev: () => NetlifyDev
 });
 module.exports = __toCommonJS(main_exports);
+var import_node_fs2 = require("fs");
 var import_node_path2 = __toESM(require("path"), 1);
 var import_node_process2 = __toESM(require("process"), 1);
 var import_config = require("@netlify/config");
@@ -41,6 +42,139 @@ var import_dev = require("@netlify/functions/dev");
 var import_redirects = require("@netlify/redirects");
 var import_static = require("@netlify/static");
 
+// src/lib/env.ts
+var SUPPORTED_CONTEXTS = ["all", "production", "deploy-preview", "branch-deploy", "dev"];
+var injectEnvVariables = async ({
+  accountSlug,
+  baseVariables = {},
+  envAPI,
+  netlifyAPI,
+  siteID
+}) => {
+  const results = {};
+  let variables = baseVariables;
+  if (netlifyAPI && accountSlug) {
+    variables = await getEnvelopeEnv({
+      accountId: accountSlug,
+      api: netlifyAPI,
+      env: baseVariables,
+      siteId: siteID
+    });
+  }
+  for (const [key, variable] of Object.entries(variables)) {
+    const existsInProcess = envAPI.has(key);
+    const [usedSource, ...overriddenSources] = existsInProcess ? ["process", ...variable.sources] : variable.sources;
+    const isInternal = variable.sources.includes("internal");
+    const result = {
+      isInternal,
+      originalValue: envAPI.get(key),
+      overriddenSources,
+      usedSource
+    };
+    if (!existsInProcess || isInternal) {
+      envAPI.set(key, variable.value);
+    }
+    results[key] = result;
+  }
+  return results;
+};
+var getValueForContext = (values, contextOrBranch) => {
+  const isSupportedContext = SUPPORTED_CONTEXTS.includes(contextOrBranch);
+  if (!isSupportedContext) {
+    const valueMatchingAsBranch = values.find((val) => val.context_parameter === contextOrBranch);
+    if (valueMatchingAsBranch != null) {
+      return valueMatchingAsBranch;
+    }
+    const valueMatchingContext = values.find((val) => val.context === "all" || val.context === "branch-deploy");
+    return valueMatchingContext ?? void 0;
+  }
+  const valueMatchingAsContext = values.find((val) => val.context === "all" || val.context === contextOrBranch);
+  return valueMatchingAsContext ?? void 0;
+};
+var filterEnvBySource = (env, source) => Object.fromEntries(Object.entries(env).filter(([, variable]) => variable.sources[0] === source));
+var fetchEnvelopeItems = async function({
+  accountId,
+  api,
+  key,
+  siteId
+}) {
+  if (accountId === void 0) {
+    return [];
+  }
+  try {
+    if (key) {
+      const envelopeItem = await api.getEnvVar({ accountId, key, siteId });
+      return [envelopeItem];
+    }
+    const envelopeItems = await api.getEnvVars({ accountId, siteId });
+    return envelopeItems;
+  } catch {
+    return [];
+  }
+};
+var formatEnvelopeData = ({
+  context = "dev",
+  envelopeItems = [],
+  scope = "any",
+  source
+}) => envelopeItems.filter(({ values }) => Boolean(getValueForContext(values, context))).filter(({ scopes }) => scope === "any" ? true : scopes.includes(scope)).sort((left, right) => left.key.toLowerCase() < right.key.toLowerCase() ? -1 : 1).reduce((acc, cur) => {
+  const val = getValueForContext(cur.values, context);
+  if (val === void 0) {
+    throw new TypeError(`failed to locate environment variable value for ${context} context`);
+  }
+  const { context: itemContext, context_parameter: branch, value } = val;
+  return {
+    ...acc,
+    [cur.key]: {
+      context: itemContext,
+      branch,
+      scopes: cur.scopes,
+      sources: [source],
+      value
+    }
+  };
+}, {});
+var getEnvelopeEnv = async ({
+  accountId,
+  api,
+  context = "dev",
+  env,
+  key = "",
+  raw = false,
+  scope = "any",
+  siteId
+}) => {
+  const [accountEnvelopeItems, siteEnvelopeItems] = await Promise.all([
+    fetchEnvelopeItems({ api, accountId, key }),
+    fetchEnvelopeItems({ api, accountId, key, siteId })
+  ]);
+  const accountEnv = formatEnvelopeData({ context, envelopeItems: accountEnvelopeItems, scope, source: "account" });
+  const siteEnv = formatEnvelopeData({ context, envelopeItems: siteEnvelopeItems, scope, source: "ui" });
+  if (raw) {
+    const entries = Object.entries({ ...accountEnv, ...siteEnv });
+    return entries.reduce(
+      (obj, [envVarKey, metadata]) => ({
+        ...obj,
+        [envVarKey]: metadata.value
+      }),
+      {}
+    );
+  }
+  const generalEnv = filterEnvBySource(env, "general");
+  const internalEnv = filterEnvBySource(env, "internal");
+  const addonsEnv = filterEnvBySource(env, "addons");
+  const configFileEnv = filterEnvBySource(env, "configFile");
+  const includeConfigEnvVars = /any|builds|post[-_]processing/.test(scope);
+  return {
+    ...generalEnv,
+    ...accountEnv,
+    ...includeConfigEnvVars ? addonsEnv : {},
+    ...siteEnv,
+    ...includeConfigEnvVars ? configFileEnv : {},
+    ...internalEnv
+  };
+};
+
 // src/lib/fs.ts
 var import_node_fs = require("fs");
 var isDirectory = async (path3) => {
@@ -112,6 +246,7 @@ var getRuntime = async ({ blobs, deployID, projectRoot, siteID }) => {
     siteID
   });
   return {
+    env,
     stop: async () => {
       restoreEnvironment(envSnapshot);
       await blobsServer?.stop();
@@ -122,6 +257,8 @@ var getRuntime = async ({ blobs, deployID, projectRoot, siteID }) => {
 // src/main.ts
 var notFoundHandler = async () => new Response("Not found", { status: 404 });
 var NetlifyDev = class {
+  #apiHost;
+  #apiScheme;
   #apiToken;
   #config;
   #features;
@@ -130,8 +267,15 @@ var NetlifyDev = class {
   #runtime;
   #siteID;
   constructor(options) {
+    if (options.apiURL) {
+      const apiURL = new URL(options.apiURL);
+      this.#apiHost = apiURL.host;
+      this.#apiScheme = apiURL.protocol.slice(0, -1);
+    }
+    this.#apiToken = options.apiToken;
     this.#features = {
       blobs: options.blobs?.enabled !== false,
+      environmentVariables: options.environmentVariables?.enabled !== false,
       functions: options.functions?.enabled !== false,
       redirects: options.redirects?.enabled !== false,
       static: options.staticFiles?.enabled !== false
@@ -139,27 +283,12 @@ var NetlifyDev = class {
     this.#logger = options.logger ?? globalThis.console;
     this.#projectRoot = options.projectRoot ?? import_node_process2.default.cwd();
   }
-  async getConfig() {
-    const configFilePath = import_node_path2.default.resolve(this.#projectRoot, "netlify.toml");
-    const configFileExists = await isFile(configFilePath);
-    const config = await (0, import_config.resolveConfig)({
-      config: configFileExists ? configFilePath : void 0,
-      repositoryRoot: this.#projectRoot,
-      cwd: import_node_process2.default.cwd(),
-      context: "dev",
-      siteId: this.#siteID,
-      token: this.#apiToken,
-      mode: "cli",
-      offline: !this.#siteID
-    });
-    return config;
-  }
-  async handle(request) {
+  async handleInEphemeralDirectory(request, destPath) {
     const userFunctionsPath = this.#config?.config.functionsDirectory ?? import_node_path2.default.join(this.#projectRoot, "netlify/functions");
     const userFunctionsPathExists = await isDirectory(userFunctionsPath);
     const functions = this.#features.functions ? new import_dev.FunctionsHandler({
       config: this.#config,
-      destPath: import_node_path2.default.join(this.#projectRoot, ".netlify", "functions-serve"),
+      destPath,
       projectRoot: this.#projectRoot,
       settings: {},
       siteId: this.#siteID,
@@ -206,23 +335,63 @@ var NetlifyDev = class {
       return staticMatch.handle();
     }
   }
+  async getConfig() {
+    const configFilePath = import_node_path2.default.resolve(this.#projectRoot, "netlify.toml");
+    const configFileExists = await isFile(configFilePath);
+    const config = await (0, import_config.resolveConfig)({
+      config: configFileExists ? configFilePath : void 0,
+      context: "dev",
+      cwd: import_node_process2.default.cwd(),
+      host: this.#apiHost,
+      offline: !this.#siteID,
+      mode: "cli",
+      repositoryRoot: this.#projectRoot,
+      scheme: this.#apiScheme,
+      siteId: this.#siteID,
+      token: this.#apiToken
+    });
+    return config;
+  }
+  async handle(request) {
+    const servePath = import_node_path2.default.join(this.#projectRoot, ".netlify", "functions-serve");
+    await import_node_fs2.promises.mkdir(servePath, { recursive: true });
+    const destPath = await import_node_fs2.promises.mkdtemp(import_node_path2.default.join(servePath, "_"));
+    try {
+      return await this.handleInEphemeralDirectory(request, destPath);
+    } finally {
+      try {
+        await import_node_fs2.promises.rm(destPath, { force: true, recursive: true });
+      } catch {
+      }
+    }
+  }
   get siteIsLinked() {
     return Boolean(this.#siteID);
   }
   async start() {
     await (0, import_dev_utils.ensureNetlifyIgnore)(this.#projectRoot, this.#logger);
-    const apiToken = await (0, import_dev_utils.getAPIToken)();
-    this.#apiToken = apiToken;
+    this.#apiToken = this.#apiToken ?? await (0, import_dev_utils.getAPIToken)();
     const state = new import_dev_utils.LocalState(this.#projectRoot);
     const siteID = state.get("siteId");
     this.#siteID = siteID;
-    this.#config = await this.getConfig();
-    this.#runtime = await getRuntime({
+    const config = await this.getConfig();
+    this.#config = config;
+    const runtime = await getRuntime({
       blobs: Boolean(this.#features.blobs),
       deployID: "0",
       projectRoot: this.#projectRoot,
       siteID: siteID ?? "0"
     });
+    this.#runtime = runtime;
+    if (this.#features.environmentVariables && siteID) {
+      await injectEnvVariables({
+        accountSlug: config?.siteInfo?.account_slug,
+        baseVariables: config?.env || {},
+        envAPI: runtime.env,
+        netlifyAPI: config?.api,
+        siteID
+      });
+    }
   }
   async stop() {
     await this.#runtime?.stop();

package/dist/main.d.cts

@@ -9,6 +9,14 @@ interface Features {
     blobs?: {
         enabled: boolean;
     };
+    /**
+     * Configuration options for environment variables.
+     *
+     * {@link} https://docs.netlify.com/environment-variables/overview/
+     */
+    environmentVariables?: {
+        enabled: boolean;
+    };
     /**
      * Configuration options for Netlify Functions.
      *
@@ -33,12 +41,15 @@ interface Features {
     };
 }
 interface NetlifyDevOptions extends Features {
+    apiURL?: string;
+    apiToken?: string;
     logger?: Logger;
     projectRoot?: string;
 }
 declare class NetlifyDev {
     #private;
     constructor(options: NetlifyDevOptions);
+    private handleInEphemeralDirectory;
     private getConfig;
     handle(request: Request): Promise<Response | undefined>;
     get siteIsLinked(): boolean;

package/dist/main.d.ts

@@ -9,6 +9,14 @@ interface Features {
     blobs?: {
         enabled: boolean;
     };
+    /**
+     * Configuration options for environment variables.
+     *
+     * {@link} https://docs.netlify.com/environment-variables/overview/
+     */
+    environmentVariables?: {
+        enabled: boolean;
+    };
     /**
      * Configuration options for Netlify Functions.
      *
@@ -33,12 +41,15 @@ interface Features {
     };
 }
 interface NetlifyDevOptions extends Features {
+    apiURL?: string;
+    apiToken?: string;
     logger?: Logger;
     projectRoot?: string;
 }
 declare class NetlifyDev {
     #private;
     constructor(options: NetlifyDevOptions);
+    private handleInEphemeralDirectory;
     private getConfig;
     handle(request: Request): Promise<Response | undefined>;
     get siteIsLinked(): boolean;

package/dist/main.js

@@ -1,4 +1,5 @@
 // src/main.ts
+import { promises as fs2 } from "node:fs";
 import path2 from "node:path";
 import process2 from "node:process";
 import { resolveConfig } from "@netlify/config";
@@ -7,6 +8,139 @@ import { FunctionsHandler } from "@netlify/functions/dev";
 import { RedirectsHandler } from "@netlify/redirects";
 import { StaticHandler } from "@netlify/static";
 
+// src/lib/env.ts
+var SUPPORTED_CONTEXTS = ["all", "production", "deploy-preview", "branch-deploy", "dev"];
+var injectEnvVariables = async ({
+  accountSlug,
+  baseVariables = {},
+  envAPI,
+  netlifyAPI,
+  siteID
+}) => {
+  const results = {};
+  let variables = baseVariables;
+  if (netlifyAPI && accountSlug) {
+    variables = await getEnvelopeEnv({
+      accountId: accountSlug,
+      api: netlifyAPI,
+      env: baseVariables,
+      siteId: siteID
+    });
+  }
+  for (const [key, variable] of Object.entries(variables)) {
+    const existsInProcess = envAPI.has(key);
+    const [usedSource, ...overriddenSources] = existsInProcess ? ["process", ...variable.sources] : variable.sources;
+    const isInternal = variable.sources.includes("internal");
+    const result = {
+      isInternal,
+      originalValue: envAPI.get(key),
+      overriddenSources,
+      usedSource
+    };
+    if (!existsInProcess || isInternal) {
+      envAPI.set(key, variable.value);
+    }
+    results[key] = result;
+  }
+  return results;
+};
+var getValueForContext = (values, contextOrBranch) => {
+  const isSupportedContext = SUPPORTED_CONTEXTS.includes(contextOrBranch);
+  if (!isSupportedContext) {
+    const valueMatchingAsBranch = values.find((val) => val.context_parameter === contextOrBranch);
+    if (valueMatchingAsBranch != null) {
+      return valueMatchingAsBranch;
+    }
+    const valueMatchingContext = values.find((val) => val.context === "all" || val.context === "branch-deploy");
+    return valueMatchingContext ?? void 0;
+  }
+  const valueMatchingAsContext = values.find((val) => val.context === "all" || val.context === contextOrBranch);
+  return valueMatchingAsContext ?? void 0;
+};
+var filterEnvBySource = (env, source) => Object.fromEntries(Object.entries(env).filter(([, variable]) => variable.sources[0] === source));
+var fetchEnvelopeItems = async function({
+  accountId,
+  api,
+  key,
+  siteId
+}) {
+  if (accountId === void 0) {
+    return [];
+  }
+  try {
+    if (key) {
+      const envelopeItem = await api.getEnvVar({ accountId, key, siteId });
+      return [envelopeItem];
+    }
+    const envelopeItems = await api.getEnvVars({ accountId, siteId });
+    return envelopeItems;
+  } catch {
+    return [];
+  }
+};
+var formatEnvelopeData = ({
+  context = "dev",
+  envelopeItems = [],
+  scope = "any",
+  source
+}) => envelopeItems.filter(({ values }) => Boolean(getValueForContext(values, context))).filter(({ scopes }) => scope === "any" ? true : scopes.includes(scope)).sort((left, right) => left.key.toLowerCase() < right.key.toLowerCase() ? -1 : 1).reduce((acc, cur) => {
+  const val = getValueForContext(cur.values, context);
+  if (val === void 0) {
+    throw new TypeError(`failed to locate environment variable value for ${context} context`);
+  }
+  const { context: itemContext, context_parameter: branch, value } = val;
+  return {
+    ...acc,
+    [cur.key]: {
+      context: itemContext,
+      branch,
+      scopes: cur.scopes,
+      sources: [source],
+      value
+    }
+  };
+}, {});
+var getEnvelopeEnv = async ({
+  accountId,
+  api,
+  context = "dev",
+  env,
+  key = "",
+  raw = false,
+  scope = "any",
+  siteId
+}) => {
+  const [accountEnvelopeItems, siteEnvelopeItems] = await Promise.all([
+    fetchEnvelopeItems({ api, accountId, key }),
+    fetchEnvelopeItems({ api, accountId, key, siteId })
+  ]);
+  const accountEnv = formatEnvelopeData({ context, envelopeItems: accountEnvelopeItems, scope, source: "account" });
+  const siteEnv = formatEnvelopeData({ context, envelopeItems: siteEnvelopeItems, scope, source: "ui" });
+  if (raw) {
+    const entries = Object.entries({ ...accountEnv, ...siteEnv });
+    return entries.reduce(
+      (obj, [envVarKey, metadata]) => ({
+        ...obj,
+        [envVarKey]: metadata.value
+      }),
+      {}
+    );
+  }
+  const generalEnv = filterEnvBySource(env, "general");
+  const internalEnv = filterEnvBySource(env, "internal");
+  const addonsEnv = filterEnvBySource(env, "addons");
+  const configFileEnv = filterEnvBySource(env, "configFile");
+  const includeConfigEnvVars = /any|builds|post[-_]processing/.test(scope);
+  return {
+    ...generalEnv,
+    ...accountEnv,
+    ...includeConfigEnvVars ? addonsEnv : {},
+    ...siteEnv,
+    ...includeConfigEnvVars ? configFileEnv : {},
+    ...internalEnv
+  };
+};
+
 // src/lib/fs.ts
 import { promises as fs } from "node:fs";
 var isDirectory = async (path3) => {
@@ -78,6 +212,7 @@ var getRuntime = async ({ blobs, deployID, projectRoot, siteID }) => {
     siteID
   });
   return {
+    env,
     stop: async () => {
       restoreEnvironment(envSnapshot);
       await blobsServer?.stop();
@@ -88,6 +223,8 @@ var getRuntime = async ({ blobs, deployID, projectRoot, siteID }) => {
 // src/main.ts
 var notFoundHandler = async () => new Response("Not found", { status: 404 });
 var NetlifyDev = class {
+  #apiHost;
+  #apiScheme;
   #apiToken;
   #config;
   #features;
@@ -96,8 +233,15 @@ var NetlifyDev = class {
   #runtime;
   #siteID;
   constructor(options) {
+    if (options.apiURL) {
+      const apiURL = new URL(options.apiURL);
+      this.#apiHost = apiURL.host;
+      this.#apiScheme = apiURL.protocol.slice(0, -1);
+    }
+    this.#apiToken = options.apiToken;
     this.#features = {
       blobs: options.blobs?.enabled !== false,
+      environmentVariables: options.environmentVariables?.enabled !== false,
       functions: options.functions?.enabled !== false,
       redirects: options.redirects?.enabled !== false,
       static: options.staticFiles?.enabled !== false
@@ -105,27 +249,12 @@ var NetlifyDev = class {
     this.#logger = options.logger ?? globalThis.console;
     this.#projectRoot = options.projectRoot ?? process2.cwd();
   }
-  async getConfig() {
-    const configFilePath = path2.resolve(this.#projectRoot, "netlify.toml");
-    const configFileExists = await isFile(configFilePath);
-    const config = await resolveConfig({
-      config: configFileExists ? configFilePath : void 0,
-      repositoryRoot: this.#projectRoot,
-      cwd: process2.cwd(),
-      context: "dev",
-      siteId: this.#siteID,
-      token: this.#apiToken,
-      mode: "cli",
-      offline: !this.#siteID
-    });
-    return config;
-  }
-  async handle(request) {
+  async handleInEphemeralDirectory(request, destPath) {
     const userFunctionsPath = this.#config?.config.functionsDirectory ?? path2.join(this.#projectRoot, "netlify/functions");
     const userFunctionsPathExists = await isDirectory(userFunctionsPath);
     const functions = this.#features.functions ? new FunctionsHandler({
       config: this.#config,
-      destPath: path2.join(this.#projectRoot, ".netlify", "functions-serve"),
+      destPath,
       projectRoot: this.#projectRoot,
       settings: {},
       siteId: this.#siteID,
@@ -172,23 +301,63 @@ var NetlifyDev = class {
       return staticMatch.handle();
     }
   }
+  async getConfig() {
+    const configFilePath = path2.resolve(this.#projectRoot, "netlify.toml");
+    const configFileExists = await isFile(configFilePath);
+    const config = await resolveConfig({
+      config: configFileExists ? configFilePath : void 0,
+      context: "dev",
+      cwd: process2.cwd(),
+      host: this.#apiHost,
+      offline: !this.#siteID,
+      mode: "cli",
+      repositoryRoot: this.#projectRoot,
+      scheme: this.#apiScheme,
+      siteId: this.#siteID,
+      token: this.#apiToken
+    });
+    return config;
+  }
+  async handle(request) {
+    const servePath = path2.join(this.#projectRoot, ".netlify", "functions-serve");
+    await fs2.mkdir(servePath, { recursive: true });
+    const destPath = await fs2.mkdtemp(path2.join(servePath, "_"));
+    try {
+      return await this.handleInEphemeralDirectory(request, destPath);
+    } finally {
+      try {
+        await fs2.rm(destPath, { force: true, recursive: true });
+      } catch {
+      }
+    }
+  }
   get siteIsLinked() {
     return Boolean(this.#siteID);
   }
   async start() {
     await ensureNetlifyIgnore(this.#projectRoot, this.#logger);
-    const apiToken = await getAPIToken();
-    this.#apiToken = apiToken;
+    this.#apiToken = this.#apiToken ?? await getAPIToken();
     const state = new LocalState(this.#projectRoot);
     const siteID = state.get("siteId");
     this.#siteID = siteID;
-    this.#config = await this.getConfig();
-    this.#runtime = await getRuntime({
+    const config = await this.getConfig();
+    this.#config = config;
+    const runtime = await getRuntime({
       blobs: Boolean(this.#features.blobs),
       deployID: "0",
       projectRoot: this.#projectRoot,
       siteID: siteID ?? "0"
     });
+    this.#runtime = runtime;
+    if (this.#features.environmentVariables && siteID) {
+      await injectEnvVariables({
+        accountSlug: config?.siteInfo?.account_slug,
+        baseVariables: config?.env || {},
+        envAPI: runtime.env,
+        netlifyAPI: config?.api,
+        siteID
+      });
+    }
   }
   async stop() {
     await this.#runtime?.stop();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/dev",
-  "version": "2.2.2",
+  "version": "2.3.1",
   "description": "Emulation of the Netlify environment for local development",
   "type": "module",
   "engines": {
@@ -46,18 +46,19 @@
   },
   "author": "Netlify Inc.",
   "devDependencies": {
-    "@netlify/types": "1.1.1",
+    "@netlify/api": "^14.0.2",
+    "@netlify/types": "1.2.0",
     "tmp-promise": "^3.0.3",
     "tsup": "^8.0.0",
     "vitest": "^3.0.0"
   },
   "dependencies": {
-    "@netlify/blobs": "9.1.1",
-    "@netlify/config": "^22.0.1",
-    "@netlify/dev-utils": "2.1.1",
-    "@netlify/functions": "3.1.8",
-    "@netlify/redirects": "1.1.3",
-    "@netlify/runtime": "2.2.1",
-    "@netlify/static": "1.1.3"
+    "@netlify/blobs": "9.1.2",
+    "@netlify/config": "^23.0.7",
+    "@netlify/dev-utils": "2.2.0",
+    "@netlify/functions": "3.1.10",
+    "@netlify/redirects": "1.1.4",
+    "@netlify/runtime": "2.2.2",
+    "@netlify/static": "1.1.4"
   }
 }