@wp-playground/client 1.0.26 → 1.0.28

package/README.md

@@ -0,0 +1,42 @@
+# Playground Client
+
+Provides a [PlaygroundClient](https://wordpress.github.io/wordpress-playground/api/client/) that can be used to control a WordPress Playground iframe:
+
+```ts
+import { startPlaygroundWeb } from '@wp-playground/client';
+
+const client = await startPlaygroundWeb({
+	// An iframe pointing to https://playground.wordpress.net/remote.html:
+	iframe: document.getElementById('wp'),
+	remoteUrl: `https://playground.wordpress.net/remote.html`,
+});
+
+const response = await client.run({
+	// wp-load.php is only required if you want to interact with WordPress.
+	code: '<?php require_once "/wordpress/wp-load.php"; $posts = get_posts(); echo "Post Title: " . $posts[0]->post_title;',
+});
+console.log(response.text);
+```
+
+Using TypeScript is highly recommended as this package ships with comprehensive types – hit ctrl+space in your IDE after `client.` and you'll see all the available methods.
+
+Once you have a [PlaygroundClient](https://wordpress.github.io/wordpress-playground/api/client/) instance, you can use it to control the playground:
+
+```ts
+await client.writeFile('/index.php', '<?php echo "Hi!"; ');
+await client.run({
+	scriptPath: '/index.php',
+});
+
+console.log(await client.readFileAsText('/index.php'));
+
+await client.request({
+	url: '/index.php',
+	method: 'POST',
+	body: {
+		foo: 'bar',
+	},
+});
+```
+
+To see all the available methods, check out the [PlaygroundClient](https://wordpress.github.io/wordpress-playground/api/client/) interface.

package/index.cjs

@@ -744,7 +744,8 @@ function zipDir($root, $output, $options = array())
                         $directory_path = $entry . '/';
                         array_push($directories, $directory_path);
                     } else if (is_file($entry)) {
-                        $zip->addFile($entry, substr($entry, strlen($zip_root)));
+                        // ensure compliance with zip spec by only using relative paths for files
+                        $zip->addFile($entry, ltrim(substr($entry, strlen($zip_root)), '/'));
                     }
                 }
                 closedir($handle);

package/index.js

@@ -2164,7 +2164,8 @@ function zipDir($root, $output, $options = array())
                         $directory_path = $entry . '/';
                         array_push($directories, $directory_path);
                     } else if (is_file($entry)) {
-                        $zip->addFile($entry, substr($entry, strlen($zip_root)));
+                        // ensure compliance with zip spec by only using relative paths for files
+                        $zip->addFile($entry, ltrim(substr($entry, strlen($zip_root)), '/'));
                     }
                 }
                 closedir($handle);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wp-playground/client",
-  "version": "1.0.26",
+  "version": "1.0.28",
   "description": "WordPress Playground client",
   "repository": {
     "type": "git",
@@ -37,7 +37,7 @@
   "main": "./index.cjs",
   "module": "./index.js",
   "types": "index.d.ts",
-  "gitHead": "f5b85399ff8dbabaf122bfa98347ce76d7f59910",
+  "gitHead": "ed7171a91717c70dd7162e3d93283f66d21c001d",
   "engines": {
     "node": ">=18.18.0",
     "npm": ">=8.11.0"
@@ -50,6 +50,8 @@
     "comlink": "^4.4.1",
     "crc-32": "1.2.2",
     "diff3": "0.0.4",
+    "events": "3.3.0",
+    "express": "4.19.2",
     "ignore": "5.2.4",
     "ini": "4.1.2",
     "minimisted": "2.0.1",
@@ -60,12 +62,14 @@
     "sha.js": "2.4.11",
     "simple-get": "4.0.1",
     "wasm-feature-detect": "1.8.0",
-    "@wp-playground/blueprints": "1.0.26",
-    "@php-wasm/universal": "1.0.26",
-    "@php-wasm/util": "1.0.26",
-    "@php-wasm/web": "1.0.26",
-    "@php-wasm/progress": "1.0.26",
-    "@wp-playground/remote": "1.0.26",
-    "@php-wasm/logger": "1.0.26"
+    "ws": "8.18.0",
+    "yargs": "17.7.2",
+    "@wp-playground/blueprints": "1.0.28",
+    "@php-wasm/universal": "1.0.28",
+    "@php-wasm/util": "1.0.28",
+    "@php-wasm/web": "1.0.28",
+    "@php-wasm/progress": "1.0.28",
+    "@wp-playground/remote": "1.0.28",
+    "@php-wasm/logger": "1.0.28"
   }
 }