@stainless-api/docs-ui 0.1.0-beta.24 → 0.1.0-beta.26

package/dist/styles/sidebar.css

@@ -1,86 +1,84 @@
-@layer docs-ui {
-  .stldocs-sidebar {
-    font-family: var(--stldocs-font);
-    font-size: var(--stldocs-font-size-body);
+.stldocs-sidebar {
+  font-family: var(--stldocs-font);
+  font-size: var(--stldocs-font-size-body);
 
-    a {
-      text-decoration: none;
-      color: var(--stldocs-color-text-secondary);
-    }
+  a {
+    text-decoration: none;
+    color: var(--stldocs-color-text-secondary);
+  }
 
-    .stldocs-sidebar-resource-title {
-      padding-bottom: 6px;
-    }
+  .stldocs-sidebar-resource-title {
+    padding-bottom: 6px;
+  }
 
-    .stldocs-sidebar-resource,
-    .stldocs-sidebar-method {
-      padding: 6px;
-      display: flex;
-      gap: 0.5rem;
+  .stldocs-sidebar-resource,
+  .stldocs-sidebar-method {
+    padding: 6px;
+    display: flex;
+    gap: 0.5rem;
 
-      .stldocs-method-route-httpmethod {
-        margin-bottom: auto;
-      }
+    .stldocs-method-route-httpmethod {
+      margin-bottom: auto;
+    }
 
-      &[data-selected='true'] {
-        & > a,
-        & > details > summary > a {
-          color: var(--stldocs-color-text);
-        }
+    &[data-selected='true'] {
+      & > a,
+      & > details > summary > a {
+        color: var(--stldocs-color-text);
       }
     }
+  }
 
-    .stldocs-sidebar-resource-title {
-      display: block;
+  .stldocs-sidebar-resource-title {
+    display: block;
 
-      a {
-        color: var(--stldocs-color-text);
-        font-weight: 500;
-      }
+    a {
+      color: var(--stldocs-color-text);
+      font-weight: 500;
     }
+  }
 
-    .stldocs-sidebar-expander {
-      .stldocs-expander-summary {
-        cursor: pointer;
-        display: flex;
+  .stldocs-sidebar-expander {
+    .stldocs-expander-summary {
+      cursor: pointer;
+      display: flex;
 
-        & > .stldocs-expander-summary-icon {
-          transform: translateX(-0.5px) translateY(-0.5px);
-          margin-left: 8px;
+      & > .stldocs-expander-summary-icon {
+        transform: translateX(-0.5px) translateY(-0.5px);
+        margin-left: 8px;
 
-          & > .stldocs-icon {
-            vertical-align: middle;
-            color: var(--stldocs-color-text-tertiary);
-          }
+        & > .stldocs-icon {
+          vertical-align: middle;
+          color: var(--stldocs-color-text-tertiary);
+        }
 
-          & > :last-child {
-            display: none;
-          }
+        & > :last-child {
+          display: none;
         }
       }
+    }
 
-      &[open],
-      &[data-open='true'] {
-        & > .stldocs-expander-summary {
-          .stldocs-type-preview-content {
+    &[open],
+    &[data-open='true'] {
+      & > .stldocs-expander-summary {
+        .stldocs-type-preview-content {
+          display: none;
+        }
+
+        & > .stldocs-expander-summary-icon {
+          & > :first-child {
             display: none;
           }
 
-          & > .stldocs-expander-summary-icon {
-            & > :first-child {
-              display: none;
-            }
-
-            & > :last-child {
-              display: inline;
-            }
+          & > :last-child {
+            display: inline;
           }
         }
+      }
 
-        & > .stldocs-expander-content {
-          margin-left: 10px;
-          line-height: 150%;
-        }
+      & > .stldocs-expander-content {
+        margin-left: 10px;
+        line-height: 150%;
       }
     }
   }

package/dist/styles/snippets.css

@@ -1,12 +1,77 @@
-@layer docs-ui {
-  .stldocs-root {
-    .snippet {
-      color: #d8d8d8;
-      --orange: 24 76% 51%;
-      --teal: 208 100% 66%;
-      --magenta: 324 54% 48.6%;
-      --purple: 274 41% 47%;
-    }
+.stldocs-root {
+  .snippet {
+    color: #d8d8d8;
+    --orange: 24 76% 51%;
+    --teal: 208 100% 66%;
+    --magenta: 324 54% 48.6%;
+    --purple: 274 41% 47%;
+  }
+
+  .hljs-comment,
+  .hljs-quote {
+    color: #adadad;
+  }
+
+  .hljs-doctag,
+  .hljs-keyword,
+  .hljs-formula {
+    color: #fb8f44;
+  }
+
+  .hljs-section,
+  .hljs-name,
+  .hljs-selector-tag,
+  .hljs-deletion,
+  .hljs-subst {
+    color: #f7585c;
+  }
+
+  .hjs-literal,
+  .hljs-string,
+  .hljs-regexp,
+  .hljs-addition,
+  .hljs-attribute,
+  .hljs-meta .hljs-string {
+    color: #54aeff;
+  }
+
+  .hljs-attr,
+  .hljs-variable,
+  .hljs-template-variable,
+  .hljs-type,
+  .hljs-selector-class,
+  .hljs-selector-attr,
+  .hljs-selector-pseudo,
+  .hljs-number {
+    color: #4ac26b;
+  }
+
+  .hljs-symbol,
+  .hljs-bullet,
+  .hljs-link,
+  .hljs-meta,
+  .hljs-selector-id,
+  .hljs-title,
+  .hljs-built_in,
+  .hljs-title.class_,
+  .hljs-class .hljs-title {
+    color: #b68eff;
+  }
+
+  .hljs-emphasis {
+    font-style: italic;
+  }
+
+  .hljs-strong {
+    font-weight: bold;
+  }
+
+  .hljs-link {
+    text-decoration: underline;
+  }
+
+  .snippet-json {
+    color: #a5a5ac;
 
     .hljs-comment,
     .hljs-quote {
@@ -15,8 +80,9 @@
 
     .hljs-doctag,
     .hljs-keyword,
-    .hljs-formula {
-      color: #fb8f44;
+    .hljs-formula,
+    .hljs-number {
+      color: var(--stldocs-syntax-color-orange);
     }
 
     .hljs-section,
@@ -24,7 +90,7 @@
     .hljs-selector-tag,
     .hljs-deletion,
     .hljs-subst {
-      color: #f7585c;
+      color: var(--stldocs-syntax-color-red);
     }
 
     .hjs-literal,
@@ -33,7 +99,7 @@
     .hljs-addition,
     .hljs-attribute,
     .hljs-meta .hljs-string {
-      color: #54aeff;
+      color: var(--stldocs-syntax-color-green);
     }
 
     .hljs-attr,
@@ -42,9 +108,8 @@
     .hljs-type,
     .hljs-selector-class,
     .hljs-selector-attr,
-    .hljs-selector-pseudo,
-    .hljs-number {
-      color: #4ac26b;
+    .hljs-selector-pseudo {
+      color: var(--stldocs-color-text);
     }
 
     .hljs-symbol,
@@ -52,81 +117,14 @@
     .hljs-link,
     .hljs-meta,
     .hljs-selector-id,
-    .hljs-title,
+    .hljs-title {
+      color: var(--stldocs-syntax-color-purple);
+    }
+
     .hljs-built_in,
     .hljs-title.class_,
     .hljs-class .hljs-title {
-      color: #b68eff;
-    }
-
-    .hljs-emphasis {
-      font-style: italic;
-    }
-
-    .hljs-strong {
-      font-weight: bold;
-    }
-
-    .hljs-link {
-      text-decoration: underline;
-    }
-
-    .snippet-json {
-      color: #a5a5ac;
-
-      .hljs-comment,
-      .hljs-quote {
-        color: #adadad;
-      }
-
-      .hljs-doctag,
-      .hljs-keyword,
-      .hljs-formula,
-      .hljs-number {
-        color: var(--stldocs-syntax-color-orange);
-      }
-
-      .hljs-section,
-      .hljs-name,
-      .hljs-selector-tag,
-      .hljs-deletion,
-      .hljs-subst {
-        color: var(--stldocs-syntax-color-red);
-      }
-
-      .hjs-literal,
-      .hljs-string,
-      .hljs-regexp,
-      .hljs-addition,
-      .hljs-attribute,
-      .hljs-meta .hljs-string {
-        color: var(--stldocs-syntax-color-green);
-      }
-
-      .hljs-attr,
-      .hljs-variable,
-      .hljs-template-variable,
-      .hljs-type,
-      .hljs-selector-class,
-      .hljs-selector-attr,
-      .hljs-selector-pseudo {
-        color: var(--stldocs-color-text);
-      }
-
-      .hljs-symbol,
-      .hljs-bullet,
-      .hljs-link,
-      .hljs-meta,
-      .hljs-selector-id,
-      .hljs-title {
-        color: var(--stldocs-syntax-color-purple);
-      }
-
-      .hljs-built_in,
-      .hljs-title.class_,
-      .hljs-class .hljs-title {
-        color: var(--stldocs-syntax-color-blue);
-      }
+      color: var(--stldocs-syntax-color-blue);
     }
   }
 }

package/dist/styles/variables.css

@@ -1,90 +1,86 @@
-@layer docs-ui {
-  :root {
-    color-scheme: dark;
-
-    --stldocs-font: 'Geist', system-ui, sans-serif;
-    --stldocs-font-mono: 'Geist Mono', ui-monospace, monospace;
-
-    --stldocs-color-white: #ffffff;
-    --stldocs-color-gray-1: #eeeeee;
-    --stldocs-color-gray-2: #c2c2c2;
-    --stldocs-color-gray-3: #8b8b8b;
-    --stldocs-color-gray-4: #52525c;
-    --stldocs-color-gray-5: #303030;
-    --stldocs-color-gray-6: #272727;
-    --stldocs-color-gray-7: #181818;
-    --stldocs-color-gray-8: #161616;
-
-    --stldocs-color-accent-low: #974703;
-    --stldocs-color-accent-high: #fdc99c;
-    --stldocs-color-accent: #f6821e;
-    --stldocs-color-red: #cf222e;
-    --stldocs-color-red-low: #351313;
-
-    --stldocs-color-text: var(--stldocs-color-gray-1);
-    --stldocs-color-text-muted: #6d6d6d;
-    --stldocs-color-text-mid: var(--stldocs-color-gray-3);
-    --stldocs-color-text-bright: var(--stldocs-color-gray-1);
-    --stldocs-color-text-accent: var(--stldocs-color-accent);
-    --stldocs-color-text-invert: var(--stldocs-color-white);
-    --stldocs-color-text-secondary: #acacac;
-    --stldocs-color-text-tertiary: #a3a3a3;
-
-    --stldocs-color-bg: var(--stldocs-color-gray-7);
-    --stldocs-color-bg-nav: var(--stldocs-color-gray-6);
-    --stldocs-color-selected: var(--stldocs-color-gray-6);
-
-    --stldocs-color-backdrop-overlay: hsla(225, 9%, 36%, 0.66);
-
-    --stldocs-color-bg-inline-code: #1f1f1f;
-    --stldocs-color-bg-accent: var(--stldocs-color-accent-high);
-    --stldocs-color-hairline: var(--stldocs-color-gray-5);
-    --stldocs-color-hairline-shade: var(--stldocs-color-white);
-    --stldocs-color-hairline-light: var(--stldocs-color-gray-5);
-
-    --stldocs-color-http-get-bg: #102916;
-    --stldocs-color-http-get: #4ac26b;
-
-    --stldocs-color-http-put-bg: #341e0e;
-    --stldocs-color-http-put: #fb8f44;
-
-    --stldocs-color-http-post-bg: #142a3d;
-    --stldocs-color-http-post: #54aeff;
-
-    --stldocs-color-http-delete-bg: #351313;
-    --stldocs-color-http-delete: #f8595c;
-
-    --stldocs-font-size-h1: 42px;
-    --stldocs-font-size-h2: 35px;
-    --stldocs-font-size-h3: 29px;
-    --stldocs-font-size-h4: 25px;
-    --stldocs-font-size-h5: 18px;
-
-    --stldocs-font-size-body: 14px;
-    --stldocs-font-size-body-xs: 12px;
-    --stldocs-font-size-small: 13px;
-    --stldocs-font-size-code: 14px;
-
-    --stldocs-content-width: 720px;
-    --stldocs-content-padding: 16px;
-
-    --stldocs-syntax-color-red: hsl(356 90.8% 66%);
-    --stldocs-syntax-color-green: hsl(136.5 49.6% 52.5%);
-    --stldocs-syntax-color-blue: hsl(208.4 100% 66.5%);
-    --stldocs-syntax-color-orange: hsl(24.6 96% 62.5%);
-    --stldocs-syntax-color-teal: hsl(203 100% 85.7%);
-    --stldocs-syntax-color-magenta: hsl(324 75.5% 63.1%);
-    --stldocs-syntax-color-purple: hsl(261 92.2% 74.7%);
-
-    --stldocs-color-snippet-box-bg: var(--stldocs-color-gray-6);
-    --stldocs-color-snippet-title-bg: var(--stldocs-color-gray-8);
-    --stldocs-color-snippet-title-muted: var(--stldocs-color-gray-3);
-    --stldocs-color-snippet-title-bright: var(--stldocs-color-white);
-    --stldocs-color-snippet-code-bg: var(--stldocs-color-gray-7);
-
-    --stldocs-color-backdrop-overlay: var(--stldocs-color-gray-8);
-    --stldocs-expander-margin-shift: 24px;
-    --stldocs-expander-right-margin: 8px;
-    --stldocs-title-padding-y: 2.5rem;
-  }
-}
+:root {
+  --stldocs-font: 'Geist', system-ui, sans-serif;
+  --stldocs-font-mono: 'Geist Mono', ui-monospace, monospace;
+
+  --stldocs-color-white: #ffffff;
+  --stldocs-color-gray-1: #eeeeee;
+  --stldocs-color-gray-2: #c2c2c2;
+  --stldocs-color-gray-3: #8b8b8b;
+  --stldocs-color-gray-4: #52525c;
+  --stldocs-color-gray-5: #303030;
+  --stldocs-color-gray-6: #272727;
+  --stldocs-color-gray-7: #181818;
+  --stldocs-color-gray-8: #161616;
+
+  --stldocs-color-accent-low: #974703;
+  --stldocs-color-accent-high: #fdc99c;
+  --stldocs-color-accent: #f6821e;
+  --stldocs-color-red: #cf222e;
+  --stldocs-color-red-low: #351313;
+
+  --stldocs-color-text: var(--stldocs-color-gray-1);
+  --stldocs-color-text-muted: #6d6d6d;
+  --stldocs-color-text-mid: var(--stldocs-color-gray-3);
+  --stldocs-color-text-bright: var(--stldocs-color-gray-1);
+  --stldocs-color-text-accent: var(--stldocs-color-accent);
+  --stldocs-color-text-invert: var(--stldocs-color-white);
+  --stldocs-color-text-secondary: #acacac;
+  --stldocs-color-text-tertiary: #a3a3a3;
+
+  --stldocs-color-bg: var(--stldocs-color-gray-7);
+  --stldocs-color-bg-nav: var(--stldocs-color-gray-6);
+  --stldocs-color-selected: var(--stldocs-color-gray-6);
+
+  --stldocs-color-backdrop-overlay: hsla(225, 9%, 36%, 0.66);
+
+  --stldocs-color-bg-inline-code: #1f1f1f;
+  --stldocs-color-bg-accent: var(--stldocs-color-accent-high);
+  --stldocs-color-hairline: var(--stldocs-color-gray-5);
+  --stldocs-color-hairline-shade: var(--stldocs-color-white);
+  --stldocs-color-hairline-light: var(--stldocs-color-gray-5);
+
+  --stldocs-color-http-get-bg: #102916;
+  --stldocs-color-http-get: #4ac26b;
+
+  --stldocs-color-http-put-bg: #341e0e;
+  --stldocs-color-http-put: #fb8f44;
+
+  --stldocs-color-http-post-bg: #142a3d;
+  --stldocs-color-http-post: #54aeff;
+
+  --stldocs-color-http-delete-bg: #351313;
+  --stldocs-color-http-delete: #f8595c;
+
+  --stldocs-font-size-h1: 42px;
+  --stldocs-font-size-h2: 35px;
+  --stldocs-font-size-h3: 29px;
+  --stldocs-font-size-h4: 25px;
+  --stldocs-font-size-h5: 18px;
+
+  --stldocs-font-size-body: 14px;
+  --stldocs-font-size-body-xs: 12px;
+  --stldocs-font-size-small: 13px;
+  --stldocs-font-size-code: 14px;
+
+  --stldocs-content-width: 720px;
+  --stldocs-content-padding: 16px;
+
+  --stldocs-syntax-color-red: hsl(356 90.8% 66%);
+  --stldocs-syntax-color-green: hsl(136.5 49.6% 52.5%);
+  --stldocs-syntax-color-blue: hsl(208.4 100% 66.5%);
+  --stldocs-syntax-color-orange: hsl(24.6 96% 62.5%);
+  --stldocs-syntax-color-teal: hsl(203 100% 85.7%);
+  --stldocs-syntax-color-magenta: hsl(324 75.5% 63.1%);
+  --stldocs-syntax-color-purple: hsl(261 92.2% 74.7%);
+
+  --stldocs-color-snippet-box-bg: var(--stldocs-color-gray-6);
+  --stldocs-color-snippet-title-bg: var(--stldocs-color-gray-8);
+  --stldocs-color-snippet-title-muted: var(--stldocs-color-gray-3);
+  --stldocs-color-snippet-title-bright: var(--stldocs-color-white);
+  --stldocs-color-snippet-code-bg: var(--stldocs-color-gray-7);
+
+  --stldocs-color-backdrop-overlay: var(--stldocs-color-gray-8);
+  --stldocs-expander-margin-shift: 24px;
+  --stldocs-expander-right-margin: 8px;
+  --stldocs-title-padding-y: 2.5rem;
+}

package/dist/types-BLgvxY4i.d.ts

@@ -0,0 +1,83 @@
+import { t as DocsLanguage } from "./routing-BE6Vrs-z.js";
+import * as SDKJSON from "@stainless/sdk-json";
+
+//#region src/search/types.d.ts
+type SearchSettings = {
+  appId: string;
+  searchKey: string;
+  indexName: string;
+  assistant?: string;
+};
+type SearchParams = {
+  query: string;
+  language?: DocsLanguage | null;
+  kind?: QueryKindsType | null;
+};
+declare const QueryKinds: readonly ["all", "resource", "http_method", "model", "property", "guide"];
+type QueryKindsType = (typeof QueryKinds)[number];
+type IndexModel = {
+  kind: 'model';
+  title: string;
+  children?: string[];
+  ident?: string;
+};
+type IndexProperty = {
+  kind: 'property';
+  docstring?: string;
+  type?: string;
+};
+type IndexResource = {
+  kind: 'resource';
+  title: string;
+  Name: string;
+  QualifiedName: string;
+};
+type IndexMethod = Pick<SDKJSON.Method, 'kind' | 'summary' | 'description' | 'endpoint' | 'httpMethod'> & {
+  title: string;
+  qualified?: string;
+  ident?: string;
+};
+declare const SearchableAttributes: readonly ["name", "title", "ident", "Name", "qualified", "QualifiedName", "endpoint", "summary", "description", "docstring"];
+declare const SearchableAttributesChat: string[];
+type SearchAttributeNames = (typeof SearchableAttributes)[number];
+type RoutableJsonNode = SDKJSON.Method | SDKJSON.Model | SDKJSON.Resource;
+type IndexEntry = Pick<RoutableJsonNode, 'name' | 'stainlessPath'> & (IndexProperty | IndexModel | IndexResource | IndexMethod) & {
+  language: DocsLanguage;
+  priority: number;
+  crumbs: string[];
+};
+type ResultRecordType = IndexEntry & {
+  objectID: string;
+  _highlightResult: Record<SearchAttributeNames, {
+    value: string;
+  }>;
+};
+type ResultType = {
+  hits: ResultRecordType[];
+  facets?: Record<string, Record<string, number>>;
+  nbHits: number;
+};
+type GuideResultType = {
+  id: string;
+  score: number;
+  words: number[];
+  data: {
+    excerpt: string;
+    url: string;
+    word_count: number;
+    meta: {
+      title: string;
+    };
+    sub_results: {
+      url: string;
+      title: string;
+      excerpt: string;
+    }[];
+  };
+};
+type ResultData = {
+  items: Array<ResultRecordType | GuideResultType>;
+  counts: Partial<Record<QueryKindsType, number>>;
+};
+//#endregion
+export { SearchableAttributesChat as _, IndexProperty as a, QueryKindsType as c, ResultType as d, RoutableJsonNode as f, SearchableAttributes as g, SearchSettings as h, IndexModel as i, ResultData as l, SearchParams as m, IndexEntry as n, IndexResource as o, SearchAttributeNames as p, IndexMethod as r, QueryKinds as s, GuideResultType as t, ResultRecordType as u };

package/dist/types-DFN4M1Sp.js

@@ -0,0 +1,34 @@
+//#region src/search/types.ts
+const QueryKinds = [
+	"all",
+	"resource",
+	"http_method",
+	"model",
+	"property",
+	"guide"
+];
+const SearchableAttributes = [
+	"name",
+	"title",
+	"ident",
+	"Name",
+	"qualified",
+	"QualifiedName",
+	"endpoint",
+	"summary",
+	"description",
+	"docstring"
+];
+const SearchableAttributesChat = [
+	"title",
+	"name",
+	"endpoint",
+	"summary",
+	"description",
+	"qualified",
+	"ident",
+	"content"
+];
+
+//#endregion
+export { SearchableAttributes as n, SearchableAttributesChat as r, QueryKinds as t };

package/dist/use-components-DI-AbT-D.js

@@ -0,0 +1,7 @@
+import { i as useComponents } from "./component-generics-Df4EDvxk.js";
+
+//#region src/contexts/use-components.tsx
+const useComponents$1 = () => useComponents();
+
+//#endregion
+export { useComponents$1 as t };

package/dist/utils-B9JL_XWH.d.ts

@@ -0,0 +1,21 @@
+import { t as DocsLanguage } from "./routing-BE6Vrs-z.js";
+import { C as TransformRequestSnippetFn } from "./sdk-D2x2l6JH.js";
+import * as SDKJSON from "@stainless/sdk-json";
+
+//#region src/markdown/utils.d.ts
+type EnvironmentType = {
+  spec: SDKJSON.Spec;
+  language: DocsLanguage;
+  transforms?: {
+    transformRequestSnippet?: TransformRequestSnippetFn;
+  };
+  options: {
+    renderNestedResources?: boolean;
+    includeModelProperties?: boolean;
+  };
+};
+declare function getDecl(env: EnvironmentType, path: string): SDKJSON.LanguageDeclNodes[SDKJSON.SpecLanguage] | undefined;
+declare function getSnippet(env: EnvironmentType, path: string): string | undefined;
+declare function stripMarkup(content: string): string;
+//#endregion
+export { stripMarkup as i, getDecl as n, getSnippet as r, EnvironmentType as t };