@redocly/config 0.31.0 → 0.33.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 (43) hide show
  1. package/lib/constants.d.ts +1 -0
  2. package/lib/constants.js +28 -1
  3. package/lib/default-theme-config-schema.d.ts +106 -0
  4. package/lib/entities-catalog-config-schema.d.ts +426 -0
  5. package/lib/entities-catalog-config-schema.js +100 -1
  6. package/lib/entities-catalog-entity-file-schema.d.ts +964 -0
  7. package/lib/entities-catalog-entity-file-schema.js +273 -0
  8. package/lib/ex-theme-config-schemas.d.ts +3 -0
  9. package/lib/index.d.ts +2 -1
  10. package/lib/index.js +3 -1
  11. package/lib/product-override-schema.d.ts +15 -0
  12. package/lib/redoc-config-schema.d.ts +3 -0
  13. package/lib/redoc-config-schema.js +1 -0
  14. package/lib/reunite-config-schema.d.ts +1 -1
  15. package/lib/reunite-config-schema.js +1 -1
  16. package/lib/root-config-schema.d.ts +4325 -5128
  17. package/lib/root-config-schema.js +1 -1
  18. package/lib/types/api-functions-types.d.ts +1 -1
  19. package/lib/types/catalog-entity-types.d.ts +42 -2
  20. package/lib/types/config-types.d.ts +0 -2
  21. package/lib/types/portal-shared-types.d.ts +1 -1
  22. package/lib-esm/constants.d.ts +1 -0
  23. package/lib-esm/constants.js +27 -0
  24. package/lib-esm/default-theme-config-schema.d.ts +106 -0
  25. package/lib-esm/entities-catalog-config-schema.d.ts +426 -0
  26. package/lib-esm/entities-catalog-config-schema.js +99 -0
  27. package/lib-esm/entities-catalog-entity-file-schema.d.ts +964 -0
  28. package/lib-esm/entities-catalog-entity-file-schema.js +270 -0
  29. package/lib-esm/ex-theme-config-schemas.d.ts +3 -0
  30. package/lib-esm/index.d.ts +2 -1
  31. package/lib-esm/index.js +2 -1
  32. package/lib-esm/product-override-schema.d.ts +15 -0
  33. package/lib-esm/redoc-config-schema.d.ts +3 -0
  34. package/lib-esm/redoc-config-schema.js +1 -0
  35. package/lib-esm/reunite-config-schema.d.ts +1 -1
  36. package/lib-esm/reunite-config-schema.js +1 -1
  37. package/lib-esm/root-config-schema.d.ts +4325 -5128
  38. package/lib-esm/root-config-schema.js +1 -1
  39. package/lib-esm/types/api-functions-types.d.ts +1 -1
  40. package/lib-esm/types/catalog-entity-types.d.ts +42 -2
  41. package/lib-esm/types/config-types.d.ts +0 -2
  42. package/lib-esm/types/portal-shared-types.d.ts +1 -1
  43. package/package.json +1 -1
package/lib/entities-catalog-config-schema.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.entitiesCatalogConfigSchema = exports.entityCatalogSpecificCatalogSchema = exports.entityCatalogFilterSchema = exports.entityCatalogIncludeSchema = exports.entityCatalogExcludeSchema = void 0;
3
+ exports.entitiesCatalogConfigSchema = exports.entityCatalogEntityTypesSchema = exports.entityCatalogEntityTypeSchema = exports.entityCatalogMetadataSchema = exports.entityCatalogMetadataSchemaPropertySchema = exports.entityCatalogSpecificCatalogSchema = exports.entityCatalogFilterSchema = exports.entityCatalogIncludeSchema = exports.entityCatalogExcludeSchema = void 0;
4
4
  exports.entityCatalogExcludeSchema = {
5
5
  type: 'object',
6
6
  required: ['key'],
@@ -63,9 +63,108 @@ exports.entityCatalogSpecificCatalogSchema = {
63
63
  },
64
64
  additionalProperties: false,
65
65
  };
66
+ exports.entityCatalogMetadataSchemaPropertySchema = {
67
+ type: 'object',
68
+ properties: {
69
+ type: {
70
+ type: 'string',
71
+ enum: ['string', 'number', 'boolean', 'array', 'object'],
72
+ },
73
+ description: {
74
+ type: 'string',
75
+ },
76
+ example: {
77
+ oneOf: [
78
+ { type: 'string' },
79
+ { type: 'number' },
80
+ { type: 'boolean' },
81
+ { type: 'array' },
82
+ { type: 'object' },
83
+ ],
84
+ },
85
+ enum: {
86
+ type: 'array',
87
+ items: { type: 'string' },
88
+ },
89
+ pattern: {
90
+ type: 'string',
91
+ },
92
+ format: {
93
+ type: 'string',
94
+ },
95
+ minimum: {
96
+ type: 'number',
97
+ },
98
+ maximum: {
99
+ type: 'number',
100
+ },
101
+ items: {
102
+ type: 'object',
103
+ },
104
+ },
105
+ additionalProperties: true,
106
+ };
107
+ exports.entityCatalogMetadataSchema = {
108
+ type: 'object',
109
+ required: ['type', 'properties'],
110
+ properties: {
111
+ type: {
112
+ type: 'string',
113
+ enum: ['object'],
114
+ },
115
+ description: {
116
+ type: 'string',
117
+ },
118
+ properties: {
119
+ type: 'object',
120
+ additionalProperties: exports.entityCatalogMetadataSchemaPropertySchema,
121
+ },
122
+ required: {
123
+ type: 'array',
124
+ items: { type: 'string' },
125
+ },
126
+ additionalProperties: {
127
+ type: 'boolean',
128
+ },
129
+ },
130
+ additionalProperties: true,
131
+ };
132
+ exports.entityCatalogEntityTypeSchema = {
133
+ type: 'object',
134
+ required: ['name', 'description', 'metadataSchema'],
135
+ properties: {
136
+ name: {
137
+ type: 'string',
138
+ description: 'Display name of the entity type',
139
+ },
140
+ description: {
141
+ type: 'string',
142
+ description: 'Description of the entity type',
143
+ },
144
+ metadataSchema: exports.entityCatalogMetadataSchema,
145
+ icon: {
146
+ type: 'object',
147
+ properties: {
148
+ src: {
149
+ type: 'string',
150
+ },
151
+ srcSet: {
152
+ type: 'string',
153
+ },
154
+ },
155
+ additionalProperties: false,
156
+ },
157
+ },
158
+ additionalProperties: false,
159
+ };
160
+ exports.entityCatalogEntityTypesSchema = {
161
+ type: 'object',
162
+ additionalProperties: exports.entityCatalogEntityTypeSchema,
163
+ };
66
164
  exports.entitiesCatalogConfigSchema = {
67
165
  type: 'object',
68
166
  properties: {
167
+ entityTypes: exports.entityCatalogEntityTypesSchema,
69
168
  catalogs: {
70
169
  type: 'object',
71
170
  properties: {