@techdocs/cli 0.0.0-nightly-20240807021931 → 0.0.0-nightly-20240809021939
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.
- package/CHANGELOG.md +3 -3
- package/dist/embedded-app/.config-schema.json +132 -132
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# @techdocs/cli
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20240809021939
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
7
|
- Updated dependencies
|
|
8
|
-
- @backstage/backend-defaults@0.0.0-nightly-
|
|
9
|
-
- @backstage/plugin-techdocs-node@0.0.0-nightly-
|
|
8
|
+
- @backstage/backend-defaults@0.0.0-nightly-20240809021939
|
|
9
|
+
- @backstage/plugin-techdocs-node@0.0.0-nightly-20240809021939
|
|
10
10
|
- @backstage/catalog-model@1.5.0
|
|
11
11
|
- @backstage/cli-common@0.1.14
|
|
12
12
|
- @backstage/config@1.2.0
|
|
@@ -125,51 +125,6 @@
|
|
|
125
125
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
126
126
|
}
|
|
127
127
|
},
|
|
128
|
-
{
|
|
129
|
-
"path": "../core-components/config.d.ts",
|
|
130
|
-
"value": {
|
|
131
|
-
"type": "object",
|
|
132
|
-
"properties": {
|
|
133
|
-
"auth": {
|
|
134
|
-
"type": "object",
|
|
135
|
-
"properties": {
|
|
136
|
-
"autologout": {
|
|
137
|
-
"description": "Autologout feature configuration",
|
|
138
|
-
"type": "object",
|
|
139
|
-
"properties": {
|
|
140
|
-
"enabled": {
|
|
141
|
-
"description": "Enable or disable the autologout feature",
|
|
142
|
-
"visibility": "frontend",
|
|
143
|
-
"type": "boolean"
|
|
144
|
-
},
|
|
145
|
-
"idleTimeoutMinutes": {
|
|
146
|
-
"description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
|
|
147
|
-
"visibility": "frontend",
|
|
148
|
-
"type": "number"
|
|
149
|
-
},
|
|
150
|
-
"promptBeforeIdleSeconds": {
|
|
151
|
-
"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.",
|
|
152
|
-
"visibility": "frontend",
|
|
153
|
-
"type": "number"
|
|
154
|
-
},
|
|
155
|
-
"useWorkerTimers": {
|
|
156
|
-
"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.",
|
|
157
|
-
"visibility": "frontend",
|
|
158
|
-
"type": "boolean"
|
|
159
|
-
},
|
|
160
|
-
"logoutIfDisconnected": {
|
|
161
|
-
"description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
|
|
162
|
-
"visibility": "frontend",
|
|
163
|
-
"type": "boolean"
|
|
164
|
-
}
|
|
165
|
-
}
|
|
166
|
-
}
|
|
167
|
-
}
|
|
168
|
-
}
|
|
169
|
-
},
|
|
170
|
-
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
171
|
-
}
|
|
172
|
-
},
|
|
173
128
|
{
|
|
174
129
|
"path": "../core-app-api/config.d.ts",
|
|
175
130
|
"value": {
|
|
@@ -399,6 +354,51 @@
|
|
|
399
354
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
400
355
|
}
|
|
401
356
|
},
|
|
357
|
+
{
|
|
358
|
+
"path": "../core-components/config.d.ts",
|
|
359
|
+
"value": {
|
|
360
|
+
"type": "object",
|
|
361
|
+
"properties": {
|
|
362
|
+
"auth": {
|
|
363
|
+
"type": "object",
|
|
364
|
+
"properties": {
|
|
365
|
+
"autologout": {
|
|
366
|
+
"description": "Autologout feature configuration",
|
|
367
|
+
"type": "object",
|
|
368
|
+
"properties": {
|
|
369
|
+
"enabled": {
|
|
370
|
+
"description": "Enable or disable the autologout feature",
|
|
371
|
+
"visibility": "frontend",
|
|
372
|
+
"type": "boolean"
|
|
373
|
+
},
|
|
374
|
+
"idleTimeoutMinutes": {
|
|
375
|
+
"description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
|
|
376
|
+
"visibility": "frontend",
|
|
377
|
+
"type": "number"
|
|
378
|
+
},
|
|
379
|
+
"promptBeforeIdleSeconds": {
|
|
380
|
+
"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.",
|
|
381
|
+
"visibility": "frontend",
|
|
382
|
+
"type": "number"
|
|
383
|
+
},
|
|
384
|
+
"useWorkerTimers": {
|
|
385
|
+
"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.",
|
|
386
|
+
"visibility": "frontend",
|
|
387
|
+
"type": "boolean"
|
|
388
|
+
},
|
|
389
|
+
"logoutIfDisconnected": {
|
|
390
|
+
"description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
|
|
391
|
+
"visibility": "frontend",
|
|
392
|
+
"type": "boolean"
|
|
393
|
+
}
|
|
394
|
+
}
|
|
395
|
+
}
|
|
396
|
+
}
|
|
397
|
+
}
|
|
398
|
+
},
|
|
399
|
+
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
400
|
+
}
|
|
401
|
+
},
|
|
402
402
|
{
|
|
403
403
|
"path": "../../plugins/techdocs/config.d.ts",
|
|
404
404
|
"value": {
|
|
@@ -1508,7 +1508,7 @@
|
|
|
1508
1508
|
}
|
|
1509
1509
|
},
|
|
1510
1510
|
{
|
|
1511
|
-
"path": "../../node_modules/@backstage-community/plugin-
|
|
1511
|
+
"path": "../../node_modules/@backstage-community/plugin-stackstorm/node_modules/@backstage/core-components/config.d.ts",
|
|
1512
1512
|
"value": {
|
|
1513
1513
|
"type": "object",
|
|
1514
1514
|
"properties": {
|
|
@@ -1707,7 +1707,7 @@
|
|
|
1707
1707
|
}
|
|
1708
1708
|
},
|
|
1709
1709
|
{
|
|
1710
|
-
"path": "../backend-
|
|
1710
|
+
"path": "../backend-app-api/config.d.ts",
|
|
1711
1711
|
"value": {
|
|
1712
1712
|
"type": "object",
|
|
1713
1713
|
"properties": {
|
|
@@ -1715,7 +1715,6 @@
|
|
|
1715
1715
|
"type": "object",
|
|
1716
1716
|
"properties": {
|
|
1717
1717
|
"auth": {
|
|
1718
|
-
"description": "Options used by the default auth, httpAuth and userInfo services.",
|
|
1719
1718
|
"type": "object",
|
|
1720
1719
|
"properties": {
|
|
1721
1720
|
"dangerouslyDisableDefaultAuthPolicy": {
|
|
@@ -2023,56 +2022,6 @@
|
|
|
2023
2022
|
"required": [
|
|
2024
2023
|
"url"
|
|
2025
2024
|
]
|
|
2026
|
-
},
|
|
2027
|
-
"accessRestrictions": {
|
|
2028
|
-
"description": "Restricts what types of access that are permitted for this access\nmethod. If no access restrictions are given, it'll have unlimited\naccess. This access restriction applies for the framework level;\nindividual plugins may have their own access control mechanisms\non top of this.",
|
|
2029
|
-
"type": "array",
|
|
2030
|
-
"items": {
|
|
2031
|
-
"type": "object",
|
|
2032
|
-
"properties": {
|
|
2033
|
-
"plugin": {
|
|
2034
|
-
"description": "Permit access to make requests to this plugin.\n\nCan be further refined by setting additional fields below.",
|
|
2035
|
-
"type": "string"
|
|
2036
|
-
},
|
|
2037
|
-
"permission": {
|
|
2038
|
-
"description": "If given, this method is limited to only performing actions\nwith these named permissions in this plugin.\n\nNote that this only applies where permissions checks are\nenabled in the first place. Endpoints that are not protected by\nthe permissions system at all, are not affected by this\nsetting.",
|
|
2039
|
-
"anyOf": [
|
|
2040
|
-
{
|
|
2041
|
-
"type": "array",
|
|
2042
|
-
"items": {
|
|
2043
|
-
"type": "string"
|
|
2044
|
-
}
|
|
2045
|
-
},
|
|
2046
|
-
{
|
|
2047
|
-
"type": "string"
|
|
2048
|
-
}
|
|
2049
|
-
]
|
|
2050
|
-
},
|
|
2051
|
-
"permissionAttribute": {
|
|
2052
|
-
"description": "If given, this method is limited to only performing actions\nwhose permissions have these attributes.\n\nNote that this only applies where permissions checks are\nenabled in the first place. Endpoints that are not protected by\nthe permissions system at all, are not affected by this\nsetting.",
|
|
2053
|
-
"type": "object",
|
|
2054
|
-
"properties": {
|
|
2055
|
-
"action": {
|
|
2056
|
-
"description": "One of more of 'create', 'read', 'update', or 'delete'.",
|
|
2057
|
-
"anyOf": [
|
|
2058
|
-
{
|
|
2059
|
-
"type": "array",
|
|
2060
|
-
"items": {
|
|
2061
|
-
"type": "string"
|
|
2062
|
-
}
|
|
2063
|
-
},
|
|
2064
|
-
{
|
|
2065
|
-
"type": "string"
|
|
2066
|
-
}
|
|
2067
|
-
]
|
|
2068
|
-
}
|
|
2069
|
-
}
|
|
2070
|
-
}
|
|
2071
|
-
},
|
|
2072
|
-
"required": [
|
|
2073
|
-
"plugin"
|
|
2074
|
-
]
|
|
2075
|
-
}
|
|
2076
2025
|
}
|
|
2077
2026
|
},
|
|
2078
2027
|
"required": [
|
|
@@ -2087,21 +2036,46 @@
|
|
|
2087
2036
|
"required": [
|
|
2088
2037
|
"externalAccess"
|
|
2089
2038
|
]
|
|
2039
|
+
},
|
|
2040
|
+
"packages": {
|
|
2041
|
+
"anyOf": [
|
|
2042
|
+
{
|
|
2043
|
+
"type": "object",
|
|
2044
|
+
"properties": {
|
|
2045
|
+
"include": {
|
|
2046
|
+
"type": "array",
|
|
2047
|
+
"items": {
|
|
2048
|
+
"type": "string"
|
|
2049
|
+
}
|
|
2050
|
+
},
|
|
2051
|
+
"exclude": {
|
|
2052
|
+
"type": "array",
|
|
2053
|
+
"items": {
|
|
2054
|
+
"type": "string"
|
|
2055
|
+
}
|
|
2056
|
+
}
|
|
2057
|
+
}
|
|
2058
|
+
},
|
|
2059
|
+
{
|
|
2060
|
+
"const": "all",
|
|
2061
|
+
"type": "string"
|
|
2062
|
+
}
|
|
2063
|
+
]
|
|
2090
2064
|
}
|
|
2091
2065
|
}
|
|
2092
2066
|
},
|
|
2093
2067
|
"discovery": {
|
|
2094
|
-
"description": "
|
|
2068
|
+
"description": "Discovery options.",
|
|
2095
2069
|
"type": "object",
|
|
2096
2070
|
"properties": {
|
|
2097
2071
|
"endpoints": {
|
|
2098
|
-
"description": "
|
|
2072
|
+
"description": "Endpoints\n\nA list of target baseUrls and the associated plugins.",
|
|
2099
2073
|
"type": "array",
|
|
2100
2074
|
"items": {
|
|
2101
2075
|
"type": "object",
|
|
2102
2076
|
"properties": {
|
|
2103
2077
|
"target": {
|
|
2104
|
-
"description": "The target
|
|
2078
|
+
"description": "The target baseUrl to use for the plugin\n\nCan be either a string or an object with internal and external keys.\nTargets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.",
|
|
2105
2079
|
"anyOf": [
|
|
2106
2080
|
{
|
|
2107
2081
|
"type": "object",
|
|
@@ -2124,7 +2098,7 @@
|
|
|
2124
2098
|
]
|
|
2125
2099
|
},
|
|
2126
2100
|
"plugins": {
|
|
2127
|
-
"description": "Array of plugins which use the target
|
|
2101
|
+
"description": "Array of plugins which use the target baseUrl.",
|
|
2128
2102
|
"type": "array",
|
|
2129
2103
|
"items": {
|
|
2130
2104
|
"type": "string"
|
|
@@ -2147,7 +2121,7 @@
|
|
|
2147
2121
|
}
|
|
2148
2122
|
},
|
|
2149
2123
|
{
|
|
2150
|
-
"path": "../backend-
|
|
2124
|
+
"path": "../backend-defaults/config.d.ts",
|
|
2151
2125
|
"value": {
|
|
2152
2126
|
"type": "object",
|
|
2153
2127
|
"properties": {
|
|
@@ -2155,6 +2129,7 @@
|
|
|
2155
2129
|
"type": "object",
|
|
2156
2130
|
"properties": {
|
|
2157
2131
|
"auth": {
|
|
2132
|
+
"description": "Options used by the default auth, httpAuth and userInfo services.",
|
|
2158
2133
|
"type": "object",
|
|
2159
2134
|
"properties": {
|
|
2160
2135
|
"dangerouslyDisableDefaultAuthPolicy": {
|
|
@@ -2462,6 +2437,56 @@
|
|
|
2462
2437
|
"required": [
|
|
2463
2438
|
"url"
|
|
2464
2439
|
]
|
|
2440
|
+
},
|
|
2441
|
+
"accessRestrictions": {
|
|
2442
|
+
"description": "Restricts what types of access that are permitted for this access\nmethod. If no access restrictions are given, it'll have unlimited\naccess. This access restriction applies for the framework level;\nindividual plugins may have their own access control mechanisms\non top of this.",
|
|
2443
|
+
"type": "array",
|
|
2444
|
+
"items": {
|
|
2445
|
+
"type": "object",
|
|
2446
|
+
"properties": {
|
|
2447
|
+
"plugin": {
|
|
2448
|
+
"description": "Permit access to make requests to this plugin.\n\nCan be further refined by setting additional fields below.",
|
|
2449
|
+
"type": "string"
|
|
2450
|
+
},
|
|
2451
|
+
"permission": {
|
|
2452
|
+
"description": "If given, this method is limited to only performing actions\nwith these named permissions in this plugin.\n\nNote that this only applies where permissions checks are\nenabled in the first place. Endpoints that are not protected by\nthe permissions system at all, are not affected by this\nsetting.",
|
|
2453
|
+
"anyOf": [
|
|
2454
|
+
{
|
|
2455
|
+
"type": "array",
|
|
2456
|
+
"items": {
|
|
2457
|
+
"type": "string"
|
|
2458
|
+
}
|
|
2459
|
+
},
|
|
2460
|
+
{
|
|
2461
|
+
"type": "string"
|
|
2462
|
+
}
|
|
2463
|
+
]
|
|
2464
|
+
},
|
|
2465
|
+
"permissionAttribute": {
|
|
2466
|
+
"description": "If given, this method is limited to only performing actions\nwhose permissions have these attributes.\n\nNote that this only applies where permissions checks are\nenabled in the first place. Endpoints that are not protected by\nthe permissions system at all, are not affected by this\nsetting.",
|
|
2467
|
+
"type": "object",
|
|
2468
|
+
"properties": {
|
|
2469
|
+
"action": {
|
|
2470
|
+
"description": "One of more of 'create', 'read', 'update', or 'delete'.",
|
|
2471
|
+
"anyOf": [
|
|
2472
|
+
{
|
|
2473
|
+
"type": "array",
|
|
2474
|
+
"items": {
|
|
2475
|
+
"type": "string"
|
|
2476
|
+
}
|
|
2477
|
+
},
|
|
2478
|
+
{
|
|
2479
|
+
"type": "string"
|
|
2480
|
+
}
|
|
2481
|
+
]
|
|
2482
|
+
}
|
|
2483
|
+
}
|
|
2484
|
+
}
|
|
2485
|
+
},
|
|
2486
|
+
"required": [
|
|
2487
|
+
"plugin"
|
|
2488
|
+
]
|
|
2489
|
+
}
|
|
2465
2490
|
}
|
|
2466
2491
|
},
|
|
2467
2492
|
"required": [
|
|
@@ -2476,46 +2501,21 @@
|
|
|
2476
2501
|
"required": [
|
|
2477
2502
|
"externalAccess"
|
|
2478
2503
|
]
|
|
2479
|
-
},
|
|
2480
|
-
"packages": {
|
|
2481
|
-
"anyOf": [
|
|
2482
|
-
{
|
|
2483
|
-
"type": "object",
|
|
2484
|
-
"properties": {
|
|
2485
|
-
"include": {
|
|
2486
|
-
"type": "array",
|
|
2487
|
-
"items": {
|
|
2488
|
-
"type": "string"
|
|
2489
|
-
}
|
|
2490
|
-
},
|
|
2491
|
-
"exclude": {
|
|
2492
|
-
"type": "array",
|
|
2493
|
-
"items": {
|
|
2494
|
-
"type": "string"
|
|
2495
|
-
}
|
|
2496
|
-
}
|
|
2497
|
-
}
|
|
2498
|
-
},
|
|
2499
|
-
{
|
|
2500
|
-
"const": "all",
|
|
2501
|
-
"type": "string"
|
|
2502
|
-
}
|
|
2503
|
-
]
|
|
2504
2504
|
}
|
|
2505
2505
|
}
|
|
2506
2506
|
},
|
|
2507
2507
|
"discovery": {
|
|
2508
|
-
"description": "
|
|
2508
|
+
"description": "Options used by the default discovery service.",
|
|
2509
2509
|
"type": "object",
|
|
2510
2510
|
"properties": {
|
|
2511
2511
|
"endpoints": {
|
|
2512
|
-
"description": "
|
|
2512
|
+
"description": "A list of target baseUrls and the associated plugins.",
|
|
2513
2513
|
"type": "array",
|
|
2514
2514
|
"items": {
|
|
2515
2515
|
"type": "object",
|
|
2516
2516
|
"properties": {
|
|
2517
2517
|
"target": {
|
|
2518
|
-
"description": "The target
|
|
2518
|
+
"description": "The target base URL to use for the plugin.\n\nCan be either a string or an object with internal and external keys.\nTargets with `{{pluginId}}` or `{{ pluginId }} in the URL will be replaced with the plugin ID.",
|
|
2519
2519
|
"anyOf": [
|
|
2520
2520
|
{
|
|
2521
2521
|
"type": "object",
|
|
@@ -2538,7 +2538,7 @@
|
|
|
2538
2538
|
]
|
|
2539
2539
|
},
|
|
2540
2540
|
"plugins": {
|
|
2541
|
-
"description": "Array of plugins which use the target
|
|
2541
|
+
"description": "Array of plugins which use the target base URL.",
|
|
2542
2542
|
"type": "array",
|
|
2543
2543
|
"items": {
|
|
2544
2544
|
"type": "string"
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@techdocs/cli",
|
|
3
3
|
"description": "Utility CLI for managing TechDocs sites in Backstage.",
|
|
4
|
-
"version": "0.0.0-nightly-
|
|
4
|
+
"version": "0.0.0-nightly-20240809021939",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
7
7
|
},
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"techdocs-cli": "bin/techdocs-cli"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@backstage/cli": "^0.0.0-nightly-
|
|
38
|
+
"@backstage/cli": "^0.0.0-nightly-20240809021939",
|
|
39
39
|
"@types/commander": "^2.12.2",
|
|
40
40
|
"@types/fs-extra": "^11.0.0",
|
|
41
41
|
"@types/http-proxy": "^1.17.4",
|
|
@@ -56,11 +56,11 @@
|
|
|
56
56
|
"ext": "ts"
|
|
57
57
|
},
|
|
58
58
|
"dependencies": {
|
|
59
|
-
"@backstage/backend-defaults": "^0.0.0-nightly-
|
|
59
|
+
"@backstage/backend-defaults": "^0.0.0-nightly-20240809021939",
|
|
60
60
|
"@backstage/catalog-model": "^1.5.0",
|
|
61
61
|
"@backstage/cli-common": "^0.1.14",
|
|
62
62
|
"@backstage/config": "^1.2.0",
|
|
63
|
-
"@backstage/plugin-techdocs-node": "^0.0.0-nightly-
|
|
63
|
+
"@backstage/plugin-techdocs-node": "^0.0.0-nightly-20240809021939",
|
|
64
64
|
"commander": "^12.0.0",
|
|
65
65
|
"fs-extra": "^11.0.0",
|
|
66
66
|
"global-agent": "^3.0.0",
|