@webda/core 4.0.0-beta.5 → 4.0.0-beta.7

package/webda.module.json

@@ -3,6 +3,48 @@
   "beans": {},
   "deployers": {},
   "moddas": {
+    "Webda/ApplicationPackager": {
+      "Import": "lib/deployers/packager.service:ApplicationPackager",
+      "Schema": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "additionalProperties": false,
+        "description": "Interface to specify the Service parameters",
+        "properties": {
+          "type": {
+            "description": "Type of the service",
+            "type": "string"
+          },
+          "openapi": {
+            "type": "object",
+            "additionalProperties": true
+          }
+        },
+        "required": [
+          "type"
+        ],
+        "type": "object",
+        "title": "ApplicationPackager"
+      },
+      "Configuration": "lib/services/serviceparameters:ServiceParameters",
+      "commands": {
+        "package": {
+          "description": "Package the application with its deployment applied",
+          "method": "package",
+          "args": {
+            "output": {
+              "type": "string",
+              "alias": "o",
+              "description": "Package folder, or JSON file with --config-only (stdout if omitted)"
+            },
+            "configOnly": {
+              "type": "boolean",
+              "description": "Only output the deployed configuration"
+            }
+          },
+          "phase": "resolved"
+        }
+      }
+    },
     "Webda/AuditService": {
       "Import": "lib/services/audit.model:AuditService",
       "Schema": {
@@ -109,19 +151,15 @@
       "Schema": {
         "$schema": "http://json-schema.org/draft-07/schema#",
         "additionalProperties": false,
-        "definitions": {
-          "Duration": {
-            "additionalProperties": false,
-            "description": "Represents a time duration that defaults to seconds but supports composite strings.",
-            "type": "number | string * Supported units:\n- seconds: `s`, `sec`, `secs`, `second`, `seconds`\n- minutes: `m`, `min`, `mins`, `minute`, `minutes`\n- hours: `h`, `hr`, `hour`, `hours`\n- days: `d`, `day`, `days`\n- months: `mo`, `mon`, `month`, `months` (assumed 30 days)\n- years: `y`, `yr`, `year`, `years` (assumed 365 days)\n\nExamples:\n- `10` → 10 seconds\n- `15s` → 15 seconds\n- `2m` → 120 seconds\n- `1d2h30m` → 1 day + 2 hours + 30 minutes\n- `1 d 2 h` → same as above (spaces allowed)"
-          }
-        },
         "description": "Parameters for the ConfigurationService, defining how configuration sources are loaded and refreshed",
         "properties": {
           "checkInterval": {
-            "$ref": "#/definitions/Duration",
             "default": "1h",
-            "description": "Check configuration every {checkInterval} seconds"
+            "description": "Check configuration every {checkInterval} seconds",
+            "type": [
+              "number",
+              "string"
+            ]
           },
           "default": {
             "default": "{ services: {}, parameters: {} }",
@@ -213,8 +251,11 @@
             "description": "Cookie Options",
             "properties": {
               "_maxAge": {
-                "$ref": "#/definitions/Duration",
-                "description": "Duration storage"
+                "description": "Duration storage",
+                "type": [
+                  "number",
+                  "string"
+                ]
               },
               "domain": {
                 "anyOf": [
@@ -267,11 +308,6 @@
             },
             "type": "object"
           },
-          "Duration": {
-            "additionalProperties": false,
-            "description": "Represents a time duration that defaults to seconds but supports composite strings.",
-            "type": "number | string * Supported units:\n- seconds: `s`, `sec`, `secs`, `second`, `seconds`\n- minutes: `m`, `min`, `mins`, `minute`, `minutes`\n- hours: `h`, `hr`, `hour`, `hours`\n- days: `d`, `day`, `days`\n- months: `mo`, `mon`, `month`, `months` (assumed 30 days)\n- years: `y`, `yr`, `year`, `years` (assumed 365 days)\n\nExamples:\n- `10` → 10 seconds\n- `15s` → 15 seconds\n- `2m` → 120 seconds\n- `1d2h30m` → 1 day + 2 hours + 30 minutes\n- `1 d 2 h` → same as above (spaces allowed)"
-          },
           "JWTOptions": {
             "additionalProperties": false,
             "description": "JWT Options",
@@ -326,7 +362,8 @@
                     "$ref": "#/definitions/jwt%24secretOrPublicKey%233"
                   }
                 ],
-                "description": "Secret to use with JWT"
+                "description": "Secret to use with JWT\n\nCan be encrypted with `webda config encrypt`",
+                "x-webda-secret": true
               },
               "subject": {
                 "description": "Subject for JWT",
@@ -360,7 +397,7 @@
           },
           "jwt": {
             "$ref": "#/definitions/JWTOptions",
-            "description": "Options for issue JWT token"
+            "description": "Options for issue JWT token\n\n`secretOrPublicKey` can be encrypted with `webda config encrypt`"
           },
           "type": {
             "description": "Type of the service",
@@ -475,7 +512,8 @@
                     "$ref": "#/definitions/jwt%24secretOrPublicKey%233"
                   }
                 ],
-                "description": "Secret to use with JWT"
+                "description": "Secret to use with JWT\n\nCan be encrypted with `webda config encrypt`",
+                "x-webda-secret": true
               },
               "subject": {
                 "description": "Subject for JWT",
@@ -516,7 +554,9 @@
                 "type": "string"
               },
               "passphrase": {
-                "type": "string"
+                "description": "Passphrase used to encrypt the private key\n\nCan be encrypted with `webda config encrypt`",
+                "type": "string",
+                "x-webda-secret": true
               },
               "type": {
                 "default": "pkcs8",
@@ -597,7 +637,7 @@
           },
           "jwt": {
             "$ref": "#/definitions/JWTOptions",
-            "description": "Default JWT options"
+            "description": "Default JWT options\n\n`secretOrPublicKey` can be encrypted with `webda config encrypt`"
           },
           "keyActiveLifespan": {
             "description": "Number of hours a key should be used for encryption\n\nif auto-rotate is not set this",
@@ -638,7 +678,87 @@
         "type": "object",
         "title": "CryptoService"
       },
-      "Configuration": "lib/services/icryptoservice:CryptoServiceParameters"
+      "Configuration": "lib/services/icryptoservice:CryptoServiceParameters",
+      "commands": {
+        "config encrypt": {
+          "description": "Encrypt the secrets of the configuration files, or check them with --check",
+          "method": "encryptConfigurationFile",
+          "args": {
+            "file": {
+              "type": "string",
+              "alias": "f",
+              "description": "Configuration file to update (json, jsonc or yaml), the application and deployment files by default"
+            },
+            "migrate": {
+              "type": "string",
+              "description": "Re-encrypt the already encrypted values with this encrypter, the default one when empty"
+            },
+            "upgrade": {
+              "type": "boolean",
+              "description": "Re-encrypt the already encrypted values with their own encrypter, to its current format or key"
+            },
+            "check": {
+              "type": "boolean",
+              "default": false,
+              "description": "Only check that the secrets are encrypted, write nothing and fail if one is not"
+            },
+            "strict": {
+              "type": "boolean",
+              "default": true,
+              "description": "With --check, report the values marked encrypt: as failures"
+            },
+            "format": {
+              "type": "string",
+              "default": "text",
+              "description": "With --check, output format: text or json"
+            },
+            "none": {
+              "type": "boolean",
+              "default": true,
+              "description": "With --check, accept the values kept in clear text with crypt:none: (--no-none to fail on them)"
+            },
+            "exclude": {
+              "type": "string",
+              "description": "Secret paths to leave alone, comma-separated (services.demo.password, units[ ].token, $.parameters.  )"
+            }
+          },
+          "phase": "application"
+        },
+        "config pki generate": {
+          "description": "Generate a key pair for the pki configuration encrypter",
+          "method": "pkiGenerate",
+          "args": {
+            "kid": {
+              "type": "string",
+              "required": true,
+              "description": "Key id, for example 2026-10"
+            },
+            "bits": {
+              "type": "number",
+              "default": 4096,
+              "description": "RSA modulus length"
+            },
+            "out": {
+              "type": "string",
+              "description": "Private key file, ./<kid>.pem by default"
+            }
+          },
+          "phase": "application"
+        },
+        "config pki list": {
+          "description": "List the pki keys and the values encrypted with each of them",
+          "method": "pkiList",
+          "args": {
+            "file": {
+              "type": "string",
+              "required": true,
+              "alias": "f",
+              "description": "Configuration file to inspect (json, jsonc or yaml)"
+            }
+          },
+          "phase": "application"
+        }
+      }
     },
     "Webda/DebugMailer": {
       "Import": "lib/services/debugmailer.service:DebugMailer",
@@ -736,19 +856,15 @@
       "Schema": {
         "$schema": "http://json-schema.org/draft-07/schema#",
         "additionalProperties": false,
-        "definitions": {
-          "Duration": {
-            "additionalProperties": false,
-            "description": "Represents a time duration that defaults to seconds but supports composite strings.",
-            "type": "number | string * Supported units:\n- seconds: `s`, `sec`, `secs`, `second`, `seconds`\n- minutes: `m`, `min`, `mins`, `minute`, `minutes`\n- hours: `h`, `hr`, `hour`, `hours`\n- days: `d`, `day`, `days`\n- months: `mo`, `mon`, `month`, `months` (assumed 30 days)\n- years: `y`, `yr`, `year`, `years` (assumed 365 days)\n\nExamples:\n- `10` → 10 seconds\n- `15s` → 15 seconds\n- `2m` → 120 seconds\n- `1d2h30m` → 1 day + 2 hours + 30 minutes\n- `1 d 2 h` → same as above (spaces allowed)"
-          }
-        },
         "description": "Parameters for the ConfigurationService, defining how configuration sources are loaded and refreshed",
         "properties": {
           "checkInterval": {
-            "$ref": "#/definitions/Duration",
             "default": "1h",
-            "description": "Check configuration every {checkInterval} seconds"
+            "description": "Check configuration every {checkInterval} seconds",
+            "type": [
+              "number",
+              "string"
+            ]
           },
           "default": {
             "default": "{ services: {}, parameters: {} }",
@@ -951,19 +1067,15 @@
       "Schema": {
         "$schema": "http://json-schema.org/draft-07/schema#",
         "additionalProperties": false,
-        "definitions": {
-          "Duration": {
-            "additionalProperties": false,
-            "description": "Represents a time duration that defaults to seconds but supports composite strings.",
-            "type": "number | string * Supported units:\n- seconds: `s`, `sec`, `secs`, `second`, `seconds`\n- minutes: `m`, `min`, `mins`, `minute`, `minutes`\n- hours: `h`, `hr`, `hour`, `hours`\n- days: `d`, `day`, `days`\n- months: `mo`, `mon`, `month`, `months` (assumed 30 days)\n- years: `y`, `yr`, `year`, `years` (assumed 365 days)\n\nExamples:\n- `10` → 10 seconds\n- `15s` → 15 seconds\n- `2m` → 120 seconds\n- `1d2h30m` → 1 day + 2 hours + 30 minutes\n- `1 d 2 h` → same as above (spaces allowed)"
-          }
-        },
         "description": "Parameters for KubernetesConfigurationService\nThrow error if default is set",
         "properties": {
           "checkInterval": {
-            "$ref": "#/definitions/Duration",
             "default": "1h",
-            "description": "Check configuration every {checkInterval} seconds"
+            "description": "Check configuration every {checkInterval} seconds",
+            "type": [
+              "number",
+              "string"
+            ]
           },
           "default": {
             "default": "{ services: {}, parameters: {} }",
@@ -1007,7 +1119,7 @@
         "description": "Parameters for the Mailer service configuration\n\nConfigures the email transport, templates directory and template engine",
         "properties": {
           "SES": {
-            "description": "SES AWS Bean if transport === \"ses\""
+            "description": "SES AWS Bean if transport === \"ses\"\n\nCredentials inside can be encrypted with `webda config encrypt`"
           },
           "emailTemplateOptions": {
             "see": "https://www.npmjs.com/package/email-templates"
@@ -1044,6 +1156,10 @@
           "type"
         ],
         "type": "object",
+        "x-webda-secret": [
+          "auth.pass",
+          "SES.credentials"
+        ],
         "title": "Mailer"
       },
       "Configuration": "lib/services/mailer.service:MailerParameters"
@@ -1211,6 +1327,16 @@
         },
         "description": "Memory store",
         "properties": {
+          "aggregationFallback": {
+            "default": "warn",
+            "description": "What to do when an aggregation on this store cannot run natively and must\nstream every matching object through memory",
+            "enum": [
+              "allow",
+              "warn",
+              "deny"
+            ],
+            "type": "string"
+          },
           "defaultModel": {
             "default": true,
             "description": "When __type model not found, use the model\nIf strict is setup this parameter is not used",
@@ -1221,6 +1347,12 @@
             "description": "If set, Store will ignore the __type",
             "type": "boolean"
           },
+          "maxGroups": {
+            "default": 10000,
+            "description": "Maximum number of groups an aggregation may produce without LIMIT (or in memory)",
+            "minimum": 1,
+            "type": "number"
+          },
           "modelAliases": {
             "$ref": "#/definitions/modelAliases",
             "description": "Model Aliases to allow easier rename of Model"
@@ -1432,6 +1564,11 @@
             ],
             "type": "string"
           },
+          "streamKeepAliveInterval": {
+            "default": 20000,
+            "description": "Milliseconds between two keep-alive comments on an open `text/event-stream` response of a server-streaming\noperation (0 disables them)",
+            "type": "number"
+          },
           "swaggerVersion": {
             "default": "5.31.0",
             "description": "Swagger version to use\n\nhttps://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui.css\nhttps://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui-bundle.js\nhttps://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui-standalone-preset.js\n\nTODO Add renovatebot regex",
@@ -1446,6 +1583,21 @@
             "description": "Base URL for the REST API",
             "type": "string"
           },
+          "webSocketMaxPayload": {
+            "default": 1048576,
+            "description": "Largest message (bytes) a client may send on a bidirectional WebSocket operation; a bigger one closes the socket",
+            "type": "number"
+          },
+          "webSocketMaxQueuedBytes": {
+            "default": 16777216,
+            "description": "Most bytes of unconsumed messages a bidirectional operation may have queued; above it the socket closes with 4413",
+            "type": "number"
+          },
+          "webSocketMaxQueuedMessages": {
+            "default": 1000,
+            "description": "Most unconsumed messages a bidirectional operation may have queued; above it the socket closes with 4413",
+            "type": "number"
+          },
           "openapi": {
             "type": "object",
             "additionalProperties": true
@@ -1756,12 +1908,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
-        "Queried"
+        "Queried",
+        "Aggregated"
       ],
       "PrimaryKey": [
         "uuid"
@@ -1942,12 +2096,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
-        "Queried"
+        "Queried",
+        "Aggregated"
       ],
       "PrimaryKey": [
         "uuid"
@@ -2026,12 +2182,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
-        "Queried"
+        "Queried",
+        "Aggregated"
       ],
       "PrimaryKey": [
         "uuid"
@@ -2367,12 +2525,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
-        "Queried"
+        "Queried",
+        "Aggregated"
       ],
       "PrimaryKey": [
         "providerUid",
@@ -2501,12 +2661,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
-        "Queried"
+        "Queried",
+        "Aggregated"
       ],
       "PrimaryKey": [
         "uuid"
@@ -2762,12 +2924,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
-        "Queried"
+        "Queried",
+        "Aggregated"
       ],
       "PrimaryKey": [
         "hash"
@@ -2846,12 +3010,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
-        "Queried"
+        "Queried",
+        "Aggregated"
       ],
       "PrimaryKey": [
         "uuid"
@@ -2896,12 +3062,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
-        "Queried"
+        "Queried",
+        "Aggregated"
       ],
       "PrimaryKey": [],
       "Identifier": "Webda/RoleModel"
@@ -3002,12 +3170,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
-        "Queried"
+        "Queried",
+        "Aggregated"
       ],
       "PrimaryKey": [
         "uuid"
@@ -3302,12 +3472,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
         "Queried",
+        "Aggregated",
         "Login",
         "Logout"
       ],
@@ -3541,12 +3713,14 @@
         "Update",
         "Patch",
         "Query",
+        "Aggregate",
         "Created",
         "PartialUpdated",
         "Deleted",
         "Patched",
         "Updated",
         "Queried",
+        "Aggregated",
         "Login",
         "Logout"
       ],