@stainless-api/docs 0.1.0-beta.7 → 0.1.0-beta.70

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 (120) hide show
  1. package/CHANGELOG.md +554 -0
  2. package/README.md +1 -1
  3. package/eslint-suppressions.json +52 -0
  4. package/locals.d.ts +17 -0
  5. package/package.json +51 -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 +45 -28
  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 +243 -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/helpers/generateDocsRoutes.ts +27 -0
  24. package/plugin/index.ts +178 -35
  25. package/plugin/languages.ts +5 -2
  26. package/plugin/loadPluginConfig.ts +121 -32
  27. package/plugin/middlewareBuilder/stainlessMiddleware.d.ts +1 -1
  28. package/plugin/react/Routing.tsx +208 -129
  29. package/plugin/referencePlaceholderUtils.ts +1 -1
  30. package/plugin/replaceSidebarPlaceholderMiddleware.ts +5 -1
  31. package/plugin/routes/Docs.astro +62 -89
  32. package/plugin/routes/DocsStatic.astro +1 -1
  33. package/plugin/routes/Overview.astro +10 -16
  34. package/plugin/routes/markdown.ts +9 -8
  35. package/plugin/vendor/preview.worker.docs.js +19768 -17702
  36. package/plugin/vendor/templates/go.md +1 -1
  37. package/plugin/vendor/templates/python.md +1 -1
  38. package/resolveSrcFile.ts +10 -0
  39. package/scripts/vendor_deps.ts +5 -5
  40. package/shared/getProsePages.ts +42 -0
  41. package/shared/getSharedLogger.ts +15 -0
  42. package/shared/terminalUtils.ts +3 -0
  43. package/src/content.config.ts +9 -0
  44. package/stl-docs/components/AIDropdown.tsx +63 -0
  45. package/stl-docs/components/AiChatIsland.tsx +14 -0
  46. package/stl-docs/components/{content-panel/ContentBreadcrumbs.tsx → ContentBreadcrumbs.tsx} +10 -18
  47. package/stl-docs/components/Head.astro +16 -0
  48. package/stl-docs/components/Header.astro +6 -8
  49. package/stl-docs/components/PageFrame.astro +18 -0
  50. package/stl-docs/components/PageTitle.astro +82 -0
  51. package/stl-docs/components/TableOfContents.astro +34 -0
  52. package/stl-docs/components/ThemeProvider.astro +36 -0
  53. package/stl-docs/components/ThemeSelect.astro +84 -139
  54. package/stl-docs/components/content-panel/ContentPanel.astro +16 -25
  55. package/stl-docs/components/headers/SplashMobileMenuToggle.astro +17 -1
  56. package/stl-docs/components/headers/StackedHeader.astro +29 -24
  57. package/stl-docs/components/icons/chat-gpt.tsx +17 -0
  58. package/stl-docs/components/icons/claude.tsx +10 -0
  59. package/stl-docs/components/icons/cursor.tsx +10 -0
  60. package/stl-docs/components/icons/gemini.tsx +19 -0
  61. package/stl-docs/components/icons/markdown.tsx +10 -0
  62. package/stl-docs/components/index.ts +1 -0
  63. package/stl-docs/components/mintlify-compat/Accordion.astro +7 -5
  64. package/stl-docs/components/mintlify-compat/AccordionGroup.astro +7 -3
  65. package/stl-docs/components/mintlify-compat/Columns.astro +40 -42
  66. package/stl-docs/components/mintlify-compat/Frame.astro +16 -18
  67. package/stl-docs/components/mintlify-compat/callouts/Callout.astro +1 -1
  68. package/stl-docs/components/mintlify-compat/callouts/Check.astro +1 -1
  69. package/stl-docs/components/mintlify-compat/callouts/Danger.astro +1 -1
  70. package/stl-docs/components/mintlify-compat/callouts/Info.astro +1 -1
  71. package/stl-docs/components/mintlify-compat/callouts/Note.astro +1 -1
  72. package/stl-docs/components/mintlify-compat/callouts/Tip.astro +1 -1
  73. package/stl-docs/components/mintlify-compat/callouts/Warning.astro +1 -1
  74. package/stl-docs/components/mintlify-compat/card.css +33 -35
  75. package/stl-docs/components/mintlify-compat/index.ts +2 -4
  76. package/stl-docs/components/nav-tabs/NavDropdown.astro +31 -70
  77. package/stl-docs/components/nav-tabs/NavTabs.astro +78 -80
  78. package/stl-docs/components/nav-tabs/SecondaryNavTabs.astro +15 -8
  79. package/stl-docs/components/nav-tabs/buildNavLinks.ts +3 -2
  80. package/stl-docs/components/pagination/HomeLink.astro +10 -0
  81. package/stl-docs/components/pagination/Pagination.astro +175 -0
  82. package/stl-docs/components/pagination/PaginationLinkEmphasized.astro +22 -0
  83. package/stl-docs/components/pagination/PaginationLinkQuiet.astro +13 -0
  84. package/stl-docs/components/pagination/util.ts +71 -0
  85. package/stl-docs/components/scripts.ts +1 -0
  86. package/stl-docs/disableCalloutSyntax.ts +36 -0
  87. package/stl-docs/index.ts +141 -50
  88. package/stl-docs/loadStlDocsConfig.ts +45 -5
  89. package/stl-docs/proseMarkdown/proseMarkdownIntegration.ts +61 -0
  90. package/stl-docs/proseMarkdown/proseMarkdownMiddleware.ts +39 -0
  91. package/stl-docs/proseMarkdown/toMarkdown.ts +158 -0
  92. package/stl-docs/proseSearchIndexing.ts +450 -0
  93. package/stl-docs/tabsMiddleware.ts +11 -3
  94. package/styles/code.css +108 -140
  95. package/styles/fonts.css +32 -17
  96. package/styles/links.css +11 -48
  97. package/styles/method-descriptions.css +36 -0
  98. package/styles/overrides.css +48 -60
  99. package/styles/page.css +92 -52
  100. package/styles/sdk_select.css +9 -7
  101. package/styles/search.css +56 -69
  102. package/styles/sidebar.css +211 -131
  103. package/styles/{variables.css → sl-variables.css} +3 -2
  104. package/styles/stldocs-variables.css +6 -0
  105. package/styles/toc.css +41 -34
  106. package/theme.css +10 -10
  107. package/tsconfig.json +2 -5
  108. package/virtual-module.d.ts +26 -4
  109. package/components/variables.css +0 -135
  110. package/stl-docs/components/mintlify-compat/Step.astro +0 -58
  111. package/stl-docs/components/mintlify-compat/Steps.astro +0 -17
  112. /package/{plugin/assets → assets}/fonts/geist/OFL.txt +0 -0
  113. /package/{plugin/assets → assets}/fonts/geist/geist-italic-latin-ext.woff2 +0 -0
  114. /package/{plugin/assets → assets}/fonts/geist/geist-italic-latin.woff2 +0 -0
  115. /package/{plugin/assets → assets}/fonts/geist/geist-latin-ext.woff2 +0 -0
  116. /package/{plugin/assets → assets}/fonts/geist/geist-latin.woff2 +0 -0
  117. /package/{plugin/assets → assets}/fonts/geist/geist-mono-italic-latin-ext.woff2 +0 -0
  118. /package/{plugin/assets → assets}/fonts/geist/geist-mono-italic-latin.woff2 +0 -0
  119. /package/{plugin/assets → assets}/fonts/geist/geist-mono-latin-ext.woff2 +0 -0
  120. /package/{plugin/assets → assets}/fonts/geist/geist-mono-latin.woff2 +0 -0
package/components/variables.css DELETED
@@ -1,135 +0,0 @@
1
- :root {
2
- --stldocs-font: var(--sl-font, system-ui, sans-serif);
3
- --stldocs-font-mono: var(--sl-font-mono, ui-monospace, monospace);
4
-
5
- --stldocs-color-white: var(--sl-color-white);
6
- --stldocs-color-gray-1: var(--sl-color-gray-1);
7
- --stldocs-color-gray-2: var(--sl-color-gray-2);
8
- --stldocs-color-gray-3: var(--sl-color-gray-3);
9
- --stldocs-color-gray-4: var(--sl-color-gray-4);
10
- --stldocs-color-gray-5: var(--sl-color-gray-5);
11
- --stldocs-color-gray-6: var(--sl-color-gray-6);
12
- --stldocs-color-gray-7: var(--sl-color-gray-7);
13
- --stldocs-color-gray-8: var(--sl-color-gray-8);
14
-
15
- --stldocs-color-accent-low: var(--sl-color-accent-low);
16
- --stldocs-color-accent-high: var(--sl-color-accent-high);
17
- --stldocs-color-accent: var(--sl-color-accent);
18
- --stldocs-color-red: var(--sl-color-red);
19
-
20
- --stldocs-color-text: var(--sl-color-text);
21
- --stldocs-color-text-accent: var(--sl-color-text-accent);
22
- --stldocs-color-text-invert: var(--sl-color-text-invert);
23
- --stldocs-color-text-secondary: var(--sl-color-text-secondary);
24
- --stldocs-color-text-tertiary: var(--sl-color-text-tertiary);
25
-
26
- --stldocs-color-bg: var(--sl-color-bg);
27
- --stldocs-color-bg-nav: var(--sl-color-bg-nav);
28
- --stldocs-color-bg-ui: var(--sl-color-bg-ui);
29
-
30
- --stldocs-color-bg-inline-code: var(--sl-color-bg-inline-code);
31
- --stldocs-color-bg-accent: var(--sl-color-bg-accent);
32
- --stldocs-color-hairline: var(--sl-color-hairline);
33
- --stldocs-color-hairline-shade: var(--sl-color-hairline-shade);
34
- --stldocs-color-hairline-light: var(--sl-color-hairline-light);
35
-
36
- --stldocs-badge-default-text: var(--sl-badge-default-text);
37
- --stldocs-color-bg-inline-code-dark: var(--sl-color-bg-inline-code-dark);
38
-
39
- --stldocs-font-size-h1: var(--sl-text-h1);
40
- --stldocs-font-size-h2: var(--sl-text-h2);
41
- --stldocs-font-size-h3: var(--sl-text-h3);
42
- --stldocs-font-size-h4: var(--sl-text-h4);
43
- --stldocs-font-size-h5: var(--sl-text-h5);
44
-
45
- --stlodcs-font-size-body: var(--sl-text-body);
46
- --stldocs-font-size-small: var(--sl-text-body-sm);
47
- --stldocs-font-size-code: var(--sl-text-code);
48
-
49
- --stldocs-content-width: var(--sl-content-width);
50
- --stldocs-content-padding: var(--sl-content-pad-x);
51
-
52
- --stldocs-color-http-get-bg: var(--sl-color-green-low);
53
- --stldocs-color-http-get: var(--sl-color-green);
54
- --stldocs-color-http-put-bg: var(--sl-color-orange-low);
55
- --stldocs-color-http-put: var(--sl-color-orange);
56
- --stldocs-color-http-post-bg: var(--sl-color-blue-low);
57
- --stldocs-color-http-post: var(--sl-color-blue);
58
- --stldocs-color-http-delete-bg: var(--sl-color-red-low);
59
- --stldocs-color-http-delete: var(--sl-color-red);
60
-
61
- --stldocs-syntax-color-red: var(--sl-color-red);
62
- --stldocs-syntax-color-green: var(--sl-color-green);
63
- --stldocs-syntax-color-blue: var(--sl-color-blue);
64
- --stldocs-syntax-color-orange: var(--sl-color-orange);
65
- --stldocs-syntax-color-teal: var(--sl-color-teal);
66
- --stldocs-syntax-color-magenta: var(--sl-color-magenta);
67
- --stldocs-syntax-color-purple: var(--sl-color-purple);
68
-
69
- --stldocs-color-backdrop-overlay: var(--sl-color-backdrop-overlay);
70
- --stldocs-expander-margin-shift: 24px;
71
- --stldocs-expander-right-margin: 8px;
72
- --stldocs-font-size-body: 14px;
73
- --stldocs-font-size-body-xs: 12px;
74
-
75
- /* UI Overrides */
76
- --stl-ui-button-border-radius: var(--sl-button-border-radius);
77
- --stl-ui-text-body: var(--sl-text-sm);
78
- --stl-ui-button-size: var(--sl-button-size);
79
-
80
- --stl-ui-color-accent-low: var(--sl-color-accent-low);
81
- --stl-ui-color-accent: var(--sl-color-accent);
82
- --stl-ui-color-accent-high: var(--sl-color-accent-high);
83
-
84
- --stl-ui-color-text: var(--sl-color-text);
85
- --stl-ui-color-text-secondary: var(--sl-color-text-secondary);
86
- --stl-ui-color-text-tertiary: var(--sl-color-text-tertiary);
87
- --stl-ui-color-text-invert: var(--sl-color-text-invert);
88
- --stl-ui-color-text-accent: var(--sl-color-text-accent);
89
-
90
- --stl-ui-color-bg: var(--sl-color-bg);
91
- --stl-ui-color-bg-ui: var(--sl-color-bg-ui);
92
- --stl-ui-color-bg-inline-code: var(--sl-color-bg-inline-code);
93
-
94
- --stl-ui-color-hairline-light: var(--sl-color-hairline-light);
95
- --stl-ui-color-hairline: var(--sl-color-hairline);
96
- --stl-ui-color-hairline-shade: var(--sl-color-hairline-shade);
97
- }
98
-
99
- /* These are the theme overrides - we need to come up with a good way to do this in starlight */
100
- :root {
101
- /*
102
- tmp remove the theme color in favor of the Shiki default theme background
103
- commented out values are the original values in case we want them again
104
- */
105
- /* --stldocs-color-snippet-box-bg: #272727; */
106
- --stldocs-color-snippet-box-bg: #1f1f1f;
107
- /* --stldocs-color-snippet-title-bg: #161616; */
108
- --stldocs-color-snippet-title-bg: #24292f;
109
- --stldocs-color-snippet-title-muted: #8b8b8b;
110
- --stldocs-color-snippet-title-bright: #ffffff;
111
- --stldocs-color-snippet-code-bg: #1d1d1d;
112
-
113
- --stldocs-title-padding-y: 2.5rem;
114
-
115
- --stldocs-z-index-theme-select: 1000;
116
- --stldocs-button-border-radius: var(--sl-button-border-radius);
117
- --stldocs-button-size: var(--sl-button-size);
118
- --stldocs-button-padding-x: var(--sl-button-padding-x);
119
- --stldocs-button-padding-y: var(--sl-button-padding-y);
120
-
121
- --sl-content-pad-x: 1rem;
122
- }
123
-
124
- :root[data-theme='light'] {
125
- --stldocs-color-snippet-box-bg: #eeeeee;
126
- /*
127
- tmp remove the theme color in favor of the Shiki default theme background
128
- commented out value is the original value in case we want it again
129
- */
130
- /* --stldocs-color-snippet-title-bg: #2a2a2a; */
131
- --stldocs-color-snippet-title-bg: #24292f;
132
- --stldocs-color-snippet-title-muted: #959595;
133
- --stldocs-color-snippet-title-bright: #000;
134
- --stldocs-color-snippet-code-bg: #383838;
135
- }
package/stl-docs/components/mintlify-compat/Step.astro DELETED
@@ -1,58 +0,0 @@
1
- ---
2
- export interface Props {
3
- title?: string;
4
- }
5
-
6
- const { title } = Astro.props;
7
- ---
8
-
9
- <li class="stl-ui-mintlify-compat-step" data-stl-ui-element>
10
- <div class="stl-ui-mintlify-compat-step-step-number"></div>
11
- <div>
12
- <p class="stl-ui-mintlify-compat-step-title">{title}</p>
13
- <div class="stl-ui-mintlify-compat-step-content"><slot /></div>
14
- </div>
15
- </li>
16
-
17
- <style>
18
- @layer stl-ui-mintlify-compat {
19
- .stl-ui-mintlify-compat-step {
20
- display: flex;
21
-
22
- &:not(:first-child) {
23
- margin-top: 1rem;
24
- }
25
- }
26
-
27
- .stl-ui-mintlify-compat-step-step-number {
28
- margin-right: 1rem;
29
- display: flex;
30
- align-items: top;
31
- justify-content: center;
32
- margin-top: 4px;
33
-
34
- &::before {
35
- counter-increment: ui-steps;
36
- content: counter(ui-steps);
37
- border-radius: 50%;
38
- height: 1.5rem;
39
- width: 1.5rem;
40
- font-size: 0.8rem;
41
- color: var(--sl-color-text);
42
- font-weight: 600;
43
- background-color: var(--sl-color-gray-5);
44
- display: flex;
45
- align-items: center;
46
- justify-content: center;
47
- }
48
- }
49
-
50
- .stl-ui-mintlify-compat-step-title {
51
- font-weight: 600;
52
- color: var(--sl-color-text);
53
- }
54
- .stl-ui-mintlify-compat-step-content {
55
- margin-top: 0.5rem;
56
- }
57
- }
58
- </style>
package/stl-docs/components/mintlify-compat/Steps.astro DELETED
@@ -1,17 +0,0 @@
1
- <ol class="stl-ui-mintlify-compat-steps"><slot /></ol>
2
-
3
- <style>
4
- @layer stl-ui-mintlify-compat {
5
- .stl-ui-mintlify-compat-steps {
6
- counter-reset: ui-steps;
7
- list-style: none;
8
- margin: 0;
9
- padding: 0;
10
- margin-top: 1rem;
11
-
12
- * {
13
- margin: 0;
14
- }
15
- }
16
- }
17
- </style>
/package/{plugin/assets → assets}/fonts/geist/OFL.txt RENAMED
File without changes