Merge branch 'main' into sulaiman/fer-2652-monite-boundary-support-sy…

…nchronizing-tab-groups
fern-api · Jul 30, 2024 · 0e5bdea · 0e5bdea
2 parents 6385134 + 08e19d9
commit 0e5bdea
Show file tree

Hide file tree

Showing 50 changed files with 337 additions and 276 deletions.
diff --git a/.github/workflows/publish-fdr-sdk.yml b/.github/workflows/publish-fdr-sdk.yml
@@ -19,7 +19,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          ref: ${{ github.event.inputs.branch || "main" }}
+          ref: ${{ github.event.inputs.branch }}
 
       - name: 📥 Install
         uses: ./.github/actions/install
@@ -40,7 +40,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          ref: ${{ github.event.inputs.branch || "main" }}
+          ref: ${{ github.event.inputs.branch }}
 
       - name: 📥 Install
         uses: ./.github/actions/install

diff --git a/.github/workflows/test-fern-bot.yml b/.github/workflows/test-fern-bot.yml
@@ -26,8 +26,21 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+
       - name: 📥 Install
         uses: ./.github/actions/install
+
+      - name: Codegen
+        run: |
+          npm install -g fern-api
+
+      - name: Compile and build
+        run: pnpm turbo compile codegen build
+        env:
+          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+          WORKOS_API_KEY: ${{ secrets.WORKOS_API_KEY }}
+          WORKOS_CLIENT_ID: ${{ secrets.WORKOS_CLIENT_ID }}
+
       - name: 🚀 serverless function run-thru
         env:
           CI: false

diff --git a/clis/docs-migrator/src/index.ts b/clis/docs-migrator/src/index.ts
@@ -136,17 +136,18 @@ export class MigrateFromMintlify {
         );
 
         // create openapi folder
-        if (mint.openapi != null && mint.openapi.length > 0) {
+        if (mint.openapi != null) {
             const openapiDir = path.join(fernDir, "openapi");
             fs.mkdirSync(openapiDir, { recursive: true });
-            if (mint.openapi.length > 1) {
+            const firstOpenapi = typeof mint.openapi === "string" ? mint.openapi : mint.openapi[0];
+            if (firstOpenapi != null) {
+                const openapiFilePath = path.join(this.dir, firstOpenapi);
+                const newOpenapiFilePath = path.join(openapiDir, `openapi${path.extname(firstOpenapi)}`);
+                await fs.promises.copyFile(openapiFilePath, newOpenapiFilePath);
+            }
+            if (typeof mint.openapi !== "string" && mint.openapi.length > 1) {
                 console.warn("Multiple OpenAPI files are not supported yet in this migrator.");
             }
-
-            const openapi = mint.openapi[0];
-            const openapiFilePath = path.join(this.dir, openapi);
-            const newOpenapiFilePath = path.join(openapiDir, `openapi${path.extname(openapi)}`);
-            await fs.promises.copyFile(openapiFilePath, newOpenapiFilePath);
         }
     }
 

diff --git a/packages/commons/github/src/createOrUpdatePullRequest.ts b/packages/commons/github/src/createOrUpdatePullRequest.ts
@@ -15,6 +15,9 @@ interface RepoMetadata {
 
 function parseRepository(repository: string): RepoMetadata {
     const [owner, repo] = repository.split("/");
+    if (owner == null || repo == null) {
+        throw new Error(`Failed to parse repository into owner and repo: ${repository}`);
+    }
     return {
         owner,
         repo,
@@ -74,9 +77,15 @@ export async function createOrUpdatePullRequest(
         base: inputs.base,
     });
     console.log("Attempting update of pull request");
+
+    const pullNumber = pulls[0]?.number;
+    if (pullNumber == null) {
+        throw new Error(`Failed to retrieve pull request number: ${JSON.stringify(pulls)}`);
+    }
+
     const { data: pull } = await octokit.rest.pulls.update({
         ...parseRepository(baseRepository),
-        pull_number: pulls[0].number,
+        pull_number: pullNumber,
         title: inputs.title,
         body: inputs.body,
     });

diff --git a/packages/commons/github/src/getLatestTag.ts b/packages/commons/github/src/getLatestTag.ts
@@ -15,5 +15,5 @@ export async function getLatestTag(githubRepository: string): Promise<string | u
         per_page: 1, // Fetch only the latest tag
     });
 
-    return response.data?.[0].name;
+    return response.data?.[0]?.name;
 }
diff --git a/packages/commons/github/src/parseRepository.ts b/packages/commons/github/src/parseRepository.ts
@@ -19,10 +19,10 @@ export function parseRepository(githubRepository: string): RepositoryReference {
     }
 
     const parts = githubRepository.split("/");
-    if (parts.length === 2) {
+    if (parts.length === 2 && parts[0] != null && parts[1] != null) {
         // Format: owner/repo
         [owner, repo] = parts;
-    } else if (parts.length === 3 && parts[0] === DEFAULT_REMOTE) {
+    } else if (parts.length === 3 && parts[0] === DEFAULT_REMOTE && parts[1] != null && parts[2] != null) {
         // Format: github.com/owner/repo
         [, owner, repo] = parts;
     } else {

diff --git a/packages/commons/github/tsconfig.json b/packages/commons/github/tsconfig.json
@@ -1,5 +1,10 @@
 {
-  "extends": "@fern-platform/configs/tsconfig/library.json",
-  "compilerOptions": { "outDir": "./dist", "rootDir": "./src" },
+  "extends": "@fern-platform/configs/tsconfig/base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "module": "esnext",
+    "moduleResolution": "node"
+  },
   "include": ["./src/**/*"]
 }
diff --git a/packages/configs/tsconfig/base.json b/packages/configs/tsconfig/base.json
@@ -3,23 +3,21 @@
   "display": "Base",
   "compilerOptions": {
     "allowSyntheticDefaultImports": true,
-    "composite": false,
+    "composite": true,
     "esModuleInterop": true,
     "experimentalDecorators": true,
     "forceConsistentCasingInFileNames": true,
     "incremental": true,
     "inlineSources": false,
     "isolatedModules": true,
     "lib": ["ESNext"],
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
     "noFallthroughCasesInSwitch": true,
     "noImplicitAny": true,
     "noImplicitOverride": true,
     "noImplicitReturns": true,
     "noImplicitThis": false,
     "noPropertyAccessFromIndexSignature": false,
-    "noUncheckedIndexedAccess": false,
+    "noUncheckedIndexedAccess": true,
     "noUnusedLocals": false,
     "noUnusedParameters": false,
     "resolveJsonModule": true,

diff --git a/packages/configs/tsconfig/library.json b/packages/configs/tsconfig/library.json
@@ -5,6 +5,8 @@
   "compilerOptions": {
     "declaration": true,
     "declarationMap": true,
-    "composite": true
+    "composite": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler"
   }
 }
diff --git a/packages/configs/tsconfig/nextjs.json b/packages/configs/tsconfig/nextjs.json
@@ -11,6 +11,7 @@
     "jsx": "preserve",
     "lib": ["dom", "dom.iterable", "esnext"],
     "types": ["node", "next", "vitest/globals"],
-    "plugins": [{ "name": "next" }]
+    "plugins": [{ "name": "next" }],
+    "noUncheckedIndexedAccess": true
   }
 }
diff --git a/packages/configs/tsconfig/react-library.json b/packages/configs/tsconfig/react-library.json
@@ -8,6 +8,7 @@
     "declarationMap": true,
     "lib": ["ESNext", "DOM"],
     "module": "ESNext",
+    "moduleResolution": "Bundler",
     "jsx": "react-jsx"
   }
 }
diff --git a/packages/fdr-sdk/src/navigation/converters/ApiReferenceNavigationConverter.ts b/packages/fdr-sdk/src/navigation/converters/ApiReferenceNavigationConverter.ts
@@ -175,10 +175,11 @@ export class ApiReferenceNavigationConverter {
         let subpackageId = isSubpackage(package_) ? package_.subpackageId : "root";
         while (package_.pointsTo != null) {
             subpackageId = package_.pointsTo;
-            package_ = this.api.subpackages[package_.pointsTo];
-            if (package_ == null) {
+            const pointsToSubpackage = this.api.subpackages[package_.pointsTo];
+            if (pointsToSubpackage == null) {
                 return [];
             }
+            package_ = pointsToSubpackage;
         }
 
         if (this.#visitedSubpackages.has(subpackageId)) {
@@ -268,6 +269,11 @@ export class ApiReferenceNavigationConverter {
     ): FernNavigation.ApiPackageChild[] {
         const children: FernNavigation.ApiPackageChild[] = [];
         let subpackage = subpackageId === "root" ? this.api.rootPackage : this.api.subpackages[subpackageId];
+        if (subpackage == null) {
+            throw new Error(
+                `${subpackageId} is not present within known subpackages: ${Object.keys(this.api.subpackages).join(", ")}`,
+            );
+        }
         while (subpackage.pointsTo != null) {
             subpackage = this.api.subpackages[subpackage.pointsTo];
             if (subpackage == null) {

diff --git a/packages/fdr-sdk/src/navigation/utils/getNoIndexFromFrontmatter.ts b/packages/fdr-sdk/src/navigation/utils/getNoIndexFromFrontmatter.ts
@@ -6,7 +6,7 @@
  */
 export function getNoIndexFromFrontmatter(markdown: string): boolean | undefined {
     const frontmatterMatch = /^---\s*([\s\S]*?)\s*---/.exec(markdown.trimStart());
-    if (!frontmatterMatch) {
+    if (!frontmatterMatch || frontmatterMatch[1] == null) {
         return undefined;
     }
 

diff --git a/packages/fdr-sdk/src/navigation/utils/traverseNavigation.ts b/packages/fdr-sdk/src/navigation/utils/traverseNavigation.ts
@@ -12,7 +12,11 @@ export function traverseNavigation(
 ): void {
     function internalChildrenTraverser(nodes: NavigationNode[], parents: NavigationNode[]): boolean | void {
         for (let i = 0; i < nodes.length; i++) {
-            const result = internalTraverser(nodes[i], i, parents);
+            const node = nodes[i];
+            if (node == null) {
+                throw new Error(`Failed to index into nodes. Index: ${i} Length: ${nodes.length}`);
+            }
+            const result = internalTraverser(node, i, parents);
             if (result === STOP) {
                 return STOP;
             }

diff --git a/packages/fdr-sdk/src/utils/lodash/mapValues.ts b/packages/fdr-sdk/src/utils/lodash/mapValues.ts
@@ -28,7 +28,11 @@ function mapValue<VALUE, VALUE2, ITERATEE extends (input: VALUE, key: string, va
     const result: Record<string, VALUE2> = {};
 
     Object.keys(object).forEach((key) => {
-        result[key] = iteratee(object[key], key, object);
+        const val = object[key];
+        if (val == null) {
+            return; // Should this be a hard failure?
+        }
+        result[key] = iteratee(val, key, object);
     });
     return result;
 }

diff --git a/packages/ui/app/src/api-page/endpoints/EndpointContentCodeSnippets.tsx b/packages/ui/app/src/api-page/endpoints/EndpointContentCodeSnippets.tsx
@@ -72,7 +72,9 @@ const UnmemoizedEndpointContentCodeSnippets: React.FC<EndpointContentCodeSnippet
     const ref = useRef<HTMLDivElement>(null);
 
     useResizeObserver(ref, ([entry]) => {
-        measureHeight(entry.contentRect.height);
+        if (entry != null) {
+            measureHeight(entry.contentRect.height);
+        }
     });
 
     const [internalSelectedErrorExample, setSelectedErrorExample] = useState<ResolvedExampleError | undefined>(

diff --git a/packages/ui/app/src/api-page/endpoints/ErrorExampleSelect.tsx b/packages/ui/app/src/api-page/endpoints/ErrorExampleSelect.tsx
@@ -27,7 +27,7 @@ export const ErrorExampleSelect: FC<PropsWithChildren<ErrorExampleSelect.Props>>
     children,
 }) => {
     const handleValueChange = (value: string) => {
-        const [errorIndex, exampleIndex] = value.split(":").map((v) => parseInt(v, 10));
+        const [errorIndex = 0, exampleIndex = 0] = value.split(":").map((v) => parseInt(v, 10));
         setSelectedErrorAndExample(errors[errorIndex], errors[errorIndex]?.examples[exampleIndex]);
     };
     const selectedErrorIndex = selectedError != null ? errors.indexOf(selectedError) : -1;

diff --git a/packages/ui/app/src/api-page/examples/CodeSnippetExample.tsx b/packages/ui/app/src/api-page/examples/CodeSnippetExample.tsx
@@ -40,7 +40,9 @@ const CodeSnippetExampleInternal: FC<CodeSnippetExample.Props> = ({
     const viewportRef = createRef<ScrollToHandle>();
 
     useResizeObserver(codeBlockRef, ([entry]) => {
-        measureHeight?.(entry.contentRect.height);
+        if (entry != null) {
+            measureHeight?.(entry.contentRect.height);
+        }
     });
 
     const requestHighlightLines = useMemo(() => {

diff --git a/packages/ui/app/src/api-page/types/type-shorthand/TypeShorthand.tsx b/packages/ui/app/src/api-page/types/type-shorthand/TypeShorthand.tsx
@@ -1,9 +1,9 @@
 import { APIV1Read } from "@fern-api/fdr-sdk";
 import { visitDiscriminatedUnion } from "@fern-ui/core-utils";
 import clsx from "clsx";
-import numeral from "numeral";
 import { ReactNode } from "react";
 import {
+    DereferencedTypeShape,
     ResolvedTypeDefinition,
     ResolvedTypeShape,
     unwrapAlias,
@@ -25,10 +25,7 @@ export function renderTypeShorthandRoot(
 ): ReactNode {
     const typeShorthand = renderTypeShorthand(unwrapOptional(shape, types), { nullable: isResponse }, types);
     const unaliasedShape = unwrapAlias(shape, types);
-    const defaultsTo =
-        unaliasedShape.type === "optional" && unaliasedShape.shape.type === "primitive"
-            ? renderDefaultTo(unaliasedShape.shape.value)
-            : null;
+    const defaultsTo = renderDefaultsTo(unaliasedShape);
     return (
         <span className={clsx("fern-api-property-meta", className)}>
             <span>{typeShorthand}</span>
@@ -37,30 +34,46 @@ export function renderTypeShorthandRoot(
             ) : !isResponse ? (
                 <span className="t-danger">Required</span>
             ) : null}
-            {defaultsTo != null && <span>{`Defaults to ${defaultsTo}`}</span>}
+            {defaultsTo != null && (
+                <span>
+                    {"Defaults to "}
+                    <code>{defaultsTo}</code>
+                </span>
+            )}
         </span>
     );
 }
 
-function renderDefaultTo(shape: APIV1Read.PrimitiveType): string | undefined {
+function renderDefaultsTo(shape: DereferencedTypeShape): string | undefined {
+    if (shape.type !== "optional") {
+        return undefined;
+    }
+
+    if (shape.shape.type === "primitive") {
+        return renderDefaultToPrimitive(shape.shape.value);
+    }
+
+    if (shape.shape.type === "enum") {
+        return shape.shape.default;
+    }
+
+    return undefined;
+}
+
+function renderDefaultToPrimitive(shape: APIV1Read.PrimitiveType): string | undefined {
     return visitDiscriminatedUnion(shape, "type")._visit<string | undefined>({
-        string: (string) => string.default,
-        integer: (integer) => {
-            if (integer.default == null) {
-                return undefined;
-            }
-            return numeral(integer.default).format("0,0");
-        },
-        double: (double) => double.default?.toString(),
+        string: (value) => value.default,
+        integer: (value) => value.default?.toString(),
+        double: (value) => value.default?.toString(),
         uint: () => undefined,
         uint64: () => undefined,
-        boolean: () => undefined,
-        long: () => undefined,
-        datetime: () => undefined,
-        uuid: () => undefined,
-        base64: () => undefined,
-        date: () => undefined,
-        bigInteger: () => undefined,
+        boolean: (value) => value.default?.toString(),
+        long: (value) => value.default?.toString(),
+        datetime: (datetime) => datetime.default,
+        uuid: (uuid) => uuid.default,
+        base64: (base64) => base64.default,
+        date: (value) => value.default,
+        bigInteger: (value) => value.default,
         _other: () => undefined,
     });
 }

diff --git a/packages/ui/app/src/api-playground/PlaygroundAuthorizationForm.tsx b/packages/ui/app/src/api-playground/PlaygroundAuthorizationForm.tsx
@@ -157,7 +157,9 @@ function HeaderAuthForm({ header, disabled }: { header: APIV1Read.HeaderAuth; di
                             headers: {
                                 ...headers,
                                 [header.headerWireValue]:
-                                    typeof change === "function" ? change(headers[header.headerWireValue]) : change,
+                                    typeof change === "function"
+                                        ? change(headers[header.headerWireValue] ?? "")
+                                        : change,
                             },
                         }));
                     },
@@ -405,7 +407,7 @@ function isAuthed(auth: APIV1Read.ApiAuth, authState: PlaygroundAuthState): bool
         bearerAuth: () => !isEmpty(authState.bearerAuth?.token.trim()),
         basicAuth: () =>
             !isEmpty(authState.basicAuth?.username.trim()) && !isEmpty(authState.basicAuth?.password.trim()),
-        header: (header) => !isEmpty(authState.header?.headers[header.headerWireValue].trim()),
+        header: (header) => !isEmpty(authState.header?.headers[header.headerWireValue]?.trim()),
         _other: () => false,
     });
 }
diff --git a/packages/ui/app/src/api-playground/PlaygroundEndpointDescription.tsx b/packages/ui/app/src/api-playground/PlaygroundEndpointDescription.tsx
@@ -18,7 +18,7 @@ export function PlaygroundEndpointDescription({ endpoint }: PlaygroundEndpointDe
     const [descriptionIsClamped, setDescriptionIsClamped] = useState(false);
 
     useResizeObserver(descriptionRef, ([entry]) => {
-        if (!showFullDescription) {
+        if (!showFullDescription && entry != null) {
             setDescriptionIsClamped(entry.target.scrollHeight > entry.target.clientHeight);
         }
     });