@arcgis/components-build-utils 5.1.0-next.98 → 5.2.0-next.0

package/README.md

@@ -8,5 +8,5 @@ It is not intended to be used directly, but rather used as a dependency by other
 
 ## License
 
-This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package, and at https://js.arcgis.com/5.0/LICENSE.txt.
-For third party notices, see https://js.arcgis.com/5.0/third-party-notices.txt.
+This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package, and at https://js.arcgis.com/5.1/LICENSE.txt.
+For third party notices, see https://js.arcgis.com/5.1/third-party-notices.txt.

package/dist/index.cjs

@@ -44,13 +44,20 @@ function sh(command, options = {}) {
   }
 }
 function sp(command, args, options = {}) {
-  try {
-    const normalizedOptions = { encoding: "utf8", ...options };
-    const result = node_child_process.spawnSync(command, args, normalizedOptions);
-    return `${result.stdout ?? ""}${result.stderr ?? ""}`.trim();
-  } catch (error) {
-    throw error;
+  const normalizedOptions = { encoding: "utf8", ...options };
+  const result = node_child_process.spawnSync(command, args, normalizedOptions);
+  if (result.error) {
+    throw result.error;
+  }
+  const output = `${result.stdout ?? ""}${result.stderr ?? ""}`.trim();
+  const exitCode = result.status ?? 0;
+  if (exitCode !== 0) {
+    throw new Error(
+      `Command failed with exit code ${String(exitCode)}: ${command} ${args.join(" ")}
+${output}`.trim()
+    );
   }
+  return output;
 }
 async function asyncSh(command, options = {}) {
   const normalizedOptions = { encoding: "utf8", ...options };
@@ -250,7 +257,8 @@ function detectPackageManager(cwd = process.cwd()) {
 function vitePresetPlugin({
   dtsOptions = {},
   externalize,
-  bundleIn
+  bundleIn,
+  isApplication
 } = {
   externalize: [],
   dtsOptions: {}
@@ -281,7 +289,8 @@ function vitePresetPlugin({
     },
     externalizeDependencies({
       externalize,
-      bundleIn
+      bundleIn,
+      isApplication
     }),
     // This dependency pulls in many others. Since components-build-utils has a
     // single entry point, we load a large module tree needlessly. To avoid,
@@ -340,24 +349,33 @@ function shouldSkip(id) {
   return id.includes("__test") || id.includes(".e2e.") || id.includes(".spec.") || id.includes(".test.") || id.includes(".stories.");
 }
 function externalizeDependencies(options) {
-  const packageJson = retrievePackageJson();
+  return externalizeDependenciesImplementation(options, retrievePackageJson());
+}
+function externalizeDependenciesImplementation(options, packageJson) {
   const externalDependencies = Object.keys({
     ...packageJson.dependencies,
     ...packageJson.peerDependencies,
     ...packageJson.optionalDependencies
   });
+  const isStrictBundling = toPosixPathSeparators(void 0).includes(
+    "support-packages/components-build-utils"
+  );
   const bundleIn = options.bundleIn?.map(stringToStartsWithGlob);
+  const explicitExternalize = options.externalize?.map(stringToStartsWithGlob) ?? [];
   const externalize = [
-    ...options.externalize?.map(stringToStartsWithGlob) ?? [],
+    ...explicitExternalize,
+    // BUG: we shouldn't silently externalize node in browser packages.
+    // Consider erroring instead
     /^node:/u,
     new RegExp(
-      `^(?:${externalDependencies.join("|")}${externalDependencies.length === 0 ? "" : "|"}${node_module.builtinModules.join("|")})(?:/.+)?$`,
+      `^(?:${externalDependencies.join("|")}${externalDependencies.length === 0 ? "" : "|"}${node_module.builtinModules.join("|")})(?:/|$)`,
       "u"
     )
   ];
   const plugin = {
-    name: "@arcgis/components-build-utils:externalize-dependencies",
+    name: pluginName,
     apply: "build",
+    // Externalize before Vite's default resolution runs
     enforce: "pre",
     // Rolldown also has "external" option, which can be provided regexes.
     // Theoretically that would be more efficient due to less communication
@@ -367,21 +385,62 @@ function externalizeDependencies(options) {
     resolveId: {
       filter: {
         id: {
-          include: externalize,
+          include: [
+            // In most cases, we want all dependencies in library packages to be
+            // externalized. Thus, this regex matches all non-relative imports.
+            nonRelativeSpecifierPattern,
+            // Also include explicitExternalize because those may target relative
+            // paths (e.g. ./draconvert.js in mock-services).
+            ...explicitExternalize
+          ],
           exclude: bundleIn
         }
       },
-      handler() {
-        return false;
+      handler(id, importer, resolveOptions) {
+        if (matchesAny(id, externalize)) {
+          return false;
+        }
+        if (
+          // Entrypoints look like src/components/button/button.tsx, so are
+          // matched by the nonRelativeSpecifierPattern
+          resolveOptions.isEntry || // Virtual specifiers are handled by plugins
+          id.startsWith("\0") || // data: node: virtual:
+          id.includes(":") || // ?raw ?url ?worker - resolved by other plugins
+          id.includes("?") || // Applications can bundle in anything
+          options.isApplication === true
+        ) {
+          return;
+        }
+        const error = `[${pluginName}] Vite tried to bundle in "${id}" (imported by ${importer}).
+This is likely undesirable. To externalize it, declare this dependency as a "dependency", "peerDependency" or "optionalDependency" in package.json.
+If this is intentional, add it to the build.dependencies.bundleIn option in useLumina() or bundleIn option in the vitePresetPlugin().
+If this is an application rather than a library, pass isApplication:true in vitePresetPlugin().`;
+        if (isStrictBundling) {
+          throw Error(error);
+        } else {
+          console.error(node_util.styleText("red", `${error}
+This will be an error in future version.`));
+          return;
+        }
       }
     }
   };
   return plugin;
 }
+const pluginName = "@arcgis/components-build-utils:externalize-dependencies";
 const stringToStartsWithGlob = (option) => typeof option === "string" ? new RegExp(
   `^${option.replace(/[.*+?^${}()|[\]\\]/gu, "\\$&")}${option.endsWith("/") ? "(?:.+)?" : "(?:/.+)?"}$`,
   "u"
 ) : option;
+const nonRelativeSpecifierPattern = /^[^\.\/]/u;
+function matchesAny(id, patterns) {
+  for (let index = 0; index < patterns.length; ++index) {
+    if (patterns[index].test(id)) {
+      return true;
+    }
+  }
+  return false;
+}
 exports.asyncFindPath = asyncFindPath;
 exports.asyncRetrievePackageJson = asyncRetrievePackageJson;
 exports.asyncSh = asyncSh;

package/dist/index.js

@@ -20,13 +20,20 @@ function sh(command, options = {}) {
   }
 }
 function sp(command, args, options = {}) {
-  try {
-    const normalizedOptions = { encoding: "utf8", ...options };
-    const result = spawnSync(command, args, normalizedOptions);
-    return `${result.stdout ?? ""}${result.stderr ?? ""}`.trim();
-  } catch (error) {
-    throw error;
+  const normalizedOptions = { encoding: "utf8", ...options };
+  const result = spawnSync(command, args, normalizedOptions);
+  if (result.error) {
+    throw result.error;
+  }
+  const output = `${result.stdout ?? ""}${result.stderr ?? ""}`.trim();
+  const exitCode = result.status ?? 0;
+  if (exitCode !== 0) {
+    throw new Error(
+      `Command failed with exit code ${String(exitCode)}: ${command} ${args.join(" ")}
+${output}`.trim()
+    );
   }
+  return output;
 }
 async function asyncSh(command, options = {}) {
   const normalizedOptions = { encoding: "utf8", ...options };
@@ -226,7 +233,8 @@ function detectPackageManager(cwd = process.cwd()) {
 function vitePresetPlugin({
   dtsOptions = {},
   externalize,
-  bundleIn
+  bundleIn,
+  isApplication
 } = {
   externalize: [],
   dtsOptions: {}
@@ -257,7 +265,8 @@ function vitePresetPlugin({
     },
     externalizeDependencies({
       externalize,
-      bundleIn
+      bundleIn,
+      isApplication
     }),
     // This dependency pulls in many others. Since components-build-utils has a
     // single entry point, we load a large module tree needlessly. To avoid,
@@ -316,24 +325,33 @@ function shouldSkip(id) {
   return id.includes("__test") || id.includes(".e2e.") || id.includes(".spec.") || id.includes(".test.") || id.includes(".stories.");
 }
 function externalizeDependencies(options) {
-  const packageJson = retrievePackageJson();
+  return externalizeDependenciesImplementation(options, retrievePackageJson());
+}
+function externalizeDependenciesImplementation(options, packageJson) {
   const externalDependencies = Object.keys({
     ...packageJson.dependencies,
     ...packageJson.peerDependencies,
     ...packageJson.optionalDependencies
   });
+  const isStrictBundling = toPosixPathSeparators(import.meta.dirname).includes(
+    "support-packages/components-build-utils"
+  );
   const bundleIn = options.bundleIn?.map(stringToStartsWithGlob);
+  const explicitExternalize = options.externalize?.map(stringToStartsWithGlob) ?? [];
   const externalize = [
-    ...options.externalize?.map(stringToStartsWithGlob) ?? [],
+    ...explicitExternalize,
+    // BUG: we shouldn't silently externalize node in browser packages.
+    // Consider erroring instead
     /^node:/u,
     new RegExp(
-      `^(?:${externalDependencies.join("|")}${externalDependencies.length === 0 ? "" : "|"}${builtinModules.join("|")})(?:/.+)?$`,
+      `^(?:${externalDependencies.join("|")}${externalDependencies.length === 0 ? "" : "|"}${builtinModules.join("|")})(?:/|$)`,
       "u"
     )
   ];
   const plugin = {
-    name: "@arcgis/components-build-utils:externalize-dependencies",
+    name: pluginName,
     apply: "build",
+    // Externalize before Vite's default resolution runs
     enforce: "pre",
     // Rolldown also has "external" option, which can be provided regexes.
     // Theoretically that would be more efficient due to less communication
@@ -343,21 +361,62 @@ function externalizeDependencies(options) {
     resolveId: {
       filter: {
         id: {
-          include: externalize,
+          include: [
+            // In most cases, we want all dependencies in library packages to be
+            // externalized. Thus, this regex matches all non-relative imports.
+            nonRelativeSpecifierPattern,
+            // Also include explicitExternalize because those may target relative
+            // paths (e.g. ./draconvert.js in mock-services).
+            ...explicitExternalize
+          ],
           exclude: bundleIn
         }
       },
-      handler() {
-        return false;
+      handler(id, importer, resolveOptions) {
+        if (matchesAny(id, externalize)) {
+          return false;
+        }
+        if (
+          // Entrypoints look like src/components/button/button.tsx, so are
+          // matched by the nonRelativeSpecifierPattern
+          resolveOptions.isEntry || // Virtual specifiers are handled by plugins
+          id.startsWith("\0") || // data: node: virtual:
+          id.includes(":") || // ?raw ?url ?worker - resolved by other plugins
+          id.includes("?") || // Applications can bundle in anything
+          options.isApplication === true
+        ) {
+          return;
+        }
+        const error = `[${pluginName}] Vite tried to bundle in "${id}" (imported by ${importer}).
+This is likely undesirable. To externalize it, declare this dependency as a "dependency", "peerDependency" or "optionalDependency" in package.json.
+If this is intentional, add it to the build.dependencies.bundleIn option in useLumina() or bundleIn option in the vitePresetPlugin().
+If this is an application rather than a library, pass isApplication:true in vitePresetPlugin().`;
+        if (isStrictBundling) {
+          throw Error(error);
+        } else {
+          console.error(styleText("red", `${error}
+This will be an error in future version.`));
+          return;
+        }
       }
     }
   };
   return plugin;
 }
+const pluginName = "@arcgis/components-build-utils:externalize-dependencies";
 const stringToStartsWithGlob = (option) => typeof option === "string" ? new RegExp(
   `^${option.replace(/[.*+?^${}()|[\]\\]/gu, "\\$&")}${option.endsWith("/") ? "(?:.+)?" : "(?:/.+)?"}$`,
   "u"
 ) : option;
+const nonRelativeSpecifierPattern = /^[^\.\/]/u;
+function matchesAny(id, patterns) {
+  for (let index = 0; index < patterns.length; ++index) {
+    if (patterns[index].test(id)) {
+      return true;
+    }
+  }
+  return false;
+}
 export {
   asyncFindPath,
   asyncRetrievePackageJson,

package/dist/packageJson.d.cts

@@ -13,6 +13,8 @@ export type PackageJson = {
     "module"?: string;
     "types"?: string;
     "files"?: string[];
+    "bin"?: Record<string, string> | string;
+    "man"?: string[] | string;
     "dependencies"?: Record<string, string>;
     "devDependencies"?: Record<string, string>;
     "peerDependencies"?: Record<string, string>;

package/dist/packageJson.d.ts

@@ -13,6 +13,8 @@ export type PackageJson = {
     "module"?: string;
     "types"?: string;
     "files"?: string[];
+    "bin"?: Record<string, string> | string;
+    "man"?: string[] | string;
     "dependencies"?: Record<string, string>;
     "devDependencies"?: Record<string, string>;
     "peerDependencies"?: Record<string, string>;

package/dist/vite.d.cts

@@ -1,11 +1,12 @@
 import { Plugin } from 'vite';
 import { default as dts } from 'vite-plugin-dts';
+import { PackageJson } from './packageJson.ts';
 /**
  * Vite preset for all our support packages:
  * - externalizes all non-dev-dependencies
  * - generates type declarations (using `vite-plugin-dts`)
  */
-export declare function vitePresetPlugin({ dtsOptions, externalize, bundleIn, }?: DependencyManagementOptions & {
+export declare function vitePresetPlugin({ dtsOptions, externalize, bundleIn, isApplication, }?: DependencyManagementOptions & {
     /** Additional options for `vite-plugin-dts` */
     dtsOptions?: Parameters<typeof dts>[0] | false;
 }): [Plugin, Plugin, Promise<Plugin> | undefined];
@@ -40,6 +41,14 @@ export type DependencyManagementOptions = {
      * technical reasons.
      */
     readonly externalize?: (RegExp | string)[];
+    /**
+     * By default, this plugin errors if any devDependency is used in runtime code
+     * to avoid bundling in dependencies in a library. In application packages,
+     * bundling in everything is desirable, so enable this option.
+     *
+     * @default false
+     */
+    readonly isApplication?: boolean;
 };
 /**
  * By default, Rollup will bundle-in all dependencies.
@@ -69,6 +78,24 @@ export type DependencyManagementOptions = {
  * be externalized (because all peerDependencies are externalized).
  */
 export declare function externalizeDependencies(options: DependencyManagementOptions): Plugin;
+interface PluginShape extends Plugin {
+    resolveId: {
+        filter: {
+            id: {
+                include: RegExp[];
+                exclude: RegExp[] | undefined;
+            };
+        };
+        handler: (id: string, importer: string | undefined, options: {
+            isEntry: boolean;
+        }) => false | undefined;
+    };
+}
+declare function externalizeDependenciesImplementation(options: DependencyManagementOptions, packageJson: PackageJson): PluginShape;
+declare function matchesAny(id: string, patterns: readonly RegExp[]): boolean;
 export declare const exportsForTests: {
     stringToStartsWithGlob: (option: RegExp | string) => RegExp;
+    externalizeDependenciesImplementation: typeof externalizeDependenciesImplementation;
+    matchesAny: typeof matchesAny;
 };
+export {};

package/dist/vite.d.ts

@@ -1,11 +1,12 @@
 import { Plugin } from 'vite';
 import { default as dts } from 'vite-plugin-dts';
+import { PackageJson } from './packageJson.ts';
 /**
  * Vite preset for all our support packages:
  * - externalizes all non-dev-dependencies
  * - generates type declarations (using `vite-plugin-dts`)
  */
-export declare function vitePresetPlugin({ dtsOptions, externalize, bundleIn, }?: DependencyManagementOptions & {
+export declare function vitePresetPlugin({ dtsOptions, externalize, bundleIn, isApplication, }?: DependencyManagementOptions & {
     /** Additional options for `vite-plugin-dts` */
     dtsOptions?: Parameters<typeof dts>[0] | false;
 }): [Plugin, Plugin, Promise<Plugin> | undefined];
@@ -40,6 +41,14 @@ export type DependencyManagementOptions = {
      * technical reasons.
      */
     readonly externalize?: (RegExp | string)[];
+    /**
+     * By default, this plugin errors if any devDependency is used in runtime code
+     * to avoid bundling in dependencies in a library. In application packages,
+     * bundling in everything is desirable, so enable this option.
+     *
+     * @default false
+     */
+    readonly isApplication?: boolean;
 };
 /**
  * By default, Rollup will bundle-in all dependencies.
@@ -69,6 +78,24 @@ export type DependencyManagementOptions = {
  * be externalized (because all peerDependencies are externalized).
  */
 export declare function externalizeDependencies(options: DependencyManagementOptions): Plugin;
+interface PluginShape extends Plugin {
+    resolveId: {
+        filter: {
+            id: {
+                include: RegExp[];
+                exclude: RegExp[] | undefined;
+            };
+        };
+        handler: (id: string, importer: string | undefined, options: {
+            isEntry: boolean;
+        }) => false | undefined;
+    };
+}
+declare function externalizeDependenciesImplementation(options: DependencyManagementOptions, packageJson: PackageJson): PluginShape;
+declare function matchesAny(id: string, patterns: readonly RegExp[]): boolean;
 export declare const exportsForTests: {
     stringToStartsWithGlob: (option: RegExp | string) => RegExp;
+    externalizeDependenciesImplementation: typeof externalizeDependenciesImplementation;
+    matchesAny: typeof matchesAny;
 };
+export {};

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@arcgis/components-build-utils",
-  "version": "5.1.0-next.98",
+  "version": "5.2.0-next.0",
   "description": "Collection of common internal build-time patterns and utilities for ArcGIS Maps SDK for JavaScript components.",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
   "type": "module",
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
-    },
-    "./ts": "./src/index.ts"
+    }
   },
   "files": [
     "dist/"
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
+    "@types/node": "^24.10.0",
     "tslib": "^2.8.1",
     "vite": "^7.3.2",
     "vite-plugin-dts": "^4.5.4"