@stainless-api/docs 0.1.0-beta.6 → 0.1.0-beta.60

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/CHANGELOG.md +476 -0
  2. package/README.md +1 -1
  3. package/eslint-suppressions.json +52 -0
  4. package/locals.d.ts +16 -0
  5. package/package.json +45 -40
  6. package/plugin/assets/languages/csharp.svg +1 -0
  7. package/plugin/buildAlgoliaIndex.ts +32 -7
  8. package/plugin/cms/server.ts +130 -58
  9. package/plugin/cms/sidebar-builder.ts +7 -26
  10. package/plugin/cms/worker.ts +83 -5
  11. package/plugin/components/MethodDescription.tsx +54 -0
  12. package/plugin/components/SDKSelect.astro +7 -87
  13. package/plugin/components/SnippetCode.tsx +53 -8
  14. package/plugin/components/search/SearchAlgolia.astro +14 -26
  15. package/plugin/components/search/SearchIsland.tsx +38 -24
  16. package/plugin/create-playground.shim.tsx +3 -0
  17. package/plugin/generateAPIReferenceLink.ts +2 -2
  18. package/plugin/globalJs/ai-dropdown-options.ts +235 -0
  19. package/plugin/globalJs/code-snippets.ts +15 -8
  20. package/plugin/globalJs/copy.ts +81 -16
  21. package/plugin/globalJs/method-descriptions.ts +33 -0
  22. package/plugin/globalJs/navigation.ts +7 -4
  23. package/plugin/index.ts +179 -35
  24. package/plugin/languages.ts +5 -2
  25. package/plugin/loadPluginConfig.ts +121 -32
  26. package/plugin/middlewareBuilder/stainlessMiddleware.d.ts +1 -1
  27. package/plugin/react/Routing.tsx +208 -104
  28. package/plugin/referencePlaceholderUtils.ts +1 -1
  29. package/plugin/replaceSidebarPlaceholderMiddleware.ts +5 -1
  30. package/plugin/routes/Docs.astro +61 -83
  31. package/plugin/routes/Overview.astro +10 -16
  32. package/plugin/routes/markdown.ts +7 -7
  33. package/plugin/vendor/preview.worker.docs.js +19768 -17702
  34. package/plugin/vendor/templates/go.md +1 -1
  35. package/plugin/vendor/templates/python.md +1 -1
  36. package/resolveSrcFile.ts +10 -0
  37. package/scripts/vendor_deps.ts +5 -5
  38. package/shared/getSharedLogger.ts +15 -0
  39. package/shared/terminalUtils.ts +3 -0
  40. package/src/content.config.ts +9 -0
  41. package/stl-docs/components/AIDropdown.tsx +63 -0
  42. package/stl-docs/components/AiChatIsland.tsx +10 -0
  43. package/stl-docs/components/{content-panel/ContentBreadcrumbs.tsx → ContentBreadcrumbs.tsx} +10 -18
  44. package/stl-docs/components/Head.astro +16 -0
  45. package/stl-docs/components/Header.astro +6 -8
  46. package/stl-docs/components/PageFrame.astro +14 -0
  47. package/stl-docs/components/PageTitle.astro +82 -0
  48. package/stl-docs/components/TableOfContents.astro +34 -0
  49. package/stl-docs/components/ThemeSelect.astro +118 -136
  50. package/stl-docs/components/content-panel/ContentPanel.astro +16 -25
  51. package/stl-docs/components/headers/SplashMobileMenuToggle.astro +17 -1
  52. package/stl-docs/components/headers/StackedHeader.astro +29 -24
  53. package/stl-docs/components/icons/chat-gpt.tsx +17 -0
  54. package/stl-docs/components/icons/claude.tsx +10 -0
  55. package/stl-docs/components/icons/cursor.tsx +10 -0
  56. package/stl-docs/components/icons/gemini.tsx +19 -0
  57. package/stl-docs/components/icons/markdown.tsx +10 -0
  58. package/stl-docs/components/index.ts +1 -0
  59. package/stl-docs/components/mintlify-compat/Accordion.astro +7 -5
  60. package/stl-docs/components/mintlify-compat/AccordionGroup.astro +7 -3
  61. package/stl-docs/components/mintlify-compat/Columns.astro +40 -42
  62. package/stl-docs/components/mintlify-compat/Frame.astro +16 -18
  63. package/stl-docs/components/mintlify-compat/Step.astro +30 -32
  64. package/stl-docs/components/mintlify-compat/Steps.astro +8 -10
  65. package/stl-docs/components/mintlify-compat/callouts/Callout.astro +1 -1
  66. package/stl-docs/components/mintlify-compat/callouts/Check.astro +1 -1
  67. package/stl-docs/components/mintlify-compat/callouts/Danger.astro +1 -1
  68. package/stl-docs/components/mintlify-compat/callouts/Info.astro +1 -1
  69. package/stl-docs/components/mintlify-compat/callouts/Note.astro +1 -1
  70. package/stl-docs/components/mintlify-compat/callouts/Tip.astro +1 -1
  71. package/stl-docs/components/mintlify-compat/callouts/Warning.astro +1 -1
  72. package/stl-docs/components/mintlify-compat/card.css +33 -35
  73. package/stl-docs/components/nav-tabs/NavDropdown.astro +31 -70
  74. package/stl-docs/components/nav-tabs/NavTabs.astro +78 -80
  75. package/stl-docs/components/nav-tabs/SecondaryNavTabs.astro +15 -8
  76. package/stl-docs/components/nav-tabs/buildNavLinks.ts +3 -2
  77. package/stl-docs/components/pagination/HomeLink.astro +10 -0
  78. package/stl-docs/components/pagination/Pagination.astro +175 -0
  79. package/stl-docs/components/pagination/PaginationLinkEmphasized.astro +22 -0
  80. package/stl-docs/components/pagination/PaginationLinkQuiet.astro +13 -0
  81. package/stl-docs/components/pagination/util.ts +71 -0
  82. package/stl-docs/components/scripts.ts +1 -0
  83. package/stl-docs/disableCalloutSyntax.ts +36 -0
  84. package/stl-docs/index.ts +121 -48
  85. package/stl-docs/loadStlDocsConfig.ts +44 -4
  86. package/stl-docs/proseMarkdown/proseMarkdownIntegration.ts +64 -0
  87. package/stl-docs/proseMarkdown/proseMarkdownMiddleware.ts +34 -0
  88. package/stl-docs/proseMarkdown/toMarkdown.ts +158 -0
  89. package/stl-docs/proseSearchIndexing.ts +113 -0
  90. package/stl-docs/tabsMiddleware.ts +11 -3
  91. package/styles/code.css +108 -140
  92. package/styles/fonts.css +32 -17
  93. package/styles/links.css +11 -48
  94. package/styles/method-descriptions.css +36 -0
  95. package/styles/overrides.css +48 -60
  96. package/styles/page.css +92 -52
  97. package/styles/sdk_select.css +9 -7
  98. package/styles/search.css +58 -69
  99. package/styles/sidebar.css +211 -131
  100. package/styles/{variables.css → sl-variables.css} +3 -2
  101. package/styles/stldocs-variables.css +6 -0
  102. package/styles/toc.css +41 -34
  103. package/theme.css +10 -10
  104. package/tsconfig.json +2 -5
  105. package/virtual-module.d.ts +23 -3
  106. package/components/variables.css +0 -135
  107. /package/{plugin/assets → assets}/fonts/geist/OFL.txt +0 -0
  108. /package/{plugin/assets → assets}/fonts/geist/geist-italic-latin-ext.woff2 +0 -0
  109. /package/{plugin/assets → assets}/fonts/geist/geist-italic-latin.woff2 +0 -0
  110. /package/{plugin/assets → assets}/fonts/geist/geist-latin-ext.woff2 +0 -0
  111. /package/{plugin/assets → assets}/fonts/geist/geist-latin.woff2 +0 -0
  112. /package/{plugin/assets → assets}/fonts/geist/geist-mono-italic-latin-ext.woff2 +0 -0
  113. /package/{plugin/assets → assets}/fonts/geist/geist-mono-italic-latin.woff2 +0 -0
  114. /package/{plugin/assets → assets}/fonts/geist/geist-mono-latin-ext.woff2 +0 -0
  115. /package/{plugin/assets → assets}/fonts/geist/geist-mono-latin.woff2 +0 -0
@@ -1,83 +1,71 @@
1
- @layer stainless {
2
- html {
3
- font-size: 16px;
4
- }
1
+ html {
2
+ font-size: 16px;
3
+ }
5
4
 
6
- .site-title {
7
- color: var(--sl-color-white);
8
- max-width: 144px;
5
+ .site-title {
6
+ color: var(--stl-color-foreground);
9
7
 
10
- img {
11
- height: 32px;
12
- width: auto;
13
- }
8
+ img {
9
+ height: 32px;
10
+ width: auto;
14
11
  }
12
+ }
15
13
 
16
- /* Hide the text in the theme select dropdown */
17
- starlight-theme-select select {
18
- width: 0;
19
- overflow: hidden;
20
- }
14
+ /* TODO: apply real button classes here */
15
+ starlight-menu-button button {
16
+ box-shadow: none;
17
+ background-color: var(--stl-color-ui-background);
18
+ border: 1px solid var(--stl-color-border);
19
+ border-radius: var(--stl-ui-layout-border-radius-sml);
20
+ height: 32px;
21
+ width: 32px;
22
+ display: flex;
23
+ align-items: center;
24
+ justify-content: center;
21
25
 
22
- button {
23
- border-radius: var(--sl-button-border-radius);
26
+ &:hover {
27
+ background-color: var(--stl-color-ui-background-hover);
24
28
  }
29
+ }
25
30
 
26
- .custom-select-wrapper select,
27
- .stldocs-button-secondary {
28
- background-color: var(--sl-color-bg-ui);
29
- border: 1px solid var(--sl-color-hairline);
30
- border-radius: var(--sl-button-border-radius);
31
-
31
+ mobile-starlight-toc {
32
+ nav {
33
+ background-color: var(--stl-color-background);
34
+ }
35
+ .toggle {
36
+ background-color: var(--stl-color-ui-background);
37
+ border: 1px solid var(--stl-color-border);
38
+ border-radius: var(--stl-ui-layout-border-radius-sml);
32
39
  &:hover {
33
- border-color: var(--sl-color-hairline-shade);
40
+ background-color: var(--stl-color-ui-background-hover);
41
+ border-color: var(--stl-color-border); /* unchanged */
34
42
  }
35
43
  }
36
-
37
- .content-panel {
38
- border-top: 0;
44
+ .dropdown {
45
+ background-color: var(--stl-color-background);
46
+ border-color: var(--stl-color-border-faint);
47
+ }
48
+ summary {
49
+ padding: 2rem 1rem;
50
+ border-color: var(--stl-color-border-faint);
51
+ }
52
+ a {
53
+ border-color: var(--stl-color-border-faint);
39
54
  }
55
+ }
40
56
 
57
+ @media (min-width: 50rem) {
41
58
  starlight-menu-button button {
42
- box-shadow: none;
43
- background-color: var(--sl-color-bg-ui);
44
- border: 1px solid var(--sl-color-hairline);
45
- border-radius: var(--sl-button-border-radius);
46
- height: var(--sl-button-size);
47
- width: var(--sl-button-size);
48
- display: flex;
49
- align-items: center;
50
- justify-content: center;
51
-
52
- &:hover {
53
- border-color: var(--sl-color-hairline-shade);
54
- }
59
+ display: none;
55
60
  }
56
61
 
57
62
  mobile-starlight-toc {
58
63
  nav {
59
- background-color: var(--sl-color-bg);
64
+ inset-inline-start: calc(var(--sl-content-inline-start, 0));
60
65
  }
61
66
 
62
67
  summary {
63
- padding: 2rem 1rem;
64
- border-bottom-color: var(--sl-color-hairline-light);
65
- }
66
- }
67
-
68
- @media (min-width: 50rem) {
69
- starlight-menu-button button {
70
- display: none;
71
- }
72
-
73
- mobile-starlight-toc {
74
- nav {
75
- inset-inline-start: calc(var(--sl-content-inline-start, 0));
76
- }
77
-
78
- summary {
79
- padding: 2rem 2rem;
80
- }
68
+ padding: 2rem 2rem;
81
69
  }
82
70
  }
83
71
  }
package/styles/page.css CHANGED
@@ -1,67 +1,107 @@
1
- /* Styles for supporting a max-width layout */
2
- @layer stainless {
3
- .page {
4
- position: relative;
5
- max-width: var(--sl-page-max-width);
6
- margin: 0 auto;
7
-
8
- .sidebar-pane {
9
- left: auto;
10
- }
1
+ .page,
2
+ .page > header .header,
3
+ .page > header .stl-secondary-nav-tabs {
4
+ max-width: var(--sl-page-max-width);
5
+ margin: 0 auto;
11
6
 
12
- > header {
13
- .stl-secondary-nav-tabs,
14
- .header {
15
- max-width: var(--sl-page-max-width);
16
- margin: 0 auto;
17
- }
18
- }
7
+ @media (min-width: 50rem) {
8
+ padding-inline: var(--stl-ui-page-padding-inline);
9
+ }
10
+ }
19
11
 
20
- .right-sidebar {
21
- border-inline-start: unset;
22
- }
12
+ .page {
13
+ position: relative;
14
+ max-width: var(--sl-page-max-width);
23
15
 
24
- .mobile-preferences {
25
- margin-top: 1rem;
26
- }
16
+ .right-sidebar {
17
+ border-inline-start: unset;
27
18
  }
28
19
 
29
- @media (min-width: 50rem) {
30
- .page {
31
- padding-left: var(--sl-sidebar-pad-x);
32
- padding-right: var(--sl-sidebar-pad-x);
33
-
34
- > header {
35
- .header,
36
- .stl-secondary-nav-tabs {
37
- padding: 0 1.5rem;
38
- }
39
- }
40
- }
20
+ .mobile-preferences {
21
+ margin-top: 1rem;
22
+ display: flex;
23
+ justify-content: flex-end;
24
+ }
25
+ }
41
26
 
42
- .header,
43
- .header {
44
- padding-inline-start: 0;
45
- padding-inline-end: 0;
46
- }
27
+ :root {
28
+ --sl-mobile-toc-height: 4rem;
29
+ }
47
30
 
48
- mobile-starlight-toc nav {
49
- inset-inline-start: calc(var(--sl-content-inline-start, 0) + var(--sl-sidebar-pad-x));
50
- }
51
- .sidebar-content {
52
- padding-left: 0;
53
- }
31
+ @media (min-width: 50rem) {
32
+ .page .sidebar-pane {
33
+ left: unset;
34
+ }
35
+ /* on desktop, adjust sidebar so that its _text content_ aligns with the page left edge.
36
+ * padding (visible on hover) bleeds out beyond the page left edge, covered by --stl-ui-page-padding-inline */
37
+ .sidebar-pane {
38
+ margin-inline-start: calc(-1 * (var(--sl-sidebar-pad-x) + var(--stl-sidebar-item-padding-inline)));
54
39
  }
55
40
 
56
- .stl-content-breadcrumbs {
57
- .stldocs-breadcrumbs {
58
- padding-left: 0;
59
- }
41
+ .header,
42
+ .header {
43
+ padding-inline-start: 0;
44
+ padding-inline-end: 0;
45
+ }
46
+
47
+ mobile-starlight-toc nav {
48
+ inset-inline-start: calc(var(--sl-content-inline-start, 0) + var(--sl-sidebar-pad-x));
60
49
  }
61
50
  }
62
51
 
63
- @media (min-width: 50em) {
52
+ .stl-content-breadcrumbs {
53
+ .stldocs-breadcrumbs {
54
+ padding-left: 0;
55
+ }
56
+ }
57
+
58
+ .stl-page-nav-container {
59
+ display: flex;
60
+ align-items: center;
61
+ justify-content: space-between;
62
+ gap: 1rem;
63
+ padding: 1rem 0 0 0;
64
+ flex-wrap: wrap;
65
+ }
66
+
67
+ .stl-page-nav-container {
68
+ display: flex;
69
+ align-items: center;
70
+ justify-content: space-between;
71
+ gap: 1rem;
72
+ padding: 1rem 0 0 0;
73
+ flex-wrap: wrap;
74
+ }
75
+
76
+ .stldocs-root .stl-page-nav-container {
77
+ padding: 1rem 0 0 var(--stldocs-content-padding);
78
+ }
79
+
80
+ @media (min-width: 50rem) {
64
81
  :root[data-has-sidebar] {
65
- --sl-content-inline-start: calc(var(--sl-sidebar-width) + 1rem);
82
+ --sl-content-inline-start: calc(var(--sl-sidebar-width) + 2rem);
83
+ }
84
+
85
+ .stldocs-root .stl-page-nav-container {
86
+ padding: 1rem 0 0 0;
87
+ }
88
+ }
89
+
90
+ @media (min-width: 72rem) {
91
+ :root {
92
+ --sl-mobile-toc-height: 0rem;
93
+ }
94
+ }
95
+
96
+ .content-panel footer {
97
+ /* Don’t render empty footer meta, which results in extra margin getting applied on behalf of the flex gap.
98
+ * Instead, move its margin to its parent. */
99
+ margin-top: 3rem;
100
+ .meta {
101
+ margin-top: 0;
102
+ &:empty,
103
+ &:not(:has(> *)) {
104
+ display: none;
105
+ }
66
106
  }
67
107
  }
@@ -1,11 +1,13 @@
1
- @layer stainless {
2
- .stl-sdk-select-dropdown-menu {
3
- min-width: 200px;
4
- }
1
+ .stl-sdk-select {
2
+ .stl-ui-dropdown {
3
+ width: 100%;
5
4
 
6
- .stl-sdk-select {
7
- .stldocs-icon.http path {
8
- fill: var(--stldocs-color-text);
5
+ .stl-ui-dropdown__button {
6
+ width: 100%;
7
+ justify-content: space-between;
9
8
  }
10
9
  }
10
+ .stldocs-icon.http path {
11
+ fill: var(--stl-color-foreground);
12
+ }
11
13
  }
package/styles/search.css CHANGED
@@ -1,84 +1,73 @@
1
- @layer stainless {
2
- /* Search input styles for Astro and Algolia */
3
- site-search {
4
- display: contents;
5
-
6
- > astro-island > div {
7
- position: absolute;
8
- }
9
-
10
- > button {
11
- padding: var(--sl-button-padding-y) var(--sl-button-padding-x);
12
- min-width: unset;
13
- display: flex;
14
- align-items: center;
15
- gap: 0.5rem;
16
- padding: 0;
17
- width: var(--sl-button-size);
18
- justify-content: center;
19
- background-color: var(--sl-color-bg-ui);
20
- border: 1px solid var(--sl-color-hairline);
21
- border-radius: var(--sl-button-border-radius);
22
- height: var(--sl-button-size);
1
+ /* Search input styles for Astro and Algolia */
2
+ site-search {
3
+ display: contents;
23
4
 
24
- &:hover {
25
- border-color: var(--sl-color-hairline-shade);
26
- }
27
-
28
- span {
29
- font-size: var(--sl-text-sm);
30
- color: var(--sl-color-text-secondary);
31
- line-height: 150%;
32
- padding-left: var(--sl-button-icon-offset);
33
- padding-right: var(--sl-button-icon-offset);
34
- }
5
+ > astro-island > div {
6
+ position: absolute;
7
+ }
35
8
 
36
- > svg {
37
- width: var(--sl-text-sm);
38
- height: var(--sl-text-sm);
39
- }
9
+ > button {
10
+ padding: var(--sl-button-padding-y) var(--sl-button-padding-x);
11
+ min-width: unset;
12
+ display: flex;
13
+ align-items: center;
14
+ gap: 0.5rem;
15
+ padding: 0;
16
+ width: var(--sl-button-size);
17
+ justify-content: center;
18
+ background-color: var(--stl-color-ui-background);
19
+ border: 1px solid var(--stl-color-border);
20
+ border-radius: var(--sl-button-border-radius);
21
+ height: var(--sl-button-size);
40
22
 
41
- &.stldocs-button {
42
- padding: 0;
43
- }
23
+ &:hover {
24
+ background: var(--stl-color-ui-background-hover);
44
25
  }
45
26
 
46
- button > kbd {
47
- border-radius: 0.25rem;
48
- font-size: var(--sl-text-2xs);
49
- gap: 0.25em;
50
- padding-inline: 0.375rem;
51
- background-color: var(--sl-color-gray-6);
52
- margin-right: -0.3rem;
27
+ span {
28
+ font-size: var(--stl-typography-scale-sm);
29
+ color: var(--stl-color-foreground-reduced);
30
+ line-height: 150%;
31
+ padding-left: var(--sl-button-icon-offset);
32
+ padding-right: var(--sl-button-icon-offset);
53
33
  }
54
34
 
55
- kbd {
56
- font-family: var(--__sl-font);
57
- color: var(--sl-color-text);
35
+ > svg {
36
+ width: var(--stl-typography-scale-sm);
37
+ height: var(--stl-typography-scale-sm);
58
38
  }
59
39
  }
60
40
 
61
- @media (min-width: 50rem) {
62
- site-search {
63
- > button {
64
- border-radius: var(--sl-button-border-radius);
65
- padding-inline-start: var(--sl-button-padding-x);
66
- padding-inline-end: var(--sl-button-padding-x);
67
- width: 100%;
68
- max-width: 30rem;
69
- justify-content: start;
41
+ button > kbd {
42
+ border-radius: 0.25rem;
43
+ font-size: var(--stl-typography-scale-xs);
44
+ gap: 0.25em;
45
+ padding-inline: 0.375rem;
46
+ background-color: var(--stl-color-muted-background);
47
+ margin-right: -0.3rem;
48
+ }
70
49
 
71
- &.stldocs-button {
72
- padding-inline-start: var(--sl-button-padding-x);
73
- padding-inline-end: var(--sl-button-padding-x);
74
- }
50
+ kbd {
51
+ font-family: var(--__sl-font);
52
+ color: var(--stl-color-foreground-reduced);
53
+ }
54
+ }
75
55
 
76
- > :last-child {
77
- margin-inline-start: auto;
78
- }
79
- > svg {
80
- margin-left: calc(-1 * var(--sl-button-icon-offset));
81
- }
56
+ @media (min-width: 50rem) {
57
+ site-search {
58
+ > button {
59
+ border-radius: var(--sl-button-border-radius);
60
+ padding-inline-start: var(--sl-button-padding-x);
61
+ padding-inline-end: var(--sl-button-padding-x);
62
+ width: 100%;
63
+ max-width: 30rem;
64
+ justify-content: start;
65
+
66
+ > :last-child {
67
+ margin-inline-start: auto;
68
+ }
69
+ > svg {
70
+ margin-left: calc(-1 * var(--sl-button-icon-offset));
82
71
  }
83
72
  }
84
73
  }