Merge pull request #2 from lightpanda-io/fix/publish

nrigaudiere · web-flow · commit 5635d9fb8204 · 2025-08-14T19:09:28.000+02:00
Fix/publish
diff --git a/.changeset/cuddly-memes-kiss.md b/.changeset/cuddly-memes-kiss.md
diff --git a/.changeset/many-boats-peel.md b/.changeset/many-boats-peel.md
@@ -0,0 +1,5 @@
+---
+"@lightpanda/browser-test": patch
+---
+
+New test
diff --git a/.npmrc b/.npmrc
@@ -1 +1,2 @@
-//registry.npmjs.org/:_authToken=$LIGHTPANDA_NPM_TOKEN
+scope=@lightpanda
+@lightpanda:registry=https://registry.npmjs.org/
diff --git a/README.md b/README.md
@@ -53,4 +53,25 @@ See [benchmark details](https://github.com/lightpanda-io/demo)._
 
 This repository contains all the [NPM](https://npmjs.com) packages created for Lightpanda
 
-<!-- USAGE EXAMPLES -->
+### Build
+
+```
+$ yarn build
+```
+
+### Publish
+To publish packages, we use [changesets](https://github.com/changesets/changesets). Make sure to have commited & pushed all your code before publishing.
+
+1. Run the following command to create a new version (patch, minor, major)
+
+```
+$ yarn changeset add
+```
+
+2. Publish all the packages
+
+```
+$ yarn publish-packages
+```
+
+3. Push the new commits & merge to main
diff --git a/packages/browser/.npmignore b/packages/browser/.npmignore
@@ -1 +1,6 @@
 lightpanda
+src/*
+cli/*
+scripts/*
+.turbo
+tsconfig.json
diff --git a/packages/browser/CHANGELOG.md b/packages/browser/CHANGELOG.md
@@ -0,0 +1,7 @@
+# @lightpanda/browser
+
+## 1.0.0
+
+### Major Changes
+
+- [#1](https://github.com/lightpanda-io/node-packages/pull/1) [`c5c17b7`](https://github.com/lightpanda-io/node-packages/commit/c5c17b708e10ea1373033873cd308e6ed1e3783f) Thanks [@nrigaudiere](https://github.com/nrigaudiere)! - Initial deployment
diff --git a/packages/browser/README.md b/packages/browser/README.md
@@ -67,6 +67,14 @@ or
 ```bash
 pnpm add @lightpanda/browser
 ```
+
+## Upgrade browser
+
+At some point in time, you might want to upgrade Lightpanda browser to a more recent version. To do so, you can run the following command:
+```bash
+npx @lightpanda/browser
+```
+
 <!-- USAGE EXAMPLES -->
 
 ## Examples
@@ -99,6 +107,10 @@ const options: LightpandaServeOptions = {
 const proc = await lightpanda.serve(options)
 
 // Do your magic ✨
+
+proc.stdout.destroy()
+proc.stderr.destroy()
+proc.kill()
 ```
 
 ℹ️ _Lightpanda's CDP server can be used alongside projects like [Puppeteer](https://pptr.dev/) or [Playwright](https://playwright.dev/)._
diff --git a/packages/browser/cli/install.ts b/packages/browser/cli/install.ts
@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+import packageJson from './../package.json' with { type: 'json' }
+import { download } from './../src/download'
+
+download(`node_modules/${packageJson.name}/dist/lightpanda`)
diff --git a/packages/browser/index.ts b/packages/browser/index.ts
@@ -0,0 +1,10 @@
+import { fetch } from './src/fetch'
+import { serve } from './src/serve'
+
+export { LightpandaFetchOptions } from './src/fetch'
+export { LightpandaServeOptions } from './src/serve'
+
+export const lightpanda = {
+  fetch,
+  serve,
+}
diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -1,17 +1,25 @@
 {
   "name": "@lightpanda/browser",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Lightpanda for Node.js",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/types/index.d.ts",
+  "type": "module",
   "scripts": {
-    "dev": "tsup src/index.ts --target node22 --format cjs,esm --dts --watch",
-    "build": "tsup src/index.ts --target node22 --format cjs,esm --minify terser && yarn dlx --package=typescript tsc --emitDeclarationOnly --declaration",
-    "postinstall": "npx tsup scripts/postinstall.ts --target node22 && node dist/postinstall.js",
+    "dev": "tsup index.ts --target node22 --format cjs,esm --dts --watch",
+    "build:index": "tsup index.ts --target node22 --format cjs,esm --minify terser",
+    "build:decl": "yarn dlx --package=typescript tsc --emitDeclarationOnly --declaration --declarationDir dist/types",
+    "build:cli": "tsup cli/install.ts --target node22 --format cjs,esm --minify terser -d dist/cli",
+    "build:postinstall": "tsup scripts/postinstall.ts --target node22 --format cjs,esm --minify terser -d dist/scripts",
+    "build": "yarn build:index && yarn build:decl && yarn build:cli && yarn build:postinstall",
+    "postinstall": "node dist/scripts/postinstall.js || true",
     "lint": "biome ci . --diagnostic-level=error",
     "typecheck": "yarn dlx --package=typescript tsc --noEmit"
   },
+  "bin": {
+    "lightpanda": "./dist/cli/install.js"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/lightpanda-io/node-packages/tree/main/packages/browser"
diff --git a/packages/browser/scripts/postinstall.ts b/packages/browser/scripts/postinstall.ts
@@ -1,61 +1,3 @@
-import { constants, chmodSync, createWriteStream } from 'node:fs'
-import https from 'node:https'
-import { arch, exit, platform } from 'node:process'
+import { download } from './../src/download'
 
-const BINARY_NAME = 'lightpanda'
-const PLATFORMS = {
-  darwin: {
-    x64: 'x86_64-macos',
-    arm64: 'aarch64-macos',
-  },
-  linux: {
-    x64: 'x86_64-linux',
-    arm64: 'aarch64-linux',
-  },
-}
-
-const get = (url: string, resolve: (value?: unknown) => void, reject: (reason: any) => void) => {
-  const file = createWriteStream(BINARY_NAME)
-
-  https.get(url, res => {
-    if (res.statusCode === 301 || res.statusCode === 302 || res.statusCode === 307) {
-      return get(res.headers.location, resolve, reject)
-    }
-
-    res
-      .pipe(file)
-      .on('finish', () => {
-        resolve()
-      })
-      .on('error', error => {
-        reject(error)
-      })
-  })
-}
-
-const downloadBinary = async (url: string) => {
-  return new Promise((resolve, reject) => get(url, resolve, reject))
-}
-
-const main = async () => {
-  const path = PLATFORMS?.[platform]?.[arch]
-
-  if (path) {
-    try {
-      await downloadBinary(
-        `https://github.com/lightpanda-io/browser/releases/download/nightly/lightpanda-${path}`,
-      )
-      chmodSync(BINARY_NAME, constants.S_IRWXU)
-      exit(0)
-    } catch (e) {
-      console.log('error', e)
-      console.warn(`Lightpanda's postinstall script failed to download the binary file "${path}".`)
-      exit(1)
-    }
-  } else {
-    console.warn("Lightpanda package doesn't ship with prebuilt binaries for your platform yet. ")
-    exit(1)
-  }
-}
-
-main()
+download()
diff --git a/packages/browser/src/download.ts b/packages/browser/src/download.ts
@@ -0,0 +1,73 @@
+import { constants, chmodSync, createWriteStream } from 'node:fs'
+import https from 'node:https'
+import { arch, exit, platform } from 'node:process'
+
+const FOLDER = 'dist'
+const BINARY_NAME = 'lightpanda'
+const BINARY_PATH = `${FOLDER}/${BINARY_NAME}`
+
+const PLATFORMS = {
+  darwin: {
+    x64: 'x86_64-macos',
+    arm64: 'aarch64-macos',
+  },
+  linux: {
+    x64: 'x86_64-linux',
+    arm64: 'aarch64-linux',
+  },
+}
+
+/**
+ * Download Lightpanda's binary
+ * @returns {Promise<void>}
+ */
+export const download = async (binaryPath: string = BINARY_PATH): Promise<void> => {
+  const path = PLATFORMS?.[platform]?.[arch]
+
+  const get = (url: string, resolve: (value?: unknown) => void, reject: (reason: any) => void) => {
+    const file = createWriteStream(binaryPath)
+
+    https.get(url, res => {
+      if (
+        res.headers.location &&
+        (res.statusCode === 301 || res.statusCode === 302 || res.statusCode === 307)
+      ) {
+        return get(res.headers.location, resolve, reject)
+      }
+
+      res
+        .pipe(file)
+        .on('finish', () => {
+          resolve()
+        })
+        .on('error', error => {
+          reject(error)
+        })
+    })
+  }
+
+  const downloadBinary = async (url: string) => {
+    return new Promise((resolve, reject) => get(url, resolve, reject))
+  }
+
+  if (path) {
+    try {
+      console.info('⏳ Downloading latest version of Lightpanda browser…')
+
+      await downloadBinary(
+        `https://github.com/lightpanda-io/browser/releases/download/nightly/lightpanda-${path}`,
+      )
+      chmodSync(binaryPath, constants.S_IRWXU)
+
+      console.info('✅ Download finished!')
+      exit(0)
+    } catch (e) {
+      console.log('error', e)
+      console.warn(`Lightpanda's failed to download the binary file "${path}".`)
+      exit(1)
+    }
+  } else {
+    console.warn("Lightpanda package doesn't ship with prebuilt binaries for your platform yet. ")
+    exit(1)
+  }
+}
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
diff --git a/packages/browser/tsconfig.json b/packages/browser/tsconfig.json
@@ -4,6 +4,7 @@
     "esModuleInterop": true,
     "target": "es6",
     "moduleResolution": "node",
+    "resolveJsonModule": true,
     "sourceMap": true,
     "outDir": "dist",
     "paths": {
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@lightpanda/browser-test": patch
 +---
++
 +New test
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-//registry.npmjs.org/:_authToken=$LIGHTPANDA_NPM_TOKEN`
	`1`	`+scope=@lightpanda`
	`2`	`+@lightpanda:registry=https://registry.npmjs.org/`