@redocly/config 0.17.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.
@@ -821,8 +821,18 @@ export declare const themeConfigSchema: {
821
821
  readonly enum: readonly ["flexsearch", "typesense"];
822
822
  readonly default: "flexsearch";
823
823
  };
824
- readonly askAi: {
825
- readonly type: "boolean";
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 askAi: {
4751
- readonly type: "boolean";
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 askAi: {
805
- readonly type: "boolean";
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
- }, askAi: {
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 askAi: {
430
- readonly type: "boolean";
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 askAi: {
7506
- readonly type: "boolean";
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 askAi: {
10133
- readonly type: "boolean";
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";
@@ -11416,8 +11416,18 @@ export declare const redoclyConfigSchema: {
11416
11416
  readonly enum: readonly ["flexsearch", "typesense"];
11417
11417
  readonly default: "flexsearch";
11418
11418
  };
11419
- readonly askAi: {
11420
- readonly type: "boolean";
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";
@@ -15352,8 +15362,18 @@ export declare const redoclyConfigSchema: {
15352
15362
  readonly enum: readonly ["flexsearch", "typesense"];
15353
15363
  readonly default: "flexsearch";
15354
15364
  };
15355
- readonly askAi: {
15356
- readonly type: "boolean";
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;
15357
15377
  };
15358
15378
  readonly facets: {
15359
15379
  readonly type: "array";
@@ -19136,8 +19156,17 @@ export declare const rootRedoclyConfigSchema: {
19136
19156
  enum: ("flexsearch" | "typesense")[];
19137
19157
  type: "string";
19138
19158
  };
19139
- askAi: {
19140
- type: "boolean";
19159
+ ai: {
19160
+ properties: {
19161
+ hide: {
19162
+ type: "boolean";
19163
+ };
19164
+ prompt: {
19165
+ type: "string";
19166
+ };
19167
+ };
19168
+ additionalProperties: false;
19169
+ type: "object";
19141
19170
  };
19142
19171
  facets: {
19143
19172
  items: {
@@ -26394,8 +26423,17 @@ export declare const rootRedoclyConfigSchema: {
26394
26423
  enum: ("flexsearch" | "typesense")[];
26395
26424
  type: "string";
26396
26425
  };
26397
- askAi: {
26398
- type: "boolean";
26426
+ ai: {
26427
+ properties: {
26428
+ hide: {
26429
+ type: "boolean";
26430
+ };
26431
+ prompt: {
26432
+ type: "string";
26433
+ };
26434
+ };
26435
+ additionalProperties: false;
26436
+ type: "object";
26399
26437
  };
26400
26438
  facets: {
26401
26439
  items: {
@@ -34799,8 +34837,18 @@ export declare const rootRedoclyConfigSchema: {
34799
34837
  readonly enum: readonly ["flexsearch", "typesense"];
34800
34838
  readonly default: "flexsearch";
34801
34839
  };
34802
- readonly askAi: {
34803
- readonly type: "boolean";
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;
34804
34852
  };
34805
34853
  readonly facets: {
34806
34854
  readonly type: "array";
@@ -38735,8 +38783,18 @@ export declare const rootRedoclyConfigSchema: {
38735
38783
  readonly enum: readonly ["flexsearch", "typesense"];
38736
38784
  readonly default: "flexsearch";
38737
38785
  };
38738
- readonly askAi: {
38739
- readonly type: "boolean";
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;
38740
38798
  };
38741
38799
  readonly facets: {
38742
38800
  readonly type: "array";
@@ -821,8 +821,18 @@ export declare const themeConfigSchema: {
821
821
  readonly enum: readonly ["flexsearch", "typesense"];
822
822
  readonly default: "flexsearch";
823
823
  };
824
- readonly askAi: {
825
- readonly type: "boolean";
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 askAi: {
4751
- readonly type: "boolean";
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 askAi: {
805
- readonly type: "boolean";
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
- }, askAi: {
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 askAi: {
430
- readonly type: "boolean";
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 askAi: {
7506
- readonly type: "boolean";
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 askAi: {
10133
- readonly type: "boolean";
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";