@redocly/config 0.16.0 → 0.17.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 +24 -4
- package/lib/ex-theme-config-schemas.d.ts +25 -2
- package/lib/ex-theme-config-schemas.js +15 -4
- package/lib/product-override-schema.d.ts +36 -6
- package/lib/reunite-config-schema.d.ts +9 -2
- package/lib/reunite-config-schema.js +9 -1
- package/lib/root-config-schema.d.ts +96 -17
- package/lib/types.d.ts +2 -0
- package/lib-esm/default-theme-config-schema.d.ts +24 -4
- package/lib-esm/ex-theme-config-schemas.d.ts +25 -2
- package/lib-esm/ex-theme-config-schemas.js +14 -3
- package/lib-esm/product-override-schema.d.ts +36 -6
- package/lib-esm/reunite-config-schema.d.ts +9 -2
- package/lib-esm/reunite-config-schema.js +9 -1
- package/lib-esm/root-config-schema.d.ts +96 -17
- package/lib-esm/types.d.ts +2 -0
- package/package.json +1 -1
|
@@ -821,8 +821,18 @@ export declare const themeConfigSchema: {
|
|
|
821
821
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
822
822
|
readonly default: "flexsearch";
|
|
823
823
|
};
|
|
824
|
-
readonly
|
|
825
|
-
readonly type: "
|
|
824
|
+
readonly ai: {
|
|
825
|
+
readonly type: "object";
|
|
826
|
+
readonly properties: {
|
|
827
|
+
readonly hide: {
|
|
828
|
+
readonly type: "boolean";
|
|
829
|
+
readonly default: false;
|
|
830
|
+
};
|
|
831
|
+
readonly prompt: {
|
|
832
|
+
readonly type: "string";
|
|
833
|
+
};
|
|
834
|
+
};
|
|
835
|
+
readonly additionalProperties: false;
|
|
826
836
|
};
|
|
827
837
|
readonly facets: {
|
|
828
838
|
readonly type: "array";
|
|
@@ -4747,8 +4757,18 @@ export declare const closedThemeConfigSchema: {
|
|
|
4747
4757
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
4748
4758
|
readonly default: "flexsearch";
|
|
4749
4759
|
};
|
|
4750
|
-
readonly
|
|
4751
|
-
readonly type: "
|
|
4760
|
+
readonly ai: {
|
|
4761
|
+
readonly type: "object";
|
|
4762
|
+
readonly properties: {
|
|
4763
|
+
readonly hide: {
|
|
4764
|
+
readonly type: "boolean";
|
|
4765
|
+
readonly default: false;
|
|
4766
|
+
};
|
|
4767
|
+
readonly prompt: {
|
|
4768
|
+
readonly type: "string";
|
|
4769
|
+
};
|
|
4770
|
+
};
|
|
4771
|
+
readonly additionalProperties: false;
|
|
4752
4772
|
};
|
|
4753
4773
|
readonly facets: {
|
|
4754
4774
|
readonly type: "array";
|
|
@@ -187,6 +187,19 @@ export declare const productConfigSchema: {
|
|
|
187
187
|
readonly additionalProperties: false;
|
|
188
188
|
readonly required: readonly ["name", "folder"];
|
|
189
189
|
};
|
|
190
|
+
export declare const aiSearchConfigSchema: {
|
|
191
|
+
readonly type: "object";
|
|
192
|
+
readonly properties: {
|
|
193
|
+
readonly hide: {
|
|
194
|
+
readonly type: "boolean";
|
|
195
|
+
readonly default: false;
|
|
196
|
+
};
|
|
197
|
+
readonly prompt: {
|
|
198
|
+
readonly type: "string";
|
|
199
|
+
};
|
|
200
|
+
};
|
|
201
|
+
readonly additionalProperties: false;
|
|
202
|
+
};
|
|
190
203
|
export declare const searchFacetsConfigSchema: {
|
|
191
204
|
readonly type: "array";
|
|
192
205
|
readonly items: {
|
|
@@ -801,8 +814,18 @@ export declare const searchConfigSchema: {
|
|
|
801
814
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
802
815
|
readonly default: "flexsearch";
|
|
803
816
|
};
|
|
804
|
-
readonly
|
|
805
|
-
readonly type: "
|
|
817
|
+
readonly ai: {
|
|
818
|
+
readonly type: "object";
|
|
819
|
+
readonly properties: {
|
|
820
|
+
readonly hide: {
|
|
821
|
+
readonly type: "boolean";
|
|
822
|
+
readonly default: false;
|
|
823
|
+
};
|
|
824
|
+
readonly prompt: {
|
|
825
|
+
readonly type: "string";
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
readonly additionalProperties: false;
|
|
806
829
|
};
|
|
807
830
|
readonly facets: {
|
|
808
831
|
readonly type: "array";
|
|
@@ -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.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.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 = {
|
|
@@ -80,6 +80,19 @@ exports.productConfigSchema = {
|
|
|
80
80
|
additionalProperties: false,
|
|
81
81
|
required: ['name', 'folder'],
|
|
82
82
|
};
|
|
83
|
+
exports.aiSearchConfigSchema = {
|
|
84
|
+
type: 'object',
|
|
85
|
+
properties: {
|
|
86
|
+
hide: {
|
|
87
|
+
type: 'boolean',
|
|
88
|
+
default: false,
|
|
89
|
+
},
|
|
90
|
+
prompt: {
|
|
91
|
+
type: 'string',
|
|
92
|
+
},
|
|
93
|
+
},
|
|
94
|
+
additionalProperties: false,
|
|
95
|
+
};
|
|
83
96
|
exports.searchFacetsConfigSchema = {
|
|
84
97
|
type: 'array',
|
|
85
98
|
items: {
|
|
@@ -179,9 +192,7 @@ exports.searchConfigSchema = {
|
|
|
179
192
|
type: 'string',
|
|
180
193
|
enum: ['flexsearch', 'typesense'],
|
|
181
194
|
default: 'flexsearch',
|
|
182
|
-
},
|
|
183
|
-
type: 'boolean',
|
|
184
|
-
}, facets: exports.searchFacetsConfigSchema, placement: {
|
|
195
|
+
}, ai: exports.aiSearchConfigSchema, facets: exports.searchFacetsConfigSchema, placement: {
|
|
185
196
|
type: 'string',
|
|
186
197
|
default: 'navbar',
|
|
187
198
|
}, shortcuts: {
|
|
@@ -426,8 +426,18 @@ export declare const productThemeOverrideSchema: {
|
|
|
426
426
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
427
427
|
readonly default: "flexsearch";
|
|
428
428
|
};
|
|
429
|
-
readonly
|
|
430
|
-
readonly type: "
|
|
429
|
+
readonly ai: {
|
|
430
|
+
readonly type: "object";
|
|
431
|
+
readonly properties: {
|
|
432
|
+
readonly hide: {
|
|
433
|
+
readonly type: "boolean";
|
|
434
|
+
readonly default: false;
|
|
435
|
+
};
|
|
436
|
+
readonly prompt: {
|
|
437
|
+
readonly type: "string";
|
|
438
|
+
};
|
|
439
|
+
};
|
|
440
|
+
readonly additionalProperties: false;
|
|
431
441
|
};
|
|
432
442
|
readonly facets: {
|
|
433
443
|
readonly type: "array";
|
|
@@ -7502,8 +7512,18 @@ export declare const productConfigOverrideSchema: {
|
|
|
7502
7512
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
7503
7513
|
readonly default: "flexsearch";
|
|
7504
7514
|
};
|
|
7505
|
-
readonly
|
|
7506
|
-
readonly type: "
|
|
7515
|
+
readonly ai: {
|
|
7516
|
+
readonly type: "object";
|
|
7517
|
+
readonly properties: {
|
|
7518
|
+
readonly hide: {
|
|
7519
|
+
readonly type: "boolean";
|
|
7520
|
+
readonly default: false;
|
|
7521
|
+
};
|
|
7522
|
+
readonly prompt: {
|
|
7523
|
+
readonly type: "string";
|
|
7524
|
+
};
|
|
7525
|
+
};
|
|
7526
|
+
readonly additionalProperties: false;
|
|
7507
7527
|
};
|
|
7508
7528
|
readonly facets: {
|
|
7509
7529
|
readonly type: "array";
|
|
@@ -10129,8 +10149,18 @@ export declare const productConfigOverrideSchema: {
|
|
|
10129
10149
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
10130
10150
|
readonly default: "flexsearch";
|
|
10131
10151
|
};
|
|
10132
|
-
readonly
|
|
10133
|
-
readonly type: "
|
|
10152
|
+
readonly ai: {
|
|
10153
|
+
readonly type: "object";
|
|
10154
|
+
readonly properties: {
|
|
10155
|
+
readonly hide: {
|
|
10156
|
+
readonly type: "boolean";
|
|
10157
|
+
readonly default: false;
|
|
10158
|
+
};
|
|
10159
|
+
readonly prompt: {
|
|
10160
|
+
readonly type: "string";
|
|
10161
|
+
};
|
|
10162
|
+
};
|
|
10163
|
+
readonly additionalProperties: false;
|
|
10134
10164
|
};
|
|
10135
10165
|
readonly facets: {
|
|
10136
10166
|
readonly type: "array";
|
|
@@ -2,8 +2,15 @@ export declare const reuniteConfigSchema: {
|
|
|
2
2
|
readonly type: "object";
|
|
3
3
|
readonly properties: {
|
|
4
4
|
readonly ignoreLint: {
|
|
5
|
-
readonly
|
|
6
|
-
|
|
5
|
+
readonly oneOf: readonly [{
|
|
6
|
+
readonly type: "boolean";
|
|
7
|
+
readonly default: false;
|
|
8
|
+
}, {
|
|
9
|
+
readonly type: "object";
|
|
10
|
+
readonly additionalProperties: {
|
|
11
|
+
readonly type: "boolean";
|
|
12
|
+
};
|
|
13
|
+
}];
|
|
7
14
|
};
|
|
8
15
|
readonly ignoreLinkChecker: {
|
|
9
16
|
readonly type: "boolean";
|
|
@@ -4,7 +4,15 @@ exports.reuniteConfigSchema = void 0;
|
|
|
4
4
|
exports.reuniteConfigSchema = {
|
|
5
5
|
type: 'object',
|
|
6
6
|
properties: {
|
|
7
|
-
ignoreLint: {
|
|
7
|
+
ignoreLint: {
|
|
8
|
+
oneOf: [
|
|
9
|
+
{ type: 'boolean', default: false },
|
|
10
|
+
{
|
|
11
|
+
type: 'object',
|
|
12
|
+
additionalProperties: { type: 'boolean' },
|
|
13
|
+
},
|
|
14
|
+
],
|
|
15
|
+
},
|
|
8
16
|
ignoreLinkChecker: { type: 'boolean' },
|
|
9
17
|
ignoreMarkdocErrors: { type: 'boolean' },
|
|
10
18
|
},
|
|
@@ -11416,8 +11416,18 @@ export declare const redoclyConfigSchema: {
|
|
|
11416
11416
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
11417
11417
|
readonly default: "flexsearch";
|
|
11418
11418
|
};
|
|
11419
|
-
readonly
|
|
11420
|
-
readonly type: "
|
|
11419
|
+
readonly ai: {
|
|
11420
|
+
readonly type: "object";
|
|
11421
|
+
readonly properties: {
|
|
11422
|
+
readonly hide: {
|
|
11423
|
+
readonly type: "boolean";
|
|
11424
|
+
readonly default: false;
|
|
11425
|
+
};
|
|
11426
|
+
readonly prompt: {
|
|
11427
|
+
readonly type: "string";
|
|
11428
|
+
};
|
|
11429
|
+
};
|
|
11430
|
+
readonly additionalProperties: false;
|
|
11421
11431
|
};
|
|
11422
11432
|
readonly facets: {
|
|
11423
11433
|
readonly type: "array";
|
|
@@ -14522,8 +14532,15 @@ export declare const redoclyConfigSchema: {
|
|
|
14522
14532
|
readonly type: "object";
|
|
14523
14533
|
readonly properties: {
|
|
14524
14534
|
readonly ignoreLint: {
|
|
14525
|
-
readonly
|
|
14526
|
-
|
|
14535
|
+
readonly oneOf: readonly [{
|
|
14536
|
+
readonly type: "boolean";
|
|
14537
|
+
readonly default: false;
|
|
14538
|
+
}, {
|
|
14539
|
+
readonly type: "object";
|
|
14540
|
+
readonly additionalProperties: {
|
|
14541
|
+
readonly type: "boolean";
|
|
14542
|
+
};
|
|
14543
|
+
}];
|
|
14527
14544
|
};
|
|
14528
14545
|
readonly ignoreLinkChecker: {
|
|
14529
14546
|
readonly type: "boolean";
|
|
@@ -15345,8 +15362,18 @@ export declare const redoclyConfigSchema: {
|
|
|
15345
15362
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
15346
15363
|
readonly default: "flexsearch";
|
|
15347
15364
|
};
|
|
15348
|
-
readonly
|
|
15349
|
-
readonly type: "
|
|
15365
|
+
readonly ai: {
|
|
15366
|
+
readonly type: "object";
|
|
15367
|
+
readonly properties: {
|
|
15368
|
+
readonly hide: {
|
|
15369
|
+
readonly type: "boolean";
|
|
15370
|
+
readonly default: false;
|
|
15371
|
+
};
|
|
15372
|
+
readonly prompt: {
|
|
15373
|
+
readonly type: "string";
|
|
15374
|
+
};
|
|
15375
|
+
};
|
|
15376
|
+
readonly additionalProperties: false;
|
|
15350
15377
|
};
|
|
15351
15378
|
readonly facets: {
|
|
15352
15379
|
readonly type: "array";
|
|
@@ -19129,8 +19156,17 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
19129
19156
|
enum: ("flexsearch" | "typesense")[];
|
|
19130
19157
|
type: "string";
|
|
19131
19158
|
};
|
|
19132
|
-
|
|
19133
|
-
|
|
19159
|
+
ai: {
|
|
19160
|
+
properties: {
|
|
19161
|
+
hide: {
|
|
19162
|
+
type: "boolean";
|
|
19163
|
+
};
|
|
19164
|
+
prompt: {
|
|
19165
|
+
type: "string";
|
|
19166
|
+
};
|
|
19167
|
+
};
|
|
19168
|
+
additionalProperties: false;
|
|
19169
|
+
type: "object";
|
|
19134
19170
|
};
|
|
19135
19171
|
facets: {
|
|
19136
19172
|
items: {
|
|
@@ -26118,7 +26154,14 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
26118
26154
|
reunite: {
|
|
26119
26155
|
properties: {
|
|
26120
26156
|
ignoreLint: {
|
|
26121
|
-
|
|
26157
|
+
oneOf: ({
|
|
26158
|
+
type: "boolean";
|
|
26159
|
+
} | {
|
|
26160
|
+
additionalProperties: {
|
|
26161
|
+
type: "boolean";
|
|
26162
|
+
};
|
|
26163
|
+
type: "object";
|
|
26164
|
+
})[];
|
|
26122
26165
|
};
|
|
26123
26166
|
ignoreLinkChecker: {
|
|
26124
26167
|
type: "boolean";
|
|
@@ -26380,8 +26423,17 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
26380
26423
|
enum: ("flexsearch" | "typesense")[];
|
|
26381
26424
|
type: "string";
|
|
26382
26425
|
};
|
|
26383
|
-
|
|
26384
|
-
|
|
26426
|
+
ai: {
|
|
26427
|
+
properties: {
|
|
26428
|
+
hide: {
|
|
26429
|
+
type: "boolean";
|
|
26430
|
+
};
|
|
26431
|
+
prompt: {
|
|
26432
|
+
type: "string";
|
|
26433
|
+
};
|
|
26434
|
+
};
|
|
26435
|
+
additionalProperties: false;
|
|
26436
|
+
type: "object";
|
|
26385
26437
|
};
|
|
26386
26438
|
facets: {
|
|
26387
26439
|
items: {
|
|
@@ -34785,8 +34837,18 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
34785
34837
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
34786
34838
|
readonly default: "flexsearch";
|
|
34787
34839
|
};
|
|
34788
|
-
readonly
|
|
34789
|
-
readonly type: "
|
|
34840
|
+
readonly ai: {
|
|
34841
|
+
readonly type: "object";
|
|
34842
|
+
readonly properties: {
|
|
34843
|
+
readonly hide: {
|
|
34844
|
+
readonly type: "boolean";
|
|
34845
|
+
readonly default: false;
|
|
34846
|
+
};
|
|
34847
|
+
readonly prompt: {
|
|
34848
|
+
readonly type: "string";
|
|
34849
|
+
};
|
|
34850
|
+
};
|
|
34851
|
+
readonly additionalProperties: false;
|
|
34790
34852
|
};
|
|
34791
34853
|
readonly facets: {
|
|
34792
34854
|
readonly type: "array";
|
|
@@ -37891,8 +37953,15 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
37891
37953
|
readonly type: "object";
|
|
37892
37954
|
readonly properties: {
|
|
37893
37955
|
readonly ignoreLint: {
|
|
37894
|
-
readonly
|
|
37895
|
-
|
|
37956
|
+
readonly oneOf: readonly [{
|
|
37957
|
+
readonly type: "boolean";
|
|
37958
|
+
readonly default: false;
|
|
37959
|
+
}, {
|
|
37960
|
+
readonly type: "object";
|
|
37961
|
+
readonly additionalProperties: {
|
|
37962
|
+
readonly type: "boolean";
|
|
37963
|
+
};
|
|
37964
|
+
}];
|
|
37896
37965
|
};
|
|
37897
37966
|
readonly ignoreLinkChecker: {
|
|
37898
37967
|
readonly type: "boolean";
|
|
@@ -38714,8 +38783,18 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
38714
38783
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
38715
38784
|
readonly default: "flexsearch";
|
|
38716
38785
|
};
|
|
38717
|
-
readonly
|
|
38718
|
-
readonly type: "
|
|
38786
|
+
readonly ai: {
|
|
38787
|
+
readonly type: "object";
|
|
38788
|
+
readonly properties: {
|
|
38789
|
+
readonly hide: {
|
|
38790
|
+
readonly type: "boolean";
|
|
38791
|
+
readonly default: false;
|
|
38792
|
+
};
|
|
38793
|
+
readonly prompt: {
|
|
38794
|
+
readonly type: "string";
|
|
38795
|
+
};
|
|
38796
|
+
};
|
|
38797
|
+
readonly additionalProperties: false;
|
|
38719
38798
|
};
|
|
38720
38799
|
readonly facets: {
|
|
38721
38800
|
readonly type: "array";
|
package/lib/types.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ import type { RedocConfigTypes } from './redoc-types';
|
|
|
6
6
|
import type { GraphQLConfigTypes } from './graphql-types';
|
|
7
7
|
import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from './ex-theme-config-schemas';
|
|
8
8
|
import type { reasonsSettingsSchema } from './feedback-config-schema';
|
|
9
|
+
import type { reuniteConfigSchema } from './reunite-config-schema';
|
|
9
10
|
/**
|
|
10
11
|
* @deprecated left for backwards compatibility. To be removed in Realm 1.0
|
|
11
12
|
*/
|
|
@@ -24,6 +25,7 @@ export type GtmAnalyticsConfig = FromSchema<typeof gtmAnalyticsConfigSchema>;
|
|
|
24
25
|
export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchema>;
|
|
25
26
|
export type CatalogConfig = FromSchema<typeof catalogSchema>;
|
|
26
27
|
export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
|
|
28
|
+
export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
|
|
27
29
|
export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
|
|
28
30
|
export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
|
|
29
31
|
export type RedoclyConfig = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
|
|
@@ -821,8 +821,18 @@ export declare const themeConfigSchema: {
|
|
|
821
821
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
822
822
|
readonly default: "flexsearch";
|
|
823
823
|
};
|
|
824
|
-
readonly
|
|
825
|
-
readonly type: "
|
|
824
|
+
readonly ai: {
|
|
825
|
+
readonly type: "object";
|
|
826
|
+
readonly properties: {
|
|
827
|
+
readonly hide: {
|
|
828
|
+
readonly type: "boolean";
|
|
829
|
+
readonly default: false;
|
|
830
|
+
};
|
|
831
|
+
readonly prompt: {
|
|
832
|
+
readonly type: "string";
|
|
833
|
+
};
|
|
834
|
+
};
|
|
835
|
+
readonly additionalProperties: false;
|
|
826
836
|
};
|
|
827
837
|
readonly facets: {
|
|
828
838
|
readonly type: "array";
|
|
@@ -4747,8 +4757,18 @@ export declare const closedThemeConfigSchema: {
|
|
|
4747
4757
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
4748
4758
|
readonly default: "flexsearch";
|
|
4749
4759
|
};
|
|
4750
|
-
readonly
|
|
4751
|
-
readonly type: "
|
|
4760
|
+
readonly ai: {
|
|
4761
|
+
readonly type: "object";
|
|
4762
|
+
readonly properties: {
|
|
4763
|
+
readonly hide: {
|
|
4764
|
+
readonly type: "boolean";
|
|
4765
|
+
readonly default: false;
|
|
4766
|
+
};
|
|
4767
|
+
readonly prompt: {
|
|
4768
|
+
readonly type: "string";
|
|
4769
|
+
};
|
|
4770
|
+
};
|
|
4771
|
+
readonly additionalProperties: false;
|
|
4752
4772
|
};
|
|
4753
4773
|
readonly facets: {
|
|
4754
4774
|
readonly type: "array";
|
|
@@ -187,6 +187,19 @@ export declare const productConfigSchema: {
|
|
|
187
187
|
readonly additionalProperties: false;
|
|
188
188
|
readonly required: readonly ["name", "folder"];
|
|
189
189
|
};
|
|
190
|
+
export declare const aiSearchConfigSchema: {
|
|
191
|
+
readonly type: "object";
|
|
192
|
+
readonly properties: {
|
|
193
|
+
readonly hide: {
|
|
194
|
+
readonly type: "boolean";
|
|
195
|
+
readonly default: false;
|
|
196
|
+
};
|
|
197
|
+
readonly prompt: {
|
|
198
|
+
readonly type: "string";
|
|
199
|
+
};
|
|
200
|
+
};
|
|
201
|
+
readonly additionalProperties: false;
|
|
202
|
+
};
|
|
190
203
|
export declare const searchFacetsConfigSchema: {
|
|
191
204
|
readonly type: "array";
|
|
192
205
|
readonly items: {
|
|
@@ -801,8 +814,18 @@ export declare const searchConfigSchema: {
|
|
|
801
814
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
802
815
|
readonly default: "flexsearch";
|
|
803
816
|
};
|
|
804
|
-
readonly
|
|
805
|
-
readonly type: "
|
|
817
|
+
readonly ai: {
|
|
818
|
+
readonly type: "object";
|
|
819
|
+
readonly properties: {
|
|
820
|
+
readonly hide: {
|
|
821
|
+
readonly type: "boolean";
|
|
822
|
+
readonly default: false;
|
|
823
|
+
};
|
|
824
|
+
readonly prompt: {
|
|
825
|
+
readonly type: "string";
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
readonly additionalProperties: false;
|
|
806
829
|
};
|
|
807
830
|
readonly facets: {
|
|
808
831
|
readonly type: "array";
|
|
@@ -77,6 +77,19 @@ export const productConfigSchema = {
|
|
|
77
77
|
additionalProperties: false,
|
|
78
78
|
required: ['name', 'folder'],
|
|
79
79
|
};
|
|
80
|
+
export const aiSearchConfigSchema = {
|
|
81
|
+
type: 'object',
|
|
82
|
+
properties: {
|
|
83
|
+
hide: {
|
|
84
|
+
type: 'boolean',
|
|
85
|
+
default: false,
|
|
86
|
+
},
|
|
87
|
+
prompt: {
|
|
88
|
+
type: 'string',
|
|
89
|
+
},
|
|
90
|
+
},
|
|
91
|
+
additionalProperties: false,
|
|
92
|
+
};
|
|
80
93
|
export const searchFacetsConfigSchema = {
|
|
81
94
|
type: 'array',
|
|
82
95
|
items: {
|
|
@@ -176,9 +189,7 @@ export const searchConfigSchema = {
|
|
|
176
189
|
type: 'string',
|
|
177
190
|
enum: ['flexsearch', 'typesense'],
|
|
178
191
|
default: 'flexsearch',
|
|
179
|
-
},
|
|
180
|
-
type: 'boolean',
|
|
181
|
-
}, facets: searchFacetsConfigSchema, placement: {
|
|
192
|
+
}, ai: aiSearchConfigSchema, facets: searchFacetsConfigSchema, placement: {
|
|
182
193
|
type: 'string',
|
|
183
194
|
default: 'navbar',
|
|
184
195
|
}, shortcuts: {
|
|
@@ -426,8 +426,18 @@ export declare const productThemeOverrideSchema: {
|
|
|
426
426
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
427
427
|
readonly default: "flexsearch";
|
|
428
428
|
};
|
|
429
|
-
readonly
|
|
430
|
-
readonly type: "
|
|
429
|
+
readonly ai: {
|
|
430
|
+
readonly type: "object";
|
|
431
|
+
readonly properties: {
|
|
432
|
+
readonly hide: {
|
|
433
|
+
readonly type: "boolean";
|
|
434
|
+
readonly default: false;
|
|
435
|
+
};
|
|
436
|
+
readonly prompt: {
|
|
437
|
+
readonly type: "string";
|
|
438
|
+
};
|
|
439
|
+
};
|
|
440
|
+
readonly additionalProperties: false;
|
|
431
441
|
};
|
|
432
442
|
readonly facets: {
|
|
433
443
|
readonly type: "array";
|
|
@@ -7502,8 +7512,18 @@ export declare const productConfigOverrideSchema: {
|
|
|
7502
7512
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
7503
7513
|
readonly default: "flexsearch";
|
|
7504
7514
|
};
|
|
7505
|
-
readonly
|
|
7506
|
-
readonly type: "
|
|
7515
|
+
readonly ai: {
|
|
7516
|
+
readonly type: "object";
|
|
7517
|
+
readonly properties: {
|
|
7518
|
+
readonly hide: {
|
|
7519
|
+
readonly type: "boolean";
|
|
7520
|
+
readonly default: false;
|
|
7521
|
+
};
|
|
7522
|
+
readonly prompt: {
|
|
7523
|
+
readonly type: "string";
|
|
7524
|
+
};
|
|
7525
|
+
};
|
|
7526
|
+
readonly additionalProperties: false;
|
|
7507
7527
|
};
|
|
7508
7528
|
readonly facets: {
|
|
7509
7529
|
readonly type: "array";
|
|
@@ -10129,8 +10149,18 @@ export declare const productConfigOverrideSchema: {
|
|
|
10129
10149
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
10130
10150
|
readonly default: "flexsearch";
|
|
10131
10151
|
};
|
|
10132
|
-
readonly
|
|
10133
|
-
readonly type: "
|
|
10152
|
+
readonly ai: {
|
|
10153
|
+
readonly type: "object";
|
|
10154
|
+
readonly properties: {
|
|
10155
|
+
readonly hide: {
|
|
10156
|
+
readonly type: "boolean";
|
|
10157
|
+
readonly default: false;
|
|
10158
|
+
};
|
|
10159
|
+
readonly prompt: {
|
|
10160
|
+
readonly type: "string";
|
|
10161
|
+
};
|
|
10162
|
+
};
|
|
10163
|
+
readonly additionalProperties: false;
|
|
10134
10164
|
};
|
|
10135
10165
|
readonly facets: {
|
|
10136
10166
|
readonly type: "array";
|
|
@@ -2,8 +2,15 @@ export declare const reuniteConfigSchema: {
|
|
|
2
2
|
readonly type: "object";
|
|
3
3
|
readonly properties: {
|
|
4
4
|
readonly ignoreLint: {
|
|
5
|
-
readonly
|
|
6
|
-
|
|
5
|
+
readonly oneOf: readonly [{
|
|
6
|
+
readonly type: "boolean";
|
|
7
|
+
readonly default: false;
|
|
8
|
+
}, {
|
|
9
|
+
readonly type: "object";
|
|
10
|
+
readonly additionalProperties: {
|
|
11
|
+
readonly type: "boolean";
|
|
12
|
+
};
|
|
13
|
+
}];
|
|
7
14
|
};
|
|
8
15
|
readonly ignoreLinkChecker: {
|
|
9
16
|
readonly type: "boolean";
|
|
@@ -1,7 +1,15 @@
|
|
|
1
1
|
export const reuniteConfigSchema = {
|
|
2
2
|
type: 'object',
|
|
3
3
|
properties: {
|
|
4
|
-
ignoreLint: {
|
|
4
|
+
ignoreLint: {
|
|
5
|
+
oneOf: [
|
|
6
|
+
{ type: 'boolean', default: false },
|
|
7
|
+
{
|
|
8
|
+
type: 'object',
|
|
9
|
+
additionalProperties: { type: 'boolean' },
|
|
10
|
+
},
|
|
11
|
+
],
|
|
12
|
+
},
|
|
5
13
|
ignoreLinkChecker: { type: 'boolean' },
|
|
6
14
|
ignoreMarkdocErrors: { type: 'boolean' },
|
|
7
15
|
},
|
|
@@ -11416,8 +11416,18 @@ export declare const redoclyConfigSchema: {
|
|
|
11416
11416
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
11417
11417
|
readonly default: "flexsearch";
|
|
11418
11418
|
};
|
|
11419
|
-
readonly
|
|
11420
|
-
readonly type: "
|
|
11419
|
+
readonly ai: {
|
|
11420
|
+
readonly type: "object";
|
|
11421
|
+
readonly properties: {
|
|
11422
|
+
readonly hide: {
|
|
11423
|
+
readonly type: "boolean";
|
|
11424
|
+
readonly default: false;
|
|
11425
|
+
};
|
|
11426
|
+
readonly prompt: {
|
|
11427
|
+
readonly type: "string";
|
|
11428
|
+
};
|
|
11429
|
+
};
|
|
11430
|
+
readonly additionalProperties: false;
|
|
11421
11431
|
};
|
|
11422
11432
|
readonly facets: {
|
|
11423
11433
|
readonly type: "array";
|
|
@@ -14522,8 +14532,15 @@ export declare const redoclyConfigSchema: {
|
|
|
14522
14532
|
readonly type: "object";
|
|
14523
14533
|
readonly properties: {
|
|
14524
14534
|
readonly ignoreLint: {
|
|
14525
|
-
readonly
|
|
14526
|
-
|
|
14535
|
+
readonly oneOf: readonly [{
|
|
14536
|
+
readonly type: "boolean";
|
|
14537
|
+
readonly default: false;
|
|
14538
|
+
}, {
|
|
14539
|
+
readonly type: "object";
|
|
14540
|
+
readonly additionalProperties: {
|
|
14541
|
+
readonly type: "boolean";
|
|
14542
|
+
};
|
|
14543
|
+
}];
|
|
14527
14544
|
};
|
|
14528
14545
|
readonly ignoreLinkChecker: {
|
|
14529
14546
|
readonly type: "boolean";
|
|
@@ -15345,8 +15362,18 @@ export declare const redoclyConfigSchema: {
|
|
|
15345
15362
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
15346
15363
|
readonly default: "flexsearch";
|
|
15347
15364
|
};
|
|
15348
|
-
readonly
|
|
15349
|
-
readonly type: "
|
|
15365
|
+
readonly ai: {
|
|
15366
|
+
readonly type: "object";
|
|
15367
|
+
readonly properties: {
|
|
15368
|
+
readonly hide: {
|
|
15369
|
+
readonly type: "boolean";
|
|
15370
|
+
readonly default: false;
|
|
15371
|
+
};
|
|
15372
|
+
readonly prompt: {
|
|
15373
|
+
readonly type: "string";
|
|
15374
|
+
};
|
|
15375
|
+
};
|
|
15376
|
+
readonly additionalProperties: false;
|
|
15350
15377
|
};
|
|
15351
15378
|
readonly facets: {
|
|
15352
15379
|
readonly type: "array";
|
|
@@ -19129,8 +19156,17 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
19129
19156
|
enum: ("flexsearch" | "typesense")[];
|
|
19130
19157
|
type: "string";
|
|
19131
19158
|
};
|
|
19132
|
-
|
|
19133
|
-
|
|
19159
|
+
ai: {
|
|
19160
|
+
properties: {
|
|
19161
|
+
hide: {
|
|
19162
|
+
type: "boolean";
|
|
19163
|
+
};
|
|
19164
|
+
prompt: {
|
|
19165
|
+
type: "string";
|
|
19166
|
+
};
|
|
19167
|
+
};
|
|
19168
|
+
additionalProperties: false;
|
|
19169
|
+
type: "object";
|
|
19134
19170
|
};
|
|
19135
19171
|
facets: {
|
|
19136
19172
|
items: {
|
|
@@ -26118,7 +26154,14 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
26118
26154
|
reunite: {
|
|
26119
26155
|
properties: {
|
|
26120
26156
|
ignoreLint: {
|
|
26121
|
-
|
|
26157
|
+
oneOf: ({
|
|
26158
|
+
type: "boolean";
|
|
26159
|
+
} | {
|
|
26160
|
+
additionalProperties: {
|
|
26161
|
+
type: "boolean";
|
|
26162
|
+
};
|
|
26163
|
+
type: "object";
|
|
26164
|
+
})[];
|
|
26122
26165
|
};
|
|
26123
26166
|
ignoreLinkChecker: {
|
|
26124
26167
|
type: "boolean";
|
|
@@ -26380,8 +26423,17 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
26380
26423
|
enum: ("flexsearch" | "typesense")[];
|
|
26381
26424
|
type: "string";
|
|
26382
26425
|
};
|
|
26383
|
-
|
|
26384
|
-
|
|
26426
|
+
ai: {
|
|
26427
|
+
properties: {
|
|
26428
|
+
hide: {
|
|
26429
|
+
type: "boolean";
|
|
26430
|
+
};
|
|
26431
|
+
prompt: {
|
|
26432
|
+
type: "string";
|
|
26433
|
+
};
|
|
26434
|
+
};
|
|
26435
|
+
additionalProperties: false;
|
|
26436
|
+
type: "object";
|
|
26385
26437
|
};
|
|
26386
26438
|
facets: {
|
|
26387
26439
|
items: {
|
|
@@ -34785,8 +34837,18 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
34785
34837
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
34786
34838
|
readonly default: "flexsearch";
|
|
34787
34839
|
};
|
|
34788
|
-
readonly
|
|
34789
|
-
readonly type: "
|
|
34840
|
+
readonly ai: {
|
|
34841
|
+
readonly type: "object";
|
|
34842
|
+
readonly properties: {
|
|
34843
|
+
readonly hide: {
|
|
34844
|
+
readonly type: "boolean";
|
|
34845
|
+
readonly default: false;
|
|
34846
|
+
};
|
|
34847
|
+
readonly prompt: {
|
|
34848
|
+
readonly type: "string";
|
|
34849
|
+
};
|
|
34850
|
+
};
|
|
34851
|
+
readonly additionalProperties: false;
|
|
34790
34852
|
};
|
|
34791
34853
|
readonly facets: {
|
|
34792
34854
|
readonly type: "array";
|
|
@@ -37891,8 +37953,15 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
37891
37953
|
readonly type: "object";
|
|
37892
37954
|
readonly properties: {
|
|
37893
37955
|
readonly ignoreLint: {
|
|
37894
|
-
readonly
|
|
37895
|
-
|
|
37956
|
+
readonly oneOf: readonly [{
|
|
37957
|
+
readonly type: "boolean";
|
|
37958
|
+
readonly default: false;
|
|
37959
|
+
}, {
|
|
37960
|
+
readonly type: "object";
|
|
37961
|
+
readonly additionalProperties: {
|
|
37962
|
+
readonly type: "boolean";
|
|
37963
|
+
};
|
|
37964
|
+
}];
|
|
37896
37965
|
};
|
|
37897
37966
|
readonly ignoreLinkChecker: {
|
|
37898
37967
|
readonly type: "boolean";
|
|
@@ -38714,8 +38783,18 @@ export declare const rootRedoclyConfigSchema: {
|
|
|
38714
38783
|
readonly enum: readonly ["flexsearch", "typesense"];
|
|
38715
38784
|
readonly default: "flexsearch";
|
|
38716
38785
|
};
|
|
38717
|
-
readonly
|
|
38718
|
-
readonly type: "
|
|
38786
|
+
readonly ai: {
|
|
38787
|
+
readonly type: "object";
|
|
38788
|
+
readonly properties: {
|
|
38789
|
+
readonly hide: {
|
|
38790
|
+
readonly type: "boolean";
|
|
38791
|
+
readonly default: false;
|
|
38792
|
+
};
|
|
38793
|
+
readonly prompt: {
|
|
38794
|
+
readonly type: "string";
|
|
38795
|
+
};
|
|
38796
|
+
};
|
|
38797
|
+
readonly additionalProperties: false;
|
|
38719
38798
|
};
|
|
38720
38799
|
readonly facets: {
|
|
38721
38800
|
readonly type: "array";
|
package/lib-esm/types.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ import type { RedocConfigTypes } from './redoc-types';
|
|
|
6
6
|
import type { GraphQLConfigTypes } from './graphql-types';
|
|
7
7
|
import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from './ex-theme-config-schemas';
|
|
8
8
|
import type { reasonsSettingsSchema } from './feedback-config-schema';
|
|
9
|
+
import type { reuniteConfigSchema } from './reunite-config-schema';
|
|
9
10
|
/**
|
|
10
11
|
* @deprecated left for backwards compatibility. To be removed in Realm 1.0
|
|
11
12
|
*/
|
|
@@ -24,6 +25,7 @@ export type GtmAnalyticsConfig = FromSchema<typeof gtmAnalyticsConfigSchema>;
|
|
|
24
25
|
export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchema>;
|
|
25
26
|
export type CatalogConfig = FromSchema<typeof catalogSchema>;
|
|
26
27
|
export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
|
|
28
|
+
export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
|
|
27
29
|
export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
|
|
28
30
|
export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
|
|
29
31
|
export type RedoclyConfig = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
|