Refactor project shape, add local config and validation

Author: eriicafes

core/entrypoint.ts

@@ -2,12 +2,46 @@ import { glob } from "glob"
 import { createJiti } from "jiti"
 import { Database } from "monarch-orm"
 import path from "node:path"
+import { localProjectSchema, projectSchema, type Project } from "./models"
 
 export type DirTree = { [k: string]: string | DirTree }
 
 export class Entrypoint {
   private import = createJiti(import.meta.url).import
 
+  public async getProject(
+    projects: Record<string, Project> | undefined,
+  ): Promise<Project | undefined> {
+    const configPath = path.resolve("monarch.config.json")
+    const config = await this.import(configPath).catch(() => undefined)
+    if (config) return localProjectSchema.safeParse(config).data
+    const project = projects?.[process.cwd()]
+    if (project) return projectSchema.safeParse(project).data
+  }
+
+  public async getDatabaseExport(relpath: string, identifier: string) {
+    try {
+      const exports = await this.import<any>(path.resolve(relpath))
+      const db = exports[identifier]
+      if (db instanceof Database) return db
+      return null
+    } catch (_error) {
+      return null
+    }
+  }
+
+  public async getFileExports(relpath: string) {
+    try {
+      const exports = await this.import<any>(path.resolve(relpath))
+      return Object.entries(exports).map(([name, value]) => ({
+        name,
+        isDb: value instanceof Database,
+      }))
+    } catch (_error) {
+      return []
+    }
+  }
+
   public async getFiles() {
     const paths = await glob("**/*.{ts,tsx,mts,cts,js,jsx,mjs,cjs}", {
       ignore: "{node_modules,tests,dist}/**",
@@ -37,27 +71,4 @@ export class Entrypoint {
 
     return { tree, suggestions }
   }
-
-  public async getExports(relpath: string) {
-    try {
-      const exports = await this.import<any>(path.resolve(relpath))
-      return Object.entries(exports).map(([name, value]) => ({
-        name,
-        isDb: value instanceof Database,
-      }))
-    } catch (_error) {
-      return []
-    }
-  }
-
-  public async getExport(relpath: string, identifier: string) {
-    try {
-      const exports = await this.import<any>(path.resolve(relpath))
-      const db = exports[identifier]
-      if (db instanceof Database) return db
-      return null
-    } catch (_error) {
-      return null
-    }
-  }
 }

core/models.ts

@@ -0,0 +1,26 @@
+import { z } from "zod"
+
+export interface Project extends z.infer<typeof projectSchema> {
+  local?: boolean
+}
+
+export const projectSchema = z.object({
+  file: z.string(),
+  export: z.string(),
+  dbname: z.string(),
+  dbs: z.record(z.string()),
+})
+
+export const localProjectSchema = z
+  .object({
+    file: z.string(),
+    export: z.string(),
+    dburl: z.string(),
+  })
+  .transform((data) => ({
+    file: data.file,
+    export: data.export,
+    dbname: "Local",
+    dbs: { Local: data.dburl },
+    local: true,
+  }))

core/types.ts

@@ -7,8 +7,8 @@
     "monarch": "./dist/index.js"
   },
   "scripts": {
-    "cli:build": "tsup cli/index.ts --format esm",
-    "cli:dev": "tsx --watch --clean cli/index.ts",
+    "cli:build": "tsup cli/index.ts --clean --format esm",
+    "cli:dev": "tsx cli/index.ts",
     "ui:build": "react-router build",
     "ui:dev": "react-router dev --port 6543",
     "ui:preview": "react-router-serve ./dist/ui/server/index.js",
@@ -97,6 +97,7 @@
     "prettier-plugin-tailwindcss": "^0.6.11",
     "tailwindcss": "^3.4.17",
     "tsup": "^8.4.0",
+    "tsx": "^4.19.3",
     "typescript": "^5.7.3",
     "typescript-eslint": "^8.26.0",
     "vite": "^6.2.0",

package.json

@@ -4,10 +4,8 @@ import { sessionStore } from "../store.server"
 import type { Route } from "./+types/_index"
 
 export async function loader({ request }: Route.LoaderArgs) {
-  const cwd = process.cwd()
   const session = await sessionStore.getSession(request.headers.get("Cookie"))
-  const projects = session.get("projects")
-  const project = projects ? projects[cwd] : undefined
+  const project = await context.entrypoint.getProject(session.get("projects"))
   if (!project) throw redirect("/setup")
 
   const dbs = await context.database.list()

pnpm-lock.yaml

@@ -25,20 +25,18 @@ import type { Route } from "./+types/setup._index"
 
 const completeSetup = createAction({
   schema: z.object({
+    file: z.string(),
+    export: z.string(),
     dbname: z.string(),
     dburl: z.string(),
-    entrypoint: z.string(),
-    export: z.string(),
   }),
   async handler(ctx, { request }) {
     const session = await sessionStore.getSession(request.headers.get("Cookie"))
-    const projects = session.get("projects")
     session.set("projects", {
-      ...projects,
       [process.cwd()]: {
-        entrypoint: ctx.input.entrypoint,
+        file: ctx.input.file,
         export: ctx.input.export,
-        dburl: ctx.input.dburl,
+        dbname: ctx.input.dbname,
         dbs: { [ctx.input.dbname]: ctx.input.dburl },
       },
     })
@@ -57,8 +55,7 @@ export async function action(args: Route.ActionArgs) {
 export async function loader({ request }: Route.LoaderArgs) {
   const cwd = process.cwd()
   const session = await sessionStore.getSession(request.headers.get("Cookie"))
-  const projects = session.get("projects")
-  const project = projects ? projects[cwd] : undefined
+  const project = await context.entrypoint.getProject(session.get("projects"))
   if (project) throw redirect("/")
 
   const files = await context.entrypoint.getFiles()
@@ -106,7 +103,7 @@ function ConnectSchema(props: { tree: DirTree; suggestions: string[] }) {
       setDraftProject({
         step: 2,
         project: {
-          entrypoint: value.file,
+          file: value.file,
           export: value.identifier,
         },
       })
@@ -119,7 +116,7 @@ function ConnectSchema(props: { tree: DirTree; suggestions: string[] }) {
   return (
     <form onSubmit={handleSubmit} className="grid gap-4">
       <p className="text-xs">
-        Select the file containing the monarch database export
+        Select file containing a monarch database export
       </p>
 
       <SchemaSelector
@@ -148,7 +145,7 @@ function ConnectDatabase() {
         step: 3,
         project: {
           ...draft.project,
-          dburl,
+          dbname,
           dbs: { [dbname]: dburl },
         },
       })
@@ -168,16 +165,20 @@ function ConnectDatabase() {
       <input type="hidden" name="_action" value="connectDatabase" />
       <div className="grid gap-1">
         <label className="text-xs font-medium">Database name</label>
-        <Input type="text" name="dbname" placeholder="Database name" />
+        <Input
+          type="text"
+          name="dbname"
+          placeholder="Enter database name"
+          defaultValue="Default"
+        />
       </div>
       <div className="grid gap-1">
-        <label className="text-xs font-medium">Connection string</label>
-        <Input type="url" name="dburl" placeholder="Database URL" />
+        <label className="text-xs font-medium">Database URL</label>
+        <Input type="url" name="dburl" placeholder="Enter database URL" />
       </div>
 
       <p className="text-xs text-muted-foreground">
-        You can add multiple database connections (dev and prod) and switch
-        between them.
+        You can add multiple database connections and switch between them.
       </p>
 
       <div className="mt-4 flex justify-between gap-4">
@@ -199,12 +200,11 @@ function CompleteSetup({
   const fetcher = useFetcher<typeof action>()
 
   const submitAction = async () => {
-    const dbname = Object.keys(draft.project.dbs)[0]!
     const data = {
-      dbname,
-      dburl: draft.project.dburl,
-      entrypoint: draft.project.entrypoint,
+      file: draft.project.file,
       export: draft.project.export,
+      dbname: draft.project.dbname,
+      dburl: draft.project.dbs[draft.project.dbname]!,
     } satisfies InferActionInput<typeof completeSetup>
     await fetcher.submit(
       {

ui/routes/_index.tsx

@@ -4,6 +4,6 @@ import type { Route } from "./+types/setup.exports"
 export async function loader({ request }: Route.LoaderArgs) {
   const path = new URL(request.url).searchParams.get("path")
   if (!path) return []
-  const exports = await context.entrypoint.getExports(path)
+  const exports = await context.entrypoint.getFileExports(path)
   return exports
 }

ui/routes/setup._index.tsx

@@ -1,6 +1,6 @@
 import { createCookieSessionStorage } from "react-router"
 import { createThemeSessionResolver } from "remix-themes"
-import type { Project } from "~/core/types"
+import type { Project } from "~/core/models"
 
 type Store = {
   projects: Record<string, Project>

ui/routes/setup.exports.tsx

@@ -1,4 +1,4 @@
-import type { Project } from "~/core/types"
+import type { Project } from "~/core/models"
 
 export type DraftProject =
   | {
@@ -7,11 +7,11 @@ export type DraftProject =
     }
   | {
       step: 2
-      project: Pick<Project, "entrypoint" | "export">
+      project: Pick<Project, "file" | "export">
     }
   | {
       step: 3
-      project: Project
+      project: Pick<Project, "file" | "export" | "dbname" | "dbs">
     }
 
 export const initialDraftProject: DraftProject = { step: 1, project: null }
@@ -37,7 +37,7 @@ export function getPreviousDraftProject(): DraftProject {
       return {
         step: 2,
         project: {
-          entrypoint: draft.project.entrypoint,
+          file: draft.project.file,
           export: draft.project.export,
         },
       }