@redocly/config 0.43.0 → 0.44.0

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 (51) hide show
  1. package/lib/common.d.ts +241 -22
  2. package/lib/common.js +50 -37
  3. package/lib/constants/config.d.ts +12 -0
  4. package/lib/constants/config.js +17 -0
  5. package/lib/constants/entities.d.ts +45 -0
  6. package/lib/constants/entities.js +58 -0
  7. package/lib/constants/enum.d.ts +1 -0
  8. package/lib/constants/enum.js +6 -0
  9. package/lib/constants/shared.d.ts +15 -0
  10. package/lib/constants/shared.js +22 -0
  11. package/lib/default-theme-config-schema.d.ts +866 -723
  12. package/lib/default-theme-config-schema.js +1 -1
  13. package/lib/entities-catalog-entity-file-schema.js +22 -22
  14. package/lib/ex-theme-config-schemas.d.ts +96 -26
  15. package/lib/ex-theme-config-schemas.js +23 -2
  16. package/lib/index.d.ts +3 -1
  17. package/lib/index.js +13 -10
  18. package/lib/product-override-schema.d.ts +73 -20
  19. package/lib/root-config-schema.d.ts +2823 -1567
  20. package/lib/root-config-schema.js +18 -11
  21. package/lib/scorecards-config-schema.d.ts +6 -0
  22. package/lib/scorecards-config-schema.js +2 -4
  23. package/lib/types/portal-shared-types.d.ts +1 -1
  24. package/lib-esm/common.d.ts +241 -22
  25. package/lib-esm/common.js +29 -16
  26. package/lib-esm/constants/config.d.ts +12 -0
  27. package/lib-esm/constants/config.js +14 -0
  28. package/lib-esm/constants/entities.d.ts +45 -0
  29. package/lib-esm/constants/entities.js +55 -0
  30. package/lib-esm/constants/enum.d.ts +1 -0
  31. package/lib-esm/constants/enum.js +2 -0
  32. package/lib-esm/constants/shared.d.ts +15 -0
  33. package/lib-esm/constants/shared.js +19 -0
  34. package/lib-esm/default-theme-config-schema.d.ts +866 -723
  35. package/lib-esm/default-theme-config-schema.js +1 -1
  36. package/lib-esm/entities-catalog-entity-file-schema.js +21 -21
  37. package/lib-esm/ex-theme-config-schemas.d.ts +96 -26
  38. package/lib-esm/ex-theme-config-schemas.js +24 -3
  39. package/lib-esm/index.d.ts +3 -1
  40. package/lib-esm/index.js +3 -1
  41. package/lib-esm/product-override-schema.d.ts +73 -20
  42. package/lib-esm/root-config-schema.d.ts +2823 -1567
  43. package/lib-esm/root-config-schema.js +14 -7
  44. package/lib-esm/scorecards-config-schema.d.ts +6 -0
  45. package/lib-esm/scorecards-config-schema.js +2 -4
  46. package/lib-esm/types/portal-shared-types.d.ts +1 -1
  47. package/package.json +2 -2
  48. package/lib/constants.d.ts +0 -38
  49. package/lib/constants.js +0 -73
  50. package/lib-esm/constants.d.ts +0 -38
  51. package/lib-esm/constants.js +0 -70
@@ -2760,92 +2760,116 @@ export declare const productConfigOverrideSchema: {
2760
2760
  readonly type: "object";
2761
2761
  readonly properties: {
2762
2762
  readonly extends: {
2763
+ readonly nodeTypeName: undefined;
2763
2764
  readonly type: "array";
2764
2765
  readonly items: {
2765
2766
  readonly type: "string";
2766
2767
  };
2768
+ readonly description: "Use extends to inherit rules and their configurations from other rulesets.";
2769
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/extends";
2767
2770
  };
2768
- readonly decorators: {
2771
+ readonly preprocessors: {
2772
+ readonly nodeTypeName: undefined;
2769
2773
  readonly type: "object";
2770
2774
  readonly additionalProperties: true;
2771
2775
  };
2772
- readonly oas2Decorators: {
2776
+ readonly oas2Preprocessors: {
2777
+ readonly nodeTypeName: undefined;
2773
2778
  readonly type: "object";
2774
2779
  readonly additionalProperties: true;
2775
2780
  };
2776
- readonly oas3_0Decorators: {
2781
+ readonly oas3_0Preprocessors: {
2782
+ readonly nodeTypeName: undefined;
2777
2783
  readonly type: "object";
2778
2784
  readonly additionalProperties: true;
2779
2785
  };
2780
- readonly oas3_1Decorators: {
2786
+ readonly oas3_1Preprocessors: {
2787
+ readonly nodeTypeName: undefined;
2781
2788
  readonly type: "object";
2782
2789
  readonly additionalProperties: true;
2783
2790
  };
2784
- readonly oas3_2Decorators: {
2791
+ readonly oas3_2Preprocessors: {
2792
+ readonly nodeTypeName: undefined;
2785
2793
  readonly type: "object";
2786
2794
  readonly additionalProperties: true;
2787
2795
  };
2788
- readonly async2Decorators: {
2796
+ readonly async2Preprocessors: {
2797
+ readonly nodeTypeName: undefined;
2789
2798
  readonly type: "object";
2790
2799
  readonly additionalProperties: true;
2791
2800
  };
2792
- readonly async3Decorators: {
2801
+ readonly async3Preprocessors: {
2802
+ readonly nodeTypeName: undefined;
2793
2803
  readonly type: "object";
2794
2804
  readonly additionalProperties: true;
2795
2805
  };
2796
- readonly arazzo1Decorators: {
2806
+ readonly arazzo1Preprocessors: {
2807
+ readonly nodeTypeName: undefined;
2797
2808
  readonly type: "object";
2798
2809
  readonly additionalProperties: true;
2799
2810
  };
2800
- readonly overlay1Decorators: {
2811
+ readonly overlay1Preprocessors: {
2812
+ readonly nodeTypeName: undefined;
2801
2813
  readonly type: "object";
2802
2814
  readonly additionalProperties: true;
2803
2815
  };
2804
- readonly openrpc1Decorators: {
2816
+ readonly openrpc1Preprocessors: {
2817
+ readonly nodeTypeName: undefined;
2805
2818
  readonly type: "object";
2806
2819
  readonly additionalProperties: true;
2807
2820
  };
2808
- readonly preprocessors: {
2821
+ readonly decorators: {
2822
+ readonly nodeTypeName: undefined;
2809
2823
  readonly type: "object";
2810
2824
  readonly additionalProperties: true;
2811
2825
  };
2812
- readonly oas2Preprocessors: {
2826
+ readonly oas2Decorators: {
2827
+ readonly nodeTypeName: undefined;
2813
2828
  readonly type: "object";
2814
2829
  readonly additionalProperties: true;
2815
2830
  };
2816
- readonly oas3_0Preprocessors: {
2831
+ readonly oas3_0Decorators: {
2832
+ readonly nodeTypeName: undefined;
2817
2833
  readonly type: "object";
2818
2834
  readonly additionalProperties: true;
2819
2835
  };
2820
- readonly oas3_1Preprocessors: {
2836
+ readonly oas3_1Decorators: {
2837
+ readonly nodeTypeName: undefined;
2821
2838
  readonly type: "object";
2822
2839
  readonly additionalProperties: true;
2823
2840
  };
2824
- readonly oas3_2Preprocessors: {
2841
+ readonly oas3_2Decorators: {
2842
+ readonly nodeTypeName: undefined;
2825
2843
  readonly type: "object";
2826
2844
  readonly additionalProperties: true;
2827
2845
  };
2828
- readonly async2Preprocessors: {
2846
+ readonly async2Decorators: {
2847
+ readonly nodeTypeName: undefined;
2829
2848
  readonly type: "object";
2830
2849
  readonly additionalProperties: true;
2831
2850
  };
2832
- readonly async3Preprocessors: {
2851
+ readonly async3Decorators: {
2852
+ readonly nodeTypeName: undefined;
2833
2853
  readonly type: "object";
2834
2854
  readonly additionalProperties: true;
2835
2855
  };
2836
- readonly arazzo1Preprocessors: {
2856
+ readonly arazzo1Decorators: {
2857
+ readonly nodeTypeName: undefined;
2837
2858
  readonly type: "object";
2838
2859
  readonly additionalProperties: true;
2839
2860
  };
2840
- readonly overlay1Preprocessors: {
2861
+ readonly overlay1Decorators: {
2862
+ readonly nodeTypeName: undefined;
2841
2863
  readonly type: "object";
2842
2864
  readonly additionalProperties: true;
2843
2865
  };
2844
- readonly openrpc1Preprocessors: {
2866
+ readonly openrpc1Decorators: {
2867
+ readonly nodeTypeName: undefined;
2845
2868
  readonly type: "object";
2846
2869
  readonly additionalProperties: true;
2847
2870
  };
2848
2871
  readonly rules: {
2872
+ readonly nodeTypeName: undefined;
2849
2873
  readonly type: "object";
2850
2874
  readonly additionalProperties: {
2851
2875
  readonly oneOf: readonly [{
@@ -2854,8 +2878,11 @@ export declare const productConfigOverrideSchema: {
2854
2878
  readonly type: "object";
2855
2879
  }];
2856
2880
  };
2881
+ readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
2882
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
2857
2883
  };
2858
2884
  readonly oas2Rules: {
2885
+ readonly nodeTypeName: undefined;
2859
2886
  readonly type: "object";
2860
2887
  readonly additionalProperties: {
2861
2888
  readonly oneOf: readonly [{
@@ -2864,8 +2891,11 @@ export declare const productConfigOverrideSchema: {
2864
2891
  readonly type: "object";
2865
2892
  }];
2866
2893
  };
2894
+ readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
2895
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
2867
2896
  };
2868
2897
  readonly oas3_0Rules: {
2898
+ readonly nodeTypeName: undefined;
2869
2899
  readonly type: "object";
2870
2900
  readonly additionalProperties: {
2871
2901
  readonly oneOf: readonly [{
@@ -2874,8 +2904,11 @@ export declare const productConfigOverrideSchema: {
2874
2904
  readonly type: "object";
2875
2905
  }];
2876
2906
  };
2907
+ readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
2908
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
2877
2909
  };
2878
2910
  readonly oas3_1Rules: {
2911
+ readonly nodeTypeName: undefined;
2879
2912
  readonly type: "object";
2880
2913
  readonly additionalProperties: {
2881
2914
  readonly oneOf: readonly [{
@@ -2884,8 +2917,11 @@ export declare const productConfigOverrideSchema: {
2884
2917
  readonly type: "object";
2885
2918
  }];
2886
2919
  };
2920
+ readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
2921
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
2887
2922
  };
2888
2923
  readonly oas3_2Rules: {
2924
+ readonly nodeTypeName: undefined;
2889
2925
  readonly type: "object";
2890
2926
  readonly additionalProperties: {
2891
2927
  readonly oneOf: readonly [{
@@ -2894,8 +2930,11 @@ export declare const productConfigOverrideSchema: {
2894
2930
  readonly type: "object";
2895
2931
  }];
2896
2932
  };
2933
+ readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
2934
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
2897
2935
  };
2898
2936
  readonly async2Rules: {
2937
+ readonly nodeTypeName: undefined;
2899
2938
  readonly type: "object";
2900
2939
  readonly additionalProperties: {
2901
2940
  readonly oneOf: readonly [{
@@ -2904,8 +2943,11 @@ export declare const productConfigOverrideSchema: {
2904
2943
  readonly type: "object";
2905
2944
  }];
2906
2945
  };
2946
+ readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
2947
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
2907
2948
  };
2908
2949
  readonly async3Rules: {
2950
+ readonly nodeTypeName: undefined;
2909
2951
  readonly type: "object";
2910
2952
  readonly additionalProperties: {
2911
2953
  readonly oneOf: readonly [{
@@ -2914,8 +2956,11 @@ export declare const productConfigOverrideSchema: {
2914
2956
  readonly type: "object";
2915
2957
  }];
2916
2958
  };
2959
+ readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
2960
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
2917
2961
  };
2918
2962
  readonly arazzo1Rules: {
2963
+ readonly nodeTypeName: undefined;
2919
2964
  readonly type: "object";
2920
2965
  readonly additionalProperties: {
2921
2966
  readonly oneOf: readonly [{
@@ -2924,8 +2969,11 @@ export declare const productConfigOverrideSchema: {
2924
2969
  readonly type: "object";
2925
2970
  }];
2926
2971
  };
2972
+ readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
2973
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
2927
2974
  };
2928
2975
  readonly overlay1Rules: {
2976
+ readonly nodeTypeName: undefined;
2929
2977
  readonly type: "object";
2930
2978
  readonly additionalProperties: {
2931
2979
  readonly oneOf: readonly [{
@@ -2934,8 +2982,11 @@ export declare const productConfigOverrideSchema: {
2934
2982
  readonly type: "object";
2935
2983
  }];
2936
2984
  };
2985
+ readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
2986
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
2937
2987
  };
2938
2988
  readonly openrpc1Rules: {
2989
+ readonly nodeTypeName: undefined;
2939
2990
  readonly type: "object";
2940
2991
  readonly additionalProperties: {
2941
2992
  readonly oneOf: readonly [{
@@ -2944,6 +2995,8 @@ export declare const productConfigOverrideSchema: {
2944
2995
  readonly type: "object";
2945
2996
  }];
2946
2997
  };
2998
+ readonly description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.";
2999
+ readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
2947
3000
  };
2948
3001
  readonly root: {
2949
3002
  readonly type: "string";