@platformatic/nitro 3.68.0 → 3.70.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/config.d.ts +96 -14
  2. package/package.json +9 -9
  3. package/schema.json +157 -33
package/config.d.ts CHANGED
@@ -9,13 +9,10 @@ export interface PlatformaticNitroConfig {
9
9
  $schema?: string;
10
10
  module?: string;
11
11
  logger?: {
12
- level?: (
13
- | ("fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent")
14
- | {
15
- [k: string]: unknown;
16
- }
17
- ) &
18
- string;
12
+ /**
13
+ * The log level. It must be one of the standard pino levels (fatal, error, warn, info, debug, trace, silent) or, when customLevels is set, one of the custom levels.
14
+ */
15
+ level?: string;
19
16
  transport?:
20
17
  | {
21
18
  target?: string;
@@ -48,6 +45,10 @@ export interface PlatformaticNitroConfig {
48
45
  redact?: {
49
46
  paths: string[];
50
47
  censor?: string;
48
+ /**
49
+ * Remove the redacted keys entirely instead of replacing their values with the censor. Defaults to false.
50
+ */
51
+ remove?: boolean;
51
52
  };
52
53
  base?: {
53
54
  [k: string]: unknown;
@@ -56,6 +57,46 @@ export interface PlatformaticNitroConfig {
56
57
  customLevels?: {
57
58
  [k: string]: unknown;
58
59
  };
60
+ /**
61
+ * The numeric value of the level defined in level, when it is not one of the standard pino levels.
62
+ */
63
+ levelVal?: number;
64
+ /**
65
+ * Only use the levels defined in customLevels and omit the standard pino ones.
66
+ */
67
+ useOnlyCustomLevels?: boolean;
68
+ /**
69
+ * How log levels are compared to the logger level. Use DESC when lower values are more severe. Defaults to ASC.
70
+ */
71
+ levelComparison?: "ASC" | "DESC";
72
+ /**
73
+ * A string prefixed to every message, including the ones of child loggers.
74
+ */
75
+ msgPrefix?: string;
76
+ /**
77
+ * The key under which any logged object is placed.
78
+ */
79
+ nestedKey?: string;
80
+ /**
81
+ * The key used for the serialized error in the log object. Defaults to err.
82
+ */
83
+ errorKey?: string;
84
+ /**
85
+ * The stringification limit at a specific nesting depth when logging circular objects. Defaults to 5.
86
+ */
87
+ depthLimit?: number;
88
+ /**
89
+ * The stringification limit of properties or elements when logging a circular object or array. Defaults to 100.
90
+ */
91
+ edgeLimit?: number;
92
+ /**
93
+ * Terminate each log line with \r\n instead of \n. Defaults to false.
94
+ */
95
+ crlf?: boolean;
96
+ /**
97
+ * Set to false to disable logging entirely. Defaults to true.
98
+ */
99
+ enabled?: boolean;
59
100
  openTelemetryExporter?: {
60
101
  protocol: "grpc" | "http";
61
102
  url: string;
@@ -170,13 +211,10 @@ export interface PlatformaticNitroConfig {
170
211
  };
171
212
  workersRestartDelay?: number | string;
172
213
  logger?: {
173
- level?: (
174
- | ("fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent")
175
- | {
176
- [k: string]: unknown;
177
- }
178
- ) &
179
- string;
214
+ /**
215
+ * The log level. It must be one of the standard pino levels (fatal, error, warn, info, debug, trace, silent) or, when customLevels is set, one of the custom levels.
216
+ */
217
+ level?: string;
180
218
  transport?:
181
219
  | {
182
220
  target?: string;
@@ -209,6 +247,10 @@ export interface PlatformaticNitroConfig {
209
247
  redact?: {
210
248
  paths: string[];
211
249
  censor?: string;
250
+ /**
251
+ * Remove the redacted keys entirely instead of replacing their values with the censor. Defaults to false.
252
+ */
253
+ remove?: boolean;
212
254
  };
213
255
  base?: {
214
256
  [k: string]: unknown;
@@ -217,6 +259,46 @@ export interface PlatformaticNitroConfig {
217
259
  customLevels?: {
218
260
  [k: string]: unknown;
219
261
  };
262
+ /**
263
+ * The numeric value of the level defined in level, when it is not one of the standard pino levels.
264
+ */
265
+ levelVal?: number;
266
+ /**
267
+ * Only use the levels defined in customLevels and omit the standard pino ones.
268
+ */
269
+ useOnlyCustomLevels?: boolean;
270
+ /**
271
+ * How log levels are compared to the logger level. Use DESC when lower values are more severe. Defaults to ASC.
272
+ */
273
+ levelComparison?: "ASC" | "DESC";
274
+ /**
275
+ * A string prefixed to every message, including the ones of child loggers.
276
+ */
277
+ msgPrefix?: string;
278
+ /**
279
+ * The key under which any logged object is placed.
280
+ */
281
+ nestedKey?: string;
282
+ /**
283
+ * The key used for the serialized error in the log object. Defaults to err.
284
+ */
285
+ errorKey?: string;
286
+ /**
287
+ * The stringification limit at a specific nesting depth when logging circular objects. Defaults to 5.
288
+ */
289
+ depthLimit?: number;
290
+ /**
291
+ * The stringification limit of properties or elements when logging a circular object or array. Defaults to 100.
292
+ */
293
+ edgeLimit?: number;
294
+ /**
295
+ * Terminate each log line with \r\n instead of \n. Defaults to false.
296
+ */
297
+ crlf?: boolean;
298
+ /**
299
+ * Set to false to disable logging entirely. Defaults to true.
300
+ */
301
+ enabled?: boolean;
220
302
  openTelemetryExporter?: {
221
303
  protocol: "grpc" | "http";
222
304
  url: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@platformatic/nitro",
3
- "version": "3.68.0",
3
+ "version": "3.70.0",
4
4
  "description": "Platformatic Nitro Capability",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
@@ -31,10 +31,10 @@
31
31
  "dependencies": {
32
32
  "light-my-request": "^6.6.0",
33
33
  "semver": "^7.6.3",
34
- "@platformatic/basic": "3.68.0",
35
- "@platformatic/foundation": "3.68.0",
36
- "@platformatic/globals": "3.68.0",
37
- "@platformatic/vite": "3.68.0"
34
+ "@platformatic/basic": "3.70.0",
35
+ "@platformatic/foundation": "3.70.0",
36
+ "@platformatic/globals": "3.70.0",
37
+ "@platformatic/vite": "3.70.0"
38
38
  },
39
39
  "devDependencies": {
40
40
  "cleaner-spec-reporter": "^0.5.0",
@@ -43,12 +43,12 @@
43
43
  "neostandard": "^0.12.0",
44
44
  "nitro": "^3.0.260610-beta",
45
45
  "nitropack": "^2.12.9",
46
- "tstyche": "^6.2.0",
46
+ "tstyche": "^7.0.0",
47
47
  "typescript": "~6.0.3",
48
- "vite": "^7.2.4",
48
+ "vite": "^8.2.2",
49
49
  "ws": "^8.18.0",
50
- "@platformatic/gateway": "3.68.0",
51
- "@platformatic/service": "3.68.0"
50
+ "@platformatic/gateway": "3.70.0",
51
+ "@platformatic/service": "3.70.0"
52
52
  },
53
53
  "engines": {
54
54
  "node": ">=22.19.0"
package/schema.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "$id": "https://schemas.platformatic.dev/@platformatic/nitro/3.68.0.json",
2
+ "$id": "https://schemas.platformatic.dev/@platformatic/nitro/3.70.0.json",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
4
  "title": "Platformatic Nitro Config",
5
5
  "type": "object",
@@ -15,22 +15,7 @@
15
15
  "properties": {
16
16
  "level": {
17
17
  "type": "string",
18
- "oneOf": [
19
- {
20
- "enum": [
21
- "fatal",
22
- "error",
23
- "warn",
24
- "info",
25
- "debug",
26
- "trace",
27
- "silent"
28
- ]
29
- },
30
- {
31
- "pattern": "^\\{.+\\}$"
32
- }
33
- ]
18
+ "description": "The log level. It must be one of the standard pino levels (fatal, error, warn, info, debug, trace, silent) or, when customLevels is set, one of the custom levels."
34
19
  },
35
20
  "transport": {
36
21
  "anyOf": [
@@ -131,6 +116,10 @@
131
116
  "censor": {
132
117
  "type": "string",
133
118
  "default": "[redacted]"
119
+ },
120
+ "remove": {
121
+ "type": "boolean",
122
+ "description": "Remove the redacted keys entirely instead of replacing their values with the censor. Defaults to false."
134
123
  }
135
124
  },
136
125
  "required": [
@@ -156,6 +145,50 @@
156
145
  "type": "object",
157
146
  "additionalProperties": true
158
147
  },
148
+ "levelVal": {
149
+ "type": "integer",
150
+ "description": "The numeric value of the level defined in level, when it is not one of the standard pino levels."
151
+ },
152
+ "useOnlyCustomLevels": {
153
+ "type": "boolean",
154
+ "description": "Only use the levels defined in customLevels and omit the standard pino ones."
155
+ },
156
+ "levelComparison": {
157
+ "type": "string",
158
+ "enum": [
159
+ "ASC",
160
+ "DESC"
161
+ ],
162
+ "description": "How log levels are compared to the logger level. Use DESC when lower values are more severe. Defaults to ASC."
163
+ },
164
+ "msgPrefix": {
165
+ "type": "string",
166
+ "description": "A string prefixed to every message, including the ones of child loggers."
167
+ },
168
+ "nestedKey": {
169
+ "type": "string",
170
+ "description": "The key under which any logged object is placed."
171
+ },
172
+ "errorKey": {
173
+ "type": "string",
174
+ "description": "The key used for the serialized error in the log object. Defaults to err."
175
+ },
176
+ "depthLimit": {
177
+ "type": "integer",
178
+ "description": "The stringification limit at a specific nesting depth when logging circular objects. Defaults to 5."
179
+ },
180
+ "edgeLimit": {
181
+ "type": "integer",
182
+ "description": "The stringification limit of properties or elements when logging a circular object or array. Defaults to 100."
183
+ },
184
+ "crlf": {
185
+ "type": "boolean",
186
+ "description": "Terminate each log line with \\r\\n instead of \\n. Defaults to false."
187
+ },
188
+ "enabled": {
189
+ "type": "boolean",
190
+ "description": "Set to false to disable logging entirely. Defaults to true."
191
+ },
159
192
  "openTelemetryExporter": {
160
193
  "type": "object",
161
194
  "properties": {
@@ -177,6 +210,35 @@
177
210
  "additionalProperties": false
178
211
  }
179
212
  },
213
+ "if": {
214
+ "not": {
215
+ "required": [
216
+ "customLevels"
217
+ ]
218
+ }
219
+ },
220
+ "then": {
221
+ "properties": {
222
+ "level": {
223
+ "oneOf": [
224
+ {
225
+ "enum": [
226
+ "fatal",
227
+ "error",
228
+ "warn",
229
+ "info",
230
+ "debug",
231
+ "trace",
232
+ "silent"
233
+ ]
234
+ },
235
+ {
236
+ "pattern": "^\\{.+\\}$"
237
+ }
238
+ ]
239
+ }
240
+ }
241
+ },
180
242
  "default": {},
181
243
  "additionalProperties": true
182
244
  },
@@ -993,22 +1055,7 @@
993
1055
  "properties": {
994
1056
  "level": {
995
1057
  "type": "string",
996
- "oneOf": [
997
- {
998
- "enum": [
999
- "fatal",
1000
- "error",
1001
- "warn",
1002
- "info",
1003
- "debug",
1004
- "trace",
1005
- "silent"
1006
- ]
1007
- },
1008
- {
1009
- "pattern": "^\\{.+\\}$"
1010
- }
1011
- ]
1058
+ "description": "The log level. It must be one of the standard pino levels (fatal, error, warn, info, debug, trace, silent) or, when customLevels is set, one of the custom levels."
1012
1059
  },
1013
1060
  "transport": {
1014
1061
  "anyOf": [
@@ -1109,6 +1156,10 @@
1109
1156
  "censor": {
1110
1157
  "type": "string",
1111
1158
  "default": "[redacted]"
1159
+ },
1160
+ "remove": {
1161
+ "type": "boolean",
1162
+ "description": "Remove the redacted keys entirely instead of replacing their values with the censor. Defaults to false."
1112
1163
  }
1113
1164
  },
1114
1165
  "required": [
@@ -1134,6 +1185,50 @@
1134
1185
  "type": "object",
1135
1186
  "additionalProperties": true
1136
1187
  },
1188
+ "levelVal": {
1189
+ "type": "integer",
1190
+ "description": "The numeric value of the level defined in level, when it is not one of the standard pino levels."
1191
+ },
1192
+ "useOnlyCustomLevels": {
1193
+ "type": "boolean",
1194
+ "description": "Only use the levels defined in customLevels and omit the standard pino ones."
1195
+ },
1196
+ "levelComparison": {
1197
+ "type": "string",
1198
+ "enum": [
1199
+ "ASC",
1200
+ "DESC"
1201
+ ],
1202
+ "description": "How log levels are compared to the logger level. Use DESC when lower values are more severe. Defaults to ASC."
1203
+ },
1204
+ "msgPrefix": {
1205
+ "type": "string",
1206
+ "description": "A string prefixed to every message, including the ones of child loggers."
1207
+ },
1208
+ "nestedKey": {
1209
+ "type": "string",
1210
+ "description": "The key under which any logged object is placed."
1211
+ },
1212
+ "errorKey": {
1213
+ "type": "string",
1214
+ "description": "The key used for the serialized error in the log object. Defaults to err."
1215
+ },
1216
+ "depthLimit": {
1217
+ "type": "integer",
1218
+ "description": "The stringification limit at a specific nesting depth when logging circular objects. Defaults to 5."
1219
+ },
1220
+ "edgeLimit": {
1221
+ "type": "integer",
1222
+ "description": "The stringification limit of properties or elements when logging a circular object or array. Defaults to 100."
1223
+ },
1224
+ "crlf": {
1225
+ "type": "boolean",
1226
+ "description": "Terminate each log line with \\r\\n instead of \\n. Defaults to false."
1227
+ },
1228
+ "enabled": {
1229
+ "type": "boolean",
1230
+ "description": "Set to false to disable logging entirely. Defaults to true."
1231
+ },
1137
1232
  "openTelemetryExporter": {
1138
1233
  "type": "object",
1139
1234
  "properties": {
@@ -1155,6 +1250,35 @@
1155
1250
  "additionalProperties": false
1156
1251
  }
1157
1252
  },
1253
+ "if": {
1254
+ "not": {
1255
+ "required": [
1256
+ "customLevels"
1257
+ ]
1258
+ }
1259
+ },
1260
+ "then": {
1261
+ "properties": {
1262
+ "level": {
1263
+ "oneOf": [
1264
+ {
1265
+ "enum": [
1266
+ "fatal",
1267
+ "error",
1268
+ "warn",
1269
+ "info",
1270
+ "debug",
1271
+ "trace",
1272
+ "silent"
1273
+ ]
1274
+ },
1275
+ {
1276
+ "pattern": "^\\{.+\\}$"
1277
+ }
1278
+ ]
1279
+ }
1280
+ }
1281
+ },
1158
1282
  "default": {},
1159
1283
  "additionalProperties": true
1160
1284
  },