@redocly/config 0.47.0 → 0.48.1

package/lib/entities-catalog-config-schema.js

@@ -1,186 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.entitiesCatalogConfigSchema = exports.entityCatalogEntityTypesSchema = exports.entityCatalogEntityTypeSchema = exports.entityCatalogMetadataSchema = exports.entityCatalogMetadataSchemaPropertySchema = exports.entityCatalogSpecificCatalogSchema = exports.entityCatalogFilterSchema = exports.entityCatalogIncludeSchema = exports.entityCatalogExcludeSchema = void 0;
-exports.entityCatalogExcludeSchema = {
-    type: 'object',
-    required: ['key'],
-    properties: {
-        key: { type: 'string' },
-    },
-    additionalProperties: false,
-};
-exports.entityCatalogIncludeSchema = {
-    type: 'object',
-    required: ['type'],
-    properties: {
-        type: { type: 'string' },
-    },
-    additionalProperties: false,
-};
-exports.entityCatalogFilterSchema = {
-    type: 'object',
-    required: ['property', 'title'],
-    properties: {
-        property: { type: 'string' },
-        hide: { type: 'boolean' },
-        label: { type: 'string' },
-        options: {
-            type: 'array',
-            items: { type: 'string' },
-        },
-        type: {
-            type: 'string',
-            enum: ['select', 'checkboxes', 'date-range'],
-            default: 'checkboxes',
-        },
-        title: { type: 'string' },
-        titleTranslationKey: { type: 'string' },
-        parentFilter: { type: 'string' },
-        valuesMapping: { type: 'object', additionalProperties: { type: 'string' } },
-    },
-    additionalProperties: false,
-};
-exports.entityCatalogSpecificCatalogSchema = {
-    type: 'object',
-    properties: {
-        slug: { type: 'string' },
-        hide: { type: 'boolean' },
-        includes: {
-            type: 'array',
-            items: exports.entityCatalogIncludeSchema,
-        },
-        excludes: {
-            type: 'array',
-            items: exports.entityCatalogExcludeSchema,
-        },
-        filters: {
-            type: 'array',
-            items: exports.entityCatalogFilterSchema,
-        },
-        titleTranslationKey: { type: 'string' },
-        descriptionTranslationKey: { type: 'string' },
-        catalogSwitcherLabelTranslationKey: { type: 'string' },
-    },
-    additionalProperties: false,
-};
-exports.entityCatalogMetadataSchemaPropertySchema = {
-    type: 'object',
-    properties: {
-        type: {
-            type: 'string',
-            enum: ['string', 'number', 'boolean', 'array', 'object'],
-        },
-        description: {
-            type: 'string',
-        },
-        example: {
-            oneOf: [
-                { type: 'string' },
-                { type: 'number' },
-                { type: 'boolean' },
-                { type: 'array' },
-                { type: 'object' },
-            ],
-        },
-        enum: {
-            type: 'array',
-            items: { type: 'string' },
-        },
-        pattern: {
-            type: 'string',
-        },
-        format: {
-            type: 'string',
-        },
-        minimum: {
-            type: 'number',
-        },
-        maximum: {
-            type: 'number',
-        },
-        items: {
-            type: 'object',
-        },
-    },
-    additionalProperties: true,
-};
-exports.entityCatalogMetadataSchema = {
-    type: 'object',
-    required: ['type', 'properties'],
-    properties: {
-        type: {
-            type: 'string',
-            enum: ['object'],
-        },
-        description: {
-            type: 'string',
-        },
-        properties: {
-            type: 'object',
-            additionalProperties: exports.entityCatalogMetadataSchemaPropertySchema,
-        },
-        required: {
-            type: 'array',
-            items: { type: 'string' },
-        },
-        additionalProperties: {
-            type: 'boolean',
-        },
-    },
-    additionalProperties: true,
-};
-exports.entityCatalogEntityTypeSchema = {
-    type: 'object',
-    required: ['name', 'description', 'metadataSchema'],
-    properties: {
-        name: {
-            type: 'string',
-            description: 'Display name of the entity type',
-        },
-        description: {
-            type: 'string',
-            description: 'Description of the entity type',
-        },
-        metadataSchema: exports.entityCatalogMetadataSchema,
-        icon: {
-            type: 'object',
-            properties: {
-                src: {
-                    type: 'string',
-                },
-                srcSet: {
-                    type: 'string',
-                },
-            },
-            additionalProperties: false,
-        },
-    },
-    additionalProperties: false,
-};
-exports.entityCatalogEntityTypesSchema = {
-    type: 'object',
-    additionalProperties: exports.entityCatalogEntityTypeSchema,
-};
-exports.entitiesCatalogConfigSchema = {
-    type: 'object',
-    properties: {
-        show: { type: 'boolean', default: false },
-        entityTypes: exports.entityCatalogEntityTypesSchema,
-        catalogs: {
-            type: 'object',
-            properties: {
-                all: exports.entityCatalogSpecificCatalogSchema,
-                services: exports.entityCatalogSpecificCatalogSchema,
-                domains: exports.entityCatalogSpecificCatalogSchema,
-                teams: exports.entityCatalogSpecificCatalogSchema,
-                users: exports.entityCatalogSpecificCatalogSchema,
-                apiDescriptions: exports.entityCatalogSpecificCatalogSchema,
-                dataSchemas: exports.entityCatalogSpecificCatalogSchema,
-                apiOperations: exports.entityCatalogSpecificCatalogSchema,
-            },
-            additionalProperties: exports.entityCatalogSpecificCatalogSchema,
-        },
-    },
-    additionalProperties: false,
-};
-//# sourceMappingURL=entities-catalog-config-schema.js.map

package/lib/entities-catalog-entity-file-schema.js

@@ -1,283 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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;
-const entities_1 = require("./constants/entities");
-exports.userMetadataSchema = {
-    type: 'object',
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.UserEntityMetadata,
-    properties: {
-        email: {
-            type: 'string',
-            description: 'Email of the user',
-        },
-    },
-    required: ['email'],
-    additionalProperties: true,
-};
-exports.apiDescriptionMetadataSchema = {
-    type: 'object',
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntityMetadata,
-    properties: {
-        specType: {
-            type: 'string',
-            enum: ['jsonschema', 'openapi', 'asyncapi', 'avro', 'zod', 'graphql', 'protobuf', 'arazzo'],
-            description: 'Type of the API description',
-        },
-        descriptionFile: {
-            type: 'string',
-            description: 'Path to the file containing the API description',
-        },
-    },
-    required: ['specType', 'descriptionFile'],
-    additionalProperties: true,
-};
-exports.apiOperationMetadataSchema = {
-    type: 'object',
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiOperationEntityMetadata,
-    properties: {
-        method: {
-            type: 'string',
-            enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'MUTATION', 'QUERY', 'SUBSCRIBE', 'PUBLISH'],
-            description: 'HTTP method of the API operation',
-        },
-        path: {
-            type: 'string',
-            description: 'Path of the API operation',
-        },
-        payload: {
-            type: 'array',
-            items: {
-                type: 'string',
-                description: 'Related dataSchema name',
-            },
-        },
-        responses: {
-            type: 'array',
-            items: {
-                type: 'string',
-                description: 'Related dataSchema name',
-            },
-        },
-    },
-    required: ['method', 'path'],
-    additionalProperties: true,
-};
-exports.dataSchemaMetadataSchema = {
-    type: 'object',
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DataSchemaEntityMetadata,
-    properties: {
-        specType: {
-            type: 'string',
-            enum: ['jsonschema', 'openapi', 'asyncapi', 'avro', 'zod', 'graphql', 'protobuf', 'arazzo'],
-            description: 'Specification type of the data schema',
-        },
-        schema: {
-            type: 'string',
-            description: 'Inline schema of the data structure',
-        },
-        sdl: {
-            type: 'string',
-            description: 'SDL of the data structure',
-        },
-    },
-    required: ['specType'],
-    additionalProperties: true,
-};
-exports.defaultMetadataSchema = {
-    type: 'object',
-    properties: {},
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityMetadata,
-    additionalProperties: true,
-};
-exports.slackChannelFileSchema = {
-    type: 'object',
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntitySlackChannel,
-    properties: {
-        name: {
-            type: 'string',
-            minLength: 2,
-            maxLength: 150,
-        },
-        url: {
-            type: 'string',
-        },
-    },
-    required: ['name'],
-    additionalProperties: false,
-};
-exports.slackContactFileSchema = {
-    type: 'object',
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntitySlackContact,
-    properties: {
-        channels: {
-            type: 'array',
-            items: exports.slackChannelFileSchema,
-        },
-    },
-    required: ['channels'],
-    additionalProperties: false,
-};
-exports.entityContactFileSchema = {
-    type: 'object',
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityContact,
-    properties: {
-        slack: exports.slackContactFileSchema,
-    },
-    additionalProperties: false,
-};
-exports.entityLinkFileSchema = {
-    type: 'object',
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityLink,
-    properties: {
-        label: {
-            type: 'string',
-            minLength: 2,
-            maxLength: 150,
-        },
-        url: {
-            type: 'string',
-        },
-    },
-    required: ['label', 'url'],
-    additionalProperties: false,
-};
-exports.entityRelationFileSchema = {
-    type: 'object',
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityRelation,
-    properties: {
-        type: {
-            type: 'string',
-            enum: entities_1.ENTITY_RELATION_TYPES,
-        },
-        key: {
-            type: 'string',
-            minLength: 2,
-            maxLength: 100,
-        },
-        version: {
-            type: 'string',
-        },
-        revision: {
-            type: 'string',
-        },
-    },
-    required: ['type', 'key'],
-    additionalProperties: false,
-};
-// Base entity schema properties
-exports.entityBaseProperties = {
-    version: {
-        type: 'string',
-    },
-    key: {
-        type: 'string',
-        pattern: '^[a-z0-9]+(?:-[a-z0-9]+)*$',
-        minLength: 2,
-        maxLength: 150,
-    },
-    type: {
-        type: 'string',
-        enum: ['user', 'data-schema', 'api-operation', 'api-description', 'service', 'domain', 'team'],
-    },
-    title: {
-        type: 'string',
-        minLength: 2,
-        maxLength: 200,
-    },
-    summary: {
-        type: 'string',
-        minLength: 1,
-        maxLength: 500,
-    },
-    tags: {
-        type: 'array',
-        items: {
-            type: 'string',
-            minLength: 1,
-            maxLength: 50,
-        },
-    },
-    git: {
-        type: 'array',
-        items: {
-            type: 'string',
-        },
-    },
-    contact: exports.entityContactFileSchema,
-    links: {
-        type: 'array',
-        nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityLinkList,
-        items: exports.entityLinkFileSchema,
-    },
-    relations: {
-        type: 'array',
-        nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityRelationList,
-        items: exports.entityRelationFileSchema,
-    },
-    metadata: exports.defaultMetadataSchema,
-};
-exports.entityFileSchema = {
-    type: 'object',
-    discriminator: {
-        propertyName: 'type',
-    },
-    oneOf: [
-        {
-            type: 'object',
-            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'user' }, metadata: exports.userMetadataSchema }),
-            required: ['key', 'title', 'type', 'metadata'],
-            additionalProperties: false,
-            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.UserEntity,
-        },
-        {
-            type: 'object',
-            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiOperationEntity,
-            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-operation' }, metadata: exports.apiOperationMetadataSchema }),
-            required: ['key', 'title', 'type', 'metadata'],
-            additionalProperties: false,
-        },
-        {
-            type: 'object',
-            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DataSchemaEntity,
-            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'data-schema' }, metadata: exports.dataSchemaMetadataSchema }),
-            required: ['key', 'title', 'type', 'metadata'],
-            additionalProperties: false,
-        },
-        {
-            type: 'object',
-            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntity,
-            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-description' }, metadata: exports.apiDescriptionMetadataSchema }),
-            required: ['key', 'title', 'type', 'metadata'],
-            additionalProperties: false,
-        },
-        {
-            type: 'object',
-            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ServiceEntity,
-            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'service' } }),
-            required: ['key', 'title', 'type'],
-            additionalProperties: false,
-        },
-        {
-            type: 'object',
-            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DomainEntity,
-            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'domain' } }),
-            required: ['key', 'title', 'type'],
-            additionalProperties: false,
-        },
-        {
-            type: 'object',
-            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.TeamEntity,
-            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'team' } }),
-            required: ['key', 'title', 'type'],
-            additionalProperties: false,
-        },
-    ],
-};
-exports.entityFileDefaultSchema = {
-    type: 'object',
-    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.Entity,
-    properties: Object.assign({}, exports.entityBaseProperties),
-    required: ['key', 'title', 'type'],
-    additionalProperties: false,
-};
-//# sourceMappingURL=entities-catalog-entity-file-schema.js.map