@stainless-api/docs-ui 0.1.0-beta.4 → 0.1.0-beta.40

package/dist/docs-BeJaKOCE.d.ts

@@ -0,0 +1,46 @@
+import * as React$1 from "react";
+import * as react_jsx_runtime62 from "react/jsx-runtime";
+import * as _stainless_sdk_json0 from "@stainless/sdk-json";
+import { LanguageDeclNodes, Spec, SpecLanguage } from "@stainless/sdk-json";
+
+//#region src/contexts/docs.d.ts
+type ContentPanelLayout = 'double-pane' | 'single-pane';
+type PropertySettingsType = {
+  types?: 'simple' | 'rich';
+  includeModelProperties?: boolean;
+  collapseDescription?: 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 useSnippet(stainlessPath: string, language?: SpecLanguage, variant?: string): 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 useResource(name: string): _stainless_sdk_json0.Resource | undefined;
+declare function useLanguage(): "node" | "go" | "python" | "terraform" | "http" | "typescript" | "ruby" | "java" | "kotlin";
+declare function useContentPanelLayout(): ContentPanelLayout;
+type DocsProviderProps = DocsContextType & {
+  children: React$1.ReactNode;
+};
+declare function DocsProvider({
+  spec,
+  language,
+  settings,
+  children
+}: DocsProviderProps): react_jsx_runtime62.JSX.Element;
+//#endregion
+export { PropertySettingsType as a, useDocs as c, useSettings as d, useSnippet as f, DocsProviderProps as i, useLanguage as l, DocsContextType as n, useContentPanelLayout as o, useSpec as p, DocsProvider as r, useDeclaration as s, ContentPanelLayout as t, useResource as u };

package/dist/docs-CopwX9a7.js

@@ -0,0 +1,54 @@
+import * as React$1 from "react";
+import { jsx } from "react/jsx-runtime";
+
+//#region src/contexts/docs.tsx
+const DocsContextDefaults = {
+	settings: {},
+	language: "node",
+	spec: null
+};
+const DocsContext = React$1.createContext(DocsContextDefaults);
+function useDocs() {
+	return React$1.useContext(DocsContext);
+}
+function useSpec() {
+	return useDocs().spec;
+}
+function useSettings() {
+	return useDocs().settings;
+}
+function useSnippet(stainlessPath, language, variant) {
+	const defaultLanguage = useLanguage();
+	const snippetLanguage = [language ?? defaultLanguage, variant ?? "default"].join(".");
+	return useSpec()?.snippets?.[snippetLanguage]?.[stainlessPath];
+}
+function useDeclaration(stainlessPath, required, language) {
+	const defaultLanguage = useLanguage();
+	const decl = useSpec()?.decls?.[language ?? defaultLanguage]?.[stainlessPath];
+	if (required && !decl) throw new Error(`Declaration not found for '${stainlessPath}'`);
+	return decl;
+}
+function useResource(name) {
+	return useSpec()?.resources?.[name];
+}
+function useLanguage() {
+	return useDocs().language;
+}
+function useContentPanelLayout() {
+	return useDocs().settings?.contentPanelLayout ?? "double-pane";
+}
+function DocsProvider({ spec, language, settings, children }) {
+	const value = {
+		...DocsContextDefaults,
+		spec,
+		settings: settings ?? DocsContextDefaults.settings,
+		language: language ?? DocsContextDefaults.language
+	};
+	return /* @__PURE__ */ jsx(DocsContext.Provider, {
+		value,
+		children
+	});
+}
+
+//#endregion
+export { useLanguage as a, useSnippet as c, useDocs as i, useSpec as l, useContentPanelLayout as n, useResource as o, useDeclaration as r, useSettings as s, DocsProvider as t };