@platformatic/runtime 3.4.1 → 3.5.0

package/README.md

@@ -1,6 +1,6 @@
 # @platformatic/runtime
 
-Check out the full documentation for Platformatic Runtime on [our website](https://docs.platformatic.dev/docs/runtime/overview).
+Check out the full documentation for Platformatic Runtime on [our website](https://docs.platformatic.dev/docs/reference/runtime/overview).
 
 ## Install
 

package/config.d.ts

@@ -5,12 +5,13 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime341Json = {
+export type PlatformaticRuntimeConfig = {
   [k: string]: unknown;
 } & {
   $schema?: string;
-  preload?: string;
+  preload?: string | string[];
   entrypoint?: string;
+  basePath?: string;
   autoload?: {
     path: string;
     exclude?: string[];
@@ -19,15 +20,34 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime341Json = {
         id: string;
         config?: string;
         useHttp?: boolean;
+        workers?: number | string;
+        health?: {
+          enabled?: boolean | string;
+          interval?: number | string;
+          gracePeriod?: number | string;
+          maxUnhealthyChecks?: number | string;
+          maxELU?: number | string;
+          maxHeapUsed?: number | string;
+          maxHeapTotal?: number | string;
+          maxYoungGeneration?: number | string;
+        };
+        preload?: string | string[];
+        dependencies?: string[];
+        arguments?: string[];
+        nodeOptions?: string;
       };
     };
   };
+  applications?: {
+    [k: string]: unknown;
+  }[];
   services?: {
     [k: string]: unknown;
   }[];
   web?: {
     [k: string]: unknown;
   }[];
+  workers?: number | string;
   logger?: {
     level: (
       | ("fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent")
@@ -50,8 +70,6 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime341Json = {
               [k: string]: unknown;
             };
             level?: string;
-            additionalProperties?: never;
-            [k: string]: unknown;
           }[];
           options?: {
             [k: string]: unknown;
@@ -63,6 +81,22 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime341Json = {
         [k: string]: unknown;
       };
     };
+    formatters?: {
+      path: string;
+    };
+    timestamp?: "epochTime" | "unixTime" | "nullTime" | "isoTime";
+    redact?: {
+      paths: string[];
+      censor?: string;
+    };
+    base?: {
+      [k: string]: unknown;
+    } | null;
+    messageKey?: string;
+    customLevels?: {
+      [k: string]: unknown;
+    };
+    captureStdio?: boolean;
     [k: string]: unknown;
   };
   server?: {
@@ -70,6 +104,7 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime341Json = {
     port?: number | string;
     http2?: boolean;
     https?: {
+      allowHTTP1?: boolean;
       key:
         | string
         | {
@@ -92,23 +127,79 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime341Json = {
                 path?: string;
               }
           )[];
+      requestCert?: boolean;
+      rejectUnauthorized?: boolean;
     };
   };
+  startTimeout?: number;
   restartOnError?: boolean | number;
+  exitOnUnhandledErrors?: boolean;
+  gracefulShutdown?: {
+    runtime: number | string;
+    application: number | string;
+  };
+  health?: {
+    enabled?: boolean | string;
+    interval?: number | string;
+    gracePeriod?: number | string;
+    maxUnhealthyChecks?: number | string;
+    maxELU?: number | string;
+    maxHeapUsed?: number | string;
+    maxHeapTotal?: number | string;
+    maxYoungGeneration?: number | string;
+  };
   undici?: {
     agentOptions?: {
       [k: string]: unknown;
     };
     interceptors?:
-      | UndiciInterceptor[]
       | {
-          Client?: UndiciInterceptor[];
-          Pool?: UndiciInterceptor[];
-          Agent?: UndiciInterceptor[];
+          module: string;
+          options: {
+            [k: string]: unknown;
+          };
+          [k: string]: unknown;
+        }[]
+      | {
+          Client?: {
+            module: string;
+            options: {
+              [k: string]: unknown;
+            };
+            [k: string]: unknown;
+          }[];
+          Pool?: {
+            module: string;
+            options: {
+              [k: string]: unknown;
+            };
+            [k: string]: unknown;
+          }[];
+          Agent?: {
+            module: string;
+            options: {
+              [k: string]: unknown;
+            };
+            [k: string]: unknown;
+          }[];
           [k: string]: unknown;
         };
     [k: string]: unknown;
   };
+  httpCache?:
+    | boolean
+    | {
+        store?: string;
+        /**
+         * @minItems 1
+         */
+        methods?: [string, ...string[]];
+        cacheTagsHeader?: string;
+        maxSize?: number;
+        maxEntrySize?: number;
+        maxCount?: number;
+        [k: string]: unknown;
+      };
   watch?: boolean | string;
   managementApi?:
     | boolean
@@ -122,6 +213,7 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime341Json = {
     | boolean
     | {
         port?: number | string;
+        enabled?: boolean | string;
         hostname?: string;
         endpoint?: string;
         auth?: {
@@ -131,88 +223,143 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime341Json = {
         labels?: {
           [k: string]: string;
         };
+        /**
+         * The label name to use for the application identifier in metrics (e.g., applicationId, serviceId)
+         */
+        applicationLabel?: string;
+        readiness?:
+          | boolean
+          | {
+              endpoint?: string;
+              success?: {
+                statusCode?: number;
+                body?: string;
+              };
+              fail?: {
+                statusCode?: number;
+                body?: string;
+              };
+            };
+        liveness?:
+          | boolean
+          | {
+              endpoint?: string;
+              success?: {
+                statusCode?: number;
+                body?: string;
+              };
+              fail?: {
+                statusCode?: number;
+                body?: string;
+              };
+            };
+        plugins?: string[];
       };
-  telemetry?: OpenTelemetry;
-  inspectorOptions?: {
-    host?: string;
-    port?: number;
-    breakFirstLine?: boolean;
-    watchDisabled?: boolean;
-    [k: string]: unknown;
-  };
-};
-
-export interface UndiciInterceptor {
-  module: string;
-  options: {
-    [k: string]: unknown;
-  };
-  [k: string]: unknown;
-}
-export interface OpenTelemetry {
-  /**
-   * The name of the service. Defaults to the folder name if not specified.
-   */
-  serviceName: string;
-  /**
-   * The version of the service (optional)
-   */
-  version?: string;
-  /**
-   * An array of paths to skip when creating spans. Useful for health checks and other endpoints that do not need to be traced.
-   */
-  skip?: {
+  telemetry?: {
+    enabled?: boolean | string;
     /**
-     * The path to skip. Can be a string or a regex.
+     * The name of the application. Defaults to the folder name if not specified.
      */
-    path?: string;
+    applicationName: string;
     /**
-     * HTTP method to skip
+     * The version of the application (optional)
      */
-    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
-    [k: string]: unknown;
-  }[];
-  exporter?:
-    | {
-        type?: "console" | "otlp" | "zipkin" | "memory";
-        /**
-         * Options for the exporter. These are passed directly to the exporter.
-         */
-        options?: {
-          /**
-           * The URL to send the traces to. Not used for console or memory exporters.
-           */
-          url?: string;
+    version?: string;
+    /**
+     * An array of paths to skip when creating spans. Useful for health checks and other endpoints that do not need to be traced.
+     */
+    skip?: {
+      /**
+       * The path to skip. Can be a string or a regex.
+       */
+      path?: string;
+      /**
+       * HTTP method to skip
+       */
+      method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
+      [k: string]: unknown;
+    }[];
+    exporter?:
+      | {
+          type?: "console" | "otlp" | "zipkin" | "memory" | "file";
           /**
-           * Headers to send to the exporter. Not used for console or memory exporters.
+           * Options for the exporter. These are passed directly to the exporter.
            */
-          headers?: {
+          options?: {
+            /**
+             * The URL to send the traces to. Not used for console or memory exporters.
+             */
+            url?: string;
+            /**
+             * Headers to send to the exporter. Not used for console or memory exporters.
+             */
+            headers?: {
+              [k: string]: unknown;
+            };
+            /**
+             * The path to write the traces to. Only for file exporter.
+             */
+            path?: string;
             [k: string]: unknown;
           };
+          additionalProperties?: never;
           [k: string]: unknown;
-        };
-        additionalProperties?: never;
-        [k: string]: unknown;
-      }[]
-    | {
-        type?: "console" | "otlp" | "zipkin" | "memory";
-        /**
-         * Options for the exporter. These are passed directly to the exporter.
-         */
-        options?: {
-          /**
-           * The URL to send the traces to. Not used for console or memory exporters.
-           */
-          url?: string;
+        }[]
+      | {
+          type?: "console" | "otlp" | "zipkin" | "memory" | "file";
           /**
-           * Headers to send to the exporter. Not used for console or memory exporters.
+           * Options for the exporter. These are passed directly to the exporter.
            */
-          headers?: {
+          options?: {
+            /**
+             * The URL to send the traces to. Not used for console or memory exporters.
+             */
+            url?: string;
+            /**
+             * Headers to send to the exporter. Not used for console or memory exporters.
+             */
+            headers?: {
+              [k: string]: unknown;
+            };
+            /**
+             * The path to write the traces to. Only for file exporter.
+             */
+            path?: string;
             [k: string]: unknown;
           };
+          additionalProperties?: never;
           [k: string]: unknown;
         };
-        additionalProperties?: never;
-        [k: string]: unknown;
-      };
-}
+  };
+  inspectorOptions?: {
+    host?: string;
+    port?: number;
+    breakFirstLine?: boolean;
+    watchDisabled?: boolean;
+    [k: string]: unknown;
+  };
+  applicationTimeout?: number | string;
+  messagingTimeout?: number | string;
+  resolvedApplicationsBasePath?: string;
+  env?: {
+    [k: string]: string;
+  };
+  sourceMaps?: boolean;
+  scheduler?: {
+    enabled?: boolean | string;
+    name: string;
+    cron: string;
+    callbackUrl: string;
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    headers?: {
+      [k: string]: string;
+    };
+    body?:
+      | string
+      | {
+          [k: string]: unknown;
+        };
+    maxRetries?: number;
+    [k: string]: unknown;
+  }[];
+};

package/eslint.config.js

@@ -1,8 +1,6 @@
-'use strict'
+import neostandard from 'neostandard'
 
-const neostandard = require('neostandard')
-
-module.exports = neostandard({
+export default neostandard({
   ts: true,
-  ignores: [...neostandard.resolveIgnoresFromGitignore(), 'test/tmp/**/*', 'dist/**/*'],
+  ignores: [...neostandard.resolveIgnoresFromGitignore(), 'test/tmp/**/*', 'dist/**/*']
 })

package/index.d.ts

@@ -1,37 +1,40 @@
-import { InjectOptions, LightMyRequestResponse } from 'fastify'
 import { FastifyError } from '@fastify/error'
-import { BaseLogger } from 'pino'
-import { RuntimeGenerator } from './lib/generator/runtime-generator'
-export type pltRuntimeBuildServer = {
-  address: string
-  port: number
-  restart: () => Promise<void>
-  stop: () => Promise<void>
-  inject: (opts: InjectOptions | string) => Promise<LightMyRequestResponse>
+import { Configuration, ConfigurationOptions, logFatalError, parseArgs } from '@platformatic/foundation'
+import { BaseGenerator } from '@platformatic/generators'
+import { JSONSchemaType } from 'ajv'
+import * as colorette from 'colorette'
+import { Logger } from 'pino'
+import { PlatformaticRuntimeConfig } from './config'
+
+export type RuntimeConfiguration = Promise<Configuration<PlatformaticRuntimeConfig>>
+
+export type ApplicationCommandContext = {
+  colorette: typeof colorette
+  parseArgs: typeof parseArgs
+  logFatalError: typeof logFatalError
 }
 
-declare module '@platformatic/runtime' {
-  export function buildServer (opts: object): Promise<pltRuntimeBuildServer>
-  export function start (args: object): Promise<object>
-  export function startCommand (args: object): Promise<void>
-  export function loadConfig (minimistConfig: object, args: object, store: object, overrides: object, replaceEnv: boolean): void
-  export function compile (argv: string[], logger: BaseLogger): void
-  export function platformaticRuntime (): Promise<void>
-  export function wrapConfigInRuntimeConfig (args: object): object
-  export const Generator: RuntimeGenerator.RuntimeGenerator
+export type ApplicationCommand = (
+  logger: Logger,
+  configuration: Configuration<unknown>,
+  args: string[],
+  context: ApplicationCommandContext
+) => Promise<void>
+
+export interface ApplicationsCommands {
+  applications: Record<string, Configuration<unknown>>
+  commands: Record<string, ApplicationCommand>
+  help: Record<string, string | (() => string)>
 }
 
-/**
- * All the errors thrown by the plugin.
- */
 export module errors {
   export const RuntimeExitedError: () => FastifyError
   export const UnknownRuntimeAPICommandError: (command: string) => FastifyError
-  export const ServiceNotFoundError: (id: string) => FastifyError
-  export const ServiceNotStartedError: (id: string) => FastifyError
+  export const ApplicationNotFoundError: (id: string) => FastifyError
+  export const ApplicationNotStartedError: (id: string) => FastifyError
   export const FailedToRetrieveOpenAPISchemaError: (id: string, error: string) => FastifyError
   export const ApplicationAlreadyStartedError: () => FastifyError
-  export const ApplicationNotStartedError: () => FastifyError
+  export const RuntimeNotStartedError: () => FastifyError
   export const ConfigPathMustBeStringError: () => FastifyError
   export const NoConfigFileFoundError: (id: string) => FastifyError
   export const InvalidEntrypointError: (entrypoint: string) => FastifyError
@@ -43,3 +46,49 @@ export module errors {
   export const CannotMapSpecifierToAbsolutePathError: (specifier: string) => FastifyError
   export const NodeInspectorFlagsNotSupportedError: () => FastifyError
 }
+
+export module symbols {
+  export declare const kConfig: unique symbol
+  export declare const kId: unique symbol
+  export declare const kFullId: unique symbol
+  export declare const kApplicationId: unique symbol
+  export declare const kWorkerId: unique symbol
+  export declare const kITC: unique symbol
+  export declare const kHealthCheckTimer: unique symbol
+  export declare const kLastELU: unique symbol
+  export declare const kWorkerStatus: unique symbol
+  export declare const kStderrMarker: string
+  export declare const kInterceptors: unique symbol
+  export declare const kWorkersBroadcast: unique symbol
+}
+
+export class Generator extends BaseGenerator {}
+
+export class WrappedGenerator extends BaseGenerator {}
+
+export declare const schema: JSONSchemaType<PlatformaticRuntimeConfig>
+
+export declare class Runtime {}
+
+export function wrapInRuntimeConfig (
+  config: Configuration<unknown>,
+  context?: ConfigurationOptions
+): Promise<RuntimeConfiguration>
+
+export declare const version: string
+
+export declare function loadConfiguration (
+  root: string | PlatformaticRuntimeConfig,
+  source?: string | PlatformaticRuntimeConfig,
+  context?: ConfigurationOptions
+): Promise<RuntimeConfiguration>
+
+export function create (
+  root: string,
+  source?: string | PlatformaticRuntimeConfig,
+  context?: ConfigurationOptions
+): Promise<Runtime>
+
+export declare function transform (config: RuntimeConfiguration): Promise<RuntimeConfiguration>
+
+export declare function loadApplicationsCommands (): Promise<ApplicationsCommands>