@redocly/config 0.43.0 → 0.44.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 (65) hide show
  1. package/lib/asyncapi-config-schema.d.ts +300 -0
  2. package/lib/asyncapi-config-schema.js +53 -0
  3. package/lib/common.d.ts +241 -22
  4. package/lib/common.js +50 -37
  5. package/lib/constants/config.d.ts +12 -0
  6. package/lib/constants/config.js +17 -0
  7. package/lib/constants/entities.d.ts +45 -0
  8. package/lib/constants/entities.js +58 -0
  9. package/lib/constants/enum.d.ts +1 -0
  10. package/lib/constants/enum.js +6 -0
  11. package/lib/constants/shared.d.ts +15 -0
  12. package/lib/constants/shared.js +22 -0
  13. package/lib/default-theme-config-schema.d.ts +3205 -2762
  14. package/lib/default-theme-config-schema.js +3 -1
  15. package/lib/entities-catalog-entity-file-schema.js +22 -22
  16. package/lib/ex-theme-config-schemas.d.ts +1903 -26
  17. package/lib/ex-theme-config-schemas.js +25 -3
  18. package/lib/index.d.ts +3 -1
  19. package/lib/index.js +13 -10
  20. package/lib/product-override-schema.d.ts +73 -20
  21. package/lib/remove-property-recursively.d.ts +1 -1
  22. package/lib/remove-property-recursively.js +7 -4
  23. package/lib/root-config-schema.d.ts +3715 -1713
  24. package/lib/root-config-schema.js +18 -11
  25. package/lib/scorecards-config-schema.d.ts +6 -0
  26. package/lib/scorecards-config-schema.js +2 -4
  27. package/lib/types/asyncapi-types.d.ts +14 -0
  28. package/lib/types/asyncapi-types.js +3 -0
  29. package/lib/types/config-types.d.ts +2 -0
  30. package/lib/types/portal-shared-types.d.ts +1 -1
  31. package/lib-esm/asyncapi-config-schema.d.ts +300 -0
  32. package/lib-esm/asyncapi-config-schema.js +50 -0
  33. package/lib-esm/common.d.ts +241 -22
  34. package/lib-esm/common.js +29 -16
  35. package/lib-esm/constants/config.d.ts +12 -0
  36. package/lib-esm/constants/config.js +14 -0
  37. package/lib-esm/constants/entities.d.ts +45 -0
  38. package/lib-esm/constants/entities.js +55 -0
  39. package/lib-esm/constants/enum.d.ts +1 -0
  40. package/lib-esm/constants/enum.js +2 -0
  41. package/lib-esm/constants/shared.d.ts +15 -0
  42. package/lib-esm/constants/shared.js +19 -0
  43. package/lib-esm/default-theme-config-schema.d.ts +3205 -2762
  44. package/lib-esm/default-theme-config-schema.js +3 -1
  45. package/lib-esm/entities-catalog-entity-file-schema.js +21 -21
  46. package/lib-esm/ex-theme-config-schemas.d.ts +1903 -26
  47. package/lib-esm/ex-theme-config-schemas.js +25 -3
  48. package/lib-esm/index.d.ts +3 -1
  49. package/lib-esm/index.js +3 -1
  50. package/lib-esm/product-override-schema.d.ts +73 -20
  51. package/lib-esm/remove-property-recursively.d.ts +1 -1
  52. package/lib-esm/remove-property-recursively.js +7 -4
  53. package/lib-esm/root-config-schema.d.ts +3715 -1713
  54. package/lib-esm/root-config-schema.js +14 -7
  55. package/lib-esm/scorecards-config-schema.d.ts +6 -0
  56. package/lib-esm/scorecards-config-schema.js +2 -4
  57. package/lib-esm/types/asyncapi-types.d.ts +14 -0
  58. package/lib-esm/types/asyncapi-types.js +2 -0
  59. package/lib-esm/types/config-types.d.ts +2 -0
  60. package/lib-esm/types/portal-shared-types.d.ts +1 -1
  61. package/package.json +2 -2
  62. package/lib/constants.d.ts +0 -38
  63. package/lib/constants.js +0 -73
  64. package/lib-esm/constants.d.ts +0 -38
  65. package/lib-esm/constants.js +0 -70
@@ -1,4 +1,5 @@
1
1
  import { graphqlConfigSchema } from './graphql-config-schema';
2
+ import { asyncapiConfigSchema } from './asyncapi-config-schema';
2
3
  import { feedbackConfigSchema } from './feedback-config-schema';
3
4
  import { logoConfigSchema, analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, footerConfigSchema, linksConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
4
5
  import { entitiesCatalogConfigSchema } from './entities-catalog-config-schema';
@@ -28,6 +29,7 @@ export const themeConfigSchema = {
28
29
  codeSnippet: codeSnippetConfigSchema,
29
30
  markdown: markdownConfigSchema,
30
31
  openapi: openapiConfigSchema,
32
+ asyncapi: asyncapiConfigSchema,
31
33
  graphql: graphqlConfigSchema,
32
34
  analytics: analyticsConfigSchema,
33
35
  userMenu: userMenuConfigSchema,
@@ -43,8 +45,8 @@ export const themeConfigSchema = {
43
45
  * @deprecated Should use `scorecardClassic` instead
44
46
  */
45
47
  scorecard: scorecardConfigSchema,
46
- scorecards: scorecardsConfigSchema,
47
48
  scorecardClassic: scorecardConfigSchema,
49
+ scorecards: scorecardsConfigSchema,
48
50
  },
49
51
  additionalProperties: true,
50
52
  };
@@ -1,7 +1,7 @@
1
- import { ENTITY_RELATION_TYPES, NODE_TYPE_NAMES } from './constants';
1
+ import { ENTITY_RELATION_TYPES, ENTITY_NODE_TYPE_NAMES } from './constants/entities';
2
2
  export const userMetadataSchema = {
3
3
  type: 'object',
4
- nodeTypeName: NODE_TYPE_NAMES.USER_ENTITY_METADATA,
4
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.UserEntityMetadata,
5
5
  properties: {
6
6
  email: {
7
7
  type: 'string',
@@ -13,7 +13,7 @@ export const userMetadataSchema = {
13
13
  };
14
14
  export const apiDescriptionMetadataSchema = {
15
15
  type: 'object',
16
- nodeTypeName: NODE_TYPE_NAMES.API_DESCRIPTION_METADATA,
16
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntityMetadata,
17
17
  properties: {
18
18
  specType: {
19
19
  type: 'string',
@@ -30,7 +30,7 @@ export const apiDescriptionMetadataSchema = {
30
30
  };
31
31
  export const apiOperationMetadataSchema = {
32
32
  type: 'object',
33
- nodeTypeName: NODE_TYPE_NAMES.API_OPERATION_METADATA,
33
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.ApiOperationEntityMetadata,
34
34
  properties: {
35
35
  method: {
36
36
  type: 'string',
@@ -61,7 +61,7 @@ export const apiOperationMetadataSchema = {
61
61
  };
62
62
  export const dataSchemaMetadataSchema = {
63
63
  type: 'object',
64
- nodeTypeName: NODE_TYPE_NAMES.DATA_SCHEMA_METADATA,
64
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.DataSchemaEntityMetadata,
65
65
  properties: {
66
66
  specType: {
67
67
  type: 'string',
@@ -83,12 +83,12 @@ export const dataSchemaMetadataSchema = {
83
83
  export const defaultMetadataSchema = {
84
84
  type: 'object',
85
85
  properties: {},
86
- nodeTypeName: NODE_TYPE_NAMES.ENTITY_METADATA,
86
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityMetadata,
87
87
  additionalProperties: true,
88
88
  };
89
89
  export const slackChannelFileSchema = {
90
90
  type: 'object',
91
- nodeTypeName: NODE_TYPE_NAMES.SLACK_CHANNEL,
91
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntitySlackChannel,
92
92
  properties: {
93
93
  name: {
94
94
  type: 'string',
@@ -104,7 +104,7 @@ export const slackChannelFileSchema = {
104
104
  };
105
105
  export const slackContactFileSchema = {
106
106
  type: 'object',
107
- nodeTypeName: NODE_TYPE_NAMES.SLACK_CONTACT,
107
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntitySlackContact,
108
108
  properties: {
109
109
  channels: {
110
110
  type: 'array',
@@ -116,7 +116,7 @@ export const slackContactFileSchema = {
116
116
  };
117
117
  export const entityContactFileSchema = {
118
118
  type: 'object',
119
- nodeTypeName: NODE_TYPE_NAMES.ENTITY_CONTACT,
119
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityContact,
120
120
  properties: {
121
121
  slack: slackContactFileSchema,
122
122
  },
@@ -124,7 +124,7 @@ export const entityContactFileSchema = {
124
124
  };
125
125
  export const entityLinkFileSchema = {
126
126
  type: 'object',
127
- nodeTypeName: NODE_TYPE_NAMES.ENTITY_LINK,
127
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityLink,
128
128
  properties: {
129
129
  label: {
130
130
  type: 'string',
@@ -140,7 +140,7 @@ export const entityLinkFileSchema = {
140
140
  };
141
141
  export const entityRelationFileSchema = {
142
142
  type: 'object',
143
- nodeTypeName: NODE_TYPE_NAMES.ENTITY_RELATION,
143
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityRelation,
144
144
  properties: {
145
145
  type: {
146
146
  type: 'string',
@@ -203,12 +203,12 @@ export const entityBaseProperties = {
203
203
  contact: entityContactFileSchema,
204
204
  links: {
205
205
  type: 'array',
206
- nodeTypeName: NODE_TYPE_NAMES.ENTITY_LINK_LIST,
206
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityLinkList,
207
207
  items: entityLinkFileSchema,
208
208
  },
209
209
  relations: {
210
210
  type: 'array',
211
- nodeTypeName: NODE_TYPE_NAMES.ENTITY_RELATION_LIST,
211
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityRelationList,
212
212
  items: entityRelationFileSchema,
213
213
  },
214
214
  metadata: defaultMetadataSchema,
@@ -224,46 +224,46 @@ export const entityFileSchema = {
224
224
  properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'user' }, metadata: userMetadataSchema }),
225
225
  required: ['key', 'title', 'type', 'metadata'],
226
226
  additionalProperties: false,
227
- nodeTypeName: NODE_TYPE_NAMES.USER_ENTITY,
227
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.UserEntity,
228
228
  },
229
229
  {
230
230
  type: 'object',
231
- nodeTypeName: NODE_TYPE_NAMES.API_OPERATION_ENTITY,
231
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.ApiOperationEntity,
232
232
  properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'api-operation' }, metadata: apiOperationMetadataSchema }),
233
233
  required: ['key', 'title', 'type', 'metadata'],
234
234
  additionalProperties: false,
235
235
  },
236
236
  {
237
237
  type: 'object',
238
- nodeTypeName: NODE_TYPE_NAMES.DATA_SCHEMA_ENTITY,
238
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.DataSchemaEntity,
239
239
  properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'data-schema' }, metadata: dataSchemaMetadataSchema }),
240
240
  required: ['key', 'title', 'type', 'metadata'],
241
241
  additionalProperties: false,
242
242
  },
243
243
  {
244
244
  type: 'object',
245
- nodeTypeName: NODE_TYPE_NAMES.API_DESCRIPTION_ENTITY,
245
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntity,
246
246
  properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'api-description' }, metadata: apiDescriptionMetadataSchema }),
247
247
  required: ['key', 'title', 'type', 'metadata'],
248
248
  additionalProperties: false,
249
249
  },
250
250
  {
251
251
  type: 'object',
252
- nodeTypeName: NODE_TYPE_NAMES.SERVICE_ENTITY,
252
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.ServiceEntity,
253
253
  properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'service' } }),
254
254
  required: ['key', 'title', 'type'],
255
255
  additionalProperties: false,
256
256
  },
257
257
  {
258
258
  type: 'object',
259
- nodeTypeName: NODE_TYPE_NAMES.DOMAIN_ENTITY,
259
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.DomainEntity,
260
260
  properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'domain' } }),
261
261
  required: ['key', 'title', 'type'],
262
262
  additionalProperties: false,
263
263
  },
264
264
  {
265
265
  type: 'object',
266
- nodeTypeName: NODE_TYPE_NAMES.TEAM_ENTITY,
266
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.TeamEntity,
267
267
  properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'team' } }),
268
268
  required: ['key', 'title', 'type'],
269
269
  additionalProperties: false,
@@ -272,7 +272,7 @@ export const entityFileSchema = {
272
272
  };
273
273
  export const entityFileDefaultSchema = {
274
274
  type: 'object',
275
- nodeTypeName: NODE_TYPE_NAMES.ENTITY,
275
+ nodeTypeName: ENTITY_NODE_TYPE_NAMES.Entity,
276
276
  properties: Object.assign({}, entityBaseProperties),
277
277
  required: ['key', 'title', 'type'],
278
278
  additionalProperties: false,