@stainless-api/docs-ui 0.1.0-beta.69 → 0.1.0-beta.70

package/dist/sdk-GMOw94wL.d.ts

@@ -0,0 +1,122 @@
+import { c as ID, d as Method, f as Model, g as SnippetLanguage, o as HasStainlessPath, t as BaseDeclaration } from "./index-CwjGm9zX.js";
+import { t as DocsLanguage } from "./routing-Cm_9XJiQ.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime30 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 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_runtime30.JSX.Element;
+type SDKDeclarationProps = {
+  path: string;
+  expand?: boolean;
+  depth?: number;
+};
+declare function SDKDeclaration({
+  path,
+  expand,
+  depth
+}: SDKDeclarationProps): react_jsx_runtime30.JSX.Element;
+type SDKConstraintsProps = {
+  constraints?: Record<string, any>;
+};
+declare function SDKConstraints({
+  constraints
+}: SDKConstraintsProps): react_jsx_runtime30.JSX.Element | undefined;
+type SDKIconProps = {
+  language: SnippetLanguage;
+  size?: number;
+};
+declare function SDKIcon({
+  language
+}: SDKIconProps): react_jsx_runtime30.JSX.Element | null;
+type SDKRequestTitleProps = {
+  snippetLanguage: SnippetLanguage;
+};
+declare function SDKRequestTitle({
+  snippetLanguage
+}: SDKRequestTitleProps): react_jsx_runtime30.JSX.Element;
+type SDKExampleProps = {
+  method: Partial<Method> & HasStainlessPath;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+declare function SDKExample({
+  method,
+  transformRequestSnippet
+}: SDKExampleProps): react_jsx_runtime30.JSX.Element;
+type SDKMethodProps = {
+  method: Method;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+declare function SDKMethodHeader({
+  method
+}: SDKMethodProps): react_jsx_runtime30.JSX.Element;
+declare function useStreamingResponse(method: BaseDeclaration): ID | undefined;
+declare function SDKMethodInfo({
+  method
+}: SDKMethodProps): react_jsx_runtime30.JSX.Element;
+declare function SDKMethodNotImplemented({
+  method
+}: SDKMethodProps): react_jsx_runtime30.JSX.Element;
+declare function SDKMethod({
+  method,
+  transformRequestSnippet
+}: SDKMethodProps): react_jsx_runtime30.JSX.Element;
+type SDKModelProps = {
+  model: Model;
+};
+declare function SDKModel({
+  model
+}: SDKModelProps): react_jsx_runtime30.JSX.Element | null;
+type SDKReferenceProps = {
+  stainlessPath: string;
+  children?: React$1.ReactNode;
+};
+declare function SDKReference({
+  stainlessPath,
+  children
+}: SDKReferenceProps): string | number | bigint | boolean | react_jsx_runtime30.JSX.Element | 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> | 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_runtime30.JSX.Element;
+//#endregion
+export { SDKSnippetLanguagesType as C, useStreamingResponse as D, useReferenceNesting as E, SDKSnippetLanguages as S, usePropertyModel as T, SDKModel as _, SDKChildren as a, SDKRequestTitle as b, SDKDeclaration as c, SDKLanguageBlock as d, SDKMethod as f, SDKMethodProps as g, SDKMethodNotImplemented as h, ReferenceNestingContextType as i, SDKExample as l, SDKMethodInfo as m, PropertyModelContextType as n, SDKConstraints as o, SDKMethodHeader as p, ReferenceNestingContext as r, SDKConstraintsProps as s, PropertyModelContext as t, SDKIcon as u, SDKModelProps as v, TransformRequestSnippetFn as w, SDKRequestTitleProps as x, SDKReference as y };

package/dist/{sdk-sidebar-JyrSuu5b.d.ts → sdk-sidebar-NCBSWuUW.d.ts}

@@ -1,5 +1,5 @@
 import { m as Resource } from "./index-CwjGm9zX.js";
-import * as react_jsx_runtime41 from "react/jsx-runtime";
+import * as react_jsx_runtime36 from "react/jsx-runtime";
 
 //#region src/components/sdk-sidebar.d.ts
 type SDKSidebarProps = {
@@ -10,6 +10,6 @@ type SDKSidebarProps = {
  */
 declare function SDKSidebar({
   resources
-}: SDKSidebarProps): react_jsx_runtime41.JSX.Element;
+}: SDKSidebarProps): react_jsx_runtime36.JSX.Element;
 //#endregion
 export { SDKSidebarProps as n, SDKSidebar as t };

package/dist/sdk-sidebar-VNY2-O1Y.d.ts

@@ -0,0 +1,15 @@
+import { m as Resource } from "./index-CwjGm9zX.js";
+import * as react_jsx_runtime29 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_runtime29.JSX.Element;
+//#endregion
+export { SDKSidebarProps as n, SDKSidebar as t };

package/dist/{snippets-DZM_ogqa.d.ts → snippets-Bj7Ey56K.d.ts}

@@ -1,7 +1,7 @@
 import { d as Method, o as HasStainlessPath } from "./index-CwjGm9zX.js";
-import { w as TransformRequestSnippetFn } from "./sdk-7I25t5FC.js";
+import { w as TransformRequestSnippetFn } from "./sdk-BvZeXpsj.js";
 import * as React$1 from "react";
-import * as react_jsx_runtime55 from "react/jsx-runtime";
+import * as react_jsx_runtime50 from "react/jsx-runtime";
 
 //#region src/components/snippets.d.ts
 type SnippetCodeProps = {
@@ -12,7 +12,7 @@ type SnippetCodeProps = {
 declare function SnippetCode({
   content,
   language
-}: SnippetCodeProps): react_jsx_runtime55.JSX.Element;
+}: SnippetCodeProps): react_jsx_runtime50.JSX.Element;
 type SnippetProps = {
   method: Partial<Method> & HasStainlessPath;
   requestTitle?: React$1.ReactNode;
@@ -25,29 +25,29 @@ type SnippetContainerProps = {
 };
 declare function SnippetContainer({
   children
-}: SnippetContainerProps): react_jsx_runtime55.JSX.Element;
+}: SnippetContainerProps): react_jsx_runtime50.JSX.Element;
 type SnippetRequestContainerProps = {
   children?: React$1.ReactNode;
   signature?: string;
 };
 declare function SnippetRequestContainer({
   children
-}: SnippetRequestContainerProps): react_jsx_runtime55.JSX.Element;
+}: SnippetRequestContainerProps): react_jsx_runtime50.JSX.Element;
 declare function Snippet({
   requestTitle,
   method,
   transformRequestSnippet
-}: SnippetProps): react_jsx_runtime55.JSX.Element | null;
+}: SnippetProps): react_jsx_runtime50.JSX.Element | null;
 declare function SnippetButtons({
   content
 }: {
   content: string;
-}): react_jsx_runtime55.JSX.Element;
+}): react_jsx_runtime50.JSX.Element;
 declare function SnippetFooter(): React$1.ReactNode;
 declare function SnippetResponse({
   responses
 }: {
   responses: Method['exampleResponses'];
-}): react_jsx_runtime55.JSX.Element | null;
+}): react_jsx_runtime50.JSX.Element | null;
 //#endregion
 export { SnippetContainer as a, SnippetProps as c, SnippetResponse as d, SnippetCodeProps as i, SnippetRequestContainer as l, SnippetButtons as n, SnippetContainerProps as o, SnippetCode as r, SnippetFooter as s, Snippet as t, SnippetRequestContainerProps as u };

package/dist/snippets-CQQSDvg2.d.ts

@@ -0,0 +1,53 @@
+import { d as Method, o as HasStainlessPath } from "./index-CwjGm9zX.js";
+import { w as TransformRequestSnippetFn } from "./sdk-GMOw94wL.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/components/snippets.d.ts
+type SnippetCodeProps = {
+  content: string;
+  signature?: string;
+  language?: string;
+};
+declare function SnippetCode({
+  content,
+  language
+}: SnippetCodeProps): react_jsx_runtime0.JSX.Element;
+type SnippetProps = {
+  method: Partial<Method> & HasStainlessPath;
+  requestTitle?: React$1.ReactNode;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+type SnippetContainerProps = {
+  method: Partial<Method> & HasStainlessPath;
+  children: React$1.ReactNode;
+  signature?: string;
+};
+declare function SnippetContainer({
+  children
+}: SnippetContainerProps): react_jsx_runtime0.JSX.Element;
+type SnippetRequestContainerProps = {
+  children?: React$1.ReactNode;
+  signature?: string;
+};
+declare function SnippetRequestContainer({
+  children
+}: SnippetRequestContainerProps): react_jsx_runtime0.JSX.Element;
+declare function Snippet({
+  requestTitle,
+  method,
+  transformRequestSnippet
+}: SnippetProps): react_jsx_runtime0.JSX.Element | null;
+declare function SnippetButtons({
+  content
+}: {
+  content: string;
+}): react_jsx_runtime0.JSX.Element;
+declare function SnippetFooter(): React$1.ReactNode;
+declare function SnippetResponse({
+  responses
+}: {
+  responses: Method['exampleResponses'];
+}): react_jsx_runtime0.JSX.Element | null;
+//#endregion
+export { SnippetContainer as a, SnippetProps as c, SnippetResponse as d, SnippetCodeProps as i, SnippetRequestContainer as l, SnippetButtons as n, SnippetContainerProps as o, SnippetCode as r, SnippetFooter as s, Snippet as t, SnippetRequestContainerProps as u };

package/dist/spec.d.ts

@@ -36,13 +36,13 @@ declare function generateNavigation(resource: Partial<Resource>): {
 declare function generateSpecForResource(spec: Spec, name: string, lang: DocsLanguage, transforms: SpecTransforms): Partial<Spec>;
 declare function transform(spec: Spec, transforms: SpecTransforms): {
   name: string;
-  lang: "cli" | "csharp" | "go" | "http" | "java" | "kotlin" | "node" | "php" | "python" | "ruby" | "terraform" | "typescript";
+  lang: "http" | "node" | "python" | "go" | "typescript" | "terraform" | "ruby" | "java" | "kotlin" | "csharp" | "php" | "cli";
   spec: Partial<Spec>;
 }[];
 declare function split(spec: Spec, transforms?: SpecTransforms): {
   resources: ReturnType<typeof transform>;
   navigation: {
-    languages: ("go" | "http" | "java" | "kotlin" | "node" | "python" | "ruby" | "terraform" | "typescript")[] | undefined;
+    languages: ("http" | "node" | "python" | "go" | "typescript" | "terraform" | "ruby" | "java" | "kotlin")[] | undefined;
     resources: {
       [k: string]: {
         title: string | undefined;

package/dist/{stl-sidebar-BR04ktwN.d.ts → stl-sidebar-CXzs_shz.d.ts}

@@ -1,5 +1,5 @@
 import { ReactNode } from "react";
-import * as react_jsx_runtime21 from "react/jsx-runtime";
+import * as react_jsx_runtime43 from "react/jsx-runtime";
 
 //#region src/components/stl-sidebar.d.ts
 declare module 'react' {
@@ -53,6 +53,6 @@ type StlSidebarProps = {
 declare function StlSidebar({
   entries,
   withStarlightRestoration
-}: StlSidebarProps): react_jsx_runtime21.JSX.Element;
+}: StlSidebarProps): react_jsx_runtime43.JSX.Element;
 //#endregion
 export { StlSidebarProps as a, StlSidebarLink as i, StlSidebarEntry as n, StlSidebarTarget as o, StlSidebarGroup as r, StlSidebar as t };

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

@@ -0,0 +1,58 @@
+import { ReactNode } from "react";
+import * as react_jsx_runtime56 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_runtime56.JSX.Element;
+//#endregion
+export { StlSidebarProps as a, StlSidebarLink as i, StlSidebarEntry as n, StlSidebarTarget as o, StlSidebarGroup as r, StlSidebar as t };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stainless-api/docs-ui",
   "private": false,
-  "version": "0.1.0-beta.69",
+  "version": "0.1.0-beta.70",
   "publishConfig": {
     "access": "public"
   },