@platformatic/control 2.28.1-alpha.1 → 2.30.0

package/index.d.ts

@@ -0,0 +1,80 @@
+import { ChildProcess } from "node:child_process";
+import BodyReadable from "undici/types/readable";
+import { FastifyError } from "@fastify/error";
+import { Readable } from "node:stream";
+import WebSocket from "ws";
+
+declare namespace control {
+  class WebSocketStream extends Readable {
+    constructor(url: string);
+    ws: WebSocket;
+  }
+
+  export class RuntimeApiClient {
+    getMatchingRuntime(opts: { pid?: string; name?: string }): Promise<unknown>;
+    getRuntimes(): Promise<unknown[]>;
+    getRuntimeMetadata(pid: number): Promise<unknown>;
+    getRuntimeServices(pid: number): Promise<unknown>;
+    getRuntimeConfig(pid: number): Promise<void>;
+    getRuntimeServiceConfig(pid: number, serviceId?: string): Promise<void>;
+    getRuntimeEnv(pid: number): Promise<void>;
+    getRuntimeServiceEnv(pid: number, serviceId: string): Promise<unknown>;
+    reloadRuntime(pid: number, options?: object): Promise<ChildProcess>;
+    restartRuntime(pid: number): Promise<void>;
+    stopRuntime(pid: number): Promise<void>;
+    getRuntimeMetrics(
+      pid: number,
+      options?: { format?: "text" | "json" }
+    ): Promise<unknown>;
+    getRuntimeLiveMetricsStream(pid: number): WebSocketStream;
+    getRuntimeLiveLogsStream(
+      pid: number,
+      startLogIndex?: number
+    ): WebSocketStream;
+    getRuntimeLogsStream(
+      pid: number,
+      logsId: string,
+      options?: { runtimePID?: number }
+    ): Promise<BodyReadable>;
+    getRuntimeAllLogsStream(
+      pid: number,
+      options?: { runtimePID?: number }
+    ): Promise<BodyReadable>;
+    getRuntimeLogIndexes(
+      pid: number,
+      options?: { all?: boolean }
+    ): Promise<unknown>;
+    injectRuntime(
+      pid: number,
+      serviceId: string,
+      options: {
+        url: string;
+        method: string;
+        headers: object;
+        body: unknown;
+      }
+    ): Promise<unknown>;
+    close(): Promise<void>;
+  }
+
+  export module errors {
+    export const RuntimeNotFound: FastifyError;
+    export const ServiceNotFound: FastifyError;
+    export const MissingRequestURL: FastifyError;
+    export const FailedToGetRuntimeMetadata: FastifyError;
+    export const FailedToGetRuntimeServices: FastifyError;
+    export const FailedToGetRuntimeEnv: FastifyError;
+    export const FailedToStreamRuntimeLogs: FastifyError;
+    export const FailedToStopRuntime: FastifyError;
+    export const FailedToReloadRuntime: FastifyError;
+    export const FailedToGetRuntimeConfig: FastifyError;
+    export const FailedToGetRuntimeServiceEnv: FastifyError;
+    export const FailedToGetRuntimeServiceConfig: FastifyError;
+    export const FailedToGetRuntimeHistoryLogs: FastifyError;
+    export const FailedToGetRuntimeAllLogs: FastifyError;
+    export const FailedToGetRuntimeLogIndexes: FastifyError;
+    export const FailedToGetRuntimeMetrics: FastifyError;
+  }
+}
+
+export = control;

package/index.test-d.ts

@@ -0,0 +1,16 @@
+import { expectError, expectType } from 'tsd'
+import { errors, RuntimeApiClient } from '.'
+import { FastifyError } from '@fastify/error'
+
+// RuntimeApiClient
+const api = new RuntimeApiClient()
+expectType<Promise<unknown[]>>(api.getRuntimes())
+expectType<Promise<void>>(api.close())
+
+// errors
+expectType<FastifyError>(errors.FailedToGetRuntimeAllLogs)
+expectType<FastifyError>(errors.FailedToGetRuntimeConfig)
+expectType<FastifyError>(errors.FailedToGetRuntimeEnv)
+expectType<FastifyError>(errors.FailedToGetRuntimeHistoryLogs)
+expectError<string>(errors.FailedToGetRuntimeHistoryLogs)
+expectError<number>(errors.FailedToGetRuntimeHistoryLogs)

package/lib/errors.js

@@ -7,14 +7,11 @@ const ERROR_PREFIX = 'PLT_CTR'
 module.exports = {
   RuntimeNotFound: createError(`${ERROR_PREFIX}_RUNTIME_NOT_FOUND`, 'Runtime not found.'),
   ServiceNotFound: createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, 'Service not found.'),
-  MissingRuntimeIdentifier: createError(`${ERROR_PREFIX}_MISSING_RUNTIME_IDENTIFIER`, 'Runtime name or PID is required.'),
   MissingRequestURL: createError(`${ERROR_PREFIX}_MISSING_REQUEST_URL`, 'Request URL is required.'),
   FailedToGetRuntimeMetadata: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_METADATA`, 'Failed to get runtime metadata %s.'),
   FailedToGetRuntimeServices: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_SERVICES`, 'Failed to get runtime services %s.'),
   FailedToGetRuntimeEnv: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_ENV`, 'Failed to get runtime environment variables %s.'),
-  FailedToInjectRuntime: createError(`${ERROR_PREFIX}_FAILED_TO_INJECT_RUNTIME`, 'Failed to inject runtime %s.'),
   FailedToStreamRuntimeLogs: createError(`${ERROR_PREFIX}_FAILED_TO_STREAM_RUNTIME_LOGS`, 'Failed to stream runtime logs %s.'),
-  FailedToRestartRuntime: createError(`${ERROR_PREFIX}_FAILED_TO_RESTART_RUNTIME`, 'Failed to restart runtime %s.'),
   FailedToStopRuntime: createError(`${ERROR_PREFIX}_FAILED_TO_STOP_RUNTIME`, 'Failed to stop the runtime %s.'),
   FailedToReloadRuntime: createError(`${ERROR_PREFIX}_FAILED_TO_RELOAD_RUNTIME`, 'Failed to reload the runtime %s.'),
   FailedToGetRuntimeConfig: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_CONFIG`, 'Failed to get runtime config %s.'),

package/lib/metrics.js

@@ -16,7 +16,7 @@ async function runtimeMetricsCommand (argv) {
 
   const client = new RuntimeApiClient()
   const runtimePid = args.pid || (await client.getMatchingRuntime([])).pid
-  const metrics = await client.getRuntimeMetrics(runtimePid, { format: args.format })
+  const metrics = await client.getRuntimeMetrics(parseInt(runtimePid), { format: args.format })
   const result = args.format === 'text' ? metrics : JSON.stringify(metrics, null, 2)
   console.log(result)
   await client.close()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/control",
-  "version": "2.28.1-alpha.1",
+  "version": "2.30.0",
   "description": "Platformatic Control",
   "main": "index.js",
   "bin": {
@@ -25,8 +25,8 @@
     "split2": "^4.2.0",
     "tsd": "^0.31.0",
     "typescript": "^5.5.4",
-    "@platformatic/service": "2.28.1-alpha.1",
-    "@platformatic/runtime": "2.28.1-alpha.1"
+    "@platformatic/runtime": "2.30.0",
+    "@platformatic/service": "2.30.0"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
@@ -37,10 +37,10 @@
     "table": "^6.8.1",
     "undici": "^7.0.0",
     "ws": "^8.16.0",
-    "@platformatic/utils": "2.28.1-alpha.1"
+    "@platformatic/utils": "2.30.0"
   },
   "scripts": {
-    "test": "pnpm run lint && pnpm run unit",
+    "test": "pnpm run lint && pnpm run unit && tsd",
     "unit": "borp --concurrency=1 --timeout=300000",
     "lint": "eslint"
   }