Merge remote-tracking branch 'origin/main' into ajiang/cohere-stream

.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 }} || "main"
 
       - 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 }} || "main"
 
       - name: 📥 Install
         uses: ./.github/actions/install

.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

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);
         }
     }
 

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,
     });

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;
 }

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 {

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/**/*"]
 }

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,

packages/configs/tsconfig/library.json

@@ -5,6 +5,8 @@
   "compilerOptions": {
     "declaration": true,
     "declarationMap": true,
-    "composite": true
+    "composite": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler"
   }
 }

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": false
   }
 }

packages/configs/tsconfig/react-library.json

@@ -8,6 +8,7 @@
     "declarationMap": true,
     "lib": ["ESNext", "DOM"],
     "module": "ESNext",
+    "moduleResolution": "Bundler",
     "jsx": "react-jsx"
   }
 }

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) {

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;
     }
 

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;
             }

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;
 }

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>(

packages/ui/app/src/mdx/components/html/index.tsx

@@ -91,7 +91,7 @@ function isImgElement(element: ReactElement): element is ReactElement<ImgProps>
     return element.type === Image;
 }
 
-export const Image: FC<ImgProps> = ({ className, src, width: w, height: h, noZoom, enableZoom, style, ...rest }) => {
+export const Image: FC<ImgProps> = ({ src, width: w, height: h, noZoom, enableZoom, style, ...rest }) => {
     const files = useAtomValue(FILES_ATOM);
     const { "no-image-zoom": noImageZoom } = useFrontmatter();
 

packages/ui/app/tsconfig.json

@@ -4,7 +4,8 @@
     "composite": true,
     "noEmit": false,
     "outDir": "./dist",
-    "rootDir": "."
+    "rootDir": ".",
+    "noUncheckedIndexedAccess": false
   },
   "include": ["./src/**/*"],
   "references": [

packages/ui/docs-bundle/src/pages/api/fern-docs/changelog.ts

@@ -101,7 +101,7 @@ function toFeedItem(
         date: new Date(entry.date),
     };
 
-    const markdown = pages[entry.pageId].markdown;
+    const markdown = pages[entry.pageId]?.markdown;
     if (markdown != null) {
         const { data: frontmatter, content } = getFrontmatter(markdown);
         item.description = frontmatter.description ?? frontmatter.subtitle ?? frontmatter.excerpt;

packages/ui/docs-bundle/src/utils/getDocsPageProps.ts

@@ -111,7 +111,7 @@ export async function getDynamicDocsPageProps(
     xFernHost: string,
     slug: string[],
     cookies: NextApiRequestCookies,
-    res: ServerResponse<IncomingMessage>,
+    _res: ServerResponse<IncomingMessage>,
 ): Promise<GetServerSideDocsPagePropsResult> {
     const url = buildUrl({ host: xFernHost, pathname: slug.join("/") });
     if (cookies.fern_token == null) {
@@ -122,6 +122,7 @@ export async function getDynamicDocsPageProps(
         const config = await getAuthEdgeConfig(xFernHost);
         let user: FernUser | undefined = undefined;
 
+        // using custom auth (e.g. qlty, propexo, etc)
         if (config?.type === "basic_token_verification") {
             try {
                 user = await verifyFernJWT(cookies.fern_token, config.secret, config.issuer);
@@ -141,6 +142,7 @@ export async function getDynamicDocsPageProps(
             user = await verifyFernJWT(cookies.fern_token);
         }
 
+        // SSO
         if (user.partner === "workos") {
             const registryService = getRegistryServiceWithToken(`workos_${cookies.fern_token}`);
 
@@ -153,8 +155,6 @@ export async function getDynamicDocsPageProps(
             console.log(`[getDynamicDocsPageProps] Fetch completed in ${end - start}ms for ${url}`);
 
             if (!docs.ok) {
-                res.setHeader("Set-Cookie", "fern_token=; Path=/; HttpOnly; SameSite=Lax; Max-Age=0");
-
                 if (docs.error.error === "UnauthorizedError") {
                     return {
                         redirect: await getUnauthenticatedRedirect(xFernHost, `/${slug.join("/")}`),
@@ -168,6 +168,7 @@ export async function getDynamicDocsPageProps(
 
             return convertDocsToDocsPageProps({ docs: docs.body, slug, url, xFernHost });
         } else if (user.partner === "ory" || user.partner === "custom") {
+            // rightbrain's api key injection
             const docs = await REGISTRY_SERVICE.docs.v2.read.getDocsForUrl({ url });
 
             if (!docs.ok) {
@@ -194,14 +195,8 @@ export async function getDynamicDocsPageProps(
         console.log(error);
     }
 
-    // Clear the token if it's invalid, then redirect to `/` to reset the login flow
-    res.setHeader("Set-Cookie", "fern_token=; Path=/; HttpOnly; SameSite=Lax; Max-Age=0");
-    return {
-        redirect: {
-            destination: `/${slug.join("/")}`,
-            permanent: false,
-        },
-    };
+    // fallback to public docs
+    return convertStaticToServerSidePropsResult(await getDocsPageProps(xFernHost, slug));
 }
 
 async function convertDocsToDocsPageProps({

packages/ui/docs-bundle/src/utils/xFernHost.ts

@@ -79,7 +79,7 @@ export function cleanHost(host: string | null | undefined): string | undefined {
     }
 
     // strip trailing slash from the host, if present
-    if (host.endsWith("/")) {
+    if (host?.endsWith("/")) {
         host = host.slice(0, -1);
     }
 

packages/ui/docs-bundle/tsconfig.json

@@ -2,7 +2,8 @@
   "extends": "@fern-platform/configs/tsconfig/nextjs.json",
   "compilerOptions": {
     "outDir": "./dist",
-    "rootDir": "."
+    "rootDir": ".",
+    "noUncheckedIndexedAccess": false
   },
   "exclude": ["node_modules"],
   "include": ["./src/**/*", ".next/types/**/*.ts", "__mocks__"],

packages/ui/local-preview-bundle/tsconfig.json

@@ -2,7 +2,8 @@
   "extends": "@fern-platform/configs/tsconfig/nextjs.json",
   "compilerOptions": {
     "outDir": "./dist",
-    "rootDir": "."
+    "rootDir": ".",
+    "noUncheckedIndexedAccess": false
   },
   "exclude": ["node_modules"],
   "include": ["./src/**/*", ".next/types/**/*.ts"],