@redocly/config 0.26.2 → 0.26.3

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

@@ -5,6 +5,7 @@ import { graphqlConfigSchema } from './graphql-config-schema';
 import { removePropertyRecursively } from './remove-property-recursively';
 import { reuniteConfigSchema } from './reunite-config-schema';
 import { analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, footerConfigSchema, linksConfigSchema, logoConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
+import { entitiesCatalogConfigSchema } from './entities-catalog-config-schema';
 import { ruleSchemas, preprocessorSchemas, decoratorsSchemas } from './common';
 export const oidcIssuerMetadataSchema = {
     type: 'object',
@@ -409,7 +410,7 @@ export const redoclyConfigSchema = {
         /**
          * @deprecated Should use `catalogClassic` instead
          */
-        catalog: catalogsConfigSchema, catalogClassic: catalogsConfigSchema, scorecard: scorecardConfigSchema }),
+        catalog: catalogsConfigSchema, entitiesCatalog: entitiesCatalogConfigSchema, catalogClassic: catalogsConfigSchema, scorecard: scorecardConfigSchema }),
     default: { redirects: {}, seo: seoConfigSchema.default },
     additionalProperties: true,
 };

package/lib-esm/types/catalog-entity-types.d.ts

@@ -0,0 +1,29 @@
+export type CatalogConfigEntityExclude = {
+    key: string;
+};
+export type CatalogConfigEntityInclude = {
+    type: string;
+};
+export type CatalogConfigEntityFilter = {
+    title: string;
+    titleTranslationKey?: string;
+    parentFilter?: string;
+    valuesMapping?: Record<string, string>;
+    missingCategoryName?: string;
+    missingCategoryNameTranslationKey?: string;
+    property: string;
+    type?: 'select' | 'checkboxes' | 'date-range';
+    options?: string[];
+    hide?: boolean;
+    label?: string;
+};
+export type CatalogEntityConfig = {
+    slug?: string;
+    hide?: boolean;
+    excludes?: CatalogConfigEntityExclude[];
+    includes?: CatalogConfigEntityInclude[];
+    filters?: CatalogConfigEntityFilter[];
+    titleTranslationKey?: string;
+    descriptionTranslationKey?: string;
+    catalogSwitcherLabelTranslationKey?: string;
+};

package/lib-esm/types/catalog-entity-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=catalog-entity-types.js.map

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

@@ -7,6 +7,7 @@ import type { GraphQLConfigTypes } from './graphql-types';
 import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from '../ex-theme-config-schemas';
 import type { reuniteConfigSchema } from '../reunite-config-schema';
 import type { optionalEmailSettings, reasonsSettings } from '../feedback-config-schema';
+import type { entitiesCatalogConfigSchema } from '../entities-catalog-config-schema';
 /**
  * @deprecated left for backwards compatibility. To be removed in Realm 1.0
  */
@@ -24,6 +25,7 @@ export type SegmentAnalyticsConfig = FromSchema<typeof segmentAnalyticsConfigSch
 export type GtmAnalyticsConfig = FromSchema<typeof gtmAnalyticsConfigSchema>;
 export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchema>;
 export type CatalogConfig = FromSchema<typeof catalogSchema>;
+export type EntitiesCatalogConfig = FromSchema<typeof entitiesCatalogConfigSchema>;
 export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
 export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
 export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;

package/lib-esm/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './api-functions-types';
 export * from './config-types';
 export * from './portal-shared-types';
+export * from './catalog-entity-types';

package/lib-esm/types/index.js

@@ -1,4 +1,5 @@
 export * from './api-functions-types';
 export * from './config-types';
 export * from './portal-shared-types';
+export * from './catalog-entity-types';
 //# sourceMappingURL=index.js.map

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

@@ -160,7 +160,18 @@ export type PageProps = {
     seo?: SeoConfig;
     frontmatter?: Omit<PageProps, 'frontmatter'> & {
         settings?: any;
-    } & Partial<UiAccessibleConfig>;
+    } & Partial<UiAccessibleConfig> & {
+        navigation?: {
+            nextButton?: {
+                link?: string;
+                label?: string;
+            };
+            previousButton?: {
+                link?: string;
+                label?: string;
+            };
+        };
+    };
     disableAutoScroll?: boolean;
     lastModified?: string | null;
     [k: string]: unknown;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@redocly/config",
-  "version": "0.26.2",
+  "version": "0.26.3",
   "license": "MIT",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
   "types": "./lib/index.d.ts",
   "devDependencies": {
-    "@markdoc/markdoc": "0.5.1",
+    "@markdoc/markdoc": "0.5.2",
     "@types/node": "22.15.3",
     "@types/react": "^19.1.4",
     "json-schema-to-ts": "2.7.2",