@wp-playground/client 0.7.18 → 0.7.20

package/index.d.ts

@@ -265,19 +265,6 @@ export interface IsomorphicLocalPHP {
 	 * @param listener - The listener function to be removed.
 	 */
 	removeEventListener(eventType: PHPEvent["type"], listener: PHPEventListener): void;
-	/**
-	 * Sets the path to the php.ini file to use for the PHP instance.
-	 *
-	 * @param path - The path to the php.ini file.
-	 */
-	setPhpIniPath(path: string): void;
-	/**
-	 * Sets a value for a specific key in the php.ini file for the PHP instance.
-	 *
-	 * @param key - The key to set the value for.
-	 * @param value - The value to set for the key.
-	 */
-	setPhpIniEntry(key: string, value: string): void;
 	/**
 	 * Recursively creates a directory with the given path in the PHP filesystem.
 	 * For example, if the path is `/root/php/data`, and `/root` already exists,
@@ -494,7 +481,7 @@ export type SpawnHandler = (command: string, args: string[]) => ChildProcess;
  * that can't be serialized over a remote connection. Therefeore,
  * they don't make sense in a remote PHP instance.
  */
-export type IsomorphicRemotePHP = Remote<Omit<IsomorphicLocalPHP, "setSapiName" | "setPhpIniEntry" | "setPhpIniPath">>;
+export type IsomorphicRemotePHP = Remote<Omit<IsomorphicLocalPHP, "setSapiName">>;
 export type UniversalPHP = IsomorphicLocalPHP | IsomorphicRemotePHP;
 export type HTTPMethod = "GET" | "POST" | "HEAD" | "OPTIONS" | "PATCH" | "PUT" | "DELETE";
 export type PHPRequestHeaders = Record<string, string>;
@@ -581,6 +568,13 @@ export interface ListFilesOptions {
 	 */
 	prependPath: boolean;
 }
+/**
+ * Rewrites the php.ini file with the given entries.
+ *
+ * @param php The PHP instance.
+ * @param entries The entries to write to the php.ini file.
+ */
+export declare function setPhpIniEntries(php: UniversalPHP, entries: Record<string, unknown>): Promise<void>;
 export type RuntimeType = "NODE" | "WEB" | "WORKER";
 export type PHPRuntimeId = number;
 export type PHPRuntime = any;
@@ -856,10 +850,6 @@ declare abstract class BasePHP implements IsomorphicLocalPHP, Disposable {
 	/** @inheritDoc */
 	setSapiName(newName: string): Promise<void>;
 	/** @inheritDoc */
-	setPhpIniPath(path: string): void;
-	/** @inheritDoc */
-	setPhpIniEntry(key: string, value: string): void;
-	/** @inheritDoc */
 	chdir(path: string): void;
 	/**
 	 * Do not use. Use new PHPRequestHandler() instead.
@@ -1253,10 +1243,10 @@ export interface DefineSiteUrlStep {
 	siteUrl: string;
 }
 /**
- * Sets WP_HOME and WP_SITEURL constants for the WordPress installation.
+ * Sets [`WP_HOME`](https://developer.wordpress.org/advanced-administration/wordpress/wp-config/#blog-address-url) and [`WP_SITEURL`](https://developer.wordpress.org/advanced-administration/wordpress/wp-config/#wp-siteurl) constants for the WordPress installation.
  *
- * Beware: Using this step makes no sense on playground.wordpress.net.
- * It is useful when you're building a custom Playground-based tool like wp-now,
+ * Using this step on playground.wordpress.net is moot.
+ * It is useful when building a custom Playground-based tool, like [`wp-now`](https://www.npmjs.com/package/@wp-now/wp-now),
  * or deploying Playground on a custom domain.
  *
  * @param playground The playground client.
@@ -1407,8 +1397,8 @@ export type LoginStep = {
 	password?: string;
 };
 /**
- * Logs in to the Playground.
- * Under the hood, this function submits the wp-login.php form
+ * Logs in to Playground.
+ * Under the hood, this function submits the [`wp-login.php`](https://developer.wordpress.org/reference/files/wp-login.php/) [form](https://developer.wordpress.org/reference/functions/wp_login_form/)
  * just like a user would.
  */
 export declare const login: StepHandler<LoginStep>;
@@ -1453,8 +1443,8 @@ export type SetSiteOptionsStep = {
 	options: Record<string, unknown>;
 };
 /**
- * Sets site options. This is equivalent to calling `update_option` for each
- * option in the `options` object.
+ * Sets site options. This is equivalent to calling [`update_option`](https://developer.wordpress.org/reference/functions/update_option/) for each
+ * option in the [`options`](https://developer.wordpress.org/apis/options/#available-options-by-category) object.
  */
 export declare const setSiteOptions: StepHandler<SetSiteOptionsStep>;
 /**
@@ -1482,7 +1472,7 @@ export interface UpdateUserMetaStep {
 	userId: number;
 }
 /**
- * Updates user meta. This is equivalent to calling `update_user_meta` for each
+ * Updates user meta. This is equivalent to calling [`update_user_meta`](https://developer.wordpress.org/reference/functions/update_user_meta/) for each
  * meta value in the `meta` object.
  */
 export declare const updateUserMeta: StepHandler<UpdateUserMetaStep>;
@@ -1655,6 +1645,7 @@ export interface RunPHPStep {
 }
 /**
  * Runs PHP code.
+ * When running WordPress functions, the `code` key must first load [`wp-load.php`](https://github.com/WordPress/WordPress/blob/master/wp-load.php) and start with `"<?php require_once 'wordpress/wp-load.php'; "`.
  */
 export declare const runPHP: StepHandler<RunPHPStep, Promise<PHPResponse>>;
 /**
@@ -1677,7 +1668,7 @@ export declare const runPHP: StepHandler<RunPHPStep, Promise<PHPResponse>>;
 export interface RunPHPWithOptionsStep {
 	step: "runPHPWithOptions";
 	/**
-	 * Run options (See /wordpress-playground/api/universal/interface/PHPRunOptions)
+	 * Run options (See /wordpress-playground/api/universal/interface/PHPRunOptions/))
 	 */
 	options: PHPRunOptions;
 }
@@ -1714,7 +1705,7 @@ export interface RequestStep {
 	request: PHPRequest;
 }
 /**
- * Sends a HTTP request to the Playground.
+ * Sends a HTTP request to Playground.
  */
 export declare const request: StepHandler<RequestStep, Promise<PHPResponse>>;
 /**
@@ -1761,13 +1752,14 @@ export interface DefineWpConfigConstsStep {
 	/** The constants to define */
 	consts: Record<string, unknown>;
 	/**
-	 * The method of defining the constants. Possible values are:
+	 * The method of defining the constants in wp-config.php. Possible values are:
 	 *
 	 * - rewrite-wp-config: Default. Rewrites the wp-config.php file to
 	 *                      explicitly call define() with the requested
 	 *                      name and value. This method alters the file
 	 *                      on the disk, but it doesn't conflict with
 	 *                      existing define() calls in wp-config.php.
+	 *
 	 * - define-before-run: Defines the constant before running the requested
 	 *                      script. It doesn't alter any files on the disk, but
 	 *                      constants defined this way may conflict with existing
@@ -1782,7 +1774,7 @@ export interface DefineWpConfigConstsStep {
 	virtualize?: boolean;
 }
 /**
- * Defines constants in a wp-config.php file.
+ * Defines constants in a [`wp-config.php`](https://developer.wordpress.org/advanced-administration/wordpress/wp-config/) file.
  *
  * This step can be called multiple times, and the constants will be merged.
  *
@@ -1878,9 +1870,9 @@ export interface ImportWordPressFilesStep<ResourceType> {
 }
 /**
  * Imports top-level WordPress files from a given zip file into
- * the documentRoot. For example, if a zip file contains the
+ * the `documentRoot`. For example, if a zip file contains the
  * `wp-content` and `wp-includes` directories, they will replace
- * the corresponding directories in Playground's documentRoot.
+ * the corresponding directories in Playground's `documentRoot`.
  *
  * Any files that Playground recognizes as "excluded from the export"
  * will carry over from the existing document root into the imported
@@ -1931,7 +1923,7 @@ export interface EnableMultisiteStep {
 	step: "enableMultisite";
 }
 /**
- * Defines constants in a wp-config.php file.
+ * Defines the [Multisite](https://developer.wordpress.org/advanced-administration/multisite/create-network/) constants in a `wp-config.php` file.
  *
  * This step can be called multiple times, and the constants will be merged.
  *
@@ -1960,7 +1952,7 @@ export interface WPCLIStep {
 	wpCliPath?: string;
 }
 /**
- * Runs PHP code.
+ * Runs PHP code using [WP-CLI](https://developer.wordpress.org/cli/commands/).
  */
 export declare const wpCLI: StepHandler<WPCLIStep, Promise<PHPResponse>>;
 /**
@@ -2183,7 +2175,7 @@ declare class WebPHP extends BasePHP {
 	static load(phpVersion: SupportedPHPVersion, options?: PHPWebLoaderOptions): Promise<WebPHP>;
 	static loadRuntime(phpVersion: SupportedPHPVersion, options?: PHPWebLoaderOptions): Promise<number>;
 }
-declare class WebPHPEndpoint implements Omit<IsomorphicLocalPHP, "setSapiName" | "setPhpIniEntry" | "setPhpIniPath"> {
+declare class WebPHPEndpoint implements Omit<IsomorphicLocalPHP, "setSapiName"> {
 	/** @inheritDoc @php-wasm/universal!RequestHandler.absoluteUrl  */
 	absoluteUrl: string;
 	/** @inheritDoc @php-wasm/universal!RequestHandler.documentRoot  */
@@ -2219,10 +2211,6 @@ declare class WebPHPEndpoint implements Omit<IsomorphicLocalPHP, "setSapiName" |
 	chdir(path: string): void;
 	/** @inheritDoc @php-wasm/web!WebPHP.setSapiName */
 	setSapiName(newName: string): void;
-	/** @inheritDoc @php-wasm/web!WebPHP.setPhpIniPath */
-	setPhpIniPath(path: string): void;
-	/** @inheritDoc @php-wasm/web!WebPHP.setPhpIniEntry */
-	setPhpIniEntry(key: string, value: string): void;
 	/** @inheritDoc @php-wasm/web!WebPHP.mkdir */
 	mkdir(path: string): void;
 	/** @inheritDoc @php-wasm/web!WebPHP.mkdirTree */