@gitbook/react-openapi 1.5.1 → 1.5.2

package/dist/index.d.ts

@@ -1,663 +1,12 @@
-import * as react2 from "react";
-import { Filesystem, OpenAPICustomOperationProperties, OpenAPICustomPrefillProperties, OpenAPICustomSpecProperties, OpenAPISchema, OpenAPIV3, OpenAPIV3xDocument } from "@gitbook/openapi-parser";
-import "flatted";
-
-//#region src/translations/en.d.ts
-declare const en: {
-  required: string;
-  deprecated: string;
-  deprecated_and_sunset_on: string;
-  stability_experimental: string;
-  stability_alpha: string;
-  stability_beta: string;
-  discriminator: string;
-  copy_to_clipboard: string;
-  copied: string;
-  no_content: string;
-  unresolved_reference: string;
-  circular_reference: string;
-  read_only: string;
-  write_only: string;
-  optional: string;
-  min: string;
-  max: string;
-  nullable: string;
-  body: string;
-  payload: string;
-  headers: string;
-  header: string;
-  authorizations: string;
-  responses: string;
-  response: string;
-  path_parameters: string;
-  query_parameters: string;
-  header_parameters: string;
-  attributes: string;
-  test_it: string;
-  information: string;
-  success: string;
-  redirect: string;
-  error: string;
-  show: string;
-  hide: string;
-  available_items: string;
-  required_scopes: string;
-  possible_values: string;
-  properties: string;
-  or: string;
-  and: string;
-};
-//#endregion
-//#region src/translations/types.d.ts
-type TranslationKey = keyof typeof en;
-type Translation = { [key in TranslationKey]: string };
-//#endregion
-//#region src/translations/index.d.ts
-declare const translations: {
-  en: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    discriminator: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    required_scopes: string;
-    possible_values: string;
-    properties: string;
-    or: string;
-    and: string;
-  };
-  de: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    discriminator: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    required_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-  };
-  es: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    discriminator: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    required_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-  };
-  fr: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    discriminator: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    required_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-  };
-  ja: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    discriminator: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    required_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-  };
-  nl: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    discriminator: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    required_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-  };
-  no: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    discriminator: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    required_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-  };
-  'pt-br': {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    discriminator: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    required_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-  };
-  zh: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    discriminator: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    required_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-  };
-};
-type TranslationLocale = keyof typeof translations;
-/**
- * Check if the locale is valid.
- */
-declare function checkIsValidLocale(locale: string): locale is TranslationLocale;
-//#endregion
-//#region src/context.d.ts
-interface OpenAPIClientContext {
-  /**
-   * The translation language to use.
-   */
-  translation: Translation;
-  /**
-   * Icons used in the block.
-   */
-  icons: {
-    chevronDown: React.ReactNode;
-    chevronRight: React.ReactNode;
-    plus: React.ReactNode;
-  };
-  /**
-   * Force all sections to be opened by default.
-   * @default false
-   */
-  defaultInteractiveOpened?: boolean;
-  /**
-   * The key of the block
-   */
-  blockKey?: string;
-  /**
-   * Optional id attached to the heading and used as an anchor.
-   */
-  id?: string;
-  /**
-   * Mark the context as a client context.
-   */
-  $$isClientContext$$: true;
-}
-interface OpenAPIContext extends Omit<OpenAPIClientContext, '$$isClientContext$$'> {
-  /**
-   * Render a code block.
-   */
-  renderCodeBlock: (props: {
-    code: string;
-    syntax: string;
-  }) => React.ReactNode;
-  /**
-   * Render the heading of the operation.
-   */
-  renderHeading: (props: {
-    deprecated: boolean;
-    title: string;
-    stability?: string;
-  }) => React.ReactNode;
-  /**
-   * Render the document of the operation.
-   */
-  renderDocument: (props: {
-    document: object;
-  }) => React.ReactNode;
-  /**
-   * Specification URL.
-   */
-  specUrl: string;
-}
-interface OpenAPIContextInput extends Omit<OpenAPIContext, 'translation'> {
-  /**
-   * The translation language to use.
-   * @default 'en'
-   */
-  locale?: TranslationLocale | undefined;
-}
-//#endregion
-//#region src/schemas/OpenAPISchemas.d.ts
-/**
- * OpenAPI Schemas component.
- */
-declare function OpenAPISchemas(props: {
-  className?: string;
-  schemas: OpenAPISchema[];
-  context: OpenAPIContextInput;
-  /**
-   * Whether to show the schema directly if there is only one.
-   */
-  grouped?: boolean;
-}): react2.JSX.Element | null;
-//#endregion
-//#region src/schemas/resolveOpenAPISchemas.d.ts
-/**
- * Resolve an OpenAPI schemas from a file and compile it to a more usable format.
- * Schemas are extracted from the OpenAPI components.schemas
- */
-declare function resolveOpenAPISchemas(filesystem: Filesystem<OpenAPIV3xDocument>, options: {
-  schemas: string[];
-}): Promise<{
-  schemas: OpenAPISchema[];
-} | null>;
-//#endregion
-//#region src/types.d.ts
-type OpenAPIServerVariableWithCustomProperties = OpenAPIV3.ServerVariableObject & OpenAPICustomPrefillProperties;
-/**
- * OpenAPI ServerObject type extended to provide x-gitbook prefill custom properties at the variable level.
- */
-type OpenAPIServerWithCustomProperties = Omit<OpenAPIV3.ServerObject, 'variables'> & {
-  variables?: {
-    [variable: string]: OpenAPIServerVariableWithCustomProperties;
-  };
-} & OpenAPICustomPrefillProperties;
-type OpenAPISecurityScope = [string, string | undefined];
-type OpenAPICustomSecurityScheme = OpenAPIV3.SecuritySchemeObject & OpenAPICustomPrefillProperties & {
-  required?: boolean;
-  scopes?: OpenAPISecurityScope[] | null;
-};
-interface OpenAPIOperationData extends OpenAPICustomSpecProperties {
-  path: string;
-  method: string;
-  /** Servers to be used for this operation */
-  servers: OpenAPIServerWithCustomProperties[];
-  /** Spec of the operation */
-  operation: OpenAPIV3.OperationObject<OpenAPICustomOperationProperties>;
-  /** Securities that should be used for this operation */
-  securities: [string, OpenAPICustomSecurityScheme][];
-}
-interface OpenAPIWebhookData extends OpenAPICustomSpecProperties {
-  name: string;
-  method: string;
-  /** Servers to be used for this operation */
-  servers: OpenAPIV3.ServerObject[];
-  /** Spec of the webhook */
-  operation: OpenAPIV3.OperationObject<OpenAPICustomOperationProperties>;
-}
-//#endregion
-//#region src/OpenAPIOperation.d.ts
-/**
- * Display an interactive OpenAPI operation.
- */
-declare function OpenAPIOperation(props: {
-  className?: string;
-  data: OpenAPIOperationData;
-  context: OpenAPIContextInput;
-}): react2.JSX.Element;
-//#endregion
-//#region src/OpenAPIWebhook.d.ts
-/**
- * Display an interactive OpenAPI webhook.
- */
-declare function OpenAPIWebhook(props: {
-  className?: string;
-  data: OpenAPIWebhookData;
-  context: OpenAPIContextInput;
-}): react2.JSX.Element;
-//#endregion
-//#region src/OpenAPIOperationContext.d.ts
-interface OpenAPIOperationPointer {
-  path: string;
-  method: string;
-}
-interface OpenAPIOperationContextValue {
-  onOpenClient: (pointer: OpenAPIOperationPointer) => void;
-}
-/**
- * Provider for the OpenAPIOperationContext.
- */
-declare function OpenAPIOperationContextProvider(props: React.PropsWithChildren<Partial<OpenAPIOperationContextValue>>): react2.JSX.Element;
-/**
- * Hook to access the OpenAPIOperationContext.
- */
-declare function useOpenAPIOperationContext(): OpenAPIOperationContextValue;
-//#endregion
-//#region src/OpenAPIPrefillContextProvider.d.ts
-/**
- * Prefill data that can be used to dynamically inject info into OpenAPI operation blocks.
- *
- * This is typically dynamic input context, such as visitor data or environment info.
- */
-type PrefillInputContextData = Record<string, unknown>;
-/**
- * Context value is function that returns prefill data.
- */
-type PrefillContextValue = () => PrefillInputContextData | null;
-/**
- * Provide context to help prefill dynamic info like visitor data in OpenAPI blocks.
- */
-declare function OpenAPIPrefillContextProvider(props: react2.PropsWithChildren<{
-  getPrefillInputContextData: () => PrefillInputContextData | null;
-}>): react2.JSX.Element;
-/**
- * Hook to access the prefill context function.
- */
-declare function useOpenAPIPrefillContext(): PrefillContextValue;
-//#endregion
-//#region src/resolveOpenAPIOperation.d.ts
-/**
- * Resolve an OpenAPI operation in a file and compile it to a more usable format.
- */
-declare function resolveOpenAPIOperation(filesystem: Filesystem<OpenAPIV3xDocument>, operationDescriptor: {
-  path: string;
-  method: string;
-}): Promise<OpenAPIOperationData | null>;
-//#endregion
-//#region src/resolveOpenAPIWebhook.d.ts
-/**
- * Resolve an OpenAPI webhook in a file and compile it to a more usable format.
- */
-declare function resolveOpenAPIWebhook(filesystem: Filesystem<OpenAPIV3xDocument>, webhookDescriptor: {
-  name: string;
-  method: string;
-}): Promise<OpenAPIWebhookData | null>;
-//#endregion
+import { checkIsValidLocale } from "./translations/index.js";
+import { OpenAPIContextInput } from "./context.js";
+import { OpenAPISchemas } from "./schemas/OpenAPISchemas.js";
+import { resolveOpenAPISchemas } from "./schemas/resolveOpenAPISchemas.js";
+import { OpenAPIOperationData, OpenAPIWebhookData } from "./types.js";
+import { OpenAPIOperation } from "./OpenAPIOperation.js";
+import { OpenAPIWebhook } from "./OpenAPIWebhook.js";
+import { OpenAPIOperationContextProvider, useOpenAPIOperationContext } from "./OpenAPIOperationContext.js";
+import { OpenAPIPrefillContextProvider, PrefillInputContextData, useOpenAPIPrefillContext } from "./OpenAPIPrefillContextProvider.js";
+import { resolveOpenAPIOperation } from "./resolveOpenAPIOperation.js";
+import { resolveOpenAPIWebhook } from "./resolveOpenAPIWebhook.js";
 export { type OpenAPIContextInput, OpenAPIOperation, OpenAPIOperationContextProvider, type OpenAPIOperationData, OpenAPIPrefillContextProvider, OpenAPISchemas, OpenAPIWebhook, type OpenAPIWebhookData, PrefillInputContextData, checkIsValidLocale, resolveOpenAPIOperation, resolveOpenAPISchemas, resolveOpenAPIWebhook, useOpenAPIOperationContext, useOpenAPIPrefillContext };