@redocly/config 0.41.1 → 0.41.3

package/lib-esm/root-config-schema.d.ts

@@ -6085,6 +6085,106 @@ export declare const l10nConfigSchema: {
     readonly additionalProperties: false;
     readonly required: readonly ["defaultLocale"];
 };
+export declare const accessConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly requiresLogin: {
+            readonly type: "boolean";
+        };
+        readonly logoutReturnUrl: {
+            readonly type: "string";
+            readonly pattern: "^https?://.*";
+        };
+        readonly residency: {
+            readonly type: "string";
+            readonly pattern: "^https?://.*";
+        };
+        readonly sso: {
+            readonly oneOf: readonly [{
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                    readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+                };
+                readonly uniqueItems: true;
+            }, {
+                readonly type: "string";
+                readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+            }];
+        };
+        readonly rbac: {
+            readonly type: "object";
+            readonly properties: {
+                readonly teamNamePatterns: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly teamFolders: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly teamFoldersBaseRoles: {
+                    readonly type: "object";
+                    readonly additionalProperties: {
+                        readonly type: "string";
+                    };
+                };
+                readonly cms: {
+                    readonly type: "object";
+                    readonly additionalProperties: {
+                        readonly type: "string";
+                    };
+                };
+                readonly reunite: {
+                    readonly type: "object";
+                    readonly additionalProperties: {
+                        readonly type: "string";
+                    };
+                };
+                readonly features: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly aiSearch: {
+                            readonly type: "object";
+                            readonly additionalProperties: {
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+                readonly content: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly '**': {
+                            readonly type: "object";
+                            readonly additionalProperties: {
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                    readonly additionalProperties: {
+                        readonly type: "object";
+                        readonly additionalProperties: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+            };
+            readonly additionalProperties: {
+                readonly type: "object";
+                readonly additionalProperties: {
+                    readonly type: "string";
+                };
+            };
+        };
+    };
+    readonly additionalProperties: false;
+};
 export declare const redoclyConfigSchema: {
     readonly type: "object";
     readonly properties: {
@@ -6253,6 +6353,110 @@ export declare const redoclyConfigSchema: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
         };
+        readonly logoutReturnUrl: {
+            readonly type: "string";
+            readonly pattern: "^https?://.*";
+        };
+        readonly access: {
+            readonly type: "object";
+            readonly properties: {
+                readonly requiresLogin: {
+                    readonly type: "boolean";
+                };
+                readonly logoutReturnUrl: {
+                    readonly type: "string";
+                    readonly pattern: "^https?://.*";
+                };
+                readonly residency: {
+                    readonly type: "string";
+                    readonly pattern: "^https?://.*";
+                };
+                readonly sso: {
+                    readonly oneOf: readonly [{
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                            readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+                        };
+                        readonly uniqueItems: true;
+                    }, {
+                        readonly type: "string";
+                        readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+                    }];
+                };
+                readonly rbac: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly teamNamePatterns: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly teamFolders: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly teamFoldersBaseRoles: {
+                            readonly type: "object";
+                            readonly additionalProperties: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly cms: {
+                            readonly type: "object";
+                            readonly additionalProperties: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly reunite: {
+                            readonly type: "object";
+                            readonly additionalProperties: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly features: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly aiSearch: {
+                                    readonly type: "object";
+                                    readonly additionalProperties: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly content: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly '**': {
+                                    readonly type: "object";
+                                    readonly additionalProperties: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly additionalProperties: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly type: "string";
+                                };
+                            };
+                        };
+                    };
+                    readonly additionalProperties: {
+                        readonly type: "object";
+                        readonly additionalProperties: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+            };
+            readonly additionalProperties: false;
+        };
         readonly developerOnboarding: {
             readonly type: "object";
             readonly required: readonly ["adapters"];
@@ -12140,6 +12344,9 @@ export declare const redoclyConfigSchema: {
                             readonly name: {
                                 readonly type: "string";
                             };
+                            readonly key: {
+                                readonly type: "string";
+                            };
                             readonly description: {
                                 readonly type: "string";
                             };
@@ -12669,7 +12876,7 @@ export declare const redoclyConfigSchema: {
                                 }];
                             };
                         };
-                        readonly required: readonly ["name", "entities", "levels"];
+                        readonly required: readonly ["name", "key", "entities", "levels"];
                         readonly additionalProperties: false;
                     };
                 };
@@ -18669,6 +18876,9 @@ export declare const redoclyConfigSchema: {
                     readonly name: {
                         readonly type: "string";
                     };
+                    readonly key: {
+                        readonly type: "string";
+                    };
                     readonly description: {
                         readonly type: "string";
                     };
@@ -19198,7 +19408,7 @@ export declare const redoclyConfigSchema: {
                         }];
                     };
                 };
-                readonly required: readonly ["name", "entities", "levels"];
+                readonly required: readonly ["name", "key", "entities", "levels"];
                 readonly additionalProperties: false;
             };
         };
@@ -28872,6 +29082,9 @@ export declare const rootRedoclyConfigSchema: {
                                         description: {
                                             type: "string";
                                         };
+                                        key: {
+                                            type: "string";
+                                        };
                                         entities: {
                                             oneOf: ({
                                                 items: {
@@ -28967,7 +29180,7 @@ export declare const rootRedoclyConfigSchema: {
                                     };
                                     additionalProperties: false;
                                     type: "object";
-                                    required: ("name" | "entities" | "levels")[];
+                                    required: ("name" | "key" | "entities" | "levels")[];
                                 };
                                 type: "array";
                             };
@@ -31689,6 +31902,110 @@ export declare const rootRedoclyConfigSchema: {
                         type: "string";
                         pattern: "^https?://.*";
                     };
+                    logoutReturnUrl: {
+                        type: "string";
+                        pattern: "^https?://.*";
+                    };
+                    access: {
+                        properties: {
+                            sso: {
+                                oneOf: ({
+                                    items: {
+                                        enum: ("REDOCLY" | "CORPORATE" | "GUEST")[];
+                                        type: "string";
+                                    };
+                                    type: "array";
+                                    uniqueItems: true;
+                                } | {
+                                    enum: ("REDOCLY" | "CORPORATE" | "GUEST")[];
+                                    type: "string";
+                                })[];
+                            };
+                            residency: {
+                                type: "string";
+                                pattern: "^https?://.*";
+                            };
+                            logoutReturnUrl: {
+                                type: "string";
+                                pattern: "^https?://.*";
+                            };
+                            rbac: {
+                                properties: {
+                                    content: {
+                                        properties: {
+                                            "**": {
+                                                additionalProperties: {
+                                                    type: "string";
+                                                };
+                                                type: "object";
+                                            };
+                                        };
+                                        additionalProperties: {
+                                            additionalProperties: {
+                                                type: "string";
+                                            };
+                                            type: "object";
+                                        };
+                                        type: "object";
+                                    };
+                                    reunite: {
+                                        additionalProperties: {
+                                            type: "string";
+                                        };
+                                        type: "object";
+                                    };
+                                    teamNamePatterns: {
+                                        items: {
+                                            type: "string";
+                                        };
+                                        type: "array";
+                                    };
+                                    teamFolders: {
+                                        items: {
+                                            type: "string";
+                                        };
+                                        type: "array";
+                                    };
+                                    teamFoldersBaseRoles: {
+                                        additionalProperties: {
+                                            type: "string";
+                                        };
+                                        type: "object";
+                                    };
+                                    cms: {
+                                        additionalProperties: {
+                                            type: "string";
+                                        };
+                                        type: "object";
+                                    };
+                                    features: {
+                                        properties: {
+                                            aiSearch: {
+                                                additionalProperties: {
+                                                    type: "string";
+                                                };
+                                                type: "object";
+                                            };
+                                        };
+                                        additionalProperties: false;
+                                        type: "object";
+                                    };
+                                };
+                                additionalProperties: {
+                                    additionalProperties: {
+                                        type: "string";
+                                    };
+                                    type: "object";
+                                };
+                                type: "object";
+                            };
+                            requiresLogin: {
+                                type: "boolean";
+                            };
+                        };
+                        additionalProperties: false;
+                        type: "object";
+                    };
                     developerOnboarding: {
                         properties: {
                             adapters: {
@@ -34781,6 +35098,9 @@ export declare const rootRedoclyConfigSchema: {
                                 description: {
                                     type: "string";
                                 };
+                                key: {
+                                    type: "string";
+                                };
                                 entities: {
                                     oneOf: ({
                                         items: {
@@ -34941,7 +35261,7 @@ export declare const rootRedoclyConfigSchema: {
                             };
                             additionalProperties: false;
                             type: "object";
-                            required: ("name" | "entities" | "levels")[];
+                            required: ("name" | "key" | "entities" | "levels")[];
                         };
                         type: "array";
                     };
@@ -37764,6 +38084,110 @@ export declare const rootRedoclyConfigSchema: {
             readonly type: "string";
             readonly pattern: "^https?://.*";
         };
+        readonly logoutReturnUrl: {
+            readonly type: "string";
+            readonly pattern: "^https?://.*";
+        };
+        readonly access: {
+            readonly type: "object";
+            readonly properties: {
+                readonly requiresLogin: {
+                    readonly type: "boolean";
+                };
+                readonly logoutReturnUrl: {
+                    readonly type: "string";
+                    readonly pattern: "^https?://.*";
+                };
+                readonly residency: {
+                    readonly type: "string";
+                    readonly pattern: "^https?://.*";
+                };
+                readonly sso: {
+                    readonly oneOf: readonly [{
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                            readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+                        };
+                        readonly uniqueItems: true;
+                    }, {
+                        readonly type: "string";
+                        readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+                    }];
+                };
+                readonly rbac: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly teamNamePatterns: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly teamFolders: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly teamFoldersBaseRoles: {
+                            readonly type: "object";
+                            readonly additionalProperties: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly cms: {
+                            readonly type: "object";
+                            readonly additionalProperties: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly reunite: {
+                            readonly type: "object";
+                            readonly additionalProperties: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly features: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly aiSearch: {
+                                    readonly type: "object";
+                                    readonly additionalProperties: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly content: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly '**': {
+                                    readonly type: "object";
+                                    readonly additionalProperties: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly additionalProperties: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly type: "string";
+                                };
+                            };
+                        };
+                    };
+                    readonly additionalProperties: {
+                        readonly type: "object";
+                        readonly additionalProperties: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+            };
+            readonly additionalProperties: false;
+        };
         readonly developerOnboarding: {
             readonly type: "object";
             readonly required: readonly ["adapters"];
@@ -43651,6 +44075,9 @@ export declare const rootRedoclyConfigSchema: {
                             readonly name: {
                                 readonly type: "string";
                             };
+                            readonly key: {
+                                readonly type: "string";
+                            };
                             readonly description: {
                                 readonly type: "string";
                             };
@@ -44180,7 +44607,7 @@ export declare const rootRedoclyConfigSchema: {
                                 }];
                             };
                         };
-                        readonly required: readonly ["name", "entities", "levels"];
+                        readonly required: readonly ["name", "key", "entities", "levels"];
                         readonly additionalProperties: false;
                     };
                 };
@@ -50180,6 +50607,9 @@ export declare const rootRedoclyConfigSchema: {
                     readonly name: {
                         readonly type: "string";
                     };
+                    readonly key: {
+                        readonly type: "string";
+                    };
                     readonly description: {
                         readonly type: "string";
                     };
@@ -50709,7 +51139,7 @@ export declare const rootRedoclyConfigSchema: {
                         }];
                     };
                 };
-                readonly required: readonly ["name", "entities", "levels"];
+                readonly required: readonly ["name", "key", "entities", "levels"];
                 readonly additionalProperties: false;
             };
         };

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

@@ -83,6 +83,9 @@ export const ssoConfigSchema = {
         },
     ],
 };
+const requiresLoginSchema = { type: 'boolean' };
+const logoutReturnUrlSchema = { type: 'string', pattern: '^https?://.*' };
+const residencySchema = { type: 'string', pattern: '^https?://.*' };
 export const redirectConfigSchema = {
     type: 'object',
     properties: {
@@ -425,6 +428,17 @@ const mcpConfigSchema = {
         },
     },
 };
+export const accessConfigSchema = {
+    type: 'object',
+    properties: {
+        requiresLogin: requiresLoginSchema,
+        logoutReturnUrl: logoutReturnUrlSchema,
+        residency: residencySchema,
+        sso: ssoConfigSchema,
+        rbac: rbacConfigSchema,
+    },
+    additionalProperties: false,
+};
 export const redoclyConfigSchema = {
     type: 'object',
     properties: Object.assign(Object.assign(Object.assign(Object.assign({ 
@@ -434,7 +448,7 @@ export const redoclyConfigSchema = {
         imports: {
             type: 'array',
             items: { type: 'string' },
-        }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema, rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema, requiresLogin: { type: 'boolean' }, responseHeaders: {
+        }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema, rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema, requiresLogin: requiresLoginSchema, responseHeaders: {
             type: 'object',
             additionalProperties: {
                 type: 'array',
@@ -452,7 +466,7 @@ export const redoclyConfigSchema = {
         }, apis: {
             type: 'object',
             additionalProperties: apiConfigSchema,
-        }, extends: { type: 'array', items: { type: 'string' } } }, ruleSchemas), decoratorsSchemas), preprocessorSchemas), { ssoDirect: ssoDirectConfigSchema, sso: ssoConfigSchema, residency: { type: 'string', pattern: '^https?://.*' }, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
+        }, extends: { type: 'array', items: { type: 'string' } } }, ruleSchemas), decoratorsSchemas), preprocessorSchemas), { ssoDirect: ssoDirectConfigSchema, sso: ssoConfigSchema, residency: residencySchema, logoutReturnUrl: logoutReturnUrlSchema, access: accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
         /**
          * @deprecated properties moved to the root of the config
          */

package/lib-esm/scorecards-config-schema.d.ts

@@ -4,6 +4,9 @@ export declare const scorecardSchema: {
         readonly name: {
             readonly type: "string";
         };
+        readonly key: {
+            readonly type: "string";
+        };
         readonly description: {
             readonly type: "string";
         };
@@ -533,7 +536,7 @@ export declare const scorecardSchema: {
             }];
         };
     };
-    readonly required: readonly ["name", "entities", "levels"];
+    readonly required: readonly ["name", "key", "entities", "levels"];
     readonly additionalProperties: false;
 };
 export declare const scorecardsConfigSchema: {
@@ -544,6 +547,9 @@ export declare const scorecardsConfigSchema: {
             readonly name: {
                 readonly type: "string";
             };
+            readonly key: {
+                readonly type: "string";
+            };
             readonly description: {
                 readonly type: "string";
             };
@@ -1073,7 +1079,7 @@ export declare const scorecardsConfigSchema: {
                 }];
             };
         };
-        readonly required: readonly ["name", "entities", "levels"];
+        readonly required: readonly ["name", "key", "entities", "levels"];
         readonly additionalProperties: false;
     };
 };

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

@@ -205,6 +205,7 @@ export const scorecardSchema = {
     type: 'object',
     properties: {
         name: { type: 'string' },
+        key: { type: 'string' },
         description: { type: 'string' },
         entities: {
             oneOf: [
@@ -227,7 +228,7 @@ export const scorecardSchema = {
         },
         trigger: triggerSchema,
     },
-    required: ['name', 'entities', 'levels'],
+    required: ['name', 'key', 'entities', 'levels'],
     additionalProperties: false,
 };
 export const scorecardsConfigSchema = {

package/lib-esm/types/catalog-entity-types.d.ts

@@ -54,7 +54,7 @@ export type EntityLinkFileSchema = FromSchema<typeof entityLinkFileSchema>;
 export type EntityRelationFileSchema = FromSchema<typeof entityRelationFileSchema>;
 export type EntityBaseFileSchema = {
     version?: string | null;
-    revision?: string | null;
+    revision?: string;
     key: string;
     title: string;
     summary?: string | null;

package/lib-esm/types/portal-shared-types.d.ts

@@ -151,7 +151,8 @@ export type ResolvedSidebar = {
     items: ResolvedNavItem[];
     catalogEntity?: {
         key: string;
-        catalogConfig: CatalogEntityConfig;
+        version?: string;
+        catalogConfig?: CatalogEntityConfig;
     };
 };
 export type CompilationError = {