@redocly/config 0.20.1 → 0.20.3

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 (11) hide show
  1. package/lib/reunite-config-schema.d.ts +22 -0
  2. package/lib/reunite-config-schema.js +15 -0
  3. package/lib/root-config-schema.d.ts +66 -0
  4. package/lib/types/code-walkthrough-types.d.ts +12 -11
  5. package/lib/types/portal-shared-types.d.ts +10 -0
  6. package/lib-esm/reunite-config-schema.d.ts +22 -0
  7. package/lib-esm/reunite-config-schema.js +15 -0
  8. package/lib-esm/root-config-schema.d.ts +217 -151
  9. package/lib-esm/types/code-walkthrough-types.d.ts +12 -11
  10. package/lib-esm/types/portal-shared-types.d.ts +10 -0
  11. package/package.json +1 -1
package/lib/reunite-config-schema.d.ts CHANGED
@@ -62,6 +62,28 @@ export declare const reuniteConfigSchema: {
62
62
  };
63
63
  };
64
64
  };
65
+ readonly severity: {
66
+ readonly type: "object";
67
+ readonly additionalProperties: false;
68
+ readonly properties: {
69
+ readonly schemaCheck: {
70
+ readonly type: "string";
71
+ readonly enum: readonly ["error", "warn", "off"];
72
+ };
73
+ readonly statusCodeCheck: {
74
+ readonly type: "string";
75
+ readonly enum: readonly ["error", "warn", "off"];
76
+ };
77
+ readonly contentTypeCheck: {
78
+ readonly type: "string";
79
+ readonly enum: readonly ["error", "warn", "off"];
80
+ };
81
+ readonly successCriteriaCheck: {
82
+ readonly type: "string";
83
+ readonly enum: readonly ["error", "warn", "off"];
84
+ };
85
+ };
86
+ };
65
87
  };
66
88
  readonly required: readonly ["path", "trigger", "agent"];
67
89
  readonly additionalProperties: false;
package/lib/reunite-config-schema.js CHANGED
@@ -15,6 +15,20 @@ const jobServersSchema = {
15
15
  },
16
16
  },
17
17
  };
18
+ const severitySchema = {
19
+ type: 'string',
20
+ enum: ['error', 'warn', 'off'],
21
+ };
22
+ const jobSeveritySchema = {
23
+ type: 'object',
24
+ additionalProperties: false,
25
+ properties: {
26
+ schemaCheck: severitySchema,
27
+ statusCodeCheck: severitySchema,
28
+ contentTypeCheck: severitySchema,
29
+ successCriteriaCheck: severitySchema,
30
+ },
31
+ };
18
32
  const jobTriggerSchema = {
19
33
  type: 'object',
20
34
  additionalProperties: false,
@@ -57,6 +71,7 @@ exports.reuniteConfigSchema = {
57
71
  trigger: jobTriggerSchema,
58
72
  inputs: jobInputsSchema,
59
73
  servers: jobServersSchema,
74
+ severity: jobSeveritySchema,
60
75
  },
61
76
  required: ['path', 'trigger', 'agent'],
62
77
  additionalProperties: false,
package/lib/root-config-schema.d.ts CHANGED
@@ -14804,6 +14804,28 @@ export declare const redoclyConfigSchema: {
14804
14804
  };
14805
14805
  };
14806
14806
  };
14807
+ readonly severity: {
14808
+ readonly type: "object";
14809
+ readonly additionalProperties: false;
14810
+ readonly properties: {
14811
+ readonly schemaCheck: {
14812
+ readonly type: "string";
14813
+ readonly enum: readonly ["error", "warn", "off"];
14814
+ };
14815
+ readonly statusCodeCheck: {
14816
+ readonly type: "string";
14817
+ readonly enum: readonly ["error", "warn", "off"];
14818
+ };
14819
+ readonly contentTypeCheck: {
14820
+ readonly type: "string";
14821
+ readonly enum: readonly ["error", "warn", "off"];
14822
+ };
14823
+ readonly successCriteriaCheck: {
14824
+ readonly type: "string";
14825
+ readonly enum: readonly ["error", "warn", "off"];
14826
+ };
14827
+ };
14828
+ };
14807
14829
  };
14808
14830
  readonly required: readonly ["path", "trigger", "agent"];
14809
14831
  readonly additionalProperties: false;
@@ -26457,6 +26479,28 @@ export declare const rootRedoclyConfigSchema: {
26457
26479
  additionalProperties: false;
26458
26480
  type: "object";
26459
26481
  };
26482
+ severity: {
26483
+ properties: {
26484
+ schemaCheck: {
26485
+ enum: ("off" | "error" | "warn")[];
26486
+ type: "string";
26487
+ };
26488
+ statusCodeCheck: {
26489
+ enum: ("off" | "error" | "warn")[];
26490
+ type: "string";
26491
+ };
26492
+ contentTypeCheck: {
26493
+ enum: ("off" | "error" | "warn")[];
26494
+ type: "string";
26495
+ };
26496
+ successCriteriaCheck: {
26497
+ enum: ("off" | "error" | "warn")[];
26498
+ type: "string";
26499
+ };
26500
+ };
26501
+ additionalProperties: false;
26502
+ type: "object";
26503
+ };
26460
26504
  };
26461
26505
  additionalProperties: false;
26462
26506
  type: "object";
@@ -38705,6 +38749,28 @@ export declare const rootRedoclyConfigSchema: {
38705
38749
  };
38706
38750
  };
38707
38751
  };
38752
+ readonly severity: {
38753
+ readonly type: "object";
38754
+ readonly additionalProperties: false;
38755
+ readonly properties: {
38756
+ readonly schemaCheck: {
38757
+ readonly type: "string";
38758
+ readonly enum: readonly ["error", "warn", "off"];
38759
+ };
38760
+ readonly statusCodeCheck: {
38761
+ readonly type: "string";
38762
+ readonly enum: readonly ["error", "warn", "off"];
38763
+ };
38764
+ readonly contentTypeCheck: {
38765
+ readonly type: "string";
38766
+ readonly enum: readonly ["error", "warn", "off"];
38767
+ };
38768
+ readonly successCriteriaCheck: {
38769
+ readonly type: "string";
38770
+ readonly enum: readonly ["error", "warn", "off"];
38771
+ };
38772
+ };
38773
+ };
38708
38774
  };
38709
38775
  readonly required: readonly ["path", "trigger", "agent"];
38710
38776
  readonly additionalProperties: false;
package/lib/types/code-walkthrough-types.d.ts CHANGED
@@ -68,16 +68,17 @@ export type CodeWalkthroughControls = {
68
68
  input: string;
69
69
  filter: string;
70
70
  };
71
- export type ControlType = keyof CodeWalkthroughControls;
72
- export type ControlTypeValue<T extends ControlType> = CodeWalkthroughControls[T];
73
- export type ControlState<T extends ControlType = ControlType> = WithConditions<{
74
- value: ControlTypeValue<T>;
71
+ export type CodeWalkthroughControlState = WithConditions<{
72
+ value: string;
73
+ render: boolean;
74
+ type: 'input';
75
+ } | {
76
+ value: string;
77
+ render: boolean;
78
+ type: 'filter';
79
+ } | {
80
+ value: boolean;
75
81
  render: boolean;
76
- type: T;
82
+ type: 'toggle';
77
83
  }>;
78
- type id = string;
79
- export type InputsState = Record<id, ControlState<'input'>>;
80
- export type TogglesState = Record<id, ControlState<'toggle'>>;
81
- export type FiltersState = Record<id, ControlState<'filter'>>;
82
- export type WalkthroughState = Record<id, InputsState | TogglesState | FiltersState>;
83
- export {};
84
+ export type CodeWalkthroughControlsState = Record<string, CodeWalkthroughControlState>;
package/lib/types/portal-shared-types.d.ts CHANGED
@@ -145,6 +145,15 @@ export type ResolvedSidebar = {
145
145
  relatedNavbarItem?: BreadcrumbItem;
146
146
  items: ResolvedNavItem[];
147
147
  };
148
+ export type CompilationError = {
149
+ message: string;
150
+ sourceFileRelativePath: string;
151
+ sourceFileLocation: {
152
+ line: number;
153
+ character?: number;
154
+ };
155
+ codeframe: string;
156
+ };
148
157
  export type PageProps = {
149
158
  metadata?: Record<string, unknown>;
150
159
  seo?: SeoConfig;
@@ -155,6 +164,7 @@ export type PageProps = {
155
164
  lastModified?: string | null;
156
165
  [k: string]: unknown;
157
166
  dynamicMarkdocComponents?: string[];
167
+ compilationErrors?: CompilationError[];
158
168
  markdown?: MdOptions;
159
169
  openapiOptions?: OpenAPIOptions;
160
170
  definitionId?: string;
package/lib-esm/reunite-config-schema.d.ts CHANGED
@@ -62,6 +62,28 @@ export declare const reuniteConfigSchema: {
62
62
  };
63
63
  };
64
64
  };
65
+ readonly severity: {
66
+ readonly type: "object";
67
+ readonly additionalProperties: false;
68
+ readonly properties: {
69
+ readonly schemaCheck: {
70
+ readonly type: "string";
71
+ readonly enum: readonly ["error", "warn", "off"];
72
+ };
73
+ readonly statusCodeCheck: {
74
+ readonly type: "string";
75
+ readonly enum: readonly ["error", "warn", "off"];
76
+ };
77
+ readonly contentTypeCheck: {
78
+ readonly type: "string";
79
+ readonly enum: readonly ["error", "warn", "off"];
80
+ };
81
+ readonly successCriteriaCheck: {
82
+ readonly type: "string";
83
+ readonly enum: readonly ["error", "warn", "off"];
84
+ };
85
+ };
86
+ };
65
87
  };
66
88
  readonly required: readonly ["path", "trigger", "agent"];
67
89
  readonly additionalProperties: false;
package/lib-esm/reunite-config-schema.js CHANGED
@@ -12,6 +12,20 @@ const jobServersSchema = {
12
12
  },
13
13
  },
14
14
  };
15
+ const severitySchema = {
16
+ type: 'string',
17
+ enum: ['error', 'warn', 'off'],
18
+ };
19
+ const jobSeveritySchema = {
20
+ type: 'object',
21
+ additionalProperties: false,
22
+ properties: {
23
+ schemaCheck: severitySchema,
24
+ statusCodeCheck: severitySchema,
25
+ contentTypeCheck: severitySchema,
26
+ successCriteriaCheck: severitySchema,
27
+ },
28
+ };
15
29
  const jobTriggerSchema = {
16
30
  type: 'object',
17
31
  additionalProperties: false,
@@ -54,6 +68,7 @@ export const reuniteConfigSchema = {
54
68
  trigger: jobTriggerSchema,
55
69
  inputs: jobInputsSchema,
56
70
  servers: jobServersSchema,
71
+ severity: jobSeveritySchema,
57
72
  },
58
73
  required: ['path', 'trigger', 'agent'],
59
74
  additionalProperties: false,
package/lib-esm/root-config-schema.d.ts CHANGED
@@ -14804,6 +14804,28 @@ export declare const redoclyConfigSchema: {
14804
14804
  };
14805
14805
  };
14806
14806
  };
14807
+ readonly severity: {
14808
+ readonly type: "object";
14809
+ readonly additionalProperties: false;
14810
+ readonly properties: {
14811
+ readonly schemaCheck: {
14812
+ readonly type: "string";
14813
+ readonly enum: readonly ["error", "warn", "off"];
14814
+ };
14815
+ readonly statusCodeCheck: {
14816
+ readonly type: "string";
14817
+ readonly enum: readonly ["error", "warn", "off"];
14818
+ };
14819
+ readonly contentTypeCheck: {
14820
+ readonly type: "string";
14821
+ readonly enum: readonly ["error", "warn", "off"];
14822
+ };
14823
+ readonly successCriteriaCheck: {
14824
+ readonly type: "string";
14825
+ readonly enum: readonly ["error", "warn", "off"];
14826
+ };
14827
+ };
14828
+ };
14807
14829
  };
14808
14830
  readonly required: readonly ["path", "trigger", "agent"];
14809
14831
  readonly additionalProperties: false;
@@ -18859,15 +18881,21 @@ export declare const rootRedoclyConfigSchema: {
18859
18881
  href: {
18860
18882
  type: "string";
18861
18883
  };
18862
- as: {
18863
- type: "string";
18864
- };
18865
18884
  crossorigin: {
18866
18885
  type: "string";
18867
18886
  };
18868
18887
  fetchpriority: {
18869
18888
  type: "string";
18870
18889
  };
18890
+ integrity: {
18891
+ type: "string";
18892
+ };
18893
+ referrerpolicy: {
18894
+ type: "string";
18895
+ };
18896
+ as: {
18897
+ type: "string";
18898
+ };
18871
18899
  hreflang: {
18872
18900
  type: "string";
18873
18901
  };
@@ -18877,18 +18905,12 @@ export declare const rootRedoclyConfigSchema: {
18877
18905
  imagesrcset: {
18878
18906
  type: "string";
18879
18907
  };
18880
- integrity: {
18881
- type: "string";
18882
- };
18883
18908
  media: {
18884
18909
  type: "string";
18885
18910
  };
18886
18911
  prefetch: {
18887
18912
  type: "string";
18888
18913
  };
18889
- referrerpolicy: {
18890
- type: "string";
18891
- };
18892
18914
  rel: {
18893
18915
  type: "string";
18894
18916
  };
@@ -18914,11 +18936,9 @@ export declare const rootRedoclyConfigSchema: {
18914
18936
  type: "string";
18915
18937
  };
18916
18938
  items: any;
18917
- href: any;
18918
18939
  page: any;
18940
+ href: any;
18919
18941
  icon: any;
18920
- separatorLine: any;
18921
- linePosition: any;
18922
18942
  directory: any;
18923
18943
  disconnect: any;
18924
18944
  group: any;
@@ -18926,6 +18946,8 @@ export declare const rootRedoclyConfigSchema: {
18926
18946
  labelTranslationKey: any;
18927
18947
  groupTranslationKey: any;
18928
18948
  separator: any;
18949
+ separatorLine: any;
18950
+ linePosition: any;
18929
18951
  version: any;
18930
18952
  menuStyle: any;
18931
18953
  expanded: any;
@@ -18937,10 +18959,10 @@ export declare const rootRedoclyConfigSchema: {
18937
18959
  };
18938
18960
  type: "array";
18939
18961
  };
18940
- href: {
18962
+ page: {
18941
18963
  type: "string";
18942
18964
  };
18943
- page: {
18965
+ href: {
18944
18966
  type: "string";
18945
18967
  };
18946
18968
  icon: {
@@ -18954,13 +18976,6 @@ export declare const rootRedoclyConfigSchema: {
18954
18976
  required: "srcSet"[];
18955
18977
  })[];
18956
18978
  };
18957
- separatorLine: {
18958
- type: "boolean";
18959
- };
18960
- linePosition: {
18961
- enum: ("top" | "bottom")[];
18962
- type: "string";
18963
- };
18964
18979
  directory: {
18965
18980
  type: "string";
18966
18981
  };
@@ -18982,6 +18997,13 @@ export declare const rootRedoclyConfigSchema: {
18982
18997
  separator: {
18983
18998
  type: "string";
18984
18999
  };
19000
+ separatorLine: {
19001
+ type: "boolean";
19002
+ };
19003
+ linePosition: {
19004
+ enum: ("top" | "bottom")[];
19005
+ type: "string";
19006
+ };
18985
19007
  version: {
18986
19008
  type: "string";
18987
19009
  };
@@ -19057,11 +19079,9 @@ export declare const rootRedoclyConfigSchema: {
19057
19079
  type: "string";
19058
19080
  };
19059
19081
  items: any;
19060
- href: any;
19061
19082
  page: any;
19083
+ href: any;
19062
19084
  icon: any;
19063
- separatorLine: any;
19064
- linePosition: any;
19065
19085
  directory: any;
19066
19086
  disconnect: any;
19067
19087
  group: any;
@@ -19069,6 +19089,8 @@ export declare const rootRedoclyConfigSchema: {
19069
19089
  labelTranslationKey: any;
19070
19090
  groupTranslationKey: any;
19071
19091
  separator: any;
19092
+ separatorLine: any;
19093
+ linePosition: any;
19072
19094
  version: any;
19073
19095
  menuStyle: any;
19074
19096
  expanded: any;
@@ -19080,10 +19102,10 @@ export declare const rootRedoclyConfigSchema: {
19080
19102
  };
19081
19103
  type: "array";
19082
19104
  };
19083
- href: {
19105
+ page: {
19084
19106
  type: "string";
19085
19107
  };
19086
- page: {
19108
+ href: {
19087
19109
  type: "string";
19088
19110
  };
19089
19111
  icon: {
@@ -19097,13 +19119,6 @@ export declare const rootRedoclyConfigSchema: {
19097
19119
  required: "srcSet"[];
19098
19120
  })[];
19099
19121
  };
19100
- separatorLine: {
19101
- type: "boolean";
19102
- };
19103
- linePosition: {
19104
- enum: ("top" | "bottom")[];
19105
- type: "string";
19106
- };
19107
19122
  directory: {
19108
19123
  type: "string";
19109
19124
  };
@@ -19125,6 +19140,13 @@ export declare const rootRedoclyConfigSchema: {
19125
19140
  separator: {
19126
19141
  type: "string";
19127
19142
  };
19143
+ separatorLine: {
19144
+ type: "boolean";
19145
+ };
19146
+ linePosition: {
19147
+ enum: ("top" | "bottom")[];
19148
+ type: "string";
19149
+ };
19128
19150
  version: {
19129
19151
  type: "string";
19130
19152
  };
@@ -19183,24 +19205,21 @@ export declare const rootRedoclyConfigSchema: {
19183
19205
  src: {
19184
19206
  type: "string";
19185
19207
  };
19208
+ async: {
19209
+ type: "boolean";
19210
+ };
19186
19211
  crossorigin: {
19187
19212
  type: "string";
19188
19213
  };
19214
+ defer: {
19215
+ type: "boolean";
19216
+ };
19189
19217
  fetchpriority: {
19190
19218
  type: "string";
19191
19219
  };
19192
19220
  integrity: {
19193
19221
  type: "string";
19194
19222
  };
19195
- referrerpolicy: {
19196
- type: "string";
19197
- };
19198
- async: {
19199
- type: "boolean";
19200
- };
19201
- defer: {
19202
- type: "boolean";
19203
- };
19204
19223
  module: {
19205
19224
  type: "boolean";
19206
19225
  };
@@ -19210,6 +19229,9 @@ export declare const rootRedoclyConfigSchema: {
19210
19229
  nonce: {
19211
19230
  type: "string";
19212
19231
  };
19232
+ referrerpolicy: {
19233
+ type: "string";
19234
+ };
19213
19235
  };
19214
19236
  additionalProperties: true;
19215
19237
  type: "object";
@@ -19226,24 +19248,21 @@ export declare const rootRedoclyConfigSchema: {
19226
19248
  src: {
19227
19249
  type: "string";
19228
19250
  };
19251
+ async: {
19252
+ type: "boolean";
19253
+ };
19229
19254
  crossorigin: {
19230
19255
  type: "string";
19231
19256
  };
19257
+ defer: {
19258
+ type: "boolean";
19259
+ };
19232
19260
  fetchpriority: {
19233
19261
  type: "string";
19234
19262
  };
19235
19263
  integrity: {
19236
19264
  type: "string";
19237
19265
  };
19238
- referrerpolicy: {
19239
- type: "string";
19240
- };
19241
- async: {
19242
- type: "boolean";
19243
- };
19244
- defer: {
19245
- type: "boolean";
19246
- };
19247
19266
  module: {
19248
19267
  type: "boolean";
19249
19268
  };
@@ -19253,6 +19272,9 @@ export declare const rootRedoclyConfigSchema: {
19253
19272
  nonce: {
19254
19273
  type: "string";
19255
19274
  };
19275
+ referrerpolicy: {
19276
+ type: "string";
19277
+ };
19256
19278
  };
19257
19279
  additionalProperties: true;
19258
19280
  type: "object";
@@ -21432,10 +21454,10 @@ export declare const rootRedoclyConfigSchema: {
21432
21454
  href: {
21433
21455
  type: "string";
21434
21456
  };
21435
- altText: {
21457
+ imageUrl: {
21436
21458
  type: "string";
21437
21459
  };
21438
- imageUrl: {
21460
+ altText: {
21439
21461
  type: "string";
21440
21462
  };
21441
21463
  };
@@ -21704,10 +21726,10 @@ export declare const rootRedoclyConfigSchema: {
21704
21726
  link: {
21705
21727
  type: "string";
21706
21728
  };
21707
- separatorLine: {
21729
+ external: {
21708
21730
  type: "boolean";
21709
21731
  };
21710
- external: {
21732
+ separatorLine: {
21711
21733
  type: "boolean";
21712
21734
  };
21713
21735
  };
@@ -21781,11 +21803,9 @@ export declare const rootRedoclyConfigSchema: {
21781
21803
  type: "string";
21782
21804
  };
21783
21805
  items: any;
21784
- href: any;
21785
21806
  page: any;
21807
+ href: any;
21786
21808
  icon: any;
21787
- separatorLine: any;
21788
- linePosition: any;
21789
21809
  directory: any;
21790
21810
  disconnect: any;
21791
21811
  group: any;
@@ -21793,6 +21813,8 @@ export declare const rootRedoclyConfigSchema: {
21793
21813
  labelTranslationKey: any;
21794
21814
  groupTranslationKey: any;
21795
21815
  separator: any;
21816
+ separatorLine: any;
21817
+ linePosition: any;
21796
21818
  version: any;
21797
21819
  menuStyle: any;
21798
21820
  expanded: any;
@@ -21804,10 +21826,10 @@ export declare const rootRedoclyConfigSchema: {
21804
21826
  };
21805
21827
  type: "array";
21806
21828
  };
21807
- href: {
21829
+ page: {
21808
21830
  type: "string";
21809
21831
  };
21810
- page: {
21832
+ href: {
21811
21833
  type: "string";
21812
21834
  };
21813
21835
  icon: {
@@ -21821,13 +21843,6 @@ export declare const rootRedoclyConfigSchema: {
21821
21843
  required: "srcSet"[];
21822
21844
  })[];
21823
21845
  };
21824
- separatorLine: {
21825
- type: "boolean";
21826
- };
21827
- linePosition: {
21828
- enum: ("top" | "bottom")[];
21829
- type: "string";
21830
- };
21831
21846
  directory: {
21832
21847
  type: "string";
21833
21848
  };
@@ -21849,6 +21864,13 @@ export declare const rootRedoclyConfigSchema: {
21849
21864
  separator: {
21850
21865
  type: "string";
21851
21866
  };
21867
+ separatorLine: {
21868
+ type: "boolean";
21869
+ };
21870
+ linePosition: {
21871
+ enum: ("top" | "bottom")[];
21872
+ type: "string";
21873
+ };
21852
21874
  version: {
21853
21875
  type: "string";
21854
21876
  };
@@ -22096,15 +22118,21 @@ export declare const rootRedoclyConfigSchema: {
22096
22118
  href: {
22097
22119
  type: "string";
22098
22120
  };
22099
- as: {
22100
- type: "string";
22101
- };
22102
22121
  crossorigin: {
22103
22122
  type: "string";
22104
22123
  };
22105
22124
  fetchpriority: {
22106
22125
  type: "string";
22107
22126
  };
22127
+ integrity: {
22128
+ type: "string";
22129
+ };
22130
+ referrerpolicy: {
22131
+ type: "string";
22132
+ };
22133
+ as: {
22134
+ type: "string";
22135
+ };
22108
22136
  hreflang: {
22109
22137
  type: "string";
22110
22138
  };
@@ -22114,18 +22142,12 @@ export declare const rootRedoclyConfigSchema: {
22114
22142
  imagesrcset: {
22115
22143
  type: "string";
22116
22144
  };
22117
- integrity: {
22118
- type: "string";
22119
- };
22120
22145
  media: {
22121
22146
  type: "string";
22122
22147
  };
22123
22148
  prefetch: {
22124
22149
  type: "string";
22125
22150
  };
22126
- referrerpolicy: {
22127
- type: "string";
22128
- };
22129
22151
  rel: {
22130
22152
  type: "string";
22131
22153
  };
@@ -22151,11 +22173,9 @@ export declare const rootRedoclyConfigSchema: {
22151
22173
  type: "string";
22152
22174
  };
22153
22175
  items: any;
22154
- href: any;
22155
22176
  page: any;
22177
+ href: any;
22156
22178
  icon: any;
22157
- separatorLine: any;
22158
- linePosition: any;
22159
22179
  directory: any;
22160
22180
  disconnect: any;
22161
22181
  group: any;
@@ -22163,6 +22183,8 @@ export declare const rootRedoclyConfigSchema: {
22163
22183
  labelTranslationKey: any;
22164
22184
  groupTranslationKey: any;
22165
22185
  separator: any;
22186
+ separatorLine: any;
22187
+ linePosition: any;
22166
22188
  version: any;
22167
22189
  menuStyle: any;
22168
22190
  expanded: any;
@@ -22174,10 +22196,10 @@ export declare const rootRedoclyConfigSchema: {
22174
22196
  };
22175
22197
  type: "array";
22176
22198
  };
22177
- href: {
22199
+ page: {
22178
22200
  type: "string";
22179
22201
  };
22180
- page: {
22202
+ href: {
22181
22203
  type: "string";
22182
22204
  };
22183
22205
  icon: {
@@ -22191,13 +22213,6 @@ export declare const rootRedoclyConfigSchema: {
22191
22213
  required: "srcSet"[];
22192
22214
  })[];
22193
22215
  };
22194
- separatorLine: {
22195
- type: "boolean";
22196
- };
22197
- linePosition: {
22198
- enum: ("top" | "bottom")[];
22199
- type: "string";
22200
- };
22201
22216
  directory: {
22202
22217
  type: "string";
22203
22218
  };
@@ -22219,6 +22234,13 @@ export declare const rootRedoclyConfigSchema: {
22219
22234
  separator: {
22220
22235
  type: "string";
22221
22236
  };
22237
+ separatorLine: {
22238
+ type: "boolean";
22239
+ };
22240
+ linePosition: {
22241
+ enum: ("top" | "bottom")[];
22242
+ type: "string";
22243
+ };
22222
22244
  version: {
22223
22245
  type: "string";
22224
22246
  };
@@ -24157,10 +24179,10 @@ export declare const rootRedoclyConfigSchema: {
24157
24179
  href: {
24158
24180
  type: "string";
24159
24181
  };
24160
- altText: {
24182
+ imageUrl: {
24161
24183
  type: "string";
24162
24184
  };
24163
- imageUrl: {
24185
+ altText: {
24164
24186
  type: "string";
24165
24187
  };
24166
24188
  };
@@ -25919,10 +25941,10 @@ export declare const rootRedoclyConfigSchema: {
25919
25941
  href: {
25920
25942
  type: "string";
25921
25943
  };
25922
- altText: {
25944
+ imageUrl: {
25923
25945
  type: "string";
25924
25946
  };
25925
- imageUrl: {
25947
+ altText: {
25926
25948
  type: "string";
25927
25949
  };
25928
25950
  };
@@ -26168,12 +26190,12 @@ export declare const rootRedoclyConfigSchema: {
26168
26190
  env: {
26169
26191
  type: "string";
26170
26192
  };
26171
- allowApiProductsOutsideCatalog: {
26172
- type: "boolean";
26173
- };
26174
26193
  stage: {
26175
26194
  type: "string";
26176
26195
  };
26196
+ allowApiProductsOutsideCatalog: {
26197
+ type: "boolean";
26198
+ };
26177
26199
  };
26178
26200
  additionalProperties: false;
26179
26201
  type: "object";
@@ -26229,13 +26251,10 @@ export declare const rootRedoclyConfigSchema: {
26229
26251
  propertyName: "type";
26230
26252
  };
26231
26253
  };
26232
- allowApiProductsOutsideCatalog: {
26233
- type: "boolean";
26234
- };
26235
- stage: {
26254
+ apiUrl: {
26236
26255
  type: "string";
26237
26256
  };
26238
- apiUrl: {
26257
+ stage: {
26239
26258
  type: "string";
26240
26259
  };
26241
26260
  ignoreApiProducts: {
@@ -26244,6 +26263,9 @@ export declare const rootRedoclyConfigSchema: {
26244
26263
  };
26245
26264
  type: "array";
26246
26265
  };
26266
+ allowApiProductsOutsideCatalog: {
26267
+ type: "boolean";
26268
+ };
26247
26269
  };
26248
26270
  additionalProperties: false;
26249
26271
  type: "object";
@@ -26299,13 +26321,10 @@ export declare const rootRedoclyConfigSchema: {
26299
26321
  propertyName: "type";
26300
26322
  };
26301
26323
  };
26302
- allowApiProductsOutsideCatalog: {
26303
- type: "boolean";
26304
- };
26305
- stage: {
26324
+ apiUrl: {
26306
26325
  type: "string";
26307
26326
  };
26308
- apiUrl: {
26327
+ stage: {
26309
26328
  type: "string";
26310
26329
  };
26311
26330
  ignoreApiProducts: {
@@ -26314,6 +26333,9 @@ export declare const rootRedoclyConfigSchema: {
26314
26333
  };
26315
26334
  type: "array";
26316
26335
  };
26336
+ allowApiProductsOutsideCatalog: {
26337
+ type: "boolean";
26338
+ };
26317
26339
  };
26318
26340
  additionalProperties: false;
26319
26341
  type: "object";
@@ -26457,6 +26479,28 @@ export declare const rootRedoclyConfigSchema: {
26457
26479
  additionalProperties: false;
26458
26480
  type: "object";
26459
26481
  };
26482
+ severity: {
26483
+ properties: {
26484
+ schemaCheck: {
26485
+ enum: ("off" | "error" | "warn")[];
26486
+ type: "string";
26487
+ };
26488
+ statusCodeCheck: {
26489
+ enum: ("off" | "error" | "warn")[];
26490
+ type: "string";
26491
+ };
26492
+ contentTypeCheck: {
26493
+ enum: ("off" | "error" | "warn")[];
26494
+ type: "string";
26495
+ };
26496
+ successCriteriaCheck: {
26497
+ enum: ("off" | "error" | "warn")[];
26498
+ type: "string";
26499
+ };
26500
+ };
26501
+ additionalProperties: false;
26502
+ type: "object";
26503
+ };
26460
26504
  };
26461
26505
  additionalProperties: false;
26462
26506
  type: "object";
@@ -26502,11 +26546,9 @@ export declare const rootRedoclyConfigSchema: {
26502
26546
  type: "string";
26503
26547
  };
26504
26548
  items: any;
26505
- href: any;
26506
26549
  page: any;
26550
+ href: any;
26507
26551
  icon: any;
26508
- separatorLine: any;
26509
- linePosition: any;
26510
26552
  directory: any;
26511
26553
  disconnect: any;
26512
26554
  group: any;
@@ -26514,6 +26556,8 @@ export declare const rootRedoclyConfigSchema: {
26514
26556
  labelTranslationKey: any;
26515
26557
  groupTranslationKey: any;
26516
26558
  separator: any;
26559
+ separatorLine: any;
26560
+ linePosition: any;
26517
26561
  version: any;
26518
26562
  menuStyle: any;
26519
26563
  expanded: any;
@@ -26525,10 +26569,10 @@ export declare const rootRedoclyConfigSchema: {
26525
26569
  };
26526
26570
  type: "array";
26527
26571
  };
26528
- href: {
26572
+ page: {
26529
26573
  type: "string";
26530
26574
  };
26531
- page: {
26575
+ href: {
26532
26576
  type: "string";
26533
26577
  };
26534
26578
  icon: {
@@ -26542,13 +26586,6 @@ export declare const rootRedoclyConfigSchema: {
26542
26586
  required: "srcSet"[];
26543
26587
  })[];
26544
26588
  };
26545
- separatorLine: {
26546
- type: "boolean";
26547
- };
26548
- linePosition: {
26549
- enum: ("top" | "bottom")[];
26550
- type: "string";
26551
- };
26552
26589
  directory: {
26553
26590
  type: "string";
26554
26591
  };
@@ -26570,6 +26607,13 @@ export declare const rootRedoclyConfigSchema: {
26570
26607
  separator: {
26571
26608
  type: "string";
26572
26609
  };
26610
+ separatorLine: {
26611
+ type: "boolean";
26612
+ };
26613
+ linePosition: {
26614
+ enum: ("top" | "bottom")[];
26615
+ type: "string";
26616
+ };
26573
26617
  version: {
26574
26618
  type: "string";
26575
26619
  };
@@ -26628,24 +26672,21 @@ export declare const rootRedoclyConfigSchema: {
26628
26672
  src: {
26629
26673
  type: "string";
26630
26674
  };
26675
+ async: {
26676
+ type: "boolean";
26677
+ };
26631
26678
  crossorigin: {
26632
26679
  type: "string";
26633
26680
  };
26681
+ defer: {
26682
+ type: "boolean";
26683
+ };
26634
26684
  fetchpriority: {
26635
26685
  type: "string";
26636
26686
  };
26637
26687
  integrity: {
26638
26688
  type: "string";
26639
26689
  };
26640
- referrerpolicy: {
26641
- type: "string";
26642
- };
26643
- async: {
26644
- type: "boolean";
26645
- };
26646
- defer: {
26647
- type: "boolean";
26648
- };
26649
26690
  module: {
26650
26691
  type: "boolean";
26651
26692
  };
@@ -26655,6 +26696,9 @@ export declare const rootRedoclyConfigSchema: {
26655
26696
  nonce: {
26656
26697
  type: "string";
26657
26698
  };
26699
+ referrerpolicy: {
26700
+ type: "string";
26701
+ };
26658
26702
  };
26659
26703
  additionalProperties: true;
26660
26704
  type: "object";
@@ -26671,24 +26715,21 @@ export declare const rootRedoclyConfigSchema: {
26671
26715
  src: {
26672
26716
  type: "string";
26673
26717
  };
26718
+ async: {
26719
+ type: "boolean";
26720
+ };
26674
26721
  crossorigin: {
26675
26722
  type: "string";
26676
26723
  };
26724
+ defer: {
26725
+ type: "boolean";
26726
+ };
26677
26727
  fetchpriority: {
26678
26728
  type: "string";
26679
26729
  };
26680
26730
  integrity: {
26681
26731
  type: "string";
26682
26732
  };
26683
- referrerpolicy: {
26684
- type: "string";
26685
- };
26686
- async: {
26687
- type: "boolean";
26688
- };
26689
- defer: {
26690
- type: "boolean";
26691
- };
26692
26733
  module: {
26693
26734
  type: "boolean";
26694
26735
  };
@@ -26698,6 +26739,9 @@ export declare const rootRedoclyConfigSchema: {
26698
26739
  nonce: {
26699
26740
  type: "string";
26700
26741
  };
26742
+ referrerpolicy: {
26743
+ type: "string";
26744
+ };
26701
26745
  };
26702
26746
  additionalProperties: true;
26703
26747
  type: "object";
@@ -28877,10 +28921,10 @@ export declare const rootRedoclyConfigSchema: {
28877
28921
  href: {
28878
28922
  type: "string";
28879
28923
  };
28880
- altText: {
28924
+ imageUrl: {
28881
28925
  type: "string";
28882
28926
  };
28883
- imageUrl: {
28927
+ altText: {
28884
28928
  type: "string";
28885
28929
  };
28886
28930
  };
@@ -29149,10 +29193,10 @@ export declare const rootRedoclyConfigSchema: {
29149
29193
  link: {
29150
29194
  type: "string";
29151
29195
  };
29152
- separatorLine: {
29196
+ external: {
29153
29197
  type: "boolean";
29154
29198
  };
29155
- external: {
29199
+ separatorLine: {
29156
29200
  type: "boolean";
29157
29201
  };
29158
29202
  };
@@ -29226,11 +29270,9 @@ export declare const rootRedoclyConfigSchema: {
29226
29270
  type: "string";
29227
29271
  };
29228
29272
  items: any;
29229
- href: any;
29230
29273
  page: any;
29274
+ href: any;
29231
29275
  icon: any;
29232
- separatorLine: any;
29233
- linePosition: any;
29234
29276
  directory: any;
29235
29277
  disconnect: any;
29236
29278
  group: any;
@@ -29238,6 +29280,8 @@ export declare const rootRedoclyConfigSchema: {
29238
29280
  labelTranslationKey: any;
29239
29281
  groupTranslationKey: any;
29240
29282
  separator: any;
29283
+ separatorLine: any;
29284
+ linePosition: any;
29241
29285
  version: any;
29242
29286
  menuStyle: any;
29243
29287
  expanded: any;
@@ -29249,10 +29293,10 @@ export declare const rootRedoclyConfigSchema: {
29249
29293
  };
29250
29294
  type: "array";
29251
29295
  };
29252
- href: {
29296
+ page: {
29253
29297
  type: "string";
29254
29298
  };
29255
- page: {
29299
+ href: {
29256
29300
  type: "string";
29257
29301
  };
29258
29302
  icon: {
@@ -29266,13 +29310,6 @@ export declare const rootRedoclyConfigSchema: {
29266
29310
  required: "srcSet"[];
29267
29311
  })[];
29268
29312
  };
29269
- separatorLine: {
29270
- type: "boolean";
29271
- };
29272
- linePosition: {
29273
- enum: ("top" | "bottom")[];
29274
- type: "string";
29275
- };
29276
29313
  directory: {
29277
29314
  type: "string";
29278
29315
  };
@@ -29294,6 +29331,13 @@ export declare const rootRedoclyConfigSchema: {
29294
29331
  separator: {
29295
29332
  type: "string";
29296
29333
  };
29334
+ separatorLine: {
29335
+ type: "boolean";
29336
+ };
29337
+ linePosition: {
29338
+ enum: ("top" | "bottom")[];
29339
+ type: "string";
29340
+ };
29297
29341
  version: {
29298
29342
  type: "string";
29299
29343
  };
@@ -38705,6 +38749,28 @@ export declare const rootRedoclyConfigSchema: {
38705
38749
  };
38706
38750
  };
38707
38751
  };
38752
+ readonly severity: {
38753
+ readonly type: "object";
38754
+ readonly additionalProperties: false;
38755
+ readonly properties: {
38756
+ readonly schemaCheck: {
38757
+ readonly type: "string";
38758
+ readonly enum: readonly ["error", "warn", "off"];
38759
+ };
38760
+ readonly statusCodeCheck: {
38761
+ readonly type: "string";
38762
+ readonly enum: readonly ["error", "warn", "off"];
38763
+ };
38764
+ readonly contentTypeCheck: {
38765
+ readonly type: "string";
38766
+ readonly enum: readonly ["error", "warn", "off"];
38767
+ };
38768
+ readonly successCriteriaCheck: {
38769
+ readonly type: "string";
38770
+ readonly enum: readonly ["error", "warn", "off"];
38771
+ };
38772
+ };
38773
+ };
38708
38774
  };
38709
38775
  readonly required: readonly ["path", "trigger", "agent"];
38710
38776
  readonly additionalProperties: false;
package/lib-esm/types/code-walkthrough-types.d.ts CHANGED
@@ -68,16 +68,17 @@ export type CodeWalkthroughControls = {
68
68
  input: string;
69
69
  filter: string;
70
70
  };
71
- export type ControlType = keyof CodeWalkthroughControls;
72
- export type ControlTypeValue<T extends ControlType> = CodeWalkthroughControls[T];
73
- export type ControlState<T extends ControlType = ControlType> = WithConditions<{
74
- value: ControlTypeValue<T>;
71
+ export type CodeWalkthroughControlState = WithConditions<{
72
+ value: string;
73
+ render: boolean;
74
+ type: 'input';
75
+ } | {
76
+ value: string;
77
+ render: boolean;
78
+ type: 'filter';
79
+ } | {
80
+ value: boolean;
75
81
  render: boolean;
76
- type: T;
82
+ type: 'toggle';
77
83
  }>;
78
- type id = string;
79
- export type InputsState = Record<id, ControlState<'input'>>;
80
- export type TogglesState = Record<id, ControlState<'toggle'>>;
81
- export type FiltersState = Record<id, ControlState<'filter'>>;
82
- export type WalkthroughState = Record<id, InputsState | TogglesState | FiltersState>;
83
- export {};
84
+ export type CodeWalkthroughControlsState = Record<string, CodeWalkthroughControlState>;
package/lib-esm/types/portal-shared-types.d.ts CHANGED
@@ -145,6 +145,15 @@ export type ResolvedSidebar = {
145
145
  relatedNavbarItem?: BreadcrumbItem;
146
146
  items: ResolvedNavItem[];
147
147
  };
148
+ export type CompilationError = {
149
+ message: string;
150
+ sourceFileRelativePath: string;
151
+ sourceFileLocation: {
152
+ line: number;
153
+ character?: number;
154
+ };
155
+ codeframe: string;
156
+ };
148
157
  export type PageProps = {
149
158
  metadata?: Record<string, unknown>;
150
159
  seo?: SeoConfig;
@@ -155,6 +164,7 @@ export type PageProps = {
155
164
  lastModified?: string | null;
156
165
  [k: string]: unknown;
157
166
  dynamicMarkdocComponents?: string[];
167
+ compilationErrors?: CompilationError[];
158
168
  markdown?: MdOptions;
159
169
  openapiOptions?: OpenAPIOptions;
160
170
  definitionId?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/config",
3
- "version": "0.20.1",
3
+ "version": "0.20.3",
4
4
  "license": "MIT",
5
5
  "main": "./lib/index.js",
6
6
  "module": "./lib-esm/index.js",