@redocly/config 0.19.4 → 0.20.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 (49) hide show
  1. package/lib/default-theme-config-schema.d.ts +62 -50
  2. package/lib/ex-theme-config-schemas.d.ts +56 -24
  3. package/lib/ex-theme-config-schemas.js +7 -3
  4. package/lib/feedback-config-schema.d.ts +4 -4
  5. package/lib/feedback-config-schema.js +4 -4
  6. package/lib/graphql-config-schema.d.ts +2 -2
  7. package/lib/index.d.ts +0 -1
  8. package/lib/index.js +0 -1
  9. package/lib/product-override-schema.d.ts +95 -77
  10. package/lib/redoc-config-schema.d.ts +2 -2
  11. package/lib/root-config-schema.d.ts +1063 -1027
  12. package/lib/types/code-walkthrough-types.d.ts +82 -0
  13. package/lib/{portal-shared-types.js → types/code-walkthrough-types.js} +1 -1
  14. package/lib/{types.d.ts → types/config-types.d.ts} +7 -7
  15. package/lib/{types.js → types/config-types.js} +1 -1
  16. package/lib/{graphql-types.d.ts → types/graphql-types.d.ts} +1 -1
  17. package/lib/types/index.d.ts +2 -0
  18. package/lib/types/index.js +19 -0
  19. package/{lib-esm → lib/types}/portal-shared-types.d.ts +3 -2
  20. package/lib/types/portal-shared-types.js +18 -0
  21. package/lib/{redoc-types.d.ts → types/redoc-types.d.ts} +1 -1
  22. package/lib-esm/default-theme-config-schema.d.ts +62 -50
  23. package/lib-esm/ex-theme-config-schemas.d.ts +56 -24
  24. package/lib-esm/ex-theme-config-schemas.js +6 -2
  25. package/lib-esm/feedback-config-schema.d.ts +4 -4
  26. package/lib-esm/feedback-config-schema.js +3 -3
  27. package/lib-esm/graphql-config-schema.d.ts +2 -2
  28. package/lib-esm/index.d.ts +0 -1
  29. package/lib-esm/index.js +0 -1
  30. package/lib-esm/product-override-schema.d.ts +95 -77
  31. package/lib-esm/redoc-config-schema.d.ts +2 -2
  32. package/lib-esm/root-config-schema.d.ts +1063 -1027
  33. package/lib-esm/types/code-walkthrough-types.d.ts +82 -0
  34. package/lib-esm/types/code-walkthrough-types.js +2 -0
  35. package/lib-esm/{types.d.ts → types/config-types.d.ts} +7 -7
  36. package/lib-esm/types/config-types.js +2 -0
  37. package/lib-esm/{graphql-types.d.ts → types/graphql-types.d.ts} +1 -1
  38. package/lib-esm/types/index.d.ts +2 -0
  39. package/lib-esm/types/index.js +3 -0
  40. package/{lib → lib-esm/types}/portal-shared-types.d.ts +3 -2
  41. package/lib-esm/types/portal-shared-types.js +2 -0
  42. package/lib-esm/{redoc-types.d.ts → types/redoc-types.d.ts} +1 -1
  43. package/package.json +1 -1
  44. package/lib-esm/portal-shared-types.js +0 -2
  45. package/lib-esm/types.js +0 -2
  46. /package/lib/{graphql-types.js → types/graphql-types.js} +0 -0
  47. /package/lib/{redoc-types.js → types/redoc-types.js} +0 -0
  48. /package/lib-esm/{graphql-types.js → types/graphql-types.js} +0 -0
  49. /package/lib-esm/{redoc-types.js → types/redoc-types.js} +0 -0
package/lib/default-theme-config-schema.d.ts CHANGED
@@ -804,10 +804,10 @@ export declare const themeConfigSchema: {
804
804
  };
805
805
  readonly additionalProperties: false;
806
806
  };
807
- readonly anonymousUserEmail: {
807
+ readonly optionalEmail: {
808
808
  readonly type: "object";
809
809
  readonly properties: {
810
- readonly enabled: {
810
+ readonly hide: {
811
811
  readonly type: "boolean";
812
812
  readonly default: false;
813
813
  };
@@ -850,28 +850,34 @@ export declare const themeConfigSchema: {
850
850
  };
851
851
  readonly additionalProperties: false;
852
852
  };
853
- readonly facets: {
854
- readonly type: "array";
855
- readonly items: {
856
- readonly type: "object";
857
- readonly required: readonly ["name", "field", "type"];
858
- readonly properties: {
859
- readonly name: {
860
- readonly type: "string";
861
- };
862
- readonly field: {
863
- readonly type: "string";
864
- };
865
- readonly type: {
866
- readonly type: "string";
867
- readonly enum: readonly ["multi-select", "select", "tags"];
868
- };
869
- readonly isTop: {
870
- readonly type: "boolean";
853
+ readonly filters: {
854
+ readonly type: "object";
855
+ readonly properties: {
856
+ readonly hide: {
857
+ readonly type: "boolean";
858
+ };
859
+ readonly facets: {
860
+ readonly type: "array";
861
+ readonly items: {
862
+ readonly type: "object";
863
+ readonly required: readonly ["name", "field", "type"];
864
+ readonly properties: {
865
+ readonly name: {
866
+ readonly type: "string";
867
+ };
868
+ readonly field: {
869
+ readonly type: "string";
870
+ };
871
+ readonly type: {
872
+ readonly type: "string";
873
+ readonly enum: readonly ["multi-select", "select", "tags"];
874
+ };
875
+ };
876
+ readonly additionalProperties: false;
871
877
  };
872
878
  };
873
- readonly additionalProperties: false;
874
879
  };
880
+ readonly additionalProperties: false;
875
881
  };
876
882
  readonly placement: {
877
883
  readonly type: "string";
@@ -2699,10 +2705,10 @@ export declare const themeConfigSchema: {
2699
2705
  };
2700
2706
  readonly additionalProperties: false;
2701
2707
  };
2702
- readonly anonymousUserEmail: {
2708
+ readonly optionalEmail: {
2703
2709
  readonly type: "object";
2704
2710
  readonly properties: {
2705
- readonly enabled: {
2711
+ readonly hide: {
2706
2712
  readonly type: "boolean";
2707
2713
  readonly default: false;
2708
2714
  };
@@ -3297,10 +3303,10 @@ export declare const themeConfigSchema: {
3297
3303
  };
3298
3304
  readonly additionalProperties: false;
3299
3305
  };
3300
- readonly anonymousUserEmail: {
3306
+ readonly optionalEmail: {
3301
3307
  readonly type: "object";
3302
3308
  readonly properties: {
3303
- readonly enabled: {
3309
+ readonly hide: {
3304
3310
  readonly type: "boolean";
3305
3311
  readonly default: false;
3306
3312
  };
@@ -4794,10 +4800,10 @@ export declare const closedThemeConfigSchema: {
4794
4800
  };
4795
4801
  readonly additionalProperties: false;
4796
4802
  };
4797
- readonly anonymousUserEmail: {
4803
+ readonly optionalEmail: {
4798
4804
  readonly type: "object";
4799
4805
  readonly properties: {
4800
- readonly enabled: {
4806
+ readonly hide: {
4801
4807
  readonly type: "boolean";
4802
4808
  readonly default: false;
4803
4809
  };
@@ -4840,28 +4846,34 @@ export declare const closedThemeConfigSchema: {
4840
4846
  };
4841
4847
  readonly additionalProperties: false;
4842
4848
  };
4843
- readonly facets: {
4844
- readonly type: "array";
4845
- readonly items: {
4846
- readonly type: "object";
4847
- readonly required: readonly ["name", "field", "type"];
4848
- readonly properties: {
4849
- readonly name: {
4850
- readonly type: "string";
4851
- };
4852
- readonly field: {
4853
- readonly type: "string";
4854
- };
4855
- readonly type: {
4856
- readonly type: "string";
4857
- readonly enum: readonly ["multi-select", "select", "tags"];
4858
- };
4859
- readonly isTop: {
4860
- readonly type: "boolean";
4849
+ readonly filters: {
4850
+ readonly type: "object";
4851
+ readonly properties: {
4852
+ readonly hide: {
4853
+ readonly type: "boolean";
4854
+ };
4855
+ readonly facets: {
4856
+ readonly type: "array";
4857
+ readonly items: {
4858
+ readonly type: "object";
4859
+ readonly required: readonly ["name", "field", "type"];
4860
+ readonly properties: {
4861
+ readonly name: {
4862
+ readonly type: "string";
4863
+ };
4864
+ readonly field: {
4865
+ readonly type: "string";
4866
+ };
4867
+ readonly type: {
4868
+ readonly type: "string";
4869
+ readonly enum: readonly ["multi-select", "select", "tags"];
4870
+ };
4871
+ };
4872
+ readonly additionalProperties: false;
4861
4873
  };
4862
4874
  };
4863
- readonly additionalProperties: false;
4864
4875
  };
4876
+ readonly additionalProperties: false;
4865
4877
  };
4866
4878
  readonly placement: {
4867
4879
  readonly type: "string";
@@ -6689,10 +6701,10 @@ export declare const closedThemeConfigSchema: {
6689
6701
  };
6690
6702
  readonly additionalProperties: false;
6691
6703
  };
6692
- readonly anonymousUserEmail: {
6704
+ readonly optionalEmail: {
6693
6705
  readonly type: "object";
6694
6706
  readonly properties: {
6695
- readonly enabled: {
6707
+ readonly hide: {
6696
6708
  readonly type: "boolean";
6697
6709
  readonly default: false;
6698
6710
  };
@@ -7287,10 +7299,10 @@ export declare const closedThemeConfigSchema: {
7287
7299
  };
7288
7300
  readonly additionalProperties: false;
7289
7301
  };
7290
- readonly anonymousUserEmail: {
7302
+ readonly optionalEmail: {
7291
7303
  readonly type: "object";
7292
7304
  readonly properties: {
7293
- readonly enabled: {
7305
+ readonly hide: {
7294
7306
  readonly type: "boolean";
7295
7307
  readonly default: false;
7296
7308
  };
package/lib/ex-theme-config-schemas.d.ts CHANGED
@@ -216,13 +216,39 @@ export declare const searchFacetsConfigSchema: {
216
216
  readonly type: "string";
217
217
  readonly enum: readonly ["multi-select", "select", "tags"];
218
218
  };
219
- readonly isTop: {
220
- readonly type: "boolean";
221
- };
222
219
  };
223
220
  readonly additionalProperties: false;
224
221
  };
225
222
  };
223
+ export declare const searchFiltersConfigSchema: {
224
+ readonly type: "object";
225
+ readonly properties: {
226
+ readonly hide: {
227
+ readonly type: "boolean";
228
+ };
229
+ readonly facets: {
230
+ readonly type: "array";
231
+ readonly items: {
232
+ readonly type: "object";
233
+ readonly required: readonly ["name", "field", "type"];
234
+ readonly properties: {
235
+ readonly name: {
236
+ readonly type: "string";
237
+ };
238
+ readonly field: {
239
+ readonly type: "string";
240
+ };
241
+ readonly type: {
242
+ readonly type: "string";
243
+ readonly enum: readonly ["multi-select", "select", "tags"];
244
+ };
245
+ };
246
+ readonly additionalProperties: false;
247
+ };
248
+ };
249
+ };
250
+ readonly additionalProperties: false;
251
+ };
226
252
  export declare const logoConfigSchema: {
227
253
  readonly type: "object";
228
254
  readonly properties: {
@@ -827,28 +853,34 @@ export declare const searchConfigSchema: {
827
853
  };
828
854
  readonly additionalProperties: false;
829
855
  };
830
- readonly facets: {
831
- readonly type: "array";
832
- readonly items: {
833
- readonly type: "object";
834
- readonly required: readonly ["name", "field", "type"];
835
- readonly properties: {
836
- readonly name: {
837
- readonly type: "string";
838
- };
839
- readonly field: {
840
- readonly type: "string";
841
- };
842
- readonly type: {
843
- readonly type: "string";
844
- readonly enum: readonly ["multi-select", "select", "tags"];
845
- };
846
- readonly isTop: {
847
- readonly type: "boolean";
856
+ readonly filters: {
857
+ readonly type: "object";
858
+ readonly properties: {
859
+ readonly hide: {
860
+ readonly type: "boolean";
861
+ };
862
+ readonly facets: {
863
+ readonly type: "array";
864
+ readonly items: {
865
+ readonly type: "object";
866
+ readonly required: readonly ["name", "field", "type"];
867
+ readonly properties: {
868
+ readonly name: {
869
+ readonly type: "string";
870
+ };
871
+ readonly field: {
872
+ readonly type: "string";
873
+ };
874
+ readonly type: {
875
+ readonly type: "string";
876
+ readonly enum: readonly ["multi-select", "select", "tags"];
877
+ };
878
+ };
879
+ readonly additionalProperties: false;
848
880
  };
849
881
  };
850
- readonly additionalProperties: false;
851
882
  };
883
+ readonly additionalProperties: false;
852
884
  };
853
885
  readonly placement: {
854
886
  readonly type: "string";
@@ -2676,10 +2708,10 @@ export declare const openapiConfigSchema: {
2676
2708
  };
2677
2709
  readonly additionalProperties: false;
2678
2710
  };
2679
- readonly anonymousUserEmail: {
2711
+ readonly optionalEmail: {
2680
2712
  readonly type: "object";
2681
2713
  readonly properties: {
2682
- readonly enabled: {
2714
+ readonly hide: {
2683
2715
  readonly type: "boolean";
2684
2716
  readonly default: false;
2685
2717
  };
package/lib/ex-theme-config-schemas.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.scorecardConfigSchema = exports.catalogsConfigSchema = exports.catalogSchema = exports.catalogFilterSchema = exports.breadcrumbsConfigSchema = exports.versionPickerConfigSchema = exports.userMenuConfigSchema = exports.analyticsConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.openapiConfigSchema = exports.markdownConfigSchema = exports.codeSnippetConfigSchema = exports.navigationConfigSchema = exports.colorModeConfigSchema = exports.searchConfigSchema = exports.linksConfigSchema = exports.scriptsConfigSchema = exports.sidebarConfigSchema = exports.footerConfigSchema = exports.productsConfigSchema = exports.navbarConfigSchema = exports.logoConfigSchema = exports.searchFacetsConfigSchema = exports.aiSearchConfigSchema = exports.productConfigSchema = exports.navItemsSchema = void 0;
3
+ exports.scorecardConfigSchema = exports.catalogsConfigSchema = exports.catalogSchema = exports.catalogFilterSchema = exports.breadcrumbsConfigSchema = exports.versionPickerConfigSchema = exports.userMenuConfigSchema = exports.analyticsConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.openapiConfigSchema = exports.markdownConfigSchema = exports.codeSnippetConfigSchema = exports.navigationConfigSchema = exports.colorModeConfigSchema = exports.searchConfigSchema = exports.linksConfigSchema = exports.scriptsConfigSchema = exports.sidebarConfigSchema = exports.footerConfigSchema = exports.productsConfigSchema = exports.navbarConfigSchema = exports.logoConfigSchema = exports.searchFiltersConfigSchema = exports.searchFacetsConfigSchema = exports.aiSearchConfigSchema = exports.productConfigSchema = exports.navItemsSchema = void 0;
4
4
  const redoc_config_schema_1 = require("./redoc-config-schema");
5
5
  const reference_docs_config_schema_1 = require("./reference-docs-config-schema");
6
6
  const hideConfigSchema = {
@@ -105,11 +105,15 @@ exports.searchFacetsConfigSchema = {
105
105
  type: 'string',
106
106
  enum: ['multi-select', 'select', 'tags'],
107
107
  },
108
- isTop: { type: 'boolean' },
109
108
  },
110
109
  additionalProperties: false,
111
110
  },
112
111
  };
112
+ exports.searchFiltersConfigSchema = {
113
+ type: 'object',
114
+ properties: Object.assign({ facets: exports.searchFacetsConfigSchema }, hideConfigSchema.properties),
115
+ additionalProperties: false,
116
+ };
113
117
  const searchSuggestedPageSchema = {
114
118
  type: 'object',
115
119
  properties: {
@@ -192,7 +196,7 @@ exports.searchConfigSchema = {
192
196
  type: 'string',
193
197
  enum: ['flexsearch', 'typesense'],
194
198
  default: 'flexsearch',
195
- }, ai: exports.aiSearchConfigSchema, facets: exports.searchFacetsConfigSchema, placement: {
199
+ }, ai: exports.aiSearchConfigSchema, filters: exports.searchFiltersConfigSchema, placement: {
196
200
  type: 'string',
197
201
  default: 'navbar',
198
202
  }, shortcuts: {
package/lib/feedback-config-schema.d.ts CHANGED
@@ -22,10 +22,10 @@ export declare const reasonsSettings: {
22
22
  };
23
23
  readonly additionalProperties: false;
24
24
  };
25
- export declare const anonymousUserEmailSettings: {
25
+ export declare const optionalEmailSettings: {
26
26
  readonly type: "object";
27
27
  readonly properties: {
28
- readonly enabled: {
28
+ readonly hide: {
29
29
  readonly type: "boolean";
30
30
  readonly default: false;
31
31
  };
@@ -252,10 +252,10 @@ export declare const feedbackConfigSchema: {
252
252
  };
253
253
  readonly additionalProperties: false;
254
254
  };
255
- readonly anonymousUserEmail: {
255
+ readonly optionalEmail: {
256
256
  readonly type: "object";
257
257
  readonly properties: {
258
- readonly enabled: {
258
+ readonly hide: {
259
259
  readonly type: "boolean";
260
260
  readonly default: false;
261
261
  };
package/lib/feedback-config-schema.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.feedbackConfigSchema = exports.anonymousUserEmailSettings = exports.reasonsSettings = void 0;
3
+ exports.feedbackConfigSchema = exports.optionalEmailSettings = exports.reasonsSettings = void 0;
4
4
  const reasonsBaseProperties = {
5
5
  hide: {
6
6
  type: 'boolean',
@@ -19,10 +19,10 @@ exports.reasonsSettings = {
19
19
  properties: reasonsBaseProperties,
20
20
  additionalProperties: false,
21
21
  };
22
- exports.anonymousUserEmailSettings = {
22
+ exports.optionalEmailSettings = {
23
23
  type: 'object',
24
24
  properties: {
25
- enabled: {
25
+ hide: {
26
26
  type: 'boolean',
27
27
  default: false,
28
28
  },
@@ -78,7 +78,7 @@ exports.feedbackConfigSchema = {
78
78
  },
79
79
  additionalProperties: false,
80
80
  },
81
- anonymousUserEmail: exports.anonymousUserEmailSettings,
81
+ optionalEmail: exports.optionalEmailSettings,
82
82
  },
83
83
  additionalProperties: false,
84
84
  },
package/lib/graphql-config-schema.d.ts CHANGED
@@ -391,10 +391,10 @@ export declare const graphqlConfigSchema: {
391
391
  };
392
392
  readonly additionalProperties: false;
393
393
  };
394
- readonly anonymousUserEmail: {
394
+ readonly optionalEmail: {
395
395
  readonly type: "object";
396
396
  readonly properties: {
397
- readonly enabled: {
397
+ readonly hide: {
398
398
  readonly type: "boolean";
399
399
  readonly default: false;
400
400
  };
package/lib/index.d.ts CHANGED
@@ -2,5 +2,4 @@ export { productThemeOverrideSchema, productConfigOverrideSchema } from './produ
2
2
  export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema';
3
3
  export { redocConfigSchema } from './redoc-config-schema';
4
4
  export * from './types';
5
- export * from './portal-shared-types';
6
5
  export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, } from './constants';
package/lib/index.js CHANGED
@@ -24,7 +24,6 @@ Object.defineProperty(exports, "rootRedoclyConfigSchema", { enumerable: true, ge
24
24
  var redoc_config_schema_1 = require("./redoc-config-schema");
25
25
  Object.defineProperty(exports, "redocConfigSchema", { enumerable: true, get: function () { return redoc_config_schema_1.redocConfigSchema; } });
26
26
  __exportStar(require("./types"), exports);
27
- __exportStar(require("./portal-shared-types"), exports);
28
27
  var constants_1 = require("./constants");
29
28
  Object.defineProperty(exports, "ApigeeDevOnboardingIntegrationAuthType", { enumerable: true, get: function () { return constants_1.ApigeeDevOnboardingIntegrationAuthType; } });
30
29
  Object.defineProperty(exports, "AuthProviderType", { enumerable: true, get: function () { return constants_1.AuthProviderType; } });