@ms-cloudpack/bundler-utilities 0.2.19 → 0.3.0

package/lib/shouldExternalizePackage.d.ts

@@ -1,12 +1,54 @@
 /**
  * Determines if a package should be externalized from the bundle.
- * Don't externalize inlined packages, node builtins, absolute paths, or relative paths.
+ * Don't externalize inlined packages, node builtins, absolute paths, relative paths,
+ * or dependencies of inlined dependencies except if they are explicitly marked as external.
+ *
+ *  @param params - The parameters for the externalization check, e.g.
+ * `{
+ *   inputPath: "/app",
+ *   id: "/app/src/about.tsx",
+ *   parent: "/app",
+ *   inlined: ["foo"],
+ *   external: ["bar", "baz"],
+ *   polyfills: new Set(["global"]),
+ *   shouldInlineNodeBuiltins: false,
+ * };`
  */
 export declare function shouldExternalizePackage(params: {
+    /**
+     * The absolute input path for the entry points to be bundled.
+     */
+    inputPath: string;
+    /**
+     * The module ID (import path) being evaluated for externalization.
+     * This can be a package name or a relative/absolute path.
+     */
     id: string;
+    /**
+     * The absolute file path of the module importing this dependency.
+     * Used to determine if the import is coming from outside the package.
+     * If it is undefined, the import is considered to be from the same package (this is common in Rollup).
+     */
+    parent?: string;
+    /**
+     * List of dependencies which should be explicitly inlined rather than externalized.
+     * These will always be bundled with the package regardless of other settings.
+     */
     inlined?: string[];
+    /**
+     * List of dependencies which should be explicitly externalized.
+     * These will never be bundled with the package.
+     */
     external?: string[];
+    /**
+     * Set of polyfill package names that should be inlined instead of externalized
+     * when used as replacements for Node.js built-in modules in browser bundles.
+     */
     polyfills?: Set<string>;
+    /**
+     * Whether Node.js built-in modules should be inlined (with polyfills) rather than externalized.
+     * When true, modules like 'fs' or 'path' will be replaced with browser-compatible versions.
+     */
     shouldInlineNodeBuiltins: boolean;
 }): boolean;
 //# sourceMappingURL=shouldExternalizePackage.d.ts.map

package/lib/shouldExternalizePackage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shouldExternalizePackage.d.ts","sourceRoot":"","sources":["../src/shouldExternalizePackage.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB,wBAAwB,EAAE,OAAO,CAAC;CACnC,GAAG,OAAO,CAUV"}
+{"version":3,"file":"shouldExternalizePackage.d.ts","sourceRoot":"","sources":["../src/shouldExternalizePackage.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE;IAC/C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB;;;OAGG;IACH,wBAAwB,EAAE,OAAO,CAAC;CACnC,GAAG,OAAO,CAmBV"}

package/lib/shouldExternalizePackage.js

@@ -3,22 +3,47 @@ import { isBuiltin } from 'module';
 import path from 'path';
 /**
  * Determines if a package should be externalized from the bundle.
- * Don't externalize inlined packages, node builtins, absolute paths, or relative paths.
+ * Don't externalize inlined packages, node builtins, absolute paths, relative paths,
+ * or dependencies of inlined dependencies except if they are explicitly marked as external.
+ *
+ *  @param params - The parameters for the externalization check, e.g.
+ * `{
+ *   inputPath: "/app",
+ *   id: "/app/src/about.tsx",
+ *   parent: "/app",
+ *   inlined: ["foo"],
+ *   external: ["bar", "baz"],
+ *   polyfills: new Set(["global"]),
+ *   shouldInlineNodeBuiltins: false,
+ * };`
  */
 export function shouldExternalizePackage(params) {
-    const { id, inlined, external, polyfills, shouldInlineNodeBuiltins } = params;
-    return !((shouldInlineNodeBuiltins && isInlinedNodeBuiltin(id, external, polyfills)) ||
+    const { inputPath, id, parent, inlined, external, polyfills, shouldInlineNodeBuiltins } = params;
+    const isExternalPackage = isExternal(id, external);
+    return !(
+    // We should inline node builtins that are handled by the nodePolyfills plugin.
+    // Except if the dependency is listed as external.
+    ((shouldInlineNodeBuiltins && isInlinedNodeBuiltin(id, polyfills) && !isExternalPackage) ||
         path.isAbsolute(id) ||
         isRelative(id) ||
         // The length check ensures that parseImportString is only called when there are inlined deps
-        (inlined?.length && inlined.includes(parseImportString(id).packageName)));
+        (inlined?.length && inlined.includes(parseImportString(id).packageName)) ||
+        // A file outside of the package is doing this import, so we should inline the nested dependencies.
+        // Except if the dependency is listed as external.
+        (isNestedDependency(inputPath, parent) && !isExternalPackage)));
 }
-// We should inline node builtins that are handled by the nodePolyfills plugin.
-// Except if the dependency is listed as external.
-function isInlinedNodeBuiltin(id, external, polyfills) {
-    return (isBuiltin(id) || !!polyfills?.has(id)) && !external?.find((ex) => id.startsWith(ex));
+function isInlinedNodeBuiltin(id, polyfills) {
+    return isBuiltin(id) || !!polyfills?.has(id);
 }
 function isRelative(id) {
     return id.startsWith('/') || id.startsWith('./') || id.startsWith('../') || id === '.' || id === '..';
 }
+// Check if the import comes from an inlined dependency.
+function isNestedDependency(inputPath, parent) {
+    const relativeParentPath = parent ? path.relative(inputPath, parent) : undefined;
+    return !!(relativeParentPath?.startsWith('..') || relativeParentPath?.includes('node_modules'));
+}
+function isExternal(id, external) {
+    return !!external?.find((ex) => id.startsWith(ex));
+}
 //# sourceMappingURL=shouldExternalizePackage.js.map

package/lib/shouldExternalizePackage.js.map

@@ -1 +1 @@
-{"version":3,"file":"shouldExternalizePackage.js","sourceRoot":"","sources":["../src/shouldExternalizePackage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAMxC;IACC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,wBAAwB,EAAE,GAAG,MAAM,CAAC;IAE9E,OAAO,CAAC,CACN,CAAC,wBAAwB,IAAI,oBAAoB,CAAC,EAAE,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC3E,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACnB,UAAU,CAAC,EAAE,CAAC;QACd,6FAA6F;QAC7F,CAAC,OAAO,EAAE,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CACzE,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,kDAAkD;AAClD,SAAS,oBAAoB,CAAC,EAAU,EAAE,QAA8B,EAAE,SAAkC;IAC1G,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/F,CAAC;AAED,SAAS,UAAU,CAAC,EAAU;IAC5B,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,CAAC;AACxG,CAAC","sourcesContent":["import { parseImportString } from '@ms-cloudpack/path-string-parsing';\nimport { isBuiltin } from 'module';\nimport path from 'path';\n\n/**\n * Determines if a package should be externalized from the bundle.\n * Don't externalize inlined packages, node builtins, absolute paths, or relative paths.\n */\nexport function shouldExternalizePackage(params: {\n  id: string;\n  inlined?: string[];\n  external?: string[];\n  polyfills?: Set<string>;\n  shouldInlineNodeBuiltins: boolean;\n}): boolean {\n  const { id, inlined, external, polyfills, shouldInlineNodeBuiltins } = params;\n\n  return !(\n    (shouldInlineNodeBuiltins && isInlinedNodeBuiltin(id, external, polyfills)) ||\n    path.isAbsolute(id) ||\n    isRelative(id) ||\n    // The length check ensures that parseImportString is only called when there are inlined deps\n    (inlined?.length && inlined.includes(parseImportString(id).packageName))\n  );\n}\n\n// We should inline node builtins that are handled by the nodePolyfills plugin.\n// Except if the dependency is listed as external.\nfunction isInlinedNodeBuiltin(id: string, external: string[] | undefined, polyfills: Set<string> | undefined): boolean {\n  return (isBuiltin(id) || !!polyfills?.has(id)) && !external?.find((ex) => id.startsWith(ex));\n}\n\nfunction isRelative(id: string): boolean {\n  return id.startsWith('/') || id.startsWith('./') || id.startsWith('../') || id === '.' || id === '..';\n}\n"]}
+{"version":3,"file":"shouldExternalizePackage.js","sourceRoot":"","sources":["../src/shouldExternalizePackage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAoCxC;IACC,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,wBAAwB,EAAE,GAAG,MAAM,CAAC;IAEjG,MAAM,iBAAiB,GAAG,UAAU,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IAEnD,OAAO,CAAC;IACN,+EAA+E;IAC/E,kDAAkD;IAClD,CACE,CAAC,wBAAwB,IAAI,oBAAoB,CAAC,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC;QACvF,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACnB,UAAU,CAAC,EAAE,CAAC;QACd,6FAA6F;QAC7F,CAAC,OAAO,EAAE,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;QACxE,mGAAmG;QACnG,kDAAkD;QAClD,CAAC,kBAAkB,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAC9D,CACF,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,EAAU,EAAE,SAAkC;IAC1E,OAAO,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,UAAU,CAAC,EAAU;IAC5B,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,CAAC;AACxG,CAAC;AAED,wDAAwD;AACxD,SAAS,kBAAkB,CAAC,SAAiB,EAAE,MAA0B;IACvE,MAAM,kBAAkB,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACjF,OAAO,CAAC,CAAC,CAAC,kBAAkB,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,kBAAkB,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC;AAClG,CAAC;AAED,SAAS,UAAU,CAAC,EAAU,EAAE,QAA8B;IAC5D,OAAO,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;AACrD,CAAC","sourcesContent":["import { parseImportString } from '@ms-cloudpack/path-string-parsing';\nimport { isBuiltin } from 'module';\nimport path from 'path';\n\n/**\n * Determines if a package should be externalized from the bundle.\n * Don't externalize inlined packages, node builtins, absolute paths, relative paths,\n * or dependencies of inlined dependencies except if they are explicitly marked as external.\n *\n *  @param params - The parameters for the externalization check, e.g.\n * `{\n *   inputPath: \"/app\",\n *   id: \"/app/src/about.tsx\",\n *   parent: \"/app\",\n *   inlined: [\"foo\"],\n *   external: [\"bar\", \"baz\"],\n *   polyfills: new Set([\"global\"]),\n *   shouldInlineNodeBuiltins: false,\n * };`\n */\nexport function shouldExternalizePackage(params: {\n  /**\n   * The absolute input path for the entry points to be bundled.\n   */\n  inputPath: string;\n  /**\n   * The module ID (import path) being evaluated for externalization.\n   * This can be a package name or a relative/absolute path.\n   */\n  id: string;\n  /**\n   * The absolute file path of the module importing this dependency.\n   * Used to determine if the import is coming from outside the package.\n   * If it is undefined, the import is considered to be from the same package (this is common in Rollup).\n   */\n  parent?: string;\n  /**\n   * List of dependencies which should be explicitly inlined rather than externalized.\n   * These will always be bundled with the package regardless of other settings.\n   */\n  inlined?: string[];\n  /**\n   * List of dependencies which should be explicitly externalized.\n   * These will never be bundled with the package.\n   */\n  external?: string[];\n  /**\n   * Set of polyfill package names that should be inlined instead of externalized\n   * when used as replacements for Node.js built-in modules in browser bundles.\n   */\n  polyfills?: Set<string>;\n  /**\n   * Whether Node.js built-in modules should be inlined (with polyfills) rather than externalized.\n   * When true, modules like 'fs' or 'path' will be replaced with browser-compatible versions.\n   */\n  shouldInlineNodeBuiltins: boolean;\n}): boolean {\n  const { inputPath, id, parent, inlined, external, polyfills, shouldInlineNodeBuiltins } = params;\n\n  const isExternalPackage = isExternal(id, external);\n\n  return !(\n    // We should inline node builtins that are handled by the nodePolyfills plugin.\n    // Except if the dependency is listed as external.\n    (\n      (shouldInlineNodeBuiltins && isInlinedNodeBuiltin(id, polyfills) && !isExternalPackage) ||\n      path.isAbsolute(id) ||\n      isRelative(id) ||\n      // The length check ensures that parseImportString is only called when there are inlined deps\n      (inlined?.length && inlined.includes(parseImportString(id).packageName)) ||\n      // A file outside of the package is doing this import, so we should inline the nested dependencies.\n      // Except if the dependency is listed as external.\n      (isNestedDependency(inputPath, parent) && !isExternalPackage)\n    )\n  );\n}\n\nfunction isInlinedNodeBuiltin(id: string, polyfills: Set<string> | undefined): boolean {\n  return isBuiltin(id) || !!polyfills?.has(id);\n}\n\nfunction isRelative(id: string): boolean {\n  return id.startsWith('/') || id.startsWith('./') || id.startsWith('../') || id === '.' || id === '..';\n}\n\n// Check if the import comes from an inlined dependency.\nfunction isNestedDependency(inputPath: string, parent: string | undefined): boolean {\n  const relativeParentPath = parent ? path.relative(inputPath, parent) : undefined;\n  return !!(relativeParentPath?.startsWith('..') || relativeParentPath?.includes('node_modules'));\n}\n\nfunction isExternal(id: string, external: string[] | undefined): boolean {\n  return !!external?.find((ex) => id.startsWith(ex));\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/bundler-utilities",
-  "version": "0.2.19",
+  "version": "0.3.0",
   "description": "Utilities used by multiple bundlers.",
   "license": "MIT",
   "type": "module",