@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
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.themeConfigSchema = void 0;
4
4
  const graphql_config_schema_1 = require("./graphql-config-schema");
5
+ const asyncapi_config_schema_1 = require("./asyncapi-config-schema");
5
6
  const feedback_config_schema_1 = require("./feedback-config-schema");
6
7
  const ex_theme_config_schemas_1 = require("./ex-theme-config-schemas");
7
8
  const entities_catalog_config_schema_1 = require("./entities-catalog-config-schema");
@@ -31,6 +32,7 @@ exports.themeConfigSchema = {
31
32
  codeSnippet: ex_theme_config_schemas_1.codeSnippetConfigSchema,
32
33
  markdown: ex_theme_config_schemas_1.markdownConfigSchema,
33
34
  openapi: ex_theme_config_schemas_1.openapiConfigSchema,
35
+ asyncapi: asyncapi_config_schema_1.asyncapiConfigSchema,
34
36
  graphql: graphql_config_schema_1.graphqlConfigSchema,
35
37
  analytics: ex_theme_config_schemas_1.analyticsConfigSchema,
36
38
  userMenu: ex_theme_config_schemas_1.userMenuConfigSchema,
@@ -46,8 +48,8 @@ exports.themeConfigSchema = {
46
48
  * @deprecated Should use `scorecardClassic` instead
47
49
  */
48
50
  scorecard: ex_theme_config_schemas_1.scorecardConfigSchema,
49
- scorecards: scorecards_config_schema_1.scorecardsConfigSchema,
50
51
  scorecardClassic: ex_theme_config_schemas_1.scorecardConfigSchema,
52
+ scorecards: scorecards_config_schema_1.scorecardsConfigSchema,
51
53
  },
52
54
  additionalProperties: true,
53
55
  };
@@ -1,10 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.entityFileDefaultSchema = exports.entityFileSchema = exports.entityBaseProperties = exports.entityRelationFileSchema = exports.entityLinkFileSchema = exports.entityContactFileSchema = exports.slackContactFileSchema = exports.slackChannelFileSchema = exports.defaultMetadataSchema = exports.dataSchemaMetadataSchema = exports.apiOperationMetadataSchema = exports.apiDescriptionMetadataSchema = exports.userMetadataSchema = void 0;
4
- const constants_1 = require("./constants");
4
+ const entities_1 = require("./constants/entities");
5
5
  exports.userMetadataSchema = {
6
6
  type: 'object',
7
- nodeTypeName: constants_1.NODE_TYPE_NAMES.USER_ENTITY_METADATA,
7
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.UserEntityMetadata,
8
8
  properties: {
9
9
  email: {
10
10
  type: 'string',
@@ -16,7 +16,7 @@ exports.userMetadataSchema = {
16
16
  };
17
17
  exports.apiDescriptionMetadataSchema = {
18
18
  type: 'object',
19
- nodeTypeName: constants_1.NODE_TYPE_NAMES.API_DESCRIPTION_METADATA,
19
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntityMetadata,
20
20
  properties: {
21
21
  specType: {
22
22
  type: 'string',
@@ -33,7 +33,7 @@ exports.apiDescriptionMetadataSchema = {
33
33
  };
34
34
  exports.apiOperationMetadataSchema = {
35
35
  type: 'object',
36
- nodeTypeName: constants_1.NODE_TYPE_NAMES.API_OPERATION_METADATA,
36
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiOperationEntityMetadata,
37
37
  properties: {
38
38
  method: {
39
39
  type: 'string',
@@ -64,7 +64,7 @@ exports.apiOperationMetadataSchema = {
64
64
  };
65
65
  exports.dataSchemaMetadataSchema = {
66
66
  type: 'object',
67
- nodeTypeName: constants_1.NODE_TYPE_NAMES.DATA_SCHEMA_METADATA,
67
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DataSchemaEntityMetadata,
68
68
  properties: {
69
69
  specType: {
70
70
  type: 'string',
@@ -86,12 +86,12 @@ exports.dataSchemaMetadataSchema = {
86
86
  exports.defaultMetadataSchema = {
87
87
  type: 'object',
88
88
  properties: {},
89
- nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_METADATA,
89
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityMetadata,
90
90
  additionalProperties: true,
91
91
  };
92
92
  exports.slackChannelFileSchema = {
93
93
  type: 'object',
94
- nodeTypeName: constants_1.NODE_TYPE_NAMES.SLACK_CHANNEL,
94
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntitySlackChannel,
95
95
  properties: {
96
96
  name: {
97
97
  type: 'string',
@@ -107,7 +107,7 @@ exports.slackChannelFileSchema = {
107
107
  };
108
108
  exports.slackContactFileSchema = {
109
109
  type: 'object',
110
- nodeTypeName: constants_1.NODE_TYPE_NAMES.SLACK_CONTACT,
110
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntitySlackContact,
111
111
  properties: {
112
112
  channels: {
113
113
  type: 'array',
@@ -119,7 +119,7 @@ exports.slackContactFileSchema = {
119
119
  };
120
120
  exports.entityContactFileSchema = {
121
121
  type: 'object',
122
- nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_CONTACT,
122
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityContact,
123
123
  properties: {
124
124
  slack: exports.slackContactFileSchema,
125
125
  },
@@ -127,7 +127,7 @@ exports.entityContactFileSchema = {
127
127
  };
128
128
  exports.entityLinkFileSchema = {
129
129
  type: 'object',
130
- nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_LINK,
130
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityLink,
131
131
  properties: {
132
132
  label: {
133
133
  type: 'string',
@@ -143,11 +143,11 @@ exports.entityLinkFileSchema = {
143
143
  };
144
144
  exports.entityRelationFileSchema = {
145
145
  type: 'object',
146
- nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_RELATION,
146
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityRelation,
147
147
  properties: {
148
148
  type: {
149
149
  type: 'string',
150
- enum: constants_1.ENTITY_RELATION_TYPES,
150
+ enum: entities_1.ENTITY_RELATION_TYPES,
151
151
  },
152
152
  key: {
153
153
  type: 'string',
@@ -206,12 +206,12 @@ exports.entityBaseProperties = {
206
206
  contact: exports.entityContactFileSchema,
207
207
  links: {
208
208
  type: 'array',
209
- nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_LINK_LIST,
209
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityLinkList,
210
210
  items: exports.entityLinkFileSchema,
211
211
  },
212
212
  relations: {
213
213
  type: 'array',
214
- nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY_RELATION_LIST,
214
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityRelationList,
215
215
  items: exports.entityRelationFileSchema,
216
216
  },
217
217
  metadata: exports.defaultMetadataSchema,
@@ -227,46 +227,46 @@ exports.entityFileSchema = {
227
227
  properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'user' }, metadata: exports.userMetadataSchema }),
228
228
  required: ['key', 'title', 'type', 'metadata'],
229
229
  additionalProperties: false,
230
- nodeTypeName: constants_1.NODE_TYPE_NAMES.USER_ENTITY,
230
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.UserEntity,
231
231
  },
232
232
  {
233
233
  type: 'object',
234
- nodeTypeName: constants_1.NODE_TYPE_NAMES.API_OPERATION_ENTITY,
234
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiOperationEntity,
235
235
  properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-operation' }, metadata: exports.apiOperationMetadataSchema }),
236
236
  required: ['key', 'title', 'type', 'metadata'],
237
237
  additionalProperties: false,
238
238
  },
239
239
  {
240
240
  type: 'object',
241
- nodeTypeName: constants_1.NODE_TYPE_NAMES.DATA_SCHEMA_ENTITY,
241
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DataSchemaEntity,
242
242
  properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'data-schema' }, metadata: exports.dataSchemaMetadataSchema }),
243
243
  required: ['key', 'title', 'type', 'metadata'],
244
244
  additionalProperties: false,
245
245
  },
246
246
  {
247
247
  type: 'object',
248
- nodeTypeName: constants_1.NODE_TYPE_NAMES.API_DESCRIPTION_ENTITY,
248
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntity,
249
249
  properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-description' }, metadata: exports.apiDescriptionMetadataSchema }),
250
250
  required: ['key', 'title', 'type', 'metadata'],
251
251
  additionalProperties: false,
252
252
  },
253
253
  {
254
254
  type: 'object',
255
- nodeTypeName: constants_1.NODE_TYPE_NAMES.SERVICE_ENTITY,
255
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ServiceEntity,
256
256
  properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'service' } }),
257
257
  required: ['key', 'title', 'type'],
258
258
  additionalProperties: false,
259
259
  },
260
260
  {
261
261
  type: 'object',
262
- nodeTypeName: constants_1.NODE_TYPE_NAMES.DOMAIN_ENTITY,
262
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DomainEntity,
263
263
  properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'domain' } }),
264
264
  required: ['key', 'title', 'type'],
265
265
  additionalProperties: false,
266
266
  },
267
267
  {
268
268
  type: 'object',
269
- nodeTypeName: constants_1.NODE_TYPE_NAMES.TEAM_ENTITY,
269
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.TeamEntity,
270
270
  properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'team' } }),
271
271
  required: ['key', 'title', 'type'],
272
272
  additionalProperties: false,
@@ -275,7 +275,7 @@ exports.entityFileSchema = {
275
275
  };
276
276
  exports.entityFileDefaultSchema = {
277
277
  type: 'object',
278
- nodeTypeName: constants_1.NODE_TYPE_NAMES.ENTITY,
278
+ nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.Entity,
279
279
  properties: Object.assign({}, exports.entityBaseProperties),
280
280
  required: ['key', 'title', 'type'],
281
281
  additionalProperties: false,