@techdocs/cli 1.9.4-next.2 → 1.9.4

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.
@@ -358,52 +358,6 @@
358
358
  },
359
359
  "packageName": "@backstage/core-app-api"
360
360
  },
361
- {
362
- "path": "../core-components/config.d.ts",
363
- "value": {
364
- "type": "object",
365
- "properties": {
366
- "auth": {
367
- "type": "object",
368
- "properties": {
369
- "autologout": {
370
- "description": "Autologout feature configuration",
371
- "type": "object",
372
- "properties": {
373
- "enabled": {
374
- "description": "Enable or disable the autologout feature",
375
- "visibility": "frontend",
376
- "type": "boolean"
377
- },
378
- "idleTimeoutMinutes": {
379
- "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
380
- "visibility": "frontend",
381
- "type": "number"
382
- },
383
- "promptBeforeIdleSeconds": {
384
- "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.",
385
- "visibility": "frontend",
386
- "type": "number"
387
- },
388
- "useWorkerTimers": {
389
- "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.",
390
- "visibility": "frontend",
391
- "type": "boolean"
392
- },
393
- "logoutIfDisconnected": {
394
- "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
395
- "visibility": "frontend",
396
- "type": "boolean"
397
- }
398
- }
399
- }
400
- }
401
- }
402
- },
403
- "$schema": "http://json-schema.org/draft-07/schema#"
404
- },
405
- "packageName": "@backstage/core-components"
406
- },
407
361
  {
408
362
  "path": "../../plugins/techdocs/config.d.ts",
409
363
  "value": {
@@ -460,182 +414,6 @@
460
414
  },
461
415
  "packageName": "@backstage/plugin-techdocs"
462
416
  },
463
- {
464
- "path": "../frontend-app-api/config.d.ts",
465
- "value": {
466
- "type": "object",
467
- "properties": {
468
- "app": {
469
- "type": "object",
470
- "properties": {
471
- "experimental": {
472
- "type": "object",
473
- "properties": {
474
- "packages": {
475
- "visibility": "frontend",
476
- "deepVisibility": "frontend",
477
- "anyOf": [
478
- {
479
- "type": "object",
480
- "properties": {
481
- "include": {
482
- "type": "array",
483
- "items": {
484
- "type": "string"
485
- }
486
- },
487
- "exclude": {
488
- "type": "array",
489
- "items": {
490
- "type": "string"
491
- }
492
- }
493
- }
494
- },
495
- {
496
- "const": "all",
497
- "type": "string"
498
- }
499
- ]
500
- }
501
- }
502
- },
503
- "routes": {
504
- "type": "object",
505
- "properties": {
506
- "bindings": {
507
- "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.",
508
- "deepVisibility": "frontend",
509
- "type": "object",
510
- "additionalProperties": {
511
- "anyOf": [
512
- {
513
- "const": false,
514
- "type": "boolean"
515
- },
516
- {
517
- "type": "string"
518
- }
519
- ]
520
- }
521
- }
522
- }
523
- },
524
- "extensions": {
525
- "deepVisibility": "frontend",
526
- "type": "array",
527
- "items": {
528
- "anyOf": [
529
- {
530
- "type": "object",
531
- "additionalProperties": {
532
- "anyOf": [
533
- {
534
- "type": "object",
535
- "properties": {
536
- "attachTo": {
537
- "type": "object",
538
- "properties": {
539
- "id": {
540
- "type": "string"
541
- },
542
- "input": {
543
- "type": "string"
544
- }
545
- },
546
- "required": [
547
- "id",
548
- "input"
549
- ]
550
- },
551
- "disabled": {
552
- "type": "boolean"
553
- },
554
- "config": {}
555
- }
556
- },
557
- {
558
- "type": "boolean"
559
- }
560
- ]
561
- }
562
- },
563
- {
564
- "type": "string"
565
- }
566
- ]
567
- }
568
- },
569
- "pluginOverrides": {
570
- "description": "This section enables you to override certain properties of specific or\ngroups of plugins.",
571
- "deepVisibility": "frontend",
572
- "type": "array",
573
- "items": {
574
- "type": "object",
575
- "properties": {
576
- "match": {
577
- "description": "The criteria for matching plugins to override.",
578
- "type": "object",
579
- "properties": {
580
- "pluginId": {
581
- "description": "A pattern that is matched against the plugin ID.",
582
- "type": "string"
583
- },
584
- "packageName": {
585
- "description": "A pattern that is matched against the package name.",
586
- "type": "string"
587
- }
588
- }
589
- },
590
- "info": {
591
- "description": "Overrides individual top-level fields of the plugin info.",
592
- "type": "object",
593
- "properties": {
594
- "description": {
595
- "description": "Override the description of the plugin.",
596
- "type": "string"
597
- },
598
- "ownerEntityRefs": {
599
- "description": "Override the owner entity references of the plugin.",
600
- "type": "array",
601
- "items": {
602
- "type": "string"
603
- }
604
- },
605
- "links": {
606
- "description": "Override the links of the plugin.",
607
- "type": "array",
608
- "items": {
609
- "type": "object",
610
- "properties": {
611
- "title": {
612
- "type": "string"
613
- },
614
- "url": {
615
- "type": "string"
616
- }
617
- },
618
- "required": [
619
- "title",
620
- "url"
621
- ]
622
- }
623
- }
624
- }
625
- }
626
- },
627
- "required": [
628
- "info"
629
- ]
630
- }
631
- }
632
- }
633
- }
634
- },
635
- "$schema": "http://json-schema.org/draft-07/schema#"
636
- },
637
- "packageName": "@backstage/frontend-app-api"
638
- },
639
417
  {
640
418
  "path": "../integration/config.d.ts",
641
419
  "value": {
@@ -1118,9 +896,231 @@
1118
896
  "type": "string"
1119
897
  }
1120
898
  },
1121
- "required": [
1122
- "host"
1123
- ]
899
+ "required": [
900
+ "host"
901
+ ]
902
+ }
903
+ }
904
+ }
905
+ }
906
+ },
907
+ "$schema": "http://json-schema.org/draft-07/schema#"
908
+ },
909
+ "packageName": "@backstage/integration"
910
+ },
911
+ {
912
+ "path": "../frontend-app-api/config.d.ts",
913
+ "value": {
914
+ "type": "object",
915
+ "properties": {
916
+ "app": {
917
+ "type": "object",
918
+ "properties": {
919
+ "experimental": {
920
+ "type": "object",
921
+ "properties": {
922
+ "packages": {
923
+ "visibility": "frontend",
924
+ "deepVisibility": "frontend",
925
+ "anyOf": [
926
+ {
927
+ "type": "object",
928
+ "properties": {
929
+ "include": {
930
+ "type": "array",
931
+ "items": {
932
+ "type": "string"
933
+ }
934
+ },
935
+ "exclude": {
936
+ "type": "array",
937
+ "items": {
938
+ "type": "string"
939
+ }
940
+ }
941
+ }
942
+ },
943
+ {
944
+ "const": "all",
945
+ "type": "string"
946
+ }
947
+ ]
948
+ }
949
+ }
950
+ },
951
+ "routes": {
952
+ "type": "object",
953
+ "properties": {
954
+ "bindings": {
955
+ "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.",
956
+ "deepVisibility": "frontend",
957
+ "type": "object",
958
+ "additionalProperties": {
959
+ "anyOf": [
960
+ {
961
+ "const": false,
962
+ "type": "boolean"
963
+ },
964
+ {
965
+ "type": "string"
966
+ }
967
+ ]
968
+ }
969
+ }
970
+ }
971
+ },
972
+ "extensions": {
973
+ "deepVisibility": "frontend",
974
+ "type": "array",
975
+ "items": {
976
+ "anyOf": [
977
+ {
978
+ "type": "object",
979
+ "additionalProperties": {
980
+ "anyOf": [
981
+ {
982
+ "type": "object",
983
+ "properties": {
984
+ "attachTo": {
985
+ "type": "object",
986
+ "properties": {
987
+ "id": {
988
+ "type": "string"
989
+ },
990
+ "input": {
991
+ "type": "string"
992
+ }
993
+ },
994
+ "required": [
995
+ "id",
996
+ "input"
997
+ ]
998
+ },
999
+ "disabled": {
1000
+ "type": "boolean"
1001
+ },
1002
+ "config": {}
1003
+ }
1004
+ },
1005
+ {
1006
+ "type": "boolean"
1007
+ }
1008
+ ]
1009
+ }
1010
+ },
1011
+ {
1012
+ "type": "string"
1013
+ }
1014
+ ]
1015
+ }
1016
+ },
1017
+ "pluginOverrides": {
1018
+ "description": "This section enables you to override certain properties of specific or\ngroups of plugins.",
1019
+ "deepVisibility": "frontend",
1020
+ "type": "array",
1021
+ "items": {
1022
+ "type": "object",
1023
+ "properties": {
1024
+ "match": {
1025
+ "description": "The criteria for matching plugins to override.",
1026
+ "type": "object",
1027
+ "properties": {
1028
+ "pluginId": {
1029
+ "description": "A pattern that is matched against the plugin ID.",
1030
+ "type": "string"
1031
+ },
1032
+ "packageName": {
1033
+ "description": "A pattern that is matched against the package name.",
1034
+ "type": "string"
1035
+ }
1036
+ }
1037
+ },
1038
+ "info": {
1039
+ "description": "Overrides individual top-level fields of the plugin info.",
1040
+ "type": "object",
1041
+ "properties": {
1042
+ "description": {
1043
+ "description": "Override the description of the plugin.",
1044
+ "type": "string"
1045
+ },
1046
+ "ownerEntityRefs": {
1047
+ "description": "Override the owner entity references of the plugin.",
1048
+ "type": "array",
1049
+ "items": {
1050
+ "type": "string"
1051
+ }
1052
+ },
1053
+ "links": {
1054
+ "description": "Override the links of the plugin.",
1055
+ "type": "array",
1056
+ "items": {
1057
+ "type": "object",
1058
+ "properties": {
1059
+ "title": {
1060
+ "type": "string"
1061
+ },
1062
+ "url": {
1063
+ "type": "string"
1064
+ }
1065
+ },
1066
+ "required": [
1067
+ "title",
1068
+ "url"
1069
+ ]
1070
+ }
1071
+ }
1072
+ }
1073
+ }
1074
+ },
1075
+ "required": [
1076
+ "info"
1077
+ ]
1078
+ }
1079
+ }
1080
+ }
1081
+ }
1082
+ },
1083
+ "$schema": "http://json-schema.org/draft-07/schema#"
1084
+ },
1085
+ "packageName": "@backstage/frontend-app-api"
1086
+ },
1087
+ {
1088
+ "path": "../core-components/config.d.ts",
1089
+ "value": {
1090
+ "type": "object",
1091
+ "properties": {
1092
+ "auth": {
1093
+ "type": "object",
1094
+ "properties": {
1095
+ "autologout": {
1096
+ "description": "Autologout feature configuration",
1097
+ "type": "object",
1098
+ "properties": {
1099
+ "enabled": {
1100
+ "description": "Enable or disable the autologout feature",
1101
+ "visibility": "frontend",
1102
+ "type": "boolean"
1103
+ },
1104
+ "idleTimeoutMinutes": {
1105
+ "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
1106
+ "visibility": "frontend",
1107
+ "type": "number"
1108
+ },
1109
+ "promptBeforeIdleSeconds": {
1110
+ "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.",
1111
+ "visibility": "frontend",
1112
+ "type": "number"
1113
+ },
1114
+ "useWorkerTimers": {
1115
+ "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.",
1116
+ "visibility": "frontend",
1117
+ "type": "boolean"
1118
+ },
1119
+ "logoutIfDisconnected": {
1120
+ "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
1121
+ "visibility": "frontend",
1122
+ "type": "boolean"
1123
+ }
1124
1124
  }
1125
1125
  }
1126
1126
  }
@@ -1128,7 +1128,7 @@
1128
1128
  },
1129
1129
  "$schema": "http://json-schema.org/draft-07/schema#"
1130
1130
  },
1131
- "packageName": "@backstage/integration"
1131
+ "packageName": "@backstage/core-components"
1132
1132
  },
1133
1133
  {
1134
1134
  "path": "../../plugins/catalog/config.d.ts",
@@ -1428,52 +1428,6 @@
1428
1428
  },
1429
1429
  "packageName": "@backstage/plugin-auth-backend-module-guest-provider"
1430
1430
  },
1431
- {
1432
- "path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/core-components/config.d.ts",
1433
- "value": {
1434
- "type": "object",
1435
- "properties": {
1436
- "auth": {
1437
- "type": "object",
1438
- "properties": {
1439
- "autologout": {
1440
- "description": "Autologout feature configuration",
1441
- "type": "object",
1442
- "properties": {
1443
- "enabled": {
1444
- "description": "Enable or disable the autologout feature",
1445
- "visibility": "frontend",
1446
- "type": "boolean"
1447
- },
1448
- "idleTimeoutMinutes": {
1449
- "description": "Number of minutes after which the inactive user is logged out automatically.\nDefault is 60 minutes (1 hour)",
1450
- "visibility": "frontend",
1451
- "type": "number"
1452
- },
1453
- "promptBeforeIdleSeconds": {
1454
- "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.",
1455
- "visibility": "frontend",
1456
- "type": "number"
1457
- },
1458
- "useWorkerTimers": {
1459
- "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.",
1460
- "visibility": "frontend",
1461
- "type": "boolean"
1462
- },
1463
- "logoutIfDisconnected": {
1464
- "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open.\nDefault is true.",
1465
- "visibility": "frontend",
1466
- "type": "boolean"
1467
- }
1468
- }
1469
- }
1470
- }
1471
- }
1472
- },
1473
- "$schema": "http://json-schema.org/draft-07/schema#"
1474
- },
1475
- "packageName": "@backstage/core-components"
1476
- },
1477
1431
  {
1478
1432
  "path": "../../node_modules/@backstage-community/plugin-stackstorm/node_modules/@backstage/core-components/config.d.ts",
1479
1433
  "value": {
@@ -2724,6 +2678,117 @@
2724
2678
  }
2725
2679
  }
2726
2680
  },
2681
+ "rateLimit": {
2682
+ "description": "Rate limiting options. Defining this as `true` will enable rate limiting with default values.",
2683
+ "anyOf": [
2684
+ {
2685
+ "type": "object",
2686
+ "properties": {
2687
+ "store": {
2688
+ "anyOf": [
2689
+ {
2690
+ "type": "object",
2691
+ "properties": {
2692
+ "type": {
2693
+ "type": "string",
2694
+ "const": "redis"
2695
+ },
2696
+ "connection": {
2697
+ "type": "string"
2698
+ }
2699
+ },
2700
+ "required": [
2701
+ "connection",
2702
+ "type"
2703
+ ]
2704
+ },
2705
+ {
2706
+ "type": "object",
2707
+ "properties": {
2708
+ "type": {
2709
+ "type": "string",
2710
+ "const": "memory"
2711
+ }
2712
+ },
2713
+ "required": [
2714
+ "type"
2715
+ ]
2716
+ }
2717
+ ]
2718
+ },
2719
+ "global": {
2720
+ "description": "Enable/disable global rate limiting. If this is disabled, plugin specific rate limiting must be\nused.",
2721
+ "type": "boolean"
2722
+ },
2723
+ "window": {
2724
+ "description": "Time frame in milliseconds or as human duration for which requests are checked/remembered.\nDefaults to one minute."
2725
+ },
2726
+ "incomingRequestLimit": {
2727
+ "description": "The maximum number of connections to allow during the `window` before rate limiting the client.\nDefaults to 5.",
2728
+ "type": "number"
2729
+ },
2730
+ "passOnStoreError": {
2731
+ "description": "Whether to pass requests in case of store failure.\nDefaults to false.",
2732
+ "type": "boolean"
2733
+ },
2734
+ "ipAllowList": {
2735
+ "description": "List of allowed IP addresses that are not rate limited.\nDefaults to [127.0.0.1, 0:0:0:0:0:0:0:1, ::1].",
2736
+ "type": "array",
2737
+ "items": {
2738
+ "type": "string"
2739
+ }
2740
+ },
2741
+ "skipSuccessfulRequests": {
2742
+ "description": "Skip rate limiting for requests that have been successful.\nDefaults to false.",
2743
+ "type": "boolean"
2744
+ },
2745
+ "skipFailedRequests": {
2746
+ "description": "Skip rate limiting for requests that have failed.\nDefaults to false.",
2747
+ "type": "boolean"
2748
+ },
2749
+ "plugin": {
2750
+ "description": "Plugin specific rate limiting configuration",
2751
+ "type": "object",
2752
+ "additionalProperties": {
2753
+ "type": "object",
2754
+ "properties": {
2755
+ "window": {
2756
+ "description": "Time frame in milliseconds or as human duration for which requests are checked/remembered.\nDefaults to one minute."
2757
+ },
2758
+ "incomingRequestLimit": {
2759
+ "description": "The maximum number of connections to allow during the `window` before rate limiting the client.\nDefaults to 5.",
2760
+ "type": "number"
2761
+ },
2762
+ "passOnStoreError": {
2763
+ "description": "Whether to pass requests in case of store failure.\nDefaults to false.",
2764
+ "type": "boolean"
2765
+ },
2766
+ "ipAllowList": {
2767
+ "description": "List of allowed IP addresses that are not rate limited.\nDefaults to [127.0.0.1, 0:0:0:0:0:0:0:1, ::1].",
2768
+ "type": "array",
2769
+ "items": {
2770
+ "type": "string"
2771
+ }
2772
+ },
2773
+ "skipSuccessfulRequests": {
2774
+ "description": "Skip rate limiting for requests that have been successful.\nDefaults to false.",
2775
+ "type": "boolean"
2776
+ },
2777
+ "skipFailedRequests": {
2778
+ "description": "Skip rate limiting for requests that have failed.\nDefaults to false.",
2779
+ "type": "boolean"
2780
+ }
2781
+ }
2782
+ }
2783
+ }
2784
+ }
2785
+ },
2786
+ {
2787
+ "const": true,
2788
+ "type": "boolean"
2789
+ }
2790
+ ]
2791
+ },
2727
2792
  "reading": {
2728
2793
  "description": "Configuration related to URL reading, used for example for reading catalog info\nfiles, scaffolder templates, and techdocs content.",
2729
2794
  "type": "object",
@@ -3072,119 +3137,6 @@
3072
3137
  "$schema": "http://json-schema.org/draft-07/schema#"
3073
3138
  },
3074
3139
  "packageName": "@backstage/integration-aws-node"
3075
- },
3076
- {
3077
- "path": "../../node_modules/@backstage-community/plugin-puppetdb/node_modules/@backstage/frontend-app-api/config.d.ts",
3078
- "value": {
3079
- "type": "object",
3080
- "properties": {
3081
- "app": {
3082
- "type": "object",
3083
- "properties": {
3084
- "experimental": {
3085
- "type": "object",
3086
- "properties": {
3087
- "packages": {
3088
- "visibility": "frontend",
3089
- "deepVisibility": "frontend",
3090
- "anyOf": [
3091
- {
3092
- "type": "object",
3093
- "properties": {
3094
- "include": {
3095
- "type": "array",
3096
- "items": {
3097
- "type": "string"
3098
- }
3099
- },
3100
- "exclude": {
3101
- "type": "array",
3102
- "items": {
3103
- "type": "string"
3104
- }
3105
- }
3106
- }
3107
- },
3108
- {
3109
- "const": "all",
3110
- "type": "string"
3111
- }
3112
- ]
3113
- }
3114
- }
3115
- },
3116
- "routes": {
3117
- "type": "object",
3118
- "properties": {
3119
- "bindings": {
3120
- "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.",
3121
- "deepVisibility": "frontend",
3122
- "type": "object",
3123
- "additionalProperties": {
3124
- "anyOf": [
3125
- {
3126
- "const": false,
3127
- "type": "boolean"
3128
- },
3129
- {
3130
- "type": "string"
3131
- }
3132
- ]
3133
- }
3134
- }
3135
- }
3136
- },
3137
- "extensions": {
3138
- "deepVisibility": "frontend",
3139
- "type": "array",
3140
- "items": {
3141
- "anyOf": [
3142
- {
3143
- "type": "object",
3144
- "additionalProperties": {
3145
- "anyOf": [
3146
- {
3147
- "type": "object",
3148
- "properties": {
3149
- "attachTo": {
3150
- "type": "object",
3151
- "properties": {
3152
- "id": {
3153
- "type": "string"
3154
- },
3155
- "input": {
3156
- "type": "string"
3157
- }
3158
- },
3159
- "required": [
3160
- "id",
3161
- "input"
3162
- ]
3163
- },
3164
- "disabled": {
3165
- "type": "boolean"
3166
- },
3167
- "config": {}
3168
- }
3169
- },
3170
- {
3171
- "type": "boolean"
3172
- }
3173
- ]
3174
- }
3175
- },
3176
- {
3177
- "type": "string"
3178
- }
3179
- ]
3180
- }
3181
- }
3182
- }
3183
- }
3184
- },
3185
- "$schema": "http://json-schema.org/draft-07/schema#"
3186
- },
3187
- "packageName": "@backstage/frontend-app-api"
3188
3140
  }
3189
3141
  ],
3190
3142
  "backstageConfigSchemaVersion": 1