@redocly/config 0.11.0 → 0.12.1
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/lib/default-theme-config-schema.d.ts +56 -8
- package/lib/ex-theme-config-schemas.d.ts +51 -4
- package/lib/ex-theme-config-schemas.js +25 -7
- package/lib/product-override-schema.d.ts +84 -12
- package/lib/root-config-schema.d.ts +231 -64
- package/lib/root-config-schema.js +8 -0
- package/lib/types.d.ts +2 -1
- package/lib-esm/default-theme-config-schema.d.ts +56 -8
- package/lib-esm/ex-theme-config-schemas.d.ts +51 -4
- package/lib-esm/ex-theme-config-schemas.js +24 -6
- package/lib-esm/product-override-schema.d.ts +84 -12
- package/lib-esm/root-config-schema.d.ts +231 -64
- package/lib-esm/root-config-schema.js +8 -0
- package/lib-esm/types.d.ts +2 -1
- package/package.json +1 -1
|
@@ -696,6 +696,34 @@ export declare const themeConfigSchema: {
|
|
|
696
696
|
readonly hide: {
|
|
697
697
|
readonly type: "boolean";
|
|
698
698
|
};
|
|
699
|
+
readonly engine: {
|
|
700
|
+
readonly type: "string";
|
|
701
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
702
|
+
readonly default: "flexsearch";
|
|
703
|
+
};
|
|
704
|
+
readonly facets: {
|
|
705
|
+
readonly type: "array";
|
|
706
|
+
readonly items: {
|
|
707
|
+
readonly type: "object";
|
|
708
|
+
readonly required: readonly ["name", "field", "type"];
|
|
709
|
+
readonly properties: {
|
|
710
|
+
readonly name: {
|
|
711
|
+
readonly type: "string";
|
|
712
|
+
};
|
|
713
|
+
readonly field: {
|
|
714
|
+
readonly type: "string";
|
|
715
|
+
};
|
|
716
|
+
readonly type: {
|
|
717
|
+
readonly type: "string";
|
|
718
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
719
|
+
};
|
|
720
|
+
readonly isTop: {
|
|
721
|
+
readonly type: "boolean";
|
|
722
|
+
};
|
|
723
|
+
};
|
|
724
|
+
readonly additionalProperties: false;
|
|
725
|
+
};
|
|
726
|
+
};
|
|
699
727
|
readonly placement: {
|
|
700
728
|
readonly type: "string";
|
|
701
729
|
readonly default: "navbar";
|
|
@@ -725,10 +753,6 @@ export declare const themeConfigSchema: {
|
|
|
725
753
|
readonly required: readonly ["page"];
|
|
726
754
|
};
|
|
727
755
|
};
|
|
728
|
-
readonly fuzzy: {
|
|
729
|
-
readonly type: "boolean";
|
|
730
|
-
readonly default: false;
|
|
731
|
-
};
|
|
732
756
|
};
|
|
733
757
|
readonly additionalProperties: false;
|
|
734
758
|
};
|
|
@@ -4238,6 +4262,34 @@ export declare const closedThemeConfigSchema: {
|
|
|
4238
4262
|
readonly hide: {
|
|
4239
4263
|
readonly type: "boolean";
|
|
4240
4264
|
};
|
|
4265
|
+
readonly engine: {
|
|
4266
|
+
readonly type: "string";
|
|
4267
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
4268
|
+
readonly default: "flexsearch";
|
|
4269
|
+
};
|
|
4270
|
+
readonly facets: {
|
|
4271
|
+
readonly type: "array";
|
|
4272
|
+
readonly items: {
|
|
4273
|
+
readonly type: "object";
|
|
4274
|
+
readonly required: readonly ["name", "field", "type"];
|
|
4275
|
+
readonly properties: {
|
|
4276
|
+
readonly name: {
|
|
4277
|
+
readonly type: "string";
|
|
4278
|
+
};
|
|
4279
|
+
readonly field: {
|
|
4280
|
+
readonly type: "string";
|
|
4281
|
+
};
|
|
4282
|
+
readonly type: {
|
|
4283
|
+
readonly type: "string";
|
|
4284
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
4285
|
+
};
|
|
4286
|
+
readonly isTop: {
|
|
4287
|
+
readonly type: "boolean";
|
|
4288
|
+
};
|
|
4289
|
+
};
|
|
4290
|
+
readonly additionalProperties: false;
|
|
4291
|
+
};
|
|
4292
|
+
};
|
|
4241
4293
|
readonly placement: {
|
|
4242
4294
|
readonly type: "string";
|
|
4243
4295
|
readonly default: "navbar";
|
|
@@ -4267,10 +4319,6 @@ export declare const closedThemeConfigSchema: {
|
|
|
4267
4319
|
readonly required: readonly ["page"];
|
|
4268
4320
|
};
|
|
4269
4321
|
};
|
|
4270
|
-
readonly fuzzy: {
|
|
4271
|
-
readonly type: "boolean";
|
|
4272
|
-
readonly default: false;
|
|
4273
|
-
};
|
|
4274
4322
|
};
|
|
4275
4323
|
readonly additionalProperties: false;
|
|
4276
4324
|
};
|
|
@@ -187,6 +187,29 @@ export declare const productConfigSchema: {
|
|
|
187
187
|
readonly additionalProperties: false;
|
|
188
188
|
readonly required: readonly ["name", "folder"];
|
|
189
189
|
};
|
|
190
|
+
export declare const searchFacetsConfigSchema: {
|
|
191
|
+
readonly type: "array";
|
|
192
|
+
readonly items: {
|
|
193
|
+
readonly type: "object";
|
|
194
|
+
readonly required: readonly ["name", "field", "type"];
|
|
195
|
+
readonly properties: {
|
|
196
|
+
readonly name: {
|
|
197
|
+
readonly type: "string";
|
|
198
|
+
};
|
|
199
|
+
readonly field: {
|
|
200
|
+
readonly type: "string";
|
|
201
|
+
};
|
|
202
|
+
readonly type: {
|
|
203
|
+
readonly type: "string";
|
|
204
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
205
|
+
};
|
|
206
|
+
readonly isTop: {
|
|
207
|
+
readonly type: "boolean";
|
|
208
|
+
};
|
|
209
|
+
};
|
|
210
|
+
readonly additionalProperties: false;
|
|
211
|
+
};
|
|
212
|
+
};
|
|
190
213
|
export declare const logoConfigSchema: {
|
|
191
214
|
readonly type: "object";
|
|
192
215
|
readonly properties: {
|
|
@@ -773,6 +796,34 @@ export declare const searchConfigSchema: {
|
|
|
773
796
|
readonly hide: {
|
|
774
797
|
readonly type: "boolean";
|
|
775
798
|
};
|
|
799
|
+
readonly engine: {
|
|
800
|
+
readonly type: "string";
|
|
801
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
802
|
+
readonly default: "flexsearch";
|
|
803
|
+
};
|
|
804
|
+
readonly facets: {
|
|
805
|
+
readonly type: "array";
|
|
806
|
+
readonly items: {
|
|
807
|
+
readonly type: "object";
|
|
808
|
+
readonly required: readonly ["name", "field", "type"];
|
|
809
|
+
readonly properties: {
|
|
810
|
+
readonly name: {
|
|
811
|
+
readonly type: "string";
|
|
812
|
+
};
|
|
813
|
+
readonly field: {
|
|
814
|
+
readonly type: "string";
|
|
815
|
+
};
|
|
816
|
+
readonly type: {
|
|
817
|
+
readonly type: "string";
|
|
818
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
819
|
+
};
|
|
820
|
+
readonly isTop: {
|
|
821
|
+
readonly type: "boolean";
|
|
822
|
+
};
|
|
823
|
+
};
|
|
824
|
+
readonly additionalProperties: false;
|
|
825
|
+
};
|
|
826
|
+
};
|
|
776
827
|
readonly placement: {
|
|
777
828
|
readonly type: "string";
|
|
778
829
|
readonly default: "navbar";
|
|
@@ -802,10 +853,6 @@ export declare const searchConfigSchema: {
|
|
|
802
853
|
readonly required: readonly ["page"];
|
|
803
854
|
};
|
|
804
855
|
};
|
|
805
|
-
readonly fuzzy: {
|
|
806
|
-
readonly type: "boolean";
|
|
807
|
-
readonly default: false;
|
|
808
|
-
};
|
|
809
856
|
};
|
|
810
857
|
readonly additionalProperties: false;
|
|
811
858
|
};
|
|
@@ -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.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.searchFacetsConfigSchema = 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 = {
|
|
@@ -80,7 +80,24 @@ exports.productConfigSchema = {
|
|
|
80
80
|
additionalProperties: false,
|
|
81
81
|
required: ['name', 'folder'],
|
|
82
82
|
};
|
|
83
|
-
|
|
83
|
+
exports.searchFacetsConfigSchema = {
|
|
84
|
+
type: 'array',
|
|
85
|
+
items: {
|
|
86
|
+
type: 'object',
|
|
87
|
+
required: ['name', 'field', 'type'],
|
|
88
|
+
properties: {
|
|
89
|
+
name: { type: 'string' },
|
|
90
|
+
field: { type: 'string' },
|
|
91
|
+
type: {
|
|
92
|
+
type: 'string',
|
|
93
|
+
enum: ['multi-select', 'select', 'tags'],
|
|
94
|
+
},
|
|
95
|
+
isTop: { type: 'boolean' },
|
|
96
|
+
},
|
|
97
|
+
additionalProperties: false,
|
|
98
|
+
},
|
|
99
|
+
};
|
|
100
|
+
const searchSuggestedPageSchema = {
|
|
84
101
|
type: 'object',
|
|
85
102
|
properties: {
|
|
86
103
|
page: { type: 'string' },
|
|
@@ -158,7 +175,11 @@ exports.linksConfigSchema = {
|
|
|
158
175
|
};
|
|
159
176
|
exports.searchConfigSchema = {
|
|
160
177
|
type: 'object',
|
|
161
|
-
properties: Object.assign({
|
|
178
|
+
properties: Object.assign({ engine: {
|
|
179
|
+
type: 'string',
|
|
180
|
+
enum: ['flexsearch', 'typesense'],
|
|
181
|
+
default: 'flexsearch',
|
|
182
|
+
}, facets: exports.searchFacetsConfigSchema, placement: {
|
|
162
183
|
type: 'string',
|
|
163
184
|
default: 'navbar',
|
|
164
185
|
}, shortcuts: {
|
|
@@ -167,10 +188,7 @@ exports.searchConfigSchema = {
|
|
|
167
188
|
default: ['/'],
|
|
168
189
|
}, suggestedPages: {
|
|
169
190
|
type: 'array',
|
|
170
|
-
items:
|
|
171
|
-
}, fuzzy: {
|
|
172
|
-
type: 'boolean',
|
|
173
|
-
default: false,
|
|
191
|
+
items: searchSuggestedPageSchema,
|
|
174
192
|
} }, hideConfigSchema.properties),
|
|
175
193
|
additionalProperties: false,
|
|
176
194
|
};
|
|
@@ -421,6 +421,34 @@ export declare const productThemeOverrideSchema: {
|
|
|
421
421
|
readonly hide: {
|
|
422
422
|
readonly type: "boolean";
|
|
423
423
|
};
|
|
424
|
+
readonly engine: {
|
|
425
|
+
readonly type: "string";
|
|
426
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
427
|
+
readonly default: "flexsearch";
|
|
428
|
+
};
|
|
429
|
+
readonly facets: {
|
|
430
|
+
readonly type: "array";
|
|
431
|
+
readonly items: {
|
|
432
|
+
readonly type: "object";
|
|
433
|
+
readonly required: readonly ["name", "field", "type"];
|
|
434
|
+
readonly properties: {
|
|
435
|
+
readonly name: {
|
|
436
|
+
readonly type: "string";
|
|
437
|
+
};
|
|
438
|
+
readonly field: {
|
|
439
|
+
readonly type: "string";
|
|
440
|
+
};
|
|
441
|
+
readonly type: {
|
|
442
|
+
readonly type: "string";
|
|
443
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
444
|
+
};
|
|
445
|
+
readonly isTop: {
|
|
446
|
+
readonly type: "boolean";
|
|
447
|
+
};
|
|
448
|
+
};
|
|
449
|
+
readonly additionalProperties: false;
|
|
450
|
+
};
|
|
451
|
+
};
|
|
424
452
|
readonly placement: {
|
|
425
453
|
readonly type: "string";
|
|
426
454
|
readonly default: "navbar";
|
|
@@ -450,10 +478,6 @@ export declare const productThemeOverrideSchema: {
|
|
|
450
478
|
readonly required: readonly ["page"];
|
|
451
479
|
};
|
|
452
480
|
};
|
|
453
|
-
readonly fuzzy: {
|
|
454
|
-
readonly type: "boolean";
|
|
455
|
-
readonly default: false;
|
|
456
|
-
};
|
|
457
481
|
};
|
|
458
482
|
readonly additionalProperties: false;
|
|
459
483
|
};
|
|
@@ -6758,6 +6782,34 @@ export declare const productConfigOverrideSchema: {
|
|
|
6758
6782
|
readonly hide: {
|
|
6759
6783
|
readonly type: "boolean";
|
|
6760
6784
|
};
|
|
6785
|
+
readonly engine: {
|
|
6786
|
+
readonly type: "string";
|
|
6787
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
6788
|
+
readonly default: "flexsearch";
|
|
6789
|
+
};
|
|
6790
|
+
readonly facets: {
|
|
6791
|
+
readonly type: "array";
|
|
6792
|
+
readonly items: {
|
|
6793
|
+
readonly type: "object";
|
|
6794
|
+
readonly required: readonly ["name", "field", "type"];
|
|
6795
|
+
readonly properties: {
|
|
6796
|
+
readonly name: {
|
|
6797
|
+
readonly type: "string";
|
|
6798
|
+
};
|
|
6799
|
+
readonly field: {
|
|
6800
|
+
readonly type: "string";
|
|
6801
|
+
};
|
|
6802
|
+
readonly type: {
|
|
6803
|
+
readonly type: "string";
|
|
6804
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
6805
|
+
};
|
|
6806
|
+
readonly isTop: {
|
|
6807
|
+
readonly type: "boolean";
|
|
6808
|
+
};
|
|
6809
|
+
};
|
|
6810
|
+
readonly additionalProperties: false;
|
|
6811
|
+
};
|
|
6812
|
+
};
|
|
6761
6813
|
readonly placement: {
|
|
6762
6814
|
readonly type: "string";
|
|
6763
6815
|
readonly default: "navbar";
|
|
@@ -6787,10 +6839,6 @@ export declare const productConfigOverrideSchema: {
|
|
|
6787
6839
|
readonly required: readonly ["page"];
|
|
6788
6840
|
};
|
|
6789
6841
|
};
|
|
6790
|
-
readonly fuzzy: {
|
|
6791
|
-
readonly type: "boolean";
|
|
6792
|
-
readonly default: false;
|
|
6793
|
-
};
|
|
6794
6842
|
};
|
|
6795
6843
|
readonly additionalProperties: false;
|
|
6796
6844
|
};
|
|
@@ -9118,6 +9166,34 @@ export declare const productConfigOverrideSchema: {
|
|
|
9118
9166
|
readonly hide: {
|
|
9119
9167
|
readonly type: "boolean";
|
|
9120
9168
|
};
|
|
9169
|
+
readonly engine: {
|
|
9170
|
+
readonly type: "string";
|
|
9171
|
+
readonly enum: readonly ["flexsearch", "typesense"];
|
|
9172
|
+
readonly default: "flexsearch";
|
|
9173
|
+
};
|
|
9174
|
+
readonly facets: {
|
|
9175
|
+
readonly type: "array";
|
|
9176
|
+
readonly items: {
|
|
9177
|
+
readonly type: "object";
|
|
9178
|
+
readonly required: readonly ["name", "field", "type"];
|
|
9179
|
+
readonly properties: {
|
|
9180
|
+
readonly name: {
|
|
9181
|
+
readonly type: "string";
|
|
9182
|
+
};
|
|
9183
|
+
readonly field: {
|
|
9184
|
+
readonly type: "string";
|
|
9185
|
+
};
|
|
9186
|
+
readonly type: {
|
|
9187
|
+
readonly type: "string";
|
|
9188
|
+
readonly enum: readonly ["multi-select", "select", "tags"];
|
|
9189
|
+
};
|
|
9190
|
+
readonly isTop: {
|
|
9191
|
+
readonly type: "boolean";
|
|
9192
|
+
};
|
|
9193
|
+
};
|
|
9194
|
+
readonly additionalProperties: false;
|
|
9195
|
+
};
|
|
9196
|
+
};
|
|
9121
9197
|
readonly placement: {
|
|
9122
9198
|
readonly type: "string";
|
|
9123
9199
|
readonly default: "navbar";
|
|
@@ -9147,10 +9223,6 @@ export declare const productConfigOverrideSchema: {
|
|
|
9147
9223
|
readonly required: readonly ["page"];
|
|
9148
9224
|
};
|
|
9149
9225
|
};
|
|
9150
|
-
readonly fuzzy: {
|
|
9151
|
-
readonly type: "boolean";
|
|
9152
|
-
readonly default: false;
|
|
9153
|
-
};
|
|
9154
9226
|
};
|
|
9155
9227
|
readonly additionalProperties: false;
|
|
9156
9228
|
};
|