@stainless-api/docs-ui 0.1.0-beta.29 → 0.1.0-beta.30

package/src/search/types.ts

@@ -1,116 +0,0 @@
-import type * as SDKJSON from '@stainless/sdk-json';
-import { DocsLanguage } from '../routing';
-
-export type SearchSettings = {
-  appId: string;
-  searchKey: string;
-  indexName: string;
-  assistant?: string;
-};
-
-export type SearchParams = {
-  query: string;
-  language?: DocsLanguage | null;
-  kind?: QueryKindsType | null;
-};
-
-export const QueryKinds = ['all', 'resource', 'http_method', 'model', 'property', 'guide'] as const;
-
-export type QueryKindsType = (typeof QueryKinds)[number];
-
-export type IndexModel = {
-  kind: 'model';
-  title: string;
-  children?: string[];
-  ident?: string;
-};
-
-export type IndexProperty = {
-  kind: 'property';
-  docstring?: string;
-  type?: string;
-};
-
-export type IndexResource = {
-  kind: 'resource';
-  title: string;
-  Name: string;
-  QualifiedName: string;
-};
-
-export type IndexMethod = Pick<
-  SDKJSON.Method,
-  'kind' | 'summary' | 'description' | 'endpoint' | 'httpMethod'
-> & {
-  title: string;
-  qualified?: string;
-  ident?: string;
-};
-
-export const SearchableAttributes = [
-  'name',
-  'title',
-  'ident',
-  'Name',
-  'qualified',
-  'QualifiedName',
-  'endpoint',
-  'summary',
-  'description',
-  'docstring',
-] as const;
-
-export const SearchableAttributesChat = [
-  'title',
-  'name',
-  'endpoint',
-  'summary',
-  'description',
-  'qualified',
-  'ident',
-  'content',
-];
-
-export type SearchAttributeNames = (typeof SearchableAttributes)[number];
-
-export type RoutableJsonNode = SDKJSON.Method | SDKJSON.Model | SDKJSON.Resource;
-
-export type IndexEntry = Pick<RoutableJsonNode, 'name' | 'stainlessPath'> &
-  (IndexProperty | IndexModel | IndexResource | IndexMethod) & {
-    language: DocsLanguage;
-    priority: number;
-    crumbs: string[];
-  };
-
-export type ResultRecordType = IndexEntry & {
-  objectID: string;
-  _highlightResult: Record<SearchAttributeNames, { value: string }>;
-};
-
-export type ResultType = {
-  hits: ResultRecordType[];
-  facets?: Record<string, Record<string, number>>;
-  nbHits: number;
-};
-
-export 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;
-    }[];
-  };
-};
-
-export type ResultData = {
-  items: Array<ResultRecordType | GuideResultType>;
-  counts: Partial<Record<QueryKindsType, number>>;
-};

package/src/style.ts

@@ -1,185 +0,0 @@
-export default {
-  TextIdentifier: 'stldocs-text-identifier',
-  TextOperator: 'stldocs-text-operator',
-  TextPunctuation: 'stldocs-text-punctuation',
-  TextKeyword: 'stldocs-text-keyword',
-
-  ContentArea: 'stldocs-content-area',
-  Markdown: 'stldocs-markdown',
-  Content: 'stldocs-content',
-  Truncation: 'stldocs-truncation',
-  Expander: 'stldocs-expander',
-  ExpanderContent: 'stldocs-expander-content',
-  ExpanderSummary: 'stldocs-expander-summary',
-  ExpanderSummaryIcon: 'stldocs-expander-summary-icon',
-  ExpanderSummaryContent: 'stldocs-expander-summary-content',
-  ExpanderIndent: 'stldocs-expander-indent',
-  Badge: 'stldocs-badge',
-  Icon: 'stldocs-icon',
-  Tooltip: 'stldocs-tooltip',
-  TooltipHost: 'stldocs-tooltip-host',
-  TooltipContent: 'stldocs-tooltip-content',
-  Input: 'stldocs-input',
-  InputTextField: 'stldocs-input-textfield',
-  ToggleButton: 'stldocs-togglebutton',
-  ListView: 'stldocs-listview',
-  ListViewItem: 'stldocs-listview-item',
-  ExpandToggle: 'stldocs-expand-toggle',
-  ExpandToggleContent: 'stldocs-expand-toggle-content',
-  LoadingSpinner: 'stldocs-loading-spinner',
-
-  Type: 'stldocs-type',
-  TypeName: 'stldocs-typename',
-  TypeKeyword: 'stldocs-type-keyword',
-  TypeString: 'stldocs-type-string',
-  TypeArray: 'stldocs-type-array',
-  TypeReference: 'stldocs-type-reference',
-  TypeBracket: 'stldocs-type-bracket',
-  TypeBrace: 'stldocs-type-brace',
-  TypePropertyName: 'stldocs-type-propertyname',
-  TypePlain: 'stldocs-type-plain',
-  TypePreview: 'stldocs-type-preview',
-  TypePreviewContent: 'stldocs-type-preview-content',
-
-  LiteralString: 'stldocs-literal-string',
-  LiteralNumeric: 'stldocs-literal-numeric',
-  LiteralBoolean: 'stldocs-literal-boolean',
-
-  Snippet: 'stldocs-snippet',
-  SnippetCode: 'stldocs-snippet-code',
-  SnippetCodeContent: 'stldocs-snippet-code-content',
-
-  SnippetRequest: 'stldocs-snippet-request',
-  SnippetRequestTitle: 'stldocs-snippet-request-title',
-  SnippetRequestTitleContent: 'stldocs-snippet-request-title-content',
-  SnippetRequestTitleLabel: 'stldocs-snippet-request-title-label',
-  SnippetRequestTitleLanguage: 'stldocs-snippet-request-title-language',
-  SnippetRequestTitleMethod: 'stldocs-snippet-request-title-method',
-
-  SnippetResponse: 'stldocs-snippet-response',
-  SnippetMultiResponse: 'stldocs-snippet-multi-response',
-
-  SnippetResponseTitle: 'stldocs-snippet-response-title',
-  SnippetResponseClosed: 'stldocs-snippet-response-closed',
-  SnippetResponseOpen: 'stldocs-snippet-response-opened',
-  SnippetResponseTab: 'stldocs-snippet-response-tab',
-  SnippetResponseTabItem: 'stldocs-snippet-response-tab-item',
-  SnippetResponseTabItemActive: 'stldocs-snippet-response-tab-item-active',
-  SnippetResponseTabSingleReturn: 'stldocs-snippet-response-tab-single-return',
-  SnippetResponsePane: 'stldocs-snippet-response-pane',
-  SnippetResponsePaneActive: 'stldocs-snippet-response-pane-active',
-
-  Method: 'stldocs-method',
-  MethodHeader: 'stldocs-method-header',
-  MethodBody: 'stldocs-method-body',
-  MethodInfo: 'stldocs-method-info',
-  MethodInfoSection: 'stldocs-method-info-section',
-  MethodExample: 'stldocs-method-example',
-  MethodResponseColumn: 'stldocs-method-response-column',
-  MethodTitle: 'stldocs-method-title',
-  MethodBadges: 'stldocs-method-badges',
-  MethodSignature: 'stldocs-method-signature',
-  MethodDescription: 'stldocs-method-description',
-  MethodParameters: 'stldocs-method-parameters',
-  MethodReturns: 'stldocs-method-returns',
-  MethodContent: 'stldocs-method-content',
-  MethodContentColumn: 'stldocs-method-content-column',
-  MethodRouteHttpMethod: 'stldocs-method-route-httpmethod',
-  MethodRouteHttpMethodIconOnly: 'stldocs-method-route-httpmethod-icon-only',
-  MethodRouteEndpoint: 'stldocs-method-route-endpoint',
-  MethodRoute: 'stldocs-method-route',
-  MethodSummary: 'stldocs-method-summary',
-  MethodSinglePane: 'stldocs-method-single-pane',
-  MethodDoublePane: 'stldocs-method-double-pane',
-
-  SignatureTitle: 'stldocs-signature-title',
-  SignatureName: 'stldocs-signature-name',
-  SignatureQualified: 'stldocs-signature-qualified',
-  SignatureParams: 'stldoc-signature-params',
-  SignatureParen: 'stldocs-signature-paren',
-  SignatureReturns: 'stldocs-signature-returns',
-
-  Property: 'stldocs-property',
-  Properties: 'stldocs-properties',
-  PropertyHeader: 'stldocs-property-header',
-  PropertyInfo: 'stldocs-property-info',
-  PropertyDeclaration: 'stldocs-property-declaration',
-  PropertyDeprecated: 'stldocs-property-deprecated',
-  PropertyDeprecatedMessage: 'stldocs-property-deprecated-message',
-  PropertyContent: 'stldocs-property-content',
-  PropertyChildren: 'stldocs-property-children',
-  PropertyConstraints: 'stldocs-property-constraints',
-  PropertyConstraint: 'stldocs-property-constraint',
-  PropertyConstraintName: 'stldocs-property-constraint-name',
-  PropertyConstraintValue: 'stldocs-property-constraint-value',
-  PropertyDefault: 'stldocs-property-default',
-  PropertyDescription: 'stldocs-property-description',
-  PropertyAnnotation: 'stldocs-property-annotation',
-  PropertyName: 'stldocs-property-name',
-  PropertyBadges: 'stldocs-property-badges',
-  PropertyTypeName: 'stldocs-property-typename',
-  PropertyType: 'stldocs-property-type',
-
-  Overview: 'stldocs-overview',
-  OverviewHeader: 'stldocs-overview-header',
-  OverviewHeaderInfo: 'stldocs-overview-header-info',
-  OverviewHeaderInfoTimestamp: 'stldocs-overview-header-info-timestamp',
-  Resource: 'stldocs-resource',
-  ResourceContent: 'stldocs-resource-content',
-  ResourceContentProperties: 'stldocs-resource-content-properties',
-  ResourceContentGroup: 'stldocs-resource-content-group',
-  ResourceContentGroupName: 'stldocs-resource-content-group-name',
-  ResourceContentGroupModelTitle: 'stldocs-resource-content-group-model-title',
-  ResourceHeader: 'stldocs-resource-header',
-  ResourceTitle: 'stldocs-resource-title',
-  ResourceTitleSegment: 'stldocs-resource-title-segment',
-  ResourceDescription: 'stldocs-resource-description',
-  ResourceName: 'stldocs-resource-name',
-  Model: 'stldocs-model',
-  Root: 'stldocs-root',
-
-  Sidebar: 'stldocs-sidebar',
-  SidebarResource: 'stldocs-sidebar-resource',
-  SidebarResourceTitle: 'stldocs-sidebar-resource-title',
-  SidebarMethod: 'stldocs-sidebar-method',
-  SidebarItemTitle: 'stldocs-sidebar-resource-title',
-  SidebarExpander: 'stldocs-sidebar-expander',
-  SidebarExpanderSummary: 'stldocs-sidebar-expander-summary',
-  SidebarExpanderContent: 'stldocs-sidebar-expander-content',
-
-  SearchForm: 'stldocs-search-form',
-  SearchModal: 'stldocs-search-modal',
-  SearchFilter: 'stldocs-search-filter',
-  SearchFilterLabel: 'stldocs-search-filter-label',
-  SearchFilterCount: 'stldocs-search-filter-count',
-  SearchBreadcrumb: 'stldocs-search-breadcrumb',
-  SearchBreadcrumbItem: 'stldocs-search-breadcrumb-item',
-  SearchBreadcrumbDivider: 'stldocs-search-breadcrumb-divider',
-  SearchResult: 'stldocs-search-result',
-  SearchResultResourceInfo: 'stldocs-search-result-resource-info',
-  SearchResultResourceTitle: 'stldocs-search-result-resource-title',
-  SearchResultResourcePath: 'stldocs-search-result-resource-path',
-  SearchResultGuideTitle: 'stldocs-search-result-guide-title',
-  SearchResultGuideExcerpt: 'stldocs-search-result-guide-excerpt',
-
-  Chat: 'stldocs-chat',
-  ChatHeader: 'stldocs-chat-header',
-  ChatInput: 'stldocs-chat-input',
-  ChatInputButtons: 'stldocs-chat-input-buttons',
-  ChatMessages: 'stldocs-chat-messages',
-  ChatMessage: 'stldocs-chat-message',
-
-  LanguageBlock: 'stldocs-language-block',
-  LanguageBlockContent: 'stldocs-language-block-content',
-  LanguageBlockContentIcon: 'stldocs-language-block-content-icon',
-  LanguageBlockContentInfo: 'stldocs-language-block-content-info',
-  LanguageBlockContentInfoLanguage: 'stldocs-language-block-content-info-language',
-  LanguageBlockContentInfoVersion: 'stldocs-language-block-content-info-version',
-  LanguageBlockLinks: 'stldocs-language-block-links',
-  LanguageBlockInstall: 'stldocs-language-block-install',
-
-  Breadcrumbs: 'stldocs-breadcrumbs',
-  BreadcrumbsItem: 'stldocs-breadcrumbs-item',
-  BreadcrumbsLink: 'stldocs-breadcrumbs-link',
-  BreadcrumbsNonLink: 'stldocs-breadcrumbs-non-link',
-} as const;