@redocly/config - npm Package Compare versions

Comparing version 0.0.0-beta-20240401150337 to 0.0.0-cache-perf-20240625144418

CHANGELOG.md

 # @redocly/config
 
-## 0.0.0-beta-20240401150337
+## 0.0.0-cache-perf-20240625144418
 
+### Patch Changes
+
+- Perf and caching improvemtns
+
+## 0.6.0
+
 ### Minor Changes
 
+- 25e87a10c9: feat: Updated the product with a major UX and DX overhaul. Please, see the detailed [release notes](./realm-redesign-release-notes.md).
+
+## 0.5.0
+
+### Minor Changes
+
+- 54176a140b: feat: Added the ability to enable fuzzy search. By default, it is set to `false`.
+  See [Search](/reference/theme/search.md) in the documentation for more information.
+
+## 0.4.0
+
+### Minor Changes
+
+- 0224aa5995: feat(bh): Added reunite config section.
+
+## 0.3.0
+
+### Minor Changes
+
+- 6380e0d826: feat: Added the `removeAttribution` configuration option for the Enterprise plan users. See [Remove attribution](/config/remove-attribution.md) in the documentation for more information.
+
+## 0.2.0
+
+### Minor Changes
+
 - 8dbb3d3b1f: feat: Added the ability to configure feedback on a per-product basis for multi-product projects. See the [Add multiple products](/author/how-to/multiple-products.md) page for details.
@@ -8,0 +39,0 @@

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

@@ -0,1 +1,2 @@
+import { redocConfigSchema } from './redoc-config-schema';
 const logoConfigSchema = {
@@ -284,3 +285,7 @@ type: 'object',
     properties: {
-        type: { type: 'string', enum: ['select', 'checkboxes', 'date-range'] },
+        type: {
+            type: 'string',
+            enum: ['select', 'checkboxes', 'date-range'],
+            default: 'checkboxes',
+        },
         title: { type: 'string' },
@@ -492,2 +497,5 @@ titleTranslationKey: { type: 'string' },
                     items: suggestedPageSchema,
+                }, fuzzy: {
+                    type: 'boolean',
+                    default: false,
                 } }, hideConfigSchema.properties),
@@ -559,3 +567,3 @@ additionalProperties: false,
         markdown: markdownConfigSchema,
-        openapi: { type: 'object', additionalProperties: true },
+        openapi: redocConfigSchema,
         graphql: { type: 'object', additionalProperties: true },
@@ -590,3 +598,3 @@ analytics: {
                     default: [],
-                } }, hideConfigSchema.properties),
+                }, hideLoginButton: { type: 'boolean' } }, hideConfigSchema.properties),
             additionalProperties: false,
@@ -653,2 +661,3 @@ default: {},
 export const productConfigOverrideSchema = {
+    $id: 'product-config-override',
     type: 'object',
@@ -655,0 +664,0 @@ properties: {

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

@@ -39,2 +39,3 @@ import type { Node } from '@markdoc/markdoc/dist/src/types';
     versionFolderId?: string;
+    badges?: ItemBadge[];
     httpVerb?: string;
@@ -45,2 +46,3 @@ separatorLine?: boolean;
     active?: boolean;
+    deprecated?: boolean;
     icon?: string;
@@ -56,2 +58,7 @@ srcSet?: string;
 };
+export type ItemBadge = {
+    name: string;
+    color?: string;
+    position?: 'before' | 'after';
+};
 export type ResolvedNavGroupItem = {
@@ -178,2 +185,3 @@ type: 'group';
     logoutDisabled?: boolean;
+    teams?: string[];
 };
@@ -183,2 +191,3 @@ export interface PageData {
     redirectTo?: string;
+    slug: string;
     sharedDataIds: Record<string, string>;
@@ -230,3 +239,2 @@ props: PageProps;
     active: boolean;
-    notExists?: boolean;
     folderId: string;
@@ -263,3 +271,3 @@ [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
 };
-export type MenuStyle = 'drilldown';
+export type MenuStyle = 'drilldown' | 'drilldown-header';
 export type BreadcrumbItem = {
@@ -266,0 +274,0 @@ label: string;

lib-esm/root-config-schema.js

 import { DEFAULT_TEAM_CLAIM_NAME, AuthProviderType, ApigeeDevOnboardingIntegrationAuthType, } from './constants';
 import { themeConfigSchema } from './default-theme-config-schema';
+import { removePropertyRecursively } from './remove-property-recursively';
+import { reuniteConfigSchema } from './reunite-config-schema';
 export const oidcIssuerMetadataSchema = {
@@ -319,2 +321,8 @@ type: 'object',
         },
+        rules: {
+            type: 'object',
+            additionalProperties: {
+                oneOf: [{ type: 'string' }, { type: 'object' }],
+            },
+        },
         ssoOnPrem: ssoOnPremConfigSchema,
@@ -324,2 +332,3 @@ sso: ssoConfigSchema,
         developerOnboarding: devOnboardingConfigSchema,
+        removeAttribution: { type: 'boolean' },
         i18n: i18ConfigSchema,
@@ -334,2 +343,3 @@ metadata: metadataConfigSchema,
         theme: themeConfigSchema,
+        reunite: reuniteConfigSchema,
     },
@@ -339,4 +349,4 @@ default: { redirects: {} },
 };
-const environmentSchema = Object.assign(Object.assign({}, redoclyConfigSchema), { additionalProperties: false });
-export const rootRedoclyConfigSchema = Object.assign(Object.assign({}, redoclyConfigSchema), { properties: Object.assign(Object.assign({ plugins: {
+const environmentSchema = Object.assign(Object.assign({}, removePropertyRecursively(redoclyConfigSchema, 'default')), { additionalProperties: false });
+export const rootRedoclyConfigSchema = Object.assign(Object.assign({ $id: 'root-redocly-config' }, redoclyConfigSchema), { properties: Object.assign(Object.assign({ plugins: {
             type: 'array',
@@ -343,0 +353,0 @@ items: { type: 'string' },

lib-esm/types.d.ts

 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';
 /**
@@ -8,2 +9,3 @@ * Theme
 export type ThemeConfig = FromSchema<typeof themeConfigSchema>;
+export type RedocConfig = RedocConfigTypes;
 export type ProductConfig = FromSchema<typeof productConfigSchema>;
@@ -10,0 +12,0 @@ export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;

lib/default-theme-config-schema.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = exports.themeConfigSchema = exports.catalogSchema = exports.scorecardConfigSchema = exports.catalogFilterSchema = exports.productConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.markdownConfigSchema = void 0;
+const redoc_config_schema_1 = require("./redoc-config-schema");
 const logoConfigSchema = {
@@ -287,3 +288,7 @@ type: 'object',
     properties: {
-        type: { type: 'string', enum: ['select', 'checkboxes', 'date-range'] },
+        type: {
+            type: 'string',
+            enum: ['select', 'checkboxes', 'date-range'],
+            default: 'checkboxes',
+        },
         title: { type: 'string' },
@@ -495,2 +500,5 @@ titleTranslationKey: { type: 'string' },
                     items: suggestedPageSchema,
+                }, fuzzy: {
+                    type: 'boolean',
+                    default: false,
                 } }, hideConfigSchema.properties),
@@ -562,3 +570,3 @@ additionalProperties: false,
         markdown: exports.markdownConfigSchema,
-        openapi: { type: 'object', additionalProperties: true },
+        openapi: redoc_config_schema_1.redocConfigSchema,
         graphql: { type: 'object', additionalProperties: true },
@@ -593,3 +601,3 @@ analytics: {
                     default: [],
-                } }, hideConfigSchema.properties),
+                }, hideLoginButton: { type: 'boolean' } }, hideConfigSchema.properties),
             additionalProperties: false,
@@ -656,2 +664,3 @@ default: {},
 exports.productConfigOverrideSchema = {
+    $id: 'product-config-override',
     type: 'object',
@@ -658,0 +667,0 @@ properties: {

lib/portal-shared-types.d.ts

@@ -39,2 +39,3 @@ import type { Node } from '@markdoc/markdoc/dist/src/types';
     versionFolderId?: string;
+    badges?: ItemBadge[];
     httpVerb?: string;
@@ -45,2 +46,3 @@ separatorLine?: boolean;
     active?: boolean;
+    deprecated?: boolean;
     icon?: string;
@@ -56,2 +58,7 @@ srcSet?: string;
 };
+export type ItemBadge = {
+    name: string;
+    color?: string;
+    position?: 'before' | 'after';
+};
 export type ResolvedNavGroupItem = {
@@ -178,2 +185,3 @@ type: 'group';
     logoutDisabled?: boolean;
+    teams?: string[];
 };
@@ -183,2 +191,3 @@ export interface PageData {
     redirectTo?: string;
+    slug: string;
     sharedDataIds: Record<string, string>;
@@ -230,3 +239,2 @@ props: PageProps;
     active: boolean;
-    notExists?: boolean;
     folderId: string;
@@ -263,3 +271,3 @@ [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
 };
-export type MenuStyle = 'drilldown';
+export type MenuStyle = 'drilldown' | 'drilldown-header';
 export type BreadcrumbItem = {
@@ -266,0 +274,0 @@ label: string;

lib/root-config-schema.js

@@ -6,2 +6,4 @@ "use strict";
 const default_theme_config_schema_1 = require("./default-theme-config-schema");
+const remove_property_recursively_1 = require("./remove-property-recursively");
+const reunite_config_schema_1 = require("./reunite-config-schema");
 exports.oidcIssuerMetadataSchema = {
@@ -323,2 +325,8 @@ type: 'object',
         },
+        rules: {
+            type: 'object',
+            additionalProperties: {
+                oneOf: [{ type: 'string' }, { type: 'object' }],
+            },
+        },
         ssoOnPrem: exports.ssoOnPremConfigSchema,
@@ -328,2 +336,3 @@ sso: exports.ssoConfigSchema,
         developerOnboarding: devOnboardingConfigSchema,
+        removeAttribution: { type: 'boolean' },
         i18n: exports.i18ConfigSchema,
@@ -338,2 +347,3 @@ metadata: metadataConfigSchema,
         theme: default_theme_config_schema_1.themeConfigSchema,
+        reunite: reunite_config_schema_1.reuniteConfigSchema,
     },
@@ -343,4 +353,4 @@ default: { redirects: {} },
 };
-const environmentSchema = Object.assign(Object.assign({}, exports.redoclyConfigSchema), { additionalProperties: false });
-exports.rootRedoclyConfigSchema = Object.assign(Object.assign({}, exports.redoclyConfigSchema), { properties: Object.assign(Object.assign({ plugins: {
+const environmentSchema = Object.assign(Object.assign({}, (0, remove_property_recursively_1.removePropertyRecursively)(exports.redoclyConfigSchema, 'default')), { additionalProperties: false });
+exports.rootRedoclyConfigSchema = Object.assign(Object.assign({ $id: 'root-redocly-config' }, exports.redoclyConfigSchema), { properties: Object.assign(Object.assign({ plugins: {
             type: 'array',
@@ -347,0 +357,0 @@ items: { type: 'string' },

lib/types.d.ts

 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';
 /**
@@ -8,2 +9,3 @@ * Theme
 export type ThemeConfig = FromSchema<typeof themeConfigSchema>;
+export type RedocConfig = RedocConfigTypes;
 export type ProductConfig = FromSchema<typeof productConfigSchema>;
@@ -10,0 +12,0 @@ export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;

package.json

 {
   "name": "@redocly/config",
-  "version": "0.0.0-beta-20240401150337",
+  "version": "0.0.0-cache-perf-20240625144418",
   "license": "MIT",
@@ -8,7 +8,7 @@ "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
-  "dependencies": {},
   "devDependencies": {
+    "@markdoc/markdoc": "0.4.0",
+    "@types/react": "18.3.2",
+    "json-schema-to-ts": "2.7.2",
     "rimraf": "5.0.5",
-    "json-schema-to-ts": "2.7.2",
-    "@markdoc/markdoc": "0.4.0",
     "typescript": "5.2.2"
@@ -15,0 +15,0 @@ },

src/default-theme-config-schema.ts

@@ -0,1 +1,3 @@
+import { redocConfigSchema } from './redoc-config-schema';
+
 const logoConfigSchema = {
@@ -324,3 +326,7 @@ type: 'object',
   properties: {
-    type: { type: 'string', enum: ['select', 'checkboxes', 'date-range'] },
+    type: {
+      type: 'string',
+      enum: ['select', 'checkboxes', 'date-range'],
+      default: 'checkboxes',
+    },
     title: { type: 'string' },
@@ -557,2 +563,6 @@ titleTranslationKey: { type: 'string' },
         },
+        fuzzy: {
+          type: 'boolean',
+          default: false,
+        },
         ...hideConfigSchema.properties,
@@ -646,3 +656,3 @@ },
     markdown: markdownConfigSchema,
-    openapi: { type: 'object', additionalProperties: true }, // TODO: put the real schema here @Viacheslav
+    openapi: redocConfigSchema,
     graphql: { type: 'object', additionalProperties: true },
@@ -679,2 +689,3 @@ analytics: {
         },
+        hideLoginButton: { type: 'boolean' },
         ...hideConfigSchema.properties,
@@ -745,2 +756,3 @@ },
 export const productConfigOverrideSchema = {
+  $id: 'product-config-override',
   type: 'object',
@@ -747,0 +759,0 @@ properties: {

src/portal-shared-types.ts

@@ -50,2 +50,3 @@ import type { Node } from '@markdoc/markdoc/dist/src/types';
 
+  badges?: ItemBadge[];
   httpVerb?: string;
@@ -56,2 +57,3 @@ separatorLine?: boolean;
   active?: boolean;
+  deprecated?: boolean;
   icon?: string;
@@ -69,2 +71,8 @@ srcSet?: string;
 
+export type ItemBadge = {
+  name: string;
+  color?: string;
+  position?: 'before' | 'after';
+};
+
 export type ResolvedNavGroupItem = {
@@ -209,2 +217,3 @@ type: 'group';
   logoutDisabled?: boolean;
+  teams?: string[];
 };
@@ -215,2 +224,3 @@
   redirectTo?: string;
+  slug: string;
   sharedDataIds: Record<string, string>;
@@ -263,3 +273,2 @@ props: PageProps;
   active: boolean;
-  notExists?: boolean;
   folderId: string;
@@ -308,3 +317,3 @@ [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
 
-export type MenuStyle = 'drilldown';
+export type MenuStyle = 'drilldown' | 'drilldown-header';
 
@@ -311,0 +320,0 @@ export type BreadcrumbItem = {

src/root-config-schema.ts

@@ -7,2 +7,4 @@ import {
 import { themeConfigSchema } from './default-theme-config-schema';
+import { removePropertyRecursively } from './remove-property-recursively';
+import { reuniteConfigSchema } from './reunite-config-schema';
 
@@ -355,2 +357,8 @@ export const oidcIssuerMetadataSchema = {
     },
+    rules: {
+      type: 'object',
+      additionalProperties: {
+        oneOf: [{ type: 'string' }, { type: 'object' }],
+      },
+    },
     ssoOnPrem: ssoOnPremConfigSchema,
@@ -360,2 +368,3 @@ sso: ssoConfigSchema,
     developerOnboarding: devOnboardingConfigSchema,
+    removeAttribution: { type: 'boolean' },
     i18n: i18ConfigSchema,
@@ -370,2 +379,3 @@ metadata: metadataConfigSchema,
     theme: themeConfigSchema,
+    reunite: reuniteConfigSchema,
   },
@@ -377,3 +387,5 @@ default: { redirects: {} },
 const environmentSchema = {
-  ...redoclyConfigSchema,
+  // We don't want to populate the env override with defaults
+  // Because during merge, defaults can override values from the root config
+  ...removePropertyRecursively(redoclyConfigSchema, 'default'),
   additionalProperties: false,
@@ -383,2 +395,3 @@ } as const;
 export const rootRedoclyConfigSchema = {
+  $id: 'root-redocly-config',
   ...redoclyConfigSchema,
@@ -385,0 +398,0 @@ properties: {

src/types.ts

@@ -38,2 +38,3 @@ import type { FromSchema } from 'json-schema-to-ts';
 } from './root-config-schema';
+import type { RedocConfigTypes } from './redoc-types';
 
@@ -45,2 +46,3 @@ /**
 export type ThemeConfig = FromSchema<typeof themeConfigSchema>;
+export type RedocConfig = RedocConfigTypes;
 export type ProductConfig = FromSchema<typeof productConfigSchema>;
@@ -47,0 +49,0 @@ export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;

New alerts

Unstable ownership

Supply chain risk

A new collaborator has begun publishing package versions. Package stability and security risk may be elevated.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1717444

increased by17.97%

Number of package files

80

increased by53.85%

Lines of code

33081

increased by20.02%

Worsened metrics

Dev dependency count

5

increased by25%

Number of high supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes