@redocly/config 0.44.0 → 0.44.2

package/lib/root-config-schema.js

@@ -511,7 +511,15 @@ exports.redoclyConfigSchema = {
         imports: {
             type: 'array',
             items: { type: 'string' },
-        }, licenseKey: { type: 'string' }, redirects: exports.redirectsConfigSchema, seo: exports.seoConfigSchema, rbac: exports.rbacConfigSchema, apiFunctions: exports.apiFunctionsConfigSchema, requiresLogin: requiresLoginSchema, responseHeaders: {
+        }, licenseKey: { type: 'string' }, redirects: exports.redirectsConfigSchema, seo: exports.seoConfigSchema, 
+        /**
+         * @deprecated Should use `access.rbac` instead
+         */
+        rbac: exports.rbacConfigSchema, apiFunctions: exports.apiFunctionsConfigSchema, 
+        /**
+         * @deprecated Should use `access.requiresLogin` instead
+         */
+        requiresLogin: requiresLoginSchema, responseHeaders: {
             type: 'object',
             additionalProperties: {
                 type: 'array',
@@ -529,7 +537,19 @@ exports.redoclyConfigSchema = {
         }, apis: {
             type: 'object',
             additionalProperties: exports.apiConfigSchema,
-        } }, common_1.configGovernanceSchema), { ssoDirect: exports.ssoDirectConfigSchema, sso: exports.ssoConfigSchema, residency: residencySchema, logoutReturnUrl: logoutReturnUrlSchema, access: exports.accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
+        } }, common_1.configGovernanceSchema), { ssoDirect: exports.ssoDirectConfigSchema, 
+        /**
+         * @deprecated Should use `access.sso` instead
+         */
+        sso: exports.ssoConfigSchema, 
+        /**
+         * @deprecated Should use `access.residency` instead
+         */
+        residency: residencySchema, 
+        /**
+         * @deprecated Should use `access.logoutReturnUrl` instead
+         */
+        logoutReturnUrl: logoutReturnUrlSchema, access: exports.accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
         /**
          * @deprecated properties moved to the root of the config
          */

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

@@ -0,0 +1,14 @@
+import type { ComponentType } from 'react';
+import type { FromSchema } from 'json-schema-to-ts';
+import type { Schema, ConfigFunction } from '@markdoc/markdoc/dist/src/types';
+import type { asyncapiConfigSchema } from '../asyncapi-config-schema';
+export type AsyncApiConfigTypes = FromSchema<typeof asyncapiConfigSchema> & {
+    markdocOptions?: {
+        tags: Record<string, Schema>;
+        nodes: Record<string, Schema>;
+        components: Record<string, ComponentType>;
+        variables?: Record<string, any>;
+        partials?: Record<string, any>;
+        functions?: Record<string, ConfigFunction>;
+    };
+};

package/lib/types/asyncapi-types.js

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

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

@@ -8,6 +8,7 @@ import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownC
 import type { scorecardsConfigSchema } from '../scorecards-config-schema';
 import type { reuniteConfigSchema } from '../reunite-config-schema';
 import type { optionalEmailSettings, reasonsSettings } from '../feedback-config-schema';
+import type { AsyncApiConfigTypes } from './asyncapi-types';
 /**
  * @deprecated left for backwards compatibility. To be removed in Realm 1.0
  */
@@ -16,6 +17,7 @@ export type ThemeConfig = Omit<FromSchema<typeof themeConfigSchema>, 'openapi'>
 };
 export type RedocConfig = RedocConfigTypes;
 export type GraphQLConfig = GraphQLConfigTypes;
+export type AsyncApiConfig = AsyncApiConfigTypes;
 export type ProductConfig = FromSchema<typeof productConfigSchema>;
 export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;
 export type MarkdownConfig = FromSchema<typeof markdownConfigSchema>;
@@ -30,7 +32,28 @@ 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 RedoclyConfig = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
+type RootRedoclyConfig = FromSchema<typeof rootRedoclyConfigSchema>;
+export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'residency' | 'logoutReturnUrl'> & {
+    /**
+     * @deprecated Should use `access.rbac` instead
+     */
+    rbac?: RootRedoclyConfig['rbac'];
+    /**
+     * @deprecated Should use `access.requiresLogin` instead
+     */
+    requiresLogin?: RootRedoclyConfig['requiresLogin'];
+    /**
+     * @deprecated Should use `access.sso` instead
+     */
+    sso?: RootRedoclyConfig['sso'];
+    /**
+     * @deprecated Should use `access.residency` instead
+     */
+    residency?: RootRedoclyConfig['residency'];
+    /**
+     * @deprecated Should use `access.logoutReturnUrl` instead
+     */
+    logoutReturnUrl?: RootRedoclyConfig['logoutReturnUrl'];
     /**
      * @deprecated properties moved to the root of the config
      */

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

@@ -1,9 +1,9 @@
 import type { Node } from '@markdoc/markdoc/dist/src/types';
 import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../constants/shared';
-import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } from './config-types';
+import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig, BannerConfig } from './config-types';
 import type { CatalogEntityConfig } from './catalog-entity-types';
 export * from './code-walkthrough-types';
-export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'aiAssistant' | 'colorMode' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard' | 'scorecards' | 'scorecardClassic' | 'entitiesCatalog' | 'mcp' | 'banner'> & {
+export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'aiAssistant' | 'colorMode' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard' | 'scorecards' | 'scorecardClassic' | 'entitiesCatalog' | 'mcp'> & {
     auth?: {
         idpsInfo?: {
             idpId: string;
@@ -18,6 +18,7 @@ export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'produc
     products?: {
         [key: string]: ProductUiConfig;
     };
+    banner?: ResolvedBannerConfig[];
 };
 /**
  * @deprecated left for backwards compatibility. To be removed in Realm 1.0
@@ -157,6 +158,9 @@ export type ResolvedSidebar = {
         catalogConfig?: CatalogEntityConfig;
     };
 };
+export type ResolvedBannerConfig = BannerConfig & {
+    ast: unknown;
+};
 export type CompilationError = {
     message: string;
     sourceFileRelativePath: string;

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

@@ -0,0 +1,300 @@
+export declare const asyncapiConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly downloadUrls: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly title: {
+                        readonly type: "string";
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["url"];
+                readonly additionalProperties: false;
+            };
+        };
+        readonly apiLogo: {
+            readonly type: "object";
+            readonly properties: {
+                readonly imageUrl: {
+                    readonly type: "string";
+                };
+                readonly href: {
+                    readonly type: "string";
+                };
+                readonly altText: {
+                    readonly type: "string";
+                };
+                readonly backgroundColor: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly jsonSamplesDepth: {
+            readonly type: "number";
+        };
+        readonly samplesMaxInlineArgs: {
+            readonly type: "number";
+        };
+        readonly fieldExpandLevel: {
+            readonly type: "number";
+        };
+        readonly baseUrlPath: {
+            readonly type: "string";
+        };
+        readonly metadata: {
+            readonly type: "object";
+            readonly properties: {
+                readonly apiId: {
+                    readonly type: "string";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly feedback: {
+            readonly type: "object";
+            readonly properties: {
+                readonly hide: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                };
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
+                    readonly default: "sentiment";
+                };
+                readonly settings: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly label: {
+                            readonly type: "string";
+                        };
+                        readonly submitText: {
+                            readonly type: "string";
+                        };
+                        readonly buttonText: {
+                            readonly type: "string";
+                        };
+                        readonly component: {
+                            readonly type: "string";
+                            readonly enum: readonly ["radio", "checkbox"];
+                            readonly default: "checkbox";
+                        };
+                        readonly items: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                            readonly minItems: 1;
+                        };
+                        readonly leftScaleLabel: {
+                            readonly type: "string";
+                        };
+                        readonly rightScaleLabel: {
+                            readonly type: "string";
+                        };
+                        readonly reasons: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly like: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly dislike: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly satisfied: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly neutral: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly dissatisfied: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly component: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["radio", "checkbox"];
+                                    readonly default: "checkbox";
+                                };
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly items: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly comment: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly likeLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly dislikeLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly satisfiedLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly neutralLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly dissatisfiedLabel: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly optionalEmail: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly placeholder: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly layout: {
+            readonly type: "string";
+            readonly enum: readonly ["stacked", "three-panel"];
+        };
+    };
+    readonly additionalProperties: false;
+};

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

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