@redocly/config 0.26.1 → 0.26.3-rc.1

package/lib/root-config-schema.js

@@ -8,6 +8,8 @@ const graphql_config_schema_1 = require("./graphql-config-schema");
 const remove_property_recursively_1 = require("./remove-property-recursively");
 const reunite_config_schema_1 = require("./reunite-config-schema");
 const ex_theme_config_schemas_1 = require("./ex-theme-config-schemas");
+const entities_catalog_config_schema_1 = require("./entities-catalog-config-schema");
+const common_1 = require("./common");
 exports.oidcIssuerMetadataSchema = {
     type: 'object',
     properties: {
@@ -95,20 +97,9 @@ exports.redirectsConfigSchema = {
     additionalProperties: exports.redirectConfigSchema,
     default: {},
 };
-const rulesSchema = {
-    type: 'object',
-    additionalProperties: {
-        oneOf: [{ type: 'string' }, { type: 'object' }],
-    },
-};
 exports.apiConfigSchema = {
     type: 'object',
-    properties: {
-        root: { type: 'string' },
-        output: { type: 'string', pattern: '(.ya?ml|.json)$' },
-        rbac: { type: 'object', additionalProperties: true },
-        openapi: ex_theme_config_schemas_1.openapiConfigSchema,
-        graphql: graphql_config_schema_1.graphqlConfigSchema,
+    properties: Object.assign(Object.assign(Object.assign(Object.assign({ root: { type: 'string' }, output: { type: 'string', pattern: '(.ya?ml|.json)$' }, rbac: { type: 'object', additionalProperties: true }, openapi: ex_theme_config_schemas_1.openapiConfigSchema, graphql: graphql_config_schema_1.graphqlConfigSchema, 
         /**
          * @deprecated left for backwards compatibility
          */
@@ -119,14 +110,7 @@ exports.apiConfigSchema = {
                 graphql: graphql_config_schema_1.graphqlConfigSchema,
             },
             additionalProperties: false,
-        },
-        title: { type: 'string' },
-        metadata: { type: 'object', additionalProperties: true },
-        rules: rulesSchema,
-        decorators: { type: 'object', additionalProperties: true },
-        preprocessors: { type: 'object', additionalProperties: true },
-        extends: { type: 'array', items: { type: 'string' } },
-    },
+        }, title: { type: 'string' }, metadata: { type: 'object', additionalProperties: true } }, common_1.ruleSchemas), common_1.preprocessorSchemas), common_1.decoratorsSchemas), { extends: { type: 'array', items: { type: 'string' } } }),
     required: ['root'],
 };
 const metadataConfigSchema = {
@@ -394,28 +378,20 @@ const responseHeaderSchema = {
 };
 exports.redoclyConfigSchema = {
     type: 'object',
-    properties: {
+    properties: Object.assign(Object.assign(Object.assign(Object.assign({ 
         /**
          * @deprecated Should use `plugins` instead
          */
         imports: {
             type: 'array',
             items: { type: 'string' },
-        },
-        licenseKey: { type: 'string' },
-        redirects: exports.redirectsConfigSchema,
-        seo: exports.seoConfigSchema,
-        rbac: exports.rbacConfigSchema,
-        apiFunctions: exports.apiFunctionsConfigSchema,
-        requiresLogin: { type: 'boolean' },
-        responseHeaders: {
+        }, licenseKey: { type: 'string' }, redirects: exports.redirectsConfigSchema, seo: exports.seoConfigSchema, rbac: exports.rbacConfigSchema, apiFunctions: exports.apiFunctionsConfigSchema, requiresLogin: { type: 'boolean' }, responseHeaders: {
             type: 'object',
             additionalProperties: {
                 type: 'array',
                 items: responseHeaderSchema,
             },
-        },
-        mockServer: {
+        }, mockServer: {
             type: 'object',
             properties: {
                 off: { type: 'boolean', default: false },
@@ -424,57 +400,20 @@ exports.redoclyConfigSchema = {
                 errorIfForcedExampleNotFound: { type: 'boolean', default: false },
                 description: { type: 'string' },
             },
-        },
-        apis: {
+        }, apis: {
             type: 'object',
             additionalProperties: exports.apiConfigSchema,
-        },
-        extends: { type: 'array', items: { type: 'string' } },
-        rules: rulesSchema,
-        decorators: { type: 'object', additionalProperties: true },
-        preprocessors: { type: 'object', additionalProperties: true },
-        ssoDirect: exports.ssoDirectConfigSchema,
-        sso: exports.ssoConfigSchema,
-        residency: { type: 'string' },
-        developerOnboarding: devOnboardingConfigSchema,
-        removeAttribution: { type: 'boolean' },
-        i18n: exports.l10nConfigSchema, // deprecated
-        l10n: exports.l10nConfigSchema,
-        metadata: metadataConfigSchema,
-        metadataGlobs: metadataGlobsConfigSchema,
-        ignore: { type: 'array', items: { type: 'string' } },
+        }, extends: { type: 'array', items: { type: 'string' } } }, common_1.ruleSchemas), common_1.decoratorsSchemas), common_1.preprocessorSchemas), { ssoDirect: exports.ssoDirectConfigSchema, sso: exports.ssoConfigSchema, residency: { type: 'string' }, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
         /**
          * @deprecated properties moved to the root of the config
          */
-        theme: default_theme_config_schema_1.themeConfigSchema,
-        reunite: reunite_config_schema_1.reuniteConfigSchema,
+        theme: default_theme_config_schema_1.themeConfigSchema, reunite: reunite_config_schema_1.reuniteConfigSchema, 
         // Ex theme properties
-        logo: ex_theme_config_schemas_1.logoConfigSchema,
-        navbar: ex_theme_config_schemas_1.navbarConfigSchema,
-        products: ex_theme_config_schemas_1.productsConfigSchema,
-        footer: ex_theme_config_schemas_1.footerConfigSchema,
-        sidebar: ex_theme_config_schemas_1.sidebarConfigSchema,
-        scripts: ex_theme_config_schemas_1.scriptsConfigSchema,
-        links: ex_theme_config_schemas_1.linksConfigSchema,
-        feedback: feedback_config_schema_1.feedbackConfigSchema,
-        search: ex_theme_config_schemas_1.searchConfigSchema,
-        colorMode: ex_theme_config_schemas_1.colorModeConfigSchema,
-        navigation: ex_theme_config_schemas_1.navigationConfigSchema,
-        codeSnippet: ex_theme_config_schemas_1.codeSnippetConfigSchema,
-        markdown: ex_theme_config_schemas_1.markdownConfigSchema,
-        openapi: ex_theme_config_schemas_1.openapiConfigSchema,
-        graphql: graphql_config_schema_1.graphqlConfigSchema,
-        analytics: ex_theme_config_schemas_1.analyticsConfigSchema,
-        userMenu: ex_theme_config_schemas_1.userMenuConfigSchema,
-        versionPicker: ex_theme_config_schemas_1.versionPickerConfigSchema,
-        breadcrumbs: ex_theme_config_schemas_1.breadcrumbsConfigSchema,
+        logo: ex_theme_config_schemas_1.logoConfigSchema, navbar: ex_theme_config_schemas_1.navbarConfigSchema, products: ex_theme_config_schemas_1.productsConfigSchema, footer: ex_theme_config_schemas_1.footerConfigSchema, sidebar: ex_theme_config_schemas_1.sidebarConfigSchema, scripts: ex_theme_config_schemas_1.scriptsConfigSchema, links: ex_theme_config_schemas_1.linksConfigSchema, feedback: feedback_config_schema_1.feedbackConfigSchema, search: ex_theme_config_schemas_1.searchConfigSchema, colorMode: ex_theme_config_schemas_1.colorModeConfigSchema, navigation: ex_theme_config_schemas_1.navigationConfigSchema, codeSnippet: ex_theme_config_schemas_1.codeSnippetConfigSchema, markdown: ex_theme_config_schemas_1.markdownConfigSchema, openapi: ex_theme_config_schemas_1.openapiConfigSchema, graphql: graphql_config_schema_1.graphqlConfigSchema, analytics: ex_theme_config_schemas_1.analyticsConfigSchema, userMenu: ex_theme_config_schemas_1.userMenuConfigSchema, versionPicker: ex_theme_config_schemas_1.versionPickerConfigSchema, breadcrumbs: ex_theme_config_schemas_1.breadcrumbsConfigSchema, 
         /**
          * @deprecated Should use `catalogClassic` instead
          */
-        catalog: ex_theme_config_schemas_1.catalogsConfigSchema,
-        catalogClassic: ex_theme_config_schemas_1.catalogsConfigSchema,
-        scorecard: ex_theme_config_schemas_1.scorecardConfigSchema,
-    },
+        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 }),
     default: { redirects: {}, seo: exports.seoConfigSchema.default },
     additionalProperties: true,
 };

package/lib/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/types/catalog-entity-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=catalog-entity-types.js.map

package/lib/types/code-walkthrough-types.d.ts

@@ -1,7 +1,6 @@
 export type CodeWalkthroughStepAttr = {
     id: string;
     title?: string;
-    stepKey: number;
 };
 export type FilesetsMarkdocAttr = WithConditions<{
     files?: string[];

package/lib/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/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/types/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api-functions-types"), exports);
 __exportStar(require("./config-types"), exports);
 __exportStar(require("./portal-shared-types"), exports);
+__exportStar(require("./catalog-entity-types"), exports);
 //# sourceMappingURL=index.js.map

package/lib/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/lib-esm/common.d.ts

@@ -0,0 +1,160 @@
+export declare const rulesSchema: {
+    readonly type: "object";
+    readonly additionalProperties: {
+        readonly oneOf: readonly [{
+            readonly type: "string";
+        }, {
+            readonly type: "object";
+        }];
+    };
+};
+export declare const ruleSchemas: {
+    readonly rules: {
+        readonly type: "object";
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "object";
+            }];
+        };
+    };
+    readonly oas2Rules: {
+        readonly type: "object";
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "object";
+            }];
+        };
+    };
+    readonly oas3_0Rules: {
+        readonly type: "object";
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "object";
+            }];
+        };
+    };
+    readonly oas3_1Rules: {
+        readonly type: "object";
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "object";
+            }];
+        };
+    };
+    readonly async2Rules: {
+        readonly type: "object";
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "object";
+            }];
+        };
+    };
+    readonly async3Rules: {
+        readonly type: "object";
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "object";
+            }];
+        };
+    };
+    readonly arazzo1Rules: {
+        readonly type: "object";
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "object";
+            }];
+        };
+    };
+    readonly overlay1Rules: {
+        readonly type: "object";
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "object";
+            }];
+        };
+    };
+};
+export declare const preprocessorSchemas: {
+    readonly preprocessors: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly oas2Preprocessors: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly oas3_0Preprocessors: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly oas3_1Preprocessors: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly async2Preprocessors: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly async3Preprocessors: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly arazzo1Preprocessors: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly overlay1Preprocessors: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+};
+export declare const decoratorsSchemas: {
+    readonly decorators: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly oas2Decorators: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly oas3_0Decorators: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly oas3_1Decorators: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly async2Decorators: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly async3Decorators: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly arazzo1Decorators: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    readonly overlay1Decorators: {
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+};

package/lib-esm/common.js

@@ -0,0 +1,37 @@
+export const rulesSchema = {
+    type: 'object',
+    additionalProperties: {
+        oneOf: [{ type: 'string' }, { type: 'object' }],
+    },
+};
+export const ruleSchemas = {
+    rules: rulesSchema,
+    oas2Rules: rulesSchema,
+    oas3_0Rules: rulesSchema,
+    oas3_1Rules: rulesSchema,
+    async2Rules: rulesSchema,
+    async3Rules: rulesSchema,
+    arazzo1Rules: rulesSchema,
+    overlay1Rules: rulesSchema,
+};
+export const preprocessorSchemas = {
+    preprocessors: { type: 'object', additionalProperties: true },
+    oas2Preprocessors: { type: 'object', additionalProperties: true },
+    oas3_0Preprocessors: { type: 'object', additionalProperties: true },
+    oas3_1Preprocessors: { type: 'object', additionalProperties: true },
+    async2Preprocessors: { type: 'object', additionalProperties: true },
+    async3Preprocessors: { type: 'object', additionalProperties: true },
+    arazzo1Preprocessors: { type: 'object', additionalProperties: true },
+    overlay1Preprocessors: { type: 'object', additionalProperties: true },
+};
+export const decoratorsSchemas = {
+    decorators: { type: 'object', additionalProperties: true },
+    oas2Decorators: { type: 'object', additionalProperties: true },
+    oas3_0Decorators: { type: 'object', additionalProperties: true },
+    oas3_1Decorators: { type: 'object', additionalProperties: true },
+    async2Decorators: { type: 'object', additionalProperties: true },
+    async3Decorators: { type: 'object', additionalProperties: true },
+    arazzo1Decorators: { type: 'object', additionalProperties: true },
+    overlay1Decorators: { type: 'object', additionalProperties: true },
+};
+//# sourceMappingURL=common.js.map