redoc 3.0.0-rc.3 → 3.0.0

package/typings/types/schema.d.ts

@@ -1,162 +0,0 @@
-import type { Node } from '@markdoc/markdoc';
-import type { AsyncApiDefinition } from './asyncapi';
-import type { ObjectValues } from './common';
-import type { OpenAPIDefinition } from './openapi';
-export type DiscriminatorObject = {
-    propertyName?: string;
-    mapping?: Record<string, string>;
-    defaultMapping?: string;
-    'x-explicitMappingOnly'?: boolean;
-};
-export type SchemaNode = {
-    type?: string | string[];
-    format?: string;
-    title?: string;
-    description?: string | Node | Node[];
-    pattern?: string;
-    default?: unknown;
-    example?: unknown;
-    const?: unknown;
-    enum?: string[];
-    deprecated?: boolean;
-    nullable?: boolean;
-    readOnly?: boolean;
-    writeOnly?: boolean;
-    minimum?: number;
-    maximum?: number;
-    exclusiveMinimum?: number | boolean;
-    exclusiveMaximum?: number | boolean;
-    multipleOf?: number;
-    minLength?: number;
-    maxLength?: number;
-    contentEncoding?: string;
-    contentMediaType?: string;
-    properties?: Record<string, SchemaNode>;
-    additionalProperties?: SchemaNode | boolean;
-    unevaluatedProperties?: SchemaNode | boolean;
-    patternProperties?: Record<string, SchemaNode>;
-    required?: string[];
-    minProperties?: number;
-    maxProperties?: number;
-    items?: SchemaNode | SchemaNode[] | boolean;
-    prefixItems?: SchemaNode[];
-    additionalItems?: SchemaNode | boolean;
-    minItems?: number;
-    maxItems?: number;
-    uniqueItems?: boolean;
-    oneOf?: SchemaNode[];
-    anyOf?: SchemaNode[];
-    allOf?: SchemaNode[];
-    if?: SchemaNode;
-    then?: SchemaNode;
-    else?: SchemaNode;
-    discriminator?: DiscriminatorObject;
-    $ref?: string;
-    externalDocs?: {
-        url?: string;
-        description?: string;
-    };
-    'x-circular-ref'?: boolean;
-    'x-allof-cycle'?: boolean;
-    'x-complex'?: boolean;
-    'x-nullable'?: boolean;
-    'x-original-ref'?: string;
-    'x-badges'?: BadgeType[];
-    'x-enumDescriptions'?: Record<string, string | Node | Node[]>;
-    'x-additionalPropertiesName'?: string;
-    'x-discriminator'?: DiscriminatorObject;
-    'x-displayName'?: string;
-    'x-parentRefs'?: string[];
-    'x-refsStack'?: string[];
-    [key: string]: unknown;
-};
-export type AccessMode = 'read-only' | 'write-only' | undefined;
-export type Document = OpenAPIDefinition | AsyncApiDefinition;
-export declare function isSchemaNode(value: unknown): value is SchemaNode;
-export declare function isStructuredExample(example: unknown): example is object;
-export type PropertyType = {
-    type: string;
-    title?: string;
-    schemaName?: string;
-    isAdditionalProperty?: boolean;
-    isAdditionalItems?: boolean;
-    isTupleItem?: boolean;
-    isPatternProperty?: boolean;
-    isCircular?: boolean;
-    isComplex?: boolean;
-    isExpandable?: boolean;
-    isRequired?: boolean;
-    isDeprecated?: boolean;
-    description?: string | Node | Node[];
-    pattern?: string;
-    example?: string | object;
-    badges?: BadgeType[];
-    default?: string;
-    accessMode?: AccessMode;
-    enum?: Record<string, string | Node | Node[]> | string[];
-    examples?: Record<string, ExampleType>;
-    extensions?: Record<string, string>;
-    externalDocs?: ExternalDocsType;
-    const?: string;
-    properties?: Record<string, PropertyType>;
-    items?: PropertyType[];
-    switcher?: SwitcherType;
-};
-export type BadgeType = {
-    name: string;
-    position: 'before' | 'after';
-    color: string;
-};
-export type ExampleType = {
-    summary?: string;
-    description?: string;
-    value?: string;
-};
-export type ExternalDocsType = {
-    description: string;
-    url: string;
-};
-export declare const switcherLabel: {
-    readonly DISCRIMINATOR: 'Discriminator';
-    readonly ONE_OF: 'One of:';
-    readonly ANY_OF: 'Any of:';
-};
-export type SwitcherLabel = ObjectValues<typeof switcherLabel>;
-export type OneOfChangeParams = {
-    pointer: string;
-    index: number;
-};
-export type SwitcherType = {
-    type: 'discriminator' | 'oneOf';
-    label: SwitcherLabel;
-    propertyName?: string;
-    jsonPointer?: string;
-    options: Record<string, SwitcherOptionType>;
-    /** The host is itself one of the variants: only its discriminator property is shared. */
-    sharesOnlyDiscriminator?: boolean;
-};
-export type SwitcherOptionType = {
-    isDeprecated: boolean;
-    isDefaultMapping: boolean;
-    isCircular?: boolean;
-    description?: string | Node | Node[];
-    constraints?: string[];
-    properties?: Record<string, PropertyType>;
-    items?: PropertyType[];
-    switcher?: SwitcherType;
-    typeLabel?: string;
-    title?: string;
-    schemaName?: string;
-    accessMode?: AccessMode;
-    enum?: Record<string, string | Node | Node[]> | string[];
-};
-export type SchemaProcessorDialect = {
-    readonly id: string;
-    process(schema: SchemaNode, document: Document, options?: SchemaProcessorOptions): PropertyType;
-};
-export type SchemaProcessorOptions = {
-    dialectId?: string;
-    rootJsonPointer?: string;
-    exampleSerializer?: (value: unknown) => string;
-    sortRequiredPropsFirst?: boolean;
-};

package/typings/types/store.d.ts

@@ -1,160 +0,0 @@
-import type { ResolvedNavItem } from '@redocly/config';
-import type { DocumentNode } from 'graphql';
-import type { Node } from '@markdoc/markdoc';
-import type { ApiSpecType, AsyncApiSecuritySchemeType, Badge, BadgeData, ContentType, ItemVariant, SecuritySchemeIn, SecuritySchemeType, ServerData, SidebarLogo, SchemaKind } from './common.js';
-import type { McpTool, McpResource, McpPrompt, OpenAPIDefinition } from './openapi.js';
-import type { AsyncApiDefinition } from './asyncapi.js';
-import type { ApiDocsOptions } from './options.js';
-import type { ContentNode } from './content.js';
-import type { GraphqlStoreMeta } from './graphql-store.js';
-export type AdapterBuildContextInput = {
-    options: ApiDocsOptions;
-    basePath: string;
-};
-export type ApiDocAdapterProps = {
-    type: ApiSpecType;
-    document: OpenAPIDefinition | AsyncApiDefinition | DocumentNode;
-    options: ApiDocsOptions;
-    basePath: string;
-};
-export type StoreContext = {
-    schemaStore: Record<string, SchemaEntry>;
-    exampleStore: Record<string, ExampleEntry>;
-    securitySchemeStore: Record<string, SecuritySchemeEntry>;
-    hashIndex: Record<string, string>;
-    document: Record<string, unknown>;
-};
-export type ApiItemContent = {
-    contentType: ContentType;
-    itemVariant?: ItemVariant;
-    meta?: ItemMeta;
-    children: ContentNode[];
-    showDivider?: boolean;
-};
-export type BreadcrumbItem = {
-    label: string;
-};
-export type ItemMeta = {
-    name?: string;
-    deprecated?: boolean;
-    isWebhook?: boolean;
-    hasSamples?: boolean;
-    badges?: BadgeData[];
-    pointer?: string;
-    position?: {
-        start: {
-            lineNumber: number;
-            column: number;
-        };
-        end?: {
-            lineNumber: number;
-            column: number;
-        };
-    };
-    protocolTag?: {
-        label: string;
-        color: string;
-    };
-    breadcrumbs?: BreadcrumbItem[];
-    action?: 'send' | 'receive';
-    actionLabel?: string;
-    channelBindings?: Record<string, unknown>;
-    returnType?: string;
-};
-export type ApiItem = ResolvedNavItem & {
-    content: ApiItemContent | null;
-    httpVerb?: string;
-};
-export type SchemaEntry = {
-    id: string;
-    kind: SchemaKind;
-    title?: string;
-    data: Record<string, unknown>;
-};
-export type ExampleEntry = {
-    id: string;
-    value: unknown;
-    key?: string;
-    summary?: string;
-    description?: string | Node | Node[];
-    mediaType?: string;
-    externalValue?: string;
-    /** Header values of an AsyncAPI message example. */
-    headers?: Record<string, unknown>;
-};
-export type OAuthFlowEntry = {
-    authorizationUrl?: string;
-    tokenUrl?: string;
-    refreshUrl?: string;
-    deviceAuthorizationUrl?: string;
-    scopes?: Record<string, string>;
-};
-export type OAuthFlowsData = {
-    implicit?: {
-        authorizationUrl?: string;
-        refreshUrl?: string;
-        scopes: Record<string, string>;
-    };
-    password?: {
-        tokenUrl: string;
-        refreshUrl?: string;
-        scopes: Record<string, string>;
-    };
-    clientCredentials?: {
-        tokenUrl: string;
-        refreshUrl?: string;
-        scopes: Record<string, string>;
-    };
-    authorizationCode?: {
-        authorizationUrl: string;
-        tokenUrl: string;
-        refreshUrl?: string;
-        scopes: Record<string, string>;
-        'x-usePkce'?: boolean;
-    };
-    deviceAuthorization?: {
-        deviceAuthorizationUrl: string;
-        tokenUrl: string;
-        refreshUrl?: string;
-        scopes: Record<string, string>;
-    };
-};
-export type SecuritySchemeEntry = {
-    id: string;
-    type: SecuritySchemeType | AsyncApiSecuritySchemeType;
-    scheme?: string;
-    bearerFormat?: string;
-    description?: string | Node[] | Node;
-    in?: SecuritySchemeIn | 'user' | 'password';
-    paramName?: string;
-    scopes?: string[];
-    openIdConnectUrl?: string;
-    deprecated?: boolean;
-    oauth2MetadataUrl?: string;
-    flows?: OAuthFlowsData;
-};
-export type GroupItem = {
-    title: string;
-    summary?: string;
-    prefix?: Badge;
-    badges?: Badge[];
-    link: string;
-    deprecated: boolean;
-    childTag?: boolean;
-};
-export type McpData = {
-    tools?: McpTool[];
-    resources?: McpResource[];
-    prompts?: McpPrompt[];
-};
-export type ApiStore = {
-    schemaStore: Record<string, SchemaEntry>;
-    exampleStore: Record<string, ExampleEntry>;
-    securitySchemeStore: Record<string, SecuritySchemeEntry>;
-    graphqlMeta?: GraphqlStoreMeta;
-    servers?: ServerData[];
-    mcp?: McpData;
-    /** From OpenAPI `info.x-logo`. Rendered by the standalone sidebar. */
-    logo?: SidebarLogo;
-    specType?: ApiSpecType;
-};

package/typings/utils/calculateMaxLength.d.ts

@@ -1,6 +0,0 @@
-type Breadcrumb = {
-    name: string;
-    href: string;
-};
-export declare function calculateMaxLength(breadcrumbs: Breadcrumb[], availableWidth: number, isCollapsed: boolean, measureEl: HTMLElement): number;
-export {};

package/typings/utils/compose.d.ts

@@ -1,7 +0,0 @@
-import type { ComponentType, FC } from 'react';
-type HOC<P> = (Component: ComponentType<P>) => FC<P>;
-export declare function compose<P>(f: HOC<P>): (Component: ComponentType<P>) => FC<P>;
-export declare function compose<P>(f: HOC<P>, g: HOC<P>): (Component: ComponentType<P>) => FC<P>;
-export declare function compose<P>(f: HOC<P>, g: HOC<P>, h: HOC<P>): (Component: ComponentType<P>) => FC<P>;
-export declare function compose<P>(f: HOC<P>, g: HOC<P>, h: HOC<P>, i: HOC<P>): (Component: ComponentType<P>) => FC<P>;
-export {};

package/typings/utils/cookies.d.ts

@@ -1,7 +0,0 @@
-export declare function setCookie(name: string | number | boolean, value: string, attributes?: {
-    [x: string]: string | number | Date | boolean;
-}): string | undefined;
-export declare function getCookie(name: string, serverString?: string): string;
-export declare function removeCookie(name: string, attributes?: {
-    [x: string]: string | number | Date | boolean;
-}): void;

package/typings/utils/deep-link.d.ts

@@ -1,163 +0,0 @@
-import type { RouteIndex } from './routing.js';
-/**
- * Serialize key-value params into a query-string fragment:
- * keys in insertion order, no encoding, undefined values omitted.
- */
-export declare function serializeFieldParams(params: Record<string, string | undefined>): string;
-/**
- * Build a deep-link path+hash string for a given operation slug and suffix:
- *   `/{operationId}#{operationId}/{suffix}`  (all lowercased, backslashes encoded).
- *
- * `operationId` must be a basePath-free slug (e.g. `cafe/placeorder`) — a
- * leading slash is stripped defensively so the output is well-formed even
- * if a caller hands in `/cafe/placeorder`.
- */
-export declare function makeDeepLink(operationId: string, suffix: string): string;
-/**
- * Build a full deep-link URL by combining routing base, operation id, and suffix.
- */
-export declare function buildDeepLinkUrl(routingBasePath: string, operationId: string, suffix: string): string;
-/**
- * Extract element id from a URL hash (strip `#`, decode, lowercase).
- * The returned value can be passed to `document.getElementById`.
- */
-export declare function hashToElementId(hash: string): string;
-/**
- * Extract the hash fragment from a deep link URL for use as an element id.
- * Given `/petstore/pet/getpetbyid#pet/getpetbyid/request`, returns `pet/getpetbyid/request`.
- * Returns empty string if no hash is present.
- */
-export declare function deepLinkToId(deepLink: string): string;
-interface OpenApiFieldParams {
-    /** "request" | "response" */
-    t?: string;
-    /** "query" | "header" | "path" | "cookie" */
-    in?: string;
-    /** Response status code (responses only) */
-    c?: string;
-    /** Callback id (callbacks only) */
-    cb?: string;
-    /** Content-type name (when multiple media types) */
-    ct?: string;
-    /** Field deep path */
-    path?: string;
-}
-/** Build a suffix for an OpenAPI request/response/callback field. */
-export declare function buildOpenApiFieldSuffix(params: OpenApiFieldParams): string;
-/**
- * Build section-level suffix for OpenAPI requests/responses.
- *
- * Examples:
- *   buildOpenApiSectionSuffix('request')                        -> "request"
- *   buildOpenApiSectionSuffix('request', 'query')                -> "request/query"
- *   buildOpenApiSectionSuffix('response', undefined, '200')      -> "response&c=200"
- *   buildOpenApiSectionSuffix('response', 'body', '200')         -> "response&c=200/body"
- *   buildOpenApiSectionSuffix('response', 'headers', '200')      -> "response&c=200/headers"
- *   buildOpenApiSectionSuffix('callbacks')                       -> "callbacks"
- *   buildOpenApiSectionSuffix('callbacks', 'myCallback')          -> "callbacks/myCallback"
- */
-export declare function buildOpenApiSectionSuffix(section: string, subSection?: string, responseCode?: string): string;
-export interface AsyncApiSuffixParams {
-    /** "send" | "receive" | "parameters" | "messages" */
-    section: string;
-    /** Message key/name (when linking to a specific message) */
-    messageKey?: string;
-    /** Sub-section: "headers" | "payload" */
-    subsection?: string;
-}
-/**
- * Build a suffix for AsyncAPI sections.
- *
- * Examples:
- *   { section: 'send' }                                    -> "send"
- *   { section: 'parameters' }                              -> "parameters"
- *   { section: 'messages', messageKey: 'userSignedUp' }    -> "messages&m=userSignedUp"
- *   { section: 'messages', messageKey: 'msg1', subsection: 'headers' }
- *       -> "messages&m=msg1&t=headers"
- *   { section: 'messages', messageKey: 'msg1', subsection: 'payload' }
- *       -> "messages&m=msg1&t=payload"
- */
-export declare function buildAsyncApiSuffix(params: AsyncApiSuffixParams): string;
-export interface GraphqlSuffixParams {
-    /** Section type: "field" | "argument" | "return-type" | "possible-types" |
-     *  "implements" | "directive" | "enum-value" | "scalar" */
-    t: string;
-    /** Stable path: e.g. "Query.hero", "User.friends" */
-    path?: string;
-    /** Argument name (when t=argument or nested under a field) */
-    arg?: string;
-    /** Return-type anchor ("1" or nested path when expanded) */
-    rt?: string;
-}
-/**
- * Build a suffix for GraphQL deep links.
- *
- * Examples:
- *   { t: 'field', path: 'Query.hero' }           -> "t=field&path=Query.hero"
- *   { t: 'argument', path: 'Query.hero', arg: 'id' }
- *       -> "t=argument&path=Query.hero&arg=id"
- *   { t: 'return-type', path: 'Query.hero', rt: '1' }
- *       -> "t=return-type&path=Query.hero&rt=1"
- */
-export declare function buildGraphqlSuffix(params: GraphqlSuffixParams): string;
-export declare function isGraphqlDeepLinkAncestor(hash: string, path: string): boolean;
-/**
- * Convert a deep-link URL to an element id, returning `undefined` for empty/missing links.
- * Shorthand for the common pattern `id={url ? deepLinkToId(url) : undefined}`.
- */
-export declare function getDeepLinkId(deepLink: string | undefined): string | undefined;
-export declare function appendVariantSuffix(fieldParentsName: string[] | undefined, suffix: string): string[];
-export declare function appendArraySuffix(fieldParentsName: string[]): string[];
-/**
- * Remove variant deep-link markers (`&oneof=N`, `&d=N`) from a field-parent path
- * piece, leaving the human-readable name(s). The markers can sit mid-path
- * (e.g. `_embedded.quote&d=0.order` -> `_embedded.quote.order`), so they must be
- * stripped in place rather than split off. Returns `''` when the piece was only a
- * marker (e.g. `&d=0`), so callers can skip it in the breadcrumb.
- */
-export declare function stripVariantMarkers(name: string): string;
-/** Remove `[]` array-item markers from a deep-link path piece; legacy links carry none. */
-export declare function stripArrayMarkers(value: string): string;
-/**
- * Keep only the variant markers (`&oneof=N` / `&d=N`) from each parent path piece,
- * dropping plain field-name bases. Used at shallow render levels where breadcrumbs are
- * suppressed, so a switched tab stays reload-reachable without showing a field prefix.
- */
-export declare function variantMarkersOnly(fieldParentsName: string[] | undefined): string[];
-/**
- * Extract a deep-link parameter value from a URL hash.
- * The search is case-insensitive and values are returned lowercased.
- */
-export declare function extractDeepLinkParamFromHash(hash: string, key: 'c' | 'm' | 'ct' | 'ex'): string | undefined;
-/** Section name owning a callback's suffixes: `callbacks/<callbackId>[/…]`. */
-export declare const CALLBACKS_SECTION = "callbacks";
-/** Sub-section anchors a callback owns. Emitted by `CallbacksSection` and matched here, so
- *  the spelling is a contract — legacy links use these exact names. */
-export declare const CALLBACK_REQUEST_SECTION = "callback-request";
-export declare const CALLBACK_RESPONSE_SECTION = "callback-response";
-export declare function stripCallbacksSegment(id: string): string;
-/** Whether a hash id addresses the given item at all — it, or anything beneath it. */
-export declare function hashIsForItem(hashId: string, itemId: string): boolean;
-/** `itemId` must be in hash shape (basePath-free, lowercased); two operations can hold a
- *  callback with the same id, so the item has to match before the callback does. Any missing
- *  argument answers `false`, so callers needn't pre-check. */
-export declare function hashTargetsCallback(hash: string, itemId: string, callbackId: string | undefined): boolean;
-/** Whether a hash id addresses something inside the given callback.
- *  `hashId` and `itemId` are expected lowercased, as `hashToElementId` returns them. */
-export declare function hashIsInsideCallback(hashId: string, itemId: string, callbackId: string): boolean;
-/**
- * Whether a hash id addresses the operation level, outside every callback. Only the part of
- * the hash *after* the item id is examined, so an operation or tag whose own slug contains a
- * marker (`/callback-response`) can't be mistaken for one either.
- */
-export declare function hashIsOutsideCallbacks(hashId: string, itemId: string): boolean;
-/**
- * Detect legacy openapi hash patterns and return normalized suffix.
- * Matches: #tag/..., #operation/..., #paths/...
- */
-export declare function getLegacyHash(hash: string): string;
-/** Map a legacy single-page hash (`#section/…`, `#tag/…`, `#operation/…`) to its route URL in
- *  the multi-page engine; `undefined` for a genuine in-page anchor (e.g. a field deep link).
- *  A sub-section tail past the route (`#operation/<id>/callbacks`) becomes the element-id hash. */
-export declare function resolveLegacyHashToRoute(hash: string, basePath: string, routeIndex: RouteIndex): string | undefined;
-export {};

package/typings/utils/definitionLoadError.d.ts

@@ -1,7 +0,0 @@
-export type DefinitionLoadStage = 'fetch' | 'parse' | 'bundle' | 'unsupported';
-export declare class DefinitionLoadError extends Error {
-    readonly stage: DefinitionLoadStage;
-    readonly httpStatus: number | undefined;
-    constructor(stage: DefinitionLoadStage, message: string, httpStatus?: number);
-}
-export declare function errorMessage(error: unknown): string;

package/typings/utils/environments.d.ts

@@ -1,6 +0,0 @@
-import type { Node } from '@markdoc/markdoc';
-import type { OpenAPIServer } from '../types/openapi.js';
-export type EnvironmentData = Record<string, Record<string, string>>;
-export declare function mergeEnvData(env1: EnvironmentData, env2?: EnvironmentData): EnvironmentData;
-export declare function getServerEnvName(server: Pick<OpenAPIServer, 'name' | 'description' | 'url'>): string | Node[] | Node;
-export declare const IS_BROWSER: boolean;

package/typings/utils/expansion.d.ts

@@ -1,3 +0,0 @@
-export declare function isWithinExpansionLevel(level: number, schemasExpansionLevel: number | undefined, fallbackLevel: number): boolean;
-export declare const REQUIRED_EXPAND_LEVEL = 4;
-export declare function isRequiredAutoExpanded(level: number, required: boolean | undefined, schemasExpansionLevel: number | undefined): boolean;

package/typings/utils/extract-extensions.d.ts

@@ -1,4 +0,0 @@
-export type GenericObject = Record<string, unknown>;
-export declare function isRedocExtension(key: string): boolean;
-export declare function extractExtensions(obj: GenericObject, showExtensions: string[] | true): GenericObject;
-export declare function getExtensionsForDisplay(obj: GenericObject, showExtensions: string[] | boolean): GenericObject;

package/typings/utils/form-urlencoded.d.ts

@@ -1,9 +0,0 @@
-export type FormFieldEncoding = {
-    contentType?: string;
-    style?: string;
-    explode?: boolean;
-    allowReserved?: boolean;
-};
-export declare function pickFormEncoding(encoding: Record<string, FormFieldEncoding | null> | undefined): Record<string, FormFieldEncoding> | undefined;
-export declare function formUrlEncodeValue(value: unknown, encoding?: Record<string, FormFieldEncoding>): string;
-export declare function stringifyFormFieldValue(value: unknown): string;

package/typings/utils/graphql-directive-utils.d.ts

@@ -1,6 +0,0 @@
-import type { GraphQLNamedType, GraphQLEnumValue, GraphQLField, GraphQLArgument, GraphQLInputField, GraphQLSchema } from 'graphql';
-import type { GraphQLInfo } from '../types/graphql.js';
-import type { RequiresScopesDirective } from './graphql-scopes.js';
-export type DirectiveTarget = GraphQLNamedType | GraphQLEnumValue | GraphQLField<any, any> | GraphQLArgument | GraphQLInputField;
-export declare function getRequiresScopesDirective(type: DirectiveTarget): RequiresScopesDirective | null;
-export declare function extractInfoFromDirectives(schema: GraphQLSchema): GraphQLInfo | undefined;

package/typings/utils/graphql-parse.d.ts

@@ -1 +0,0 @@
-export { parse } from 'graphql';

package/typings/utils/graphql-reference-map.d.ts

@@ -1,3 +0,0 @@
-import type { SchemaEntry } from '../types/store.js';
-import type { GraphqlStoreMeta, GraphqlTypeReference } from '../types/graphql-store.js';
-export declare function buildGraphqlReferenceMap(schemaStore: Record<string, SchemaEntry>, rootTypes?: GraphqlStoreMeta['rootTypes']): Record<string, GraphqlTypeReference[]>;

package/typings/utils/graphql-samples.d.ts

@@ -1,29 +0,0 @@
-import type { ApiStore, SchemaEntry } from '../types/store.js';
-import type { GraphqlStoreFieldData, GraphqlTypeData } from '../types/graphql-store.js';
-export declare const INDENTATION = "  ";
-export declare const CONNECTION_FIELDS: ReadonlySet<string>;
-export type GraphqlTypeLookup = (name: string) => GraphqlTypeData | undefined;
-export declare function createGraphqlTypeLookup(schemaStore: Record<string, SchemaEntry>): GraphqlTypeLookup;
-export declare function getOperationFromStore(store: Pick<ApiStore, 'schemaStore' | 'graphqlMeta'>, operationType: 'query' | 'mutation' | 'subscription', operationName: string): GraphqlStoreFieldData | undefined;
-type ParsedTypeNotation = {
-    kind: 'named';
-    name: string;
-} | {
-    kind: 'list';
-    ofType: ParsedTypeNotation;
-} | {
-    kind: 'non-null';
-    ofType: ParsedTypeNotation;
-};
-export declare function parseTypeNotation(display: string): ParsedTypeNotation;
-export declare function getScalarExample(typeName: string): unknown;
-export declare function getTypeExample(display: string, lookup: GraphqlTypeLookup, expandLevel: number, level?: number): unknown;
-type SampleLabels = {
-    argumentsHere: string;
-    fragment: string;
-};
-export declare function getVariablesDeclaration(args: GraphqlStoreFieldData[], multiline: boolean): string;
-export declare function generateOperationExample(operationType: 'query' | 'mutation' | 'subscription', operation: GraphqlStoreFieldData, lookup: GraphqlTypeLookup, expandLevel: number, multilineArguments?: boolean, labels?: Partial<SampleLabels>): string;
-export declare function generateOperationVariablesExample(args: GraphqlStoreFieldData[], lookup: GraphqlTypeLookup, expandLevel: number): Record<string, unknown>;
-export declare function generateOperationResponseExample(typeDisplay: string, lookup: GraphqlTypeLookup, expandLevel: number): object;
-export {};

package/typings/utils/graphql-scopes.d.ts

@@ -1,6 +0,0 @@
-import type { GraphqlRequiresScopes } from '../types/graphql-store.js';
-export interface RequiresScopesDirective {
-    scopes: string[][];
-    parentScopes?: string[][];
-}
-export declare function mergeRequiresScopes(fieldScopes: GraphqlRequiresScopes | null | undefined, parentScopes: GraphqlRequiresScopes | null | undefined): RequiresScopesDirective | null;

package/typings/utils/graphql-type-expansion.d.ts

@@ -1,5 +0,0 @@
-import type { GraphqlStoreFieldData, GraphqlTypeData } from '../types/graphql-store.js';
-import type { GraphqlTypeLookup } from './graphql-samples.js';
-export declare function isGraphqlFieldExpandable(field: GraphqlStoreFieldData, fieldExpandLevel: number, maxFieldExpandLevel: number, lookup: GraphqlTypeLookup): boolean;
-export declare function graphqlTypeHasExpandableFields(data: GraphqlTypeData | undefined, fieldExpandLevel: number, maxFieldExpandLevel: number, lookup: GraphqlTypeLookup): boolean;
-export declare function countNamedTypeFields(typeName: string, lookup: GraphqlTypeLookup): number;

package/typings/utils/http-methods.d.ts

@@ -1,8 +0,0 @@
-/**
- * OpenAPI operation (HTTP method) keys recognized on a path item, including
- * the OpenAPI 3.2 `query` / vendor `x-query` operations. Shared by the
- * adapter build context and the public `isOperationName` guard.
- */
-export declare const HTTP_METHODS: ReadonlySet<string>;
-/** Returns `true` when `key` names an OpenAPI operation on a path item. */
-export declare function isOperationName(key: string): boolean;

package/typings/utils/is-record.d.ts

@@ -1 +0,0 @@
-export declare function isRecord(value: unknown): value is Record<string, unknown>;

package/typings/utils/languages.d.ts

@@ -1,18 +0,0 @@
-import type { Language } from '../types/openapi.js';
-/** Every language `codeSamples.languages` accepts. `label` is what users write in config. */
-export declare const DEFAULT_LANGUAGES: Language[];
-/** Tab identity — a custom `label` names the tab. */
-export declare function getLangKey({ lang, label }: {
-    lang: string;
-    label?: string;
-}): string;
-/** Language to generate code in — a custom `label` never changes it. */
-export declare function getGeneratorKey({ lang }: {
-    lang: string;
-}): string;
-/**
- * Grammar for the syntax highlighter, resolved from the configured language name. Keep this the
- * only place a language is turned into a grammar: it is many-to-one (`Node.js` and `JavaScript`
- * both highlight as JavaScript, `Payload` as JSON), so a grammar can never identify a language.
- */
-export declare function getSyntaxHighlightLang(lang: string): string;

package/typings/utils/loadAndBundleSpec.d.ts

@@ -1,4 +0,0 @@
-import type { RedocConfig } from '@redocly/config';
-import type { OpenAPIDefinition } from '../types/openapi.js';
-export declare function loadOpenapiConfig(): Promise<RedocConfig>;
-export declare function loadAndBundleDefinition(specUrlOrObject: Record<string, unknown> | string): Promise<OpenAPIDefinition>;

package/typings/utils/logo.d.ts

@@ -1,8 +0,0 @@
-import type { RawLogo, SidebarLogo } from '../types/common.js';
-/**
- * Normalizes an authored `{ url }` logo (OpenAPI `info.x-logo`, the standalone `logo` prop) into
- * the `{ imageUrl }` shape the sidebar renders. `hrefFallback` covers OpenAPI's `info.contact.url`.
- * Without an image there is nothing to render, hence `undefined` — which is also what lets
- * callers fall through to the next logo source with `??`.
- */
-export declare function toSidebarLogo(raw: RawLogo | undefined, hrefFallback?: string): SidebarLogo | undefined;