@techdocs/cli 1.9.3-next.0 → 1.9.3-next.2

package/dist/embedded-app/.config-schema.json

@@ -119,6 +119,10 @@
                 "description": "Whether authorization is enabled in Backstage. Defaults to false, which means authorization\nrequests will be automatically allowed without invoking the authorization policy.",
                 "visibility": "frontend",
                 "type": "boolean"
+              },
+              "EXPERIMENTAL_enableBatchedRequests": {
+                "visibility": "frontend",
+                "type": "boolean"
               }
             }
           }
@@ -354,6 +358,52 @@
       },
       "packageName": "@backstage/core-app-api"
     },
+    {
+      "path": "../core-components/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "auth": {
+            "type": "object",
+            "properties": {
+              "autologout": {
+                "description": "Autologout feature configuration",
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "description": "Enable or disable the autologout feature",
+                    "visibility": "frontend",
+                    "type": "boolean"
+                  },
+                  "idleTimeoutMinutes": {
+                    "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
+                    "visibility": "frontend",
+                    "type": "number"
+                  },
+                  "promptBeforeIdleSeconds": {
+                    "description": "Number of seconds before the idle timeout where the user will be asked if it's still active.\nA dialog will be shown.\nDefault is 10 seconds.\nSet to 0 seconds to disable the prompt.",
+                    "visibility": "frontend",
+                    "type": "number"
+                  },
+                  "useWorkerTimers": {
+                    "description": "Enable/disable the usage of worker thread timers instead of main thread timers.\nDefault is true.\nIf you experience some browser incompatibility, you may try to set this to false.",
+                    "visibility": "frontend",
+                    "type": "boolean"
+                  },
+                  "logoutIfDisconnected": {
+                    "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
+                    "visibility": "frontend",
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      },
+      "packageName": "@backstage/core-components"
+    },
     {
       "path": "../../plugins/techdocs/config.d.ts",
       "value": {
@@ -635,6 +685,11 @@
                       "visibility": "frontend",
                       "type": "string"
                     },
+                    "disableEditUrl": {
+                      "description": "Disable the edit url feature.",
+                      "visibility": "frontend",
+                      "type": "boolean"
+                    },
                     "username": {
                       "description": "The username to use for authenticated requests.",
                       "visibility": "secret",
@@ -1040,52 +1095,6 @@
       },
       "packageName": "@backstage/plugin-catalog"
     },
-    {
-      "path": "../core-components/config.d.ts",
-      "value": {
-        "type": "object",
-        "properties": {
-          "auth": {
-            "type": "object",
-            "properties": {
-              "autologout": {
-                "description": "Autologout feature configuration",
-                "type": "object",
-                "properties": {
-                  "enabled": {
-                    "description": "Enable or disable the autologout feature",
-                    "visibility": "frontend",
-                    "type": "boolean"
-                  },
-                  "idleTimeoutMinutes": {
-                    "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
-                    "visibility": "frontend",
-                    "type": "number"
-                  },
-                  "promptBeforeIdleSeconds": {
-                    "description": "Number of seconds before the idle timeout where the user will be asked if it's still active.\nA dialog will be shown.\nDefault is 10 seconds.\nSet to 0 seconds to disable the prompt.",
-                    "visibility": "frontend",
-                    "type": "number"
-                  },
-                  "useWorkerTimers": {
-                    "description": "Enable/disable the usage of worker thread timers instead of main thread timers.\nDefault is true.\nIf you experience some browser incompatibility, you may try to set this to false.",
-                    "visibility": "frontend",
-                    "type": "boolean"
-                  },
-                  "logoutIfDisconnected": {
-                    "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
-                    "visibility": "frontend",
-                    "type": "boolean"
-                  }
-                }
-              }
-            }
-          }
-        },
-        "$schema": "http://json-schema.org/draft-07/schema#"
-      },
-      "packageName": "@backstage/core-components"
-    },
     {
       "path": "../../node_modules/@backstage-community/plugin-stackstorm/config.d.ts",
       "value": {
@@ -1153,25 +1162,6 @@
       },
       "packageName": "@oriflame/backstage-plugin-score-card"
     },
-    {
-      "path": "../backend-plugin-api/config.d.ts",
-      "value": {
-        "type": "object",
-        "properties": {
-          "backend": {
-            "type": "object",
-            "properties": {
-              "workingDirectory": {
-                "description": "An absolute path to a directory that can be used as a working dir, for\nexample as scratch space for large operations.",
-                "type": "string"
-              }
-            }
-          }
-        },
-        "$schema": "http://json-schema.org/draft-07/schema#"
-      },
-      "packageName": "@backstage/backend-plugin-api"
-    },
     {
       "path": "../../plugins/auth-backend/config.d.ts",
       "value": {
@@ -1200,6 +1190,10 @@
                 "description": "JWS \"alg\" (Algorithm) Header Parameter value. Defaults to ES256.\nMust match one of the algorithms defined for IdentityClient.\nWhen setting a different algorithm, check if the `key` field\nof the `signing_keys` table can fit the length of the generated keys.\nIf not, add a knex migration file in the migrations folder.\nMore info on supported algorithms: https://github.com/panva/jose",
                 "type": "string"
               },
+              "omitIdentityTokenOwnershipClaim": {
+                "description": "Whether to omit the entity ownership references (`ent`) claim from the\nidentity token. If this is enabled the `ent` claim will only be available\nvia the user info endpoint and the `UserInfoService`.\n\nDefaults to `false`.",
+                "type": "boolean"
+              },
               "keyStore": {
                 "description": "To control how to store JWK data in auth-backend",
                 "type": "object",
@@ -1293,61 +1287,353 @@
                 "description": "Additional app origins to allow for authenticating",
                 "type": "array",
                 "items": {
-                  "type": "string"
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      },
+      "packageName": "@backstage/plugin-auth-backend"
+    },
+    {
+      "path": "../../plugins/auth-backend-module-guest-provider/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "auth": {
+            "description": "Configuration options for the auth plugin",
+            "type": "object",
+            "properties": {
+              "providers": {
+                "type": "object",
+                "properties": {
+                  "guest": {
+                    "type": "object",
+                    "properties": {
+                      "userEntityRef": {
+                        "description": "The entity reference to use for the guest user.",
+                        "default": "user:development/guest",
+                        "type": "string"
+                      },
+                      "ownershipEntityRefs": {
+                        "description": "A list of entity references to user for ownership of the guest user if the user\n is not found in the catalog.",
+                        "default": "[userEntityRef]",
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      },
+                      "dangerouslyAllowOutsideDevelopment": {
+                        "description": "Allow users to sign in with the guest provider outside of their development environments.",
+                        "type": "boolean"
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "required": [
+              "providers"
+            ]
+          }
+        },
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      },
+      "packageName": "@backstage/plugin-auth-backend-module-guest-provider"
+    },
+    {
+      "path": "../backend-plugin-api/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "backend": {
+            "type": "object",
+            "properties": {
+              "workingDirectory": {
+                "description": "An absolute path to a directory that can be used as a working dir, for\nexample as scratch space for large operations.",
+                "type": "string"
+              }
+            }
+          }
+        },
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      },
+      "packageName": "@backstage/backend-plugin-api"
+    },
+    {
+      "path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/core-components/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "auth": {
+            "type": "object",
+            "properties": {
+              "autologout": {
+                "description": "Autologout feature configuration",
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "description": "Enable or disable the autologout feature",
+                    "visibility": "frontend",
+                    "type": "boolean"
+                  },
+                  "idleTimeoutMinutes": {
+                    "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
+                    "visibility": "frontend",
+                    "type": "number"
+                  },
+                  "promptBeforeIdleSeconds": {
+                    "description": "Number of seconds before the idle timeout where the user will be asked if it's still active.\nA dialog will be shown.\nDefault is 10 seconds.\nSet to 0 seconds to disable the prompt.",
+                    "visibility": "frontend",
+                    "type": "number"
+                  },
+                  "useWorkerTimers": {
+                    "description": "Enable/disable the usage of worker thread timers instead of main thread timers.\nDefault is true.\nIf you experience some browser incompatibility, you may try to set this to false.",
+                    "visibility": "frontend",
+                    "type": "boolean"
+                  },
+                  "logoutIfDisconnected": {
+                    "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
+                    "visibility": "frontend",
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      },
+      "packageName": "@backstage/core-components"
+    },
+    {
+      "path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/core-app-api/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "app": {
+            "description": "Generic frontend configuration.",
+            "type": "object",
+            "properties": {
+              "baseUrl": {
+                "description": "The public absolute root URL that the frontend.",
+                "visibility": "frontend",
+                "type": "string"
+              },
+              "title": {
+                "description": "The title of the app, as shown in the Backstage web interface.",
+                "visibility": "frontend",
+                "type": "string"
+              },
+              "support": {
+                "description": "Information about support of this Backstage instance and how to contact the integrator team.",
+                "type": "object",
+                "properties": {
+                  "url": {
+                    "description": "The primary support url.",
+                    "visibility": "frontend",
+                    "type": "string"
+                  },
+                  "items": {
+                    "description": "A list of categorized support item groupings.",
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "title": {
+                          "description": "The title of the support item grouping.",
+                          "visibility": "frontend",
+                          "type": "string"
+                        },
+                        "icon": {
+                          "description": "An optional icon for the support item grouping.",
+                          "visibility": "frontend",
+                          "type": "string"
+                        },
+                        "links": {
+                          "description": "A list of support links for the Backstage instance inside this grouping.",
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "url": {
+                                "visibility": "frontend",
+                                "type": "string"
+                              },
+                              "title": {
+                                "visibility": "frontend",
+                                "type": "string"
+                              }
+                            },
+                            "required": [
+                              "url"
+                            ]
+                          }
+                        }
+                      },
+                      "required": [
+                        "links",
+                        "title"
+                      ]
+                    }
+                  }
+                },
+                "required": [
+                  "items",
+                  "url"
+                ]
+              },
+              "routes": {
+                "type": "object",
+                "properties": {
+                  "bindings": {
+                    "description": "Maps external route references to regular route references. Both the\nkey and the value is expected to be on the form `<pluginId>.<routeId>`.\nIf the value is `false`, the route will be disabled even if it has a\ndefault mapping.",
+                    "deepVisibility": "frontend",
+                    "type": "object",
+                    "additionalProperties": {
+                      "anyOf": [
+                        {
+                          "const": false,
+                          "type": "boolean"
+                        },
+                        {
+                          "type": "string"
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            },
+            "required": [
+              "baseUrl"
+            ]
+          },
+          "backend": {
+            "description": "Generic backend configuration.",
+            "type": "object",
+            "properties": {
+              "baseUrl": {
+                "description": "The public absolute root URL that the backend is reachable at, from the browser's perspective.",
+                "visibility": "frontend",
+                "type": "string"
+              }
+            },
+            "required": [
+              "baseUrl"
+            ]
+          },
+          "organization": {
+            "description": "Configuration that provides information about the organization that the app is for.",
+            "type": "object",
+            "properties": {
+              "name": {
+                "description": "The name of the organization that the app belongs to.",
+                "visibility": "frontend",
+                "type": "string"
+              }
+            }
+          },
+          "homepage": {
+            "description": "This config was used by the HomepageTimer but has been replaced  by the HeaderWorldClock in the home plugin",
+            "deprecated": "in favor of the HeaderWorldClock which is found in the home plugin",
+            "type": "object",
+            "properties": {
+              "clocks": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "label": {
+                      "visibility": "frontend",
+                      "type": "string"
+                    },
+                    "timezone": {
+                      "visibility": "frontend",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "label",
+                    "timezone"
+                  ]
                 }
               }
             }
-          }
-        },
-        "$schema": "http://json-schema.org/draft-07/schema#"
-      },
-      "packageName": "@backstage/plugin-auth-backend"
-    },
-    {
-      "path": "../../plugins/auth-backend-module-guest-provider/config.d.ts",
-      "value": {
-        "type": "object",
-        "properties": {
+          },
           "auth": {
-            "description": "Configuration options for the auth plugin",
+            "description": "Configuration that provides information on available configured authentication providers.",
             "type": "object",
             "properties": {
-              "providers": {
-                "type": "object",
-                "properties": {
-                  "guest": {
-                    "type": "object",
-                    "properties": {
-                      "userEntityRef": {
-                        "description": "The entity reference to use for the guest user.",
-                        "default": "user:development/guest",
-                        "type": "string"
-                      },
-                      "ownershipEntityRefs": {
-                        "description": "A list of entity references to user for ownership of the guest user if the user\n is not found in the catalog.",
-                        "default": "[userEntityRef]",
-                        "type": "array",
-                        "items": {
+              "environment": {
+                "description": "The 'environment' attribute added as an optional parameter to have configurable environment value for `auth.providers`.\ndefault value: 'development'\noptional values: 'development' | 'production'",
+                "visibility": "frontend",
+                "type": "string"
+              }
+            }
+          },
+          "enableExperimentalRedirectFlow": {
+            "description": "Enable redirect authentication flow type, instead of a popup for authentication.",
+            "visibility": "frontend",
+            "type": "boolean"
+          },
+          "discovery": {
+            "description": "Discovery options.",
+            "visibility": "frontend",
+            "type": "object",
+            "properties": {
+              "endpoints": {
+                "description": "Endpoints\n\nA list of target baseUrls and the associated plugins.",
+                "visibility": "frontend",
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "target": {
+                      "description": "The target baseUrl to use for the plugin\n\nCan be either a string or an object with internal and external keys. (Internal is used for the backend, external for the frontend)\nTargets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.",
+                      "visibility": "frontend",
+                      "anyOf": [
+                        {
+                          "type": "object",
+                          "properties": {
+                            "external": {
+                              "visibility": "frontend",
+                              "type": "string"
+                            }
+                          }
+                        },
+                        {
                           "type": "string"
                         }
-                      },
-                      "dangerouslyAllowOutsideDevelopment": {
-                        "description": "Allow users to sign in with the guest provider outside of their development environments.",
-                        "type": "boolean"
+                      ]
+                    },
+                    "plugins": {
+                      "description": "Array of plugins which use the target baseUrl.",
+                      "visibility": "frontend",
+                      "type": "array",
+                      "items": {
+                        "type": "string"
                       }
                     }
-                  }
+                  },
+                  "required": [
+                    "plugins",
+                    "target"
+                  ]
                 }
               }
-            },
-            "required": [
-              "providers"
-            ]
+            }
           }
         },
+        "required": [
+          "app",
+          "backend"
+        ],
         "$schema": "http://json-schema.org/draft-07/schema#"
       },
-      "packageName": "@backstage/plugin-auth-backend-module-guest-provider"
+      "packageName": "@backstage/core-app-api"
     },
     {
       "path": "../../node_modules/@backstage-community/plugin-stackstorm/node_modules/@backstage/core-components/config.d.ts",
@@ -1968,6 +2254,14 @@
                           "continue"
                         ],
                         "type": "string"
+                      },
+                      "onPluginModuleBootFailure": {
+                        "description": "The default value for `onPluginModuleBootFailure` if not specified for a particular plugin module.\nThis defaults to 'abort', which means `onPluginModuleBootFailure: continue` must be specified\nfor backend startup to continue on plugin module boot failure. This can also be set to\n'continue', which flips the logic for individual plugin modules so that they must be set to\n`onPluginModuleBootFailure: abort` to be required.",
+                        "enum": [
+                          "abort",
+                          "continue"
+                        ],
+                        "type": "string"
                       }
                     }
                   },
@@ -1983,6 +2277,22 @@
                             "continue"
                           ],
                           "type": "string"
+                        },
+                        "modules": {
+                          "type": "object",
+                          "additionalProperties": {
+                            "type": "object",
+                            "properties": {
+                              "onPluginModuleBootFailure": {
+                                "description": "Used to control backend startup behavior when this plugin module fails to boot up. Setting\nthis to `continue` allows the backend to continue starting up, even if this plugin\nmodule fails. This can enable leaving a crashing plugin installed, but still permit backend\nstartup, which may help troubleshoot data-dependent issues. Plugin module failures for plugin modules\nset to `abort` are fatal (this is the default unless overridden by the `default`\nsetting).",
+                                "enum": [
+                                  "abort",
+                                  "continue"
+                                ],
+                                "type": "string"
+                              }
+                            }
+                          }
                         }
                       }
                     }
@@ -2829,6 +3139,96 @@
                       "store"
                     ]
                   },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "store": {
+                        "type": "string",
+                        "const": "valkey"
+                      },
+                      "connection": {
+                        "description": "A valkey connection string in the form `redis://user:pass@host:port`.",
+                        "visibility": "secret",
+                        "type": "string"
+                      },
+                      "defaultTtl": {
+                        "description": "An optional default TTL (in milliseconds, if given as a number)."
+                      },
+                      "valkey": {
+                        "type": "object",
+                        "properties": {
+                          "client": {
+                            "description": "An optional Valkey client configuration.  These options are passed to the `@keyv/valkey` client.",
+                            "type": "object",
+                            "properties": {
+                              "namespace": {
+                                "description": "Namespace for the current instance.",
+                                "type": "string"
+                              },
+                              "keyPrefixSeparator": {
+                                "description": "Separator to use between namespace and key.",
+                                "type": "string"
+                              },
+                              "clearBatchSize": {
+                                "description": "Number of keys to delete in a single batch.",
+                                "type": "number"
+                              },
+                              "useUnlink": {
+                                "description": "Enable Unlink instead of using Del for clearing keys. This is more performant but may not be supported by all Redis versions.",
+                                "type": "boolean"
+                              },
+                              "noNamespaceAffectsAll": {
+                                "description": "Whether to allow clearing all keys when no namespace is set.\nIf set to true and no namespace is set, iterate() will return all keys.\nDefaults to `false`.",
+                                "type": "boolean"
+                              }
+                            }
+                          },
+                          "cluster": {
+                            "description": "An optional Valkey cluster (redis cluster under the hood) configuration.",
+                            "type": "object",
+                            "properties": {
+                              "rootNodes": {
+                                "description": "Cluster configuration options to be passed to the `@keyv/valkey` client (and node-redis under the hood)\nhttps://github.com/redis/node-redis/blob/master/docs/clustering.md",
+                                "visibility": "secret",
+                                "type": "array",
+                                "items": {
+                                  "type": "object",
+                                  "properties": {},
+                                  "additionalProperties": true
+                                }
+                              },
+                              "defaults": {
+                                "description": "Cluster node default configuration options to be passed to the `@keyv/redis` client (and node-redis under the hood)\nhttps://github.com/redis/node-redis/blob/master/docs/clustering.md",
+                                "visibility": "secret",
+                                "type": "object",
+                                "properties": {},
+                                "additionalProperties": true
+                              },
+                              "minimizeConnections": {
+                                "description": "When `true`, `.connect()` will only discover the cluster topology, without actually connecting to all the nodes.\nUseful for short-term or PubSub-only connections.",
+                                "type": "boolean"
+                              },
+                              "useReplicas": {
+                                "description": "When `true`, distribute load by executing readonly commands (such as `GET`, `GEOSEARCH`, etc.) across all cluster nodes. When `false`, only use master nodes.",
+                                "type": "boolean"
+                              },
+                              "maxCommandRedirections": {
+                                "description": "The maximum number of times a command will be redirected due to `MOVED` or `ASK` errors.",
+                                "type": "number"
+                              }
+                            },
+                            "required": [
+                              "rootNodes"
+                            ]
+                          }
+                        }
+                      }
+                    },
+                    "required": [
+                      "connection",
+                      "store"
+                    ]
+                  },
                   {
                     "type": "object",
                     "properties": {
@@ -3182,6 +3582,27 @@
       },
       "packageName": "@backstage/plugin-auth-backend-module-google-provider"
     },
+    {
+      "path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/plugin-permission-common/config.d.ts",
+      "value": {
+        "type": "object",
+        "properties": {
+          "permission": {
+            "description": "Configuration options for Backstage permissions and authorization",
+            "type": "object",
+            "properties": {
+              "enabled": {
+                "description": "Whether authorization is enabled in Backstage. Defaults to false, which means authorization\nrequests will be automatically allowed without invoking the authorization policy.",
+                "visibility": "frontend",
+                "type": "boolean"
+              }
+            }
+          }
+        },
+        "$schema": "http://json-schema.org/draft-07/schema#"
+      },
+      "packageName": "@backstage/plugin-permission-common"
+    },
     {
       "path": "../integration-aws-node/config.d.ts",
       "value": {