@platformatic/runtime 2.0.0-alpha.2 → 2.0.0-alpha.21

package/config.d.ts

@@ -0,0 +1,218 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha21Json = {
+  [k: string]: unknown;
+} & {
+  $schema?: string;
+  preload?: string;
+  entrypoint?: string;
+  autoload?: {
+    path: string;
+    exclude?: string[];
+    mappings?: {
+      [k: string]: {
+        id: string;
+        config?: string;
+        useHttp?: boolean;
+      };
+    };
+  };
+  services?: {
+    [k: string]: unknown;
+  }[];
+  web?: {
+    [k: string]: unknown;
+  }[];
+  logger?: {
+    level: (
+      | ("fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent")
+      | {
+          [k: string]: unknown;
+        }
+    ) &
+      string;
+    transport?:
+      | {
+          target?: string;
+          options?: {
+            [k: string]: unknown;
+          };
+        }
+      | {
+          targets?: {
+            target?: string;
+            options?: {
+              [k: string]: unknown;
+            };
+            level?: string;
+            additionalProperties?: never;
+            [k: string]: unknown;
+          }[];
+          options?: {
+            [k: string]: unknown;
+          };
+        };
+    pipeline?: {
+      target?: string;
+      options?: {
+        [k: string]: unknown;
+      };
+    };
+    [k: string]: unknown;
+  };
+  server?: {
+    hostname?: string;
+    port?: number | string;
+    http2?: boolean;
+    https?: {
+      key:
+        | string
+        | {
+            path?: string;
+          }
+        | (
+            | string
+            | {
+                path?: string;
+              }
+          )[];
+      cert:
+        | string
+        | {
+            path?: string;
+          }
+        | (
+            | string
+            | {
+                path?: string;
+              }
+          )[];
+    };
+  };
+  restartOnError?: boolean | number;
+  undici?: {
+    agentOptions?: {
+      [k: string]: unknown;
+    };
+    interceptors?:
+      | UndiciInterceptor[]
+      | {
+          Client?: UndiciInterceptor[];
+          Pool?: UndiciInterceptor[];
+          Agent?: UndiciInterceptor[];
+          [k: string]: unknown;
+        };
+    [k: string]: unknown;
+  };
+  watch?: boolean | string;
+  managementApi?:
+    | boolean
+    | string
+    | {
+        logs?: {
+          maxSize?: number;
+        };
+      };
+  metrics?:
+    | boolean
+    | {
+        port?: number | string;
+        hostname?: string;
+        endpoint?: string;
+        auth?: {
+          username: string;
+          password: string;
+        };
+        labels?: {
+          [k: string]: 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?: {
+    /**
+     * 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";
+        /**
+         * 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;
+          /**
+           * Headers to send to the exporter. Not used for console or memory exporters.
+           */
+          headers?: {
+            [k: string]: unknown;
+          };
+          [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;
+          /**
+           * Headers to send to the exporter. Not used for console or memory exporters.
+           */
+          headers?: {
+            [k: string]: unknown;
+          };
+          [k: string]: unknown;
+        };
+        additionalProperties?: never;
+        [k: string]: unknown;
+      };
+}

package/eslint.config.js

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

package/fixtures/botched-start/platformatic.runtime.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v1.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "a",
   "autoload": {
     "path": "./services"

package/fixtures/botched-start/services/a/platformatic.service.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v1.3.0/service",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
   "server": {
     "logger": {
       "level": "warn"

package/fixtures/composerApp/platformatic.composer.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.23.2/composer",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/composer/1.52.0.json",
   "server": {
     "hostname": "127.0.0.1",
     "port": 0,

package/fixtures/configs/invalid-entrypoint.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "invalid",
   "autoload": {
     "path": "../monorepo",

package/fixtures/configs/invalid-schema-type.config.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.22.0/trickortreat",
+  "$schema": "https://schemas.platformatic.dev/trickortreat/0.22.0.json",
   "server": {
     "hostname": "127.0.0.1",
     "port": 0,

package/fixtures/configs/{invalid-autoload-with-services.json → invalid-web-with-services.json}

@@ -1,12 +1,9 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "db-app",
   "autoload": {
     "path": "../monorepo",
-    "exclude": [
-      "docs",
-      "composerApp"
-    ],
+    "exclude": ["docs", "composerApp"],
     "mappings": {
       "serviceAppWithLogger": {
         "id": "with-logger",
@@ -28,5 +25,12 @@
       "path": "../monorepo/serviceAppWithLogger",
       "config": "platformatic.service.json"
     }
+  ],
+  "web": [
+    {
+      "id": "with-logger",
+      "path": "../monorepo/serviceAppWithLogger",
+      "config": "platformatic.service.json"
+    }
   ]
 }

package/fixtures/configs/missing-property.config.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "serviceApp",
   "autoload": {
     "exclude": ["docs", "composerApp"],

package/fixtures/configs/missing-service-config.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "serviceApp",
   "autoload": {
     "path": "../monorepo"

package/fixtures/configs/monorepo-composer-no-autoload.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "composerApp",
-  "hotReload": false,
+  "watch": false,
   "services": [
     {
       "id": "with-logger",

package/fixtures/configs/monorepo-composer.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "composerApp",
-  "hotReload": false,
+  "watch": false,
   "autoload": {
     "path": "../monorepo",
     "exclude": ["docs"],

package/fixtures/configs/monorepo-create-cycle.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "with-logger",
-  "hotReload": false,
+  "watch": false,
   "autoload": {
     "path": "../monorepo",
     "exclude": [

package/fixtures/configs/monorepo-missing-dependencies.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "composer",
-  "hotReload": false,
+  "watch": false,
   "managementApi": false,
   "autoload": {
     "path": "../monorepo-missing-dependencies"

package/fixtures/configs/monorepo-no-cycles.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "serviceApp",
-  "hotReload": false,
+  "watch": false,
   "autoload": {
     "path": "../monorepo",
     "exclude": ["docs", "composerApp"],

package/fixtures/configs/monorepo-openapi.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.35.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "without-openapi",
-  "hotReload": false,
+  "watch": false,
   "services": [
     {
       "id": "without-openapi",

package/fixtures/configs/{monorepo-hotreload-env.json → monorepo-watch-env.json}

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.33.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "serviceApp",
-  "hotReload": "{PLT_HOT_RELOAD}",
+  "watch": "{PLT_WATCH}",
   "autoload": {
     "path": "../monorepo",
     "exclude": ["docs", "composerApp"],

package/fixtures/configs/monorepo-watch-single.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.35.0/runtime",
+  "entrypoint": "service1",
+  "watch": true,
+  "services": [
+    {
+      "id": "service1",
+      "path": "../monorepo-watch/service1",
+      "config": "platformatic.service.json"
+    }
+  ]
+}

package/fixtures/configs/monorepo-watch.json

@@ -1,12 +1,27 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.35.0/runtime",
-  "entrypoint": "service1",
-  "hotReload": true,
-  "services": [
-    {
-      "id": "service1",
-      "path": "../monorepo-watch/service1",
-      "config": "platformatic.service.json"
+  "$schema": "https://platformatic.dev/schemas/v2.0.0/runtime",
+  "entrypoint": "serviceApp",
+  "watch": true,
+  "autoload": {
+    "path": "../monorepo",
+    "exclude": ["docs", "composerApp"],
+    "mappings": {
+      "serviceAppWithLogger": {
+        "id": "with-logger",
+        "config": "platformatic.service.json"
+      },
+      "serviceAppWithMultiplePlugins": {
+        "id": "multi-plugin-service",
+        "config": "platformatic.service.json"
+      },
+      "dbApp": {
+        "id": "db-app",
+        "config": "platformatic.db.json"
+      }
     }
-  ]
+  },
+  "logger": {
+    "level": "trace"
+  },
+  "restartOnError": 1000
 }

package/fixtures/configs/monorepo-with-dependencies.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v1.44.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "main",
-  "hotReload": true,
+  "watch": true,
   "autoload": {
     "path": "../monorepo-with-dependencies"
   }

package/fixtures/configs/monorepo-with-management-api-without-metrics.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.22.0.json",
+  "entrypoint": "serviceApp",
+  "watch": true,
+  "autoload": {
+    "path": "../monorepo",
+    "exclude": ["docs", "composerApp"],
+    "mappings": {
+      "serviceAppWithLogger": {
+        "id": "with-logger",
+        "config": "platformatic.service.json"
+      },
+      "serviceAppWithMultiplePlugins": {
+        "id": "multi-plugin-service",
+        "config": "platformatic.service.json"
+      }
+    }
+  },
+  "managementApi": {},
+  "metrics": false
+}

package/fixtures/configs/monorepo-with-management-api.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v1.21.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "serviceApp",
-  "hotReload": false,
+  "watch": false,
   "autoload": {
     "path": "../monorepo",
     "exclude": ["docs", "composerApp"],

package/fixtures/configs/{monorepo-hotreload.json → monorepo-with-metrics.json}

@@ -1,7 +1,8 @@
 {
   "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
   "entrypoint": "serviceApp",
-  "hotReload": true,
+  "watch": false,
+  "managementApi": false,
   "autoload": {
     "path": "../monorepo",
     "exclude": [
@@ -23,9 +24,9 @@
       }
     }
   },
-  "server": {
-    "logger": {
-      "level": "trace"
+  "metrics": {
+    "labels": {
+      "app": "serviceApp"
     }
   }
 }

package/fixtures/configs/monorepo.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "serviceApp",
-  "hotReload": false,
+  "watch": false,
   "managementApi": false,
   "autoload": {
     "path": "../monorepo",

package/fixtures/configs/no-services.config.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "doesNotExist",
   "services": []
 }

package/fixtures/configs/no-sources.config.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": ""
 }

package/fixtures/configs/service-throws-on-start.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "serviceThrowsOnStart",
   "services": [
     {

package/fixtures/configs/service-with-env-port.json

@@ -1,7 +1,7 @@
 {
-    "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+    "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
     "entrypoint": "serviceApp",
-    "hotReload": false,
+    "watch": false,
     "managementApi": false,
     "autoload": {
       "path": "../monorepo",

package/fixtures/configs/service-with-stdio.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "stdio",
+  "managementApi": {},
+  "services": [
+    {
+      "id": "stdio",
+      "path": "../stdio",
+      "config": "platformatic.service.json"
+    }
+  ]
+}

package/fixtures/configs/{hotreload.json → watch.json}

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.32.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "serviceApp",
-  "hotReload": true,
+  "watch": true,
   "autoload": {
     "path": "../monorepo",
     "exclude": ["docs", "composerApp"],

package/fixtures/crash-on-bootstrap/platformatic.runtime.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "service-1",
+  "autoload": {
+    "path": "./services"
+  },
+  "restartOnError": 100,
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": "0",
+    "logger": {
+      "level": "info"
+    }
+  }
+}

package/fixtures/crash-on-bootstrap/services/service-1/platformatic.service.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "plugins": {
+    "paths": [{
+      "path": "plugin.js",
+      "encapsulate": false
+    }]
+  }
+}

package/fixtures/crash-on-bootstrap/services/service-1/plugin.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = async function (app) {
+  app.log.info('Service 1 plugin')
+}

package/fixtures/crash-on-bootstrap/services/service-2/platformatic.service.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "plugins": {
+    "paths": [{
+      "path": "plugin.js",
+      "encapsulate": false
+    }]
+  }
+}

package/fixtures/crash-on-bootstrap/services/service-2/plugin.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = async function () {
+  throw new Error('Crash!')
+}

package/fixtures/dbApp/platformatic.db.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.22.0/db",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/db/1.52.0.json",
   "server": {
     "hostname": "127.0.0.1",
     "port": 0