@redocly/config 0.48.0 → 0.48.1

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

@@ -1,183 +0,0 @@
-export const entityCatalogExcludeSchema = {
-    type: 'object',
-    required: ['key'],
-    properties: {
-        key: { type: 'string' },
-    },
-    additionalProperties: false,
-};
-export const entityCatalogIncludeSchema = {
-    type: 'object',
-    required: ['type'],
-    properties: {
-        type: { type: 'string' },
-    },
-    additionalProperties: false,
-};
-export const 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,
-};
-export const entityCatalogSpecificCatalogSchema = {
-    type: 'object',
-    properties: {
-        slug: { type: 'string' },
-        hide: { type: 'boolean' },
-        includes: {
-            type: 'array',
-            items: entityCatalogIncludeSchema,
-        },
-        excludes: {
-            type: 'array',
-            items: entityCatalogExcludeSchema,
-        },
-        filters: {
-            type: 'array',
-            items: entityCatalogFilterSchema,
-        },
-        titleTranslationKey: { type: 'string' },
-        descriptionTranslationKey: { type: 'string' },
-        catalogSwitcherLabelTranslationKey: { type: 'string' },
-    },
-    additionalProperties: false,
-};
-export const 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,
-};
-export const entityCatalogMetadataSchema = {
-    type: 'object',
-    required: ['type', 'properties'],
-    properties: {
-        type: {
-            type: 'string',
-            enum: ['object'],
-        },
-        description: {
-            type: 'string',
-        },
-        properties: {
-            type: 'object',
-            additionalProperties: entityCatalogMetadataSchemaPropertySchema,
-        },
-        required: {
-            type: 'array',
-            items: { type: 'string' },
-        },
-        additionalProperties: {
-            type: 'boolean',
-        },
-    },
-    additionalProperties: true,
-};
-export const 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: entityCatalogMetadataSchema,
-        icon: {
-            type: 'object',
-            properties: {
-                src: {
-                    type: 'string',
-                },
-                srcSet: {
-                    type: 'string',
-                },
-            },
-            additionalProperties: false,
-        },
-    },
-    additionalProperties: false,
-};
-export const entityCatalogEntityTypesSchema = {
-    type: 'object',
-    additionalProperties: entityCatalogEntityTypeSchema,
-};
-export const entitiesCatalogConfigSchema = {
-    type: 'object',
-    properties: {
-        show: { type: 'boolean', default: false },
-        entityTypes: entityCatalogEntityTypesSchema,
-        catalogs: {
-            type: 'object',
-            properties: {
-                all: entityCatalogSpecificCatalogSchema,
-                services: entityCatalogSpecificCatalogSchema,
-                domains: entityCatalogSpecificCatalogSchema,
-                teams: entityCatalogSpecificCatalogSchema,
-                users: entityCatalogSpecificCatalogSchema,
-                apiDescriptions: entityCatalogSpecificCatalogSchema,
-                dataSchemas: entityCatalogSpecificCatalogSchema,
-                apiOperations: entityCatalogSpecificCatalogSchema,
-            },
-            additionalProperties: entityCatalogSpecificCatalogSchema,
-        },
-    },
-    additionalProperties: false,
-};
-//# sourceMappingURL=entities-catalog-config-schema.js.map

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

@@ -1,280 +0,0 @@
-import { ENTITY_RELATION_TYPES, ENTITY_NODE_TYPE_NAMES } from './constants/entities';
-export const userMetadataSchema = {
-    type: 'object',
-    nodeTypeName: ENTITY_NODE_TYPE_NAMES.UserEntityMetadata,
-    properties: {
-        email: {
-            type: 'string',
-            description: 'Email of the user',
-        },
-    },
-    required: ['email'],
-    additionalProperties: true,
-};
-export const apiDescriptionMetadataSchema = {
-    type: 'object',
-    nodeTypeName: 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,
-};
-export const apiOperationMetadataSchema = {
-    type: 'object',
-    nodeTypeName: 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,
-};
-export const dataSchemaMetadataSchema = {
-    type: 'object',
-    nodeTypeName: 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,
-};
-export const defaultMetadataSchema = {
-    type: 'object',
-    properties: {},
-    nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityMetadata,
-    additionalProperties: true,
-};
-export const slackChannelFileSchema = {
-    type: 'object',
-    nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntitySlackChannel,
-    properties: {
-        name: {
-            type: 'string',
-            minLength: 2,
-            maxLength: 150,
-        },
-        url: {
-            type: 'string',
-        },
-    },
-    required: ['name'],
-    additionalProperties: false,
-};
-export const slackContactFileSchema = {
-    type: 'object',
-    nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntitySlackContact,
-    properties: {
-        channels: {
-            type: 'array',
-            items: slackChannelFileSchema,
-        },
-    },
-    required: ['channels'],
-    additionalProperties: false,
-};
-export const entityContactFileSchema = {
-    type: 'object',
-    nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityContact,
-    properties: {
-        slack: slackContactFileSchema,
-    },
-    additionalProperties: false,
-};
-export const entityLinkFileSchema = {
-    type: 'object',
-    nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityLink,
-    properties: {
-        label: {
-            type: 'string',
-            minLength: 2,
-            maxLength: 150,
-        },
-        url: {
-            type: 'string',
-        },
-    },
-    required: ['label', 'url'],
-    additionalProperties: false,
-};
-export const entityRelationFileSchema = {
-    type: 'object',
-    nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityRelation,
-    properties: {
-        type: {
-            type: 'string',
-            enum: 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
-export const 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: entityContactFileSchema,
-    links: {
-        type: 'array',
-        nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityLinkList,
-        items: entityLinkFileSchema,
-    },
-    relations: {
-        type: 'array',
-        nodeTypeName: ENTITY_NODE_TYPE_NAMES.EntityRelationList,
-        items: entityRelationFileSchema,
-    },
-    metadata: defaultMetadataSchema,
-};
-export const entityFileSchema = {
-    type: 'object',
-    discriminator: {
-        propertyName: 'type',
-    },
-    oneOf: [
-        {
-            type: 'object',
-            properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'user' }, metadata: userMetadataSchema }),
-            required: ['key', 'title', 'type', 'metadata'],
-            additionalProperties: false,
-            nodeTypeName: ENTITY_NODE_TYPE_NAMES.UserEntity,
-        },
-        {
-            type: 'object',
-            nodeTypeName: ENTITY_NODE_TYPE_NAMES.ApiOperationEntity,
-            properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'api-operation' }, metadata: apiOperationMetadataSchema }),
-            required: ['key', 'title', 'type', 'metadata'],
-            additionalProperties: false,
-        },
-        {
-            type: 'object',
-            nodeTypeName: ENTITY_NODE_TYPE_NAMES.DataSchemaEntity,
-            properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'data-schema' }, metadata: dataSchemaMetadataSchema }),
-            required: ['key', 'title', 'type', 'metadata'],
-            additionalProperties: false,
-        },
-        {
-            type: 'object',
-            nodeTypeName: ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntity,
-            properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'api-description' }, metadata: apiDescriptionMetadataSchema }),
-            required: ['key', 'title', 'type', 'metadata'],
-            additionalProperties: false,
-        },
-        {
-            type: 'object',
-            nodeTypeName: ENTITY_NODE_TYPE_NAMES.ServiceEntity,
-            properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'service' } }),
-            required: ['key', 'title', 'type'],
-            additionalProperties: false,
-        },
-        {
-            type: 'object',
-            nodeTypeName: ENTITY_NODE_TYPE_NAMES.DomainEntity,
-            properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'domain' } }),
-            required: ['key', 'title', 'type'],
-            additionalProperties: false,
-        },
-        {
-            type: 'object',
-            nodeTypeName: ENTITY_NODE_TYPE_NAMES.TeamEntity,
-            properties: Object.assign(Object.assign({}, entityBaseProperties), { type: { const: 'team' } }),
-            required: ['key', 'title', 'type'],
-            additionalProperties: false,
-        },
-    ],
-};
-export const entityFileDefaultSchema = {
-    type: 'object',
-    nodeTypeName: ENTITY_NODE_TYPE_NAMES.Entity,
-    properties: Object.assign({}, entityBaseProperties),
-    required: ['key', 'title', 'type'],
-    additionalProperties: false,
-};
-//# sourceMappingURL=entities-catalog-entity-file-schema.js.map