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

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 (117) hide show
  1. package/dist/{breadcrumbs-D4R5cbSw.js → breadcrumbs-3q1o8SBZ.js} +2 -2
  2. package/dist/{breadcrumbs-C4-bfzhR.d.ts → breadcrumbs-Bu4Lz7cO.d.ts} +4 -4
  3. package/dist/{component-generics-BXUlfDmo.d.ts → component-generics-CLPqY1b3.d.ts} +2 -2
  4. package/dist/{component-5L-iyIZ6.js → component-l0Q5m3CM.js} +2 -2
  5. package/dist/components/MaskedInput.d.ts +3 -3
  6. package/dist/components/MaskedInput.js +1 -1
  7. package/dist/components/breadcrumbs.d.ts +1 -1
  8. package/dist/components/breadcrumbs.js +2 -2
  9. package/dist/components/icons.d.ts +11 -11
  10. package/dist/components/index.d.ts +10 -10
  11. package/dist/components/index.js +10 -10
  12. package/dist/components/method.d.ts +2 -2
  13. package/dist/components/method.js +3 -3
  14. package/dist/components/overview.d.ts +1 -1
  15. package/dist/components/overview.js +3 -3
  16. package/dist/components/primitives.d.ts +1 -1
  17. package/dist/components/primitives.js +1 -1
  18. package/dist/components/properties.d.ts +1 -1
  19. package/dist/components/properties.js +1 -1
  20. package/dist/components/sdk.d.ts +1 -1
  21. package/dist/components/sdk.js +1 -1
  22. package/dist/components/sidebar.d.ts +1 -1
  23. package/dist/components/sidebar.js +1 -3
  24. package/dist/components/snippets.d.ts +2 -2
  25. package/dist/components/snippets.js +1 -1
  26. package/dist/{components-DuWqBogG.js → components-BdOXrvW2.js} +8 -11
  27. package/dist/contexts/component-generics.d.ts +1 -1
  28. package/dist/contexts/component-types.d.ts +10 -10
  29. package/dist/contexts/component.d.ts +13 -13
  30. package/dist/contexts/component.js +18 -18
  31. package/dist/contexts/docs.d.ts +1 -1
  32. package/dist/contexts/index.d.ts +14 -14
  33. package/dist/contexts/markdown.d.ts +1 -1
  34. package/dist/contexts/navigation.d.ts +1 -1
  35. package/dist/contexts/use-components.d.ts +9 -9
  36. package/dist/{csharp-E3FbT47c.js → csharp-ZbePFjQO.js} +7 -7
  37. package/dist/{docs-DXW3HLam.d.ts → docs-8bJ2Zq-a.d.ts} +4 -5
  38. package/dist/{go-DNSFGJle.js → go-B0LsOWv5.js} +1 -1
  39. package/dist/{http-DXRdcllM.js → http-DhFmbdJn.js} +3 -3
  40. package/dist/index-BON8gAFi.d.ts +15 -0
  41. package/dist/index-BtmA2psc.d.ts +1587 -0
  42. package/dist/{index-CMjS_7Z-.d.ts → index-qF_YVWCx.d.ts} +48 -48
  43. package/dist/index.d.ts +15 -15
  44. package/dist/index.js +18 -18
  45. package/dist/{java-X1yS0K52.js → java-DnoViM8r.js} +1 -1
  46. package/dist/languages/csharp.d.ts +10 -10
  47. package/dist/languages/csharp.js +1 -1
  48. package/dist/languages/go.d.ts +10 -10
  49. package/dist/languages/go.js +1 -1
  50. package/dist/languages/http.d.ts +10 -10
  51. package/dist/languages/http.js +10 -10
  52. package/dist/languages/index.d.ts +10 -10
  53. package/dist/languages/index.js +17 -17
  54. package/dist/languages/java.d.ts +10 -10
  55. package/dist/languages/java.js +1 -1
  56. package/dist/languages/python.d.ts +10 -10
  57. package/dist/languages/python.js +1 -1
  58. package/dist/languages/ruby.d.ts +10 -10
  59. package/dist/languages/ruby.js +1 -1
  60. package/dist/languages/typescript.d.ts +10 -10
  61. package/dist/languages/typescript.js +1 -1
  62. package/dist/{languages-Ir9QQoCT.js → languages-DkMjjyDN.js} +7 -7
  63. package/dist/markdown/index.d.ts +5 -5
  64. package/dist/markdown/index.js +18 -18
  65. package/dist/markdown/md.js +2 -2
  66. package/dist/markdown/printer.d.ts +6 -6
  67. package/dist/markdown/printer.js +33 -32
  68. package/dist/markdown/utils.d.ts +5 -5
  69. package/dist/{markdown-DlZBWMNG.d.ts → markdown-DTp4ociY.d.ts} +2 -2
  70. package/dist/method-ClPGsX68.d.ts +59 -0
  71. package/dist/{method-nEcioXL5.js → method-pJ_RhZj-.js} +10 -35
  72. package/dist/{navigation-BO8IjmvM.d.ts → navigation-DzgC_T1S.d.ts} +3 -3
  73. package/dist/{overview-BI_asPrF.d.ts → overview-CdbaBavs.d.ts} +11 -11
  74. package/dist/{overview-D_7o7P6l.js → overview-DYiiAHTd.js} +6 -6
  75. package/dist/{primitives-Bm0Cm3Xo.d.ts → primitives-Cw5uBUQk.d.ts} +11 -11
  76. package/dist/{primitives-Dk_RvOzh.js → primitives-DHsRAENq.js} +2 -2
  77. package/dist/{properties-BGhVCqER.d.ts → properties-Bn_hArWT.d.ts} +5 -5
  78. package/dist/{properties-BTdEzx5f.js → properties-WqNSu-9K.js} +1 -1
  79. package/dist/{python-DqdvqQ9I.js → python-Bj1XJ1je.js} +1 -1
  80. package/dist/{routing-CUnVDpU-.d.ts → routing-BHkWbZpp.d.ts} +5 -5
  81. package/dist/routing.d.ts +1 -1
  82. package/dist/{ruby-CHeld1ey.js → ruby-CUOmUwz-.js} +1 -1
  83. package/dist/{sdk-DA3oRxHu.d.ts → sdk-BiLj2q7E.d.ts} +22 -22
  84. package/dist/{sdk-DEoUlY8I.js → sdk-DoprvjCy.js} +2 -2
  85. package/dist/{sidebar-D_cK7JN_.js → sidebar-4QeeafnE.js} +8 -4
  86. package/dist/{sidebar-DZQPDV-z.d.ts → sidebar-DimNfsmt.d.ts} +9 -9
  87. package/dist/{snippets-BiXJx1BL.js → snippets-BPHTjwpN.js} +11 -16
  88. package/dist/{snippets-Dg6GX-e4.d.ts → snippets-CQrk6Dfj.d.ts} +11 -11
  89. package/dist/spec.d.ts +26 -26
  90. package/dist/{style-cJZFOvnF.js → style-WTDMMzqU.js} +0 -3
  91. package/dist/style.d.ts +0 -3
  92. package/dist/style.js +1 -1
  93. package/dist/styles/main.css +10 -27
  94. package/dist/styles/primitives.css +1 -1
  95. package/dist/styles/search.css +0 -9
  96. package/dist/styles/sidebar.css +0 -4
  97. package/dist/styles.css +161 -41
  98. package/dist/{typescript-C--P_L-R.js → typescript-B4wuVmP1.js} +1 -1
  99. package/dist/utils.d.ts +6 -6
  100. package/package.json +4 -4
  101. package/dist/breadcrumbs-R-MrRUAb.d.ts +0 -25
  102. package/dist/component-generics-DK3L_HfT.d.ts +0 -30
  103. package/dist/docs-Bbe2P0iM.d.ts +0 -47
  104. package/dist/index-B0GI632t.d.ts +0 -274
  105. package/dist/index-C8y-QK_S.d.ts +0 -15
  106. package/dist/index-CXNWVE3S.d.ts +0 -15
  107. package/dist/markdown-xEaREw5e.d.ts +0 -22
  108. package/dist/method-BRfK1KuU.d.ts +0 -71
  109. package/dist/method-BUQRaC59.d.ts +0 -71
  110. package/dist/navigation-C36vzOT-.d.ts +0 -29
  111. package/dist/overview-g0IyxCAY.d.ts +0 -39
  112. package/dist/primitives-COZrZCWZ.d.ts +0 -104
  113. package/dist/properties-BqjMaZ-l.d.ts +0 -54
  114. package/dist/routing-o8okAfJK.d.ts +0 -54
  115. package/dist/sdk-tq-VoVQP.d.ts +0 -118
  116. package/dist/sidebar-sPFdjATU.d.ts +0 -36
  117. package/dist/snippets-CVckJDzp.d.ts +0 -51
@@ -1,54 +0,0 @@
1
- import { ReactNode } from "react";
2
- import * as react_jsx_runtime36 from "react/jsx-runtime";
3
-
4
- //#region src/components/properties.d.ts
5
- type PropertyToggleProps = {
6
- target: string;
7
- };
8
- declare function PropertyToggle({
9
- target
10
- }: PropertyToggleProps): react_jsx_runtime36.JSX.Element;
11
- type PropertyDescriptionProps = {
12
- description?: string;
13
- };
14
- declare function PropertyDescription({
15
- description
16
- }: PropertyDescriptionProps): react_jsx_runtime36.JSX.Element | undefined;
17
- type PropertyTitleProps = {
18
- title?: string;
19
- };
20
- declare function PropertyTitle({
21
- title
22
- }: PropertyTitleProps): react_jsx_runtime36.JSX.Element | undefined;
23
- type PropertyProps = {
24
- id?: string;
25
- name?: ReactNode;
26
- typeName?: ReactNode;
27
- badges?: ReactNode;
28
- type?: ReactNode;
29
- description?: string;
30
- title?: string;
31
- expand?: boolean;
32
- deprecated?: boolean | string;
33
- additional?: ReactNode;
34
- declaration?: ReactNode;
35
- constraints?: ReactNode;
36
- children?: ReactNode;
37
- };
38
- declare function Property({
39
- id,
40
- name,
41
- typeName,
42
- badges,
43
- type,
44
- declaration,
45
- description,
46
- title,
47
- deprecated,
48
- expand,
49
- additional,
50
- constraints,
51
- children
52
- }: PropertyProps): react_jsx_runtime36.JSX.Element;
53
- //#endregion
54
- export { PropertyTitle as a, PropertyToggleProps as c, PropertyProps as i, PropertyDescription as n, PropertyTitleProps as o, PropertyDescriptionProps as r, PropertyToggle as s, Property as t };
@@ -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 };
@@ -1,118 +0,0 @@
1
- import { t as DocsLanguage } from "./routing-CUnVDpU-.js";
2
- import * as React$1 from "react";
3
- import * as react_jsx_runtime34 from "react/jsx-runtime";
4
- import * as SDKJSON from "@stainless/sdk-json";
5
-
6
- //#region src/components/sdk.d.ts
7
- type PropertyModelContextType = {
8
- modelPath?: string;
9
- propertyPath?: string;
10
- };
11
- declare const PropertyModelContext: React$1.Context<PropertyModelContextType>;
12
- declare function usePropertyModel(): PropertyModelContextType;
13
- type ReferenceNestingContextType = string[];
14
- declare const ReferenceNestingContext: React$1.Context<ReferenceNestingContextType>;
15
- declare function useReferenceNesting(): ReferenceNestingContextType;
16
- type SDKSnippetLanguagesType = Record<SDKJSON.SnippetLanguage, {
17
- name: string;
18
- }>;
19
- declare const SDKSnippetLanguages: SDKSnippetLanguagesType;
20
- type TransformRequestSnippetFn = ({
21
- snippet,
22
- language
23
- }: {
24
- snippet: string;
25
- language: DocsLanguage;
26
- }) => string;
27
- type SDKChildrenProps = {
28
- paths: SDKJSON.ID[];
29
- expand?: boolean;
30
- depth?: number;
31
- };
32
- declare function SDKChildren({
33
- paths,
34
- expand,
35
- depth
36
- }: SDKChildrenProps): react_jsx_runtime34.JSX.Element;
37
- type SDKDeclarationProps = {
38
- path: string;
39
- expand?: boolean;
40
- depth?: number;
41
- };
42
- declare function SDKDeclaration({
43
- path,
44
- expand,
45
- depth
46
- }: SDKDeclarationProps): react_jsx_runtime34.JSX.Element;
47
- type SDKConstraintsProps = {
48
- constraints?: Record<string, any>;
49
- };
50
- declare function SDKConstraints({
51
- constraints
52
- }: SDKConstraintsProps): react_jsx_runtime34.JSX.Element | undefined;
53
- type SDKIconProps = {
54
- language: SDKJSON.SnippetLanguage;
55
- size?: number;
56
- };
57
- declare function SDKIcon({
58
- language
59
- }: SDKIconProps): react_jsx_runtime34.JSX.Element | null;
60
- type SDKRequestTitleProps = {
61
- snippetLanguage: SDKJSON.SnippetLanguage;
62
- };
63
- declare function SDKRequestTitle({
64
- snippetLanguage
65
- }: SDKRequestTitleProps): react_jsx_runtime34.JSX.Element;
66
- type SDKExampleProps = {
67
- method: SDKJSON.Method;
68
- transformRequestSnippet?: TransformRequestSnippetFn;
69
- };
70
- declare function SDKExample({
71
- method,
72
- transformRequestSnippet
73
- }: SDKExampleProps): react_jsx_runtime34.JSX.Element;
74
- type SDKMethodProps = {
75
- method: SDKJSON.Method;
76
- transformRequestSnippet?: TransformRequestSnippetFn;
77
- };
78
- declare function SDKMethodHeader({
79
- method
80
- }: SDKMethodProps): react_jsx_runtime34.JSX.Element;
81
- declare function SDKMethodInfo({
82
- method
83
- }: SDKMethodProps): react_jsx_runtime34.JSX.Element;
84
- declare function SDKMethod({
85
- method,
86
- transformRequestSnippet
87
- }: SDKMethodProps): react_jsx_runtime34.JSX.Element;
88
- type SDKModelProps = {
89
- model: SDKJSON.Model;
90
- };
91
- declare function SDKModel({
92
- model
93
- }: SDKModelProps): react_jsx_runtime34.JSX.Element | null;
94
- type SDKReferenceProps = {
95
- stainlessPath: string;
96
- children?: React$1.ReactNode;
97
- };
98
- declare function SDKReference({
99
- stainlessPath,
100
- children
101
- }: 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_runtime34.JSX.Element | null | undefined;
102
- type SDKLanguageBlockProps = {
103
- language: DocsLanguage;
104
- version: string;
105
- install: string;
106
- links: {
107
- repo: string;
108
- docs: string;
109
- };
110
- };
111
- declare function SDKLanguageBlock({
112
- language,
113
- version,
114
- install,
115
- links
116
- }: SDKLanguageBlockProps): react_jsx_runtime34.JSX.Element;
117
- //#endregion
118
- export { TransformRequestSnippetFn as C, SDKSnippetLanguagesType as S, useReferenceNesting as T, SDKModelProps as _, SDKChildren as a, SDKRequestTitleProps as b, SDKDeclaration as c, SDKLanguageBlock as d, SDKMethod as f, SDKModel as g, SDKMethodProps 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, SDKReference as v, usePropertyModel as w, SDKSnippetLanguages as x, SDKRequestTitle as y };
@@ -1,36 +0,0 @@
1
- import * as React$1 from "react";
2
- import * as react_jsx_runtime53 from "react/jsx-runtime";
3
- import * as SDKJSON from "@stainless/sdk-json";
4
-
5
- //#region src/components/sidebar.d.ts
6
- type SidebarExpanderProps = {
7
- open?: boolean;
8
- summary: React$1.ReactNode;
9
- children?: React$1.ReactNode;
10
- };
11
- declare function SidebarExpander({
12
- open,
13
- summary,
14
- children
15
- }: SidebarExpanderProps): react_jsx_runtime53.JSX.Element;
16
- type SidebarMethodProps = {
17
- method: SDKJSON.Method;
18
- };
19
- declare function SidebarMethod({
20
- method
21
- }: SidebarMethodProps): react_jsx_runtime53.JSX.Element;
22
- type SidebarResourceProps = {
23
- resource: SDKJSON.Resource;
24
- };
25
- declare function SidebarResource({
26
- resource
27
- }: SidebarResourceProps): react_jsx_runtime53.JSX.Element;
28
- type SidebarProps = {
29
- resources: SDKJSON.Resource[];
30
- selectedPath?: string;
31
- };
32
- declare function Sidebar({
33
- resources
34
- }: SidebarProps): react_jsx_runtime53.JSX.Element;
35
- //#endregion
36
- export { SidebarProps as a, SidebarMethodProps as i, SidebarExpander as n, SidebarResource as o, SidebarMethod as r, SidebarResourceProps as s, Sidebar as t };
@@ -1,51 +0,0 @@
1
- import { C as TransformRequestSnippetFn } from "./sdk-DA3oRxHu.js";
2
- import * as React$1 from "react";
3
- import * as react_jsx_runtime84 from "react/jsx-runtime";
4
- import * as SDKJSON from "@stainless/sdk-json";
5
-
6
- //#region src/components/snippets.d.ts
7
- type SnippetCodeProps = {
8
- content: string;
9
- signature?: string;
10
- language?: string;
11
- };
12
- declare function SnippetCode({
13
- content,
14
- language
15
- }: SnippetCodeProps): react_jsx_runtime84.JSX.Element;
16
- type SnippetProps = {
17
- method: SDKJSON.Method;
18
- requestTitle?: React$1.ReactNode;
19
- transformRequestSnippet?: TransformRequestSnippetFn;
20
- };
21
- type SnippetContainerProps = {
22
- children: React$1.ReactNode;
23
- signature?: string;
24
- };
25
- declare function SnippetContainer({
26
- children
27
- }: SnippetContainerProps): react_jsx_runtime84.JSX.Element;
28
- type SnippetRequestContainerProps = {
29
- children?: React$1.ReactNode;
30
- signature?: string;
31
- };
32
- declare function SnippetRequestContainer({
33
- children
34
- }: SnippetRequestContainerProps): react_jsx_runtime84.JSX.Element;
35
- declare function Snippet({
36
- requestTitle,
37
- method,
38
- transformRequestSnippet
39
- }: SnippetProps): react_jsx_runtime84.JSX.Element | null;
40
- declare function SnippetButtons({
41
- content
42
- }: {
43
- content: string;
44
- }): react_jsx_runtime84.JSX.Element;
45
- declare function SnippetResponse({
46
- responses
47
- }: {
48
- responses: SDKJSON.Method['exampleResponses'];
49
- }): react_jsx_runtime84.JSX.Element | null;
50
- //#endregion
51
- export { SnippetContainer as a, SnippetRequestContainer as c, SnippetCodeProps as i, SnippetRequestContainerProps as l, SnippetButtons as n, SnippetContainerProps as o, SnippetCode as r, SnippetProps as s, Snippet as t, SnippetResponse as u };