@redocly/config 0.47.0 → 0.48.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.
Files changed (80) hide show
  1. package/lib/index.d.ts +9 -9
  2. package/lib/index.js +1 -41
  3. package/lib/package.json +3 -0
  4. package/lib/root-config-schema.d.ts +16 -1
  5. package/lib/types/api-functions-types.d.ts +2 -2
  6. package/lib/types/asyncapi-types.d.ts +1 -1
  7. package/lib/types/catalog-entity-types.d.ts +2 -2
  8. package/lib/types/config-types.d.ts +10 -10
  9. package/lib/types/graphql-types.d.ts +1 -1
  10. package/lib/types/index.d.ts +4 -4
  11. package/lib/types/portal-shared-types.d.ts +4 -4
  12. package/lib/types/redoc-types.d.ts +1 -1
  13. package/lib-esm/index.d.ts +9 -9
  14. package/lib-esm/index.js +1 -10
  15. package/lib-esm/root-config-schema.d.ts +16 -1
  16. package/lib-esm/types/api-functions-types.d.ts +2 -2
  17. package/lib-esm/types/asyncapi-types.d.ts +1 -1
  18. package/lib-esm/types/catalog-entity-types.d.ts +2 -2
  19. package/lib-esm/types/config-types.d.ts +10 -10
  20. package/lib-esm/types/graphql-types.d.ts +1 -1
  21. package/lib-esm/types/index.d.ts +4 -4
  22. package/lib-esm/types/portal-shared-types.d.ts +4 -4
  23. package/lib-esm/types/redoc-types.d.ts +1 -1
  24. package/package.json +19 -4
  25. package/lib/asyncapi-config-schema.js +0 -53
  26. package/lib/common.js +0 -103
  27. package/lib/constants/config.js +0 -17
  28. package/lib/constants/entities.js +0 -58
  29. package/lib/constants/enum.js +0 -6
  30. package/lib/constants/shared.js +0 -22
  31. package/lib/default-theme-config-schema.js +0 -57
  32. package/lib/entities-catalog-config-schema.js +0 -186
  33. package/lib/entities-catalog-entity-file-schema.js +0 -283
  34. package/lib/ex-theme-config-schemas.js +0 -687
  35. package/lib/feedback-config-schema.js +0 -88
  36. package/lib/graphql-config-schema.js +0 -157
  37. package/lib/product-override-schema.js +0 -44
  38. package/lib/redoc-config-schema.js +0 -120
  39. package/lib/reference-docs-config-schema.js +0 -518
  40. package/lib/remove-property-recursively.js +0 -28
  41. package/lib/reunite-config-schema.js +0 -103
  42. package/lib/root-config-schema.js +0 -587
  43. package/lib/scorecards-config-schema.js +0 -242
  44. package/lib/types/api-functions-types.js +0 -3
  45. package/lib/types/asyncapi-types.js +0 -3
  46. package/lib/types/catalog-entity-types.js +0 -3
  47. package/lib/types/code-walkthrough-types.js +0 -3
  48. package/lib/types/config-types.js +0 -3
  49. package/lib/types/graphql-types.js +0 -3
  50. package/lib/types/index.js +0 -21
  51. package/lib/types/portal-shared-types.js +0 -18
  52. package/lib/types/redoc-types.js +0 -3
  53. package/lib-esm/asyncapi-config-schema.js +0 -50
  54. package/lib-esm/common.js +0 -100
  55. package/lib-esm/constants/config.js +0 -14
  56. package/lib-esm/constants/entities.js +0 -55
  57. package/lib-esm/constants/enum.js +0 -2
  58. package/lib-esm/constants/shared.js +0 -19
  59. package/lib-esm/default-theme-config-schema.js +0 -54
  60. package/lib-esm/entities-catalog-config-schema.js +0 -183
  61. package/lib-esm/entities-catalog-entity-file-schema.js +0 -280
  62. package/lib-esm/ex-theme-config-schemas.js +0 -684
  63. package/lib-esm/feedback-config-schema.js +0 -85
  64. package/lib-esm/graphql-config-schema.js +0 -154
  65. package/lib-esm/product-override-schema.js +0 -41
  66. package/lib-esm/redoc-config-schema.js +0 -117
  67. package/lib-esm/reference-docs-config-schema.js +0 -515
  68. package/lib-esm/remove-property-recursively.js +0 -25
  69. package/lib-esm/reunite-config-schema.js +0 -100
  70. package/lib-esm/root-config-schema.js +0 -584
  71. package/lib-esm/scorecards-config-schema.js +0 -239
  72. package/lib-esm/types/api-functions-types.js +0 -2
  73. package/lib-esm/types/asyncapi-types.js +0 -2
  74. package/lib-esm/types/catalog-entity-types.js +0 -2
  75. package/lib-esm/types/code-walkthrough-types.js +0 -2
  76. package/lib-esm/types/config-types.js +0 -2
  77. package/lib-esm/types/graphql-types.js +0 -2
  78. package/lib-esm/types/index.js +0 -5
  79. package/lib-esm/types/portal-shared-types.js +0 -2
  80. package/lib-esm/types/redoc-types.js +0 -2
@@ -1,85 +0,0 @@
1
- const reasonsBaseProperties = {
2
- hide: {
3
- type: 'boolean',
4
- default: false,
5
- },
6
- component: {
7
- type: 'string',
8
- enum: ['radio', 'checkbox'],
9
- default: 'checkbox',
10
- },
11
- label: { type: 'string' },
12
- items: { type: 'array', items: { type: 'string' } },
13
- };
14
- export const reasonsSettings = {
15
- type: 'object',
16
- properties: reasonsBaseProperties,
17
- additionalProperties: false,
18
- };
19
- export const optionalEmailSettings = {
20
- type: 'object',
21
- properties: {
22
- hide: {
23
- type: 'boolean',
24
- default: false,
25
- },
26
- label: { type: 'string' },
27
- placeholder: { type: 'string' },
28
- },
29
- additionalProperties: false,
30
- };
31
- export const feedbackConfigSchema = {
32
- type: 'object',
33
- properties: {
34
- hide: {
35
- type: 'boolean',
36
- default: false,
37
- },
38
- type: {
39
- type: 'string',
40
- enum: ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'],
41
- default: 'sentiment',
42
- },
43
- settings: {
44
- type: 'object',
45
- properties: {
46
- label: { type: 'string' },
47
- submitText: { type: 'string' },
48
- buttonText: { type: 'string' },
49
- component: {
50
- type: 'string',
51
- enum: ['radio', 'checkbox'],
52
- default: 'checkbox',
53
- },
54
- items: { type: 'array', items: { type: 'string' }, minItems: 1 },
55
- leftScaleLabel: { type: 'string' },
56
- rightScaleLabel: { type: 'string' },
57
- reasons: {
58
- type: 'object',
59
- properties: Object.assign(Object.assign({}, reasonsBaseProperties), { like: reasonsSettings, dislike: reasonsSettings, satisfied: reasonsSettings, neutral: reasonsSettings, dissatisfied: reasonsSettings }),
60
- additionalProperties: false,
61
- },
62
- comment: {
63
- type: 'object',
64
- properties: {
65
- hide: {
66
- type: 'boolean',
67
- default: false,
68
- },
69
- label: { type: 'string' },
70
- likeLabel: { type: 'string' },
71
- dislikeLabel: { type: 'string' },
72
- satisfiedLabel: { type: 'string' },
73
- neutralLabel: { type: 'string' },
74
- dissatisfiedLabel: { type: 'string' },
75
- },
76
- additionalProperties: false,
77
- },
78
- optionalEmail: optionalEmailSettings,
79
- },
80
- additionalProperties: false,
81
- },
82
- },
83
- additionalProperties: false,
84
- };
85
- //# sourceMappingURL=feedback-config-schema.js.map
@@ -1,154 +0,0 @@
1
- import { feedbackConfigSchema } from './feedback-config-schema';
2
- import { downloadUrlsSchema } from './redoc-config-schema';
3
- const typeGroupConfig = {
4
- type: 'object',
5
- properties: {
6
- includeByName: {
7
- type: 'array',
8
- items: {
9
- type: 'string',
10
- },
11
- },
12
- excludeByName: {
13
- type: 'array',
14
- items: {
15
- type: 'string',
16
- },
17
- },
18
- },
19
- additionalProperties: false,
20
- };
21
- const menuGroupConfig = {
22
- type: 'object',
23
- properties: {
24
- name: {
25
- type: 'string',
26
- },
27
- items: typeGroupConfig,
28
- queries: typeGroupConfig,
29
- mutations: typeGroupConfig,
30
- subscriptions: typeGroupConfig,
31
- types: typeGroupConfig,
32
- directives: typeGroupConfig,
33
- },
34
- required: ['name'],
35
- additionalProperties: false,
36
- };
37
- const menuGroupingConfig = {
38
- type: 'object',
39
- properties: {
40
- requireExactGroups: {
41
- type: 'boolean',
42
- },
43
- groups: {
44
- type: 'array',
45
- items: menuGroupConfig,
46
- },
47
- otherItemsGroupName: {
48
- type: 'string',
49
- },
50
- },
51
- required: ['requireExactGroups', 'groups', 'otherItemsGroupName'],
52
- additionalProperties: false,
53
- };
54
- const graphqlContactConfigSchema = {
55
- type: 'object',
56
- properties: {
57
- name: { type: 'string' },
58
- url: { type: 'string', format: 'uri' },
59
- email: { type: 'string', format: 'email' },
60
- },
61
- additionalProperties: false,
62
- };
63
- const graphqlLicenseConfigSchema = {
64
- type: 'object',
65
- properties: {
66
- name: { type: 'string' },
67
- url: { type: 'string', format: 'uri' },
68
- identifier: { type: 'string' },
69
- },
70
- additionalProperties: false,
71
- };
72
- const graphqlInfoConfigSchema = {
73
- type: 'object',
74
- properties: {
75
- title: { type: 'string' },
76
- version: { type: 'string' },
77
- description: { type: 'string' },
78
- termsOfService: { type: 'string', format: 'uri' },
79
- contact: graphqlContactConfigSchema,
80
- license: graphqlLicenseConfigSchema,
81
- },
82
- additionalProperties: false,
83
- };
84
- export const graphqlConfigSchema = {
85
- type: 'object',
86
- properties: {
87
- menu: {
88
- type: 'object',
89
- properties: Object.assign({}, menuGroupingConfig.properties),
90
- additionalProperties: false,
91
- },
92
- sidebar: {
93
- type: 'object',
94
- properties: {
95
- hide: {
96
- type: 'boolean',
97
- },
98
- },
99
- },
100
- downloadUrls: downloadUrlsSchema,
101
- apiLogo: {
102
- type: 'object',
103
- properties: {
104
- imageUrl: {
105
- type: 'string',
106
- },
107
- href: {
108
- type: 'string',
109
- },
110
- altText: {
111
- type: 'string',
112
- },
113
- backgroundColor: {
114
- type: 'string',
115
- },
116
- },
117
- },
118
- jsonSamplesDepth: {
119
- type: 'number',
120
- },
121
- samplesMaxInlineArgs: {
122
- type: 'number',
123
- },
124
- licenseKey: {
125
- type: 'string',
126
- },
127
- fieldExpandLevel: {
128
- type: 'number',
129
- },
130
- baseUrlPath: {
131
- type: 'string',
132
- },
133
- metadata: {
134
- type: 'object',
135
- properties: {
136
- apiId: {
137
- type: 'string',
138
- },
139
- },
140
- additionalProperties: true,
141
- },
142
- feedback: feedbackConfigSchema,
143
- layout: { type: 'string', enum: ['stacked', 'three-panel'] },
144
- showBuiltInScalars: {
145
- type: 'boolean',
146
- },
147
- showBuiltInDirectives: {
148
- type: 'boolean',
149
- },
150
- info: graphqlInfoConfigSchema,
151
- },
152
- additionalProperties: false,
153
- };
154
- //# sourceMappingURL=graphql-config-schema.js.map
@@ -1,41 +0,0 @@
1
- import { themeConfigSchema } from './default-theme-config-schema';
2
- import { paletteConfigSchema, productGoogleAnalyticsConfigSchema } from './ex-theme-config-schemas';
3
- import { apiConfigSchema, redoclyConfigSchema } from './root-config-schema';
4
- export const productThemeOverrideSchema = {
5
- type: 'object',
6
- properties: {
7
- logo: themeConfigSchema.properties.logo,
8
- navbar: themeConfigSchema.properties.navbar,
9
- footer: themeConfigSchema.properties.footer,
10
- sidebar: themeConfigSchema.properties.sidebar,
11
- search: themeConfigSchema.properties.search,
12
- codeSnippet: themeConfigSchema.properties.codeSnippet,
13
- breadcrumbs: themeConfigSchema.properties.breadcrumbs,
14
- openapi: themeConfigSchema.properties.openapi,
15
- feedback: themeConfigSchema.properties.feedback,
16
- palette: paletteConfigSchema,
17
- mockServer: redoclyConfigSchema.properties.mockServer,
18
- analytics: {
19
- type: 'object',
20
- properties: {
21
- ga: productGoogleAnalyticsConfigSchema,
22
- },
23
- },
24
- },
25
- additionalProperties: true,
26
- default: {},
27
- };
28
- export const productConfigOverrideSchema = {
29
- $id: 'product-config-override',
30
- type: 'object',
31
- properties: Object.assign(Object.assign({}, productThemeOverrideSchema.properties), { apis: {
32
- type: 'object',
33
- additionalProperties: apiConfigSchema,
34
- },
35
- /**
36
- * @deprecated left for backwards compatibility
37
- */
38
- theme: productThemeOverrideSchema }),
39
- additionalProperties: false,
40
- };
41
- //# sourceMappingURL=product-override-schema.js.map
@@ -1,117 +0,0 @@
1
- import { feedbackConfigSchema } from './feedback-config-schema';
2
- const codeSamplesConfigSchema = {
3
- type: 'object',
4
- properties: {
5
- languages: {
6
- type: 'array',
7
- items: {
8
- type: 'object',
9
- properties: {
10
- lang: {
11
- type: 'string',
12
- examples: [
13
- 'curl',
14
- 'JavaScript',
15
- 'Node.js',
16
- 'Python',
17
- 'Java8+Apache',
18
- 'Java',
19
- 'C#',
20
- 'C#+Newtonsoft',
21
- 'PHP',
22
- 'Go',
23
- 'Ruby',
24
- 'R',
25
- 'Payload',
26
- ],
27
- },
28
- label: { type: 'string' },
29
- options: {
30
- type: 'object',
31
- properties: {
32
- indent: { type: 'string' },
33
- withImports: { type: 'boolean' },
34
- withComments: { type: 'boolean' },
35
- binary: { type: 'boolean' },
36
- credentials: {
37
- type: 'string',
38
- enum: ['omit', 'same-origin', 'include'],
39
- },
40
- },
41
- additionalProperties: false,
42
- },
43
- },
44
- required: ['lang'],
45
- additionalProperties: false,
46
- },
47
- },
48
- skipOptionalParameters: { type: 'boolean' },
49
- withOAuth2Call: { type: 'boolean' },
50
- },
51
- additionalProperties: false,
52
- };
53
- export const downloadUrlsSchema = {
54
- type: 'array',
55
- items: {
56
- type: 'object',
57
- properties: {
58
- title: { type: 'string' },
59
- url: { type: 'string' },
60
- },
61
- required: ['url'],
62
- additionalProperties: false,
63
- },
64
- };
65
- export const redocConfigSchema = {
66
- type: 'object',
67
- properties: {
68
- licenseKey: { type: 'string' },
69
- hideLoading: { type: 'boolean' },
70
- disableRouter: { type: 'boolean' },
71
- hideSidebar: { type: 'boolean' },
72
- feedback: feedbackConfigSchema,
73
- hideReplay: { type: 'boolean' },
74
- oAuth2RedirectURI: { type: 'string', nullable: true },
75
- corsProxyUrl: { type: 'string' },
76
- sortRequiredPropsFirst: { type: 'boolean' },
77
- sanitize: { type: 'boolean' },
78
- hideDownloadButtons: { type: 'boolean' },
79
- downloadUrls: downloadUrlsSchema,
80
- onlyRequiredInSamples: { type: 'boolean' },
81
- generatedSamplesMaxDepth: { oneOf: [{ type: 'number' }, { type: 'string' }] },
82
- showExtensions: {
83
- oneOf: [
84
- { type: 'boolean' },
85
- { type: 'string' },
86
- { type: 'array', items: { type: 'string' } },
87
- ],
88
- },
89
- hideSchemaTitles: { type: 'boolean' },
90
- jsonSamplesExpandLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
91
- schemasExpansionLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
92
- mockServer: {
93
- type: 'object',
94
- properties: {
95
- url: { type: 'string' },
96
- position: { type: 'string', enum: ['first', 'last', 'replace', 'off'] },
97
- description: { type: 'string' },
98
- },
99
- },
100
- maxDisplayedEnumValues: { type: 'number' },
101
- schemaDefinitionsTagName: { type: 'string' },
102
- layout: { type: 'string', enum: ['stacked', 'three-panel'] },
103
- hideInfoMetadata: { type: 'boolean' },
104
- events: { type: 'object' },
105
- skipBundle: { type: 'boolean' },
106
- routingBasePath: { type: 'string' },
107
- codeSamples: codeSamplesConfigSchema,
108
- ignoreNamedSchemas: {
109
- oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }],
110
- },
111
- hidePropertiesPrefix: { type: 'boolean' },
112
- excludeFromSearch: { type: 'boolean' },
113
- showSchemaCatalogLinks: { type: 'boolean' },
114
- },
115
- additionalProperties: false,
116
- };
117
- //# sourceMappingURL=redoc-config-schema.js.map