dist/browser->cdn for headless

coveo · Feb 14, 2025 · 46bf862 · 46bf862
1 parent ea114e5
commit 46bf862
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 109 deletions.
diff --git a/.deployment.config.json b/.deployment.config.json
@@ -69,7 +69,7 @@
         "disabled": $[IS_NIGHTLY],
         "bucket": "{terraform.infra.infra.bucket_binaries}",
         "directory": "proda/StaticCDN/headless/v$[HEADLESS_PATCH_VERSION]",
-        "source": "packages/headless/dist/browser",
+        "source": "packages/headless/cdn",
         "parameters": {
           "acl": "public-read"
         }
@@ -81,7 +81,7 @@
         "disabled": $[IS_NIGHTLY],
         "bucket": "{terraform.infra.infra.bucket_binaries}",
         "directory": "proda/StaticCDN/headless/v$[HEADLESS_MINOR_VERSION]",
-        "source": "packages/headless/dist/browser",
+        "source": "packages/headless/cdn",
         "parameters": {
           "acl": "public-read"
         }
@@ -93,7 +93,7 @@
         "disabled": $[IS_NIGHTLY],
         "bucket": "{terraform.infra.infra.bucket_binaries}",
         "directory": "proda/StaticCDN/headless/v$[HEADLESS_MAJOR_VERSION]",
-        "source": "packages/headless/dist/browser",
+        "source": "packages/headless/cdn",
         "parameters": {
           "acl": "public-read"
         }
@@ -105,7 +105,7 @@
         "disabled": $[IS_NOT_NIGHTLY],
         "bucket": "{terraform.infra.infra.bucket_binaries}",
         "directory": "proda/StaticCDN/headless/v$[HEADLESS_MAJOR_VERSION]-nightly",
-        "source": "packages/headless/dist/browser",
+        "source": "packages/headless/cdn",
         "parameters": {
           "acl": "public-read"
         }

diff --git a/packages/atomic-hosted-page/scripts/start.js b/packages/atomic-hosted-page/scripts/start.js
@@ -63,7 +63,7 @@ const run = async () => {
     `Copying headless files to ${devPublicDir}/headless/v${headlessVersion}`
   );
   await copyFiles(
-    path.join(headlessDir, 'dist/browser'),
+    path.join(headlessDir, 'cdn'),
     `${devPublicDir}/headless/v${headlessVersion}`
   );
 

diff --git a/packages/atomic/playwright.config.ts b/packages/atomic/playwright.config.ts
@@ -42,7 +42,7 @@ export default defineConfig({
     ? {
         command:
           process.env.DEPLOYMENT_ENVIRONMENT === 'CDN'
-            ? 'cp -r ../headless/dist/browser ./dist-storybook/headless/ && cp -r ../bueno/dist/browser ./dist-storybook/bueno/ && npx ws -c ws.config.cjs'
+            ? 'cp -r ../headless/cdn ./dist-storybook/headless/ && cp -r ../bueno/dist/browser ./dist-storybook/bueno/ && npx ws -c ws.config.cjs'
             : 'npx ws -d ./dist-storybook -p 4400',
         port: 4400,
         timeout: 120 * 1000,

diff --git a/packages/atomic/scripts/start-vite.mjs b/packages/atomic/scripts/start-vite.mjs
@@ -61,7 +61,7 @@ const run = async () => {
     `Copying headless files to ${devPublicDir}/headless/v${headlessVersion}`
   );
   await copyFiles(
-    path.join(headlessDir, 'dist/browser'),
+    path.join(headlessDir, 'cdn'),
     `${devPublicDir}/headless/v${headlessVersion}`
   );
 

diff --git a/packages/headless/.gitignore b/packages/headless/.gitignore
@@ -3,3 +3,4 @@ temp/
 doc-parser/build
 
 src/external-builds
+cdn/
diff --git a/packages/headless/contributors/adding-a-sub-package.md b/packages/headless/contributors/adding-a-sub-package.md
@@ -44,19 +44,10 @@ A sub-package groups together exports (i.e. engine, controllers, action loaders,
    "exports": {
      // ...
      "./case-assist": {
-       "types": "./dist/definitions/case-assist.index.d.ts",
-       "node": {
-         "types": "./dist/definitions/case-assist.index.d.ts",
-         "import": "./dist/case-assist/headless.esm.js",
-         "require": "./dist/case-assist/headless.cjs"
-       },
-       "browser": {
-         "types": "./dist/definitions/case-assist.index.d.ts",
-         "import": "./dist/browser/case-assist/headless.esm.js",
-         "require": "./dist/browser/case-assist/headless.js"
-       },
-       "import": "./dist/browser/case-assist/headless.esm.js",
-       "require": "./dist/browser/case-assist/headless.js"
+        "types": "./dist/definitions/case-assist.index.d.ts",
+        "import": "./dist/case-assist/headless.esm.js",
+        "require": "./dist/case-assist/headless.cjs",
+        "default": "./dist/case-assist/headless.esm.js"
      },
      // ...
    }

diff --git a/packages/headless/contributors/troubleshooting-bundles-content.md b/packages/headless/contributors/troubleshooting-bundles-content.md
@@ -14,7 +14,7 @@ However, due to the internal project architecture, unnecessary code can sometime
 
 During the building process of Headless bundles using esbuild, `metafiles` are generated simultaneously and saved in the "dist" folder. This configuration can be found in `esbuild.mjs`.
 
-After executing the command `npm run build`, you should find the available `metafiles` in the `dist` folder, such as `dist/browser/browser.esm.stats.json` or `dist/browser/case-assist/browser.esm.stats.json`.
+After executing the command `npm run build`, you should find the available `metafiles` in the `dist` folder, such as `cdn/browser.esm.stats.json` or `cdn/case-assist/browser.esm.stats.json`.
 
 These files contain metadata about the build process, specifically providing information about the files included in the final bundle and the reasons behind their inclusion.
 

diff --git a/packages/headless/esbuild.mjs b/packages/headless/esbuild.mjs
@@ -90,7 +90,7 @@ const base = {
 
 const browserEsm = Object.entries(useCaseEntries).map((entry) => {
   const [useCase, entryPoint] = entry;
-  const outDir = getUseCaseDir('dist/browser', useCase);
+  const outDir = getUseCaseDir('cdn', useCase);
   const outfile = `${outDir}/headless.esm.js`;
 
   let config = {
@@ -113,7 +113,7 @@ const browserEsm = Object.entries(useCaseEntries).map((entry) => {
 
 const browserUmd = Object.entries(useCaseEntries).map((entry) => {
   const [useCase, entryPoint] = entry;
-  const outDir = getUseCaseDir('dist/browser/', useCase);
+  const outDir = getUseCaseDir('cdn', useCase);
   const outfile = `${outDir}/headless.js`;
 
   const globalName = getUmdGlobalName(useCase);

diff --git a/packages/headless/package.json b/packages/headless/package.json
@@ -7,113 +7,50 @@
     "directory": "packages/headless"
   },
   "main": "./dist/headless.cjs",
-  "module": "./dist/browser/headless.esm.js",
+  "module": "./dist/headless.esm.js",
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/definitions/index.d.ts",
-      "node": {
-        "types": "./dist/definitions/index.d.ts",
-        "import": "./dist/headless.esm.js",
-        "require": "./dist/headless.cjs"
-      },
-      "browser": {
-        "types": "./dist/definitions/index.d.ts",
-        "import": "./dist/browser/headless.esm.js",
-        "require": "./dist/browser/headless.js"
-      },
-      "import": "./dist/browser/headless.esm.js",
-      "require": "./dist/browser/headless.js"
+      "import": "./dist/headless.esm.js",
+      "require": "./dist/headless.cjs",
+      "default": "./dist/headless.esm.js"
     },
     "./case-assist": {
       "types": "./dist/definitions/case-assist.index.d.ts",
-      "node": {
-        "types": "./dist/definitions/case-assist.index.d.ts",
-        "import": "./dist/case-assist/headless.esm.js",
-        "require": "./dist/case-assist/headless.cjs"
-      },
-      "browser": {
-        "types": "./dist/definitions/case-assist.index.d.ts",
-        "import": "./dist/browser/case-assist/headless.esm.js",
-        "require": "./dist/browser/case-assist/headless.js"
-      },
-      "import": "./dist/browser/case-assist/headless.esm.js",
-      "require": "./dist/browser/case-assist/headless.js"
+      "import": "./dist/case-assist/headless.esm.js",
+      "require": "./dist/case-assist/headless.cjs",
+      "default": "./dist/case-assist/headless.esm.js"
     },
     "./commerce": {
       "types": "./dist/definitions/commerce.index.d.ts",
-      "node": {
-        "types": "./dist/definitions/commerce.index.d.ts",
-        "import": "./dist/commerce/headless.esm.js",
-        "require": "./dist/commerce/headless.cjs"
-      },
-      "browser": {
-        "types": "./dist/definitions/commerce.index.d.ts",
-        "import": "./dist/browser/commerce/headless.esm.js",
-        "require": "./dist/browser/commerce/headless.js"
-      },
-      "import": "./dist/browser/commerce/headless.esm.js",
-      "require": "./dist/browser/commerce/headless.js"
+      "import": "./dist/commerce/headless.esm.js",
+      "require": "./dist/commerce/headless.cjs",
+      "default": "./dist/commerce/headless.esm.js"
     },
     "./insight": {
       "types": "./dist/definitions/insight.index.d.ts",
-      "node": {
-        "types": "./dist/definitions/insight.index.d.ts",
-        "import": "./dist/insight/headless.esm.js",
-        "require": "./dist/insight/headless.cjs"
-      },
-      "browser": {
-        "types": "./dist/definitions/insight.index.d.ts",
-        "import": "./dist/browser/insight/headless.esm.js",
-        "require": "./dist/browser/insight/headless.js"
-      },
-      "import": "./dist/browser/insight/headless.esm.js",
-      "require": "./dist/browser/insight/headless.js"
+      "import": "./dist/insight/headless.esm.js",
+      "require": "./dist/insight/headless.cjs",
+      "default": "./dist/insight/headless.esm.js"
     },
     "./recommendation": {
       "types": "./dist/definitions/recommendation.index.d.ts",
-      "node": {
-        "types": "./dist/definitions/recommendation.index.d.ts",
-        "import": "./dist/recommendation/headless.esm.js",
-        "require": "./dist/recommendation/headless.cjs"
-      },
-      "browser": {
-        "types": "./dist/definitions/recommendation.index.d.ts",
-        "import": "./dist/browser/recommendation/headless.esm.js",
-        "require": "./dist/browser/recommendation/headless.js"
-      },
-      "import": "./dist/browser/recommendation/headless.esm.js",
-      "require": "./dist/browser/recommendation/headless.js"
+      "import": "./dist/recommendation/headless.esm.js",
+      "require": "./dist/recommendation/headless.cjs",
+      "default": "./dist/recommendation/headless.esm.js"
     },
     "./ssr": {
       "types": "./dist/definitions/ssr.index.d.ts",
-      "node": {
-        "types": "./dist/definitions/ssr.index.d.ts",
-        "import": "./dist/ssr/headless.esm.js",
-        "require": "./dist/ssr/headless.cjs"
-      },
-      "browser": {
-        "types": "./dist/definitions/ssr.index.d.ts",
-        "import": "./dist/browser/ssr/headless.esm.js",
-        "require": "./dist/browser/ssr/headless.js"
-      },
-      "import": "./dist/browser/ssr/headless.esm.js",
-      "require": "./dist/browser/ssr/headless.js"
+      "import": "./dist/ssr/headless.esm.js",
+      "require": "./dist/ssr/headless.cjs",
+      "default": "./dist/ssr/headless.esm.js"
     },
     "./ssr-commerce": {
       "types": "./dist/definitions/ssr-commerce.index.d.ts",
-      "node": {
-        "types": "./dist/definitions/ssr-commerce.index.d.ts",
-        "import": "./dist/ssr-commerce/headless.esm.js",
-        "require": "./dist/ssr-commerce/headless.cjs"
-      },
-      "browser": {
-        "types": "./dist/definitions/ssr-commerce.index.d.ts",
-        "import": "./dist/browser/ssr-commerce/headless.esm.js",
-        "require": "./dist/browser/ssr-commerce/headless.js"
-      },
-      "import": "./dist/browser/ssr-commerce/headless.esm.js",
-      "require": "./dist/browser/ssr-commerce/headless.js"
+      "import": "./dist/ssr-commerce/headless.esm.js",
+      "require": "./dist/ssr-commerce/headless.cjs",
+      "default": "./dist/ssr-commerce/headless.esm.js"
     }
   },
   "types": "./dist/definitions/index.d.ts",

diff --git a/packages/samples/headless-commerce-react/vite.config.js b/packages/samples/headless-commerce-react/vite.config.js
@@ -49,7 +49,7 @@ export default defineConfig({
             dest: `./bueno/${buenoVersion}`,
           },
           {
-            src: '../../headless/dist/browser/*',
+            src: '../../headless/cdn/*',
             dest: `./headless/${headlessVersion}`,
           },
         ],
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,3 +3,4 @@ temp/
		doc-parser/build

		src/external-builds
		cdn/