@redocly/config 0.8.2 → 0.9.0

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.
@@ -3055,7 +3055,7 @@ export declare const devOnboardingAdapterConfigSchema: {
3055
3055
  readonly propertyName: "type";
3056
3056
  };
3057
3057
  };
3058
- export declare const i18ConfigSchema: {
3058
+ export declare const l10nConfigSchema: {
3059
3059
  readonly type: "object";
3060
3060
  readonly properties: {
3061
3061
  readonly defaultLocale: {
@@ -5684,6 +5684,31 @@ export declare const redoclyConfigSchema: {
5684
5684
  readonly additionalProperties: false;
5685
5685
  readonly required: readonly ["defaultLocale"];
5686
5686
  };
5687
+ readonly l10n: {
5688
+ readonly type: "object";
5689
+ readonly properties: {
5690
+ readonly defaultLocale: {
5691
+ readonly type: "string";
5692
+ };
5693
+ readonly locales: {
5694
+ readonly type: "array";
5695
+ readonly items: {
5696
+ readonly type: "object";
5697
+ readonly properties: {
5698
+ readonly code: {
5699
+ readonly type: "string";
5700
+ };
5701
+ readonly name: {
5702
+ readonly type: "string";
5703
+ };
5704
+ };
5705
+ readonly required: readonly ["code"];
5706
+ };
5707
+ };
5708
+ };
5709
+ readonly additionalProperties: false;
5710
+ readonly required: readonly ["defaultLocale"];
5711
+ };
5687
5712
  readonly metadata: {
5688
5713
  readonly type: "object";
5689
5714
  readonly additionalProperties: true;
@@ -14101,6 +14126,31 @@ export declare const rootRedoclyConfigSchema: {
14101
14126
  type: "object";
14102
14127
  required: "defaultLocale"[];
14103
14128
  };
14129
+ l10n: {
14130
+ properties: {
14131
+ defaultLocale: {
14132
+ type: "string";
14133
+ };
14134
+ locales: {
14135
+ items: {
14136
+ properties: {
14137
+ name: {
14138
+ type: "string";
14139
+ };
14140
+ code: {
14141
+ type: "string";
14142
+ };
14143
+ };
14144
+ type: "object";
14145
+ required: "code"[];
14146
+ };
14147
+ type: "array";
14148
+ };
14149
+ };
14150
+ additionalProperties: false;
14151
+ type: "object";
14152
+ required: "defaultLocale"[];
14153
+ };
14104
14154
  ignore: {
14105
14155
  items: {
14106
14156
  type: "string";
@@ -16724,6 +16774,31 @@ export declare const rootRedoclyConfigSchema: {
16724
16774
  readonly additionalProperties: false;
16725
16775
  readonly required: readonly ["defaultLocale"];
16726
16776
  };
16777
+ readonly l10n: {
16778
+ readonly type: "object";
16779
+ readonly properties: {
16780
+ readonly defaultLocale: {
16781
+ readonly type: "string";
16782
+ };
16783
+ readonly locales: {
16784
+ readonly type: "array";
16785
+ readonly items: {
16786
+ readonly type: "object";
16787
+ readonly properties: {
16788
+ readonly code: {
16789
+ readonly type: "string";
16790
+ };
16791
+ readonly name: {
16792
+ readonly type: "string";
16793
+ };
16794
+ };
16795
+ readonly required: readonly ["code"];
16796
+ };
16797
+ };
16798
+ };
16799
+ readonly additionalProperties: false;
16800
+ readonly required: readonly ["defaultLocale"];
16801
+ };
16727
16802
  readonly metadata: {
16728
16803
  readonly type: "object";
16729
16804
  readonly additionalProperties: true;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.i18ConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.graviteeAdapterAuthIdpSchema = exports.graviteeAdapterAuthStaticSchema = exports.rbacConfigSchema = exports.rbacScopeItemsSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoOnPremConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
3
+ exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.l10nConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.graviteeAdapterAuthIdpSchema = exports.graviteeAdapterAuthStaticSchema = exports.rbacConfigSchema = exports.rbacScopeItemsSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoOnPremConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
4
4
  const constants_1 = require("./constants");
5
5
  const default_theme_config_schema_1 = require("./default-theme-config-schema");
6
6
  const remove_property_recursively_1 = require("./remove-property-recursively");
@@ -256,7 +256,7 @@ const devOnboardingConfigSchema = {
256
256
  },
257
257
  },
258
258
  };
259
- exports.i18ConfigSchema = {
259
+ exports.l10nConfigSchema = {
260
260
  type: 'object',
261
261
  properties: {
262
262
  defaultLocale: {
@@ -327,7 +327,8 @@ exports.redoclyConfigSchema = {
327
327
  residency: { type: 'string' },
328
328
  developerOnboarding: devOnboardingConfigSchema,
329
329
  removeAttribution: { type: 'boolean' },
330
- i18n: exports.i18ConfigSchema,
330
+ i18n: exports.l10nConfigSchema,
331
+ l10n: exports.l10nConfigSchema,
331
332
  metadata: metadataConfigSchema,
332
333
  ignore: {
333
334
  type: 'array',
package/lib/types.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { FromSchema } from 'json-schema-to-ts';
2
2
  import type { amplitudeAnalyticsConfigSchema, catalogFilterSchema, catalogSchema, googleAnalyticsConfigSchema, gtmAnalyticsConfigSchema, markdownConfigSchema, productConfigSchema, productGoogleAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, scorecardConfigSchema, segmentAnalyticsConfigSchema, closedThemeConfigSchema as themeConfigSchema } from './default-theme-config-schema';
3
- import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, i18ConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
3
+ import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, l10nConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
4
4
  import type { RedocConfigTypes } from './redoc-types';
5
5
  import type { GraphQLConfigTypes } from './graphql-types';
6
6
  /**
@@ -44,7 +44,7 @@ export type ApigeeAdapterConfig = FromSchema<typeof apigeeXAdapterConfigSchema |
44
44
  export type ApigeeAdapterAuthOauth2 = FromSchema<typeof apigeeAdapterAuthOauth2Schema>;
45
45
  export type ApigeeAdapterAuthServiceAccount = FromSchema<typeof apigeeAdapterAuthServiceAccountSchema>;
46
46
  export type SsoConfig = FromSchema<typeof ssoOnPremConfigSchema>;
47
- export type I18nConfig = FromSchema<typeof i18ConfigSchema>;
47
+ export type L10nConfig = FromSchema<typeof l10nConfigSchema>;
48
48
  type BasicApiConfig = FromSchema<typeof apiConfigSchema>;
49
49
  export type ApiConfig = BasicApiConfig & {
50
50
  theme?: {
@@ -3055,7 +3055,7 @@ export declare const devOnboardingAdapterConfigSchema: {
3055
3055
  readonly propertyName: "type";
3056
3056
  };
3057
3057
  };
3058
- export declare const i18ConfigSchema: {
3058
+ export declare const l10nConfigSchema: {
3059
3059
  readonly type: "object";
3060
3060
  readonly properties: {
3061
3061
  readonly defaultLocale: {
@@ -5684,6 +5684,31 @@ export declare const redoclyConfigSchema: {
5684
5684
  readonly additionalProperties: false;
5685
5685
  readonly required: readonly ["defaultLocale"];
5686
5686
  };
5687
+ readonly l10n: {
5688
+ readonly type: "object";
5689
+ readonly properties: {
5690
+ readonly defaultLocale: {
5691
+ readonly type: "string";
5692
+ };
5693
+ readonly locales: {
5694
+ readonly type: "array";
5695
+ readonly items: {
5696
+ readonly type: "object";
5697
+ readonly properties: {
5698
+ readonly code: {
5699
+ readonly type: "string";
5700
+ };
5701
+ readonly name: {
5702
+ readonly type: "string";
5703
+ };
5704
+ };
5705
+ readonly required: readonly ["code"];
5706
+ };
5707
+ };
5708
+ };
5709
+ readonly additionalProperties: false;
5710
+ readonly required: readonly ["defaultLocale"];
5711
+ };
5687
5712
  readonly metadata: {
5688
5713
  readonly type: "object";
5689
5714
  readonly additionalProperties: true;
@@ -14101,6 +14126,31 @@ export declare const rootRedoclyConfigSchema: {
14101
14126
  type: "object";
14102
14127
  required: "defaultLocale"[];
14103
14128
  };
14129
+ l10n: {
14130
+ properties: {
14131
+ defaultLocale: {
14132
+ type: "string";
14133
+ };
14134
+ locales: {
14135
+ items: {
14136
+ properties: {
14137
+ name: {
14138
+ type: "string";
14139
+ };
14140
+ code: {
14141
+ type: "string";
14142
+ };
14143
+ };
14144
+ type: "object";
14145
+ required: "code"[];
14146
+ };
14147
+ type: "array";
14148
+ };
14149
+ };
14150
+ additionalProperties: false;
14151
+ type: "object";
14152
+ required: "defaultLocale"[];
14153
+ };
14104
14154
  ignore: {
14105
14155
  items: {
14106
14156
  type: "string";
@@ -16724,6 +16774,31 @@ export declare const rootRedoclyConfigSchema: {
16724
16774
  readonly additionalProperties: false;
16725
16775
  readonly required: readonly ["defaultLocale"];
16726
16776
  };
16777
+ readonly l10n: {
16778
+ readonly type: "object";
16779
+ readonly properties: {
16780
+ readonly defaultLocale: {
16781
+ readonly type: "string";
16782
+ };
16783
+ readonly locales: {
16784
+ readonly type: "array";
16785
+ readonly items: {
16786
+ readonly type: "object";
16787
+ readonly properties: {
16788
+ readonly code: {
16789
+ readonly type: "string";
16790
+ };
16791
+ readonly name: {
16792
+ readonly type: "string";
16793
+ };
16794
+ };
16795
+ readonly required: readonly ["code"];
16796
+ };
16797
+ };
16798
+ };
16799
+ readonly additionalProperties: false;
16800
+ readonly required: readonly ["defaultLocale"];
16801
+ };
16727
16802
  readonly metadata: {
16728
16803
  readonly type: "object";
16729
16804
  readonly additionalProperties: true;
@@ -253,7 +253,7 @@ const devOnboardingConfigSchema = {
253
253
  },
254
254
  },
255
255
  };
256
- export const i18ConfigSchema = {
256
+ export const l10nConfigSchema = {
257
257
  type: 'object',
258
258
  properties: {
259
259
  defaultLocale: {
@@ -324,7 +324,8 @@ export const redoclyConfigSchema = {
324
324
  residency: { type: 'string' },
325
325
  developerOnboarding: devOnboardingConfigSchema,
326
326
  removeAttribution: { type: 'boolean' },
327
- i18n: i18ConfigSchema,
327
+ i18n: l10nConfigSchema,
328
+ l10n: l10nConfigSchema,
328
329
  metadata: metadataConfigSchema,
329
330
  ignore: {
330
331
  type: 'array',
@@ -1,6 +1,6 @@
1
1
  import type { FromSchema } from 'json-schema-to-ts';
2
2
  import type { amplitudeAnalyticsConfigSchema, catalogFilterSchema, catalogSchema, googleAnalyticsConfigSchema, gtmAnalyticsConfigSchema, markdownConfigSchema, productConfigSchema, productGoogleAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, scorecardConfigSchema, segmentAnalyticsConfigSchema, closedThemeConfigSchema as themeConfigSchema } from './default-theme-config-schema';
3
- import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, i18ConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
3
+ import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, l10nConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
4
4
  import type { RedocConfigTypes } from './redoc-types';
5
5
  import type { GraphQLConfigTypes } from './graphql-types';
6
6
  /**
@@ -44,7 +44,7 @@ export type ApigeeAdapterConfig = FromSchema<typeof apigeeXAdapterConfigSchema |
44
44
  export type ApigeeAdapterAuthOauth2 = FromSchema<typeof apigeeAdapterAuthOauth2Schema>;
45
45
  export type ApigeeAdapterAuthServiceAccount = FromSchema<typeof apigeeAdapterAuthServiceAccountSchema>;
46
46
  export type SsoConfig = FromSchema<typeof ssoOnPremConfigSchema>;
47
- export type I18nConfig = FromSchema<typeof i18ConfigSchema>;
47
+ export type L10nConfig = FromSchema<typeof l10nConfigSchema>;
48
48
  type BasicApiConfig = FromSchema<typeof apiConfigSchema>;
49
49
  export type ApiConfig = BasicApiConfig & {
50
50
  theme?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/config",
3
- "version": "0.8.2",
3
+ "version": "0.9.0",
4
4
  "license": "MIT",
5
5
  "main": "./lib/index.js",
6
6
  "module": "./lib-esm/index.js",