@stainless-api/docs-ui 0.1.0-beta.85 → 0.1.0-beta.87

package/dist/routing.js

@@ -1,5 +1,4 @@
-import { t as __exportAll } from "./chunk-BYypO7fO.js";
-
+import { t as __exportAll } from "./chunk-pbuEa-1d.js";
 //#region src/routing.ts
 var routing_exports = /* @__PURE__ */ __exportAll({
 	LanguageNames: () => LanguageNames,
@@ -201,6 +200,5 @@ function updateHistory(basePath, language, stainlessPath) {
 		language
 	}, "", path);
 }
-
 //#endregion
-export { LanguageNames, Languages, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateMissingRouteList, generateRoute, generateRouteList, getLanguageSnippet, getResource, isSupportedLanguage, parseRoute, parseStainlessPath, scrollToPath, routing_exports as t, trimStainlessPath, updateHistory, walkTree };
+export { LanguageNames, Languages, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateMissingRouteList, generateRoute, generateRouteList, getLanguageSnippet, getResource, isSupportedLanguage, parseRoute, parseStainlessPath, scrollToPath, routing_exports as t, trimStainlessPath, updateHistory, walkTree };

package/dist/sdk-BkW3MDco.d.ts

@@ -0,0 +1,128 @@
+import { _ as SnippetLanguage, c as ID, d as Method, f as Model, o as HasStainlessPath, t as BaseDeclaration } from "./index-DFr9Mesr.js";
+import { t as DocsLanguage } from "./routing-yTSG7nWM.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/components/sdk.d.ts
+type PropertyModelContextType = {
+  modelPath?: string;
+  propertyPath?: string;
+};
+declare const PropertyModelContext: React$1.Context<PropertyModelContextType>;
+declare function usePropertyModel(): PropertyModelContextType;
+type ReferenceNestingContextType = string[];
+declare const ReferenceNestingContext: React$1.Context<ReferenceNestingContextType>;
+declare function useReferenceNesting(): ReferenceNestingContextType;
+type DeclarationParentsContextType = ReadonlySet<string>;
+declare function useDeclarationParents(): DeclarationParentsContextType;
+type SDKSnippetLanguagesType = Record<SnippetLanguage, {
+  name: string;
+}>;
+declare const SDKSnippetLanguages: SDKSnippetLanguagesType;
+type TransformRequestSnippetFn = ({
+  snippet,
+  language
+}: {
+  snippet: string;
+  language: DocsLanguage;
+}) => string;
+type SDKChildrenProps = {
+  paths: ID[];
+  expand?: boolean;
+  depth?: number;
+};
+declare function SDKChildren({
+  paths,
+  expand,
+  depth
+}: SDKChildrenProps): react_jsx_runtime0.JSX.Element;
+type SDKDeclarationProps = {
+  path: string;
+  expand?: boolean;
+  depth?: number;
+};
+declare function SDKDeclaration({
+  path,
+  expand,
+  depth
+}: SDKDeclarationProps): react_jsx_runtime0.JSX.Element;
+type SDKConstraintsProps = {
+  constraints?: Record<string, unknown>;
+};
+declare function SDKConstraints({
+  constraints
+}: SDKConstraintsProps): react_jsx_runtime0.JSX.Element | undefined;
+type SDKIconProps = {
+  language: SnippetLanguage;
+  size?: number;
+};
+declare function SDKIcon({
+  language
+}: SDKIconProps): react_jsx_runtime0.JSX.Element | null;
+type SDKRequestTitleProps = {
+  snippetLanguage: SnippetLanguage;
+};
+declare function SDKRequestTitle({
+  snippetLanguage
+}: SDKRequestTitleProps): react_jsx_runtime0.JSX.Element;
+type SDKExampleProps = {
+  method: Partial<Method> & HasStainlessPath;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+declare function SDKExample({
+  method,
+  transformRequestSnippet
+}: SDKExampleProps): react_jsx_runtime0.JSX.Element;
+type SDKMethodProps = {
+  method: Method;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+declare function SDKMethodHeader({
+  method
+}: SDKMethodProps): react_jsx_runtime0.JSX.Element;
+declare function useStreamingResponse(method: BaseDeclaration): ID | undefined;
+declare function SDKMethodInfo({
+  method,
+  children
+}: SDKMethodProps & {
+  children?: React$1.ReactNode;
+}): react_jsx_runtime0.JSX.Element;
+declare function SDKMethodNotImplemented({
+  method
+}: SDKMethodProps): react_jsx_runtime0.JSX.Element;
+declare function SDKMethodInfoContent(_props: SDKMethodProps): React$1.ReactNode;
+declare function SDKMethod({
+  method,
+  transformRequestSnippet
+}: SDKMethodProps): react_jsx_runtime0.JSX.Element;
+type SDKModelProps = {
+  model: Model;
+};
+declare function SDKModel({
+  model
+}: SDKModelProps): react_jsx_runtime0.JSX.Element | null;
+type SDKReferenceProps = {
+  stainlessPath: string;
+  children?: React$1.ReactNode;
+};
+declare function SDKReference({
+  stainlessPath,
+  children
+}: SDKReferenceProps): string | number | bigint | boolean | Iterable<React$1.ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<React$1.ReactNode> | null | undefined> | react_jsx_runtime0.JSX.Element | null | undefined;
+type SDKLanguageBlockProps = {
+  language: DocsLanguage;
+  version: string;
+  install: string;
+  links: {
+    repo: string;
+    docs: string;
+  };
+};
+declare function SDKLanguageBlock({
+  language,
+  version,
+  install,
+  links
+}: SDKLanguageBlockProps): react_jsx_runtime0.JSX.Element;
+//#endregion
+export { useStreamingResponse as A, SDKRequestTitleProps as C, useDeclarationParents as D, TransformRequestSnippetFn as E, usePropertyModel as O, SDKRequestTitle as S, SDKSnippetLanguagesType as T, SDKMethodNotImplemented as _, ReferenceNestingContextType as a, SDKModelProps as b, SDKConstraintsProps as c, SDKIcon as d, SDKLanguageBlock as f, SDKMethodInfoContent as g, SDKMethodInfo as h, ReferenceNestingContext as i, useReferenceNesting as k, SDKDeclaration as l, SDKMethodHeader as m, PropertyModelContext as n, SDKChildren as o, SDKMethod as p, PropertyModelContextType as r, SDKConstraints as s, DeclarationParentsContextType as t, SDKExample as u, SDKMethodProps as v, SDKSnippetLanguages as w, SDKReference as x, SDKModel as y };

package/dist/sdk-Cx2Z7bDk.d.ts

@@ -0,0 +1,128 @@
+import { _ as SnippetLanguage, c as ID, d as Method, f as Model, o as HasStainlessPath, t as BaseDeclaration } from "./index-DFr9Mesr.js";
+import { t as DocsLanguage } from "./routing-C_fawH40.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/components/sdk.d.ts
+type PropertyModelContextType = {
+  modelPath?: string;
+  propertyPath?: string;
+};
+declare const PropertyModelContext: React$1.Context<PropertyModelContextType>;
+declare function usePropertyModel(): PropertyModelContextType;
+type ReferenceNestingContextType = string[];
+declare const ReferenceNestingContext: React$1.Context<ReferenceNestingContextType>;
+declare function useReferenceNesting(): ReferenceNestingContextType;
+type DeclarationParentsContextType = ReadonlySet<string>;
+declare function useDeclarationParents(): DeclarationParentsContextType;
+type SDKSnippetLanguagesType = Record<SnippetLanguage, {
+  name: string;
+}>;
+declare const SDKSnippetLanguages: SDKSnippetLanguagesType;
+type TransformRequestSnippetFn = ({
+  snippet,
+  language
+}: {
+  snippet: string;
+  language: DocsLanguage;
+}) => string;
+type SDKChildrenProps = {
+  paths: ID[];
+  expand?: boolean;
+  depth?: number;
+};
+declare function SDKChildren({
+  paths,
+  expand,
+  depth
+}: SDKChildrenProps): react_jsx_runtime0.JSX.Element;
+type SDKDeclarationProps = {
+  path: string;
+  expand?: boolean;
+  depth?: number;
+};
+declare function SDKDeclaration({
+  path,
+  expand,
+  depth
+}: SDKDeclarationProps): react_jsx_runtime0.JSX.Element;
+type SDKConstraintsProps = {
+  constraints?: Record<string, unknown>;
+};
+declare function SDKConstraints({
+  constraints
+}: SDKConstraintsProps): react_jsx_runtime0.JSX.Element | undefined;
+type SDKIconProps = {
+  language: SnippetLanguage;
+  size?: number;
+};
+declare function SDKIcon({
+  language
+}: SDKIconProps): react_jsx_runtime0.JSX.Element | null;
+type SDKRequestTitleProps = {
+  snippetLanguage: SnippetLanguage;
+};
+declare function SDKRequestTitle({
+  snippetLanguage
+}: SDKRequestTitleProps): react_jsx_runtime0.JSX.Element;
+type SDKExampleProps = {
+  method: Partial<Method> & HasStainlessPath;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+declare function SDKExample({
+  method,
+  transformRequestSnippet
+}: SDKExampleProps): react_jsx_runtime0.JSX.Element;
+type SDKMethodProps = {
+  method: Method;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+declare function SDKMethodHeader({
+  method
+}: SDKMethodProps): react_jsx_runtime0.JSX.Element;
+declare function useStreamingResponse(method: BaseDeclaration): ID | undefined;
+declare function SDKMethodInfo({
+  method,
+  children
+}: SDKMethodProps & {
+  children?: React$1.ReactNode;
+}): react_jsx_runtime0.JSX.Element;
+declare function SDKMethodNotImplemented({
+  method
+}: SDKMethodProps): react_jsx_runtime0.JSX.Element;
+declare function SDKMethodInfoContent(_props: SDKMethodProps): React$1.ReactNode;
+declare function SDKMethod({
+  method,
+  transformRequestSnippet
+}: SDKMethodProps): react_jsx_runtime0.JSX.Element;
+type SDKModelProps = {
+  model: Model;
+};
+declare function SDKModel({
+  model
+}: SDKModelProps): react_jsx_runtime0.JSX.Element | null;
+type SDKReferenceProps = {
+  stainlessPath: string;
+  children?: React$1.ReactNode;
+};
+declare function SDKReference({
+  stainlessPath,
+  children
+}: SDKReferenceProps): string | number | bigint | boolean | Iterable<React$1.ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<React$1.ReactNode> | null | undefined> | react_jsx_runtime0.JSX.Element | null | undefined;
+type SDKLanguageBlockProps = {
+  language: DocsLanguage;
+  version: string;
+  install: string;
+  links: {
+    repo: string;
+    docs: string;
+  };
+};
+declare function SDKLanguageBlock({
+  language,
+  version,
+  install,
+  links
+}: SDKLanguageBlockProps): react_jsx_runtime0.JSX.Element;
+//#endregion
+export { useStreamingResponse as A, SDKRequestTitleProps as C, useDeclarationParents as D, TransformRequestSnippetFn as E, usePropertyModel as O, SDKRequestTitle as S, SDKSnippetLanguagesType as T, SDKMethodNotImplemented as _, ReferenceNestingContextType as a, SDKModelProps as b, SDKConstraintsProps as c, SDKIcon as d, SDKLanguageBlock as f, SDKMethodInfoContent as g, SDKMethodInfo as h, ReferenceNestingContext as i, useReferenceNesting as k, SDKDeclaration as l, SDKMethodHeader as m, PropertyModelContext as n, SDKChildren as o, SDKMethod as p, PropertyModelContextType as r, SDKConstraints as s, DeclarationParentsContextType as t, SDKExample as u, SDKMethodProps as v, SDKSnippetLanguages as w, SDKReference as x, SDKModel as y };

package/dist/sdk-sidebar-BpDlOMat.d.ts

@@ -0,0 +1,15 @@
+import { h as Resource } from "./index-DFr9Mesr.js";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/components/sdk-sidebar.d.ts
+type SDKSidebarProps = {
+  resources: Resource[];
+};
+/**
+ * Given some SDKJSON.Resources, calls into StlSidebar with the appropriate sidebar entries.
+ */
+declare function SDKSidebar({
+  resources
+}: SDKSidebarProps): react_jsx_runtime0.JSX.Element;
+//#endregion
+export { SDKSidebarProps as n, SDKSidebar as t };

package/dist/spec.d.ts

@@ -1,5 +1,5 @@
-import { d as Method, f as Model, h as Resource, i as DeclarationNode, v as Spec, y as SpecLanguage } from "./index-pvh-w1xa.js";
-import { DocsLanguage } from "./routing.js";
+import { d as Method, f as Model, h as Resource, i as DeclarationNode, v as Spec, y as SpecLanguage } from "./index-DFr9Mesr.js";
+import { t as DocsLanguage } from "./routing-C_fawH40.js";
 
 //#region src/spec.d.ts
 type SecurityScheme = Spec['security_schemes'][number];

package/dist/spec.js

@@ -1,6 +1,5 @@
 import { Languages } from "./routing.js";
 import { isResourceEmpty } from "./utils.js";
-
 //#region src/spec.ts
 const defaultTransforms = {
 	resource: (resource) => resource,
@@ -162,6 +161,5 @@ async function retrieve(apiKey, project, revision) {
 	})).json();
 	if (typeof data.spec === "string") return parseSpec(data.spec);
 }
-
 //#endregion
-export { defineTransforms, generateNavigation, generateSpecForResource, parseSpec, retrieve, split, transform };
+export { defineTransforms, generateNavigation, generateSpecForResource, parseSpec, retrieve, split, transform };

package/dist/stl-sidebar-CKrR5ZGs.d.ts

@@ -0,0 +1,58 @@
+import { ReactNode } from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/components/stl-sidebar.d.ts
+declare module 'react' {
+  namespace JSX {
+    interface IntrinsicElements {
+      /**
+       * Custom element defined by Starlight's <SidebarPersister>.
+       */
+      'sl-sidebar-restore': React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
+    }
+  }
+}
+type StlSidebarTarget = {
+  type: 'href';
+  href: string;
+} | {
+  type: 'stainlessPath';
+  stainlessPath: string;
+};
+interface StlSidebarLink {
+  type: 'link';
+  icon?: ReactNode;
+  label: string;
+  /** Current sidebar item is highlighted. */
+  isCurrent?: boolean;
+  target: StlSidebarTarget;
+  /** Additional HTML attributes that will be attached to the anchor element. */
+  attrs?: Record<string, unknown>;
+}
+interface StlSidebarGroup {
+  type: 'group';
+  icon?: ReactNode;
+  label: string;
+  entries: Array<StlSidebarLink | StlSidebarGroup>;
+  /** Defaults to true. */
+  collapsible?: boolean;
+  collapsed?: boolean;
+  /** Current sidebar item is highlighted. */
+  isCurrent?: boolean;
+  target?: StlSidebarTarget;
+}
+type StlSidebarEntry = StlSidebarLink | StlSidebarGroup;
+type StlSidebarProps = {
+  entries: StlSidebarEntry[];
+  /**
+   * If set, add <sl-sidebar-restore> custom elements (as defined by Starlight's SidebarPersister)
+   * which are used to save/restore sidebar state.
+   */
+  withStarlightRestoration?: boolean;
+};
+declare function StlSidebar({
+  entries,
+  withStarlightRestoration
+}: StlSidebarProps): react_jsx_runtime0.JSX.Element;
+//#endregion
+export { StlSidebarProps as a, StlSidebarLink as i, StlSidebarEntry as n, StlSidebarTarget as o, StlSidebarGroup as r, StlSidebar as t };

package/dist/style.js

@@ -174,6 +174,5 @@ var style_default = {
 	BreadcrumbsNonLink: "stldocs-breadcrumbs-non-link",
 	DeepLinkButton: "stldocs-deep-link-button"
 };
-
 //#endregion
-export { style_default as default };
+export { style_default as default };