@redocly/config 0.20.0 → 0.20.2

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.
@@ -2441,7 +2441,7 @@ export declare const themeConfigSchema: {
2441
2441
  };
2442
2442
  readonly sideNavStyle: {
2443
2443
  readonly type: "string";
2444
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
2444
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
2445
2445
  };
2446
2446
  readonly simpleOneOfTypeLabel: {
2447
2447
  readonly type: "boolean";
@@ -6437,7 +6437,7 @@ export declare const closedThemeConfigSchema: {
6437
6437
  };
6438
6438
  readonly sideNavStyle: {
6439
6439
  readonly type: "string";
6440
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
6440
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
6441
6441
  };
6442
6442
  readonly simpleOneOfTypeLabel: {
6443
6443
  readonly type: "boolean";
@@ -2444,7 +2444,7 @@ export declare const openapiConfigSchema: {
2444
2444
  };
2445
2445
  readonly sideNavStyle: {
2446
2446
  readonly type: "string";
2447
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
2447
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
2448
2448
  };
2449
2449
  readonly simpleOneOfTypeLabel: {
2450
2450
  readonly type: "boolean";
@@ -1934,7 +1934,7 @@ export declare const productThemeOverrideSchema: {
1934
1934
  };
1935
1935
  readonly sideNavStyle: {
1936
1936
  readonly type: "string";
1937
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
1937
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
1938
1938
  };
1939
1939
  readonly simpleOneOfTypeLabel: {
1940
1940
  readonly type: "boolean";
@@ -4035,7 +4035,7 @@ export declare const productConfigOverrideSchema: {
4035
4035
  };
4036
4036
  readonly sideNavStyle: {
4037
4037
  readonly type: "string";
4038
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
4038
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
4039
4039
  };
4040
4040
  readonly simpleOneOfTypeLabel: {
4041
4041
  readonly type: "boolean";
@@ -6264,7 +6264,7 @@ export declare const productConfigOverrideSchema: {
6264
6264
  };
6265
6265
  readonly sideNavStyle: {
6266
6266
  readonly type: "string";
6267
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
6267
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
6268
6268
  };
6269
6269
  readonly simpleOneOfTypeLabel: {
6270
6270
  readonly type: "boolean";
@@ -9122,7 +9122,7 @@ export declare const productConfigOverrideSchema: {
9122
9122
  };
9123
9123
  readonly sideNavStyle: {
9124
9124
  readonly type: "string";
9125
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
9125
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
9126
9126
  };
9127
9127
  readonly simpleOneOfTypeLabel: {
9128
9128
  readonly type: "boolean";
@@ -11797,7 +11797,7 @@ export declare const productConfigOverrideSchema: {
11797
11797
  };
11798
11798
  readonly sideNavStyle: {
11799
11799
  readonly type: "string";
11800
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
11800
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
11801
11801
  };
11802
11802
  readonly simpleOneOfTypeLabel: {
11803
11803
  readonly type: "boolean";
@@ -1339,7 +1339,7 @@ export declare const deprecatedRefDocsSchema: {
1339
1339
  };
1340
1340
  readonly sideNavStyle: {
1341
1341
  readonly type: "string";
1342
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
1342
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
1343
1343
  };
1344
1344
  readonly simpleOneOfTypeLabel: {
1345
1345
  readonly type: "boolean";
@@ -494,7 +494,7 @@ exports.deprecatedRefDocsSchema = {
494
494
  showObjectSchemaExamples: { type: 'boolean' },
495
495
  disableTryItRequestUrlEncoding: { type: 'boolean' },
496
496
  sidebarLinks: ConfigSidebarLinks,
497
- sideNavStyle: { type: 'string', enum: ['summary-only', 'path-first', 'id-only'] },
497
+ sideNavStyle: { type: 'string', enum: ['summary-only', 'path-first', 'id-only', 'path-only'] },
498
498
  simpleOneOfTypeLabel: { type: 'boolean' },
499
499
  sortEnumValuesAlphabetically: { type: 'boolean' },
500
500
  sortOperationsAlphabetically: { type: 'boolean' },
@@ -1839,7 +1839,7 @@ export declare const apiConfigSchema: {
1839
1839
  };
1840
1840
  readonly sideNavStyle: {
1841
1841
  readonly type: "string";
1842
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
1842
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
1843
1843
  };
1844
1844
  readonly simpleOneOfTypeLabel: {
1845
1845
  readonly type: "boolean";
@@ -4071,7 +4071,7 @@ export declare const apiConfigSchema: {
4071
4071
  };
4072
4072
  readonly sideNavStyle: {
4073
4073
  readonly type: "string";
4074
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
4074
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
4075
4075
  };
4076
4076
  readonly simpleOneOfTypeLabel: {
4077
4077
  readonly type: "boolean";
@@ -7139,7 +7139,7 @@ export declare const redoclyConfigSchema: {
7139
7139
  };
7140
7140
  readonly sideNavStyle: {
7141
7141
  readonly type: "string";
7142
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
7142
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
7143
7143
  };
7144
7144
  readonly simpleOneOfTypeLabel: {
7145
7145
  readonly type: "boolean";
@@ -9371,7 +9371,7 @@ export declare const redoclyConfigSchema: {
9371
9371
  };
9372
9372
  readonly sideNavStyle: {
9373
9373
  readonly type: "string";
9374
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
9374
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
9375
9375
  };
9376
9376
  readonly simpleOneOfTypeLabel: {
9377
9377
  readonly type: "boolean";
@@ -13188,7 +13188,7 @@ export declare const redoclyConfigSchema: {
13188
13188
  };
13189
13189
  readonly sideNavStyle: {
13190
13190
  readonly type: "string";
13191
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
13191
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
13192
13192
  };
13193
13193
  readonly simpleOneOfTypeLabel: {
13194
13194
  readonly type: "boolean";
@@ -17243,7 +17243,7 @@ export declare const redoclyConfigSchema: {
17243
17243
  };
17244
17244
  readonly sideNavStyle: {
17245
17245
  readonly type: "string";
17246
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
17246
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
17247
17247
  };
17248
17248
  readonly simpleOneOfTypeLabel: {
17249
17249
  readonly type: "boolean";
@@ -20698,7 +20698,7 @@ export declare const rootRedoclyConfigSchema: {
20698
20698
  type: "object";
20699
20699
  };
20700
20700
  sideNavStyle: {
20701
- enum: ("summary-only" | "path-first" | "id-only")[];
20701
+ enum: ("path-only" | "summary-only" | "path-first" | "id-only")[];
20702
20702
  type: "string";
20703
20703
  };
20704
20704
  simpleOneOfTypeLabel: {
@@ -23423,7 +23423,7 @@ export declare const rootRedoclyConfigSchema: {
23423
23423
  type: "object";
23424
23424
  };
23425
23425
  sideNavStyle: {
23426
- enum: ("summary-only" | "path-first" | "id-only")[];
23426
+ enum: ("path-only" | "summary-only" | "path-first" | "id-only")[];
23427
23427
  type: "string";
23428
23428
  };
23429
23429
  simpleOneOfTypeLabel: {
@@ -25185,7 +25185,7 @@ export declare const rootRedoclyConfigSchema: {
25185
25185
  type: "object";
25186
25186
  };
25187
25187
  sideNavStyle: {
25188
- enum: ("summary-only" | "path-first" | "id-only")[];
25188
+ enum: ("path-only" | "summary-only" | "path-first" | "id-only")[];
25189
25189
  type: "string";
25190
25190
  };
25191
25191
  simpleOneOfTypeLabel: {
@@ -28143,7 +28143,7 @@ export declare const rootRedoclyConfigSchema: {
28143
28143
  type: "object";
28144
28144
  };
28145
28145
  sideNavStyle: {
28146
- enum: ("summary-only" | "path-first" | "id-only")[];
28146
+ enum: ("path-only" | "summary-only" | "path-first" | "id-only")[];
28147
28147
  type: "string";
28148
28148
  };
28149
28149
  simpleOneOfTypeLabel: {
@@ -31040,7 +31040,7 @@ export declare const rootRedoclyConfigSchema: {
31040
31040
  };
31041
31041
  readonly sideNavStyle: {
31042
31042
  readonly type: "string";
31043
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
31043
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
31044
31044
  };
31045
31045
  readonly simpleOneOfTypeLabel: {
31046
31046
  readonly type: "boolean";
@@ -33272,7 +33272,7 @@ export declare const rootRedoclyConfigSchema: {
33272
33272
  };
33273
33273
  readonly sideNavStyle: {
33274
33274
  readonly type: "string";
33275
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
33275
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
33276
33276
  };
33277
33277
  readonly simpleOneOfTypeLabel: {
33278
33278
  readonly type: "boolean";
@@ -37089,7 +37089,7 @@ export declare const rootRedoclyConfigSchema: {
37089
37089
  };
37090
37090
  readonly sideNavStyle: {
37091
37091
  readonly type: "string";
37092
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
37092
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
37093
37093
  };
37094
37094
  readonly simpleOneOfTypeLabel: {
37095
37095
  readonly type: "boolean";
@@ -41144,7 +41144,7 @@ export declare const rootRedoclyConfigSchema: {
41144
41144
  };
41145
41145
  readonly sideNavStyle: {
41146
41146
  readonly type: "string";
41147
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
41147
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
41148
41148
  };
41149
41149
  readonly simpleOneOfTypeLabel: {
41150
41150
  readonly type: "boolean";
@@ -29,6 +29,7 @@ export type CodeWalkthroughAttr = {
29
29
  preview: React.ReactNode[];
30
30
  inputs: InputsMarkdocAttr;
31
31
  toggles: TogglesMarkdocAttr;
32
+ __idx: number;
32
33
  };
33
34
  export type CodeWalkthroughFile = {
34
35
  path: string;
@@ -67,16 +68,17 @@ export type CodeWalkthroughControls = {
67
68
  input: string;
68
69
  filter: string;
69
70
  };
70
- export type ControlType = keyof CodeWalkthroughControls;
71
- export type ControlTypeValue<T extends ControlType> = CodeWalkthroughControls[T];
72
- export type ControlState<T extends ControlType = ControlType> = WithConditions<{
73
- 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;
74
81
  render: boolean;
75
- type: T;
82
+ type: 'toggle';
76
83
  }>;
77
- type id = string;
78
- export type InputsState = Record<id, ControlState<'input'>>;
79
- export type TogglesState = Record<id, ControlState<'toggle'>>;
80
- export type FiltersState = Record<id, ControlState<'filter'>>;
81
- export type WalkthroughState = Record<id, InputsState | TogglesState | FiltersState>;
82
- export {};
84
+ export type CodeWalkthroughControlsState = Record<string, CodeWalkthroughControlState>;
@@ -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;
@@ -2441,7 +2441,7 @@ export declare const themeConfigSchema: {
2441
2441
  };
2442
2442
  readonly sideNavStyle: {
2443
2443
  readonly type: "string";
2444
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
2444
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
2445
2445
  };
2446
2446
  readonly simpleOneOfTypeLabel: {
2447
2447
  readonly type: "boolean";
@@ -6437,7 +6437,7 @@ export declare const closedThemeConfigSchema: {
6437
6437
  };
6438
6438
  readonly sideNavStyle: {
6439
6439
  readonly type: "string";
6440
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
6440
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
6441
6441
  };
6442
6442
  readonly simpleOneOfTypeLabel: {
6443
6443
  readonly type: "boolean";
@@ -2444,7 +2444,7 @@ export declare const openapiConfigSchema: {
2444
2444
  };
2445
2445
  readonly sideNavStyle: {
2446
2446
  readonly type: "string";
2447
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
2447
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
2448
2448
  };
2449
2449
  readonly simpleOneOfTypeLabel: {
2450
2450
  readonly type: "boolean";
@@ -1934,7 +1934,7 @@ export declare const productThemeOverrideSchema: {
1934
1934
  };
1935
1935
  readonly sideNavStyle: {
1936
1936
  readonly type: "string";
1937
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
1937
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
1938
1938
  };
1939
1939
  readonly simpleOneOfTypeLabel: {
1940
1940
  readonly type: "boolean";
@@ -4035,7 +4035,7 @@ export declare const productConfigOverrideSchema: {
4035
4035
  };
4036
4036
  readonly sideNavStyle: {
4037
4037
  readonly type: "string";
4038
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
4038
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
4039
4039
  };
4040
4040
  readonly simpleOneOfTypeLabel: {
4041
4041
  readonly type: "boolean";
@@ -6264,7 +6264,7 @@ export declare const productConfigOverrideSchema: {
6264
6264
  };
6265
6265
  readonly sideNavStyle: {
6266
6266
  readonly type: "string";
6267
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
6267
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
6268
6268
  };
6269
6269
  readonly simpleOneOfTypeLabel: {
6270
6270
  readonly type: "boolean";
@@ -9122,7 +9122,7 @@ export declare const productConfigOverrideSchema: {
9122
9122
  };
9123
9123
  readonly sideNavStyle: {
9124
9124
  readonly type: "string";
9125
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
9125
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
9126
9126
  };
9127
9127
  readonly simpleOneOfTypeLabel: {
9128
9128
  readonly type: "boolean";
@@ -11797,7 +11797,7 @@ export declare const productConfigOverrideSchema: {
11797
11797
  };
11798
11798
  readonly sideNavStyle: {
11799
11799
  readonly type: "string";
11800
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
11800
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
11801
11801
  };
11802
11802
  readonly simpleOneOfTypeLabel: {
11803
11803
  readonly type: "boolean";
@@ -1339,7 +1339,7 @@ export declare const deprecatedRefDocsSchema: {
1339
1339
  };
1340
1340
  readonly sideNavStyle: {
1341
1341
  readonly type: "string";
1342
- readonly enum: readonly ["summary-only", "path-first", "id-only"];
1342
+ readonly enum: readonly ["summary-only", "path-first", "id-only", "path-only"];
1343
1343
  };
1344
1344
  readonly simpleOneOfTypeLabel: {
1345
1345
  readonly type: "boolean";
@@ -491,7 +491,7 @@ export const deprecatedRefDocsSchema = {
491
491
  showObjectSchemaExamples: { type: 'boolean' },
492
492
  disableTryItRequestUrlEncoding: { type: 'boolean' },
493
493
  sidebarLinks: ConfigSidebarLinks,
494
- sideNavStyle: { type: 'string', enum: ['summary-only', 'path-first', 'id-only'] },
494
+ sideNavStyle: { type: 'string', enum: ['summary-only', 'path-first', 'id-only', 'path-only'] },
495
495
  simpleOneOfTypeLabel: { type: 'boolean' },
496
496
  sortEnumValuesAlphabetically: { type: 'boolean' },
497
497
  sortOperationsAlphabetically: { type: 'boolean' },