@redocly/config 0.43.0 → 0.44.1

package/lib/common.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.decoratorsSchemas = exports.decoratorTypes = exports.decoratorsSchema = exports.preprocessorSchemas = exports.preprocessorTypes = exports.ruleSchemas = exports.ruleTypes = exports.rulesSchema = void 0;
-exports.rulesSchema = {
+exports.configGovernanceSchema = exports.decoratorTypes = exports.preprocessorTypes = exports.ruleTypes = void 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',
 };
 exports.ruleTypes = [
     'rules',
@@ -19,17 +22,17 @@ exports.ruleTypes = [
     'overlay1Rules',
     'openrpc1Rules',
 ];
-exports.ruleSchemas = {
-    rules: exports.rulesSchema,
-    oas2Rules: exports.rulesSchema,
-    oas3_0Rules: exports.rulesSchema,
-    oas3_1Rules: exports.rulesSchema,
-    oas3_2Rules: exports.rulesSchema,
-    async2Rules: exports.rulesSchema,
-    async3Rules: exports.rulesSchema,
-    arazzo1Rules: exports.rulesSchema,
-    overlay1Rules: exports.rulesSchema,
-    openrpc1Rules: exports.rulesSchema,
+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,
 };
 exports.preprocessorTypes = [
     'preprocessors',
@@ -43,23 +46,25 @@ exports.preprocessorTypes = [
     'overlay1Preprocessors',
     'openrpc1Preprocessors',
 ];
-const preprocessorSchema = {
+const preprocessorsSchema = {
+    nodeTypeName: undefined,
     type: 'object',
     additionalProperties: true,
 };
-exports.preprocessorSchemas = {
-    preprocessors: preprocessorSchema,
-    oas2Preprocessors: preprocessorSchema,
-    oas3_0Preprocessors: preprocessorSchema,
-    oas3_1Preprocessors: preprocessorSchema,
-    oas3_2Preprocessors: preprocessorSchema,
-    async2Preprocessors: preprocessorSchema,
-    async3Preprocessors: preprocessorSchema,
-    arazzo1Preprocessors: preprocessorSchema,
-    overlay1Preprocessors: preprocessorSchema,
-    openrpc1Preprocessors: preprocessorSchema,
+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,
 };
-exports.decoratorsSchema = {
+const decoratorsSchema = {
+    nodeTypeName: undefined,
     type: 'object',
     additionalProperties: true,
 };
@@ -75,16 +80,24 @@ exports.decoratorTypes = [
     'overlay1Decorators',
     'openrpc1Decorators',
 ];
-exports.decoratorsSchemas = {
-    decorators: exports.decoratorsSchema,
-    oas2Decorators: exports.decoratorsSchema,
-    oas3_0Decorators: exports.decoratorsSchema,
-    oas3_1Decorators: exports.decoratorsSchema,
-    oas3_2Decorators: exports.decoratorsSchema,
-    async2Decorators: exports.decoratorsSchema,
-    async3Decorators: exports.decoratorsSchema,
-    arazzo1Decorators: exports.decoratorsSchema,
-    overlay1Decorators: exports.decoratorsSchema,
-    openrpc1Decorators: exports.decoratorsSchema,
+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',
+};
+exports.configGovernanceSchema = Object.assign(Object.assign(Object.assign(Object.assign({}, ruleSchemas), decoratorSchemas), preprocessorSchemas), { extends: extendsSchema });
 //# sourceMappingURL=common.js.map

package/lib/constants/config.d.ts

@@ -0,0 +1,12 @@
+export declare const CONFIG_NODE_TYPE_NAMES: {
+    readonly RedirectSource: "RedirectSource";
+    readonly Redirects: "Redirects";
+    readonly ScorecardClassic: "ScorecardClassic";
+    readonly ScorecardClassicLevelList: "ScorecardClassicLevelList";
+    readonly ScorecardClassicLevel: "ScorecardClassicLevel";
+    readonly ScorecardClassicTargetList: "ScorecardClassicTargetList";
+    readonly ScorecardClassicTarget: "ScorecardClassicTarget";
+    readonly ScorecardClassicTargetWhere: "ScorecardClassicTargetWhere";
+    readonly ScorecardClassicTargetWhereMetadata: "ScorecardClassicTargetWhereMetadata";
+    readonly ScorecardClassicTeamMetadataProperty: "ScorecardClassicTeamMetadataProperty";
+};

package/lib/constants/config.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONFIG_NODE_TYPE_NAMES = void 0;
+const enum_1 = require("./enum");
+exports.CONFIG_NODE_TYPE_NAMES = (0, enum_1.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/constants/entities.d.ts

@@ -0,0 +1,45 @@
+export declare const ENTITY_RELATION_TYPES: readonly ["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 declare const ENTITY_NODE_TYPE_NAMES: {
+    readonly UserEntity: "UserEntity";
+    readonly UserEntityMetadata: "UserEntityMetadata";
+    readonly ApiDescriptionEntity: "ApiDescriptionEntity";
+    readonly ApiDescriptionEntityMetadata: "ApiDescriptionEntityMetadata";
+    readonly ApiOperationEntity: "ApiOperationEntity";
+    readonly ApiOperationEntityMetadata: "ApiOperationEntityMetadata";
+    readonly DataSchemaEntity: "DataSchemaEntity";
+    readonly DataSchemaEntityMetadata: "DataSchemaEntityMetadata";
+    readonly ServiceEntity: "ServiceEntity";
+    readonly DomainEntity: "DomainEntity";
+    readonly TeamEntity: "TeamEntity";
+    readonly Entity: "Entity";
+    readonly EntityMetadata: "EntityMetadata";
+    readonly EntityLinkList: "EntityLinkList";
+    readonly EntityLink: "EntityLink";
+    readonly EntityRelation: "EntityRelation";
+    readonly EntityRelationList: "EntityRelationList";
+    readonly EntityContact: "EntityContact";
+    readonly EntitySlackContact: "EntitySlackContact";
+    readonly EntitySlackChannel: "EntitySlackChannel";
+};
+export declare const NODE_TYPE_NAMES: {
+    readonly UserEntity: "UserEntity";
+    readonly UserEntityMetadata: "UserEntityMetadata";
+    readonly ApiDescriptionEntity: "ApiDescriptionEntity";
+    readonly ApiDescriptionEntityMetadata: "ApiDescriptionEntityMetadata";
+    readonly ApiOperationEntity: "ApiOperationEntity";
+    readonly ApiOperationEntityMetadata: "ApiOperationEntityMetadata";
+    readonly DataSchemaEntity: "DataSchemaEntity";
+    readonly DataSchemaEntityMetadata: "DataSchemaEntityMetadata";
+    readonly ServiceEntity: "ServiceEntity";
+    readonly DomainEntity: "DomainEntity";
+    readonly TeamEntity: "TeamEntity";
+    readonly Entity: "Entity";
+    readonly EntityMetadata: "EntityMetadata";
+    readonly EntityLinkList: "EntityLinkList";
+    readonly EntityLink: "EntityLink";
+    readonly EntityRelation: "EntityRelation";
+    readonly EntityRelationList: "EntityRelationList";
+    readonly EntityContact: "EntityContact";
+    readonly EntitySlackContact: "EntitySlackContact";
+    readonly EntitySlackChannel: "EntitySlackChannel";
+};

package/lib/constants/entities.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NODE_TYPE_NAMES = exports.ENTITY_NODE_TYPE_NAMES = exports.ENTITY_RELATION_TYPES = void 0;
+const enum_1 = require("./enum");
+exports.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',
+];
+exports.ENTITY_NODE_TYPE_NAMES = (0, enum_1.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)
+exports.NODE_TYPE_NAMES = exports.ENTITY_NODE_TYPE_NAMES;
+//# sourceMappingURL=entities.js.map

package/lib/constants/enum.d.ts

@@ -0,0 +1 @@
+export declare const createEnum: <T extends { [K in keyof T]: K; }>(obj: T) => T;

package/lib/constants/enum.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEnum = void 0;
+const createEnum = (obj) => obj;
+exports.createEnum = createEnum;
+//# sourceMappingURL=enum.js.map

package/lib/constants/shared.d.ts

@@ -0,0 +1,15 @@
+export declare const DEFAULT_TEAM_CLAIM_NAME = "https://redocly.com/sso/teams";
+export declare enum AuthProviderType {
+    OIDC = "OIDC",
+    SAML2 = "SAML2"
+}
+export declare enum ApigeeDevOnboardingIntegrationAuthType {
+    SERVICE_ACCOUNT = "SERVICE_ACCOUNT",
+    OAUTH2 = "OAUTH2"
+}
+export declare const REDOCLY_TEAMS_RBAC = "redocly::teams-rbac";
+export declare const REDOCLY_ROUTE_RBAC = "redocly::route-rbac";
+export declare enum LayoutVariant {
+    STACKED = "stacked",
+    THREE_PANEL = "three-panel"
+}

package/lib/constants/shared.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LayoutVariant = exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.ApigeeDevOnboardingIntegrationAuthType = exports.AuthProviderType = exports.DEFAULT_TEAM_CLAIM_NAME = void 0;
+exports.DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';
+var AuthProviderType;
+(function (AuthProviderType) {
+    AuthProviderType["OIDC"] = "OIDC";
+    AuthProviderType["SAML2"] = "SAML2";
+})(AuthProviderType || (exports.AuthProviderType = AuthProviderType = {}));
+var ApigeeDevOnboardingIntegrationAuthType;
+(function (ApigeeDevOnboardingIntegrationAuthType) {
+    ApigeeDevOnboardingIntegrationAuthType["SERVICE_ACCOUNT"] = "SERVICE_ACCOUNT";
+    ApigeeDevOnboardingIntegrationAuthType["OAUTH2"] = "OAUTH2";
+})(ApigeeDevOnboardingIntegrationAuthType || (exports.ApigeeDevOnboardingIntegrationAuthType = ApigeeDevOnboardingIntegrationAuthType = {}));
+exports.REDOCLY_TEAMS_RBAC = 'redocly::teams-rbac';
+exports.REDOCLY_ROUTE_RBAC = 'redocly::route-rbac';
+var LayoutVariant;
+(function (LayoutVariant) {
+    LayoutVariant["STACKED"] = "stacked";
+    LayoutVariant["THREE_PANEL"] = "three-panel";
+})(LayoutVariant || (exports.LayoutVariant = LayoutVariant = {}));
+//# sourceMappingURL=shared.js.map