@stainless-api/docs-ui 0.1.0-beta.9 → 0.1.0-beta.90

package/dist/docs-DSjdvCh5.d.ts

@@ -0,0 +1,62 @@
+import { h as Resource, u as LanguageDeclNodes, v as Spec, y as SpecLanguage } from "./index-DFr9Mesr.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/contexts/docs.d.ts
+type ContentPanelLayout = 'double-pane' | 'single-pane';
+type PropertySettingsType = {
+  types?: 'simple' | 'rich';
+  includeModelProperties?: boolean | 'method-page';
+  collapseDescription?: boolean | 'show-first-line';
+  showTitle?: boolean;
+  expandDepth?: number;
+};
+type DocsContextType = {
+  language: SpecLanguage;
+  spec: Spec | null;
+  settings?: {
+    properties?: PropertySettingsType;
+    contentPanelLayout?: ContentPanelLayout;
+    virtualExpanders?: boolean;
+  };
+};
+declare function useDocs(): DocsContextType;
+declare function useSpec(): Spec | null;
+declare function useSettings(): {
+  properties?: PropertySettingsType;
+  contentPanelLayout?: ContentPanelLayout;
+  virtualExpanders?: boolean;
+} | undefined;
+declare function useSnippets(stainlessPath: string, language?: SpecLanguage): {
+  [key: `custom:${string}`]: {
+    content: string;
+  };
+  default: {
+    content: string;
+  };
+} | undefined;
+declare function useSnippetIds(stainlessPath: string, language?: SpecLanguage): SnippetId[] | undefined;
+type SnippetId = keyof NonNullable<ReturnType<typeof useSnippets>>;
+declare function useSnippet(stainlessPath: string, language?: SpecLanguage, snippetId?: SnippetId): string | undefined;
+declare function useSnippetResponse(stainlessPath: string, snippetId?: SnippetId): {
+  status?: string;
+  content: string;
+}[] | undefined;
+type Declaration = LanguageDeclNodes[SpecLanguage];
+declare function useDeclaration<Required extends boolean>(stainlessPath: string, required: Required, language?: SpecLanguage): (Required extends true ? never : undefined) | Declaration;
+declare function useAvailableLanguages(stainlessPath: string): SpecLanguage[];
+declare function useIgnoredResources(): string[];
+declare function useResource(name: string): Resource | undefined;
+declare function useLanguage(): "http" | "node" | "python" | "go" | "typescript" | "terraform" | "ruby" | "java" | "kotlin" | "csharp" | "php" | "cli";
+declare function useContentPanelLayout(): ContentPanelLayout;
+type DocsProviderProps = DocsContextType & {
+  children: React$1.ReactNode;
+};
+declare function DocsProvider({
+  spec,
+  language,
+  settings,
+  children
+}: DocsProviderProps): react_jsx_runtime0.JSX.Element;
+//#endregion
+export { useSnippetResponse as _, DocsProviderProps as a, useContentPanelLayout as c, useIgnoredResources as d, useLanguage as f, useSnippetIds as g, useSnippet as h, DocsProvider as i, useDeclaration as l, useSettings as m, Declaration as n, PropertySettingsType as o, useResource as p, DocsContextType as r, useAvailableLanguages as s, ContentPanelLayout as t, useDocs as u, useSnippets as v, useSpec as y };