@redocly/config - npm Package Compare versions

Comparing version 0.6.0 to 0.6.1

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

 import { redocConfigSchema } from './redoc-config-schema';
+import { graphqlConfigSchema } from './graphql-config-schema';
 const logoConfigSchema = {
@@ -566,3 +567,3 @@ type: 'object',
         openapi: redocConfigSchema,
-        graphql: { type: 'object', additionalProperties: true },
+        graphql: graphqlConfigSchema,
         analytics: {
@@ -569,0 +570,0 @@ type: 'object',

lib-esm/index.d.ts

@@ -5,2 +5,2 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema';
 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';

lib-esm/index.js

@@ -5,3 +5,3 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema';
 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';
 //# sourceMappingURL=index.js.map

lib-esm/redoc-config-schema.js

@@ -0,1 +1,2 @@
+import { feedbackConfigSchema } from './feedback-config-schema';
 const codeSamplesConfigSchema = {
@@ -72,69 +73,3 @@ type: 'object',
         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: feedbackConfigSchema,
         hideReplay: { type: 'boolean' },
@@ -141,0 +76,0 @@ oAuth2RedirectURI: { type: 'string', nullable: true },

lib-esm/root-config-schema.js

@@ -115,2 +115,8 @@ import { DEFAULT_TEAM_CLAIM_NAME, AuthProviderType, ApigeeDevOnboardingIntegrationAuthType, } from './constants';
 };
+const rulesSchema = {
+    type: 'object',
+    additionalProperties: {
+        oneOf: [{ type: 'string' }, { type: 'object' }],
+    },
+};
 export const apiConfigSchema = {
@@ -132,3 +138,3 @@ type: 'object',
         metadata: { type: 'object', additionalProperties: true },
-        rules: { type: 'object', additionalProperties: true },
+        rules: rulesSchema,
         decorators: { type: 'object', additionalProperties: true },
@@ -323,8 +329,5 @@ preprocessors: { type: 'object', additionalProperties: true },
         },
-        rules: {
-            type: 'object',
-            additionalProperties: {
-                oneOf: [{ type: 'string' }, { type: 'object' }],
-            },
-        },
+        rules: rulesSchema,
+        decorators: { type: 'object', additionalProperties: true },
+        preprocessors: { type: 'object', additionalProperties: true },
         ssoOnPrem: ssoOnPremConfigSchema,
@@ -331,0 +334,0 @@ sso: ssoConfigSchema,

lib-esm/types.d.ts

@@ -5,2 +5,3 @@ import type { FromSchema } from 'json-schema-to-ts';
 import type { RedocConfigTypes } from './redoc-types';
+import type { GraphQLConfigTypes } from './graphql-types';
 /**
@@ -11,2 +12,3 @@ * Theme
 export type RedocConfig = RedocConfigTypes;
+export type GraphQLConfig = GraphQLConfigTypes;
 export type ProductConfig = FromSchema<typeof productConfigSchema>;
@@ -13,0 +15,0 @@ export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;

lib/default-theme-config-schema.js

@@ -5,2 +5,3 @@ "use strict";
 const redoc_config_schema_1 = require("./redoc-config-schema");
+const graphql_config_schema_1 = require("./graphql-config-schema");
 const logoConfigSchema = {
@@ -570,3 +571,3 @@ type: 'object',
         openapi: redoc_config_schema_1.redocConfigSchema,
-        graphql: { type: 'object', additionalProperties: true },
+        graphql: graphql_config_schema_1.graphqlConfigSchema,
         analytics: {
@@ -573,0 +574,0 @@ type: 'object',

lib/index.d.ts

@@ -5,2 +5,2 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema';
 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';

lib/index.js

@@ -17,3 +17,3 @@ "use strict";
 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");
@@ -30,2 +30,3 @@ Object.defineProperty(exports, "rbacConfigSchema", { enumerable: true, get: function () { return root_config_schema_1.rbacConfigSchema; } });
 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; } });
@@ -32,0 +33,0 @@ Object.defineProperty(exports, "REDOCLY_TEAMS_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_TEAMS_RBAC; } });

lib/redoc-config-schema.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.redocConfigSchema = void 0;
+const feedback_config_schema_1 = require("./feedback-config-schema");
 const codeSamplesConfigSchema = {
@@ -75,69 +76,3 @@ type: 'object',
         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' },
@@ -144,0 +79,0 @@ oAuth2RedirectURI: { type: 'string', nullable: true },

lib/root-config-schema.js

@@ -118,2 +118,8 @@ "use strict";
 };
+const rulesSchema = {
+    type: 'object',
+    additionalProperties: {
+        oneOf: [{ type: 'string' }, { type: 'object' }],
+    },
+};
 exports.apiConfigSchema = {
@@ -135,3 +141,3 @@ type: 'object',
         metadata: { type: 'object', additionalProperties: true },
-        rules: { type: 'object', additionalProperties: true },
+        rules: rulesSchema,
         decorators: { type: 'object', additionalProperties: true },
@@ -326,8 +332,5 @@ preprocessors: { type: 'object', additionalProperties: true },
         },
-        rules: {
-            type: 'object',
-            additionalProperties: {
-                oneOf: [{ type: 'string' }, { type: 'object' }],
-            },
-        },
+        rules: rulesSchema,
+        decorators: { type: 'object', additionalProperties: true },
+        preprocessors: { type: 'object', additionalProperties: true },
         ssoOnPrem: exports.ssoOnPremConfigSchema,
@@ -334,0 +337,0 @@ sso: exports.ssoConfigSchema,

lib/types.d.ts

@@ -5,2 +5,3 @@ import type { FromSchema } from 'json-schema-to-ts';
 import type { RedocConfigTypes } from './redoc-types';
+import type { GraphQLConfigTypes } from './graphql-types';
 /**
@@ -11,2 +12,3 @@ * Theme
 export type RedocConfig = RedocConfigTypes;
+export type GraphQLConfig = GraphQLConfigTypes;
 export type ProductConfig = FromSchema<typeof productConfigSchema>;
@@ -13,0 +15,0 @@ export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;

package.json

 {
   "name": "@redocly/config",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "license": "MIT",
@@ -11,2 +11,3 @@ "main": "./lib/index.js",
     "@types/react": "18.3.2",
+    "react-router-dom": "^6.21.1",
     "json-schema-to-ts": "2.7.2",
@@ -13,0 +14,0 @@ "rimraf": "5.0.5",

No alert changes

Improved metrics

Total package byte prevSize

1808237

increased by5.32%

Lines of code

36421

increased by10.11%

Worsened metrics

Dev dependency count

6

increased by20%

Number of package files

55

decreased by-31.25%

No dependency changes