chore: better Typescript types (#9480)

* fix doc type

* improve frontmatter types

* add types to files.ts

* get rid of `any`s from docPage

* add types to JsBundleListClient

* add TS types to utils.ts

* fix dynamicNav types

* let the inferred type shine

* add proper types to CodeKeywords

* add TS to apiExamples

* add TS type to sidebar

* add TS types to serverSidebar

* add TS types to expandable

* add TS types to PlatformContent component

* add TS types to cliChecksumTableClient

* add proper TS types to changelog/list

* add proper doc TS type to Include component

* improte TS types for Alert component

* imropve resolveOpenAPI types

* fix type import 🙊

* add missing sidebar_title front matter property

* fix TS errors on [[...path]]/page.tsx

* fix TS errors in *sidebar.tsx

* fix TS errors on apiPage

* fix TS errors on docTree

* narrow down some anys on docTree

* move remark-component-spacing plugin to TS

* move remark-toc-headings plugin to TS

* move remark-extract-frontmatter plugin to TS

Author: a-hariti

app/[[...path]]/page.tsx

@@ -22,7 +22,7 @@ import {capitilize} from 'sentry-docs/utils';
 
 export async function generateStaticParams() {
   const docs = await getDocsFrontMatter();
-  const paths = docs.map(doc => {
+  const paths: {path: string[] | undefined}[] = docs.map(doc => {
     const path = doc.slug.split('/');
     return {path};
   });
@@ -83,7 +83,7 @@ export default async function Page({params}) {
   }
 
   // get the MDX for the current doc and render it
-  let doc: any = null;
+  let doc: Awaited<ReturnType<typeof getFileBySlug>> | null = null;
   try {
     doc = await getFileBySlug(`docs/${pageNode.path}`);
   } catch (e) {
@@ -128,7 +128,7 @@ export async function generateMetadata({params}: MetadataProps): Promise<Metadat
       title =
         pageNode.frontmatter.title +
         (guideOrPlatform ? ` | Sentry for ${capitilize(guideOrPlatform.name)}` : '');
-      description = pageNode.frontmatter.description;
+      description = pageNode.frontmatter.description ?? '';
     }
   }
 

src/build/resolveOpenAPI.ts

@@ -44,14 +44,32 @@ export type APIParameter = {
   };
 };
 
+type APIExample = {
+  summary: string;
+  value: any;
+};
+
+type APIResponse = {
+  description: string;
+  status_code: string;
+  content?: {
+    content_type: string;
+    schema: any;
+    example?: APIExample;
+    examples?: {[key: string]: APIExample};
+  };
+};
+
+type APIData = DeRefedOpenAPI['paths'][string][string];
+
 export type API = {
   apiPath: string;
   bodyParameters: APIParameter[];
   method: string;
   name: string;
   pathParameters: APIParameter[];
   queryParameters: APIParameter[];
-  responses: any;
+  responses: APIResponse[];
   slug: string;
   bodyContentType?: string;
   descriptionMarkdown?: string;
@@ -154,7 +172,7 @@ async function apiCategoriesUncached(): Promise<APICategory[]> {
   return categories;
 }
 
-function getBodyParameters(apiData): APIParameter[] {
+function getBodyParameters(apiData: APIData): APIParameter[] {
   const content = apiData.requestBody?.content;
   const contentType = content && Object.values(content)[0];
   const properties = contentType?.schema?.properties;
@@ -176,7 +194,7 @@ function getBodyParameters(apiData): APIParameter[] {
   }));
 }
 
-function getBodyContentType(apiData): string | undefined {
+function getBodyContentType(apiData: APIData): string | undefined {
   const content = apiData.requestBody?.content;
   const types = content && Object.keys(content);
   if (!types?.length) {

src/components/alert.tsx

@@ -1,7 +1,9 @@
 'use client';
 
+import {ReactNode} from 'react';
+
 type Props = {
-  children?: any;
+  children?: ReactNode;
   level?: 'info' | 'warning' | 'danger' | 'success' | '';
   title?: string;
 };
@@ -11,7 +13,7 @@ export function Alert({title, children, level}: Props) {
   if (level) {
     className += ` alert-${level}`;
   }
-  if (children.props && typeof children.props.children === 'string') {
+  if (children && typeof children === 'string') {
     className += ' markdown-text-only';
   }
   return (

src/components/apiExamples.tsx

@@ -9,16 +9,18 @@ import {Fragment, useState} from 'react';
 
 import {type API} from 'sentry-docs/build/resolveOpenAPI';
 
-function Example(props) {
-  const selectedTabView: number = props.selectedTabView;
-  const api: API = props.api;
-  const selectedResponse: number = props.selectedResponse;
+type ExampleProps = {
+  api: API;
+  selectedResponse: number;
+  selectedTabView: number;
+};
 
-  let exampleJson;
+function Example({api, selectedTabView, selectedResponse}: ExampleProps) {
+  let exampleJson: any;
   if (api.responses[selectedResponse].content?.examples) {
-    exampleJson = Object.values(api.responses[selectedResponse].content?.examples).map(
-      (e: any) => e.value
-    )[0];
+    exampleJson = Object.values(
+      api.responses[selectedResponse].content?.examples ?? {}
+    ).map(e => e.value)[0];
   } else if (api.responses[selectedResponse].content?.example) {
     exampleJson = api.responses[selectedResponse].content?.example;
   }
@@ -43,7 +45,7 @@ function Example(props) {
         <code
           dangerouslySetInnerHTML={{
             __html: Prism.highlight(
-              JSON.stringify(api.responses[selectedResponse].content.schema, null, 2),
+              JSON.stringify(api.responses[selectedResponse].content?.schema, null, 2),
               Prism.languages.json,
               'json'
             ),
@@ -54,7 +56,7 @@ function Example(props) {
   );
 }
 
-const strFormat = str => {
+const strFormat = (str: string) => {
   const s = str.trim();
   if (s.endsWith('.')) {
     return s;

src/components/changelog/list.tsx

@@ -61,15 +61,16 @@ export default function Changelogs({
   });
 
   // iterate over all posts and create a list of months & years
-  const months = changelogs.reduce((allMonths: any, post: any) => {
-    const date = new Date(post.publishedAt) as Date;
+  const months = changelogs.reduce((allMonths, post) => {
+    // if no date is set, use the epoch (simulate behavior before this refactor)
+    const date = post.publishedAt ?? new Date(0);
     const year = date.getFullYear();
     const month = date.toLocaleString('default', {
       month: 'long',
     });
     const dateMonthYear = `${month} ${year}`;
     return [...new Set([...allMonths, dateMonthYear])];
-  }, []);
+  }, [] as string[]);
 
   const monthsCopy = [...months];
 

src/components/cliChecksumTableClient.tsx

@@ -7,8 +7,16 @@ const ChecksumValue = styled.code`
   white-space: nowrap;
 `;
 
+export type Files = {
+  checksums: {
+    name: string;
+    value: string;
+  }[];
+  name: string;
+};
+
 type Props = {
-  files: any[];
+  files: Files[];
   version: string;
 };
 
@@ -37,7 +45,7 @@ export function CliChecksumTableClient({version, files}: Props) {
               </td>
               <td style={{verticalAlign: 'middle', width: '100%'}}>
                 <ChecksumValue>
-                  {`sha384-${file.checksums.find(c => c.name === 'sha256-hex').value}`}
+                  {`sha384-${file.checksums.find(c => c.name === 'sha256-hex')?.value}`}
                 </ChecksumValue>
               </td>
             </tr>

src/components/codeKeywords.tsx

@@ -68,11 +68,11 @@ function runRegex(
   arr: ChildrenItem[],
   str: string,
   regex: RegExp,
-  cb: (lastIndex: number, match: any[]) => React.ReactNode
+  cb: (lastIndex: number, match: RegExpExecArray) => React.ReactNode
 ): void {
   regex.lastIndex = 0;
 
-  let match;
+  let match: RegExpExecArray | null;
   let lastIndex = 0;
   // eslint-disable-next-line no-cond-assign
   while ((match = regex.exec(str)) !== null) {

src/components/docPage.tsx

@@ -2,6 +2,7 @@ import {ReactNode} from 'react';
 
 import {getCurrentPlatformOrGuide} from 'sentry-docs/docTree';
 import {serverContext} from 'sentry-docs/serverContext';
+import {FrontMatter} from 'sentry-docs/types';
 
 import {Breadcrumbs} from './breadcrumbs';
 import {CodeContextProvider} from './codeContext';
@@ -15,8 +16,8 @@ import {ServerSidebar} from './serverSidebar';
 import {TableOfContents} from './tableOfContents';
 
 type Props = {
-  children: any;
-  frontMatter: any;
+  children: ReactNode;
+  frontMatter: Omit<FrontMatter, 'slug'>;
   notoc?: boolean;
   sidebar?: ReactNode;
 };

src/components/dynamicNav.tsx

@@ -10,9 +10,9 @@ type Node = {
   [key: string]: any;
   context: {
     [key: string]: any;
-    sidebar_order?: number | null;
-    sidebar_title?: string | null;
-    title?: string | null;
+    sidebar_order?: number;
+    sidebar_title?: string;
+    title?: string;
   };
   path: string;
 };
@@ -64,13 +64,17 @@ export const renderChildren = (
       ({name, node}) =>
         node && !!node.context.title && name !== '' && exclude.indexOf(node.path) === -1
     ),
-    ({node}) => node
+    ({node}) => node!
   ).map(({node, children: nodeChildren}) => {
+    // will not be null because of the filter above
+    if (!node) {
+      return null;
+    }
     return (
       <SidebarLink
         to={node.path}
         key={node.path}
-        title={node.context.sidebar_title || node.context.title}
+        title={node.context.sidebar_title || node.context.title!}
         collapsed={depth >= showDepth}
         path={path}
       >

src/components/expandable.tsx

@@ -1,11 +1,11 @@
 'use client';
 
-import {useState} from 'react';
+import {ReactNode, useState} from 'react';
 import {ArrowDown} from 'react-feather';
 import styled from '@emotion/styled';
 
 type Props = {
-  children: any;
+  children: ReactNode;
   title: string;
 };