@redocly/config 0.26.2 → 0.26.3

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 (35) hide show
  1. package/lib/common.d.ts +1 -1
  2. package/lib/common.js +1 -1
  3. package/lib/default-theme-config-schema.d.ts +573 -4326
  4. package/lib/default-theme-config-schema.js +3 -2
  5. package/lib/entities-catalog-config-schema.d.ts +718 -0
  6. package/lib/entities-catalog-config-schema.js +84 -0
  7. package/lib/ex-theme-config-schemas.d.ts +64 -0
  8. package/lib/ex-theme-config-schemas.js +1 -1
  9. package/lib/product-override-schema.d.ts +1 -1
  10. package/lib/root-config-schema.d.ts +3449 -209
  11. package/lib/root-config-schema.js +2 -1
  12. package/lib/types/catalog-entity-types.d.ts +29 -0
  13. package/lib/types/catalog-entity-types.js +3 -0
  14. package/lib/types/config-types.d.ts +2 -0
  15. package/lib/types/index.d.ts +1 -0
  16. package/lib/types/index.js +1 -0
  17. package/lib/types/portal-shared-types.d.ts +12 -1
  18. package/lib-esm/common.d.ts +1 -1
  19. package/lib-esm/common.js +1 -1
  20. package/lib-esm/default-theme-config-schema.d.ts +573 -4326
  21. package/lib-esm/default-theme-config-schema.js +2 -1
  22. package/lib-esm/entities-catalog-config-schema.d.ts +718 -0
  23. package/lib-esm/entities-catalog-config-schema.js +81 -0
  24. package/lib-esm/ex-theme-config-schemas.d.ts +64 -0
  25. package/lib-esm/ex-theme-config-schemas.js +2 -2
  26. package/lib-esm/product-override-schema.d.ts +1 -1
  27. package/lib-esm/root-config-schema.d.ts +3449 -209
  28. package/lib-esm/root-config-schema.js +2 -1
  29. package/lib-esm/types/catalog-entity-types.d.ts +29 -0
  30. package/lib-esm/types/catalog-entity-types.js +2 -0
  31. package/lib-esm/types/config-types.d.ts +2 -0
  32. package/lib-esm/types/index.d.ts +1 -0
  33. package/lib-esm/types/index.js +1 -0
  34. package/lib-esm/types/portal-shared-types.d.ts +12 -1
  35. package/package.json +2 -2
@@ -8,6 +8,7 @@ const graphql_config_schema_1 = require("./graphql-config-schema");
8
8
  const remove_property_recursively_1 = require("./remove-property-recursively");
9
9
  const reunite_config_schema_1 = require("./reunite-config-schema");
10
10
  const ex_theme_config_schemas_1 = require("./ex-theme-config-schemas");
11
+ const entities_catalog_config_schema_1 = require("./entities-catalog-config-schema");
11
12
  const common_1 = require("./common");
12
13
  exports.oidcIssuerMetadataSchema = {
13
14
  type: 'object',
@@ -412,7 +413,7 @@ exports.redoclyConfigSchema = {
412
413
  /**
413
414
  * @deprecated Should use `catalogClassic` instead
414
415
  */
415
- catalog: ex_theme_config_schemas_1.catalogsConfigSchema, catalogClassic: ex_theme_config_schemas_1.catalogsConfigSchema, scorecard: ex_theme_config_schemas_1.scorecardConfigSchema }),
416
+ catalog: ex_theme_config_schemas_1.catalogsConfigSchema, entitiesCatalog: entities_catalog_config_schema_1.entitiesCatalogConfigSchema, catalogClassic: ex_theme_config_schemas_1.catalogsConfigSchema, scorecard: ex_theme_config_schemas_1.scorecardConfigSchema }),
416
417
  default: { redirects: {}, seo: exports.seoConfigSchema.default },
417
418
  additionalProperties: true,
418
419
  };
@@ -0,0 +1,29 @@
1
+ export type CatalogConfigEntityExclude = {
2
+ key: string;
3
+ };
4
+ export type CatalogConfigEntityInclude = {
5
+ type: string;
6
+ };
7
+ export type CatalogConfigEntityFilter = {
8
+ title: string;
9
+ titleTranslationKey?: string;
10
+ parentFilter?: string;
11
+ valuesMapping?: Record<string, string>;
12
+ missingCategoryName?: string;
13
+ missingCategoryNameTranslationKey?: string;
14
+ property: string;
15
+ type?: 'select' | 'checkboxes' | 'date-range';
16
+ options?: string[];
17
+ hide?: boolean;
18
+ label?: string;
19
+ };
20
+ export type CatalogEntityConfig = {
21
+ slug?: string;
22
+ hide?: boolean;
23
+ excludes?: CatalogConfigEntityExclude[];
24
+ includes?: CatalogConfigEntityInclude[];
25
+ filters?: CatalogConfigEntityFilter[];
26
+ titleTranslationKey?: string;
27
+ descriptionTranslationKey?: string;
28
+ catalogSwitcherLabelTranslationKey?: string;
29
+ };
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=catalog-entity-types.js.map
@@ -7,6 +7,7 @@ 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';
8
8
  import type { reuniteConfigSchema } from '../reunite-config-schema';
9
9
  import type { optionalEmailSettings, reasonsSettings } from '../feedback-config-schema';
10
+ import type { entitiesCatalogConfigSchema } from '../entities-catalog-config-schema';
10
11
  /**
11
12
  * @deprecated left for backwards compatibility. To be removed in Realm 1.0
12
13
  */
@@ -24,6 +25,7 @@ export type SegmentAnalyticsConfig = FromSchema<typeof segmentAnalyticsConfigSch
24
25
  export type GtmAnalyticsConfig = FromSchema<typeof gtmAnalyticsConfigSchema>;
25
26
  export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchema>;
26
27
  export type CatalogConfig = FromSchema<typeof catalogSchema>;
28
+ export type EntitiesCatalogConfig = FromSchema<typeof entitiesCatalogConfigSchema>;
27
29
  export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
28
30
  export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
29
31
  export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
@@ -1,3 +1,4 @@
1
1
  export * from './api-functions-types';
2
2
  export * from './config-types';
3
3
  export * from './portal-shared-types';
4
+ export * from './catalog-entity-types';
@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./api-functions-types"), exports);
18
18
  __exportStar(require("./config-types"), exports);
19
19
  __exportStar(require("./portal-shared-types"), exports);
20
+ __exportStar(require("./catalog-entity-types"), exports);
20
21
  //# sourceMappingURL=index.js.map
@@ -160,7 +160,18 @@ export type PageProps = {
160
160
  seo?: SeoConfig;
161
161
  frontmatter?: Omit<PageProps, 'frontmatter'> & {
162
162
  settings?: any;
163
- } & Partial<UiAccessibleConfig>;
163
+ } & Partial<UiAccessibleConfig> & {
164
+ navigation?: {
165
+ nextButton?: {
166
+ link?: string;
167
+ label?: string;
168
+ };
169
+ previousButton?: {
170
+ link?: string;
171
+ label?: string;
172
+ };
173
+ };
174
+ };
164
175
  disableAutoScroll?: boolean;
165
176
  lastModified?: string | null;
166
177
  [k: string]: unknown;
@@ -115,7 +115,7 @@ export declare const preprocessorSchemas: {
115
115
  readonly type: "object";
116
116
  readonly additionalProperties: true;
117
117
  };
118
- readonly arazzoPreprocessors: {
118
+ readonly arazzo1Preprocessors: {
119
119
  readonly type: "object";
120
120
  readonly additionalProperties: true;
121
121
  };
package/lib-esm/common.js CHANGED
@@ -21,7 +21,7 @@ export const preprocessorSchemas = {
21
21
  oas3_1Preprocessors: { type: 'object', additionalProperties: true },
22
22
  async2Preprocessors: { type: 'object', additionalProperties: true },
23
23
  async3Preprocessors: { type: 'object', additionalProperties: true },
24
- arazzoPreprocessors: { type: 'object', additionalProperties: true },
24
+ arazzo1Preprocessors: { type: 'object', additionalProperties: true },
25
25
  overlay1Preprocessors: { type: 'object', additionalProperties: true },
26
26
  };
27
27
  export const decoratorsSchemas = {