@redocly/config 0.18.0 → 0.19.0

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 (9) hide show
  1. package/lib/graphql-types.d.ts +2 -1
  2. package/lib/reunite-config-schema.d.ts +39 -0
  3. package/lib/reunite-config-schema.js +36 -0
  4. package/lib/root-config-schema.d.ts +117 -0
  5. package/lib-esm/graphql-types.d.ts +2 -1
  6. package/lib-esm/reunite-config-schema.d.ts +39 -0
  7. package/lib-esm/reunite-config-schema.js +36 -0
  8. package/lib-esm/root-config-schema.d.ts +117 -0
  9. package/package.json +1 -1
package/lib/graphql-types.d.ts CHANGED
@@ -3,7 +3,8 @@ import type { Location } from 'react-router-dom';
3
3
  import type { graphqlConfigSchema } from './graphql-config-schema';
4
4
  export type GraphQLConfigTypes = FromSchema<typeof graphqlConfigSchema> & {
5
5
  markdown?: {
6
- parser: (md: string) => string;
6
+ parser?: (md: string) => string;
7
+ highlight?: (code: string, lang: string, options?: Record<string, any>) => string;
7
8
  };
8
9
  onLocationChange?: (location: Partial<Location>) => void;
9
10
  };
package/lib/reunite-config-schema.d.ts CHANGED
@@ -18,6 +18,45 @@ export declare const reuniteConfigSchema: {
18
18
  readonly ignoreMarkdocErrors: {
19
19
  readonly type: "boolean";
20
20
  };
21
+ readonly jobs: {
22
+ readonly type: "array";
23
+ readonly items: {
24
+ readonly type: "object";
25
+ readonly properties: {
26
+ readonly path: {
27
+ readonly type: "string";
28
+ readonly pattern: "^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$";
29
+ };
30
+ readonly agent: {
31
+ readonly type: "string";
32
+ readonly enum: readonly ["spot"];
33
+ };
34
+ readonly trigger: {
35
+ readonly type: "object";
36
+ readonly additionalProperties: false;
37
+ readonly properties: {
38
+ readonly event: {
39
+ readonly type: "string";
40
+ readonly enum: readonly ["schedule"];
41
+ };
42
+ readonly interval: {
43
+ readonly type: "string";
44
+ readonly pattern: "^[1-9]\\d*[mhdw]$";
45
+ };
46
+ };
47
+ readonly required: readonly ["event"];
48
+ };
49
+ readonly inputs: {
50
+ readonly type: "object";
51
+ readonly additionalProperties: {
52
+ readonly type: "string";
53
+ };
54
+ };
55
+ };
56
+ readonly required: readonly ["path", "trigger", "agent"];
57
+ readonly additionalProperties: false;
58
+ };
59
+ };
21
60
  };
22
61
  readonly additionalProperties: false;
23
62
  };
package/lib/reunite-config-schema.js CHANGED
@@ -1,6 +1,22 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.reuniteConfigSchema = void 0;
4
+ const jobInputsSchema = {
5
+ type: 'object',
6
+ additionalProperties: { type: 'string' },
7
+ };
8
+ const jobTriggerSchema = {
9
+ type: 'object',
10
+ additionalProperties: false,
11
+ properties: {
12
+ event: {
13
+ type: 'string',
14
+ enum: ['schedule'],
15
+ },
16
+ interval: { type: 'string', pattern: '^[1-9]\\d*[mhdw]$' },
17
+ },
18
+ required: ['event'],
19
+ };
4
20
  exports.reuniteConfigSchema = {
5
21
  type: 'object',
6
22
  properties: {
@@ -15,6 +31,26 @@ exports.reuniteConfigSchema = {
15
31
  },
16
32
  ignoreLinkChecker: { type: 'boolean' },
17
33
  ignoreMarkdocErrors: { type: 'boolean' },
34
+ jobs: {
35
+ type: 'array',
36
+ items: {
37
+ type: 'object',
38
+ properties: {
39
+ path: {
40
+ type: 'string',
41
+ pattern: '^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$',
42
+ },
43
+ agent: {
44
+ type: 'string',
45
+ enum: ['spot'],
46
+ },
47
+ trigger: jobTriggerSchema,
48
+ inputs: jobInputsSchema,
49
+ },
50
+ required: ['path', 'trigger', 'agent'],
51
+ additionalProperties: false,
52
+ },
53
+ },
18
54
  },
19
55
  additionalProperties: false,
20
56
  };
package/lib/root-config-schema.d.ts CHANGED
@@ -14554,6 +14554,45 @@ export declare const redoclyConfigSchema: {
14554
14554
  readonly ignoreMarkdocErrors: {
14555
14555
  readonly type: "boolean";
14556
14556
  };
14557
+ readonly jobs: {
14558
+ readonly type: "array";
14559
+ readonly items: {
14560
+ readonly type: "object";
14561
+ readonly properties: {
14562
+ readonly path: {
14563
+ readonly type: "string";
14564
+ readonly pattern: "^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$";
14565
+ };
14566
+ readonly agent: {
14567
+ readonly type: "string";
14568
+ readonly enum: readonly ["spot"];
14569
+ };
14570
+ readonly trigger: {
14571
+ readonly type: "object";
14572
+ readonly additionalProperties: false;
14573
+ readonly properties: {
14574
+ readonly event: {
14575
+ readonly type: "string";
14576
+ readonly enum: readonly ["schedule"];
14577
+ };
14578
+ readonly interval: {
14579
+ readonly type: "string";
14580
+ readonly pattern: "^[1-9]\\d*[mhdw]$";
14581
+ };
14582
+ };
14583
+ readonly required: readonly ["event"];
14584
+ };
14585
+ readonly inputs: {
14586
+ readonly type: "object";
14587
+ readonly additionalProperties: {
14588
+ readonly type: "string";
14589
+ };
14590
+ };
14591
+ };
14592
+ readonly required: readonly ["path", "trigger", "agent"];
14593
+ readonly additionalProperties: false;
14594
+ };
14595
+ };
14557
14596
  };
14558
14597
  readonly additionalProperties: false;
14559
14598
  };
@@ -26187,6 +26226,45 @@ export declare const rootRedoclyConfigSchema: {
26187
26226
  ignoreMarkdocErrors: {
26188
26227
  type: "boolean";
26189
26228
  };
26229
+ jobs: {
26230
+ items: {
26231
+ properties: {
26232
+ path: {
26233
+ type: "string";
26234
+ pattern: "^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$";
26235
+ };
26236
+ trigger: {
26237
+ properties: {
26238
+ event: {
26239
+ enum: "schedule"[];
26240
+ type: "string";
26241
+ };
26242
+ interval: {
26243
+ type: "string";
26244
+ pattern: "^[1-9]\\d*[mhdw]$";
26245
+ };
26246
+ };
26247
+ additionalProperties: false;
26248
+ type: "object";
26249
+ required: "event"[];
26250
+ };
26251
+ agent: {
26252
+ enum: "spot"[];
26253
+ type: "string";
26254
+ };
26255
+ inputs: {
26256
+ additionalProperties: {
26257
+ type: "string";
26258
+ };
26259
+ type: "object";
26260
+ };
26261
+ };
26262
+ additionalProperties: false;
26263
+ type: "object";
26264
+ required: ("path" | "trigger" | "agent")[];
26265
+ };
26266
+ type: "array";
26267
+ };
26190
26268
  };
26191
26269
  additionalProperties: false;
26192
26270
  type: "object";
@@ -37999,6 +38077,45 @@ export declare const rootRedoclyConfigSchema: {
37999
38077
  readonly ignoreMarkdocErrors: {
38000
38078
  readonly type: "boolean";
38001
38079
  };
38080
+ readonly jobs: {
38081
+ readonly type: "array";
38082
+ readonly items: {
38083
+ readonly type: "object";
38084
+ readonly properties: {
38085
+ readonly path: {
38086
+ readonly type: "string";
38087
+ readonly pattern: "^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$";
38088
+ };
38089
+ readonly agent: {
38090
+ readonly type: "string";
38091
+ readonly enum: readonly ["spot"];
38092
+ };
38093
+ readonly trigger: {
38094
+ readonly type: "object";
38095
+ readonly additionalProperties: false;
38096
+ readonly properties: {
38097
+ readonly event: {
38098
+ readonly type: "string";
38099
+ readonly enum: readonly ["schedule"];
38100
+ };
38101
+ readonly interval: {
38102
+ readonly type: "string";
38103
+ readonly pattern: "^[1-9]\\d*[mhdw]$";
38104
+ };
38105
+ };
38106
+ readonly required: readonly ["event"];
38107
+ };
38108
+ readonly inputs: {
38109
+ readonly type: "object";
38110
+ readonly additionalProperties: {
38111
+ readonly type: "string";
38112
+ };
38113
+ };
38114
+ };
38115
+ readonly required: readonly ["path", "trigger", "agent"];
38116
+ readonly additionalProperties: false;
38117
+ };
38118
+ };
38002
38119
  };
38003
38120
  readonly additionalProperties: false;
38004
38121
  };
package/lib-esm/graphql-types.d.ts CHANGED
@@ -3,7 +3,8 @@ import type { Location } from 'react-router-dom';
3
3
  import type { graphqlConfigSchema } from './graphql-config-schema';
4
4
  export type GraphQLConfigTypes = FromSchema<typeof graphqlConfigSchema> & {
5
5
  markdown?: {
6
- parser: (md: string) => string;
6
+ parser?: (md: string) => string;
7
+ highlight?: (code: string, lang: string, options?: Record<string, any>) => string;
7
8
  };
8
9
  onLocationChange?: (location: Partial<Location>) => void;
9
10
  };
package/lib-esm/reunite-config-schema.d.ts CHANGED
@@ -18,6 +18,45 @@ export declare const reuniteConfigSchema: {
18
18
  readonly ignoreMarkdocErrors: {
19
19
  readonly type: "boolean";
20
20
  };
21
+ readonly jobs: {
22
+ readonly type: "array";
23
+ readonly items: {
24
+ readonly type: "object";
25
+ readonly properties: {
26
+ readonly path: {
27
+ readonly type: "string";
28
+ readonly pattern: "^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$";
29
+ };
30
+ readonly agent: {
31
+ readonly type: "string";
32
+ readonly enum: readonly ["spot"];
33
+ };
34
+ readonly trigger: {
35
+ readonly type: "object";
36
+ readonly additionalProperties: false;
37
+ readonly properties: {
38
+ readonly event: {
39
+ readonly type: "string";
40
+ readonly enum: readonly ["schedule"];
41
+ };
42
+ readonly interval: {
43
+ readonly type: "string";
44
+ readonly pattern: "^[1-9]\\d*[mhdw]$";
45
+ };
46
+ };
47
+ readonly required: readonly ["event"];
48
+ };
49
+ readonly inputs: {
50
+ readonly type: "object";
51
+ readonly additionalProperties: {
52
+ readonly type: "string";
53
+ };
54
+ };
55
+ };
56
+ readonly required: readonly ["path", "trigger", "agent"];
57
+ readonly additionalProperties: false;
58
+ };
59
+ };
21
60
  };
22
61
  readonly additionalProperties: false;
23
62
  };
package/lib-esm/reunite-config-schema.js CHANGED
@@ -1,3 +1,19 @@
1
+ const jobInputsSchema = {
2
+ type: 'object',
3
+ additionalProperties: { type: 'string' },
4
+ };
5
+ const jobTriggerSchema = {
6
+ type: 'object',
7
+ additionalProperties: false,
8
+ properties: {
9
+ event: {
10
+ type: 'string',
11
+ enum: ['schedule'],
12
+ },
13
+ interval: { type: 'string', pattern: '^[1-9]\\d*[mhdw]$' },
14
+ },
15
+ required: ['event'],
16
+ };
1
17
  export const reuniteConfigSchema = {
2
18
  type: 'object',
3
19
  properties: {
@@ -12,6 +28,26 @@ export const reuniteConfigSchema = {
12
28
  },
13
29
  ignoreLinkChecker: { type: 'boolean' },
14
30
  ignoreMarkdocErrors: { type: 'boolean' },
31
+ jobs: {
32
+ type: 'array',
33
+ items: {
34
+ type: 'object',
35
+ properties: {
36
+ path: {
37
+ type: 'string',
38
+ pattern: '^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$',
39
+ },
40
+ agent: {
41
+ type: 'string',
42
+ enum: ['spot'],
43
+ },
44
+ trigger: jobTriggerSchema,
45
+ inputs: jobInputsSchema,
46
+ },
47
+ required: ['path', 'trigger', 'agent'],
48
+ additionalProperties: false,
49
+ },
50
+ },
15
51
  },
16
52
  additionalProperties: false,
17
53
  };
package/lib-esm/root-config-schema.d.ts CHANGED
@@ -14554,6 +14554,45 @@ export declare const redoclyConfigSchema: {
14554
14554
  readonly ignoreMarkdocErrors: {
14555
14555
  readonly type: "boolean";
14556
14556
  };
14557
+ readonly jobs: {
14558
+ readonly type: "array";
14559
+ readonly items: {
14560
+ readonly type: "object";
14561
+ readonly properties: {
14562
+ readonly path: {
14563
+ readonly type: "string";
14564
+ readonly pattern: "^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$";
14565
+ };
14566
+ readonly agent: {
14567
+ readonly type: "string";
14568
+ readonly enum: readonly ["spot"];
14569
+ };
14570
+ readonly trigger: {
14571
+ readonly type: "object";
14572
+ readonly additionalProperties: false;
14573
+ readonly properties: {
14574
+ readonly event: {
14575
+ readonly type: "string";
14576
+ readonly enum: readonly ["schedule"];
14577
+ };
14578
+ readonly interval: {
14579
+ readonly type: "string";
14580
+ readonly pattern: "^[1-9]\\d*[mhdw]$";
14581
+ };
14582
+ };
14583
+ readonly required: readonly ["event"];
14584
+ };
14585
+ readonly inputs: {
14586
+ readonly type: "object";
14587
+ readonly additionalProperties: {
14588
+ readonly type: "string";
14589
+ };
14590
+ };
14591
+ };
14592
+ readonly required: readonly ["path", "trigger", "agent"];
14593
+ readonly additionalProperties: false;
14594
+ };
14595
+ };
14557
14596
  };
14558
14597
  readonly additionalProperties: false;
14559
14598
  };
@@ -26187,6 +26226,45 @@ export declare const rootRedoclyConfigSchema: {
26187
26226
  ignoreMarkdocErrors: {
26188
26227
  type: "boolean";
26189
26228
  };
26229
+ jobs: {
26230
+ items: {
26231
+ properties: {
26232
+ path: {
26233
+ type: "string";
26234
+ pattern: "^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$";
26235
+ };
26236
+ trigger: {
26237
+ properties: {
26238
+ event: {
26239
+ enum: "schedule"[];
26240
+ type: "string";
26241
+ };
26242
+ interval: {
26243
+ type: "string";
26244
+ pattern: "^[1-9]\\d*[mhdw]$";
26245
+ };
26246
+ };
26247
+ additionalProperties: false;
26248
+ type: "object";
26249
+ required: "event"[];
26250
+ };
26251
+ agent: {
26252
+ enum: "spot"[];
26253
+ type: "string";
26254
+ };
26255
+ inputs: {
26256
+ additionalProperties: {
26257
+ type: "string";
26258
+ };
26259
+ type: "object";
26260
+ };
26261
+ };
26262
+ additionalProperties: false;
26263
+ type: "object";
26264
+ required: ("path" | "trigger" | "agent")[];
26265
+ };
26266
+ type: "array";
26267
+ };
26190
26268
  };
26191
26269
  additionalProperties: false;
26192
26270
  type: "object";
@@ -37999,6 +38077,45 @@ export declare const rootRedoclyConfigSchema: {
37999
38077
  readonly ignoreMarkdocErrors: {
38000
38078
  readonly type: "boolean";
38001
38079
  };
38080
+ readonly jobs: {
38081
+ readonly type: "array";
38082
+ readonly items: {
38083
+ readonly type: "object";
38084
+ readonly properties: {
38085
+ readonly path: {
38086
+ readonly type: "string";
38087
+ readonly pattern: "^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$";
38088
+ };
38089
+ readonly agent: {
38090
+ readonly type: "string";
38091
+ readonly enum: readonly ["spot"];
38092
+ };
38093
+ readonly trigger: {
38094
+ readonly type: "object";
38095
+ readonly additionalProperties: false;
38096
+ readonly properties: {
38097
+ readonly event: {
38098
+ readonly type: "string";
38099
+ readonly enum: readonly ["schedule"];
38100
+ };
38101
+ readonly interval: {
38102
+ readonly type: "string";
38103
+ readonly pattern: "^[1-9]\\d*[mhdw]$";
38104
+ };
38105
+ };
38106
+ readonly required: readonly ["event"];
38107
+ };
38108
+ readonly inputs: {
38109
+ readonly type: "object";
38110
+ readonly additionalProperties: {
38111
+ readonly type: "string";
38112
+ };
38113
+ };
38114
+ };
38115
+ readonly required: readonly ["path", "trigger", "agent"];
38116
+ readonly additionalProperties: false;
38117
+ };
38118
+ };
38002
38119
  };
38003
38120
  readonly additionalProperties: false;
38004
38121
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/config",
3
- "version": "0.18.0",
3
+ "version": "0.19.0",
4
4
  "license": "MIT",
5
5
  "main": "./lib/index.js",
6
6
  "module": "./lib-esm/index.js",