@stainless-api/docs-ui 0.1.0-beta.56 → 0.1.0-beta.57

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. package/dist/{breadcrumbs-C4-bfzhR.d.ts → breadcrumbs-BFCcsaL5.d.ts} +2 -2
  2. package/dist/{breadcrumbs-D4R5cbSw.js → breadcrumbs-CCViAnPI.js} +2 -2
  3. package/dist/{breadcrumbs-R-MrRUAb.d.ts → breadcrumbs-DTHE6aca.d.ts} +2 -2
  4. package/dist/{component-5L-iyIZ6.js → component-2IFa97aV.js} +2 -2
  5. package/dist/{component-generics-BXUlfDmo.d.ts → component-generics-CXfH4VNh.d.ts} +2 -2
  6. package/dist/{component-generics-DK3L_HfT.d.ts → component-generics-Dbwqv7EL.d.ts} +2 -2
  7. package/dist/components/MaskedInput.d.ts +3 -3
  8. package/dist/components/MaskedInput.js +1 -1
  9. package/dist/components/breadcrumbs.d.ts +1 -1
  10. package/dist/components/breadcrumbs.js +2 -2
  11. package/dist/components/icons.d.ts +11 -11
  12. package/dist/components/index.d.ts +10 -10
  13. package/dist/components/index.js +10 -10
  14. package/dist/components/method.d.ts +2 -2
  15. package/dist/components/method.js +3 -3
  16. package/dist/components/overview.d.ts +1 -1
  17. package/dist/components/overview.js +3 -3
  18. package/dist/components/primitives.d.ts +1 -1
  19. package/dist/components/primitives.js +1 -1
  20. package/dist/components/properties.d.ts +1 -1
  21. package/dist/components/properties.js +1 -1
  22. package/dist/components/sdk.d.ts +1 -1
  23. package/dist/components/sdk.js +1 -1
  24. package/dist/components/sidebar.d.ts +1 -1
  25. package/dist/components/sidebar.js +1 -3
  26. package/dist/components/snippets.d.ts +2 -2
  27. package/dist/components/snippets.js +1 -1
  28. package/dist/{components-DuWqBogG.js → components-B6opXKh2.js} +8 -11
  29. package/dist/contexts/component-generics.d.ts +1 -1
  30. package/dist/contexts/component-types.d.ts +10 -10
  31. package/dist/contexts/component.d.ts +13 -13
  32. package/dist/contexts/component.js +18 -18
  33. package/dist/contexts/docs.d.ts +1 -1
  34. package/dist/contexts/index.d.ts +14 -14
  35. package/dist/contexts/markdown.d.ts +1 -1
  36. package/dist/contexts/navigation.d.ts +1 -1
  37. package/dist/contexts/use-components.d.ts +9 -9
  38. package/dist/{csharp-E3FbT47c.js → csharp-Cs2V5Q49.js} +1 -1
  39. package/dist/{docs-DXW3HLam.d.ts → docs-AUJrRqst.d.ts} +2 -2
  40. package/dist/{docs-Bbe2P0iM.d.ts → docs-BQbH-a6R.d.ts} +3 -3
  41. package/dist/{go-DNSFGJle.js → go-jtKybF5f.js} +1 -1
  42. package/dist/{http-DXRdcllM.js → http-ByTnZCdl.js} +3 -3
  43. package/dist/{index-CMjS_7Z-.d.ts → index-Bk5AWxiZ.d.ts} +30 -30
  44. package/dist/index-CBfCrZxK.d.ts +15 -0
  45. package/dist/index-CxTvYsqI.d.ts +15 -0
  46. package/dist/{index-B0GI632t.d.ts → index-DUvl24AZ.d.ts} +30 -30
  47. package/dist/index.d.ts +15 -15
  48. package/dist/index.js +18 -18
  49. package/dist/{java-X1yS0K52.js → java-CSfLt_jp.js} +1 -1
  50. package/dist/languages/csharp.d.ts +10 -10
  51. package/dist/languages/csharp.js +1 -1
  52. package/dist/languages/go.d.ts +10 -10
  53. package/dist/languages/go.js +1 -1
  54. package/dist/languages/http.d.ts +10 -10
  55. package/dist/languages/http.js +10 -10
  56. package/dist/languages/index.d.ts +10 -10
  57. package/dist/languages/index.js +17 -17
  58. package/dist/languages/java.d.ts +10 -10
  59. package/dist/languages/java.js +1 -1
  60. package/dist/languages/python.d.ts +10 -10
  61. package/dist/languages/python.js +1 -1
  62. package/dist/languages/ruby.d.ts +10 -10
  63. package/dist/languages/ruby.js +1 -1
  64. package/dist/languages/typescript.d.ts +10 -10
  65. package/dist/languages/typescript.js +1 -1
  66. package/dist/{languages-Ir9QQoCT.js → languages-X8bJZjuW.js} +7 -7
  67. package/dist/markdown/index.d.ts +1 -1
  68. package/dist/markdown/index.js +18 -18
  69. package/dist/markdown/printer.d.ts +1 -1
  70. package/dist/markdown/printer.js +19 -19
  71. package/dist/markdown/utils.d.ts +2 -2
  72. package/dist/{markdown-DlZBWMNG.d.ts → markdown-CqEZJJrZ.d.ts} +2 -2
  73. package/dist/{markdown-xEaREw5e.d.ts → markdown-V_bNKjle.d.ts} +2 -2
  74. package/dist/{method-nEcioXL5.js → method-BPsNdtwS.js} +10 -35
  75. package/dist/method-CD_dwBsB.d.ts +59 -0
  76. package/dist/method-CkGKALRi.d.ts +59 -0
  77. package/dist/{navigation-BO8IjmvM.d.ts → navigation-BlOvTCTX.d.ts} +2 -2
  78. package/dist/{navigation-C36vzOT-.d.ts → navigation-CXQA2RZo.d.ts} +3 -3
  79. package/dist/{overview-D_7o7P6l.js → overview-BslKVsRE.js} +3 -3
  80. package/dist/{overview-BI_asPrF.d.ts → overview-CVTaIlP6.d.ts} +6 -6
  81. package/dist/{overview-g0IyxCAY.d.ts → overview-DFrenwhf.d.ts} +6 -6
  82. package/dist/{primitives-Dk_RvOzh.js → primitives-CCj2Pn-o.js} +2 -2
  83. package/dist/{primitives-Bm0Cm3Xo.d.ts → primitives-Da9sUCQo.d.ts} +11 -11
  84. package/dist/{primitives-COZrZCWZ.d.ts → primitives-DiDzLHoK.d.ts} +11 -11
  85. package/dist/{properties-BGhVCqER.d.ts → properties-CEjSSMRr.d.ts} +5 -5
  86. package/dist/{properties-BqjMaZ-l.d.ts → properties-CXDSYNGL.d.ts} +5 -5
  87. package/dist/{properties-BTdEzx5f.js → properties-DhttBLpf.js} +1 -1
  88. package/dist/{python-DqdvqQ9I.js → python-BU7eaJMy.js} +1 -1
  89. package/dist/routing.d.ts +1 -1
  90. package/dist/{ruby-CHeld1ey.js → ruby-LiJ6VW-R.js} +1 -1
  91. package/dist/{sdk-tq-VoVQP.d.ts → sdk-CL6r5JlK.d.ts} +1 -1
  92. package/dist/{sdk-DEoUlY8I.js → sdk-CbNqFzOI.js} +2 -2
  93. package/dist/{sdk-DA3oRxHu.d.ts → sdk-CenwRRXT.d.ts} +14 -14
  94. package/dist/{sidebar-DZQPDV-z.d.ts → sidebar-BDwx6h14.d.ts} +5 -5
  95. package/dist/{sidebar-sPFdjATU.d.ts → sidebar-CcX4PdH0.d.ts} +5 -5
  96. package/dist/{sidebar-D_cK7JN_.js → sidebar-ZNWRDHyv.js} +7 -3
  97. package/dist/{snippets-BiXJx1BL.js → snippets-CO4kIovz.js} +6 -5
  98. package/dist/{snippets-CVckJDzp.d.ts → snippets-DePfv2T6.d.ts} +8 -8
  99. package/dist/{snippets-Dg6GX-e4.d.ts → snippets-ykHHsG1B.d.ts} +8 -8
  100. package/dist/spec.d.ts +3 -3
  101. package/dist/{style-cJZFOvnF.js → style-Vk87Pfuy.js} +0 -2
  102. package/dist/style.d.ts +0 -2
  103. package/dist/style.js +1 -1
  104. package/dist/styles/main.css +1 -26
  105. package/dist/styles/primitives.css +1 -1
  106. package/dist/styles/search.css +0 -9
  107. package/dist/styles/sidebar.css +0 -4
  108. package/dist/styles.css +152 -40
  109. package/dist/{typescript-C--P_L-R.js → typescript-C8J1uyak.js} +1 -1
  110. package/package.json +2 -2
  111. package/dist/index-C8y-QK_S.d.ts +0 -15
  112. package/dist/index-CXNWVE3S.d.ts +0 -15
  113. package/dist/method-BRfK1KuU.d.ts +0 -71
  114. package/dist/method-BUQRaC59.d.ts +0 -71
  115. package/dist/routing-o8okAfJK.d.ts +0 -54
@@ -1,15 +0,0 @@
1
- import { a as Join, c as ListViewProps, d as ToggleButtonProps, f as Tooltip, i as InputProps, l as Markdown, n as Expander, o as Link, p as VirtualExpander, r as Input, s as ListView, t as Badge, u as ToggleButton } from "./primitives-Bm0Cm3Xo.js";
2
- import { n as generateApiBreadcrumbs, t as SDKBreadcrumbs } from "./breadcrumbs-R-MrRUAb.js";
3
- import { a as MethodDescription, c as MethodHeaderProps, d as MethodInfo, f as MethodInfoProps, h as MethodRouteProps, i as Method, l as MethodIconBadge, m as MethodRoute, n as HttpMethodIcons, o as MethodDescriptionProps, p as MethodProps, r as HttpMethods, s as MethodHeader, t as HTTPMethod, u as MethodIconProps } from "./method-BUQRaC59.js";
4
- import { a as PropertyTitle, c as PropertyToggleProps, i as PropertyProps, n as PropertyDescription, o as PropertyTitleProps, r as PropertyDescriptionProps, s as PropertyToggle, t as Property } from "./properties-BGhVCqER.js";
5
- import { C as TransformRequestSnippetFn, S as SDKSnippetLanguagesType, T as useReferenceNesting, _ as SDKModelProps, a as SDKChildren, b as SDKRequestTitleProps, c as SDKDeclaration, d as SDKLanguageBlock, f as SDKMethod, g as SDKModel, h as SDKMethodProps, i as ReferenceNestingContextType, l as SDKExample, m as SDKMethodInfo, n as PropertyModelContextType, o as SDKConstraints, p as SDKMethodHeader, r as ReferenceNestingContext, s as SDKConstraintsProps, t as PropertyModelContext, u as SDKIcon, v as SDKReference, w as usePropertyModel, x as SDKSnippetLanguages, y as SDKRequestTitle } from "./sdk-tq-VoVQP.js";
6
- import { a as SnippetContainer, c as SnippetRequestContainer, i as SnippetCodeProps, l as SnippetRequestContainerProps, n as SnippetButtons, o as SnippetContainerProps, r as SnippetCode, s as SnippetProps, t as Snippet, u as SnippetResponse } from "./snippets-Dg6GX-e4.js";
7
- import { a as SDKResource, c as SDKRoot, i as SDKOverviewProps, l as SDKRootProps, n as SDKMethodSummaryProps, o as SDKResourceHeader, r as SDKOverview, s as SDKResourceProps, t as SDKMethodSummary } from "./overview-g0IyxCAY.js";
8
- import { a as SidebarProps, i as SidebarMethodProps, n as SidebarExpander, o as SidebarResource, r as SidebarMethod, s as SidebarResourceProps, t as Sidebar } from "./sidebar-DZQPDV-z.js";
9
-
10
- //#region src/components/index.d.ts
11
- declare namespace index_d_exports {
12
- export { Badge, Expander, HTTPMethod, HttpMethodIcons, HttpMethods, Input, InputProps, Join, Link, ListView, ListViewProps, Markdown, Method, MethodDescription, MethodDescriptionProps, MethodHeader, MethodHeaderProps, MethodIconBadge, MethodIconProps, MethodInfo, MethodInfoProps, MethodProps, MethodRoute, MethodRouteProps, Property, PropertyDescription, PropertyDescriptionProps, PropertyModelContext, PropertyModelContextType, PropertyProps, PropertyTitle, PropertyTitleProps, PropertyToggle, PropertyToggleProps, ReferenceNestingContext, ReferenceNestingContextType, SDKBreadcrumbs, SDKChildren, SDKConstraints, SDKConstraintsProps, SDKDeclaration, SDKExample, SDKIcon, SDKLanguageBlock, SDKMethod, SDKMethodHeader, SDKMethodInfo, SDKMethodProps, SDKMethodSummary, SDKMethodSummaryProps, SDKModel, SDKModelProps, SDKOverview, SDKOverviewProps, SDKReference, SDKRequestTitle, SDKRequestTitleProps, SDKResource, SDKResourceHeader, SDKResourceProps, SDKRoot, SDKRootProps, SDKSnippetLanguages, SDKSnippetLanguagesType, Sidebar, SidebarExpander, SidebarMethod, SidebarMethodProps, SidebarProps, SidebarResource, SidebarResourceProps, Snippet, SnippetButtons, SnippetCode, SnippetCodeProps, SnippetContainer, SnippetContainerProps, SnippetProps, SnippetRequestContainer, SnippetRequestContainerProps, SnippetResponse, ToggleButton, ToggleButtonProps, Tooltip, TransformRequestSnippetFn, VirtualExpander, generateApiBreadcrumbs, usePropertyModel, useReferenceNesting };
13
- }
14
- //#endregion
15
- export { index_d_exports as t };
@@ -1,71 +0,0 @@
1
- import * as React$1 from "react";
2
- import { ReactNode } from "react";
3
- import * as react_jsx_runtime15 from "react/jsx-runtime";
4
- import { LucideIcon } from "lucide-react";
5
-
6
- //#region src/components/method.d.ts
7
- declare const HttpMethods: string[];
8
- type HTTPMethod = (typeof HttpMethods)[number];
9
- declare const HttpMethodIcons: Record<HTTPMethod, LucideIcon>;
10
- type MethodIconProps = {
11
- httpMethod?: string;
12
- showName?: boolean;
13
- };
14
- declare function MethodIconBadge({
15
- httpMethod,
16
- showName
17
- }: MethodIconProps): react_jsx_runtime15.JSX.Element | null;
18
- type MethodHeaderProps = {
19
- title: ReactNode;
20
- level?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5';
21
- signature?: ReactNode;
22
- badges?: ReactNode;
23
- children?: ReactNode;
24
- };
25
- declare function MethodHeader({
26
- title,
27
- badges,
28
- signature,
29
- children,
30
- level
31
- }: MethodHeaderProps): react_jsx_runtime15.JSX.Element;
32
- type MethodRouteProps = {
33
- httpMethod?: string;
34
- endpoint?: string | ReactNode;
35
- iconOnly?: boolean;
36
- };
37
- declare function MethodRoute({
38
- httpMethod,
39
- endpoint,
40
- iconOnly
41
- }: MethodRouteProps): react_jsx_runtime15.JSX.Element;
42
- type MethodDescriptionProps = {
43
- description?: string;
44
- };
45
- declare function MethodDescription({
46
- description
47
- }: MethodDescriptionProps): react_jsx_runtime15.JSX.Element | undefined;
48
- type MethodInfoProps = {
49
- children?: ReactNode;
50
- parameters?: ReactNode;
51
- returns?: ReactNode;
52
- };
53
- declare function MethodInfo({
54
- children,
55
- parameters,
56
- returns
57
- }: MethodInfoProps): react_jsx_runtime15.JSX.Element;
58
- type MethodProps = {
59
- id?: string;
60
- header?: ReactNode;
61
- children?: ReactNode;
62
- } & React$1.HTMLProps<HTMLDivElement>;
63
- declare function Method({
64
- id,
65
- header,
66
- children,
67
- className,
68
- ...props
69
- }: MethodProps): react_jsx_runtime15.JSX.Element;
70
- //#endregion
71
- export { MethodDescription as a, MethodHeaderProps as c, MethodInfo as d, MethodInfoProps as f, MethodRouteProps as h, Method as i, MethodIconBadge as l, MethodRoute as m, HttpMethodIcons as n, MethodDescriptionProps as o, MethodProps as p, HttpMethods as r, MethodHeader as s, HTTPMethod as t, MethodIconProps as u };
@@ -1,71 +0,0 @@
1
- import * as React$1 from "react";
2
- import { ReactNode } from "react";
3
- import * as react_jsx_runtime85 from "react/jsx-runtime";
4
- import { LucideIcon } from "lucide-react";
5
-
6
- //#region src/components/method.d.ts
7
- declare const HttpMethods: string[];
8
- type HTTPMethod = (typeof HttpMethods)[number];
9
- declare const HttpMethodIcons: Record<HTTPMethod, LucideIcon>;
10
- type MethodIconProps = {
11
- httpMethod?: string;
12
- showName?: boolean;
13
- };
14
- declare function MethodIconBadge({
15
- httpMethod,
16
- showName
17
- }: MethodIconProps): react_jsx_runtime85.JSX.Element | null;
18
- type MethodHeaderProps = {
19
- title: ReactNode;
20
- level?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5';
21
- signature?: ReactNode;
22
- badges?: ReactNode;
23
- children?: ReactNode;
24
- };
25
- declare function MethodHeader({
26
- title,
27
- badges,
28
- signature,
29
- children,
30
- level
31
- }: MethodHeaderProps): react_jsx_runtime85.JSX.Element;
32
- type MethodRouteProps = {
33
- httpMethod?: string;
34
- endpoint?: string | ReactNode;
35
- iconOnly?: boolean;
36
- };
37
- declare function MethodRoute({
38
- httpMethod,
39
- endpoint,
40
- iconOnly
41
- }: MethodRouteProps): react_jsx_runtime85.JSX.Element;
42
- type MethodDescriptionProps = {
43
- description?: string;
44
- };
45
- declare function MethodDescription({
46
- description
47
- }: MethodDescriptionProps): react_jsx_runtime85.JSX.Element | undefined;
48
- type MethodInfoProps = {
49
- children?: ReactNode;
50
- parameters?: ReactNode;
51
- returns?: ReactNode;
52
- };
53
- declare function MethodInfo({
54
- children,
55
- parameters,
56
- returns
57
- }: MethodInfoProps): react_jsx_runtime85.JSX.Element;
58
- type MethodProps = {
59
- id?: string;
60
- header?: ReactNode;
61
- children?: ReactNode;
62
- } & React$1.HTMLProps<HTMLDivElement>;
63
- declare function Method({
64
- id,
65
- header,
66
- children,
67
- className,
68
- ...props
69
- }: MethodProps): react_jsx_runtime85.JSX.Element;
70
- //#endregion
71
- export { MethodDescription as a, MethodHeaderProps as c, MethodInfo as d, MethodInfoProps as f, MethodRouteProps as h, Method as i, MethodIconBadge as l, MethodRoute as m, HttpMethodIcons as n, MethodDescriptionProps as o, MethodProps as p, HttpMethods as r, MethodHeader as s, HTTPMethod as t, MethodIconProps as u };
@@ -1,54 +0,0 @@
1
- import * as SDKJSON from "@stainless/sdk-json";
2
-
3
- //#region src/routing.d.ts
4
- declare namespace routing_d_exports {
5
- export { DocsLanguage, LanguageNames, Languages, ParsedStainlessPath, RouteEntry, SpecTreeEntry, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateRoute, generateRouteList, getLanguageSnippet, getResource, isSupportedLanguage, parseRoute, parseStainlessPath, scrollToPath, trimStainlessPath, updateHistory, walkTree };
6
- }
7
- declare const Languages: readonly ["http", "node", "python", "go", "typescript", "terraform", "ruby", "java", "kotlin", "csharp", "php"];
8
- declare const SupportedLanguageSyntaxes: string[];
9
- type DocsLanguage = (typeof Languages)[number];
10
- declare const LanguageNames: Record<DocsLanguage, string>;
11
- declare function getLanguageSnippet(language: DocsLanguage): "http.curl" | "node.default" | "go.default" | "python.default" | "terraform.default" | "typescript.default" | "ruby.default" | "java.default" | "kotlin.default" | "csharp.default" | "php.default";
12
- declare function isSupportedLanguage(language: string): language is DocsLanguage;
13
- type ParsedStainlessPath = ReturnType<typeof parseStainlessPath>;
14
- declare function parseStainlessPath(stainlessPath: string): {
15
- resource: string[] | null;
16
- method: string | null;
17
- model: string | null;
18
- routable: string | undefined;
19
- } | null;
20
- declare function trimStainlessPath(stainlessPath: string): string;
21
- declare function getResource(stainlessPath: string): string | undefined;
22
- declare function parseRoute(basePath: string, route: string): {
23
- stainlessPath: string;
24
- language: DocsLanguage;
25
- };
26
- declare function generateRoute(basePath: string, language: string, stainlessPath: string): string | null;
27
- type SpecTreeEntry = {
28
- data: SDKJSON.Method | SDKJSON.Resource | SDKJSON.Model;
29
- path: string[];
30
- };
31
- declare function walkTree(spec: SDKJSON.Spec, includeModels?: boolean): Generator<SpecTreeEntry, void, any>;
32
- type RouteEntry = {
33
- title: string;
34
- kind: SpecTreeEntry['data']['kind'];
35
- language: DocsLanguage;
36
- stainlessPath: string;
37
- slug: string;
38
- };
39
- declare function generateRouteList({
40
- spec,
41
- languages,
42
- excludeLanguages
43
- }: {
44
- spec: SDKJSON.Spec;
45
- languages?: DocsLanguage[];
46
- excludeLanguages?: DocsLanguage[];
47
- }): RouteEntry[];
48
- type ResourceOrMethod = SDKJSON.Resource | SDKJSON.Method;
49
- declare function findNavigationPath(items: ResourceOrMethod[], target: string): string[] | undefined;
50
- declare function expandToElement(el: HTMLElement | null): void;
51
- declare function scrollToPath(stainlessPath: string): void;
52
- declare function updateHistory(basePath: string, language: DocsLanguage, stainlessPath: string): void;
53
- //#endregion
54
- export { routing_d_exports as _, RouteEntry as a, updateHistory as b, expandToElement as c, generateRouteList as d, getLanguageSnippet as f, parseStainlessPath as g, parseRoute as h, ParsedStainlessPath as i, findNavigationPath as l, isSupportedLanguage as m, LanguageNames as n, SpecTreeEntry as o, getResource as p, Languages as r, SupportedLanguageSyntaxes as s, DocsLanguage as t, generateRoute as u, scrollToPath as v, walkTree as x, trimStainlessPath as y };