@redocly/config 0.50.1 → 0.51.0

package/lib-esm/types/index.d.ts

@@ -2,3 +2,4 @@ export * from './api-functions-types.js';
 export * from './config-types.js';
 export * from './portal-shared-types.js';
 export * from './catalog-entity-types.js';
+export * from './json-schema-types.js';

package/lib-esm/types/json-schema-types.d.ts

@@ -0,0 +1,69 @@
+/**
+ * This type is a subset of JSON Schema that aligns with [json-schema-adapter](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/types/json-schema-adapter.ts)
+ * which translates JSON Schema to the Redocly CLI's internal NodeType tree format.
+ *
+ * */
+export type RedoclyConfigJSONSchema = Base & (SchemaObject | SchemaArray | SchemaString | SchemaNumber | SchemaBoolean | SchemaOneOf);
+type Base = {
+    $id?: string;
+    type?: Type;
+    description?: string;
+    /** Redocly extension: link to the option's documentation page. */
+    documentationLink?: string;
+    /** Redocly extension: overrides the generated `NodeType` name. */
+    nodeTypeName?: string;
+    /** @deprecated Not supported by the `NodeType` adapter; avoid in new schemas. */
+    not?: any;
+};
+type Type = 'object' | 'array' | 'string' | 'number' | 'integer' | 'boolean';
+type SchemaObject = {
+    type: 'object';
+    properties?: Record<string, RedoclyConfigJSONSchema>;
+    additionalProperties?: boolean | RedoclyConfigJSONSchema;
+    unevaluatedProperties?: boolean | RedoclyConfigJSONSchema;
+    patternProperties?: Record<string, RedoclyConfigJSONSchema>;
+    required?: readonly string[];
+} & SchemaOneOfFragment;
+type SchemaArray = {
+    type: 'array';
+    items?: RedoclyConfigJSONSchema;
+    minItems?: number;
+    /** @deprecated Not supported by the `NodeType` adapter; avoid in new schemas. */
+    uniqueItems?: boolean;
+};
+type SchemaString = {
+    type: 'string';
+    pattern?: string;
+    minLength?: number;
+    maxLength?: number;
+    format?: 'uri' | 'email' | 'date-time';
+    enum?: readonly (string | number | boolean | null)[];
+    const?: string | number | boolean | null;
+};
+type SchemaNumber = {
+    type: 'number' | 'integer';
+    minimum?: number;
+};
+type SchemaBoolean = {
+    type: 'boolean';
+};
+/** A standalone `oneOf` schema whose branches are full schemas. */
+type SchemaOneOf = {
+    oneOf: readonly RedoclyConfigJSONSchema[];
+    discriminator?: {
+        propertyName: string;
+        mapping?: Record<string, RedoclyConfigJSONSchema>;
+    };
+};
+/** A `oneOf` inside an object schema; branches only narrow `required`. */
+type SchemaOneOfFragment = {
+    oneOf?: readonly SchemaObjectFragment[];
+    discriminator?: {
+        propertyName: string;
+        mapping?: Record<string, RedoclyConfigJSONSchema>;
+    };
+};
+type SchemaObjectFragment = {
+    required: readonly string[];
+};
+export {};

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

@@ -1,7 +1,9 @@
 import type { Node } from '@markdoc/markdoc/dist/src/types';
+import type { FromSchema } from 'json-schema-to-ts';
 import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../constants/shared.js';
 import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig, BannerConfig } from './config-types.js';
 import type { CatalogEntityConfig } from './catalog-entity-types.js';
+import type { searchConfigSchema } from '../ex-theme-config-schemas.js';
 export * from './code-walkthrough-types.js';
 export type UiAccessibleConfig = Pick<RedoclyConfig, 'logo' | 'navbar' | 'products' | 'footer' | 'sidebar' | 'scripts' | 'links' | 'feedback' | 'search' | 'aiAssistant' | 'colorMode' | 'palette' | 'navigation' | 'codeSnippet' | 'markdown' | 'openapi' | 'graphql' | 'analytics' | 'userMenu' | 'versionPicker' | 'breadcrumbs' | 'catalog' | 'scorecard' | 'scorecards' | 'scorecardClassic' | 'entitiesCatalog' | 'mcp'> & {
     auth?: {
@@ -334,3 +336,4 @@ export type ProductUiConfig = ProductConfig & {
     };
     configOverride?: ProductThemeOverrideConfig;
 };
+export type SearchEngineType = NonNullable<FromSchema<typeof searchConfigSchema>['engine']>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/config",
-  "version": "0.50.1",
+  "version": "0.51.0",
   "license": "MIT",
   "type": "module",
   "main": "./lib/index.js",

package/lib/remove-property-recursively.d.ts

@@ -1,5 +0,0 @@
-type Removed<T, Drop> = T extends Record<string, any> ? T extends ArrayLike<any> ? Array<Removed<T[number], Drop>> : {
-    [K in Exclude<keyof T, Drop>]: Removed<T[K], Drop>;
-} : T;
-export declare function removePropertyRecursively<TObject extends object, TProp extends string>(object: TObject, propToRemove: TProp, parentKey?: string): Removed<TObject, TProp>;
-export {};

package/lib-esm/remove-property-recursively.d.ts

@@ -1,5 +0,0 @@
-type Removed<T, Drop> = T extends Record<string, any> ? T extends ArrayLike<any> ? Array<Removed<T[number], Drop>> : {
-    [K in Exclude<keyof T, Drop>]: Removed<T[K], Drop>;
-} : T;
-export declare function removePropertyRecursively<TObject extends object, TProp extends string>(object: TObject, propToRemove: TProp, parentKey?: string): Removed<TObject, TProp>;
-export {};