@redocly/config 0.6.0 → 0.6.2

package/lib/root-config-schema.js

@@ -115,6 +115,12 @@ exports.redirectsConfigSchema = {
     additionalProperties: exports.redirectConfigSchema,
     default: {},
 };
+const rulesSchema = {
+    type: 'object',
+    additionalProperties: {
+        oneOf: [{ type: 'string' }, { type: 'object' }],
+    },
+};
 exports.apiConfigSchema = {
     type: 'object',
     properties: {
@@ -131,7 +137,7 @@ exports.apiConfigSchema = {
         },
         title: { type: 'string' },
         metadata: { type: 'object', additionalProperties: true },
-        rules: { type: 'object', additionalProperties: true },
+        rules: rulesSchema,
         decorators: { type: 'object', additionalProperties: true },
         preprocessors: { type: 'object', additionalProperties: true },
     },
@@ -300,6 +306,7 @@ exports.redoclyConfigSchema = {
         redirects: exports.redirectsConfigSchema,
         seo: exports.seoConfigSchema,
         rbac: exports.rbacConfigSchema,
+        requiresLogin: { type: 'boolean' },
         responseHeaders: {
             type: 'object',
             additionalProperties: {
@@ -321,12 +328,9 @@ exports.redoclyConfigSchema = {
             type: 'object',
             additionalProperties: exports.apiConfigSchema,
         },
-        rules: {
-            type: 'object',
-            additionalProperties: {
-                oneOf: [{ type: 'string' }, { type: 'object' }],
-            },
-        },
+        rules: rulesSchema,
+        decorators: { type: 'object', additionalProperties: true },
+        preprocessors: { type: 'object', additionalProperties: true },
         ssoOnPrem: exports.ssoOnPremConfigSchema,
         sso: exports.ssoConfigSchema,
         residency: { type: 'string' },

package/lib/types.d.ts

@@ -2,11 +2,13 @@ import type { FromSchema } from 'json-schema-to-ts';
 import type { amplitudeAnalyticsConfigSchema, catalogFilterSchema, catalogSchema, googleAnalyticsConfigSchema, gtmAnalyticsConfigSchema, markdownConfigSchema, productConfigSchema, productGoogleAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, scorecardConfigSchema, segmentAnalyticsConfigSchema, themeConfigSchema } from './default-theme-config-schema';
 import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, basicAuthProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, i18ConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
 import type { RedocConfigTypes } from './redoc-types';
+import type { GraphQLConfigTypes } from './graphql-types';
 /**
  * Theme
  */
 export type ThemeConfig = FromSchema<typeof themeConfigSchema>;
 export type RedocConfig = RedocConfigTypes;
+export type GraphQLConfig = GraphQLConfigTypes;
 export type ProductConfig = FromSchema<typeof productConfigSchema>;
 export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;
 export type MarkdownConfig = FromSchema<typeof markdownConfigSchema>;

package/lib-esm/default-theme-config-schema.d.ts

@@ -1939,7 +1939,306 @@ export declare const themeConfigSchema: {
         };
         readonly graphql: {
             readonly type: "object";
-            readonly additionalProperties: true;
+            readonly properties: {
+                readonly pagination: {
+                    readonly type: "string";
+                    readonly enum: readonly ["none", "section", "item"];
+                };
+                readonly navigation: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly contentPrefix: {
+                            readonly type: "string";
+                        };
+                        readonly menuPrefix: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly hidePaginationButtons: {
+                    readonly type: "boolean";
+                };
+                readonly menu: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly requireExactGroups: {
+                            readonly type: "boolean";
+                        };
+                        readonly groups: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly name: {
+                                        readonly type: "string";
+                                    };
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                    readonly queries: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                    readonly mutations: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                    readonly subscriptions: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                    readonly types: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                    readonly directives: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly includeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                            readonly excludeByName: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly additionalProperties: false;
+                                    };
+                                };
+                                readonly required: readonly ["name"];
+                                readonly additionalProperties: false;
+                            };
+                        };
+                        readonly otherItemsGroupName: {
+                            readonly type: "string";
+                        };
+                        readonly initialLoadState: {
+                            readonly type: "string";
+                            readonly enum: readonly ["all-expanded", "default"];
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+                readonly sidebar: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly hide: {
+                            readonly type: "boolean";
+                        };
+                    };
+                };
+                readonly apiLogo: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly imageUrl: {
+                            readonly type: "string";
+                        };
+                        readonly href: {
+                            readonly type: "string";
+                        };
+                        readonly altText: {
+                            readonly type: "string";
+                        };
+                        readonly backgroundColor: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly jsonSamplesExpandLevel: {
+                    readonly type: "number";
+                };
+                readonly sampleMaxInlineArgs: {
+                    readonly type: "number";
+                };
+                readonly licenseKey: {
+                    readonly type: "string";
+                };
+                readonly fieldExpandLevel: {
+                    readonly type: "number";
+                };
+                readonly baseUrlPath: {
+                    readonly type: "string";
+                };
+                readonly feedback: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly hide: {
+                            readonly type: "boolean";
+                            readonly default: false;
+                        };
+                        readonly type: {
+                            readonly type: "string";
+                            readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
+                            readonly default: "sentiment";
+                        };
+                        readonly settings: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly submitText: {
+                                    readonly type: "string";
+                                };
+                                readonly buttonText: {
+                                    readonly type: "string";
+                                };
+                                readonly component: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["radio", "checkbox"];
+                                    readonly default: "checkbox";
+                                };
+                                readonly items: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                    readonly minItems: 1;
+                                };
+                                readonly leftScaleLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly rightScaleLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly reasons: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly comment: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly likeLabel: {
+                                            readonly type: "string";
+                                        };
+                                        readonly dislikeLabel: {
+                                            readonly type: "string";
+                                        };
+                                        readonly satisfiedLabel: {
+                                            readonly type: "string";
+                                        };
+                                        readonly neutralLabel: {
+                                            readonly type: "string";
+                                        };
+                                        readonly dissatisfiedLabel: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                    readonly default: null;
+                    readonly nullable: true;
+                };
+            };
+            readonly additionalProperties: false;
         };
         readonly analytics: {
             readonly type: "object";

package/lib-esm/default-theme-config-schema.js

@@ -1,4 +1,5 @@
 import { redocConfigSchema } from './redoc-config-schema';
+import { graphqlConfigSchema } from './graphql-config-schema';
 const logoConfigSchema = {
     type: 'object',
     properties: {
@@ -563,7 +564,7 @@ export const themeConfigSchema = {
         },
         markdown: markdownConfigSchema,
         openapi: redocConfigSchema,
-        graphql: { type: 'object', additionalProperties: true },
+        graphql: graphqlConfigSchema,
         analytics: {
             type: 'object',
             properties: {

package/lib-esm/feedback-config-schema.d.ts

@@ -0,0 +1,102 @@
+export declare const feedbackConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly hide: {
+            readonly type: "boolean";
+            readonly default: false;
+        };
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
+            readonly default: "sentiment";
+        };
+        readonly settings: {
+            readonly type: "object";
+            readonly properties: {
+                readonly label: {
+                    readonly type: "string";
+                };
+                readonly submitText: {
+                    readonly type: "string";
+                };
+                readonly buttonText: {
+                    readonly type: "string";
+                };
+                readonly component: {
+                    readonly type: "string";
+                    readonly enum: readonly ["radio", "checkbox"];
+                    readonly default: "checkbox";
+                };
+                readonly items: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly minItems: 1;
+                };
+                readonly leftScaleLabel: {
+                    readonly type: "string";
+                };
+                readonly rightScaleLabel: {
+                    readonly type: "string";
+                };
+                readonly reasons: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly hide: {
+                            readonly type: "boolean";
+                            readonly default: false;
+                        };
+                        readonly component: {
+                            readonly type: "string";
+                            readonly enum: readonly ["radio", "checkbox"];
+                            readonly default: "checkbox";
+                        };
+                        readonly label: {
+                            readonly type: "string";
+                        };
+                        readonly items: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+                readonly comment: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly hide: {
+                            readonly type: "boolean";
+                            readonly default: false;
+                        };
+                        readonly label: {
+                            readonly type: "string";
+                        };
+                        readonly likeLabel: {
+                            readonly type: "string";
+                        };
+                        readonly dislikeLabel: {
+                            readonly type: "string";
+                        };
+                        readonly satisfiedLabel: {
+                            readonly type: "string";
+                        };
+                        readonly neutralLabel: {
+                            readonly type: "string";
+                        };
+                        readonly dissatisfiedLabel: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+            };
+            readonly additionalProperties: false;
+        };
+    };
+    readonly additionalProperties: false;
+    readonly default: null;
+    readonly nullable: true;
+};

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

@@ -0,0 +1,68 @@
+export const feedbackConfigSchema = {
+    type: 'object',
+    properties: {
+        hide: {
+            type: 'boolean',
+            default: false,
+        },
+        type: {
+            type: 'string',
+            enum: ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'],
+            default: 'sentiment',
+        },
+        settings: {
+            type: 'object',
+            properties: {
+                label: { type: 'string' },
+                submitText: { type: 'string' },
+                buttonText: { type: 'string' },
+                component: {
+                    type: 'string',
+                    enum: ['radio', 'checkbox'],
+                    default: 'checkbox',
+                },
+                items: { type: 'array', items: { type: 'string' }, minItems: 1 },
+                leftScaleLabel: { type: 'string' },
+                rightScaleLabel: { type: 'string' },
+                reasons: {
+                    type: 'object',
+                    properties: {
+                        hide: {
+                            type: 'boolean',
+                            default: false,
+                        },
+                        component: {
+                            type: 'string',
+                            enum: ['radio', 'checkbox'],
+                            default: 'checkbox',
+                        },
+                        label: { type: 'string' },
+                        items: { type: 'array', items: { type: 'string' } },
+                    },
+                    additionalProperties: false,
+                },
+                comment: {
+                    type: 'object',
+                    properties: {
+                        hide: {
+                            type: 'boolean',
+                            default: false,
+                        },
+                        label: { type: 'string' },
+                        likeLabel: { type: 'string' },
+                        dislikeLabel: { type: 'string' },
+                        satisfiedLabel: { type: 'string' },
+                        neutralLabel: { type: 'string' },
+                        dissatisfiedLabel: { type: 'string' },
+                    },
+                    additionalProperties: false,
+                },
+            },
+            additionalProperties: false,
+        },
+    },
+    additionalProperties: false,
+    default: null,
+    nullable: true,
+};
+//# sourceMappingURL=feedback-config-schema.js.map