ENG-815 DbDotenv.d.ts

apps/roam/scripts/compile.ts

@@ -18,18 +18,7 @@ const getVersion = (): string => {
 const getBuildDate = (): string => {
   return new Date().toISOString().split("T")[0]; // YYYY-MM-DD format
 };
-let envContents = null;
-
-try {
-  const dbDotEnv = require("@repo/database/dbDotEnv");
-  envContents = dbDotEnv.envContents;
-} catch (error) {
-  if ((error as Error).message.includes("Cannot find module")) {
-    console.error("Build the database module before compiling roam");
-    process.exit(1);
-  }
-  throw error;
-}
+const { envContents } = require("@repo/database/dbDotEnv");
 
 // https://github.com/evanw/esbuild/issues/337#issuecomment-954633403
 const importAsGlobals = (

apps/roam/scripts/deploy.ts

@@ -2,7 +2,7 @@ import { put } from "@vercel/blob";
 import fs, { readFileSync } from "fs";
 import { join } from "path";
 import { compile } from "./compile";
-import { config } from "@repo/database/dbDotEnv";
+const { config } = require("@repo/database/dbDotEnv");
 import { execSync } from "child_process";
 
 if (process.env.NODE_ENV !== "production") {

apps/website/app/utils/supabase/middleware.ts

@@ -1,6 +1,6 @@
 import { createServerClient } from "@supabase/ssr";
 import { NextResponse, type NextRequest } from "next/server";
-import { envContents } from "@repo/database/dbDotEnv";
+const { envContents } = require("@repo/database/dbDotEnv");
 
 // Inspired by https://supabase.com/ui/docs/nextjs/password-based-auth
 

apps/website/app/utils/supabase/server.ts

@@ -1,7 +1,7 @@
 import { createServerClient, type CookieOptions } from "@supabase/ssr";
 import { cookies } from "next/headers";
 import type { Database } from "@repo/database/dbTypes";
-import { envContents } from "@repo/database/dbDotEnv";
+const { envContents } = require("@repo/database/dbDotEnv");
 
 // Inspired by https://supabase.com/ui/docs/nextjs/password-based-auth
 

apps/website/next.config.ts

@@ -1,5 +1,5 @@
 import type { NextConfig } from "next";
-import { config } from "@repo/database/dbDotEnv";
+const { config } = require("@repo/database/dbDotEnv");
 
 config();
 

packages/database/doc/tasks.dot

@@ -20,6 +20,7 @@ deploy
 deploy_functions
 migrate
 gentypes
+bootstrap
 
 /* supabase functions */
 node [color=purple]
@@ -58,6 +59,7 @@ cucumber_js
     s_migrate -> migrations_up
     dev -> setup
     dev -> serve
+    setup -> bootstrap
     setup -> genenv
     setup -> migrate
     serve -> s_serve
@@ -83,4 +85,5 @@ cucumber_js
     build -> tsc
     s_genTypes -> generate_schema
     s_migrate -> sup_start
+    bootstrap -> tsc
 }

packages/database/package.json

@@ -6,28 +6,30 @@
   "exports": {
     "./lib/*": "./src/lib/*.ts",
     "./dbDotEnv": {
-      "types": "./types/dbDotEnv.d.ts",
-      "import": "./src/dbDotEnv.mjs",
-      "default": "./src/dbDotEnv.mjs"
+      "types": "./dist/src/dbDotEnv.d.mts",
+      "import": "./dist/src/dbDotEnv.mjs",
+      "require": "./dist/src/dbDotEnv.mjs",
+      "default": "./dist/src/dbDotEnv.mjs"
     },
     "./dbTypes": "./src/dbTypes.ts",
     "./inputTypes": "./src/inputTypes.ts"
   },
   "typesVersions": {
     "*": {
       "./dbDotEnv": [
-        "types/dbDotEnv.d.ts"
+        "dist/src/dbDotEnv.d.mts"
       ]
     }
   },
   "scripts": {
     "init": "supabase login",
-    "setup": "pnpm run genenv && pnpm run migrate",
+    "setup": "pnpm run bootstrap && pnpm run genenv && pnpm run migrate",
+    "bootstrap": "tsc -p tsconfig_bootstrap.json",
     "dev": "pnpm run setup && pnpm run serve",
     "build": "pnpm run setup && tsc",
     "serve": "tsx scripts/serve.ts",
     "stop": "supabase stop",
-    "check-types": "tsc --noEmit --skipLibCheck",
+    "check-types": "tsc -p tsconfig_lint.json",
     "check-schema": "tsx scripts/lintSchemas.ts && supabase stop && pnpm run dbdiff",
     "lint": "eslint . && tsx scripts/lintSchemas.ts && tsx scripts/lintFunctions.ts",
     "lint:fix": "eslint --fix . && tsx scripts/lintSchemas.ts -f && tsx scripts/lintFunctions.ts",

packages/database/scripts/genTypes.ts

@@ -1,7 +1,7 @@
 import { execSync } from "node:child_process";
 import { writeFileSync } from "fs";
 import { join, dirname } from "path";
-import { getVariant } from "@repo/database/dbDotEnv";
+import { getVariant } from "../src/dbDotEnv.mts";
 
 const __dirname = dirname(__filename);
 const projectRoot = join(__dirname, "..");

packages/database/scripts/serve.ts

@@ -1,7 +1,7 @@
 import { execSync } from "node:child_process";
 import { writeFileSync } from "fs";
 import { join, dirname } from "path";
-import { getVariant } from "@repo/database/dbDotEnv";
+import { getVariant } from "../src/dbDotEnv.mts";
 
 const __dirname = dirname(__filename);
 const projectRoot = join(__dirname, "..");

packages/database/src/dbDotEnv.mjs → packages/database/src/dbDotEnv.mts

@@ -3,9 +3,12 @@ import { join, dirname, basename } from "node:path";
 import { fileURLToPath } from "node:url";
 import dotenv from "dotenv";
 
-// Note: This file is written as mjs so it can be used before typescript compilation.
-// This means the corresponding .d.ts file is currently maintained by hand.
-// Remember to update it as needed.
+export type Variant =
+  | "none"
+  | "local"
+  | "branch"
+  | "production"
+  | "implicit";
 
 const findRoot = () => {
   let dir = fileURLToPath(import.meta.url);
@@ -15,24 +18,28 @@ const findRoot = () => {
   return dir;
 };
 
-export const getVariant = () => {
+const VARIANTS = new Set<Variant>([
+    "none",
+    "local",
+    "branch",
+    "production",
+    "implicit",
+  ]);
+
+export const getVariant = (): Variant => {
   const processHasVars =
     !!process.env["SUPABASE_URL"] && !!process.env["SUPABASE_ANON_KEY"];
   const useDbArgPos = (process.argv || []).indexOf("--use-db");
   let variant =
-    useDbArgPos > 0
+    (useDbArgPos > 0
       ? process.argv[useDbArgPos + 1]
-      : process.env["SUPABASE_USE_DB"];
+      : process.env["SUPABASE_USE_DB"]) as Variant | undefined;
   if (variant === undefined) {
     dotenv.config();
-    variant = process.env["SUPABASE_USE_DB"];
+    variant = process.env["SUPABASE_USE_DB"] as Variant | undefined;
   }
 
-  if (
-    ["local", "branch", "production", "none", "implicit", undefined].indexOf(
-      variant,
-    ) === -1
-  ) {
+  if (variant !== undefined && !VARIANTS.has(variant)) {
     throw new Error("Invalid variant: " + variant);
   }
 
@@ -61,14 +68,14 @@ export const getVariant = () => {
   return variant;
 };
 
-export const envFilePath = () => {
+export const envFilePath = (): string | null => {
   const variant = getVariant();
   if (variant === "implicit" || variant === "none") return null;
   const name = join(findRoot(), `.env.${variant}`);
   return existsSync(name) ? name : null;
 };
 
-export const envContents = () => {
+export const envContents = (): Partial<Record<string, string>> => {
   const path = envFilePath();
   if (!path) {
     // Fallback to process.env when running in production environments
@@ -85,7 +92,7 @@ export const envContents = () => {
 
 let configDone = false;
 
-export const config = () => {
+export const config = (): void => {
   if (configDone) return;
   const path = envFilePath();
   if (path) dotenv.config({ path });

packages/database/tsconfig.json

@@ -5,11 +5,6 @@
     "rootDir": ".",
     "outDir": "dist"
   },
-  "include": [
-    "./src/**/*",
-    "./scripts/**/*",
-    "./features/step-definitions/**/*",
-    "./features/support/**/*"
-  ],
+  "include": ["./src/**/*"],
   "exclude": ["supabase"]
 }

packages/database/tsconfig_bootstrap.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@repo/typescript-config/base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "outDir": "dist"
+  },
+  "include": ["./src/dbDotEnv.mts"]
+}

packages/database/tsconfig_lint.json

@@ -0,0 +1,20 @@
+{
+  "extends": "@repo/typescript-config/base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "outDir": "dist",
+    "allowImportingTsExtensions": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "declaration": true,
+    "noEmit": true
+  },
+  "include": [
+    "./src/**/*",
+    "./scripts/**/*",
+    "./features/step-definitions/**/*",
+    "./features/support/**/*"
+  ],
+  "exclude": ["supabase"]
+}

turbo.json

@@ -40,9 +40,15 @@
   ],
   "tasks": {
     "build": {
-      "dependsOn": ["@repo/database#genenv"],
+      "dependsOn": ["^build"],
       "inputs": ["$TURBO_DEFAULT$", ".env*"],
-      "outputs": [".next/**", "!.next/cache/**", "dist/**", "src/dbTypes.ts"]
+      "outputs": [
+        ".next/**",
+        "!.next/cache/**",
+        "dist/**",
+        "src/dbTypes.ts",
+        ".env*"
+      ]
     },
     "build-schema": {
       "inputs": ["$TURBO_DEFAULT$", ".env*"],
@@ -58,8 +64,10 @@
       "passThroughEnv": ["OBSIDIAN_PLUGIN_PATH"],
       "cache": false,
       "persistent": true,
-      "inputs": ["$TURBO_DEFAULT$", ".env*"]
+      "inputs": ["$TURBO_DEFAULT$", ".env*"],
+      "dependsOn": ["@repo/database#bootstrap"]
     },
+    "bootstrap": {},
     "roam#dev": {
       "with": ["@repo/database#dev"]
     },