restored next

Signed-off-by: Matteo Collina <hello@matteocollina.com>

Author: mcollina

docs/cli.md

@@ -90,7 +90,6 @@ Welcome to Platformatic. Available commands are:
 * `logs` - stream logs for a Platformatic runtime application.
 * `upgrade` - upgrade the Platformatic configuration to the latest version.
 * `resolve` - resolve Platformatic Runtime external services
-* `patch-config` - Applies a patch file to the runtime and services configurations.
 * `client` - generate a Platformatic client.
 * `build` - builds all services.
 * `install` - install all dependencies of an application and its services.
@@ -144,6 +143,20 @@ To get the list of runtimes with enabled management API use the
 `platformatic ctl ps` command.
 
 
+#### install
+
+Install all dependencies of an application and its services.
+
+```bash
+platformatic install
+```
+
+Options:
+
+* `-p, --production`: Only install production dependencies.
+* `-P, --package-manager EXECUTABLE`: Use an alternative package manager (the default is to autodetect it).
+
+
 #### logs
 
 Streams logs from the platformatic runtime application.
@@ -244,15 +257,6 @@ You can find more details about the configuration format here:
 * [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
 * [Platformatic Service Configuration](https://docs.platformatic.dev/docs/service/configuration)
 
-#### `patch-config`
-
-Applies a patch file to the runtime and services configurations.
-
-Arguments:
-
-* `-c, --config FILE` - Path to the runtime configuration file.
-- `-p, --patch PATCH`: The file containing the patch to execute. Its default export should be a function that receives the `runtime` and `services` arguments and returns an object containing
-  the `runtime` and `services` keys with [JSON Patch](https://jsonpatch.com/) formatted patch to apply to configuration files.
 
 #### start
 
@@ -302,19 +306,6 @@ platformatic client <command>
 ```
 
 
-### install
-
-Install all dependencies of an application and its services.
-
-```bash
-platformatic install
-```
-
-Options:
-
-* `-p, --production`: Only install production dependencies.
-* `-P, --package-manager EXECUTABLE`: Use an alternative package manager (the default is to autodetect it).
-
 #### help
 
 Create a Fastify plugin that exposes a client for a remote OpenAPI or GraphQL API.
@@ -400,9 +391,11 @@ Options:
 * `--types-only` - Generate only the type file.
 * `--types-comment` - Add a comment at the beginning of the auto generated `.d.ts` type definition.
 * `--with-credentials` - Adds "credentials: 'include'" to all fetch requests (only for frontend clients).
+* `--props-optional` - If `true`, properties will be defined as optional unless they're part of the `required` array. By default this option is `false`.
 * `--skip-config-update` - If `true`, it will not update the `platformatic|watt` config found in your repo.
 
 
+
 ### composer
 
 ```bash
@@ -1144,6 +1137,24 @@ To get the list of runtimes with enabled management API use the
 `platformatic ctl ps` command.
 
 
+#### metrics
+
+Get metrics from the platformatic runtime application.
+
+``` bash
+  $ platformatic ctl metrics
+```
+
+Options:
+
+* `-p, --pid <number>` - The process id of the runtime.
+* `-f, --format <string>` - The format of the metrics, which should be either `text` or `json` (default to `json`).
+
+If `--pid` is not specified, the command will get metrics from the first available matching runtime.
+
+To see the list of all available control commands, run `platformatic ctl help`.
+
+
 #### ps
 
 Lists all running platformatic runtime applications.

docs/client/frontend.md

@@ -45,6 +45,24 @@ console.log(movies)
 
 You can use both named operations and the factory in the same file. They can work on different hosts, so the factory does _not_ use the global `setBaseUrl` function.
 
+### Default fetch params
+
+You can set additional parameters to be passed to the client `fetch` instance.
+
+```js
+import build from './api.js'
+import { setDefaultFetchParams } from './api.js'
+
+setDefaultFetchParams({
+    keepalive: false,
+    mode: 'no-cors'
+})
+
+// `fetch` will be called with the `keepalive` and `mode` method as defined above
+const movies = await getMovies({})
+console.log(movies)
+```
+
 ### Default Headers
 
 You can set headers that will be sent along with all the requests made by the client. This is useful, for instance, for authentication.
@@ -58,6 +76,7 @@ setBaseUrl('http://my-server-url.com') // modifies the global `baseUrl` variable
 setDefaultHeaders({
     authorization: 'Bearer MY_TOKEN'
 })
+
 const movies = await getMovies({})
 console.log(movies)
 ```
@@ -98,8 +117,9 @@ interface GetMoviesResponseOK {
   'title': string;
 }
 export interface Api {
-  setBaseUrl(newUrl: string) : void;
-  setDefaultHeaders(headers: Object) : void;
+  setBaseUrl(newUrl: string): void;
+  setDefaultHeaders(headers: Object): void;
+  setDefaultFetchParams(fetchParams: RequestInit): void;
   getMovies(req: GetMoviesRequest): Promise<Array<GetMoviesResponseOK>>;
   // ... all operations listed here
 }
@@ -118,10 +138,12 @@ let defaultHeaders = ''
 /**  @type {import('./api-types.d.ts').Api['setBaseUrl']} */
 export const setBaseUrl = (newUrl) => { baseUrl = newUrl }
 
-
 /**  @type {import('./api-types.d.ts').Api['setDefaultHeaders']} */
 export const setDefaultHeaders = (headers) => { defaultHeaders = headers }
 
+/**  @type {import('./${name}-types.d.ts').${camelCaseName}['setDefaultFetchParams']} */
+export const setDefaultFetchParams = (fetchParams) => { defaultFetchParams = fetchParams }
+
 /**  @type {import('./api-types.d.ts').Api['getMovies']} */
 export const getMovies = async (request) => {
   return await _getMovies(baseUrl, request)
@@ -165,12 +187,15 @@ import type { Api } from './api-types'
 import type * as Types from './api-types'
 
 let baseUrl = ''
-let defaultHeaders = ''
+let defaultHeaders = {}
+let defaultFetchParams = {}
 
 export const setBaseUrl = (newUrl: string) : void => { baseUrl = newUrl }
 
 export const setDefaultHeaders = (headers: Object) => { defaultHeaders = headers }
 
+export const setDefaultFetchParams = (fetchParams: RequestInit): void => { defaultFetchParams = fetchParams }
+
 const _getMovies = async (url: string, request: Types.GetMoviesRequest) => {
   const response = await fetch(`${url}/movies/?${new URLSearchParams(Object.entries(request || {})).toString()}`)
 

docs/composer/programmatic.md

@@ -32,23 +32,25 @@ const app = await buildServer({
     hostname: '127.0.0.1',
     port: 0
   },
-  services: [
-    {
-      id: 'auth-service',
-      origin: 'https://auth-service.com',
-      openapi: {
-        url: '/documentation/json',
-        prefix: 'auth'
+  composer: {
+    services: [
+      {
+        id: 'auth-service',
+        origin: 'https://auth-service.com',
+        openapi: {
+          url: '/documentation/json',
+          prefix: 'auth'
+        }
+      },
+      {
+        id: 'payment-service',
+        origin: 'https://payment-service.com',
+        openapi: {
+          file: './schemas/payment-service.json'
+        }
       }
-    },
-    {
-      id: 'payment-service',
-      origin: 'https://payment-service.com',
-      openapi: {
-        file: './schemas/payment-service.json'
-      }
-    }
-  ]
+    ]
+  }
 })
 
 await app.start()

docs/contributing/documentation-style-guide.md

@@ -124,7 +124,7 @@ More like this:
 >As an example, the following recommendations should be
 referenced.
 
-To view a live example, refer to the [Decorators](../reference/db/configuration.md)
+To view a live example, refer to the [Decorators](../db/configuration.md)
 reference document.
 
 To recap, **avoid "you" in reference documentation or API documentation.**

docs/db/configuration.md

@@ -200,7 +200,7 @@ postgres://user:password@my-database:5432/db-name
   ```
 
   You can for example add the `security` section, so that Swagger will allow you to add the authentication header to your requests.
-  We're adding a Bearer token in the form of a [JWT](/reference/db/authorization/strategies.md#json-web-token-jwt) in the code block below: 
+  We're adding a Bearer token in the form of a [JWT](./authorization/strategies.md#json-web-token-jwt) in the code block below: 
 
   ```json title="Example Object"
   {