@studiometa/forge-core 0.4.5 → 0.4.7

package/dist/index.js

@@ -2,7 +2,7 @@ import { createWriteStream, mkdirSync } from "node:fs";
 import { homedir } from "node:os";
 import { dirname, join } from "node:path";
 import pino from "pino";
-import { BackgroundProcessAttributesSchema, BackupConfigAttributesSchema, CertificateAttributesSchema, CommandAttributesSchema, DatabaseAttributesSchema, DatabaseUserAttributesSchema, DeploymentAttributesSchema, DeploymentOutputAttributesSchema, DeploymentScriptAttributesSchema, EnvironmentAttributesSchema, FirewallRuleAttributesSchema, MonitorAttributesSchema, NginxTemplateAttributesSchema, RecipeAttributesSchema, RedirectRuleAttributesSchema, ScheduledJobAttributesSchema, SecurityRuleAttributesSchema, ServerAttributesSchema, SiteAttributesSchema, SshKeyAttributesSchema, UserAttributesSchema, jsonApiDocumentSchema, jsonApiListDocumentSchema, unwrapDocument, unwrapListDocument } from "@studiometa/forge-api";
+import { BackgroundProcessAttributesSchema, BackgroundProcessLogAttributesSchema, BackupConfigAttributesSchema, CertificateAttributesSchema, CommandAttributesSchema, DatabaseAttributesSchema, DatabaseUserAttributesSchema, DeploymentAttributesSchema, DeploymentOutputAttributesSchema, DeploymentScriptAttributesSchema, EnvironmentAttributesSchema, FirewallRuleAttributesSchema, MonitorAttributesSchema, NginxTemplateAttributesSchema, PhpConfigAttributesSchema, PhpMaxExecutionTimeAttributesSchema, PhpMaxUploadSizeAttributesSchema, PhpOpcacheAttributesSchema, PhpVersionAttributesSchema, RecipeAttributesSchema, RedirectRuleAttributesSchema, ScheduledJobAttributesSchema, SecurityRuleAttributesSchema, ServerAttributesSchema, SiteAttributesSchema, SshKeyAttributesSchema, UserAttributesSchema, jsonApiDocumentSchema, jsonApiListDocumentSchema, unwrapDocument, unwrapListDocument } from "@studiometa/forge-api";
 //#region src/constants.ts
 /**
 * All supported resources.
@@ -28,6 +28,8 @@ var RESOURCES = [
 	"backups",
 	"commands",
 	"scheduled-jobs",
+	"services",
+	"php",
 	"user",
 	"batch"
 ];
@@ -643,6 +645,56 @@ var ROUTES = {
 			path: "/orgs/:org/servers/:server_id/sites/:site_id/scheduled-jobs/:id/output"
 		}
 	},
+	services: { action: {
+		method: "POST",
+		path: "/orgs/:org/servers/:server_id/services/:service/actions"
+	} },
+	php: {
+		listVersions: {
+			method: "GET",
+			path: "/orgs/:org/servers/:server_id/php/versions"
+		},
+		getVersion: {
+			method: "GET",
+			path: "/orgs/:org/servers/:server_id/php/versions/:version_id"
+		},
+		getConfig: {
+			method: "GET",
+			path: "/orgs/:org/servers/:server_id/php/versions/:version_id/configs/:type"
+		},
+		updateConfig: {
+			method: "PUT",
+			path: "/orgs/:org/servers/:server_id/php/versions/:version_id/configs/:type"
+		},
+		getMaxUploadSize: {
+			method: "GET",
+			path: "/orgs/:org/servers/:server_id/php/max-upload-size"
+		},
+		updateMaxUploadSize: {
+			method: "PUT",
+			path: "/orgs/:org/servers/:server_id/php/max-upload-size"
+		},
+		getMaxExecutionTime: {
+			method: "GET",
+			path: "/orgs/:org/servers/:server_id/php/max-execution-time"
+		},
+		updateMaxExecutionTime: {
+			method: "PUT",
+			path: "/orgs/:org/servers/:server_id/php/max-execution-time"
+		},
+		getOpcache: {
+			method: "GET",
+			path: "/orgs/:org/servers/:server_id/php/opcache"
+		},
+		enableOpcache: {
+			method: "POST",
+			path: "/orgs/:org/servers/:server_id/php/opcache"
+		},
+		disableOpcache: {
+			method: "DELETE",
+			path: "/orgs/:org/servers/:server_id/php/opcache"
+		}
+	},
 	user: { get: {
 		method: "GET",
 		path: "/user"
@@ -729,12 +781,35 @@ async function getServer(options, ctx) {
 	return { data: unwrapDocument(await request(ROUTES.servers.get, ctx, { server_id: options.server_id }, { schema: jsonApiDocumentSchema(ServerAttributesSchema) })) };
 }
 //#endregion
+//#region src/utils/list-all-pages.ts
+/**
+* GET every page of a cursor-paginated list route and return all its resources.
+* Follows `meta.next_cursor` until the API returns no cursor.
+*/
+async function listAllPages(route, ctx, params, attributes, query = {}) {
+	const schema = jsonApiListDocumentSchema(attributes);
+	const items = [];
+	let cursor;
+	do {
+		const response = await request(route, ctx, params, {
+			schema,
+			query: cursor ? {
+				...query,
+				"page[cursor]": cursor
+			} : query
+		});
+		items.push(...unwrapListDocument(response));
+		cursor = response.meta.next_cursor;
+	} while (cursor);
+	return items;
+}
+//#endregion
 //#region src/executors/servers/list.ts
 /**
-* List all servers.
+* List all servers, from every page.
 */
 async function listServers(_options, ctx) {
-	return { data: unwrapListDocument(await request(ROUTES.servers.list, ctx, {}, { schema: jsonApiListDocumentSchema(ServerAttributesSchema) })) };
+	return { data: await listAllPages(ROUTES.servers.list, ctx, {}, ServerAttributesSchema) };
 }
 //#endregion
 //#region src/executors/servers/reboot.ts
@@ -1187,6 +1262,17 @@ async function getDaemon(options, ctx) {
 	}, { schema: jsonApiDocumentSchema(BackgroundProcessAttributesSchema) })) };
 }
 //#endregion
+//#region src/executors/daemons/get-log.ts
+/**
+* Get the log output for a daemon (background process).
+*/
+async function getDaemonLog(options, ctx) {
+	return { data: unwrapDocument(await request(ROUTES.daemons.log, ctx, {
+		server_id: options.server_id,
+		id: options.id
+	}, { schema: jsonApiDocumentSchema(BackgroundProcessLogAttributesSchema) })).content };
+}
+//#endregion
 //#region src/executors/daemons/list.ts
 /**
 * List daemons on a server.
@@ -1298,10 +1384,10 @@ async function getSshKey(options, ctx) {
 //#endregion
 //#region src/executors/ssh-keys/list.ts
 /**
-* List SSH keys on a server.
+* List SSH keys on a server, from every page. Filter by server user with `user`.
 */
 async function listSshKeys(options, ctx) {
-	return { data: unwrapListDocument(await request(ROUTES.sshKeys.list, ctx, { server_id: options.server_id }, { schema: jsonApiListDocumentSchema(SshKeyAttributesSchema) })) };
+	return { data: await listAllPages(ROUTES.sshKeys.list, ctx, { server_id: options.server_id }, SshKeyAttributesSchema, options.user ? { "filter[user]": options.user } : {}) };
 }
 //#endregion
 //#region src/executors/security-rules/create.ts
@@ -1768,6 +1854,246 @@ async function listScheduledJobs(options, ctx) {
 	return { data: unwrapListDocument(await request(route, ctx, params, { schema: jsonApiListDocumentSchema(ScheduledJobAttributesSchema) })) };
 }
 //#endregion
+//#region src/executors/services/list.ts
+/**
+* List services on a server with a derived availability flag.
+*
+* The v2 API has no GET endpoint for services, so availability is inferred from
+* the server object attributes. This `available` flag is a documented heuristic:
+*
+* - nginx      → always available
+* - php        → available when `php_version` is set (detail = php_version)
+* - mysql      → available when `database_type` starts with "mysql"/"mariadb"
+* - postgres   → available when `database_type` starts with "postgres"
+* - redis      → available when `redis_status` is non-null
+* - supervisor → always available
+*/
+async function listServices(options, ctx) {
+	const { data: server } = await getServer({ server_id: options.server_id }, ctx);
+	const databaseType = server.database_type ?? "";
+	const isMysql = databaseType.startsWith("mysql") || databaseType.startsWith("mariadb");
+	const isPostgres = databaseType.startsWith("postgres");
+	return { data: [
+		{
+			service: "nginx",
+			available: true,
+			detail: null
+		},
+		{
+			service: "php",
+			available: server.php_version !== null,
+			detail: server.php_version
+		},
+		{
+			service: "mysql",
+			available: isMysql,
+			detail: isMysql ? server.database_type : null
+		},
+		{
+			service: "postgres",
+			available: isPostgres,
+			detail: isPostgres ? server.database_type : null
+		},
+		{
+			service: "redis",
+			available: server.redis_status !== null,
+			detail: server.redis_status
+		},
+		{
+			service: "supervisor",
+			available: true,
+			detail: null
+		}
+	] };
+}
+//#endregion
+//#region src/executors/services/types.ts
+/**
+* Option and result types for service executors.
+*/
+/**
+* The six restartable services exposed by the Forge v2 API.
+*
+* There is no GET endpoint for services — availability is inferred from the
+* server object (see `listServices`).
+*/
+var RESTARTABLE_SERVICES = [
+	"nginx",
+	"php",
+	"mysql",
+	"postgres",
+	"redis",
+	"supervisor"
+];
+//#endregion
+//#region src/executors/services/restart.ts
+/**
+* Restart a service on a server.
+*
+* Maps the user verb "restart" to the API action "reboot". The v2 API restarts
+* a service via POST /servers/{server}/services/{service}/actions with body
+* `{ action: "reboot" }`. The php service additionally requires a `version`.
+*/
+async function restartService(options, ctx) {
+	if (!RESTARTABLE_SERVICES.includes(options.service)) throw new Error(`Invalid service "${options.service}". Valid services: ${RESTARTABLE_SERVICES.join(", ")}.`);
+	if (options.service === "php" && !options.version) throw new Error("The \"php\" service requires a version (e.g. \"php83\") to restart.");
+	await request(ROUTES.services.action, ctx, {
+		server_id: options.server_id,
+		service: options.service
+	}, { body: {
+		action: "reboot",
+		...options.version ? { version: options.version } : {}
+	} });
+	return { data: void 0 };
+}
+//#endregion
+//#region src/executors/php/types.ts
+/**
+* Option types for PHP executors.
+*/
+/**
+* The PHP configuration files that Forge can read and write.
+*/
+var PHP_CONFIG_TYPES = [
+	"cli",
+	"fpm",
+	"pool"
+];
+//#endregion
+//#region src/executors/php/versions.ts
+/**
+* List the PHP versions installed on a server.
+*/
+async function listPhpVersions(options, ctx) {
+	return { data: unwrapListDocument(await request(ROUTES.php.listVersions, ctx, { server_id: options.server_id }, { schema: jsonApiListDocumentSchema(PhpVersionAttributesSchema) })) };
+}
+/**
+* Resolve a PHP version to its ID on a server.
+*
+* A numeric value is an ID and is returned as is, without an API call.
+* Any other value is matched against the installed versions: "8.3",
+* "php8.3" (binary name) and "php83" all match version 8.3.
+*/
+async function resolvePhpVersionId(server_id, version, ctx) {
+	if (/^\d+$/.test(version)) return version;
+	const { data: versions } = await listPhpVersions({ server_id }, ctx);
+	const wanted = version.trim().toLowerCase();
+	const match = versions.find((item) => [
+		item.version,
+		item.binary_name,
+		`php${item.version}`,
+		`php${item.version.replace(".", "")}`
+	].map((name) => name.toLowerCase()).includes(wanted));
+	if (!match) {
+		const installed = versions.map((item) => item.version).join(", ") || "none";
+		throw new Error(`PHP version "${version}" is not installed on server ${server_id}. Installed: ${installed}.`);
+	}
+	return String(match.id);
+}
+/**
+* Get one installed PHP version.
+*/
+async function getPhpVersion(options, ctx) {
+	const version_id = await resolvePhpVersionId(options.server_id, options.version, ctx);
+	return { data: unwrapDocument(await request(ROUTES.php.getVersion, ctx, {
+		server_id: options.server_id,
+		version_id
+	}, { schema: jsonApiDocumentSchema(PhpVersionAttributesSchema) })) };
+}
+//#endregion
+//#region src/executors/php/config.ts
+/**
+* Throw when the configuration type is not one of cli, fpm or pool,
+* or when a user is given for a type other than pool.
+*/
+function assertConfigTarget(type, user) {
+	if (!PHP_CONFIG_TYPES.includes(type)) throw new Error(`Invalid PHP config type "${type}". Valid types: ${PHP_CONFIG_TYPES.join(", ")}.`);
+	if (user && type !== "pool") throw new Error(`The user option applies to the pool config only, not "${type}".`);
+}
+/**
+* Get a PHP configuration file (cli, fpm or pool) for an installed version.
+*/
+async function getPhpConfig(options, ctx) {
+	assertConfigTarget(options.type, options.user);
+	const version_id = await resolvePhpVersionId(options.server_id, options.version, ctx);
+	return { data: unwrapDocument(await request(ROUTES.php.getConfig, ctx, {
+		server_id: options.server_id,
+		version_id,
+		type: options.type
+	}, {
+		schema: jsonApiDocumentSchema(PhpConfigAttributesSchema),
+		...options.user ? { query: { user: options.user } } : {}
+	})).configuration };
+}
+/**
+* Replace a PHP configuration file (cli, fpm or pool) for an installed version.
+*/
+async function updatePhpConfig(options, ctx) {
+	assertConfigTarget(options.type, options.user);
+	const version_id = await resolvePhpVersionId(options.server_id, options.version, ctx);
+	await request(ROUTES.php.updateConfig, ctx, {
+		server_id: options.server_id,
+		version_id,
+		type: options.type
+	}, { body: {
+		config: options.content,
+		...options.user ? { user: options.user } : {}
+	} });
+	return { data: void 0 };
+}
+//#endregion
+//#region src/executors/php/limits.ts
+/**
+* Get the PHP max upload size of a server, in megabytes.
+*/
+async function getPhpMaxUploadSize(options, ctx) {
+	const response = await request(ROUTES.php.getMaxUploadSize, ctx, { server_id: options.server_id }, { schema: jsonApiDocumentSchema(PhpMaxUploadSizeAttributesSchema) });
+	return { data: String(unwrapDocument(response).max_upload_size) };
+}
+/**
+* Set the PHP max upload size of a server, in megabytes.
+*/
+async function updatePhpMaxUploadSize(options, ctx) {
+	await request(ROUTES.php.updateMaxUploadSize, ctx, { server_id: options.server_id }, { body: { max_upload_size: options.size } });
+	return { data: void 0 };
+}
+/**
+* Get the PHP max execution time of a server, in seconds.
+*/
+async function getPhpMaxExecutionTime(options, ctx) {
+	const response = await request(ROUTES.php.getMaxExecutionTime, ctx, { server_id: options.server_id }, { schema: jsonApiDocumentSchema(PhpMaxExecutionTimeAttributesSchema) });
+	return { data: String(unwrapDocument(response).max_execution_time) };
+}
+/**
+* Set the PHP max execution time of a server, in seconds.
+*/
+async function updatePhpMaxExecutionTime(options, ctx) {
+	await request(ROUTES.php.updateMaxExecutionTime, ctx, { server_id: options.server_id }, { body: { max_execution_time: options.seconds } });
+	return { data: void 0 };
+}
+//#endregion
+//#region src/executors/php/opcache.ts
+/**
+* Get whether PHP OPcache is enabled on a server.
+*/
+async function getPhpOpcache(options, ctx) {
+	return { data: unwrapDocument(await request(ROUTES.php.getOpcache, ctx, { server_id: options.server_id }, { schema: jsonApiDocumentSchema(PhpOpcacheAttributesSchema) })).opcache_enabled };
+}
+/**
+* Enable PHP OPcache on a server.
+*/
+async function enablePhpOpcache(options, ctx) {
+	await request(ROUTES.php.enableOpcache, ctx, { server_id: options.server_id });
+	return { data: void 0 };
+}
+/**
+* Disable PHP OPcache on a server.
+*/
+async function disablePhpOpcache(options, ctx) {
+	await request(ROUTES.php.disableOpcache, ctx, { server_id: options.server_id });
+	return { data: void 0 };
+}
+//#endregion
 //#region src/executors/user/get.ts
 /**
 * Get the currently authenticated user.
@@ -1776,6 +2102,6 @@ async function getUser(_options, ctx) {
 	return { data: unwrapDocument(await request(ROUTES.user.get, ctx, {}, { schema: jsonApiDocumentSchema(UserAttributesSchema) })) };
 }
 //#endregion
-export { ACTIONS, RESOURCES, activateCertificate, createAuditLogger, createBackupConfig, createCertificate, createCommand, createDaemon, createDatabase, createDatabaseUser, createFirewallRule, createMonitor, createNginxTemplate, createRecipe, createRedirectRule, createScheduledJob, createSecurityRule, createServer, createSite, createSshKey, createTestExecutorContext, deleteBackupConfig, deleteCertificate, deleteDaemon, deleteDatabase, deleteDatabaseUser, deleteFirewallRule, deleteMonitor, deleteNginxTemplate, deleteRecipe, deleteRedirectRule, deleteScheduledJob, deleteSecurityRule, deleteServer, deleteSite, deleteSshKey, deploySite, deploySiteAndWait, getAuditLogPath, getBackupConfig, getCertificate, getCommand, getDaemon, getDatabase, getDatabaseUser, getDeploymentLog, getDeploymentScript, getEnv, getFirewallRule, getMonitor, getNginxConfig, getNginxTemplate, getRecipe, getRedirectRule, getScheduledJob, getSecurityRule, getServer, getSite, getSshKey, getUser, listBackupConfigs, listCommands, listDaemons, listDatabaseUsers, listDatabases, listDeployments, listFirewallRules, listMonitors, listNginxTemplates, listRecipes, listRedirectRules, listScheduledJobs, listSecurityRules, listServers, listSites, listSshKeys, matchByName, mockDocument, mockListDocument, mockResource, rebootServer, resolveServers, resolveSites, restartDaemon, runRecipe, sanitizeArgs, updateBackupConfig, updateDaemon, updateDatabaseUser, updateDeploymentScript, updateEnv, updateNginxConfig, updateNginxTemplate, updateRecipe, updateSecurityRule, updateSite };
+export { ACTIONS, PHP_CONFIG_TYPES, RESOURCES, RESTARTABLE_SERVICES, activateCertificate, createAuditLogger, createBackupConfig, createCertificate, createCommand, createDaemon, createDatabase, createDatabaseUser, createFirewallRule, createMonitor, createNginxTemplate, createRecipe, createRedirectRule, createScheduledJob, createSecurityRule, createServer, createSite, createSshKey, createTestExecutorContext, deleteBackupConfig, deleteCertificate, deleteDaemon, deleteDatabase, deleteDatabaseUser, deleteFirewallRule, deleteMonitor, deleteNginxTemplate, deleteRecipe, deleteRedirectRule, deleteScheduledJob, deleteSecurityRule, deleteServer, deleteSite, deleteSshKey, deploySite, deploySiteAndWait, disablePhpOpcache, enablePhpOpcache, getAuditLogPath, getBackupConfig, getCertificate, getCommand, getDaemon, getDaemonLog, getDatabase, getDatabaseUser, getDeploymentLog, getDeploymentScript, getEnv, getFirewallRule, getMonitor, getNginxConfig, getNginxTemplate, getPhpConfig, getPhpMaxExecutionTime, getPhpMaxUploadSize, getPhpOpcache, getPhpVersion, getRecipe, getRedirectRule, getScheduledJob, getSecurityRule, getServer, getSite, getSshKey, getUser, listBackupConfigs, listCommands, listDaemons, listDatabaseUsers, listDatabases, listDeployments, listFirewallRules, listMonitors, listNginxTemplates, listPhpVersions, listRecipes, listRedirectRules, listScheduledJobs, listSecurityRules, listServers, listServices, listSites, listSshKeys, matchByName, mockDocument, mockListDocument, mockResource, rebootServer, resolvePhpVersionId, resolveServers, resolveSites, restartDaemon, restartService, runRecipe, sanitizeArgs, updateBackupConfig, updateDaemon, updateDatabaseUser, updateDeploymentScript, updateEnv, updateNginxConfig, updateNginxTemplate, updatePhpConfig, updatePhpMaxExecutionTime, updatePhpMaxUploadSize, updateRecipe, updateSecurityRule, updateSite };
 
 //# sourceMappingURL=index.js.map