Merge pull request #143 from midday-ai/feature/engine-v1

Engine v1

.github/workflows/preview-engine.yml

@@ -0,0 +1,31 @@
+name: Preview Deployment - Engine
+env:
+  CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+on:
+  push:
+    branches-ignore:
+      - main
+    paths:
+      - apps/engine/**
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+      - name: Install dependencies
+        run: bun install
+      # - name: 🔦 Run linter
+      #   run: bun run lint --filter=@midday/engine
+      # - name: 🪐 Check TypeScript
+      #   run: bun run typecheck --filter=@midday/engine
+      - name: Deploy Project Artifacts to Cloudflare
+        uses: cloudflare/wrangler-action@v3
+        with:
+          packageManager: bun
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          workingDirectory: "apps/engine"
+          wranglerVersion: "3.60.1"
+          command: deploy --minify src/index.ts --name=engine-staging

.github/workflows/production-engine.yml

@@ -0,0 +1,31 @@
+name: Preview Deployment - Engine
+env:
+  CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - apps/engine/**
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+      - name: Install dependencies
+        run: bun install
+      # - name: 🔦 Run linter
+      #   run: bun run lint --filter=@midday/engine
+      # - name: 🪐 Check TypeScript
+      #   run: bun run typecheck --filter=@midday/engine
+      - name: Deploy Project Artifacts to Cloudflare
+        uses: cloudflare/wrangler-action@v3
+        with:
+          packageManager: bun
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          workingDirectory: "apps/engine"
+          wranglerVersion: "3.60.1"
+          command: deploy --minify src/index.ts --name=engine

apps/dashboard/.env-example

@@ -53,4 +53,8 @@ MISTRAL_API_KEY=
 
 # OpenPanel
 NEXT_PUBLIC_OPENPANEL_CLIENT_ID=
-OPENPANEL_SECRET_KEY=
+OPENPANEL_SECRET_KEY=
+
+# Engine
+ENGINE_API_ENDPOINT=http://localhost:3002
+ENGINE_API_SECRET=secret

apps/dashboard/src/components/tables/transactions/columns.tsx

@@ -44,7 +44,11 @@ export type Transaction = {
   status: "posted" | "excluded" | "included" | "pending" | "completed";
   manual?: boolean;
   date: string;
-  category: string;
+  category?: {
+    slug: string;
+    name: string;
+    color: string;
+  };
   name: string;
   description?: string;
   currency: string;

apps/dashboard/src/env.mjs

@@ -32,6 +32,8 @@ export const env = createEnv({
     BASELIME_SERVICE: z.string(),
     BASELIME_API_KEY: z.string(),
     OPENPANEL_SECRET_KEY: z.string(),
+    ENGINE_API_ENDPOINT: z.string(),
+    ENGINE_API_SECRET: z.string(),
   },
   /**
    * Specify your client-side environment variables schema here.
@@ -85,6 +87,8 @@ export const env = createEnv({
     NEXT_PUBLIC_OPENPANEL_CLIENT_ID:
       process.env.NEXT_PUBLIC_OPENPANEL_CLIENT_ID,
     OPENPANEL_SECRET_KEY: process.env.OPENPANEL_SECRET_KEY,
+    ENGINE_API_ENDPOINT: process.env.ENGINE_API_ENDPOINT,
+    ENGINE_API_SECRET: process.env.ENGINE_API_SECRET,
   },
   skipValidation: !!process.env.CI || !!process.env.SKIP_ENV_VALIDATION,
 });

apps/dashboard/tsconfig.json

@@ -4,7 +4,8 @@
     "baseUrl": ".",
     "paths": {
       "@/*": ["./src/*"]
-    }
+    },
+    "strict": true
   },
   "include": ["next-env.d.ts", "next.config.js", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts", "tailwind.config.ts"],
   "exclude": ["node_modules"]

apps/docs/api-reference/engine/endpoint/auth-link-gocardless.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/gocardless/link
+---

apps/docs/api-reference/engine/endpoint/auth-link-plaid.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/plaid/link
+---

apps/docs/api-reference/engine/endpoint/exchange-token-1.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/plaid/exchange
+---

apps/docs/api-reference/engine/endpoint/exchange-token-gocardless.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/gocardless/exchange
+---

apps/docs/api-reference/engine/endpoint/exchange-token-plaid.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/plaid/exchange
+---

apps/docs/api-reference/engine/endpoint/exchange-token.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/gocardless/exchange
+---

apps/docs/api-reference/engine/endpoint/get-account-balance.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /accounts/balance
+---

apps/docs/api-reference/engine/endpoint/get-accounts.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /accounts
+---

apps/docs/api-reference/engine/endpoint/get-accountsbalance.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /accounts/balance
+---

apps/docs/api-reference/engine/endpoint/get-auth-link.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/gocardless/link
+---

apps/docs/api-reference/engine/endpoint/get-health.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /health
+---

apps/docs/api-reference/engine/endpoint/get-institutionssearch.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /institutions/search
+---

apps/docs/api-reference/engine/endpoint/get-link.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/plaid/link
+---

apps/docs/api-reference/engine/endpoint/get-transactions.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /transactions
+---

apps/docs/api-reference/engine/endpoint/gocardless-auth-link.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/gocardless/link
+---

apps/docs/api-reference/engine/endpoint/gocardless-exchange-token.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/gocardless/exchange
+---

apps/docs/api-reference/engine/endpoint/health.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /health
+---

apps/docs/api-reference/engine/endpoint/plaid-auth-link.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/plaid/link
+---

apps/docs/api-reference/engine/endpoint/plaid-exchange-token.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/plaid/exchange
+---

apps/docs/api-reference/engine/endpoint/post-authgocardlessexchange.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/gocardless/exchange
+---

apps/docs/api-reference/engine/endpoint/post-authgocardlesslink.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/gocardless/link
+---

apps/docs/api-reference/engine/endpoint/post-authplaidexchange.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/plaid/exchange
+---

apps/docs/api-reference/engine/endpoint/post-authplaidlink.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /auth/plaid/link
+---

apps/docs/api-reference/engine/endpoint/search-institutions.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /institutions/search
+---

apps/docs/api-reference/engine/introduction.mdx

@@ -0,0 +1,30 @@
+---
+title: "Introduction"
+"og:title": "Midday Engine API Reference - Introduction"
+description: "Fundamental concepts of Midday Engine API."
+icon: webhook
+---
+
+<Info>
+  Midday Engine is currently in beta. If you have any questions or feedback,
+  please reach out to us at
+  [support@midday.ai](mailto:support@midday.ai?subject=Engine%20API%20API)
+</Info>
+
+## Base URL
+
+Midday Engine API is built on REST principles and is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.
+
+The Base URL for all API endpoints is:
+
+```bash Terminal
+https://engine-api.midday.ai
+```
+
+## Authentication
+
+Authentication to Midday Engine API is performed via the Authorization header with a Bearer token. To authenticate, you need to include the Authorization header with the word `Bearer` followed by your token in your API requests like so:
+
+```bash Terminal
+Authorization: Bearer <Your-Token>
+```

apps/docs/examples.mdx

@@ -0,0 +1,6 @@
+---
+title: "Examples"
+"og:title": "Midday API Examples - Build with the Midday API"
+description: "Explore ideas and examples of what you can build with the Midday API"
+icon: github
+---

apps/docs/integrations.mdx

@@ -0,0 +1,6 @@
+---
+title: "Integrations"
+"og:title": "Midday Integrations: Connect Midday to services"
+description: "Integrate Midday with your services."
+icon: object-union
+---

apps/docs/introduction.mdx

@@ -2,4 +2,20 @@
 title: Introduction
 "og:title": "Getting Started with Midday.ai - Documentation"
 description: "Midday.ai | Run your business smarter."
+icon: rocket
 ---
+
+<Frame>
+  <img src="/images/header.png" alt="Midday header" width="1200" height="630" />
+</Frame>
+
+You can self-host Midday on your own cloud infrastructure for greater control over your data. This guide will walk you through the entire process of setting up Midday.
+
+## Prerequisites
+
+Before you begin, make sure you have the following:
+
+- A [GitHub](https://github.com/) account
+- An [Upstash](https://upstash.com/) account
+- A [Supabase](https://supabase.com/) account
+- A [Vercel](https://vercel.com/) account

apps/docs/local-development.mdx

@@ -2,4 +2,5 @@
 title: "Local Development"
 "og:title": "How to setup Midday.ai for Local Development"
 description: "A guide on how to run Midday.ai's codebase locally."
+icon: code
 ---

apps/docs/mint.json

@@ -30,18 +30,18 @@
       "name": "Dashboard",
       "url": "https://app.midday.ai"
     },
-    "openapi": "https://api.midday.ai",
+    "openapi": "https://engine.midday.ai/openapi",
     "tabs": [
       {
-        "name": "API Reference",
-        "url": "api-reference"
+        "name": "Engine API Reference",
+        "url": "api-reference/engine"
       }
     ],
     "anchors": [
       {
         "name": "Help Center",
         "icon": "question",
-        "url": "https://midday.ai/help"
+        "url": "https://midday.ai/support"
       },
       {
         "name": "GitHub",
@@ -52,11 +52,35 @@
     "navigation": [
       {
         "group": "Getting Started",
-        "pages": ["introduction", "local-development", "self-hosting"]
+        "pages": ["introduction"]
       },
       {
         "group": "Resources",
-        "pages": ["integrations", "sdks", "examples"]
+        "pages": ["integrations", "examples"]
+      },
+      {
+        "group": "Open source",
+        "pages": ["local-development", "self-hosting"]
+      },
+      {
+        "group": "Engine API Reference",
+        "pages": [
+          "api-reference/engine/introduction"
+        ]
+      },
+      {
+        "group": "Links",
+        "pages": [
+          "api-reference/engine/endpoint/get-transactions",
+          "api-reference/engine/endpoint/get-accounts",
+          "api-reference/engine/endpoint/get-account-balance",
+          "api-reference/engine/endpoint/search-institutions",
+          "api-reference/engine/endpoint/auth-link-gocardless",
+          "api-reference/engine/endpoint/exchange-token-gocardless",
+          "api-reference/engine/endpoint/auth-link-plaid",
+          "api-reference/engine/endpoint/exchange-token-plaid",
+          "api-reference/engine/endpoint/health"
+        ]
       }
     ],
     "api": {
@@ -68,6 +92,7 @@
     "footerSocials": {
       "twitter": "https://twitter.com/middayai",
       "github": "https://git.new/midday",
-      "website": "https://midday.ai"
+      "website": "https://midday.ai",
+      "linkedin": "https://www.linkedin.com/company/midday-ai"
     }
   }

apps/docs/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@midday/docs",
+  "scripts": {
+    "dev": "mintlify dev --port 3004",
+    "generate:engine": "bunx @mintlify/scraping@latest openapi-file http://localhost:3002/openapi -o api-reference/engine/endpoint"
+  },
+  "devDependencies": {
+    "mintlify": "^4.0.170"
+  }
+}

apps/docs/self-hosting.mdx

@@ -1,4 +1,6 @@
 ---
-title: "Self-hosting Midday.ai"
-"og:title": "How to self-host Midday.ai"
+title: "Self-hosting Midday"
+"og:title": "How to self-host Midday in 8 easy steps"
+description: "An end-to-end guide on how to self-host Midday"
+icon: server
 ---