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

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 CHANGED
@@ -1,15 +1,15 @@
1
1
  # @techdocs/cli
2
2
 
3
- ## 0.0.0-nightly-20240718021752
3
+ ## 0.0.0-nightly-20240720021712
4
4
 
5
5
  ### Patch Changes
6
6
 
7
7
  - Updated dependencies
8
- - @backstage/backend-defaults@0.0.0-nightly-20240718021752
9
- - @backstage/plugin-techdocs-node@0.0.0-nightly-20240718021752
8
+ - @backstage/backend-defaults@0.0.0-nightly-20240720021712
10
9
  - @backstage/catalog-model@1.5.0
11
10
  - @backstage/cli-common@0.1.14
12
11
  - @backstage/config@1.2.0
12
+ - @backstage/plugin-techdocs-node@0.0.0-nightly-20240720021712
13
13
 
14
14
  ## 1.8.16
15
15
 
@@ -354,51 +354,6 @@
354
354
  "$schema": "http://json-schema.org/draft-07/schema#"
355
355
  }
356
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
357
  {
403
358
  "path": "../../plugins/techdocs/config.d.ts",
404
359
  "value": {
@@ -444,6 +399,51 @@
444
399
  "$schema": "http://json-schema.org/draft-07/schema#"
445
400
  }
446
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,116 +1553,7 @@
1553
1553
  }
1554
1554
  },
1555
1555
  {
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",
1556
+ "path": "../backend-defaults/config.d.ts",
1666
1557
  "value": {
1667
1558
  "type": "object",
1668
1559
  "properties": {
@@ -1670,6 +1561,7 @@
1670
1561
  "type": "object",
1671
1562
  "properties": {
1672
1563
  "auth": {
1564
+ "description": "Options used by the default auth, httpAuth and userInfo services.",
1673
1565
  "type": "object",
1674
1566
  "properties": {
1675
1567
  "dangerouslyDisableDefaultAuthPolicy": {
@@ -1995,17 +1887,17 @@
1995
1887
  }
1996
1888
  },
1997
1889
  "discovery": {
1998
- "description": "Discovery options.",
1890
+ "description": "Options used by the default discovery service.",
1999
1891
  "type": "object",
2000
1892
  "properties": {
2001
1893
  "endpoints": {
2002
- "description": "Endpoints\n\nA list of target baseUrls and the associated plugins.",
1894
+ "description": "A list of target baseUrls and the associated plugins.",
2003
1895
  "type": "array",
2004
1896
  "items": {
2005
1897
  "type": "object",
2006
1898
  "properties": {
2007
1899
  "target": {
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.",
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.",
2009
1901
  "anyOf": [
2010
1902
  {
2011
1903
  "type": "object",
@@ -2028,7 +1920,7 @@
2028
1920
  ]
2029
1921
  },
2030
1922
  "plugins": {
2031
- "description": "Array of plugins which use the target baseUrl.",
1923
+ "description": "Array of plugins which use the target base URL.",
2032
1924
  "type": "array",
2033
1925
  "items": {
2034
1926
  "type": "string"
@@ -2051,7 +1943,7 @@
2051
1943
  }
2052
1944
  },
2053
1945
  {
2054
- "path": "../backend-defaults/config.d.ts",
1946
+ "path": "../backend-app-api/config.d.ts",
2055
1947
  "value": {
2056
1948
  "type": "object",
2057
1949
  "properties": {
@@ -2059,7 +1951,6 @@
2059
1951
  "type": "object",
2060
1952
  "properties": {
2061
1953
  "auth": {
2062
- "description": "Options used by the default auth, httpAuth and userInfo services.",
2063
1954
  "type": "object",
2064
1955
  "properties": {
2065
1956
  "dangerouslyDisableDefaultAuthPolicy": {
@@ -2385,17 +2276,17 @@
2385
2276
  }
2386
2277
  },
2387
2278
  "discovery": {
2388
- "description": "Options used by the default discovery service.",
2279
+ "description": "Discovery options.",
2389
2280
  "type": "object",
2390
2281
  "properties": {
2391
2282
  "endpoints": {
2392
- "description": "A list of target baseUrls and the associated plugins.",
2283
+ "description": "Endpoints\n\nA list of target baseUrls and the associated plugins.",
2393
2284
  "type": "array",
2394
2285
  "items": {
2395
2286
  "type": "object",
2396
2287
  "properties": {
2397
2288
  "target": {
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.",
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.",
2399
2290
  "anyOf": [
2400
2291
  {
2401
2292
  "type": "object",
@@ -2418,7 +2309,7 @@
2418
2309
  ]
2419
2310
  },
2420
2311
  "plugins": {
2421
- "description": "Array of plugins which use the target base URL.",
2312
+ "description": "Array of plugins which use the target baseUrl.",
2422
2313
  "type": "array",
2423
2314
  "items": {
2424
2315
  "type": "string"
@@ -2439,6 +2330,115 @@
2439
2330
  },
2440
2331
  "$schema": "http://json-schema.org/draft-07/schema#"
2441
2332
  }
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
@@ -1 +1 @@
1
- <!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Backstage is an open source framework for building developer portals"/><link rel="manifest" href="/manifest.json" crossorigin="use-credentials"/><link rel="icon" href="/favicon.ico"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5"/><title>Techdocs Preview App</title><meta name="backstage-app-mode" content="public"><script defer="defer" src="/static/runtime.bb0e2f74.js"></script><script defer="defer" src="/static/module-material-ui.6663331c.js"></script><script defer="defer" src="/static/module-lodash.03ad7f2c.js"></script><script defer="defer" src="/static/module-date-fns.ede1fb4c.js"></script><script defer="defer" src="/static/module-mui.fdfd026f.js"></script><script defer="defer" src="/static/module-material-table.a7bd92fb.js"></script><script defer="defer" src="/static/module-react-dom.de9144a3.js"></script><script defer="defer" src="/static/module-react-router.94674603.js"></script><script defer="defer" src="/static/module-react-router-dom.cba3485a.js"></script><script defer="defer" src="/static/module-react-beautiful-dnd.aed438c6.js"></script><script defer="defer" src="/static/module-zod.98ecf655.js"></script><script defer="defer" src="/static/module-i18next.3d702b1d.js"></script><script defer="defer" src="/static/vendor.bb0e2f74.js"></script><script defer="defer" src="/static/main.bb0e2f74.js"></script></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
1
+ <!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Backstage is an open source framework for building developer portals"/><link rel="manifest" href="/manifest.json" crossorigin="use-credentials"/><link rel="icon" href="/favicon.ico"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5"/><title>Techdocs Preview App</title><meta name="backstage-app-mode" content="public"><script defer="defer" src="/static/runtime.a2397231.js"></script><script defer="defer" src="/static/module-material-ui.6663331c.js"></script><script defer="defer" src="/static/module-lodash.03ad7f2c.js"></script><script defer="defer" src="/static/module-date-fns.ede1fb4c.js"></script><script defer="defer" src="/static/module-mui.fdfd026f.js"></script><script defer="defer" src="/static/module-material-table.a7bd92fb.js"></script><script defer="defer" src="/static/module-react-dom.de9144a3.js"></script><script defer="defer" src="/static/module-react-router.94674603.js"></script><script defer="defer" src="/static/module-react-router-dom.cba3485a.js"></script><script defer="defer" src="/static/module-react-beautiful-dnd.aed438c6.js"></script><script defer="defer" src="/static/module-zod.98ecf655.js"></script><script defer="defer" src="/static/module-i18next.3d702b1d.js"></script><script defer="defer" src="/static/vendor.a2397231.js"></script><script defer="defer" src="/static/main.a2397231.js"></script></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>