@redocly/config 0.17.1 → 0.18.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.
Files changed (13) hide show
  1. package/lib/default-theme-config-schema.d.ts +12 -0
  2. package/lib/ex-theme-config-schemas.d.ts +6 -0
  3. package/lib/ex-theme-config-schemas.js +4 -0
  4. package/lib/root-config-schema.d.ts +40 -4
  5. package/lib/root-config-schema.js +3 -3
  6. package/lib/types.d.ts +2 -2
  7. package/lib-esm/default-theme-config-schema.d.ts +12 -0
  8. package/lib-esm/ex-theme-config-schemas.d.ts +6 -0
  9. package/lib-esm/ex-theme-config-schemas.js +4 -0
  10. package/lib-esm/root-config-schema.d.ts +40 -4
  11. package/lib-esm/root-config-schema.js +2 -2
  12. package/lib-esm/types.d.ts +2 -2
  13. package/package.json +1 -1
package/lib/default-theme-config-schema.d.ts CHANGED
@@ -3928,6 +3928,12 @@ export declare const themeConfigSchema: {
3928
3928
  readonly additionalProperties: false;
3929
3929
  };
3930
3930
  };
3931
+ readonly ignore: {
3932
+ readonly type: "array";
3933
+ readonly items: {
3934
+ readonly type: "string";
3935
+ };
3936
+ };
3931
3937
  };
3932
3938
  };
3933
3939
  };
@@ -7864,6 +7870,12 @@ export declare const closedThemeConfigSchema: {
7864
7870
  readonly additionalProperties: false;
7865
7871
  };
7866
7872
  };
7873
+ readonly ignore: {
7874
+ readonly type: "array";
7875
+ readonly items: {
7876
+ readonly type: "string";
7877
+ };
7878
+ };
7867
7879
  };
7868
7880
  };
7869
7881
  };
package/lib/ex-theme-config-schemas.d.ts CHANGED
@@ -4062,5 +4062,11 @@ export declare const scorecardConfigSchema: {
4062
4062
  readonly additionalProperties: false;
4063
4063
  };
4064
4064
  };
4065
+ readonly ignore: {
4066
+ readonly type: "array";
4067
+ readonly items: {
4068
+ readonly type: "string";
4069
+ };
4070
+ };
4065
4071
  };
4066
4072
  };
package/lib/ex-theme-config-schemas.js CHANGED
@@ -586,6 +586,10 @@ exports.scorecardConfigSchema = {
586
586
  additionalProperties: false,
587
587
  },
588
588
  },
589
+ ignore: {
590
+ type: 'array',
591
+ items: { type: 'string' },
592
+ },
589
593
  },
590
594
  };
591
595
  //# sourceMappingURL=ex-theme-config-schemas.js.map
package/lib/root-config-schema.d.ts CHANGED
@@ -298,7 +298,7 @@ export declare const authProviderConfigSchema: {
298
298
  readonly propertyName: "type";
299
299
  };
300
300
  };
301
- export declare const ssoOnPremConfigSchema: {
301
+ export declare const ssoDirectConfigSchema: {
302
302
  readonly type: "object";
303
303
  readonly additionalProperties: {
304
304
  readonly oneOf: readonly [{
@@ -10156,7 +10156,7 @@ export declare const redoclyConfigSchema: {
10156
10156
  readonly type: "object";
10157
10157
  readonly additionalProperties: true;
10158
10158
  };
10159
- readonly ssoOnPrem: {
10159
+ readonly ssoDirect: {
10160
10160
  readonly type: "object";
10161
10161
  readonly additionalProperties: {
10162
10162
  readonly oneOf: readonly [{
@@ -14523,6 +14523,12 @@ export declare const redoclyConfigSchema: {
14523
14523
  readonly additionalProperties: false;
14524
14524
  };
14525
14525
  };
14526
+ readonly ignore: {
14527
+ readonly type: "array";
14528
+ readonly items: {
14529
+ readonly type: "string";
14530
+ };
14531
+ };
14526
14532
  };
14527
14533
  };
14528
14534
  };
@@ -18469,6 +18475,12 @@ export declare const redoclyConfigSchema: {
18469
18475
  readonly additionalProperties: false;
18470
18476
  };
18471
18477
  };
18478
+ readonly ignore: {
18479
+ readonly type: "array";
18480
+ readonly items: {
18481
+ readonly type: "string";
18482
+ };
18483
+ };
18472
18484
  };
18473
18485
  };
18474
18486
  };
@@ -21583,6 +21595,12 @@ export declare const rootRedoclyConfigSchema: {
21583
21595
  };
21584
21596
  scorecard: {
21585
21597
  properties: {
21598
+ ignore: {
21599
+ items: {
21600
+ type: "string";
21601
+ };
21602
+ type: "array";
21603
+ };
21586
21604
  ignoreNonCompliant: {
21587
21605
  type: "boolean";
21588
21606
  };
@@ -25726,7 +25744,7 @@ export declare const rootRedoclyConfigSchema: {
25726
25744
  additionalProperties: true;
25727
25745
  type: "object";
25728
25746
  };
25729
- ssoOnPrem: {
25747
+ ssoDirect: {
25730
25748
  additionalProperties: {
25731
25749
  oneOf: ({
25732
25750
  properties: {
@@ -28850,6 +28868,12 @@ export declare const rootRedoclyConfigSchema: {
28850
28868
  };
28851
28869
  scorecard: {
28852
28870
  properties: {
28871
+ ignore: {
28872
+ items: {
28873
+ type: "string";
28874
+ };
28875
+ type: "array";
28876
+ };
28853
28877
  ignoreNonCompliant: {
28854
28878
  type: "boolean";
28855
28879
  };
@@ -33577,7 +33601,7 @@ export declare const rootRedoclyConfigSchema: {
33577
33601
  readonly type: "object";
33578
33602
  readonly additionalProperties: true;
33579
33603
  };
33580
- readonly ssoOnPrem: {
33604
+ readonly ssoDirect: {
33581
33605
  readonly type: "object";
33582
33606
  readonly additionalProperties: {
33583
33607
  readonly oneOf: readonly [{
@@ -37944,6 +37968,12 @@ export declare const rootRedoclyConfigSchema: {
37944
37968
  readonly additionalProperties: false;
37945
37969
  };
37946
37970
  };
37971
+ readonly ignore: {
37972
+ readonly type: "array";
37973
+ readonly items: {
37974
+ readonly type: "string";
37975
+ };
37976
+ };
37947
37977
  };
37948
37978
  };
37949
37979
  };
@@ -41890,6 +41920,12 @@ export declare const rootRedoclyConfigSchema: {
41890
41920
  readonly additionalProperties: false;
41891
41921
  };
41892
41922
  };
41923
+ readonly ignore: {
41924
+ readonly type: "array";
41925
+ readonly items: {
41926
+ readonly type: "string";
41927
+ };
41928
+ };
41893
41929
  };
41894
41930
  };
41895
41931
  readonly plugins: {
package/lib/root-config-schema.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
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;
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.ssoDirectConfigSchema = 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 feedback_config_schema_1 = require("./feedback-config-schema");
@@ -62,7 +62,7 @@ exports.authProviderConfigSchema = {
62
62
  oneOf: [exports.oidcProviderConfigSchema, exports.saml2ProviderConfigSchema],
63
63
  discriminator: { propertyName: 'type' },
64
64
  };
65
- exports.ssoOnPremConfigSchema = {
65
+ exports.ssoDirectConfigSchema = {
66
66
  type: 'object',
67
67
  additionalProperties: exports.authProviderConfigSchema,
68
68
  };
@@ -344,7 +344,7 @@ exports.redoclyConfigSchema = {
344
344
  rules: rulesSchema,
345
345
  decorators: { type: 'object', additionalProperties: true },
346
346
  preprocessors: { type: 'object', additionalProperties: true },
347
- ssoOnPrem: exports.ssoOnPremConfigSchema,
347
+ ssoDirect: exports.ssoDirectConfigSchema,
348
348
  sso: exports.ssoConfigSchema,
349
349
  residency: { type: 'string' },
350
350
  developerOnboarding: devOnboardingConfigSchema,
package/lib/types.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import type { FromSchema } from 'json-schema-to-ts';
2
2
  import type { themeConfigSchema } from './default-theme-config-schema';
3
3
  import type { productConfigOverrideSchema } from './product-override-schema';
4
- 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
+ import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, l10nConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoDirectConfigSchema } from './root-config-schema';
5
5
  import type { RedocConfigTypes } from './redoc-types';
6
6
  import type { GraphQLConfigTypes } from './graphql-types';
7
7
  import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from './ex-theme-config-schemas';
@@ -49,7 +49,7 @@ export type GraviteeAdapterConfig = FromSchema<typeof graviteeAdapterConfigSchem
49
49
  export type ApigeeAdapterConfig = FromSchema<typeof apigeeXAdapterConfigSchema | typeof apigeeEdgeAdapterConfigSchema>;
50
50
  export type ApigeeAdapterAuthOauth2 = FromSchema<typeof apigeeAdapterAuthOauth2Schema>;
51
51
  export type ApigeeAdapterAuthServiceAccount = FromSchema<typeof apigeeAdapterAuthServiceAccountSchema>;
52
- export type SsoConfig = FromSchema<typeof ssoOnPremConfigSchema>;
52
+ export type SsoConfig = FromSchema<typeof ssoDirectConfigSchema>;
53
53
  export type L10nConfig = FromSchema<typeof l10nConfigSchema>;
54
54
  type BasicApiConfig = FromSchema<typeof apiConfigSchema>;
55
55
  export type ApiConfig = BasicApiConfig & {
package/lib-esm/default-theme-config-schema.d.ts CHANGED
@@ -3928,6 +3928,12 @@ export declare const themeConfigSchema: {
3928
3928
  readonly additionalProperties: false;
3929
3929
  };
3930
3930
  };
3931
+ readonly ignore: {
3932
+ readonly type: "array";
3933
+ readonly items: {
3934
+ readonly type: "string";
3935
+ };
3936
+ };
3931
3937
  };
3932
3938
  };
3933
3939
  };
@@ -7864,6 +7870,12 @@ export declare const closedThemeConfigSchema: {
7864
7870
  readonly additionalProperties: false;
7865
7871
  };
7866
7872
  };
7873
+ readonly ignore: {
7874
+ readonly type: "array";
7875
+ readonly items: {
7876
+ readonly type: "string";
7877
+ };
7878
+ };
7867
7879
  };
7868
7880
  };
7869
7881
  };
package/lib-esm/ex-theme-config-schemas.d.ts CHANGED
@@ -4062,5 +4062,11 @@ export declare const scorecardConfigSchema: {
4062
4062
  readonly additionalProperties: false;
4063
4063
  };
4064
4064
  };
4065
+ readonly ignore: {
4066
+ readonly type: "array";
4067
+ readonly items: {
4068
+ readonly type: "string";
4069
+ };
4070
+ };
4065
4071
  };
4066
4072
  };
package/lib-esm/ex-theme-config-schemas.js CHANGED
@@ -583,6 +583,10 @@ export const scorecardConfigSchema = {
583
583
  additionalProperties: false,
584
584
  },
585
585
  },
586
+ ignore: {
587
+ type: 'array',
588
+ items: { type: 'string' },
589
+ },
586
590
  },
587
591
  };
588
592
  //# sourceMappingURL=ex-theme-config-schemas.js.map
package/lib-esm/root-config-schema.d.ts CHANGED
@@ -298,7 +298,7 @@ export declare const authProviderConfigSchema: {
298
298
  readonly propertyName: "type";
299
299
  };
300
300
  };
301
- export declare const ssoOnPremConfigSchema: {
301
+ export declare const ssoDirectConfigSchema: {
302
302
  readonly type: "object";
303
303
  readonly additionalProperties: {
304
304
  readonly oneOf: readonly [{
@@ -10156,7 +10156,7 @@ export declare const redoclyConfigSchema: {
10156
10156
  readonly type: "object";
10157
10157
  readonly additionalProperties: true;
10158
10158
  };
10159
- readonly ssoOnPrem: {
10159
+ readonly ssoDirect: {
10160
10160
  readonly type: "object";
10161
10161
  readonly additionalProperties: {
10162
10162
  readonly oneOf: readonly [{
@@ -14523,6 +14523,12 @@ export declare const redoclyConfigSchema: {
14523
14523
  readonly additionalProperties: false;
14524
14524
  };
14525
14525
  };
14526
+ readonly ignore: {
14527
+ readonly type: "array";
14528
+ readonly items: {
14529
+ readonly type: "string";
14530
+ };
14531
+ };
14526
14532
  };
14527
14533
  };
14528
14534
  };
@@ -18469,6 +18475,12 @@ export declare const redoclyConfigSchema: {
18469
18475
  readonly additionalProperties: false;
18470
18476
  };
18471
18477
  };
18478
+ readonly ignore: {
18479
+ readonly type: "array";
18480
+ readonly items: {
18481
+ readonly type: "string";
18482
+ };
18483
+ };
18472
18484
  };
18473
18485
  };
18474
18486
  };
@@ -21583,6 +21595,12 @@ export declare const rootRedoclyConfigSchema: {
21583
21595
  };
21584
21596
  scorecard: {
21585
21597
  properties: {
21598
+ ignore: {
21599
+ items: {
21600
+ type: "string";
21601
+ };
21602
+ type: "array";
21603
+ };
21586
21604
  ignoreNonCompliant: {
21587
21605
  type: "boolean";
21588
21606
  };
@@ -25726,7 +25744,7 @@ export declare const rootRedoclyConfigSchema: {
25726
25744
  additionalProperties: true;
25727
25745
  type: "object";
25728
25746
  };
25729
- ssoOnPrem: {
25747
+ ssoDirect: {
25730
25748
  additionalProperties: {
25731
25749
  oneOf: ({
25732
25750
  properties: {
@@ -28850,6 +28868,12 @@ export declare const rootRedoclyConfigSchema: {
28850
28868
  };
28851
28869
  scorecard: {
28852
28870
  properties: {
28871
+ ignore: {
28872
+ items: {
28873
+ type: "string";
28874
+ };
28875
+ type: "array";
28876
+ };
28853
28877
  ignoreNonCompliant: {
28854
28878
  type: "boolean";
28855
28879
  };
@@ -33577,7 +33601,7 @@ export declare const rootRedoclyConfigSchema: {
33577
33601
  readonly type: "object";
33578
33602
  readonly additionalProperties: true;
33579
33603
  };
33580
- readonly ssoOnPrem: {
33604
+ readonly ssoDirect: {
33581
33605
  readonly type: "object";
33582
33606
  readonly additionalProperties: {
33583
33607
  readonly oneOf: readonly [{
@@ -37944,6 +37968,12 @@ export declare const rootRedoclyConfigSchema: {
37944
37968
  readonly additionalProperties: false;
37945
37969
  };
37946
37970
  };
37971
+ readonly ignore: {
37972
+ readonly type: "array";
37973
+ readonly items: {
37974
+ readonly type: "string";
37975
+ };
37976
+ };
37947
37977
  };
37948
37978
  };
37949
37979
  };
@@ -41890,6 +41920,12 @@ export declare const rootRedoclyConfigSchema: {
41890
41920
  readonly additionalProperties: false;
41891
41921
  };
41892
41922
  };
41923
+ readonly ignore: {
41924
+ readonly type: "array";
41925
+ readonly items: {
41926
+ readonly type: "string";
41927
+ };
41928
+ };
41893
41929
  };
41894
41930
  };
41895
41931
  readonly plugins: {
package/lib-esm/root-config-schema.js CHANGED
@@ -59,7 +59,7 @@ export const authProviderConfigSchema = {
59
59
  oneOf: [oidcProviderConfigSchema, saml2ProviderConfigSchema],
60
60
  discriminator: { propertyName: 'type' },
61
61
  };
62
- export const ssoOnPremConfigSchema = {
62
+ export const ssoDirectConfigSchema = {
63
63
  type: 'object',
64
64
  additionalProperties: authProviderConfigSchema,
65
65
  };
@@ -341,7 +341,7 @@ export const redoclyConfigSchema = {
341
341
  rules: rulesSchema,
342
342
  decorators: { type: 'object', additionalProperties: true },
343
343
  preprocessors: { type: 'object', additionalProperties: true },
344
- ssoOnPrem: ssoOnPremConfigSchema,
344
+ ssoDirect: ssoDirectConfigSchema,
345
345
  sso: ssoConfigSchema,
346
346
  residency: { type: 'string' },
347
347
  developerOnboarding: devOnboardingConfigSchema,
package/lib-esm/types.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import type { FromSchema } from 'json-schema-to-ts';
2
2
  import type { themeConfigSchema } from './default-theme-config-schema';
3
3
  import type { productConfigOverrideSchema } from './product-override-schema';
4
- 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
+ import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, l10nConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoDirectConfigSchema } from './root-config-schema';
5
5
  import type { RedocConfigTypes } from './redoc-types';
6
6
  import type { GraphQLConfigTypes } from './graphql-types';
7
7
  import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from './ex-theme-config-schemas';
@@ -49,7 +49,7 @@ export type GraviteeAdapterConfig = FromSchema<typeof graviteeAdapterConfigSchem
49
49
  export type ApigeeAdapterConfig = FromSchema<typeof apigeeXAdapterConfigSchema | typeof apigeeEdgeAdapterConfigSchema>;
50
50
  export type ApigeeAdapterAuthOauth2 = FromSchema<typeof apigeeAdapterAuthOauth2Schema>;
51
51
  export type ApigeeAdapterAuthServiceAccount = FromSchema<typeof apigeeAdapterAuthServiceAccountSchema>;
52
- export type SsoConfig = FromSchema<typeof ssoOnPremConfigSchema>;
52
+ export type SsoConfig = FromSchema<typeof ssoDirectConfigSchema>;
53
53
  export type L10nConfig = FromSchema<typeof l10nConfigSchema>;
54
54
  type BasicApiConfig = FromSchema<typeof apiConfigSchema>;
55
55
  export type ApiConfig = BasicApiConfig & {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/config",
3
- "version": "0.17.1",
3
+ "version": "0.18.0",
4
4
  "license": "MIT",
5
5
  "main": "./lib/index.js",
6
6
  "module": "./lib-esm/index.js",