@redocly/config 0.44.0 → 0.44.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/asyncapi-config-schema.d.ts +300 -0
- package/lib/asyncapi-config-schema.js +53 -0
- package/lib/default-theme-config-schema.d.ts +300 -0
- package/lib/default-theme-config-schema.js +2 -0
- package/lib/ex-theme-config-schemas.d.ts +1807 -0
- package/lib/ex-theme-config-schemas.js +2 -1
- package/lib/remove-property-recursively.d.ts +1 -1
- package/lib/remove-property-recursively.js +7 -4
- package/lib/root-config-schema.d.ts +776 -0
- package/lib/root-config-schema.js +22 -2
- package/lib/types/asyncapi-types.d.ts +14 -0
- package/lib/types/asyncapi-types.js +3 -0
- package/lib/types/config-types.d.ts +24 -1
- package/lib/types/portal-shared-types.d.ts +6 -2
- package/lib-esm/asyncapi-config-schema.d.ts +300 -0
- package/lib-esm/asyncapi-config-schema.js +50 -0
- package/lib-esm/default-theme-config-schema.d.ts +300 -0
- package/lib-esm/default-theme-config-schema.js +2 -0
- package/lib-esm/ex-theme-config-schemas.d.ts +1807 -0
- package/lib-esm/ex-theme-config-schemas.js +1 -0
- package/lib-esm/remove-property-recursively.d.ts +1 -1
- package/lib-esm/remove-property-recursively.js +7 -4
- package/lib-esm/root-config-schema.d.ts +776 -0
- package/lib-esm/root-config-schema.js +22 -2
- package/lib-esm/types/asyncapi-types.d.ts +14 -0
- package/lib-esm/types/asyncapi-types.js +2 -0
- package/lib-esm/types/config-types.d.ts +24 -1
- package/lib-esm/types/portal-shared-types.d.ts +6 -2
- package/package.json +2 -2
|
@@ -508,7 +508,15 @@ export const redoclyConfigSchema = {
|
|
|
508
508
|
imports: {
|
|
509
509
|
type: 'array',
|
|
510
510
|
items: { type: 'string' },
|
|
511
|
-
}, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema,
|
|
511
|
+
}, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema,
|
|
512
|
+
/**
|
|
513
|
+
* @deprecated Should use `access.rbac` instead
|
|
514
|
+
*/
|
|
515
|
+
rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema,
|
|
516
|
+
/**
|
|
517
|
+
* @deprecated Should use `access.requiresLogin` instead
|
|
518
|
+
*/
|
|
519
|
+
requiresLogin: requiresLoginSchema, responseHeaders: {
|
|
512
520
|
type: 'object',
|
|
513
521
|
additionalProperties: {
|
|
514
522
|
type: 'array',
|
|
@@ -526,7 +534,19 @@ export const redoclyConfigSchema = {
|
|
|
526
534
|
}, apis: {
|
|
527
535
|
type: 'object',
|
|
528
536
|
additionalProperties: apiConfigSchema,
|
|
529
|
-
} }, configGovernanceSchema), { ssoDirect: ssoDirectConfigSchema,
|
|
537
|
+
} }, configGovernanceSchema), { ssoDirect: ssoDirectConfigSchema,
|
|
538
|
+
/**
|
|
539
|
+
* @deprecated Should use `access.sso` instead
|
|
540
|
+
*/
|
|
541
|
+
sso: ssoConfigSchema,
|
|
542
|
+
/**
|
|
543
|
+
* @deprecated Should use `access.residency` instead
|
|
544
|
+
*/
|
|
545
|
+
residency: residencySchema,
|
|
546
|
+
/**
|
|
547
|
+
* @deprecated Should use `access.logoutReturnUrl` instead
|
|
548
|
+
*/
|
|
549
|
+
logoutReturnUrl: logoutReturnUrlSchema, access: accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } },
|
|
530
550
|
/**
|
|
531
551
|
* @deprecated properties moved to the root of the config
|
|
532
552
|
*/
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { ComponentType } from 'react';
|
|
2
|
+
import type { FromSchema } from 'json-schema-to-ts';
|
|
3
|
+
import type { Schema, ConfigFunction } from '@markdoc/markdoc/dist/src/types';
|
|
4
|
+
import type { asyncapiConfigSchema } from '../asyncapi-config-schema';
|
|
5
|
+
export type AsyncApiConfigTypes = FromSchema<typeof asyncapiConfigSchema> & {
|
|
6
|
+
markdocOptions?: {
|
|
7
|
+
tags: Record<string, Schema>;
|
|
8
|
+
nodes: Record<string, Schema>;
|
|
9
|
+
components: Record<string, ComponentType>;
|
|
10
|
+
variables?: Record<string, any>;
|
|
11
|
+
partials?: Record<string, any>;
|
|
12
|
+
functions?: Record<string, ConfigFunction>;
|
|
13
|
+
};
|
|
14
|
+
};
|
|
@@ -8,6 +8,7 @@ import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownC
|
|
|
8
8
|
import type { scorecardsConfigSchema } from '../scorecards-config-schema';
|
|
9
9
|
import type { reuniteConfigSchema } from '../reunite-config-schema';
|
|
10
10
|
import type { optionalEmailSettings, reasonsSettings } from '../feedback-config-schema';
|
|
11
|
+
import type { AsyncApiConfigTypes } from './asyncapi-types';
|
|
11
12
|
/**
|
|
12
13
|
* @deprecated left for backwards compatibility. To be removed in Realm 1.0
|
|
13
14
|
*/
|
|
@@ -16,6 +17,7 @@ export type ThemeConfig = Omit<FromSchema<typeof themeConfigSchema>, 'openapi'>
|
|
|
16
17
|
};
|
|
17
18
|
export type RedocConfig = RedocConfigTypes;
|
|
18
19
|
export type GraphQLConfig = GraphQLConfigTypes;
|
|
20
|
+
export type AsyncApiConfig = AsyncApiConfigTypes;
|
|
19
21
|
export type ProductConfig = FromSchema<typeof productConfigSchema>;
|
|
20
22
|
export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;
|
|
21
23
|
export type MarkdownConfig = FromSchema<typeof markdownConfigSchema>;
|
|
@@ -30,7 +32,28 @@ export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
|
|
|
30
32
|
export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
|
|
31
33
|
export type ScorecardsConfig = FromSchema<typeof scorecardsConfigSchema>;
|
|
32
34
|
export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
|
|
33
|
-
|
|
35
|
+
type RootRedoclyConfig = FromSchema<typeof rootRedoclyConfigSchema>;
|
|
36
|
+
export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'residency' | 'logoutReturnUrl'> & {
|
|
37
|
+
/**
|
|
38
|
+
* @deprecated Should use `access.rbac` instead
|
|
39
|
+
*/
|
|
40
|
+
rbac?: RootRedoclyConfig['rbac'];
|
|
41
|
+
/**
|
|
42
|
+
* @deprecated Should use `access.requiresLogin` instead
|
|
43
|
+
*/
|
|
44
|
+
requiresLogin?: RootRedoclyConfig['requiresLogin'];
|
|
45
|
+
/**
|
|
46
|
+
* @deprecated Should use `access.sso` instead
|
|
47
|
+
*/
|
|
48
|
+
sso?: RootRedoclyConfig['sso'];
|
|
49
|
+
/**
|
|
50
|
+
* @deprecated Should use `access.residency` instead
|
|
51
|
+
*/
|
|
52
|
+
residency?: RootRedoclyConfig['residency'];
|
|
53
|
+
/**
|
|
54
|
+
* @deprecated Should use `access.logoutReturnUrl` instead
|
|
55
|
+
*/
|
|
56
|
+
logoutReturnUrl?: RootRedoclyConfig['logoutReturnUrl'];
|
|
34
57
|
/**
|
|
35
58
|
* @deprecated properties moved to the root of the config
|
|
36
59
|
*/
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { Node } from '@markdoc/markdoc/dist/src/types';
|
|
2
2
|
import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../constants/shared';
|
|
3
|
-
import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } from './config-types';
|
|
3
|
+
import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig, BannerConfig } from './config-types';
|
|
4
4
|
import type { CatalogEntityConfig } from './catalog-entity-types';
|
|
5
5
|
export * from './code-walkthrough-types';
|
|
6
|
-
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'
|
|
6
|
+
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'> & {
|
|
7
7
|
auth?: {
|
|
8
8
|
idpsInfo?: {
|
|
9
9
|
idpId: string;
|
|
@@ -18,6 +18,7 @@ export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'produc
|
|
|
18
18
|
products?: {
|
|
19
19
|
[key: string]: ProductUiConfig;
|
|
20
20
|
};
|
|
21
|
+
banner?: ResolvedBannerConfig[];
|
|
21
22
|
};
|
|
22
23
|
/**
|
|
23
24
|
* @deprecated left for backwards compatibility. To be removed in Realm 1.0
|
|
@@ -157,6 +158,9 @@ export type ResolvedSidebar = {
|
|
|
157
158
|
catalogConfig?: CatalogEntityConfig;
|
|
158
159
|
};
|
|
159
160
|
};
|
|
161
|
+
export type ResolvedBannerConfig = BannerConfig & {
|
|
162
|
+
ast: unknown;
|
|
163
|
+
};
|
|
160
164
|
export type CompilationError = {
|
|
161
165
|
message: string;
|
|
162
166
|
sourceFileRelativePath: string;
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@redocly/config",
|
|
3
|
-
"version": "0.44.
|
|
3
|
+
"version": "0.44.2",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"module": "./lib-esm/index.js",
|
|
7
7
|
"types": "./lib/index.d.ts",
|
|
8
8
|
"devDependencies": {
|
|
9
9
|
"@markdoc/markdoc": "0.5.2",
|
|
10
|
-
"@redocly/openapi-core": "2.
|
|
10
|
+
"@redocly/openapi-core": "2.24.0",
|
|
11
11
|
"@types/node": "22.18.13",
|
|
12
12
|
"@types/react": "^19.2.7",
|
|
13
13
|
"@vitest/coverage-v8": "4.0.10",
|