@odvi/create-dtt-framework 0.1.7 → 0.1.9

package/template/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 DTT Framework
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/template/docs/framework/environment-variables.md

@@ -97,6 +97,19 @@ SNOWFLAKE_SCHEMA=PUBLIC
 # Snowflake role name
 SNOWFLAKE_ROLE=ANALYST
 
+# ============================================
+# AWS S3 (Optional)
+# ============================================
+
+# AWS Access Key ID
+AWS_ACCESS_KEY_ID=AKIA...
+
+# AWS Secret Access Key
+AWS_ACCESS_SECRET_KEY=wJalr...
+
+# AWS Region (e.g., us-east-1, ap-southeast-1)
+AWS_REGION=us-east-1
+
 # ============================================
 # NextBank (Placeholder - Optional)
 # ============================================
@@ -418,6 +431,45 @@ SNOWFLAKE_ROLE=ANALYST
 
 ---
 
+### AWS S3 Variables (Optional)
+
+#### AWS_ACCESS_KEY_ID
+
+**Purpose:** AWS Access Key ID for S3 access
+
+**Where to find:** AWS IAM Console → Users → Security credentials
+
+**Example:**
+```bash
+AWS_ACCESS_KEY_ID=AKIA...
+```
+
+#### AWS_ACCESS_SECRET_KEY
+
+**Purpose:** AWS Secret Access Key for S3 access
+
+**Where to find:** AWS IAM Console → Users → Security credentials (only visible when created)
+
+**Example:**
+```bash
+AWS_ACCESS_SECRET_KEY=wJalr...
+```
+
+**Notes:**
+- Never commit to version control
+- Ensure the user has appropriate S3 permissions (e.g., `AmazonS3ReadOnlyAccess` or custom policy)
+
+#### AWS_REGION
+
+**Purpose:** AWS Region where your S3 buckets are located
+
+**Example:**
+```bash
+AWS_REGION=us-east-1
+```
+
+---
+
 ### NextBank Variables (Placeholder)
 
 **Note:** NextBank is a placeholder integration. These variables are optional and not currently used.

package/template/drizzle/0000_awesome_argent.sql

@@ -0,0 +1,18 @@
+CREATE TABLE "users" (
+	"id" text PRIMARY KEY NOT NULL,
+	"email" varchar(255) NOT NULL,
+	"first_name" varchar(255),
+	"last_name" varchar(255),
+	"image_url" text,
+	"clerk_org_id" text,
+	"created_at" timestamp DEFAULT now() NOT NULL,
+	"updated_at" timestamp DEFAULT now() NOT NULL,
+	CONSTRAINT "users_email_unique" UNIQUE("email")
+);
+--> statement-breakpoint
+CREATE TABLE "health_check_tests" (
+	"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
+	"test_key" text NOT NULL,
+	"test_value" text,
+	"created_at" timestamp DEFAULT now() NOT NULL
+);

package/template/drizzle/meta/0000_snapshot.json

@@ -0,0 +1,129 @@
+{
+  "id": "8ef2966f-b7b3-4fd4-adfc-84bfe2fdbf38",
+  "prevId": "00000000-0000-0000-0000-000000000000",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.users": {
+      "name": "users",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "text",
+          "primaryKey": true,
+          "notNull": true
+        },
+        "email": {
+          "name": "email",
+          "type": "varchar(255)",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "first_name": {
+          "name": "first_name",
+          "type": "varchar(255)",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "last_name": {
+          "name": "last_name",
+          "type": "varchar(255)",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "image_url": {
+          "name": "image_url",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "clerk_org_id": {
+          "name": "clerk_org_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamp",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {
+        "users_email_unique": {
+          "name": "users_email_unique",
+          "nullsNotDistinct": false,
+          "columns": [
+            "email"
+          ]
+        }
+      },
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    },
+    "public.health_check_tests": {
+      "name": "health_check_tests",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "gen_random_uuid()"
+        },
+        "test_key": {
+          "name": "test_key",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "test_value": {
+          "name": "test_value",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/template/drizzle/meta/_journal.json

@@ -0,0 +1,13 @@
+{
+  "version": "7",
+  "dialect": "postgresql",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "7",
+      "when": 1767269294126,
+      "tag": "0000_awesome_argent",
+      "breakpoints": true
+    }
+  ]
+}

package/template/eslint.config.js

@@ -0,0 +1,61 @@
+import { FlatCompat } from "@eslint/eslintrc";
+import tseslint from "typescript-eslint";
+// @ts-ignore -- no types for this plugin
+import drizzle from "eslint-plugin-drizzle";
+
+const compat = new FlatCompat({
+  baseDirectory: import.meta.dirname,
+});
+
+export default tseslint.config(
+  {
+    ignores: [".next"],
+  },
+  ...compat.extends("next/core-web-vitals"),
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    plugins: {
+      drizzle,
+    },
+    extends: [
+      ...tseslint.configs.recommended,
+      ...tseslint.configs.recommendedTypeChecked,
+      ...tseslint.configs.stylisticTypeChecked,
+    ],
+    rules: {
+      "@typescript-eslint/array-type": "off",
+      "@typescript-eslint/consistent-type-definitions": "off",
+      "@typescript-eslint/consistent-type-imports": [
+        "warn",
+        { prefer: "type-imports", fixStyle: "inline-type-imports" },
+      ],
+      "@typescript-eslint/no-unused-vars": [
+        "warn",
+        { argsIgnorePattern: "^_" },
+      ],
+      "@typescript-eslint/require-await": "off",
+      "@typescript-eslint/no-misused-promises": [
+        "error",
+        { checksVoidReturn: { attributes: false } },
+      ],
+      "drizzle/enforce-delete-with-where": [
+        "error",
+        { drizzleObjectName: ["db", "ctx.db"] },
+      ],
+      "drizzle/enforce-update-with-where": [
+        "error",
+        { drizzleObjectName: ["db", "ctx.db"] },
+      ],
+    },
+  },
+  {
+    linterOptions: {
+      reportUnusedDisableDirectives: true,
+    },
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+      },
+    },
+  },
+);

package/template/src/config/env.ts

@@ -30,6 +30,11 @@ const envSchema = z.object({
   NEXTBANK_API: z.string().url().optional(),
   NEXTBANK_API_USERNAME: z.string().optional(),
   NEXTBANK_API_PASSWORD: z.string().optional(),
+
+  // AWS S3 (optional)
+  AWS_ACCESS_KEY_ID: z.string().optional(),
+  AWS_ACCESS_SECRET_KEY: z.string().optional(),
+  AWS_REGION: z.string().optional(),
 })
 
 export const env = envSchema.parse(process.env)

package/template/src/features/health-check/config.ts

@@ -52,6 +52,13 @@ export const SERVICES = [
       { name: 'Ping API', endpoint: '/nextbank/ping' },
     ],
   },
+  {
+    name: 'AWS S3',
+    icon: 'cloud',
+    checks: [
+      { name: 'Connect', endpoint: '/aws-s3/connect' },
+    ],
+  },
   {
     name: 'Framework',
     icon: 'code',

package/template/src/server/api/routes/health/aws-s3.ts

@@ -0,0 +1,59 @@
+import { Hono } from 'hono'
+import { S3Client, ListBucketsCommand } from '@aws-sdk/client-s3'
+import { env } from '@/config/env'
+
+export const awsS3HealthRoutes = new Hono()
+
+awsS3HealthRoutes.get('/connect', async (c) => {
+  const start = performance.now()
+
+  try {
+    // Check if credentials are configured
+    if (!env.AWS_ACCESS_KEY_ID || !env.AWS_ACCESS_SECRET_KEY || !env.AWS_REGION) {
+      return c.json({
+        status: 'warning',
+        responseTimeMs: Math.round(performance.now() - start),
+        message: 'AWS S3 credentials not configured - skipping connection check',
+        data: {
+          skipped: true,
+          reason: 'Missing AWS_ACCESS_KEY_ID, AWS_ACCESS_SECRET_KEY, or AWS_REGION',
+        },
+      })
+    }
+
+    const s3Client = new S3Client({
+      region: env.AWS_REGION,
+      credentials: {
+        accessKeyId: env.AWS_ACCESS_KEY_ID,
+        secretAccessKey: env.AWS_ACCESS_SECRET_KEY,
+      },
+    })
+
+    // Try to list buckets to verify connectivity and credentials
+    const command = new ListBucketsCommand({})
+    const response = await s3Client.send(command)
+
+    return c.json({
+      status: 'healthy',
+      responseTimeMs: Math.round(performance.now() - start),
+      message: 'Successfully connected to AWS S3',
+      data: {
+        region: env.AWS_REGION,
+        bucketCount: response.Buckets?.length ?? 0,
+      },
+    })
+  } catch (error) {
+    return c.json(
+      {
+        status: 'error',
+        responseTimeMs: Math.round(performance.now() - start),
+        error: error instanceof Error ? error.message : 'Failed to connect to AWS S3',
+        data: {
+          details: error instanceof Error ? error.stack : undefined,
+        },
+      },
+      500
+    )
+  }
+})
+

package/template/src/server/api/routes/health/index.ts

@@ -6,6 +6,7 @@ import { edgeFunctionsHealthRoutes } from './edge-functions'
 import { snowflakeHealthRoutes } from './snowflake'
 import { nextbankHealthRoutes } from './nextbank'
 import { frameworkHealthRoutes } from './framework'
+import { awsS3HealthRoutes } from './aws-s3'
 
 export const healthRoutes = new Hono()
 
@@ -16,6 +17,7 @@ healthRoutes.route('/edge', edgeFunctionsHealthRoutes)
 healthRoutes.route('/snowflake', snowflakeHealthRoutes)
 healthRoutes.route('/nextbank', nextbankHealthRoutes)
 healthRoutes.route('/framework', frameworkHealthRoutes)
+healthRoutes.route('/aws-s3', awsS3HealthRoutes)
 
 healthRoutes.get('/all', async (c) => {
   const start = performance.now()
@@ -38,6 +40,7 @@ healthRoutes.get('/all', async (c) => {
     { name: 'Snowflake Query', url: `${baseUrl}/api/health/snowflake/query` },
     { name: 'NextBank Ping', url: `${baseUrl}/api/health/nextbank/ping` },
     { name: 'NextBank Auth', url: `${baseUrl}/api/health/nextbank/auth` },
+    { name: 'AWS S3 Connect', url: `${baseUrl}/api/health/aws-s3/connect` },
   ]
 
   // Run all checks in parallel
@@ -46,7 +49,7 @@ healthRoutes.get('/all', async (c) => {
       const checkStart = performance.now()
       try {
         const response = await fetch(check.url, {
-          method: check.method || 'GET',
+          method: check.method ?? 'GET',
           headers: {
             'Content-Type': 'application/json',
             // Forward auth header if present
@@ -60,7 +63,7 @@ healthRoutes.get('/all', async (c) => {
 
         return {
           name: check.name,
-          status: response.ok ? data.status || 'healthy' : 'error',
+          status: response.ok ? data.status ?? 'healthy' : 'error',
           responseTimeMs: Math.round(performance.now() - checkStart),
           httpStatus: response.status,
           data,
@@ -85,12 +88,13 @@ healthRoutes.get('/all', async (c) => {
     edge: results.filter((r) => r.status === 'fulfilled' && r.value.name.includes('Edge')),
     snowflake: results.filter((r) => r.status === 'fulfilled' && r.value.name.includes('Snowflake')),
     nextbank: results.filter((r) => r.status === 'fulfilled' && r.value.name.includes('NextBank')),
+    awsS3: results.filter((r) => r.status === 'fulfilled' && r.value.name.includes('AWS S3')),
   }
 
   // Determine overall status
   const allResults = results.map((r) => (r.status === 'fulfilled' ? r.value : null))
   const hasErrors = allResults.some((r) => r && (r.status === 'error' || r.httpStatus >= 400))
-  const allHealthy = allResults.every((r) => r && r.status === 'healthy')
+  const allHealthy = allResults.every((r) => r?.status === 'healthy')
 
   return c.json({
     status: hasErrors ? 'unhealthy' : allHealthy ? 'healthy' : 'partial',

package/template/start-database.sh

@@ -0,0 +1,88 @@
+#!/usr/bin/env bash
+# Use this script to start a docker container for a local development database
+
+# TO RUN ON WINDOWS:
+# 1. Install WSL (Windows Subsystem for Linux) - https://learn.microsoft.com/en-us/windows/wsl/install
+# 2. Install Docker Desktop or Podman Deskop
+# - Docker Desktop for Windows - https://docs.docker.com/docker-for-windows/install/
+# - Podman Desktop - https://podman.io/getting-started/installation
+# 3. Open WSL - `wsl`
+# 4. Run this script - `./start-database.sh`
+
+# On Linux and macOS you can run this script directly - `./start-database.sh`
+
+# import env variables from .env
+set -a
+source .env
+
+DB_PASSWORD=$(echo "$DATABASE_URL" | awk -F':' '{print $3}' | awk -F'@' '{print $1}')
+DB_PORT=$(echo "$DATABASE_URL" | awk -F':' '{print $4}' | awk -F'\/' '{print $1}')
+DB_NAME=$(echo "$DATABASE_URL" | awk -F'/' '{print $4}')
+DB_CONTAINER_NAME="$DB_NAME-postgres"
+
+if ! [ -x "$(command -v docker)" ] && ! [ -x "$(command -v podman)" ]; then
+  echo -e "Docker or Podman is not installed. Please install docker or podman and try again.\nDocker install guide: https://docs.docker.com/engine/install/\nPodman install guide: https://podman.io/getting-started/installation"
+  exit 1
+fi
+
+# determine which docker command to use
+if [ -x "$(command -v docker)" ]; then
+  DOCKER_CMD="docker"
+elif [ -x "$(command -v podman)" ]; then
+  DOCKER_CMD="podman"
+fi
+
+if ! $DOCKER_CMD info > /dev/null 2>&1; then
+  echo "$DOCKER_CMD daemon is not running. Please start $DOCKER_CMD and try again."
+  exit 1
+fi
+
+if command -v nc >/dev/null 2>&1; then
+  if nc -z localhost "$DB_PORT" 2>/dev/null; then
+    echo "Port $DB_PORT is already in use."
+    exit 1
+  fi
+else
+  echo "Warning: Unable to check if port $DB_PORT is already in use (netcat not installed)"
+  read -p "Do you want to continue anyway? [y/N]: " -r REPLY
+  if ! [[ $REPLY =~ ^[Yy]$ ]]; then
+    echo "Aborting."
+    exit 1
+  fi
+fi
+
+if [ "$($DOCKER_CMD ps -q -f name=$DB_CONTAINER_NAME)" ]; then
+  echo "Database container '$DB_CONTAINER_NAME' already running"
+  exit 0
+fi
+
+if [ "$($DOCKER_CMD ps -q -a -f name=$DB_CONTAINER_NAME)" ]; then
+  $DOCKER_CMD start "$DB_CONTAINER_NAME"
+  echo "Existing database container '$DB_CONTAINER_NAME' started"
+  exit 0
+fi
+
+if [ "$DB_PASSWORD" = "password" ]; then
+  echo "You are using the default database password"
+  read -p "Should we generate a random password for you? [y/N]: " -r REPLY
+  if ! [[ $REPLY =~ ^[Yy]$ ]]; then
+    echo "Please change the default password in the .env file and try again"
+    exit 1
+  fi
+  # Generate a random URL-safe password
+  DB_PASSWORD=$(openssl rand -base64 12 | tr '+/' '-_')
+  if [[ "$(uname)" == "Darwin" ]]; then
+    # macOS requires an empty string to be passed with the `i` flag
+    sed -i '' "s#:password@#:$DB_PASSWORD@#" .env
+  else
+    sed -i "s#:password@#:$DB_PASSWORD@#" .env
+  fi
+fi
+
+$DOCKER_CMD run -d \
+  --name $DB_CONTAINER_NAME \
+  -e POSTGRES_USER="postgres" \
+  -e POSTGRES_PASSWORD="$DB_PASSWORD" \
+  -e POSTGRES_DB="$DB_NAME" \
+  -p "$DB_PORT":5432 \
+  docker.io/postgres && echo "Database container '$DB_CONTAINER_NAME' was successfully created"