@redocly/config 0.47.0 → 0.48.1

package/lib/scorecards-config-schema.js

@@ -1,242 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.scorecardsConfigSchema = exports.scorecardSchema = void 0;
-const common_1 = require("./common");
-const comparisonOperatorSchema = {
-    type: 'string',
-    enum: [
-        'eq',
-        'in',
-        'gt',
-        'gte',
-        'lt',
-        'lte',
-        'contains',
-        'startsWith',
-        'endsWith',
-        'exists',
-        'isEmpty',
-        'between',
-        'matches',
-        'some',
-        'every',
-        'none',
-    ],
-};
-const logicalOperatorSchema = {
-    type: 'string',
-    enum: ['and', 'or'],
-};
-// Base condition schema with field, operator, value, modifier, and match properties
-const conditionSchema = {
-    type: 'object',
-    properties: {
-        field: { type: 'string' },
-        operator: comparisonOperatorSchema,
-        value: {
-            oneOf: [{ type: 'boolean' }, { type: 'string' }, { type: 'number' }],
-        },
-        modifier: { type: 'string', enum: ['not'] },
-        match: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    field: { type: 'string' },
-                    operator: comparisonOperatorSchema,
-                    value: {
-                        oneOf: [{ type: 'boolean' }, { type: 'string' }, { type: 'number' }],
-                    },
-                    modifier: { type: 'string', enum: ['not'] },
-                },
-            },
-        },
-    },
-};
-// Schema for a logical operator with conditions (used for nesting)
-const logicalOperatorConditionSchema = {
-    type: 'object',
-    properties: {
-        operator: logicalOperatorSchema,
-        conditions: {
-            type: 'array',
-            items: conditionSchema, // At the deepest level, only simple conditions
-        },
-    },
-    required: ['operator', 'conditions'],
-    additionalProperties: false,
-};
-// Conditions schema allowing nested conditions with up to 2 levels of recursion
-const conditionsSchema = {
-    type: 'array',
-    items: {
-        oneOf: [
-            conditionSchema,
-            {
-                type: 'object',
-                properties: {
-                    operator: logicalOperatorSchema,
-                    conditions: {
-                        type: 'array',
-                        items: {
-                            oneOf: [conditionSchema, logicalOperatorConditionSchema],
-                        },
-                    },
-                },
-                required: ['operator', 'conditions'],
-                additionalProperties: false,
-            },
-        ],
-    },
-};
-const entityRuleAssertionSchema = {
-    type: 'object',
-    properties: {
-        defined: { type: 'boolean' },
-        nonEmpty: { type: 'boolean' },
-        eq: {},
-        gt: { type: 'number' },
-        gte: { type: 'number' },
-        lt: { type: 'number' },
-        lte: { type: 'number' },
-        const: {},
-    },
-    additionalProperties: false,
-};
-const entityRuleWhereSchema = {
-    type: 'array',
-    items: {
-        type: 'object',
-        properties: {
-            subject: {
-                type: 'object',
-                properties: {
-                    type: {
-                        type: 'string',
-                        enum: ['Entity', 'EntityMetadata', 'EntityRelations', 'EntityRelation'],
-                    },
-                    property: { type: 'string' },
-                },
-                required: ['type', 'property'],
-                additionalProperties: false,
-            },
-            assertions: entityRuleAssertionSchema,
-        },
-        required: ['subject', 'assertions'],
-        additionalProperties: false,
-    },
-};
-const entityRuleSchema = {
-    type: 'object',
-    properties: {
-        title: { type: 'string' },
-        subject: {
-            type: 'object',
-            properties: {
-                type: {
-                    type: 'string',
-                    enum: ['Entity', 'EntityMetadata', 'EntityRelations', 'EntityRelation'],
-                },
-                property: { type: 'string' },
-            },
-            required: ['type', 'property'],
-            additionalProperties: false,
-        },
-        severity: {
-            type: 'string',
-            enum: ['error', 'warn', 'off'],
-        },
-        message: { type: 'string' },
-        assertions: entityRuleAssertionSchema,
-        where: entityRuleWhereSchema,
-        weight: { type: 'number', default: 1 },
-    },
-    required: ['subject', 'assertions'],
-    additionalProperties: false,
-};
-// Supports both OpenAPI/AsyncAPI rules (backward compatibility) and entity rules
-const levelRulesSchema = {
-    type: 'object',
-    additionalProperties: {
-        oneOf: [
-            { type: 'string' },
-            {
-                type: 'object',
-                properties: {
-                    severity: {
-                        type: 'string',
-                        enum: ['error', 'warn', 'off'],
-                    },
-                    weight: { type: 'number', default: 1 },
-                },
-                additionalProperties: true,
-            },
-            entityRuleSchema,
-        ],
-    },
-};
-const levelSchema = {
-    type: 'object',
-    properties: {
-        name: { type: 'string' },
-        extends: common_1.configGovernanceSchema.extends,
-        rules: levelRulesSchema,
-    },
-    required: ['name'],
-    additionalProperties: false,
-};
-const triggerEventSchema = {
-    type: 'object',
-    properties: {
-        event: {
-            type: 'string',
-            enum: ['runtime', 'manual'],
-        },
-    },
-    required: ['event'],
-    additionalProperties: false,
-};
-const triggerSchema = {
-    oneOf: [
-        triggerEventSchema,
-        {
-            type: 'array',
-            items: triggerEventSchema,
-        },
-    ],
-};
-exports.scorecardSchema = {
-    type: 'object',
-    properties: {
-        name: { type: 'string' },
-        key: { type: 'string' },
-        description: { type: 'string' },
-        entities: {
-            oneOf: [
-                conditionsSchema,
-                {
-                    type: 'object',
-                    properties: {
-                        operator: logicalOperatorSchema,
-                        conditions: conditionsSchema,
-                    },
-                    required: ['operator', 'conditions'],
-                    additionalProperties: false,
-                },
-            ],
-        },
-        levels: {
-            type: 'array',
-            items: levelSchema,
-            minItems: 1,
-        },
-        trigger: triggerSchema,
-    },
-    required: ['name', 'key', 'entities', 'levels'],
-    additionalProperties: false,
-};
-exports.scorecardsConfigSchema = {
-    type: 'array',
-    items: exports.scorecardSchema,
-};
-//# sourceMappingURL=scorecards-config-schema.js.map

package/lib/types/api-functions-types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=api-functions-types.js.map

package/lib/types/asyncapi-types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=asyncapi-types.js.map

package/lib/types/catalog-entity-types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=catalog-entity-types.js.map

package/lib/types/code-walkthrough-types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=code-walkthrough-types.js.map

package/lib/types/config-types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=config-types.js.map

package/lib/types/graphql-types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=graphql-types.js.map

package/lib/types/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./api-functions-types"), exports);
-__exportStar(require("./config-types"), exports);
-__exportStar(require("./portal-shared-types"), exports);
-__exportStar(require("./catalog-entity-types"), exports);
-//# sourceMappingURL=index.js.map

package/lib/types/portal-shared-types.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./code-walkthrough-types"), exports);
-//# sourceMappingURL=portal-shared-types.js.map

package/lib/types/redoc-types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=redoc-types.js.map

package/lib-esm/asyncapi-config-schema.js

@@ -1,50 +0,0 @@
-import { feedbackConfigSchema } from './feedback-config-schema';
-import { downloadUrlsSchema } from './redoc-config-schema';
-export const asyncapiConfigSchema = {
-    type: 'object',
-    properties: {
-        downloadUrls: downloadUrlsSchema,
-        apiLogo: {
-            type: 'object',
-            properties: {
-                imageUrl: {
-                    type: 'string',
-                },
-                href: {
-                    type: 'string',
-                },
-                altText: {
-                    type: 'string',
-                },
-                backgroundColor: {
-                    type: 'string',
-                },
-            },
-        },
-        jsonSamplesDepth: {
-            type: 'number',
-        },
-        samplesMaxInlineArgs: {
-            type: 'number',
-        },
-        fieldExpandLevel: {
-            type: 'number',
-        },
-        baseUrlPath: {
-            type: 'string',
-        },
-        metadata: {
-            type: 'object',
-            properties: {
-                apiId: {
-                    type: 'string',
-                },
-            },
-            additionalProperties: true,
-        },
-        feedback: feedbackConfigSchema,
-        layout: { type: 'string', enum: ['stacked', 'three-panel'] },
-    },
-    additionalProperties: false,
-};
-//# sourceMappingURL=asyncapi-config-schema.js.map

package/lib-esm/common.js

@@ -1,100 +0,0 @@
-const rulesSchema = {
-    nodeTypeName: undefined,
-    type: 'object',
-    additionalProperties: {
-        oneOf: [{ type: 'string' }, { type: 'object' }],
-    },
-    description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.',
-    documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules',
-};
-export const ruleTypes = [
-    'rules',
-    'oas2Rules',
-    'oas3_0Rules',
-    'oas3_1Rules',
-    'oas3_2Rules',
-    'async2Rules',
-    'async3Rules',
-    'arazzo1Rules',
-    'overlay1Rules',
-    'openrpc1Rules',
-];
-const ruleSchemas = {
-    rules: rulesSchema,
-    oas2Rules: rulesSchema,
-    oas3_0Rules: rulesSchema,
-    oas3_1Rules: rulesSchema,
-    oas3_2Rules: rulesSchema,
-    async2Rules: rulesSchema,
-    async3Rules: rulesSchema,
-    arazzo1Rules: rulesSchema,
-    overlay1Rules: rulesSchema,
-    openrpc1Rules: rulesSchema,
-};
-export const preprocessorTypes = [
-    'preprocessors',
-    'oas2Preprocessors',
-    'oas3_0Preprocessors',
-    'oas3_1Preprocessors',
-    'oas3_2Preprocessors',
-    'async2Preprocessors',
-    'async3Preprocessors',
-    'arazzo1Preprocessors',
-    'overlay1Preprocessors',
-    'openrpc1Preprocessors',
-];
-const preprocessorsSchema = {
-    nodeTypeName: undefined,
-    type: 'object',
-    additionalProperties: true,
-};
-const preprocessorSchemas = {
-    preprocessors: preprocessorsSchema,
-    oas2Preprocessors: preprocessorsSchema,
-    oas3_0Preprocessors: preprocessorsSchema,
-    oas3_1Preprocessors: preprocessorsSchema,
-    oas3_2Preprocessors: preprocessorsSchema,
-    async2Preprocessors: preprocessorsSchema,
-    async3Preprocessors: preprocessorsSchema,
-    arazzo1Preprocessors: preprocessorsSchema,
-    overlay1Preprocessors: preprocessorsSchema,
-    openrpc1Preprocessors: preprocessorsSchema,
-};
-const decoratorsSchema = {
-    nodeTypeName: undefined,
-    type: 'object',
-    additionalProperties: true,
-};
-export const decoratorTypes = [
-    'decorators',
-    'oas2Decorators',
-    'oas3_0Decorators',
-    'oas3_1Decorators',
-    'oas3_2Decorators',
-    'async2Decorators',
-    'async3Decorators',
-    'arazzo1Decorators',
-    'overlay1Decorators',
-    'openrpc1Decorators',
-];
-const decoratorSchemas = {
-    decorators: decoratorsSchema,
-    oas2Decorators: decoratorsSchema,
-    oas3_0Decorators: decoratorsSchema,
-    oas3_1Decorators: decoratorsSchema,
-    oas3_2Decorators: decoratorsSchema,
-    async2Decorators: decoratorsSchema,
-    async3Decorators: decoratorsSchema,
-    arazzo1Decorators: decoratorsSchema,
-    overlay1Decorators: decoratorsSchema,
-    openrpc1Decorators: decoratorsSchema,
-};
-const extendsSchema = {
-    nodeTypeName: undefined,
-    type: 'array',
-    items: { type: 'string' },
-    description: 'Use extends to inherit rules and their configurations from other rulesets.',
-    documentationLink: 'https://redocly.com/docs/cli/configuration/reference/extends',
-};
-export const configGovernanceSchema = Object.assign(Object.assign(Object.assign(Object.assign({}, ruleSchemas), decoratorSchemas), preprocessorSchemas), { extends: extendsSchema });
-//# sourceMappingURL=common.js.map

package/lib-esm/constants/config.js

@@ -1,14 +0,0 @@
-import { createEnum } from './enum';
-export const CONFIG_NODE_TYPE_NAMES = createEnum({
-    RedirectSource: 'RedirectSource',
-    Redirects: 'Redirects',
-    ScorecardClassic: 'ScorecardClassic',
-    ScorecardClassicLevelList: 'ScorecardClassicLevelList',
-    ScorecardClassicLevel: 'ScorecardClassicLevel',
-    ScorecardClassicTargetList: 'ScorecardClassicTargetList',
-    ScorecardClassicTarget: 'ScorecardClassicTarget',
-    ScorecardClassicTargetWhere: 'ScorecardClassicTargetWhere',
-    ScorecardClassicTargetWhereMetadata: 'ScorecardClassicTargetWhereMetadata',
-    ScorecardClassicTeamMetadataProperty: 'ScorecardClassicTeamMetadataProperty',
-});
-//# sourceMappingURL=config.js.map

package/lib-esm/constants/entities.js

@@ -1,55 +0,0 @@
-import { createEnum } from './enum';
-export const ENTITY_RELATION_TYPES = [
-    'partOf',
-    'hasParts',
-    'creates',
-    'createdBy',
-    'owns',
-    'ownedBy',
-    'implements',
-    'implementedBy',
-    'dependsOn',
-    'dependencyOf',
-    'uses',
-    'usedBy',
-    'produces',
-    'consumes',
-    'linksTo',
-    'supersedes',
-    'supersededBy',
-    'compatibleWith',
-    'extends',
-    'extendedBy',
-    'relatesTo',
-    'hasMember',
-    'memberOf',
-    'triggers',
-    'triggeredBy',
-    'returns',
-    'returnedBy',
-];
-export const ENTITY_NODE_TYPE_NAMES = createEnum({
-    UserEntity: 'UserEntity',
-    UserEntityMetadata: 'UserEntityMetadata',
-    ApiDescriptionEntity: 'ApiDescriptionEntity',
-    ApiDescriptionEntityMetadata: 'ApiDescriptionEntityMetadata',
-    ApiOperationEntity: 'ApiOperationEntity',
-    ApiOperationEntityMetadata: 'ApiOperationEntityMetadata',
-    DataSchemaEntity: 'DataSchemaEntity',
-    DataSchemaEntityMetadata: 'DataSchemaEntityMetadata',
-    ServiceEntity: 'ServiceEntity',
-    DomainEntity: 'DomainEntity',
-    TeamEntity: 'TeamEntity',
-    Entity: 'Entity',
-    EntityMetadata: 'EntityMetadata',
-    EntityLinkList: 'EntityLinkList',
-    EntityLink: 'EntityLink',
-    EntityRelation: 'EntityRelation',
-    EntityRelationList: 'EntityRelationList',
-    EntityContact: 'EntityContact',
-    EntitySlackContact: 'EntitySlackContact',
-    EntitySlackChannel: 'EntitySlackChannel',
-});
-// FIXME: remove this once the config is updated in openapi-core and it's updated in the monorepo (https://github.com/Redocly/redocly-cli/pull/2604)
-export const NODE_TYPE_NAMES = ENTITY_NODE_TYPE_NAMES;
-//# sourceMappingURL=entities.js.map

package/lib-esm/constants/enum.js

@@ -1,2 +0,0 @@
-export const createEnum = (obj) => obj;
-//# sourceMappingURL=enum.js.map

package/lib-esm/constants/shared.js

@@ -1,19 +0,0 @@
-export const DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';
-export var AuthProviderType;
-(function (AuthProviderType) {
-    AuthProviderType["OIDC"] = "OIDC";
-    AuthProviderType["SAML2"] = "SAML2";
-})(AuthProviderType || (AuthProviderType = {}));
-export var ApigeeDevOnboardingIntegrationAuthType;
-(function (ApigeeDevOnboardingIntegrationAuthType) {
-    ApigeeDevOnboardingIntegrationAuthType["SERVICE_ACCOUNT"] = "SERVICE_ACCOUNT";
-    ApigeeDevOnboardingIntegrationAuthType["OAUTH2"] = "OAUTH2";
-})(ApigeeDevOnboardingIntegrationAuthType || (ApigeeDevOnboardingIntegrationAuthType = {}));
-export const REDOCLY_TEAMS_RBAC = 'redocly::teams-rbac';
-export const REDOCLY_ROUTE_RBAC = 'redocly::route-rbac';
-export var LayoutVariant;
-(function (LayoutVariant) {
-    LayoutVariant["STACKED"] = "stacked";
-    LayoutVariant["THREE_PANEL"] = "three-panel";
-})(LayoutVariant || (LayoutVariant = {}));
-//# sourceMappingURL=shared.js.map

package/lib-esm/default-theme-config-schema.js

@@ -1,54 +0,0 @@
-import { graphqlConfigSchema } from './graphql-config-schema';
-import { asyncapiConfigSchema } from './asyncapi-config-schema';
-import { feedbackConfigSchema } from './feedback-config-schema';
-import { logoConfigSchema, analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, paletteConfigSchema, footerConfigSchema, linksConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
-import { entitiesCatalogConfigSchema } from './entities-catalog-config-schema';
-import { scorecardsConfigSchema } from './scorecards-config-schema';
-export const themeConfigSchema = {
-    type: 'object',
-    properties: {
-        /**
-         * @deprecated Should use `plugins` instead
-         */
-        imports: {
-            type: 'array',
-            items: { type: 'string' },
-        },
-        logo: logoConfigSchema,
-        navbar: navbarConfigSchema,
-        products: productsConfigSchema,
-        footer: footerConfigSchema,
-        sidebar: sidebarConfigSchema,
-        scripts: scriptsConfigSchema,
-        links: linksConfigSchema,
-        feedback: feedbackConfigSchema,
-        search: searchConfigSchema,
-        aiAssistant: aiAssistantSchema,
-        colorMode: colorModeConfigSchema,
-        palette: paletteConfigSchema,
-        navigation: navigationConfigSchema,
-        codeSnippet: codeSnippetConfigSchema,
-        markdown: markdownConfigSchema,
-        openapi: openapiConfigSchema,
-        asyncapi: asyncapiConfigSchema,
-        graphql: graphqlConfigSchema,
-        analytics: analyticsConfigSchema,
-        userMenu: userMenuConfigSchema,
-        versionPicker: versionPickerConfigSchema,
-        breadcrumbs: breadcrumbsConfigSchema,
-        /**
-         * @deprecated Should use `catalogClassic` instead
-         */
-        catalog: catalogsConfigSchema,
-        entitiesCatalog: entitiesCatalogConfigSchema,
-        catalogClassic: catalogsConfigSchema,
-        /**
-         * @deprecated Should use `scorecardClassic` instead
-         */
-        scorecard: scorecardConfigSchema,
-        scorecardClassic: scorecardConfigSchema,
-        scorecards: scorecardsConfigSchema,
-    },
-    additionalProperties: true,
-};
-//# sourceMappingURL=default-theme-config-schema.js.map