redoc 2.5.4 → 3.0.0-rc.1

package/typings/RedocStandalone.d.ts

@@ -0,0 +1,36 @@
+import type { ReactElement, ReactNode } from 'react';
+import type { ApiItem, ApiStore } from './types/store.js';
+import type { ApiSpecType } from './types/common.js';
+import type { RawApiDocsOptions } from './types/options.js';
+import type { MarkdownAdapter } from './contexts/markdownAdapter.js';
+import type { RedoclyApiDocsStandaloneProps } from './RedoclyApiDocsStandalone.js';
+import type { BuildTimings } from './telemetry/index.js';
+type RedocStandaloneProps = {
+    /** Parsed API description object, or a GraphQL SDL string. */
+    spec?: Record<string, unknown> | string;
+    /** URL of the API description. Ignored when `spec` is provided. */
+    specUrl?: string;
+    options?: Partial<RawApiDocsOptions>;
+    basePath?: string;
+    logo?: RedoclyApiDocsStandaloneProps['logo'];
+    markdownAdapter?: MarkdownAdapter;
+    onLoaded?: (error?: Error) => void;
+    /** Rendered while the spec is loading. */
+    children?: ReactNode;
+};
+type PreparedApiDocs = {
+    items: ApiItem[];
+    store: ApiStore;
+    options: RawApiDocsOptions;
+    specType: ApiSpecType;
+    /** Bundled spec, or the raw SDL string for GraphQL. */
+    document?: Record<string, unknown> | string;
+    timings: BuildTimings;
+};
+declare function prepareApiDocs({ spec, specUrl, options, basePath }: Pick<RedocStandaloneProps, 'spec' | 'specUrl' | 'options' | 'basePath'>): Promise<PreparedApiDocs>;
+declare function isTelemetryDisabled(value: unknown): boolean;
+/** Loads and bundles the spec, builds the item model, and renders `RedoclyApiDocsStandalone`. */
+declare const RedocStandalone: ({ spec, specUrl, options, basePath, logo, markdownAdapter, onLoaded, children, }: RedocStandaloneProps) => ReactElement | null;
+export { RedocStandalone, prepareApiDocs, isTelemetryDisabled };
+export type { RedocStandaloneProps };
+export default RedocStandalone;

package/typings/RedoclyApiDocs.d.ts

@@ -0,0 +1,23 @@
+import { type ReactElement } from 'react';
+import type { LayoutVariant } from '@redocly/config';
+import type { ApiItem, ApiStore } from './types/store.js';
+import type { RawApiDocsOptions } from './types/options.js';
+import { type MarkdownAdapter } from './contexts/markdownAdapter.js';
+import { type InitialTelemetryContext, type RedocTelemetryConfig } from './telemetry/index.js';
+type RedoclyApiDocsInnerProps = {
+    items: ApiItem[];
+    basePath: string;
+    markdownAdapter: MarkdownAdapter;
+    telemetryConfig?: Partial<RedocTelemetryConfig>;
+    initialTelemetry?: InitialTelemetryContext;
+};
+type RedoclyApiDocsProps = RedoclyApiDocsInnerProps & {
+    store: ApiStore;
+    options: RawApiDocsOptions;
+    layout?: LayoutVariant;
+};
+declare const RedoclyApiDocsComponent: (props: RedoclyApiDocsInnerProps) => ReactElement;
+declare const RedoclyApiDocs: import("react").FC<any>;
+export { RedoclyApiDocs, RedoclyApiDocsComponent };
+export type { RedoclyApiDocsProps };
+export default RedoclyApiDocs;

package/typings/RedoclyApiDocsStandalone.d.ts

@@ -0,0 +1,22 @@
+import type { ApiItem, ApiStore } from './types/store.js';
+import type { RawApiDocsOptions } from './types/options.js';
+import type { RedocTelemetryConfig } from './telemetry/RedocTelemetry.js';
+import type { MarkdownAdapter } from './contexts/markdownAdapter.js';
+import type { RawLogo } from './types/common.js';
+import type { BuildTimings } from './telemetry/index.js';
+type RedoclyApiDocsStandaloneProps = {
+    items: ApiItem[];
+    store: ApiStore;
+    basePath: string;
+    options: RawApiDocsOptions;
+    logo?: RawLogo;
+    telemetryConfig?: Partial<RedocTelemetryConfig>;
+    markdownAdapter?: MarkdownAdapter;
+    spec?: Record<string, unknown> | string;
+    specUrl?: string;
+    buildTimings?: BuildTimings;
+};
+declare const RedoclyApiDocsStandalone: import("react").FC<any>;
+export { RedoclyApiDocsStandalone };
+export type { RedoclyApiDocsStandaloneProps };
+export default RedoclyApiDocsStandalone;

package/typings/adapters/asyncapi/build/context.d.ts

@@ -0,0 +1,9 @@
+import type { AsyncApiDefinition, AsyncApiBuildContext as BuildContext } from '../../../types/asyncapi.js';
+import type { AdapterBuildContextInput, StoreContext } from '../../../types/store.js';
+type CreateBuildContextInputWithDocument = AdapterBuildContextInput & {
+    document: AsyncApiDefinition;
+    storeCtx: StoreContext;
+    processContent?: boolean;
+};
+export declare function createBuildContext({ document, options, basePath, storeCtx, processContent }: CreateBuildContextInputWithDocument): BuildContext;
+export {};

package/typings/adapters/asyncapi/build/navigation.d.ts

@@ -0,0 +1,2 @@
+import type { ApiItem } from '../../../types/store.js';
+export declare function buildNavigationItems(): ApiItem[];

package/typings/adapters/asyncapi/build/utils.d.ts

@@ -0,0 +1,3 @@
+import type { ProtocolVariant, AsyncApiDefinition } from '../../../types/asyncapi.js';
+export declare function findFirstBinding(obj: unknown, visited?: Set<unknown>): ProtocolVariant | null;
+export declare function mapChannelToOperations(rawAsyncApiDoc: AsyncApiDefinition): Record<string, string[]>;

package/typings/adapters/asyncapi/buildContext.d.ts

@@ -0,0 +1,2 @@
+import type { AsyncApiBuildContext as BuildContext } from '../../types/asyncapi.js';
+export declare const asyncApiContext: import("../scopedContext.js").ScopedContext<BuildContext>;

package/typings/adapters/asyncapi/index.d.ts

@@ -0,0 +1,13 @@
+import type { ApiDocAdapterProps, ApiItem, ApiStore, StoreContext } from '../../types/store.js';
+import type { AsyncApiDefinition } from '../../types/asyncapi.js';
+export declare function processAsyncApiDocument(props: ApiDocAdapterProps & {
+    document: AsyncApiDefinition;
+    processContent?: boolean;
+}): {
+    items: ApiItem[];
+    store: ApiStore;
+};
+export declare function buildAsyncApiItems({ document, options, basePath, processContent }: ApiDocAdapterProps & {
+    document: AsyncApiDefinition;
+    processContent?: boolean;
+}, storeCtx: StoreContext): ApiItem[];

package/typings/adapters/asyncapi/items/channel/content.d.ts

@@ -0,0 +1,5 @@
+import type { ApiItemContent, MessageReferencesGroups } from '../../../../types/content.js';
+import type { AsyncApiChannel, AsyncApiDefinition, ProtocolVariant } from '../../../../types/asyncapi.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildMessageReferencesGroups(document: AsyncApiDefinition, messageKey: string, protocol: ProtocolVariant | null | undefined): MessageReferencesGroups;
+export declare function buildChannelContent(channelId: string, channel: AsyncApiChannel, document: AsyncApiDefinition, markdownOptions: ParseMarkdownOptions, protocol?: ProtocolVariant | null): ApiItemContent;

package/typings/adapters/asyncapi/items/channel/item.d.ts

@@ -0,0 +1,13 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { AsyncApiChannel } from '../../../../types/asyncapi.js';
+export declare function buildTaggedChannelItem({ channelId, channel, operationIds, tagName }: {
+    channelId: string;
+    channel: AsyncApiChannel;
+    operationIds: string[];
+    tagName: string;
+}): ApiItem;
+export declare function buildUntaggedChannelItem({ channelId, channel, operationIds }: {
+    channelId: string;
+    channel: AsyncApiChannel;
+    operationIds: string[];
+}): ApiItem;

package/typings/adapters/asyncapi/items/operation/content.d.ts

@@ -0,0 +1,4 @@
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { AsyncApiDefinition, AsyncApiOperation, ProtocolVariant } from '../../../../types/asyncapi.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+export declare function buildOperationContent(operationId: string, operation: AsyncApiOperation, document: AsyncApiDefinition, pageSlug: string, options: ApiDocsOptions, protocol?: ProtocolVariant | null, groupHeaderLabel?: string, showDivider?: boolean): ApiItemContent;

package/typings/adapters/asyncapi/items/operation/item.d.ts

@@ -0,0 +1,15 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { AsyncApiDefinition, AsyncApiOperation, ProtocolVariant } from '../../../../types/asyncapi.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+export declare function buildOperationItem({ operationId, operation, linkParts, channelBindings, document, options, protocol, groupHeaderLabel, processContent, showDivider }: {
+    operationId: string;
+    operation: AsyncApiOperation;
+    linkParts: string[];
+    channelBindings?: Record<string, unknown>;
+    document: AsyncApiDefinition;
+    options: ApiDocsOptions;
+    protocol?: ProtocolVariant | null;
+    groupHeaderLabel?: string;
+    processContent?: boolean;
+    showDivider?: boolean;
+}): ApiItem;

package/typings/adapters/asyncapi/items/overview/content.d.ts

@@ -0,0 +1,10 @@
+import type { AsyncApiDefinition } from '../../../../types/asyncapi.js';
+import type { ApiItemContent, ContentNode } from '../../../../types/content.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+export declare function buildOverviewContent({ document, options, protocol, sectionChildren, basePath }: {
+    document: AsyncApiDefinition;
+    options: ApiDocsOptions;
+    protocol: string | null;
+    sectionChildren: ContentNode[];
+    basePath: string;
+}): ApiItemContent;

package/typings/adapters/asyncapi/items/overview/item.d.ts

@@ -0,0 +1,16 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { ContentNode } from '../../../../types/content.js';
+import type { AsyncApiDefinition } from '../../../../types/asyncapi.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+type Options = {
+    basePath: string;
+    document: AsyncApiDefinition;
+    options: ApiDocsOptions;
+    protocol: string | null;
+    sectionChildren: ContentNode[];
+    processContent?: boolean;
+};
+export declare function buildOverviewItem(info: {
+    title?: string;
+}, options: Options): ApiItem;
+export {};

package/typings/adapters/asyncapi/panels/brokers.d.ts

@@ -0,0 +1,4 @@
+import type { AsyncApiServer } from '../../../types/asyncapi.js';
+import type { ParseMarkdownOptions } from '../../utils/parseMarkdown.js';
+import { type BrokersNode } from '../../../types/content.js';
+export declare function buildBrokersPanelContent(servers: Record<string, AsyncApiServer>, protocol: string | null, markdownOptions: ParseMarkdownOptions): BrokersNode;

package/typings/adapters/asyncapi/panels/download.d.ts

@@ -0,0 +1,3 @@
+import type { DownloadNode } from '../../../types/content.js';
+import type { NormalizedDownloadUrl } from '../../../types/options.js';
+export declare function buildDownloadPanelContent(downloadUrls: NormalizedDownloadUrl[]): DownloadNode;

package/typings/adapters/asyncapi/panels/group.d.ts

@@ -0,0 +1,16 @@
+import type { GroupItemNode } from '../../../types/content.js';
+import type { AsyncApiBuildContext } from '../../../types/asyncapi.js';
+import type { ApiItem } from '../../../types/store.js';
+export declare function buildGroupItemsPanel({ group, protocol, channelByLink, context }: {
+    group: ApiItem[];
+    protocol: AsyncApiBuildContext['protocol'];
+    channelByLink: Map<string, {
+        bindings?: Record<string, unknown>;
+    } | undefined>;
+    context: AsyncApiBuildContext;
+}): GroupItemNode['children'][0];
+type VisibleGroupItem = ApiItem & {
+    link: string;
+};
+export declare function isVisibleGroupItem(item: ApiItem): item is VisibleGroupItem;
+export {};

package/typings/adapters/asyncapi/panels/overview.d.ts

@@ -0,0 +1,3 @@
+import type { AsyncApiInfo } from '../../../types/asyncapi.js';
+import { type OverviewNode } from '../../../types/content.js';
+export declare function buildOverviewPanelContent(info: AsyncApiInfo): OverviewNode;

package/typings/adapters/asyncapi/store.d.ts

@@ -0,0 +1,3 @@
+import type { ApiStore, StoreContext } from '../../types/store.js';
+import type { AsyncApiDefinition } from '../../types/asyncapi.js';
+export declare function populateAsyncApiStore(document: AsyncApiDefinition, existingCtx: StoreContext): ApiStore;

package/typings/adapters/asyncapi/utils/avro-to-json-schema.d.ts

@@ -0,0 +1,4 @@
+import type { AvroSchema } from '../../../types/asyncapi.js';
+type JsonSchemaObject = Record<string, unknown>;
+export declare function avroToJsonSchema(avroSchema: AvroSchema): JsonSchemaObject;
+export {};

package/typings/adapters/asyncapi/utils/get-channel-label.d.ts

@@ -0,0 +1,3 @@
+import type { AsyncApiChannel } from '../../../types/asyncapi.js';
+/** Shared by the nav item, the page header and message references so all three stay in sync. */
+export declare function getChannelLabel(channel: AsyncApiChannel | undefined, channelId: string): string;

package/typings/adapters/asyncapi/utils/get-protocol-labels.d.ts

@@ -0,0 +1,24 @@
+import type { AsyncApiChannelBinding, ProtocolVariant } from '../../../types/asyncapi.js';
+type Options = {
+    channel: string;
+    channels: string;
+    servers: string;
+    server: string;
+    send: string;
+    receive: string;
+    sendLabel: string;
+    receiveLabel: string;
+    channelBinding: string;
+    payload: string;
+};
+type Params = {
+    protocol: string | null;
+    channelBindings?: AsyncApiChannelBinding;
+};
+export declare function componentLabelsByProtocol({ protocol, channelBindings }: Params): Options;
+export declare function itemLabelsByProtocol(protocol: ProtocolVariant | null, channelBindings?: AsyncApiChannelBinding): {
+    channel: string;
+    send: string;
+    receive: string;
+};
+export {};

package/typings/adapters/asyncapi/utils/get-server-host.d.ts

@@ -0,0 +1,3 @@
+import type { AsyncApiServer } from '../../../types/asyncapi.js';
+/** AsyncAPI 3.x uses `host`; 2.x documents provide `url` instead. */
+export declare function getServerHost(server: AsyncApiServer): string | undefined;

package/typings/adapters/asyncapi/utils/resolve-schema.d.ts

@@ -0,0 +1,2 @@
+import type { AsyncAPISchema } from '../../../types/asyncapi.js';
+export declare function resolveAsyncApiSchema(value: AsyncAPISchema | undefined): Record<string, unknown> | undefined;

package/typings/adapters/asyncapi/utils/resolveInDoc.d.ts

@@ -0,0 +1,2 @@
+import type { AsyncApiDefinition } from '../../../types/asyncapi.js';
+export declare function resolveInDoc<T>(document: AsyncApiDefinition, value: unknown): T | undefined;

package/typings/adapters/build.d.ts

@@ -0,0 +1,31 @@
+import type { DocumentNode } from 'graphql';
+import type { ApiDocAdapterProps, ApiItem, ApiStore } from '../types/store.js';
+import type { OpenAPIDefinition } from '../types/openapi.js';
+import type { AsyncApiDefinition } from '../types/asyncapi.js';
+import type { ApiSpecType } from '../types/common.js';
+import type { RawApiDocsOptions } from '../types/options.js';
+import type { MarkdownParser } from './utils/parseMarkdown.js';
+type ApiDocProps = Omit<ApiDocAdapterProps, 'options'> & {
+    options: RawApiDocsOptions;
+    markdownParser: MarkdownParser;
+};
+type BuildItemsResult = {
+    items: ApiItem[];
+    store: ApiStore;
+    specType: ApiSpecType;
+};
+export declare function buildItems(props: ApiDocProps): Promise<BuildItemsResult>;
+export declare function isOpenApiDefinition(def: ApiDocProps): def is ApiDocProps & {
+    type: 'openapi';
+    document: OpenAPIDefinition;
+};
+export declare function isAsyncApiDefinition(def: ApiDocProps): def is ApiDocProps & {
+    type: 'asyncapi';
+    document: AsyncApiDefinition;
+};
+export declare function isGraphqlDefinition(def: ApiDocProps): def is ApiDocProps & {
+    type: 'graphql';
+    document: DocumentNode;
+};
+export declare function buildNavItems(props: ApiDocProps): Promise<Omit<BuildItemsResult, 'store'>>;
+export {};

package/typings/adapters/graphql/build/context.d.ts

@@ -0,0 +1,9 @@
+import type { DocumentNode, GraphQLSchema } from 'graphql';
+import type { AdapterBuildContextInput } from '../../../types/store.js';
+import type { GraphqlBuildContext as BuildContext } from '../../../types/graphql.js';
+export type CreateBuildContextInputWithDocumentAndSchema = AdapterBuildContextInput & {
+    document: DocumentNode;
+    prebuiltSchema?: GraphQLSchema;
+    processContent?: boolean;
+};
+export declare function createBuildContext({ document, options, basePath, prebuiltSchema, processContent }: CreateBuildContextInputWithDocumentAndSchema): BuildContext;

package/typings/adapters/graphql/buildContext.d.ts

@@ -0,0 +1,2 @@
+import type { GraphqlBuildContext as BuildContext } from '../../types/graphql.js';
+export declare const graphqlContext: import("../scopedContext.js").ScopedContext<BuildContext>;

package/typings/adapters/graphql/buildStoreFromSdl.d.ts

@@ -0,0 +1,2 @@
+import type { ApiStore } from '../../types/store.js';
+export declare function buildGraphqlStoreFromSdl(sdl: string): ApiStore;

package/typings/adapters/graphql/group/custom.d.ts

@@ -0,0 +1,2 @@
+import type { ApiItem } from '../../../types/store.js';
+export declare function groupByCustomMenu(): ApiItem[];

package/typings/adapters/graphql/group/default.d.ts

@@ -0,0 +1,2 @@
+import type { ApiItem } from '../../../types/store.js';
+export declare function groupByDefault(): ApiItem[];

package/typings/adapters/graphql/group/errors.d.ts

@@ -0,0 +1 @@
+export declare function getItemDoesNotMatchAnyGroupErrorMessage(itemDescription: string): string;

package/typings/adapters/graphql/group/itemBuilders.d.ts

@@ -0,0 +1,5 @@
+import type { GraphqlItemVariant } from '../../../types/graphql.js';
+import type { ApiItem } from '../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../items/types.js';
+export type GraphqlMenuGroupItemsBuilder = (args?: GraphqlMenuGroupItemsBuildParams) => ApiItem[];
+export declare const GRAPHQL_MENU_GROUP_ITEM_BUILDERS: Record<GraphqlItemVariant, GraphqlMenuGroupItemsBuilder>;

package/typings/adapters/graphql/group/utils.d.ts

@@ -0,0 +1,8 @@
+import type { ApiItem } from '../../../types/store.js';
+import type { GraphqlItemVariant } from '../../../types/graphql.js';
+export declare function createGroup({ typeGroup, items, label, parentPath }: {
+    items: ApiItem[];
+    typeGroup?: GraphqlItemVariant;
+    label?: string;
+    parentPath?: string;
+}): ApiItem;

package/typings/adapters/graphql/index.d.ts

@@ -0,0 +1,10 @@
+import type { DocumentNode } from 'graphql';
+import type { ApiDocAdapterProps, ApiItem, ApiStore } from '../../types/store.js';
+export declare function processGraphqlDocument({ document, options, basePath, processContent }: ApiDocAdapterProps & {
+    document: DocumentNode;
+    processContent?: boolean;
+}): {
+    items: ApiItem[];
+    store: ApiStore;
+};
+export declare function buildGraphqlItems(): ApiItem[];

package/typings/adapters/graphql/items/directive/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLDirective } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildDirectiveContent(directive: GraphQLDirective, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/typings/adapters/graphql/items/directive/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildDirectiveItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];

package/typings/adapters/graphql/items/enum/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLEnumType } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildEnumContent(enumType: GraphQLEnumType, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/typings/adapters/graphql/items/enum/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildEnumItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];

package/typings/adapters/graphql/items/input/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLInputObjectType } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildInputContent(input: GraphQLInputObjectType, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/typings/adapters/graphql/items/input/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildInputItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];

package/typings/adapters/graphql/items/interface/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLInterfaceType } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildInterfaceContent(interfaceType: GraphQLInterfaceType, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/typings/adapters/graphql/items/interface/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildInterfaceItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];

package/typings/adapters/graphql/items/mutation/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLField } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildMutationContent(mutation: GraphQLField<unknown, unknown>, mutationName: string, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/typings/adapters/graphql/items/mutation/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildMutationItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];

package/typings/adapters/graphql/items/object/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLObjectType } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildObjectContent(object: GraphQLObjectType, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/typings/adapters/graphql/items/object/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildObjectItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];

package/typings/adapters/graphql/items/operation/content.d.ts

@@ -0,0 +1,7 @@
+import type { GraphQLField } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ItemVariant } from '../../../../types/common.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+type OperationType = 'query' | 'mutation' | 'subscription';
+export declare function buildOperationContent(operation: GraphQLField<unknown, unknown>, rootTypeName: string, operationType: OperationType, variant: ItemVariant, markdownOptions: ParseMarkdownOptions): ApiItemContent;
+export {};

package/typings/adapters/graphql/items/overview/content.d.ts

@@ -0,0 +1,11 @@
+import type { Node } from '@markdoc/markdoc';
+import type { ApiItemContent, ContentNode } from '../../../../types/content.js';
+import type { ApiDocsOptions } from '../../../../types/options.js';
+type OverviewOptions = {
+    options: ApiDocsOptions;
+    markdoc?: string | Node[];
+    sectionChildren: ContentNode[];
+    basePath: string;
+};
+export declare function buildOverviewContent(overviewOptions: OverviewOptions): ApiItemContent;
+export {};

package/typings/adapters/graphql/items/overview/item.d.ts

@@ -0,0 +1,4 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { ContentNode } from '../../../../types/content.js';
+import type { GraphqlBuildContext as BuildContext } from '../../../../types/graphql.js';
+export declare function buildOverviewItem(context: BuildContext, sectionChildren: ContentNode[]): ApiItem;

package/typings/adapters/graphql/items/query/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLField } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildQueryContent(query: GraphQLField<unknown, unknown>, queryName: string, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/typings/adapters/graphql/items/query/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildQueryItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];

package/typings/adapters/graphql/items/scalar/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLScalarType } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildScalarContent(scalar: GraphQLScalarType, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/typings/adapters/graphql/items/scalar/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildScalarItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];

package/typings/adapters/graphql/items/subscription/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLField } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildSubscriptionContent(subscription: GraphQLField<unknown, unknown>, subscriptionName: string, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/typings/adapters/graphql/items/subscription/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildSubscriptionItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];

package/typings/adapters/graphql/items/types.d.ts

@@ -0,0 +1,7 @@
+import type { TypeGroupFilter } from '../../../types/graphql.js';
+export type GraphqlMenuGroupItemsBuildParams = {
+    filter?: TypeGroupFilter;
+    processedItems?: Set<string>;
+    menuCommonFilter?: TypeGroupFilter;
+    parentPath?: string;
+};

package/typings/adapters/graphql/items/union/content.d.ts

@@ -0,0 +1,4 @@
+import type { GraphQLUnionType } from 'graphql';
+import type { ApiItemContent } from '../../../../types/content.js';
+import type { ParseMarkdownOptions } from '../../../utils/parseMarkdown.js';
+export declare function buildUnionContent(union: GraphQLUnionType, markdownOptions: ParseMarkdownOptions): ApiItemContent;

package/typings/adapters/graphql/items/union/item.d.ts

@@ -0,0 +1,3 @@
+import type { ApiItem } from '../../../../types/store.js';
+import type { GraphqlMenuGroupItemsBuildParams } from '../types.js';
+export declare function buildUnionItems({ filter, processedItems, menuCommonFilter, parentPath }?: GraphqlMenuGroupItemsBuildParams): ApiItem[];

package/typings/adapters/graphql/panels/download.d.ts

@@ -0,0 +1,3 @@
+import type { DownloadNode } from '../../../types/content.js';
+import type { NormalizedDownloadUrl } from '../../../types/options.js';
+export declare function buildDownloadPanelContent(downloadUrls: NormalizedDownloadUrl[]): DownloadNode | null;

package/typings/adapters/graphql/panels/group-items.d.ts

@@ -0,0 +1,4 @@
+import type { ResolvedNavLinkItem } from '@redocly/config';
+import type { GroupItemNode } from '../../../types/content.js';
+import type { GraphqlBuildContext, GraphqlItemVariant } from '../../../types/graphql.js';
+export declare function buildGroupItemsPanelContent(items: ResolvedNavLinkItem[], context: GraphqlBuildContext, typeGroup?: GraphqlItemVariant): GroupItemNode;

package/typings/adapters/graphql/panels/overview.d.ts

@@ -0,0 +1,3 @@
+import type { OverviewNode } from '../../../types/content.js';
+import type { ApiDocsOptions } from '../../../types/options.js';
+export declare function buildOverviewPanelContent(info: ApiDocsOptions['info'] | undefined): OverviewNode | null;

package/typings/adapters/graphql/serializeType.d.ts

@@ -0,0 +1,5 @@
+import type { GraphQLDirective, GraphQLNamedType, GraphQLType } from 'graphql';
+import type { GraphqlDirectiveData, GraphqlTypeData, GraphqlTypeRef } from '../../types/graphql-store.js';
+export declare function toTypeRef(type: GraphQLType): GraphqlTypeRef;
+export declare function serializeNamedType(type: GraphQLNamedType): GraphqlTypeData;
+export declare function serializeDirective(directive: GraphQLDirective): GraphqlDirectiveData;

package/typings/adapters/graphql/store.d.ts

@@ -0,0 +1,3 @@
+import type { GraphQLSchema } from 'graphql';
+import type { ApiStore } from '../../types/store.js';
+export declare function populateGraphqlStore(schema: GraphQLSchema): ApiStore;

package/typings/adapters/graphql/utils/configMetadataRows.d.ts

@@ -0,0 +1,3 @@
+import type { ApiDocsMetadata } from '../../../types/options.js';
+import type { InfoMetadataRow } from '../../../types/content.js';
+export declare function buildGraphqlConfigMetadataRows(metadata: ApiDocsMetadata | undefined): InfoMetadataRow[];

package/typings/adapters/graphql/utils/constants.d.ts

@@ -0,0 +1,23 @@
+import type { GraphqlItemVariant } from '../../../types/graphql.js';
+/**
+ * Built-in GraphQL scalar types.
+ * These are the standard scalars defined in the GraphQL specification.
+ */
+export declare const BUILT_IN_SCALARS: ReadonlySet<string>;
+/**
+ * Built-in GraphQL directives.
+ * These are the standard directives defined in the GraphQL specification.
+ */
+export declare const BUILT_IN_DIRECTIVES: ReadonlySet<string>;
+export declare const GRAPHQL_VARIANTS: readonly ["query", "mutation", "subscription", "directive", "object", "interface", "union", "enum", "input", "scalar"];
+export declare const menuGroupFilterKey: {
+    readonly ITEMS: 'items';
+    readonly QUERIES: 'queries';
+    readonly MUTATIONS: 'mutations';
+    readonly SUBSCRIPTIONS: 'subscriptions';
+    readonly TYPES: 'types';
+    readonly DIRECTIVES: 'directives';
+};
+export type MenuGroupFilterKey = (typeof menuGroupFilterKey)[keyof typeof menuGroupFilterKey];
+export declare const MENU_GROUP_FILTER_KEYS: MenuGroupFilterKey[];
+export declare const DEFAULT_GROUP_LABELS: Record<GraphqlItemVariant, string>;