@capsulescodes/browser-php 0.5.5

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Capsules Codes <hello@capsules.codes>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,145 @@
+
+<p align="center"><img src="art/capsules-browser-php-image.svg" width="400px" height="265px" alt="Browser PHP" /></p>
+
+Run any PHP stuff within your browser.
+
+The Browser PHP package offers a collection of commands for running PHP from the Node CLI or for launching a PHP server from Node. Perfect for running a Laravel project in CodeSandbox, for example.
+
+<br>
+
+ [This article](https://capsules.codes/en/blog/fyi/en-fyi-run-laravel-on-your-browser-with-browser-php) provides an in-depth exploration of the package.
+
+<br>
+
+## Installation
+
+```bash
+npm install --save-dev @capsulescodes/browser-php
+```
+
+<br>
+<br>
+
+## Usage
+
+This package gives access to three binaries. `php-cli` and `php-server` from `node_modules`, `composer` from `vendor`.
+
+<br>
+
+### PHP
+```
+node node_modules/.bin/php-cli
+```
+
+<br>
+
+Or add `script` in `package.json`
+```
+"scripts" : {
+    "php" : "php-cli"
+},
+```
+
+<br>
+
+Example
+```
+npm run php -r "echo 'Hello Browser PHP World!';"
+
+
+> Hello Browser PHP World!
+```
+
+<br>
+<br>
+
+### Serve
+```
+node node_modules/.bin/php-server
+```
+
+<br>
+
+Or add `script` in `package.json`
+```
+"scripts" : {
+    "serve" : "php-server"
+},
+```
+
+<br>
+
+Example
+```
+npm run serve
+
+
+> PHP server is listening on url http://localhost:2222
+```
+
+<br>
+<br>
+
+
+### Composer
+```
+node node_modules/.bin/php vendor/bin/composer
+```
+
+<br>
+
+Or add `script` in `package.json`
+```
+"scripts" : {
+    "composer": "php-cli vendor/bin/composer"
+},
+```
+
+<br>
+
+Example
+```
+npm run composer
+
+>    ______
+>   / ____/___  ____ ___  ____  ____  ________  _____
+>  / /   / __ \/ __ `__ \/ __ \/ __ \/ ___/ _ \/ ___/
+> / /___/ /_/ / / / / / / /_/ / /_/ (__  )  __/ /
+> \____/\____/_/ /_/ /_/ .___/\____/____/\___/_/
+>                     /_/
+> Composer version 2.7.7 2024-06-10 22:11:12
+```
+
+<br>
+<br>
+
+## Configuration
+
+The scripts can be configured with environment variables
+
+- `BROWSER_PHP_VERSION` : The PHP version you need | default : `8.2`
+
+- `BROWSER_PHP_COMPOSER_VERSION` : The Composer executable version | default : `2.7.7`
+- `BROWSER_PHP_COMPOSER_PATH` : The Composer executable path | default : `vendor/bin`
+- `BROWSER_PHP_COMPOSER_NAME` : The Composer executable name | default : `composer`
+
+- `BROWSER_PHP_SERVER_HOST` : The host name you need | default : `http://localhost`
+- `BROWSER_PHP_SERVER_PORT` : The port you need | default : `2222`
+- `BROWSER_PHP_SERVER_PATH` : The directory path you need | default : `public`
+- `BROWSER_PHP_SERVER_DEBUG` : The debug mode you need | default : `false`
+
+<br>
+<br>
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+Please make sure to update tests as appropriate.
+
+## Credits
+
+- [Capsules Codes](https://github.com/capsulescodes)
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

package/bin/cli.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+import { PHP as i } from "@php-wasm/universal";
+import { loadNodeRuntime as n, createNodeFsMountHandler as c } from "@php-wasm/node";
+import r from "../dist/env.js";
+const o = new i(await n(r.php.version));
+o.mkdir(process.cwd());
+o.mount(process.cwd(), c(process.cwd()));
+o.chdir(process.cwd());
+let e = process.argv.slice(2);
+e.includes("--disable-functions") && (e.splice(e.indexOf("--disable-functions"), 1), e = ["-d", "disable_functions=proc_open,popen", ...e]);
+o.cli(["php", ...e]).catch((s) => {
+  throw s;
+}).finally(() => process.exit(0));

package/bin/server.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+import h from "http";
+import r from "../dist/env.js";
+import { PHPRequestHandler as u, PHP as m } from "@php-wasm/universal";
+import { loadNodeRuntime as w, createNodeFsMountHandler as f } from "@php-wasm/node";
+let n, d;
+const H = h.createServer(async (e, o) => {
+  if (n) {
+    if (e.url) {
+      const s = {};
+      if (e.rawHeaders && e.rawHeaders.length)
+        for (let t = 0; t < e.rawHeaders.length; t += 2)
+          s[e.rawHeaders[t]] = e.rawHeaders[t + 1];
+      const l = new Promise((t) => {
+        const i = [];
+        e.on("data", (p) => i.push(p)).on("end", () => t(Buffer.concat(i).toString()));
+      }), c = { method: e.method, url: e.url, headers: s, body: await l }, a = await n.request(c);
+      r.server.debug && console.log(c, a), delete a.headers["x-frame-options"], Object.keys(a.headers).forEach((t) => o.setHeader(t, a.headers[t])), o.statusCode = a.httpStatusCode, o.end(a.bytes);
+    }
+  } else if (!d) {
+    d = !0, n = new u({ phpFactory: async () => new m(await w(r.php.version)), documentRoot: r.server.path, absoluteUrl: `${r.server.host}:${r.server.port}` });
+    const s = await n.getPrimaryPhp();
+    s.mkdir(process.cwd()), s.mount(process.cwd(), f(process.cwd())), s.chdir(process.cwd()), d = !1, o.statusCode = 302, o.setHeader("location", e.url ?? ""), o.end();
+  }
+});
+H.listen(r.server.port, async () => console.log(`
+PHP server is listening on ${r.server.host}:${r.server.port}
+`));

package/dist/env.js

@@ -0,0 +1,19 @@
+import { config as e } from "dotenv";
+e({ path: process.env.INIT_CWD ? `${process.env.INIT_CWD}/.env` : ".env" });
+const s = {
+  php: { version: process.env.BROWSER_PHP_VERSION != null ? process.env.BROWSER_PHP_VERSION : "8.2" },
+  composer: {
+    name: process.env.BROWSER_PHP_COMPOSER_NAME ?? "composer",
+    version: process.env.BROWSER_PHP_COMPOSER_VERSION ?? "2.7.7",
+    path: process.env.BROWSER_PHP_COMPOSER_PATH ?? "vendor/bin"
+  },
+  server: {
+    host: process.env.BROWSER_PHP_SERVER_HOST ?? "http://localhost",
+    port: process.env.BROWSER_PHP_SERVER_PORT ?? "2222",
+    path: process.env.BROWSER_PHP_SERVER_PATH ?? "public",
+    debug: process.env.BROWSER_PHP_SERVER_DEBUG != null && process.env.BROWSER_PHP_SERVER_DEBUG != "false"
+  }
+};
+export {
+  s as default
+};

package/dist/installer.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+import s from "fs";
+import t from "https";
+import e from "./env.js";
+process.env.INIT_CWD === process.cwd() && !process.env.VITEST && process.exit();
+t.get(`https://getcomposer.org/download/${e.composer.version}/composer.phar`, (o) => {
+  const r = process.env.INIT_CWD ? `${process.cwd()}/${e.composer.path}` : e.composer.path;
+  s.existsSync(r) || s.mkdirSync(r, { recursive: !0 });
+  const p = s.createWriteStream(`${r}/${e.composer.name}`);
+  o.pipe(p);
+}).on("error", (o) => {
+  throw o;
+});

package/package.json

@@ -0,0 +1,51 @@
+{
+    "name" : "@capsulescodes/browser-php",
+    "description" : "PHP CLI and Web server on browser",
+    "version" : "0.5.5",
+    "keywords" : [
+        "node",
+        "browser",
+        "php"
+    ],
+    "homepage" : "https://github.com/capsulescodes/browser-php",
+    "repository" : {
+        "type" : "git",
+        "url" : "git+https://github.com/capsulescodes/browser-php.git"
+    },
+    "license" : "MIT",
+    "author" : {
+        "name" : "Yannick Decat",
+        "email" : "yannick@capsules.codes",
+        "url" : "https://capsules.codes/"
+    },
+    "scripts" : {
+        "build" : "vite build",
+        "test" : "vitest run",
+        "postinstall" : "node dist/installer.js"
+    },
+    "files" : [
+        "!*",
+        "bin",
+        "dist"
+    ],
+    "bin" : {
+        "php-server" : "bin/server.js",
+        "php-cli" : "bin/cli.js"
+    },
+    "dependencies" : {
+        "@php-wasm/node" : "^1.0.8",
+        "@php-wasm/universal" : "^1.0.8",
+        "dotenv" : "^16.4.5",
+        "vite" : "^5.4.10"
+    },
+    "devDependencies" : {
+        "@stylistic/eslint-plugin" : "^2.10.1",
+        "@types/node" : "^22.8.6",
+        "eslint" : "^9.13.0",
+        "tsx" : "^4.19.2",
+        "typescript" : "^5.6.3",
+        "typescript-eslint" : "^8.12.2",
+        "vitest" : "^2.1.4g"
+    },
+    "type" : "module"
+}