@redocly/config 0.6.0 → 0.6.2

package/src/index.ts

@@ -1,14 +0,0 @@
-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';

package/src/portal-shared-types.ts

@@ -1,330 +0,0 @@
-import type { Node } from '@markdoc/markdoc/dist/src/types';
-import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from './constants';
-import type {
-  ProductConfig,
-  ProductGoogleAnalyticsConfig,
-  RbacScopeItems,
-  SeoConfig,
-  ThemeConfig,
-} from './types';
-
-export type ThemeUIConfig = ThemeConfig & {
-  auth?: {
-    // used by portal dev login emulator
-    idpsInfo?: {
-      idpId: string;
-      type: string; // AuthProviderType
-      title: string | undefined;
-    }[];
-    devLogin?: boolean;
-    loginUrls?: Record<string, string>;
-  };
-  search?: {
-    shortcuts?: string[];
-    suggestedPages?: any[];
-  };
-  breadcrumbs?: {
-    prefixItems?: ResolvedNavLinkItem[];
-  };
-  products?: {
-    [key: string]: ProductUiConfig;
-  };
-};
-
-export type ResolvedNavLinkItem = {
-  type: 'link';
-  fsPath?: string;
-  metadata?: Record<string, unknown>;
-  link: string;
-  label: string;
-  labelTranslationKey?: string;
-  items?: ResolvedNavItem[];
-  sidebar?: ResolvedNavItem[]; // for API catalog it contains the corresponding sidebar first item
-  external?: boolean;
-  target?: '_self' | '_blank';
-
-  version?: string;
-  isDefault?: boolean;
-  versionFolderId?: string;
-
-  badges?: ItemBadge[];
-  httpVerb?: string;
-  separatorLine?: boolean;
-  linePosition?: 'top' | 'bottom';
-  routeSlug?: string;
-  active?: boolean;
-  deprecated?: boolean;
-  icon?: string;
-  srcSet?: string;
-  [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
-  [REDOCLY_ROUTE_RBAC]?: {
-    slug?: string;
-    fsPath?: string;
-  };
-
-  linkedSidebars?: string[];
-  languageInsensitive?: boolean;
-};
-
-export type ItemBadge = {
-  name: string;
-  color?: string;
-  position?: 'before' | 'after';
-};
-
-export type ResolvedNavGroupItem = {
-  type: 'group';
-  fsPath?: string;
-  metadata?: Record<string, unknown>;
-  link?: string;
-  label?: string;
-  labelTranslationKey?: string;
-  items?: ResolvedNavItem[];
-  sidebar?: ResolvedNavItem[]; // for API catalog it contains the corresponding sidebar first item
-  external?: boolean;
-  target?: '_self' | '_blank';
-  expanded?: string;
-  selectFirstItemOnExpand?: boolean;
-
-  version?: string;
-  isDefault?: boolean;
-  versionFolderId?: string;
-
-  menuStyle?: MenuStyle;
-  separatorLine?: boolean;
-  linePosition?: 'top' | 'bottom';
-  routeSlug?: string;
-  active?: boolean;
-  icon?: string;
-  srcSet?: string;
-  [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
-  [REDOCLY_ROUTE_RBAC]?: {
-    slug?: string;
-    fsPath?: string;
-  };
-
-  linkedSidebars?: string[];
-  languageInsensitive?: boolean;
-};
-
-export type ResolvedNavItem =
-  | ResolvedNavLinkItem
-  | ResolvedNavGroupItem
-  | {
-      type: 'separator';
-      fsPath?: never;
-      metadata?: Record<string, unknown>;
-      label?: string;
-      labelTranslationKey?: string;
-      routeSlug?: never;
-
-      version?: string;
-      isDefault?: boolean;
-      versionFolderId?: string;
-
-      variant?: 'primary' | 'secondary';
-      separatorLine?: boolean;
-      linePosition?: 'top' | 'bottom';
-      link?: undefined;
-      items?: ResolvedNavItem[]; // for typescript
-      sidebar?: ResolvedNavItem[]; // for typescript
-      linkedSidebars?: string[]; // for typescript
-      icon?: string; // for typescript
-      srcSet?: string; // for typescript
-      languageInsensitive?: boolean; // for typescript
-      [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
-      [REDOCLY_ROUTE_RBAC]?: {
-        slug?: string;
-        fsPath?: string;
-      };
-    }
-  | {
-      type: 'error';
-
-      fsPath?: never;
-      version?: string;
-      isDefault?: boolean;
-      versionFolderId?: string;
-      metadata?: Record<string, unknown>;
-      routeSlug?: never;
-
-      label: string;
-      labelTranslationKey?: string;
-      link?: undefined;
-      items?: ResolvedNavItem[]; // for typescript
-      sidebar?: ResolvedNavItem[]; // for typescript
-      linkedSidebars?: string[]; // for typescript
-      icon?: string; // for typescript
-      srcSet?: string; // for typescript
-      languageInsensitive?: boolean; // for typescript
-      [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
-      [REDOCLY_ROUTE_RBAC]?: {
-        slug?: string;
-        fsPath?: string;
-      };
-    };
-
-export type ResolvedNavItemWithLink = (ResolvedNavLinkItem | ResolvedNavGroupItem) & {
-  link: string;
-};
-
-export type ResolvedSidebar = {
-  relatedNavbarItem?: BreadcrumbItem;
-  items: ResolvedNavItem[];
-};
-
-export interface PageProps {
-  metadata?: Record<string, unknown>;
-  seo?: SeoConfig;
-  frontmatter?: Omit<PageProps, 'frontmatter'> & {
-    theme?: any;
-    settings?: any;
-  };
-  disableAutoScroll?: boolean;
-  lastModified?: string | null;
-  [k: string]: unknown;
-  dynamicMarkdocComponents?: string[];
-  markdown?: MdOptions;
-  openapiOptions?: OpenAPIOptions;
-  definitionId?: string;
-  variables?: {
-    lang?: string;
-    rbac?: {
-      teams: string[];
-    };
-  };
-}
-
-export interface MdOptions {
-  partials: Record<string, Node>;
-  variables?: Record<string, any>;
-}
-
-export interface PageStaticData {
-  props?: PageProps;
-  [k: string]: unknown;
-}
-
-export type UserData = {
-  isAuthenticated: boolean;
-  name: string;
-  email?: string;
-  picture: string;
-  logoutDisabled?: boolean;
-  teams?: string[];
-};
-
-export interface PageData {
-  templateId: string;
-  redirectTo?: string;
-  slug: string;
-  sharedDataIds: Record<string, string>;
-  props: PageProps;
-  versions?: Version[];
-  userData: UserData;
-}
-
-export type NavItem = {
-  page?: string;
-  directory?: string;
-  group?: string;
-  groupTranslationKey?: string;
-  label?: string;
-  labelTranslationKey?: string;
-  href?: string;
-  items?: NavItem[];
-  separator?: string;
-  separatorTranslationKey?: string;
-  separatorLine?: boolean;
-  linePosition?: 'top' | 'bottom';
-  version?: string;
-  menuStyle?: MenuStyle;
-  external?: boolean;
-  target?: '_self' | '_blank';
-  expanded?: boolean | 'always';
-  selectFirstItemOnExpand?: boolean;
-  flatten?: boolean; // for API catalog only
-  icon?: string | { srcSet: string };
-  rbac?: RbacScopeItems;
-  linkedSidebars?: string[];
-  $ref?: string;
-  disconnect?: boolean;
-};
-
-export interface LogoConfig {
-  image?: string;
-  srcSet?: string;
-  altText?: string;
-  link?: string;
-  favicon?: string;
-}
-
-export type Version = {
-  version: string;
-  label: string;
-  link: string;
-  default: boolean;
-  active: boolean;
-  notExists?: boolean;
-  folderId: string;
-  [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
-  [REDOCLY_ROUTE_RBAC]?: {
-    slug?: string;
-    fsPath?: string;
-  };
-};
-
-export type VersionConfigItem = {
-  version: string;
-  name?: string;
-};
-
-export type VersionsConfigType = {
-  versions: VersionConfigItem[];
-  default?: string;
-};
-
-export type VersionedFolderConfig = {
-  // key is a relative path to file inside of a versioned folder, value is an array of versions
-  versionedFiles: Map<string, Set<string>>;
-
-  defaultVersion?: string;
-  versions: VersionConfigItem[];
-  hasVersionsConfig?: boolean; // if versions.yaml file exists
-};
-
-export type NavGroup = ResolvedNavItem[] | undefined | string | boolean | number;
-
-export type NavGroupRecord = Record<string, NavGroup>;
-
-export type ResolvedConfigLinks = NavGroup | NavGroupRecord;
-
-export type RawNavConfigItem = NavItem | NavItem[] | string | undefined | boolean | number;
-
-export type RawNavConfig = RawNavConfigItem | Record<string, RawNavConfigItem>;
-
-export type OpenAPIOptions = {
-  showRightPanelToggle?: boolean;
-  layout?: LayoutVariant;
-  collapsedSidebar?: boolean;
-};
-
-export type MenuStyle = 'drilldown' | 'drilldown-header';
-
-export type BreadcrumbItem = {
-  label: string;
-  link?: string;
-};
-
-export type ProductThemeOverrideConfig = Pick<
-  ThemeUIConfig,
-  'logo' | 'navbar' | 'footer' | 'sidebar' | 'search' | 'codeSnippet' | 'breadcrumbs' | 'feedback'
-> & { analytics?: { ga?: ProductGoogleAnalyticsConfig } };
-
-export type ProductUiConfig = ProductConfig & {
-  slug: string;
-  link: string;
-  [REDOCLY_TEAMS_RBAC]?: { [key: string]: string };
-  [REDOCLY_ROUTE_RBAC]?: { [key: string]: string };
-  themeOverride?: ProductThemeOverrideConfig;
-};

package/src/redoc-config-schema.ts

@@ -1,183 +0,0 @@
-const codeSamplesConfigSchema = {
-  type: 'object',
-  properties: {
-    languages: {
-      type: 'array',
-      items: {
-        type: 'object',
-        properties: {
-          lang: {
-            type: 'string',
-            enum: [
-              'curl',
-              'JavaScript',
-              'Node.js',
-              'Python',
-              'Java8+Apache',
-              'Java',
-              'C#',
-              'C#+Newtonsoft',
-              'PHP',
-              'Go',
-              'Ruby',
-              'R',
-              'Payload',
-            ],
-          },
-          label: { type: 'string' },
-          options: {
-            type: 'object',
-            properties: {
-              indent: { type: 'string' },
-              withImports: { type: 'boolean' },
-              withComments: { type: 'boolean' },
-              binary: { type: 'boolean' },
-              credentials: {
-                type: 'string',
-                enum: ['omit', 'same-origin', 'include'],
-              },
-            },
-            additionalProperties: false,
-          },
-        },
-        required: ['lang'],
-        additionalProperties: false,
-      },
-    },
-    skipOptionalParameters: { type: 'boolean' },
-    withOAuth2Call: { type: 'boolean' },
-  },
-  required: ['languages'],
-  additionalProperties: false,
-} as const;
-
-const downloadUrlsSchema = {
-  type: 'array',
-  items: {
-    type: 'object',
-    properties: {
-      title: { type: 'string' },
-      url: { type: 'string' },
-    },
-    required: ['url'],
-    additionalProperties: false,
-  },
-} as const;
-
-export const redocConfigSchema = {
-  type: 'object',
-  properties: {
-    licenseKey: { type: 'string' },
-    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,
-    },
-    hideReplay: { type: 'boolean' },
-    oAuth2RedirectURI: { type: 'string', nullable: true },
-    corsProxyUrl: { type: 'string' },
-    sortRequiredPropsFirst: { type: 'boolean' },
-    sanitize: { type: 'boolean' },
-    hideDownloadButtons: { type: 'boolean' },
-    downloadUrls: downloadUrlsSchema,
-    onlyRequiredInSamples: { type: 'boolean' },
-    generatedSamplesMaxDepth: { oneOf: [{ type: 'number' }, { type: 'string' }] },
-    showExtensions: {
-      oneOf: [
-        { type: 'boolean' },
-        { type: 'string' },
-        { type: 'array', items: { type: 'string' } },
-      ],
-    },
-    hideSchemaTitles: { type: 'boolean' },
-    jsonSamplesExpandLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
-    schemasExpansionLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
-    mockServer: {
-      type: 'object',
-      properties: {
-        url: { type: 'string' },
-        position: { enum: ['first', 'last', 'replace', 'off'] },
-        description: { type: 'string' },
-      },
-    },
-    maxDisplayedEnumValues: { type: 'number' },
-    schemaDefinitionsTagName: { type: 'string' },
-    layout: { type: 'string', enum: ['stacked', 'three-panel'] },
-    hideInfoMetadata: { type: 'boolean' },
-    events: { type: 'object' },
-    skipBundle: { type: 'boolean' },
-    routingBasePath: { type: 'string' },
-    codeSamples: codeSamplesConfigSchema,
-    ignoreNamedSchemas: {
-      oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }],
-    },
-    hidePropertiesPrefix: { type: 'boolean' },
-    excludeFromSearch: { type: 'boolean' },
-  },
-  additionalProperties: false,
-} as const;

package/src/redoc-types.ts

@@ -1,80 +0,0 @@
-import type { ReactElement, ComponentType } from 'react';
-import type { FromSchema } from 'json-schema-to-ts';
-import type { Schema, ConfigFunction } from '@markdoc/markdoc/dist/src/types';
-import type { redocConfigSchema } from './redoc-config-schema';
-
-export type RedocConfigTypes = FromSchema<typeof redocConfigSchema> & {
-  markdocOptions?: {
-    tags: Record<string, Schema>;
-    nodes: Record<string, Schema>;
-    components: Record<string, ComponentType>;
-    variables?: Record<string, any>;
-    partials?: Record<string, any>;
-    functions?: Record<string, ConfigFunction>;
-  };
-  onDeepLinkClick?: ((link: string) => void) | undefined | null;
-  unstable_hooks?: HooksConfig;
-  requestInterceptor?: ((req: Request, operation: OperationModel) => void) | undefined | null;
-  unstable_externalCodeSamples?: Unstable_ExternalCodeSample[];
-  scrollYOffset?: number | string | (() => number);
-};
-
-type HooksConfig = {
-  AfterApiTitle?: HookConfig<{ info: OpenAPIInfo }>;
-  BeforeOperation?: HookConfig<{ operation: OperationModel }>;
-  BeforeOperationSummary?: HookConfig<{ operation: OperationModel }>;
-  AfterOperationSummary?: HookConfig<{ operation: OperationModel }>;
-  AfterOperation?: HookConfig<{ operation: OperationModel }>;
-  onInit?: (args: { store: Record<string, any> }) => void;
-  replaceSecurityLink?: (args: { securityRequirementId: string }) => string;
-  sanitize?: (raw: string) => string;
-  MiddlePanelFooter?: HookConfig<undefined>;
-  MiddlePanelHeader?: HookConfig<undefined>;
-};
-
-type OpenAPIInfo = {
-  title: string;
-  version: string;
-  description?: string;
-  summary?: string;
-  termsOfService?: string;
-  contact?: Record<string, any>;
-  license?: Record<string, any>;
-  'x-logo'?: Record<string, any>;
-  'x-metadata'?: Record<string, any>;
-  'x-seo'?: Record<string, any>;
-};
-
-type HookResult =
-  | ReactElement
-  | {
-      html: string;
-    }
-  | null;
-
-type HookConfig<T> = (props: T) => HookResult;
-
-type Unstable_ExternalCodeSample = {
-  get: (source: ExternalSource) => string;
-  lang: string;
-  label?: string;
-};
-
-type ExternalSource = {
-  sample: Unstable_ExternalCodeSample;
-  operation: OperationModel;
-  exampleName?: string;
-  pathParams?: any;
-  properties?: any;
-};
-
-type OperationModel = {
-  id: string;
-  name: string;
-  description?: string | Record<string, any>;
-  href: string;
-  pointer: string;
-  httpVerb: string;
-  deprecated: boolean;
-  path: string;
-};

package/src/remove-property-recursively.ts

@@ -1,39 +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 function removePropertyRecursively<TObject extends object, TProp extends string>(
-  object: TObject,
-  propToRemove: TProp,
-): Removed<TObject, TProp> {
-  return Object.fromEntries(
-    Object.entries(object)
-      .map(([key, value]) => {
-        if (key === propToRemove) {
-          return undefined;
-        }
-
-        if (typeof value !== 'object' || !value) {
-          return [key, value];
-        }
-
-        if (Array.isArray(value)) {
-          return [
-            key,
-            value.map((arrayItem) =>
-              typeof arrayItem === 'object'
-                ? removePropertyRecursively(arrayItem, propToRemove)
-                : arrayItem,
-            ),
-          ];
-        }
-
-        return [key, removePropertyRecursively(value as Record<string, unknown>, propToRemove)];
-      })
-      .filter(Boolean) as [string, unknown][],
-  ) as Removed<TObject, TProp>;
-}

package/src/reunite-config-schema.ts

@@ -1,7 +0,0 @@
-export const reuniteConfigSchema = {
-  type: 'object',
-  properties: {
-    ignoreLinkChecker: { type: 'boolean' },
-  },
-  additionalProperties: false,
-} as const;