@redocly/config 0.49.0 → 0.50.0

package/lib-esm/common.d.ts

@@ -1,247 +1,270 @@
-export declare const ruleTypes: readonly ["rules", "oas2Rules", "oas3_0Rules", "oas3_1Rules", "oas3_2Rules", "async2Rules", "async3Rules", "arazzo1Rules", "overlay1Rules", "openrpc1Rules"];
+export declare const ruleTypes: readonly ['rules', 'oas2Rules', 'oas3_0Rules', 'oas3_1Rules', 'oas3_2Rules', 'async2Rules', 'async3Rules', 'arazzo1Rules', 'arazzo1_1Rules', 'overlay1Rules', 'openrpc1Rules'];
 export type RuleTypes = (typeof ruleTypes)[number];
-export declare const preprocessorTypes: readonly ["preprocessors", "oas2Preprocessors", "oas3_0Preprocessors", "oas3_1Preprocessors", "oas3_2Preprocessors", "async2Preprocessors", "async3Preprocessors", "arazzo1Preprocessors", "overlay1Preprocessors", "openrpc1Preprocessors"];
+export declare const preprocessorTypes: readonly ['preprocessors', 'oas2Preprocessors', 'oas3_0Preprocessors', 'oas3_1Preprocessors', 'oas3_2Preprocessors', 'async2Preprocessors', 'async3Preprocessors', 'arazzo1Preprocessors', 'arazzo1_1Preprocessors', 'overlay1Preprocessors', 'openrpc1Preprocessors'];
 export type PreprocessorTypes = (typeof preprocessorTypes)[number];
-export declare const decoratorTypes: readonly ["decorators", "oas2Decorators", "oas3_0Decorators", "oas3_1Decorators", "oas3_2Decorators", "async2Decorators", "async3Decorators", "arazzo1Decorators", "overlay1Decorators", "openrpc1Decorators"];
+export declare const decoratorTypes: readonly ['decorators', 'oas2Decorators', 'oas3_0Decorators', 'oas3_1Decorators', 'oas3_2Decorators', 'async2Decorators', 'async3Decorators', 'arazzo1Decorators', 'arazzo1_1Decorators', 'overlay1Decorators', 'openrpc1Decorators'];
 export type DecoratorTypes = (typeof decoratorTypes)[number];
 export declare const configGovernanceSchema: {
     extends: {
         readonly nodeTypeName: undefined;
-        readonly type: "array";
+        readonly type: 'array';
         readonly items: {
-            readonly type: "string";
+            readonly type: 'string';
         };
-        readonly description: "Use extends to inherit rules and their configurations from other rulesets.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/extends";
+        readonly description: 'Use extends to inherit rules and their configurations from other rulesets.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/extends';
     };
-    preprocessors: {
-        readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: true;
-    };
-    oas2Preprocessors: {
-        readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: true;
-    };
-    oas3_0Preprocessors: {
+    arazzo1Decorators: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas3_1Preprocessors: {
+    arazzo1Preprocessors: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas3_2Preprocessors: {
+    arazzo1Rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: true;
+        readonly type: 'object';
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    async2Preprocessors: {
+    arazzo1_1Decorators: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    async3Preprocessors: {
+    arazzo1_1Preprocessors: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    arazzo1Preprocessors: {
+    arazzo1_1Rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: true;
+        readonly type: 'object';
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    overlay1Preprocessors: {
+    async2Decorators: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    openrpc1Preprocessors: {
+    async2Preprocessors: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    decorators: {
+    async2Rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: true;
+        readonly type: 'object';
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    oas2Decorators: {
+    async3Decorators: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas3_0Decorators: {
+    async3Preprocessors: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas3_1Decorators: {
+    async3Rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: true;
+        readonly type: 'object';
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    oas3_2Decorators: {
+    decorators: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    async2Decorators: {
+    oas2Decorators: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    async3Decorators: {
+    oas2Preprocessors: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    arazzo1Decorators: {
+    oas2Rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: true;
+        readonly type: 'object';
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    overlay1Decorators: {
+    oas3_0Decorators: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    openrpc1Decorators: {
+    oas3_0Preprocessors: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: true;
     };
-    rules: {
+    oas3_0Rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: {
             readonly oneOf: readonly [{
-                readonly type: "string";
+                readonly type: 'string';
             }, {
-                readonly type: "object";
+                readonly type: 'object';
             }];
         };
-        readonly 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.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    oas2Rules: {
+    oas3_1Decorators: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: "string";
-            }, {
-                readonly type: "object";
-            }];
-        };
-        readonly 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.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
+        readonly type: 'object';
+        readonly additionalProperties: true;
     };
-    oas3_0Rules: {
+    oas3_1Preprocessors: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: "string";
-            }, {
-                readonly type: "object";
-            }];
-        };
-        readonly 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.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
+        readonly type: 'object';
+        readonly additionalProperties: true;
     };
     oas3_1Rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: {
             readonly oneOf: readonly [{
-                readonly type: "string";
+                readonly type: 'string';
             }, {
-                readonly type: "object";
+                readonly type: 'object';
             }];
         };
-        readonly 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.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
+    };
+    oas3_2Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: 'object';
+        readonly additionalProperties: true;
+    };
+    oas3_2Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: 'object';
+        readonly additionalProperties: true;
     };
     oas3_2Rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: {
             readonly oneOf: readonly [{
-                readonly type: "string";
+                readonly type: 'string';
             }, {
-                readonly type: "object";
+                readonly type: 'object';
             }];
         };
-        readonly 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.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    async2Rules: {
+    openrpc1Decorators: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: "string";
-            }, {
-                readonly type: "object";
-            }];
-        };
-        readonly 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.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
+        readonly type: 'object';
+        readonly additionalProperties: true;
     };
-    async3Rules: {
+    openrpc1Preprocessors: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: "string";
-            }, {
-                readonly type: "object";
-            }];
-        };
-        readonly 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.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
+        readonly type: 'object';
+        readonly additionalProperties: true;
     };
-    arazzo1Rules: {
+    openrpc1Rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: {
             readonly oneOf: readonly [{
-                readonly type: "string";
+                readonly type: 'string';
             }, {
-                readonly type: "object";
+                readonly type: 'object';
             }];
         };
-        readonly 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.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
+    };
+    overlay1Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: 'object';
+        readonly additionalProperties: true;
+    };
+    overlay1Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: 'object';
+        readonly additionalProperties: true;
     };
     overlay1Rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: {
             readonly oneOf: readonly [{
-                readonly type: "string";
+                readonly type: 'string';
             }, {
-                readonly type: "object";
+                readonly type: 'object';
             }];
         };
-        readonly 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.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    openrpc1Rules: {
+    preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: 'object';
+        readonly additionalProperties: true;
+    };
+    rules: {
         readonly nodeTypeName: undefined;
-        readonly type: "object";
+        readonly type: 'object';
         readonly additionalProperties: {
             readonly oneOf: readonly [{
-                readonly type: "string";
+                readonly type: 'string';
             }, {
-                readonly type: "object";
+                readonly type: 'object';
             }];
         };
-        readonly 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.";
-        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/rules#rules";
+        readonly 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.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
 };

package/lib-esm/constants/config.d.ts

@@ -1,12 +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";
+    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-esm/constants/entities.d.ts

@@ -1,45 +1,23 @@
-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_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";
+    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-esm/constants/identity-provider-slug.d.ts

@@ -0,0 +1,8 @@
+export declare const IDENTITY_PROVIDER_SLUG_PATTERN = "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+export declare const IDENTITY_PROVIDER_SLUG_REGEX: RegExp;
+export declare const IDENTITY_PROVIDER_SLUG_MESSAGE = "Unique ID must be lowercase letters, numbers, and hyphens only";
+export declare const IDENTITY_PROVIDER_SLUG_MAX_LENGTH = 63;
+export declare const IDENTITY_PROVIDER_SLUG_MAX_LENGTH_MESSAGE = "Unique ID cannot exceed 63 characters";
+export declare const IDENTITY_PROVIDER_RESERVED_SLUGS: readonly ['redocly', 'corporate', 'guest'];
+export declare const IDENTITY_PROVIDER_RESERVED_MESSAGE: string;
+export declare const SSO_LOGIN_TYPES: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];