@techdocs/cli 0.0.0-nightly-20240720021712 → 0.0.0-nightly-20240721021945

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/CHANGELOG.md +3 -3
  2. package/dist/embedded-app/.config-schema.json +210 -210
  3. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,15 +1,15 @@
1
1
  # @techdocs/cli
2
2
 
3
- ## 0.0.0-nightly-20240720021712
3
+ ## 0.0.0-nightly-20240721021945
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - Updated dependencies
8
- - @backstage/backend-defaults@0.0.0-nightly-20240720021712
8
+ - @backstage/backend-defaults@0.0.0-nightly-20240721021945
9
9
  - @backstage/catalog-model@1.5.0
10
10
  - @backstage/cli-common@0.1.14
11
11
  - @backstage/config@1.2.0
12
- - @backstage/plugin-techdocs-node@0.0.0-nightly-20240720021712
12
+ - @backstage/plugin-techdocs-node@0.0.0-nightly-20240721021945
13
13
 
14
14
  ## 1.8.16
15
15
 
package/dist/embedded-app/.config-schema.json CHANGED
@@ -125,6 +125,96 @@
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
+ {
174
+ "path": "../../plugins/techdocs/config.d.ts",
175
+ "value": {
176
+ "type": "object",
177
+ "properties": {
178
+ "techdocs": {
179
+ "description": "Configuration options for the techdocs plugin",
180
+ "type": "object",
181
+ "properties": {
182
+ "builder": {
183
+ "description": "Documentation building process depends on the builder attr",
184
+ "visibility": "frontend",
185
+ "enum": [
186
+ "external",
187
+ "local"
188
+ ],
189
+ "type": "string"
190
+ },
191
+ "legacyUseCaseSensitiveTripletPaths": {
192
+ "description": "Allows fallback to case-sensitive triplets in case of migration issues.",
193
+ "visibility": "frontend",
194
+ "type": "boolean"
195
+ },
196
+ "sanitizer": {
197
+ "type": "object",
198
+ "properties": {
199
+ "allowedIframeHosts": {
200
+ "description": "Allows iframe tag only for listed hosts\nExample:\n allowedIframeHosts: [\"example.com\"]\n this will allow all iframes with the host `example.com` in the src attribute",
201
+ "visibility": "frontend",
202
+ "type": "array",
203
+ "items": {
204
+ "type": "string"
205
+ }
206
+ }
207
+ }
208
+ }
209
+ }
210
+ }
211
+ },
212
+ "required": [
213
+ "techdocs"
214
+ ],
215
+ "$schema": "http://json-schema.org/draft-07/schema#"
216
+ }
217
+ },
128
218
  {
129
219
  "path": "../core-app-api/config.d.ts",
130
220
  "value": {
@@ -354,96 +444,6 @@
354
444
  "$schema": "http://json-schema.org/draft-07/schema#"
355
445
  }
356
446
  },
357
- {
358
- "path": "../../plugins/techdocs/config.d.ts",
359
- "value": {
360
- "type": "object",
361
- "properties": {
362
- "techdocs": {
363
- "description": "Configuration options for the techdocs plugin",
364
- "type": "object",
365
- "properties": {
366
- "builder": {
367
- "description": "Documentation building process depends on the builder attr",
368
- "visibility": "frontend",
369
- "enum": [
370
- "external",
371
- "local"
372
- ],
373
- "type": "string"
374
- },
375
- "legacyUseCaseSensitiveTripletPaths": {
376
- "description": "Allows fallback to case-sensitive triplets in case of migration issues.",
377
- "visibility": "frontend",
378
- "type": "boolean"
379
- },
380
- "sanitizer": {
381
- "type": "object",
382
- "properties": {
383
- "allowedIframeHosts": {
384
- "description": "Allows iframe tag only for listed hosts\nExample:\n allowedIframeHosts: [\"example.com\"]\n this will allow all iframes with the host `example.com` in the src attribute",
385
- "visibility": "frontend",
386
- "type": "array",
387
- "items": {
388
- "type": "string"
389
- }
390
- }
391
- }
392
- }
393
- }
394
- }
395
- },
396
- "required": [
397
- "techdocs"
398
- ],
399
- "$schema": "http://json-schema.org/draft-07/schema#"
400
- }
401
- },
402
- {
403
- "path": "../core-components/config.d.ts",
404
- "value": {
405
- "type": "object",
406
- "properties": {
407
- "auth": {
408
- "type": "object",
409
- "properties": {
410
- "autologout": {
411
- "description": "Autologout feature configuration",
412
- "type": "object",
413
- "properties": {
414
- "enabled": {
415
- "description": "Enable or disable the autologout feature",
416
- "visibility": "frontend",
417
- "type": "boolean"
418
- },
419
- "idleTimeoutMinutes": {
420
- "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
421
- "visibility": "frontend",
422
- "type": "number"
423
- },
424
- "promptBeforeIdleSeconds": {
425
- "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.",
426
- "visibility": "frontend",
427
- "type": "number"
428
- },
429
- "useWorkerTimers": {
430
- "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.",
431
- "visibility": "frontend",
432
- "type": "boolean"
433
- },
434
- "logoutIfDisconnected": {
435
- "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
436
- "visibility": "frontend",
437
- "type": "boolean"
438
- }
439
- }
440
- }
441
- }
442
- }
443
- },
444
- "$schema": "http://json-schema.org/draft-07/schema#"
445
- }
446
- },
447
447
  {
448
448
  "path": "../integration/config.d.ts",
449
449
  "value": {
@@ -1553,7 +1553,116 @@
1553
1553
  }
1554
1554
  },
1555
1555
  {
1556
- "path": "../backend-defaults/config.d.ts",
1556
+ "path": "../integration-aws-node/config.d.ts",
1557
+ "value": {
1558
+ "type": "object",
1559
+ "properties": {
1560
+ "aws": {
1561
+ "description": "Configuration for access to AWS accounts",
1562
+ "type": "object",
1563
+ "properties": {
1564
+ "accountDefaults": {
1565
+ "description": "Defaults for retrieving AWS account credentials",
1566
+ "type": "object",
1567
+ "properties": {
1568
+ "roleName": {
1569
+ "description": "The IAM role to assume to retrieve temporary AWS credentials",
1570
+ "type": "string"
1571
+ },
1572
+ "partition": {
1573
+ "description": "The AWS partition of the IAM role, e.g. \"aws\", \"aws-cn\"",
1574
+ "type": "string"
1575
+ },
1576
+ "region": {
1577
+ "description": "The STS regional endpoint to use when retrieving temporary AWS credentials, e.g. \"ap-northeast-1\"",
1578
+ "type": "string"
1579
+ },
1580
+ "externalId": {
1581
+ "description": "The unique identifier needed to assume the role to retrieve temporary AWS credentials",
1582
+ "visibility": "secret",
1583
+ "type": "string"
1584
+ }
1585
+ }
1586
+ },
1587
+ "mainAccount": {
1588
+ "description": "Main account to use for retrieving AWS account credentials",
1589
+ "type": "object",
1590
+ "properties": {
1591
+ "accessKeyId": {
1592
+ "description": "The access key ID for a set of static AWS credentials",
1593
+ "visibility": "secret",
1594
+ "type": "string"
1595
+ },
1596
+ "secretAccessKey": {
1597
+ "description": "The secret access key for a set of static AWS credentials",
1598
+ "visibility": "secret",
1599
+ "type": "string"
1600
+ },
1601
+ "profile": {
1602
+ "description": "The configuration profile from a credentials file at ~/.aws/credentials and\na configuration file at ~/.aws/config.",
1603
+ "type": "string"
1604
+ },
1605
+ "region": {
1606
+ "description": "The STS regional endpoint to use for the main account, e.g. \"ap-northeast-1\"",
1607
+ "type": "string"
1608
+ }
1609
+ }
1610
+ },
1611
+ "accounts": {
1612
+ "description": "Configuration for retrieving AWS accounts credentials",
1613
+ "type": "array",
1614
+ "items": {
1615
+ "type": "object",
1616
+ "properties": {
1617
+ "accountId": {
1618
+ "description": "The account ID of the target account that this matches on, e.g. \"123456789012\"",
1619
+ "type": "string"
1620
+ },
1621
+ "accessKeyId": {
1622
+ "description": "The access key ID for a set of static AWS credentials",
1623
+ "visibility": "secret",
1624
+ "type": "string"
1625
+ },
1626
+ "secretAccessKey": {
1627
+ "description": "The secret access key for a set of static AWS credentials",
1628
+ "visibility": "secret",
1629
+ "type": "string"
1630
+ },
1631
+ "profile": {
1632
+ "description": "The configuration profile from a credentials file at ~/.aws/credentials and\na configuration file at ~/.aws/config.",
1633
+ "type": "string"
1634
+ },
1635
+ "roleName": {
1636
+ "description": "The IAM role to assume to retrieve temporary AWS credentials",
1637
+ "type": "string"
1638
+ },
1639
+ "partition": {
1640
+ "description": "The AWS partition of the IAM role, e.g. \"aws\", \"aws-cn\"",
1641
+ "type": "string"
1642
+ },
1643
+ "region": {
1644
+ "description": "The STS regional endpoint to use when retrieving temporary AWS credentials, e.g. \"ap-northeast-1\"",
1645
+ "type": "string"
1646
+ },
1647
+ "externalId": {
1648
+ "description": "The unique identifier needed to assume the role to retrieve temporary AWS credentials",
1649
+ "visibility": "secret",
1650
+ "type": "string"
1651
+ }
1652
+ },
1653
+ "required": [
1654
+ "accountId"
1655
+ ]
1656
+ }
1657
+ }
1658
+ }
1659
+ }
1660
+ },
1661
+ "$schema": "http://json-schema.org/draft-07/schema#"
1662
+ }
1663
+ },
1664
+ {
1665
+ "path": "../backend-app-api/config.d.ts",
1557
1666
  "value": {
1558
1667
  "type": "object",
1559
1668
  "properties": {
@@ -1561,7 +1670,6 @@
1561
1670
  "type": "object",
1562
1671
  "properties": {
1563
1672
  "auth": {
1564
- "description": "Options used by the default auth, httpAuth and userInfo services.",
1565
1673
  "type": "object",
1566
1674
  "properties": {
1567
1675
  "dangerouslyDisableDefaultAuthPolicy": {
@@ -1887,17 +1995,17 @@
1887
1995
  }
1888
1996
  },
1889
1997
  "discovery": {
1890
- "description": "Options used by the default discovery service.",
1998
+ "description": "Discovery options.",
1891
1999
  "type": "object",
1892
2000
  "properties": {
1893
2001
  "endpoints": {
1894
- "description": "A list of target baseUrls and the associated plugins.",
2002
+ "description": "Endpoints\n\nA list of target baseUrls and the associated plugins.",
1895
2003
  "type": "array",
1896
2004
  "items": {
1897
2005
  "type": "object",
1898
2006
  "properties": {
1899
2007
  "target": {
1900
- "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.",
2008
+ "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.",
1901
2009
  "anyOf": [
1902
2010
  {
1903
2011
  "type": "object",
@@ -1920,7 +2028,7 @@
1920
2028
  ]
1921
2029
  },
1922
2030
  "plugins": {
1923
- "description": "Array of plugins which use the target base URL.",
2031
+ "description": "Array of plugins which use the target baseUrl.",
1924
2032
  "type": "array",
1925
2033
  "items": {
1926
2034
  "type": "string"
@@ -1943,7 +2051,7 @@
1943
2051
  }
1944
2052
  },
1945
2053
  {
1946
- "path": "../backend-app-api/config.d.ts",
2054
+ "path": "../backend-defaults/config.d.ts",
1947
2055
  "value": {
1948
2056
  "type": "object",
1949
2057
  "properties": {
@@ -1951,6 +2059,7 @@
1951
2059
  "type": "object",
1952
2060
  "properties": {
1953
2061
  "auth": {
2062
+ "description": "Options used by the default auth, httpAuth and userInfo services.",
1954
2063
  "type": "object",
1955
2064
  "properties": {
1956
2065
  "dangerouslyDisableDefaultAuthPolicy": {
@@ -2276,17 +2385,17 @@
2276
2385
  }
2277
2386
  },
2278
2387
  "discovery": {
2279
- "description": "Discovery options.",
2388
+ "description": "Options used by the default discovery service.",
2280
2389
  "type": "object",
2281
2390
  "properties": {
2282
2391
  "endpoints": {
2283
- "description": "Endpoints\n\nA list of target baseUrls and the associated plugins.",
2392
+ "description": "A list of target baseUrls and the associated plugins.",
2284
2393
  "type": "array",
2285
2394
  "items": {
2286
2395
  "type": "object",
2287
2396
  "properties": {
2288
2397
  "target": {
2289
- "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.",
2398
+ "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.",
2290
2399
  "anyOf": [
2291
2400
  {
2292
2401
  "type": "object",
@@ -2309,7 +2418,7 @@
2309
2418
  ]
2310
2419
  },
2311
2420
  "plugins": {
2312
- "description": "Array of plugins which use the target baseUrl.",
2421
+ "description": "Array of plugins which use the target base URL.",
2313
2422
  "type": "array",
2314
2423
  "items": {
2315
2424
  "type": "string"
@@ -2330,115 +2439,6 @@
2330
2439
  },
2331
2440
  "$schema": "http://json-schema.org/draft-07/schema#"
2332
2441
  }
2333
- },
2334
- {
2335
- "path": "../integration-aws-node/config.d.ts",
2336
- "value": {
2337
- "type": "object",
2338
- "properties": {
2339
- "aws": {
2340
- "description": "Configuration for access to AWS accounts",
2341
- "type": "object",
2342
- "properties": {
2343
- "accountDefaults": {
2344
- "description": "Defaults for retrieving AWS account credentials",
2345
- "type": "object",
2346
- "properties": {
2347
- "roleName": {
2348
- "description": "The IAM role to assume to retrieve temporary AWS credentials",
2349
- "type": "string"
2350
- },
2351
- "partition": {
2352
- "description": "The AWS partition of the IAM role, e.g. \"aws\", \"aws-cn\"",
2353
- "type": "string"
2354
- },
2355
- "region": {
2356
- "description": "The STS regional endpoint to use when retrieving temporary AWS credentials, e.g. \"ap-northeast-1\"",
2357
- "type": "string"
2358
- },
2359
- "externalId": {
2360
- "description": "The unique identifier needed to assume the role to retrieve temporary AWS credentials",
2361
- "visibility": "secret",
2362
- "type": "string"
2363
- }
2364
- }
2365
- },
2366
- "mainAccount": {
2367
- "description": "Main account to use for retrieving AWS account credentials",
2368
- "type": "object",
2369
- "properties": {
2370
- "accessKeyId": {
2371
- "description": "The access key ID for a set of static AWS credentials",
2372
- "visibility": "secret",
2373
- "type": "string"
2374
- },
2375
- "secretAccessKey": {
2376
- "description": "The secret access key for a set of static AWS credentials",
2377
- "visibility": "secret",
2378
- "type": "string"
2379
- },
2380
- "profile": {
2381
- "description": "The configuration profile from a credentials file at ~/.aws/credentials and\na configuration file at ~/.aws/config.",
2382
- "type": "string"
2383
- },
2384
- "region": {
2385
- "description": "The STS regional endpoint to use for the main account, e.g. \"ap-northeast-1\"",
2386
- "type": "string"
2387
- }
2388
- }
2389
- },
2390
- "accounts": {
2391
- "description": "Configuration for retrieving AWS accounts credentials",
2392
- "type": "array",
2393
- "items": {
2394
- "type": "object",
2395
- "properties": {
2396
- "accountId": {
2397
- "description": "The account ID of the target account that this matches on, e.g. \"123456789012\"",
2398
- "type": "string"
2399
- },
2400
- "accessKeyId": {
2401
- "description": "The access key ID for a set of static AWS credentials",
2402
- "visibility": "secret",
2403
- "type": "string"
2404
- },
2405
- "secretAccessKey": {
2406
- "description": "The secret access key for a set of static AWS credentials",
2407
- "visibility": "secret",
2408
- "type": "string"
2409
- },
2410
- "profile": {
2411
- "description": "The configuration profile from a credentials file at ~/.aws/credentials and\na configuration file at ~/.aws/config.",
2412
- "type": "string"
2413
- },
2414
- "roleName": {
2415
- "description": "The IAM role to assume to retrieve temporary AWS credentials",
2416
- "type": "string"
2417
- },
2418
- "partition": {
2419
- "description": "The AWS partition of the IAM role, e.g. \"aws\", \"aws-cn\"",
2420
- "type": "string"
2421
- },
2422
- "region": {
2423
- "description": "The STS regional endpoint to use when retrieving temporary AWS credentials, e.g. \"ap-northeast-1\"",
2424
- "type": "string"
2425
- },
2426
- "externalId": {
2427
- "description": "The unique identifier needed to assume the role to retrieve temporary AWS credentials",
2428
- "visibility": "secret",
2429
- "type": "string"
2430
- }
2431
- },
2432
- "required": [
2433
- "accountId"
2434
- ]
2435
- }
2436
- }
2437
- }
2438
- }
2439
- },
2440
- "$schema": "http://json-schema.org/draft-07/schema#"
2441
- }
2442
2442
  }
2443
2443
  ],
2444
2444
  "backstageConfigSchemaVersion": 1
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-20240720021712",
4
+ "version": "0.0.0-nightly-20240721021945",
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-20240720021712",
38
+ "@backstage/cli": "^0.0.0-nightly-20240721021945",
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-20240720021712",
59
+ "@backstage/backend-defaults": "^0.0.0-nightly-20240721021945",
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-20240720021712",
63
+ "@backstage/plugin-techdocs-node": "^0.0.0-nightly-20240721021945",
64
64
  "commander": "^12.0.0",
65
65
  "fs-extra": "^11.0.0",
66
66
  "global-agent": "^3.0.0",