@redocly/config 0.6.0 → 0.6.2

package/lib/graphql-config-schema.d.ts

@@ -0,0 +1,303 @@
+export declare const graphqlConfigSchema: {
+    readonly type: "object";
+    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;
+};

package/lib/graphql-config-schema.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.graphqlConfigSchema = void 0;
+const feedback_config_schema_1 = require("./feedback-config-schema");
+const typeGroupConfig = {
+    type: 'object',
+    properties: {
+        includeByName: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        },
+        excludeByName: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        },
+    },
+    additionalProperties: false,
+};
+const menuGroupConfig = {
+    type: 'object',
+    properties: {
+        name: {
+            type: 'string',
+        },
+        items: typeGroupConfig,
+        queries: typeGroupConfig,
+        mutations: typeGroupConfig,
+        subscriptions: typeGroupConfig,
+        types: typeGroupConfig,
+        directives: typeGroupConfig,
+    },
+    required: ['name'],
+    additionalProperties: false,
+};
+const menuGroupingConfig = {
+    type: 'object',
+    properties: {
+        requireExactGroups: {
+            type: 'boolean',
+        },
+        groups: {
+            type: 'array',
+            items: menuGroupConfig,
+        },
+        otherItemsGroupName: {
+            type: 'string',
+        },
+    },
+    required: ['requireExactGroups', 'groups', 'otherItemsGroupName'],
+    additionalProperties: false,
+};
+exports.graphqlConfigSchema = {
+    type: 'object',
+    properties: {
+        pagination: {
+            type: 'string',
+            enum: ['none', 'section', 'item'],
+        },
+        navigation: {
+            type: 'object',
+            properties: {
+                contentPrefix: {
+                    type: 'string',
+                },
+                menuPrefix: {
+                    type: 'string',
+                },
+            },
+        },
+        hidePaginationButtons: {
+            type: 'boolean',
+        },
+        menu: {
+            type: 'object',
+            properties: Object.assign({ initialLoadState: {
+                    type: 'string',
+                    enum: ['all-expanded', 'default'],
+                } }, menuGroupingConfig.properties),
+            additionalProperties: false,
+        },
+        sidebar: {
+            type: 'object',
+            properties: {
+                hide: {
+                    type: 'boolean',
+                },
+            },
+        },
+        apiLogo: {
+            type: 'object',
+            properties: {
+                imageUrl: {
+                    type: 'string',
+                },
+                href: {
+                    type: 'string',
+                },
+                altText: {
+                    type: 'string',
+                },
+                backgroundColor: {
+                    type: 'string',
+                },
+            },
+        },
+        jsonSamplesExpandLevel: {
+            type: 'number',
+        },
+        sampleMaxInlineArgs: {
+            type: 'number',
+        },
+        licenseKey: {
+            type: 'string',
+        },
+        fieldExpandLevel: {
+            type: 'number',
+        },
+        baseUrlPath: {
+            type: 'string',
+        },
+        feedback: feedback_config_schema_1.feedbackConfigSchema,
+    },
+    additionalProperties: false,
+};
+//# sourceMappingURL=graphql-config-schema.js.map

package/lib/graphql-types.d.ts

@@ -0,0 +1,9 @@
+import type { FromSchema } from 'json-schema-to-ts';
+import type { Location } from 'react-router-dom';
+import type { graphqlConfigSchema } from './graphql-config-schema';
+export type GraphQLConfigTypes = FromSchema<typeof graphqlConfigSchema> & {
+    markdown?: {
+        parser: (md: string) => string;
+    };
+    onLocationChange?: (location: Partial<Location>) => void;
+};

package/lib/graphql-types.js

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

package/lib/index.d.ts

@@ -2,4 +2,4 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema'
 export { productThemeOverrideSchema, productConfigOverrideSchema, } from './default-theme-config-schema';
 export * from './types';
 export * from './portal-shared-types';
-export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, } from './constants';
+export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, } from './constants';

package/lib/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.LayoutVariant = exports.AuthProviderType = exports.ApigeeDevOnboardingIntegrationAuthType = exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = exports.rootRedoclyConfigSchema = exports.rbacConfigSchema = void 0;
+exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.LayoutVariant = exports.DEFAULT_TEAM_CLAIM_NAME = exports.AuthProviderType = exports.ApigeeDevOnboardingIntegrationAuthType = exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = exports.rootRedoclyConfigSchema = exports.rbacConfigSchema = void 0;
 var root_config_schema_1 = require("./root-config-schema");
 Object.defineProperty(exports, "rbacConfigSchema", { enumerable: true, get: function () { return root_config_schema_1.rbacConfigSchema; } });
 Object.defineProperty(exports, "rootRedoclyConfigSchema", { enumerable: true, get: function () { return root_config_schema_1.rootRedoclyConfigSchema; } });
@@ -26,6 +26,7 @@ __exportStar(require("./portal-shared-types"), exports);
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "ApigeeDevOnboardingIntegrationAuthType", { enumerable: true, get: function () { return constants_1.ApigeeDevOnboardingIntegrationAuthType; } });
 Object.defineProperty(exports, "AuthProviderType", { enumerable: true, get: function () { return constants_1.AuthProviderType; } });
+Object.defineProperty(exports, "DEFAULT_TEAM_CLAIM_NAME", { enumerable: true, get: function () { return constants_1.DEFAULT_TEAM_CLAIM_NAME; } });
 Object.defineProperty(exports, "LayoutVariant", { enumerable: true, get: function () { return constants_1.LayoutVariant; } });
 Object.defineProperty(exports, "REDOCLY_TEAMS_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_TEAMS_RBAC; } });
 Object.defineProperty(exports, "REDOCLY_ROUTE_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_ROUTE_RBAC; } });

package/lib/redoc-config-schema.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.redocConfigSchema = void 0;
+const feedback_config_schema_1 = require("./feedback-config-schema");
 const codeSamplesConfigSchema = {
     type: 'object',
     properties: {
@@ -72,73 +73,7 @@ exports.redocConfigSchema = {
         hideLoading: { type: 'boolean' },
         disableRouter: { type: 'boolean' },
         hideSidebar: { type: 'boolean' },
-        feedback: {
-            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,
-        },
+        feedback: feedback_config_schema_1.feedbackConfigSchema,
         hideReplay: { type: 'boolean' },
         oAuth2RedirectURI: { type: 'string', nullable: true },
         corsProxyUrl: { type: 'string' },