@intuned/browser-dev 2.2.3-test-build.2 → 2.2.3-test-build.23

package/BROWSER_SCRIPTS_SETUP.md

@@ -16,17 +16,18 @@ The `common/browser_scripts.js` file at the root of the monorepo needs to be inc
 
 The generation happens automatically:
 
-### During Installation
+### During Development (prepare hook)
 
-When you run `yarn install`, the `postinstall` hook automatically generates `script.ts`:
+When you run `yarn install` or `npm publish` in the development repo, the `prepare` hook generates `script.ts`:
 
 ```bash
-yarn install  # automatically runs generate-browser-script
+yarn install  # automatically runs prepare → generate-browser-script
+npm publish   # prepare hook runs before publishing
 ```
 
 ### During Build
 
-The build script also regenerates `script.ts` before compiling:
+The build script regenerates `script.ts` before compiling:
 
 ```bash
 yarn build  # runs generate-browser-script → tsc → babel
@@ -40,6 +41,10 @@ You can manually regenerate the file:
 yarn generate-browser-script
 ```
 
+### For Package Consumers
+
+When users install your package via npm/yarn, they get the pre-generated `script.ts` that's committed to the repo. The `prepare` hook does NOT run when installing as a dependency (only during development/publishing).
+
 ## Usage in Code
 
 In `ensureBrowserScripts.ts`:
@@ -65,9 +70,10 @@ async function ensureBrowserScripts(page: Page): Promise<void> {
 ## Important Notes
 
 - **DO NOT** edit `script.ts` manually - it's auto-generated
-- **DO NOT** commit `script.ts` to git - it's in `.gitignore`
-- The file is regenerated on every build and install
-- If you update `common/browser_scripts.js`, run `yarn generate-browser-script` to update
+- **DO** commit `script.ts` to git - it needs to be in the published package
+- The file is regenerated on every build and during `prepare` (development only)
+- If you update `common/browser_scripts.js`, run `yarn generate-browser-script` to update and commit the changes
+- Package consumers get the pre-generated file, so they don't need the `scripts/` folder
 
 ## Benefits
 

package/dist/common/script.js

@@ -2599,5 +2599,4 @@ const BROWSER_SCRIPT = exports.BROWSER_SCRIPT = `(function () {
     convertHtmlStringToSemanticMarkdown: nodeExports.convertHtmlToMarkdown,
     getElementXPath: getElementXPath,
   };
-})();
-`;
+})();`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intuned/browser-dev",
-  "version": "2.2.3-test-build.2",
+  "version": "2.2.3-test-build.23",
   "description": "runner package for intuned functions",
   "types": "./dist/index.d.ts",
   "typesVersions": {
@@ -35,8 +35,7 @@
   "author": "Intuned Team",
   "license": "Elastic-2.0",
   "scripts": {
-    "generate-browser-script": "node scripts/generate-browser-script.js",
-    "postinstall": "yarn generate-browser-script",
+    "generate-browser-script": "bash scripts/generate-browser-script.sh",
     "build": "rm -rf dist && yarn generate-browser-script && tsc -p tsconfig.json && yarn copy-dts && babel src --out-dir dist --extensions '.ts' && node scripts/ensure-index-types.js",
     "ensure-types": "node scripts/ensure-index-types.js",
     "test": "vitest run",