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

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 (87) hide show
  1. package/dist/{breadcrumbs-BhYwbXkc.d.ts → breadcrumbs-7G1MoVzo.d.ts} +2 -2
  2. package/dist/{cli-F3kMmeoJ.js → cli-DhMMZoiU.js} +1 -1
  3. package/dist/{component-P9sn5yyG.js → component-Drp93QK-.js} +2 -2
  4. package/dist/{component-generics-zU0Pqx8m.d.ts → component-generics-5cSjFCLn.d.ts} +2 -2
  5. package/dist/{component-generics-ByGsYTc8.d.ts → component-generics-t_S0Wc9i.d.ts} +2 -2
  6. package/dist/components/MaskedInput.d.ts +3 -3
  7. package/dist/components/breadcrumbs.d.ts +1 -1
  8. package/dist/components/icons.d.ts +12 -12
  9. package/dist/components/index.d.ts +10 -10
  10. package/dist/components/index.js +4 -4
  11. package/dist/components/method.d.ts +1 -1
  12. package/dist/components/method.js +2 -2
  13. package/dist/components/overview.d.ts +1 -1
  14. package/dist/components/overview.js +2 -2
  15. package/dist/components/primitives.d.ts +1 -1
  16. package/dist/components/properties.d.ts +1 -1
  17. package/dist/components/properties.js +1 -1
  18. package/dist/components/sdk-sidebar.d.ts +1 -1
  19. package/dist/components/sdk.d.ts +1 -1
  20. package/dist/components/snippets.d.ts +2 -2
  21. package/dist/components/stl-sidebar.d.ts +1 -1
  22. package/dist/{components-w1JmIrB0.js → components-BbJAAdUU.js} +3 -3
  23. package/dist/contexts/component-generics.d.ts +1 -1
  24. package/dist/contexts/component-types.d.ts +11 -11
  25. package/dist/contexts/component.d.ts +14 -14
  26. package/dist/contexts/component.js +8 -8
  27. package/dist/contexts/docs.d.ts +1 -1
  28. package/dist/contexts/index.d.ts +15 -15
  29. package/dist/contexts/markdown.d.ts +1 -1
  30. package/dist/contexts/navigation.d.ts +1 -1
  31. package/dist/contexts/use-components.d.ts +10 -10
  32. package/dist/{docs-z3fl2eW-.d.ts → docs---kdT2w-.d.ts} +3 -3
  33. package/dist/{docs-g4IPmtZr.d.ts → docs-CceV-0oK.d.ts} +4 -4
  34. package/dist/{http-fOPCX17A.js → http-DVyJ-D6t.js} +1 -1
  35. package/dist/{index-B8Zys1C2.d.ts → index-Bc1tYWPC.d.ts} +39 -39
  36. package/dist/{index-C5Zmb2CI.d.ts → index-Cuw1pZs8.d.ts} +8 -8
  37. package/dist/{index-D7PkxNgB.d.ts → index-DIchpgQZ.d.ts} +9 -9
  38. package/dist/{index-DIaM6Ync.d.ts → index-DSeLOs29.d.ts} +39 -39
  39. package/dist/index.d.ts +16 -16
  40. package/dist/index.js +7 -7
  41. package/dist/languages/cli.d.ts +11 -11
  42. package/dist/languages/cli.js +6 -6
  43. package/dist/languages/csharp.d.ts +11 -11
  44. package/dist/languages/go.d.ts +11 -11
  45. package/dist/languages/http.d.ts +11 -11
  46. package/dist/languages/http.js +5 -5
  47. package/dist/languages/index.d.ts +11 -11
  48. package/dist/languages/index.js +7 -7
  49. package/dist/languages/java.d.ts +11 -11
  50. package/dist/languages/python.d.ts +11 -11
  51. package/dist/languages/ruby.d.ts +11 -11
  52. package/dist/languages/terraform.d.ts +11 -11
  53. package/dist/languages/typescript.d.ts +11 -11
  54. package/dist/{languages-B6eap2M6.js → languages-C8iNdbjN.js} +2 -2
  55. package/dist/markdown/index.d.ts +1 -1
  56. package/dist/markdown/index.js +8 -8
  57. package/dist/markdown/printer.d.ts +1 -1
  58. package/dist/markdown/printer.js +8 -8
  59. package/dist/markdown/utils.d.ts +2 -2
  60. package/dist/{markdown-Cibv9fDR.d.ts → markdown-HJXGh2Yn.d.ts} +2 -2
  61. package/dist/{method-630cPKDl.d.ts → method-DPnfsySL.d.ts} +6 -6
  62. package/dist/{method-BzkPRXGL.d.ts → method-R97dH39J.d.ts} +6 -6
  63. package/dist/{method-BPDUyBlD.js → method-iAV6cZjF.js} +1 -1
  64. package/dist/{navigation-BW-SBvb4.d.ts → navigation-QXH2ufM3.d.ts} +2 -2
  65. package/dist/{navigation-DWYqC_HX.d.ts → navigation-dh0gX_lm.d.ts} +3 -3
  66. package/dist/{overview-Cui1XtuC.d.ts → overview-BR3WhCoz.d.ts} +6 -6
  67. package/dist/{overview-DFwfIK6k.js → overview-DQIrvYJr.js} +1 -1
  68. package/dist/{overview-RXc9iPzz.d.ts → overview-Ddh84S6_.d.ts} +6 -6
  69. package/dist/{primitives-DhGxFYx6.d.ts → primitives-D0h4FgbU.d.ts} +11 -11
  70. package/dist/{primitives-MsH-h0bU.d.ts → primitives-xbTKYFgQ.d.ts} +11 -11
  71. package/dist/{properties-Bynmj9_H.d.ts → properties-CjUi1Cjx.d.ts} +5 -5
  72. package/dist/{properties-BnbBKd5a.js → properties-PNuJPLqP.js} +9 -3
  73. package/dist/{properties-C9W4QJ_F.d.ts → properties-q3XaAaRo.d.ts} +5 -5
  74. package/dist/routing.d.ts +1 -1
  75. package/dist/{sdk-BvZeXpsj.d.ts → sdk-CSKStkB5.d.ts} +14 -14
  76. package/dist/{sdk-GMOw94wL.d.ts → sdk-D3U444dU.d.ts} +15 -15
  77. package/dist/{sdk-sidebar-NCBSWuUW.d.ts → sdk-sidebar-Cf04O8rR.d.ts} +2 -2
  78. package/dist/{sdk-sidebar-VNY2-O1Y.d.ts → sdk-sidebar-f7SS4xxq.d.ts} +2 -2
  79. package/dist/{snippets-Bj7Ey56K.d.ts → snippets-CMtWGDSE.d.ts} +8 -8
  80. package/dist/{snippets-CQQSDvg2.d.ts → snippets-DZAozdda.d.ts} +8 -8
  81. package/dist/spec.d.ts +3 -3
  82. package/dist/{stl-sidebar-CXzs_shz.d.ts → stl-sidebar-CItXFC3n.d.ts} +2 -2
  83. package/dist/{stl-sidebar-DSkUHwcU.d.ts → stl-sidebar-DpnXVa_V.d.ts} +2 -2
  84. package/dist/styles/main.css +6 -0
  85. package/dist/styles.css +6 -0
  86. package/package.json +1 -1
  87. package/dist/routing-Cm_9XJiQ.d.ts +0 -61
@@ -1,5 +1,5 @@
1
1
  import { m as Resource } from "./index-CwjGm9zX.js";
2
- import * as react_jsx_runtime36 from "react/jsx-runtime";
2
+ import * as react_jsx_runtime58 from "react/jsx-runtime";
3
3
 
4
4
  //#region src/components/sdk-sidebar.d.ts
5
5
  type SDKSidebarProps = {
@@ -10,6 +10,6 @@ type SDKSidebarProps = {
10
10
  */
11
11
  declare function SDKSidebar({
12
12
  resources
13
- }: SDKSidebarProps): react_jsx_runtime36.JSX.Element;
13
+ }: SDKSidebarProps): react_jsx_runtime58.JSX.Element;
14
14
  //#endregion
15
15
  export { SDKSidebarProps as n, SDKSidebar as t };
@@ -1,5 +1,5 @@
1
1
  import { m as Resource } from "./index-CwjGm9zX.js";
2
- import * as react_jsx_runtime29 from "react/jsx-runtime";
2
+ import * as react_jsx_runtime43 from "react/jsx-runtime";
3
3
 
4
4
  //#region src/components/sdk-sidebar.d.ts
5
5
  type SDKSidebarProps = {
@@ -10,6 +10,6 @@ type SDKSidebarProps = {
10
10
  */
11
11
  declare function SDKSidebar({
12
12
  resources
13
- }: SDKSidebarProps): react_jsx_runtime29.JSX.Element;
13
+ }: SDKSidebarProps): react_jsx_runtime43.JSX.Element;
14
14
  //#endregion
15
15
  export { SDKSidebarProps as n, SDKSidebar as t };
@@ -1,7 +1,7 @@
1
1
  import { d as Method, o as HasStainlessPath } from "./index-CwjGm9zX.js";
2
- import { w as TransformRequestSnippetFn } from "./sdk-BvZeXpsj.js";
2
+ import { w as TransformRequestSnippetFn } from "./sdk-D3U444dU.js";
3
3
  import * as React$1 from "react";
4
- import * as react_jsx_runtime50 from "react/jsx-runtime";
4
+ import * as react_jsx_runtime72 from "react/jsx-runtime";
5
5
 
6
6
  //#region src/components/snippets.d.ts
7
7
  type SnippetCodeProps = {
@@ -12,7 +12,7 @@ type SnippetCodeProps = {
12
12
  declare function SnippetCode({
13
13
  content,
14
14
  language
15
- }: SnippetCodeProps): react_jsx_runtime50.JSX.Element;
15
+ }: SnippetCodeProps): react_jsx_runtime72.JSX.Element;
16
16
  type SnippetProps = {
17
17
  method: Partial<Method> & HasStainlessPath;
18
18
  requestTitle?: React$1.ReactNode;
@@ -25,29 +25,29 @@ type SnippetContainerProps = {
25
25
  };
26
26
  declare function SnippetContainer({
27
27
  children
28
- }: SnippetContainerProps): react_jsx_runtime50.JSX.Element;
28
+ }: SnippetContainerProps): react_jsx_runtime72.JSX.Element;
29
29
  type SnippetRequestContainerProps = {
30
30
  children?: React$1.ReactNode;
31
31
  signature?: string;
32
32
  };
33
33
  declare function SnippetRequestContainer({
34
34
  children
35
- }: SnippetRequestContainerProps): react_jsx_runtime50.JSX.Element;
35
+ }: SnippetRequestContainerProps): react_jsx_runtime72.JSX.Element;
36
36
  declare function Snippet({
37
37
  requestTitle,
38
38
  method,
39
39
  transformRequestSnippet
40
- }: SnippetProps): react_jsx_runtime50.JSX.Element | null;
40
+ }: SnippetProps): react_jsx_runtime72.JSX.Element | null;
41
41
  declare function SnippetButtons({
42
42
  content
43
43
  }: {
44
44
  content: string;
45
- }): react_jsx_runtime50.JSX.Element;
45
+ }): react_jsx_runtime72.JSX.Element;
46
46
  declare function SnippetFooter(): React$1.ReactNode;
47
47
  declare function SnippetResponse({
48
48
  responses
49
49
  }: {
50
50
  responses: Method['exampleResponses'];
51
- }): react_jsx_runtime50.JSX.Element | null;
51
+ }): react_jsx_runtime72.JSX.Element | null;
52
52
  //#endregion
53
53
  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 };
@@ -1,7 +1,7 @@
1
1
  import { d as Method, o as HasStainlessPath } from "./index-CwjGm9zX.js";
2
- import { w as TransformRequestSnippetFn } from "./sdk-GMOw94wL.js";
2
+ import { w as TransformRequestSnippetFn } from "./sdk-CSKStkB5.js";
3
3
  import * as React$1 from "react";
4
- import * as react_jsx_runtime0 from "react/jsx-runtime";
4
+ import * as react_jsx_runtime61 from "react/jsx-runtime";
5
5
 
6
6
  //#region src/components/snippets.d.ts
7
7
  type SnippetCodeProps = {
@@ -12,7 +12,7 @@ type SnippetCodeProps = {
12
12
  declare function SnippetCode({
13
13
  content,
14
14
  language
15
- }: SnippetCodeProps): react_jsx_runtime0.JSX.Element;
15
+ }: SnippetCodeProps): react_jsx_runtime61.JSX.Element;
16
16
  type SnippetProps = {
17
17
  method: Partial<Method> & HasStainlessPath;
18
18
  requestTitle?: React$1.ReactNode;
@@ -25,29 +25,29 @@ type SnippetContainerProps = {
25
25
  };
26
26
  declare function SnippetContainer({
27
27
  children
28
- }: SnippetContainerProps): react_jsx_runtime0.JSX.Element;
28
+ }: SnippetContainerProps): react_jsx_runtime61.JSX.Element;
29
29
  type SnippetRequestContainerProps = {
30
30
  children?: React$1.ReactNode;
31
31
  signature?: string;
32
32
  };
33
33
  declare function SnippetRequestContainer({
34
34
  children
35
- }: SnippetRequestContainerProps): react_jsx_runtime0.JSX.Element;
35
+ }: SnippetRequestContainerProps): react_jsx_runtime61.JSX.Element;
36
36
  declare function Snippet({
37
37
  requestTitle,
38
38
  method,
39
39
  transformRequestSnippet
40
- }: SnippetProps): react_jsx_runtime0.JSX.Element | null;
40
+ }: SnippetProps): react_jsx_runtime61.JSX.Element | null;
41
41
  declare function SnippetButtons({
42
42
  content
43
43
  }: {
44
44
  content: string;
45
- }): react_jsx_runtime0.JSX.Element;
45
+ }): react_jsx_runtime61.JSX.Element;
46
46
  declare function SnippetFooter(): React$1.ReactNode;
47
47
  declare function SnippetResponse({
48
48
  responses
49
49
  }: {
50
50
  responses: Method['exampleResponses'];
51
- }): react_jsx_runtime0.JSX.Element | null;
51
+ }): react_jsx_runtime61.JSX.Element | null;
52
52
  //#endregion
53
53
  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 CHANGED
@@ -1,5 +1,5 @@
1
1
  import { _ as Spec, d as Method, f as Model, i as DeclarationNode, m as Resource, v as SpecLanguage } from "./index-CwjGm9zX.js";
2
- import { t as DocsLanguage } from "./routing-Cm_9XJiQ.js";
2
+ import { t as DocsLanguage } from "./routing-utiR5mY3.js";
3
3
 
4
4
  //#region src/spec.d.ts
5
5
  type SecurityScheme = Spec['security_schemes'][number];
@@ -36,13 +36,13 @@ declare function generateNavigation(resource: Partial<Resource>): {
36
36
  declare function generateSpecForResource(spec: Spec, name: string, lang: DocsLanguage, transforms: SpecTransforms): Partial<Spec>;
37
37
  declare function transform(spec: Spec, transforms: SpecTransforms): {
38
38
  name: string;
39
- lang: "http" | "node" | "python" | "go" | "typescript" | "terraform" | "ruby" | "java" | "kotlin" | "csharp" | "php" | "cli";
39
+ lang: "cli" | "csharp" | "go" | "http" | "java" | "kotlin" | "node" | "php" | "python" | "ruby" | "terraform" | "typescript";
40
40
  spec: Partial<Spec>;
41
41
  }[];
42
42
  declare function split(spec: Spec, transforms?: SpecTransforms): {
43
43
  resources: ReturnType<typeof transform>;
44
44
  navigation: {
45
- languages: ("http" | "node" | "python" | "go" | "typescript" | "terraform" | "ruby" | "java" | "kotlin")[] | undefined;
45
+ languages: ("go" | "http" | "java" | "kotlin" | "node" | "python" | "ruby" | "terraform" | "typescript")[] | undefined;
46
46
  resources: {
47
47
  [k: string]: {
48
48
  title: string | undefined;
@@ -1,5 +1,5 @@
1
1
  import { ReactNode } from "react";
2
- import * as react_jsx_runtime43 from "react/jsx-runtime";
2
+ import * as react_jsx_runtime78 from "react/jsx-runtime";
3
3
 
4
4
  //#region src/components/stl-sidebar.d.ts
5
5
  declare module 'react' {
@@ -53,6 +53,6 @@ type StlSidebarProps = {
53
53
  declare function StlSidebar({
54
54
  entries,
55
55
  withStarlightRestoration
56
- }: StlSidebarProps): react_jsx_runtime43.JSX.Element;
56
+ }: StlSidebarProps): react_jsx_runtime78.JSX.Element;
57
57
  //#endregion
58
58
  export { StlSidebarProps as a, StlSidebarLink as i, StlSidebarEntry as n, StlSidebarTarget as o, StlSidebarGroup as r, StlSidebar as t };
@@ -1,5 +1,5 @@
1
1
  import { ReactNode } from "react";
2
- import * as react_jsx_runtime56 from "react/jsx-runtime";
2
+ import * as react_jsx_runtime67 from "react/jsx-runtime";
3
3
 
4
4
  //#region src/components/stl-sidebar.d.ts
5
5
  declare module 'react' {
@@ -53,6 +53,6 @@ type StlSidebarProps = {
53
53
  declare function StlSidebar({
54
54
  entries,
55
55
  withStarlightRestoration
56
- }: StlSidebarProps): react_jsx_runtime56.JSX.Element;
56
+ }: StlSidebarProps): react_jsx_runtime67.JSX.Element;
57
57
  //#endregion
58
58
  export { StlSidebarProps as a, StlSidebarLink as i, StlSidebarEntry as n, StlSidebarTarget as o, StlSidebarGroup as r, StlSidebar as t };
@@ -169,6 +169,12 @@
169
169
  padding: 0.5rem 0;
170
170
  font-size: var(--stl-typography-scale-sm);
171
171
 
172
+ &:has(.stldocs-expander-summary-content .stldocs-property-description)
173
+ .stldocs-expander-content
174
+ > .stldocs-property-description {
175
+ padding-top: 0.75rem;
176
+ }
177
+
172
178
  .stldocs-expander-summary-content {
173
179
  width: 100%;
174
180
  }
package/dist/styles.css CHANGED
@@ -1999,6 +1999,12 @@ a.stl-ui-button {
1999
1999
  padding: 0.5rem 0;
2000
2000
  font-size: var(--stl-typography-scale-sm);
2001
2001
 
2002
+ &:has(.stldocs-expander-summary-content .stldocs-property-description)
2003
+ .stldocs-expander-content
2004
+ > .stldocs-property-description {
2005
+ padding-top: 0.75rem;
2006
+ }
2007
+
2002
2008
  .stldocs-expander-summary-content {
2003
2009
  width: 100%;
2004
2010
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@stainless-api/docs-ui",
3
3
  "private": false,
4
- "version": "0.1.0-beta.70",
4
+ "version": "0.1.0-beta.71",
5
5
  "publishConfig": {
6
6
  "access": "public"
7
7
  },
@@ -1,61 +0,0 @@
1
- import { _ as Spec, d as Method, f as Model, m as Resource } from "./index-CwjGm9zX.js";
2
-
3
- //#region src/routing.d.ts
4
- declare namespace routing_d_exports {
5
- export { DocsLanguage, LanguageNames, Languages, ParsedStainlessPath, RouteEntry, SpecTreeEntry, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateMissingRouteList, 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", "cli"];
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" | "python.default" | "go.default" | "typescript.default" | "terraform.default" | "ruby.default" | "java.default" | "kotlin.default" | "csharp.default" | "php.default" | "cli.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: Method | Resource | Model;
29
- path: string[];
30
- };
31
- declare function walkTree(spec: 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: Spec;
45
- languages?: DocsLanguage[];
46
- excludeLanguages?: DocsLanguage[];
47
- }): RouteEntry[];
48
- declare function generateMissingRouteList({
49
- spec,
50
- basePath
51
- }: {
52
- spec: Spec;
53
- basePath: string;
54
- }): string[];
55
- type ResourceOrMethod = Resource | Method;
56
- declare function findNavigationPath(items: ResourceOrMethod[], target: string): string[] | undefined;
57
- declare function expandToElement(el: HTMLElement | null): void;
58
- declare function scrollToPath(stainlessPath: string): void;
59
- declare function updateHistory(basePath: string, language: DocsLanguage, stainlessPath: string): void;
60
- //#endregion
61
- export { walkTree as S, parseStainlessPath as _, RouteEntry as a, trimStainlessPath as b, expandToElement as c, generateRoute as d, generateRouteList as f, parseRoute as g, isSupportedLanguage as h, ParsedStainlessPath as i, findNavigationPath as l, getResource as m, LanguageNames as n, SpecTreeEntry as o, getLanguageSnippet as p, Languages as r, SupportedLanguageSyntaxes as s, DocsLanguage as t, generateMissingRouteList as u, routing_d_exports as v, updateHistory as x, scrollToPath as y };