@redocly/config 0.51.0 → 0.53.0

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

@@ -463,7 +463,7 @@ export declare const idpsConfigSchema: {
             readonly type: 'string';
             readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
             readonly not: {
-                readonly enum: readonly ["redocly", "corporate", "guest"];
+                readonly enum: ("corporate" | "guest")[];
             };
         };
         readonly uniqueItems: true;
@@ -471,7 +471,7 @@ export declare const idpsConfigSchema: {
         readonly type: 'string';
         readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
         readonly not: {
-            readonly enum: readonly ["redocly", "corporate", "guest"];
+            readonly enum: ("corporate" | "guest")[];
         };
     }];
 };
@@ -5786,6 +5786,12 @@ export declare const rbacConfigSchema: {
                         readonly type: 'string';
                     };
                 };
+                readonly mcp: {
+                    readonly type: 'object';
+                    readonly additionalProperties: {
+                        readonly type: 'string';
+                    };
+                };
             };
             readonly additionalProperties: false;
         };
@@ -6428,6 +6434,21 @@ export declare const l10nConfigSchema: {
     readonly additionalProperties: false;
     readonly required: readonly ["defaultLocale"];
 };
+export declare const skillsConfigSchema: {
+    readonly type: 'object';
+    readonly properties: {
+        readonly hide: {
+            readonly type: 'boolean';
+        };
+        readonly excludeFiles: {
+            readonly type: 'array';
+            readonly items: {
+                readonly type: 'string';
+            };
+        };
+    };
+    readonly additionalProperties: false;
+};
 export declare const accessConfigSchema: {
     readonly type: 'object';
     readonly properties: {
@@ -6462,7 +6483,7 @@ export declare const accessConfigSchema: {
                     readonly type: 'string';
                     readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                     readonly not: {
-                        readonly enum: readonly ["redocly", "corporate", "guest"];
+                        readonly enum: ("corporate" | "guest")[];
                     };
                 };
                 readonly uniqueItems: true;
@@ -6470,7 +6491,7 @@ export declare const accessConfigSchema: {
                 readonly type: 'string';
                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                 readonly not: {
-                    readonly enum: readonly ["redocly", "corporate", "guest"];
+                    readonly enum: ("corporate" | "guest")[];
                 };
             }];
         };
@@ -6516,6 +6537,12 @@ export declare const accessConfigSchema: {
                                 readonly type: 'string';
                             };
                         };
+                        readonly mcp: {
+                            readonly type: 'object';
+                            readonly additionalProperties: {
+                                readonly type: 'string';
+                            };
+                        };
                     };
                     readonly additionalProperties: false;
                 };
@@ -7177,6 +7204,12 @@ export declare const redoclyConfigSchema: {
                                 readonly type: 'string';
                             };
                         };
+                        readonly mcp: {
+                            readonly type: 'object';
+                            readonly additionalProperties: {
+                                readonly type: 'string';
+                            };
+                        };
                     };
                     readonly additionalProperties: false;
                 };
@@ -12457,7 +12490,7 @@ export declare const redoclyConfigSchema: {
                     readonly type: 'string';
                     readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                     readonly not: {
-                        readonly enum: readonly ["redocly", "corporate", "guest"];
+                        readonly enum: ("corporate" | "guest")[];
                     };
                 };
                 readonly uniqueItems: true;
@@ -12465,7 +12498,7 @@ export declare const redoclyConfigSchema: {
                 readonly type: 'string';
                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                 readonly not: {
-                    readonly enum: readonly ["redocly", "corporate", "guest"];
+                    readonly enum: ("corporate" | "guest")[];
                 };
             }];
         };
@@ -12517,7 +12550,7 @@ export declare const redoclyConfigSchema: {
                             readonly type: 'string';
                             readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                             readonly not: {
-                                readonly enum: readonly ["redocly", "corporate", "guest"];
+                                readonly enum: ("corporate" | "guest")[];
                             };
                         };
                         readonly uniqueItems: true;
@@ -12525,7 +12558,7 @@ export declare const redoclyConfigSchema: {
                         readonly type: 'string';
                         readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                         readonly not: {
-                            readonly enum: readonly ["redocly", "corporate", "guest"];
+                            readonly enum: ("corporate" | "guest")[];
                         };
                     }];
                 };
@@ -12571,6 +12604,12 @@ export declare const redoclyConfigSchema: {
                                         readonly type: 'string';
                                     };
                                 };
+                                readonly mcp: {
+                                    readonly type: 'object';
+                                    readonly additionalProperties: {
+                                        readonly type: 'string';
+                                    };
+                                };
                             };
                             readonly additionalProperties: false;
                         };
@@ -26662,20 +26701,20 @@ export declare const redoclyConfigSchema: {
                     };
                     readonly additionalProperties: false;
                 };
-                readonly gateway: {
-                    readonly type: 'object';
-                    readonly properties: {
-                        readonly hide: {
-                            readonly type: 'boolean';
-                        };
-                        readonly allowedHosts: {
-                            readonly type: 'array';
-                            readonly items: {
-                                readonly type: 'string';
-                            };
-                        };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly skills: {
+            readonly type: 'object';
+            readonly properties: {
+                readonly hide: {
+                    readonly type: 'boolean';
+                };
+                readonly excludeFiles: {
+                    readonly type: 'array';
+                    readonly items: {
+                        readonly type: 'string';
                     };
-                    readonly additionalProperties: false;
                 };
             };
             readonly additionalProperties: false;
@@ -27212,6 +27251,12 @@ export declare const rootRedoclyConfigSchema: {
                                 readonly type: 'string';
                             };
                         };
+                        readonly mcp: {
+                            readonly type: 'object';
+                            readonly additionalProperties: {
+                                readonly type: 'string';
+                            };
+                        };
                     };
                     readonly additionalProperties: false;
                 };
@@ -32492,7 +32537,7 @@ export declare const rootRedoclyConfigSchema: {
                     readonly type: 'string';
                     readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                     readonly not: {
-                        readonly enum: readonly ["redocly", "corporate", "guest"];
+                        readonly enum: ("corporate" | "guest")[];
                     };
                 };
                 readonly uniqueItems: true;
@@ -32500,7 +32545,7 @@ export declare const rootRedoclyConfigSchema: {
                 readonly type: 'string';
                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                 readonly not: {
-                    readonly enum: readonly ["redocly", "corporate", "guest"];
+                    readonly enum: ("corporate" | "guest")[];
                 };
             }];
         };
@@ -32552,7 +32597,7 @@ export declare const rootRedoclyConfigSchema: {
                             readonly type: 'string';
                             readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                             readonly not: {
-                                readonly enum: readonly ["redocly", "corporate", "guest"];
+                                readonly enum: ("corporate" | "guest")[];
                             };
                         };
                         readonly uniqueItems: true;
@@ -32560,7 +32605,7 @@ export declare const rootRedoclyConfigSchema: {
                         readonly type: 'string';
                         readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                         readonly not: {
-                            readonly enum: readonly ["redocly", "corporate", "guest"];
+                            readonly enum: ("corporate" | "guest")[];
                         };
                     }];
                 };
@@ -32606,6 +32651,12 @@ export declare const rootRedoclyConfigSchema: {
                                         readonly type: 'string';
                                     };
                                 };
+                                readonly mcp: {
+                                    readonly type: 'object';
+                                    readonly additionalProperties: {
+                                        readonly type: 'string';
+                                    };
+                                };
                             };
                             readonly additionalProperties: false;
                         };
@@ -46697,20 +46748,20 @@ export declare const rootRedoclyConfigSchema: {
                     };
                     readonly additionalProperties: false;
                 };
-                readonly gateway: {
-                    readonly type: 'object';
-                    readonly properties: {
-                        readonly hide: {
-                            readonly type: 'boolean';
-                        };
-                        readonly allowedHosts: {
-                            readonly type: 'array';
-                            readonly items: {
-                                readonly type: 'string';
-                            };
-                        };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly skills: {
+            readonly type: 'object';
+            readonly properties: {
+                readonly hide: {
+                    readonly type: 'boolean';
+                };
+                readonly excludeFiles: {
+                    readonly type: 'array';
+                    readonly items: {
+                        readonly type: 'string';
                     };
-                    readonly additionalProperties: false;
                 };
             };
             readonly additionalProperties: false;
@@ -47245,6 +47296,12 @@ export declare const rootRedoclyConfigSchema: {
                                             readonly type: 'string';
                                         };
                                     };
+                                    readonly mcp: {
+                                        readonly type: 'object';
+                                        readonly additionalProperties: {
+                                            readonly type: 'string';
+                                        };
+                                    };
                                 };
                                 readonly additionalProperties: false;
                             };
@@ -52525,7 +52582,7 @@ export declare const rootRedoclyConfigSchema: {
                                 readonly type: 'string';
                                 readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                                 readonly not: {
-                                    readonly enum: readonly ["redocly", "corporate", "guest"];
+                                    readonly enum: ("corporate" | "guest")[];
                                 };
                             };
                             readonly uniqueItems: true;
@@ -52533,7 +52590,7 @@ export declare const rootRedoclyConfigSchema: {
                             readonly type: 'string';
                             readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                             readonly not: {
-                                readonly enum: readonly ["redocly", "corporate", "guest"];
+                                readonly enum: ("corporate" | "guest")[];
                             };
                         }];
                     };
@@ -52585,7 +52642,7 @@ export declare const rootRedoclyConfigSchema: {
                                         readonly type: 'string';
                                         readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                                         readonly not: {
-                                            readonly enum: readonly ["redocly", "corporate", "guest"];
+                                            readonly enum: ("corporate" | "guest")[];
                                         };
                                     };
                                     readonly uniqueItems: true;
@@ -52593,7 +52650,7 @@ export declare const rootRedoclyConfigSchema: {
                                     readonly type: 'string';
                                     readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
                                     readonly not: {
-                                        readonly enum: readonly ["redocly", "corporate", "guest"];
+                                        readonly enum: ("corporate" | "guest")[];
                                     };
                                 }];
                             };
@@ -52639,6 +52696,12 @@ export declare const rootRedoclyConfigSchema: {
                                                     readonly type: 'string';
                                                 };
                                             };
+                                            readonly mcp: {
+                                                readonly type: 'object';
+                                                readonly additionalProperties: {
+                                                    readonly type: 'string';
+                                                };
+                                            };
                                         };
                                         readonly additionalProperties: false;
                                     };
@@ -66730,20 +66793,20 @@ export declare const rootRedoclyConfigSchema: {
                                 };
                                 readonly additionalProperties: false;
                             };
-                            readonly gateway: {
-                                readonly type: 'object';
-                                readonly properties: {
-                                    readonly hide: {
-                                        readonly type: 'boolean';
-                                    };
-                                    readonly allowedHosts: {
-                                        readonly type: 'array';
-                                        readonly items: {
-                                            readonly type: 'string';
-                                        };
-                                    };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                    readonly skills: {
+                        readonly type: 'object';
+                        readonly properties: {
+                            readonly hide: {
+                                readonly type: 'boolean';
+                            };
+                            readonly excludeFiles: {
+                                readonly type: 'array';
+                                readonly items: {
+                                    readonly type: 'string';
                                 };
-                                readonly additionalProperties: false;
                             };
                         };
                         readonly additionalProperties: false;

package/lib/types/config-types.d.ts

@@ -1,7 +1,7 @@
 import type { FromSchema } from 'json-schema-to-ts';
 import type { themeConfigSchema } from '../default-theme-config-schema.js';
 import type { productConfigOverrideSchema } from '../product-override-schema.js';
-import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, l10nConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, bannerConfigSchema, bannersConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoDirectConfigSchema } from '../root-config-schema.js';
+import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, l10nConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, skillsConfigSchema, bannerConfigSchema, bannersConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoDirectConfigSchema } from '../root-config-schema.js';
 import type { RedocConfigTypes } from './redoc-types.js';
 import type { GraphQLConfigTypes } from './graphql-types.js';
 import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from '../ex-theme-config-schemas.js';
@@ -32,6 +32,7 @@ export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
 export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
 export type ScorecardsConfig = FromSchema<typeof scorecardsConfigSchema>;
 export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
+export type SkillsConfig = FromSchema<typeof skillsConfigSchema>;
 type RootRedoclyConfig = FromSchema<typeof rootRedoclyConfigSchema>;
 export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'idps' | 'residency' | 'logoutReturnUrl'> & {
     /**

package/lib/types/index.d.ts

@@ -2,4 +2,5 @@ export * from './api-functions-types.js';
 export * from './config-types.js';
 export * from './portal-shared-types.js';
 export * from './catalog-entity-types.js';
+export * from './mock-server-types.js';
 export * from './json-schema-types.js';

package/lib/types/mock-server-types.d.ts

@@ -0,0 +1,59 @@
+import type { ApiFunctionsContext } from './api-functions-types.js';
+export type HttpMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+export interface MockSnippetRequest {
+    readonly method: HttpMethod;
+    readonly path: string;
+    readonly params: Record<string, unknown>;
+    readonly query: Record<string, unknown>;
+    readonly headers: Record<string, string>;
+    readonly body?: unknown;
+}
+export interface MockSnippetState {
+    get<T>(resource: string, id: string | number): Promise<T | null>;
+    list<T>(resource: string): Promise<T[]>;
+    set<T>(resource: string, id: string | number, value: T): Promise<void>;
+    delete(resource: string, id: string | number): Promise<void>;
+}
+export interface MockSnippetContext {
+    request: MockSnippetRequest;
+    state: MockSnippetState;
+}
+export interface MockSnippetResult {
+    status: number;
+    headers?: Record<string, string>;
+    body?: unknown;
+}
+export interface MockJsExecutorOptions {
+    timeoutMs?: number;
+    maxLifetimeMs?: number;
+}
+export interface MockJsExecutor {
+    run(snippet: string, context: MockSnippetContext, opts?: MockJsExecutorOptions): Promise<MockSnippetResult>;
+}
+export type MockKey = (string | number)[];
+export interface MockStateSetOptions {
+    ttlSeconds?: number;
+}
+export interface MockStateListOptions {
+    limit?: number;
+    cursor?: string;
+}
+export interface MockStateListItem<T> {
+    key: MockKey;
+    value: T;
+}
+export interface MockStateListResult<T> {
+    items: MockStateListItem<T>[];
+    total?: number;
+    cursor: string | null;
+}
+export interface MockStateStore {
+    get<T>(key: MockKey): Promise<T | null>;
+    set<T>(key: MockKey, value: T, opts?: MockStateSetOptions): Promise<void>;
+    delete(key: MockKey): Promise<void>;
+    list<T>(prefix: MockKey, opts?: MockStateListOptions): Promise<MockStateListResult<T>>;
+}
+export type MockServerRouteContext = ApiFunctionsContext & {
+    executor?: MockJsExecutor;
+    store?: MockStateStore;
+};

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

@@ -109,6 +109,7 @@ export type ResolvedNavItem = ResolvedNavLinkItem | ResolvedNavGroupItem | {
     isDefault?: boolean;
     versionFolderId?: string;
     variant?: 'primary' | 'secondary';
+    hideWhenEmpty?: boolean;
     separatorLine?: boolean;
     linePosition?: 'top' | 'bottom';
     link?: undefined;

package/lib-esm/constants/identity-provider-slug.d.ts

@@ -3,6 +3,7 @@ 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 REDOCLY_IDP_SLUG = "redocly";
+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'];

package/lib-esm/index.d.ts

@@ -6,5 +6,5 @@ export * from './common.js';
 export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, DEFAULT_SEARCH_ENGINE, } from './constants/shared.js';
 export { CONFIG_NODE_TYPE_NAMES } from './constants/config.js';
 export { ENTITY_RELATION_TYPES, ENTITY_NODE_TYPE_NAMES } from './constants/entities.js';
-export { IDENTITY_PROVIDER_RESERVED_MESSAGE, IDENTITY_PROVIDER_RESERVED_SLUGS, IDENTITY_PROVIDER_SLUG_MAX_LENGTH, IDENTITY_PROVIDER_SLUG_MAX_LENGTH_MESSAGE, IDENTITY_PROVIDER_SLUG_MESSAGE, IDENTITY_PROVIDER_SLUG_PATTERN, IDENTITY_PROVIDER_SLUG_REGEX, } from './constants/identity-provider-slug.js';
+export { IDENTITY_PROVIDER_RESERVED_MESSAGE, IDENTITY_PROVIDER_RESERVED_SLUGS, IDENTITY_PROVIDER_SLUG_MAX_LENGTH, IDENTITY_PROVIDER_SLUG_MAX_LENGTH_MESSAGE, IDENTITY_PROVIDER_SLUG_MESSAGE, IDENTITY_PROVIDER_SLUG_PATTERN, IDENTITY_PROVIDER_SLUG_REGEX, REDOCLY_IDP_SLUG, } from './constants/identity-provider-slug.js';
 export * from './entities-catalog-entity-file-schema.js';