@gravito/scaffold 1.0.0-beta.1 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravito/scaffold",
-  "version": "1.0.0-beta.1",
+  "version": "1.1.0",
   "description": "Project scaffolding engine for Gravito - Generate enterprise-grade architecture templates",
   "type": "module",
   "main": "dist/index.js",
@@ -17,7 +17,9 @@
     "build": "bun run build.ts",
     "dev": "bun run --watch src/index.ts",
     "test": "bun test",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "bun tsc -p tsconfig.json --noEmit --skipLibCheck",
+    "test:coverage": "bun test --coverage --coverage-threshold=80",
+    "test:ci": "bun test --coverage --coverage-threshold=80"
   },
   "files": [
     "dist",
@@ -32,10 +34,11 @@
   },
   "devDependencies": {
     "tsup": "^8.5.1",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "bun-types": "latest"
   },
   "peerDependencies": {
-    "gravito-core": "1.0.0-beta.6"
+    "@gravito/core": "workspace:*"
   },
   "author": "Carl Lee <carllee0520@gmail.com>",
   "license": "MIT",
@@ -45,4 +48,4 @@
     "url": "git+https://github.com/gravito-framework/gravito.git",
     "directory": "packages/scaffold"
   }
-}
+}

package/templates/features/otel/.env.example

@@ -0,0 +1,2 @@
+OTEL_ENABLED=true
+OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318/v1/traces

package/templates/features/otel/config/telemetry.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from '@gravito/core/telemetry'
+
+export default defineConfig({
+  enabled: process.env.OTEL_ENABLED !== 'false',
+  service_name: process.env.APP_NAME || 'gravito-app',
+  exporter: {
+    type: 'otlp', // or 'console'
+    endpoint: process.env.OTEL_EXPORTER_OTLP_ENDPOINT || 'http://localhost:4318/v1/traces',
+  },
+})

package/templates/features/otel/docker-compose.yml

@@ -0,0 +1,15 @@
+services:
+  gravito.jaeger:
+    image: jaegertracing/all-in-one:latest
+    ports:
+      - "16686:16686" # Web UI
+      - "4317:4317" # OTLP gRPC
+      - "4318:4318" # OTLP HTTP
+    environment:
+      - COLLECTOR_OTLP_ENABLED=true
+    networks:
+      - gravito
+
+networks:
+  gravito:
+    driver: bridge

package/templates/features/otel/package.json

@@ -0,0 +1,7 @@
+{
+    "dependencies": {
+        "@opentelemetry/sdk-node": "^0.45.0",
+        "@opentelemetry/exporter-trace-otlp-http": "^0.45.0",
+        "@gravito/telemetry": "workspace:*"
+    }
+}

package/templates/features/redis/.env.example

@@ -0,0 +1,7 @@
+CACHE_DRIVER=redis
+QUEUE_CONNECTION=redis
+SESSION_DRIVER=redis
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379

package/templates/features/redis/config/cache.ts

@@ -0,0 +1,14 @@
+import { defineConfig } from '@gravito/core/cache'
+
+export default defineConfig({
+  default: 'redis',
+  stores: {
+    redis: {
+      driver: 'redis',
+      connection: 'default',
+    },
+    memory: {
+      driver: 'memory',
+    },
+  },
+})

package/templates/features/redis/config/queue.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from '@gravito/core/queue'
+
+export default defineConfig({
+  default: 'redis',
+  connections: {
+    redis: {
+      driver: 'redis',
+      connection: 'default',
+      queue: 'default',
+      retry_after: 90,
+    },
+  },
+})

package/templates/features/redis/docker-compose.yml

@@ -0,0 +1,17 @@
+services:
+  gravito.redis:
+    image: redis:alpine
+    ports:
+      - '${REDIS_PORT:-6379}:6379'
+    volumes:
+      - gravito-redis:/data
+    networks:
+      - gravito
+
+networks:
+  gravito:
+    driver: bridge
+
+volumes:
+  gravito-redis:
+    driver: local

package/templates/features/redis/package.json

@@ -0,0 +1,5 @@
+{
+    "dependencies": {
+        "ioredis": "^5.3.0"
+    }
+}

package/templates/overlays/core/.env.example

@@ -0,0 +1,14 @@
+APP_NAME=Gravito
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=http://localhost:3000
+
+LOG_LEVEL=debug
+
+DB_CONNECTION=sqlite
+DB_DATABASE=gravito.sqlite
+
+CACHE_DRIVER=memory
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file

package/templates/overlays/core/config/cache.ts

@@ -0,0 +1,26 @@
+/**
+ * Cache Configuration
+ *
+ * Defines cache stores and default cache driver.
+ * This configuration is used by @gravito/stasis cache orbit.
+ *
+ * Supported drivers: 'memory', 'file', 'null', 'redis'
+ */
+export default {
+  default: process.env.CACHE_DRIVER || 'memory',
+  stores: {
+    memory: {
+      driver: 'memory',
+      maxItems: 10_000,
+    },
+    file: {
+      driver: 'file',
+      path: process.env.CACHE_PATH || 'storage/framework/cache',
+    },
+    redis: {
+      driver: 'redis',
+      connection: process.env.REDIS_CACHE_CONNECTION || 'default',
+      prefix: process.env.REDIS_CACHE_PREFIX || 'cache:',
+    },
+  },
+} as const

package/templates/overlays/core/config/database.ts

@@ -0,0 +1,38 @@
+/**
+ * Database Configuration
+ *
+ * Defines database connections and default connection driver.
+ * This configuration is used by @gravito/atlas ORM.
+ *
+ * Supported drivers: 'postgres', 'mysql', 'mariadb', 'sqlite', 'mongodb', 'redis'
+ */
+export default {
+  default: process.env.DB_CONNECTION || 'sqlite',
+  connections: {
+    sqlite: {
+      driver: 'sqlite',
+      database: process.env.DB_DATABASE || 'database/database.sqlite',
+    },
+    postgres: {
+      driver: 'postgres',
+      host: process.env.DB_HOST || '127.0.0.1',
+      port: parseInt(process.env.DB_PORT || '5432', 10),
+      database: process.env.DB_DATABASE || 'gravito',
+      username: process.env.DB_USERNAME || 'postgres',
+      password: process.env.DB_PASSWORD || '',
+      charset: 'utf8',
+      search_path: 'public',
+      sslmode: process.env.DB_SSLMODE || 'prefer',
+    },
+    mysql: {
+      driver: 'mysql',
+      host: process.env.DB_HOST || '127.0.0.1',
+      port: parseInt(process.env.DB_PORT || '3306', 10),
+      database: process.env.DB_DATABASE || 'gravito',
+      username: process.env.DB_USERNAME || 'root',
+      password: process.env.DB_PASSWORD || '',
+      charset: 'utf8mb4',
+      collation: 'utf8mb4_unicode_ci',
+    },
+  },
+} as const

package/templates/overlays/core/config/queue.ts

@@ -0,0 +1,31 @@
+/**
+ * Queue Configuration
+ *
+ * Defines queue connections and default queue driver.
+ * This configuration is used by @gravito/stream queue system.
+ *
+ * Supported drivers: 'memory', 'database', 'redis', 'kafka', 'sqs', 'rabbitmq', 'nats'
+ */
+export default {
+  default: process.env.QUEUE_CONNECTION || 'sync',
+  connections: {
+    sync: {
+      driver: 'sync',
+    },
+    memory: {
+      driver: 'memory',
+    },
+    database: {
+      driver: 'database',
+      table: process.env.QUEUE_TABLE || 'jobs',
+    },
+    redis: {
+      driver: 'redis',
+      host: process.env.REDIS_HOST || '127.0.0.1',
+      port: parseInt(process.env.REDIS_PORT || '6379', 10),
+      password: process.env.REDIS_PASSWORD,
+      db: parseInt(process.env.REDIS_DB || '0', 10),
+      prefix: process.env.REDIS_PREFIX || 'queue:',
+    },
+  },
+} as const

package/templates/overlays/core/package.json

@@ -0,0 +1,5 @@
+{
+    "dependencies": {
+        "better-sqlite3": "^9.0.0"
+    }
+}

package/templates/overlays/enterprise/.env.example

@@ -0,0 +1,26 @@
+APP_NAME=Gravito
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=http://localhost:3000
+
+LOG_LEVEL=debug
+LOG_CHANNEL=stack
+
+DB_CONNECTION=pgsql
+DB_HOST=127.0.0.1
+DB_PORT=5432
+DB_DATABASE=gravito
+DB_USERNAME=gravito
+DB_PASSWORD=secret
+
+CACHE_DRIVER=redis
+QUEUE_CONNECTION=redis
+SESSION_DRIVER=redis
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+# Security
+CORS_ALLOWED_ORIGINS=http://localhost:3000

package/templates/overlays/enterprise/config/cache.ts

@@ -0,0 +1,31 @@
+/**
+ * Cache Configuration
+ *
+ * Defines cache stores and default cache driver.
+ * This configuration is used by @gravito/stasis cache orbit.
+ *
+ * Enterprise profile: Configured for production with Redis as default.
+ *
+ * Supported drivers: 'memory', 'file', 'null', 'redis'
+ */
+export default {
+  default: process.env.CACHE_DRIVER || 'redis',
+  stores: {
+    // Redis - Redis 快取（生產環境推薦）
+    redis: {
+      driver: 'redis',
+      connection: process.env.REDIS_CACHE_CONNECTION || 'default',
+      prefix: process.env.REDIS_CACHE_PREFIX || 'cache:',
+    },
+    // Memory - 記憶體快取（開發/測試環境）
+    memory: {
+      driver: 'memory',
+      maxItems: 10_000,
+    },
+    // File - 檔案快取
+    file: {
+      driver: 'file',
+      path: process.env.CACHE_PATH || 'storage/framework/cache',
+    },
+  },
+} as const

package/templates/overlays/enterprise/config/database.ts

@@ -0,0 +1,34 @@
+/**
+ * Database Configuration
+ *
+ * Defines database connections and default connection driver.
+ * This configuration is used by @gravito/atlas ORM.
+ *
+ * Enterprise profile: Configured for production with PostgreSQL as default.
+ */
+export default {
+  default: process.env.DB_CONNECTION || 'postgres',
+  connections: {
+    postgres: {
+      driver: 'postgres',
+      host: process.env.DB_HOST || '127.0.0.1',
+      port: parseInt(process.env.DB_PORT || '5432', 10),
+      database: process.env.DB_DATABASE || 'gravito',
+      username: process.env.DB_USERNAME || 'postgres',
+      password: process.env.DB_PASSWORD || '',
+      charset: 'utf8',
+      search_path: 'public',
+      sslmode: process.env.DB_SSLMODE || 'prefer',
+    },
+    mysql: {
+      driver: 'mysql',
+      host: process.env.DB_HOST || '127.0.0.1',
+      port: parseInt(process.env.DB_PORT || '3306', 10),
+      database: process.env.DB_DATABASE || 'gravito',
+      username: process.env.DB_USERNAME || 'root',
+      password: process.env.DB_PASSWORD || '',
+      charset: 'utf8mb4',
+      collation: 'utf8mb4_unicode_ci',
+    },
+  },
+} as const

package/templates/overlays/enterprise/config/logging.ts

@@ -0,0 +1,32 @@
+import { defineConfig } from '@gravito/core/logging'
+
+export default defineConfig({
+  default: process.env.LOG_CHANNEL || 'stack',
+  channels: {
+    stack: {
+      driver: 'stack',
+      channels: ['daily', 'stdout'],
+      ignore_exceptions: false,
+    },
+    single: {
+      driver: 'single',
+      path: 'storage/logs/gravito.log',
+      level: process.env.LOG_LEVEL || 'debug',
+    },
+    daily: {
+      driver: 'daily',
+      path: 'storage/logs/gravito.log',
+      level: process.env.LOG_LEVEL || 'debug',
+      days: 14,
+    },
+    stdout: {
+      driver: 'monolog',
+      handler: 'Monolog\\Handler\\StreamHandler',
+      with: {
+        stream: 'php://stdout',
+      },
+      level: process.env.LOG_LEVEL || 'debug',
+      formatter: 'json', // Enterprise defaults to structured JSON logging
+    },
+  },
+})

package/templates/overlays/enterprise/config/queue.ts

@@ -0,0 +1,31 @@
+/**
+ * Queue Configuration
+ *
+ * Defines queue connections and default queue driver.
+ * This configuration is used by @gravito/stream queue system.
+ *
+ * Enterprise profile: Configured for production with Redis as default.
+ */
+export default {
+  default: process.env.QUEUE_CONNECTION || 'redis',
+  connections: {
+    redis: {
+      driver: 'redis',
+      host: process.env.REDIS_HOST || '127.0.0.1',
+      port: parseInt(process.env.REDIS_PORT || '6379', 10),
+      password: process.env.REDIS_PASSWORD,
+      db: parseInt(process.env.REDIS_DB || '0', 10),
+      prefix: process.env.REDIS_PREFIX || 'queue:',
+    },
+    database: {
+      driver: 'database',
+      table: process.env.QUEUE_TABLE || 'jobs',
+    },
+    kafka: {
+      driver: 'kafka',
+      brokers: (process.env.KAFKA_BROKERS || 'localhost:9092').split(','),
+      consumerGroupId: process.env.KAFKA_CONSUMER_GROUP_ID || 'gravito-workers',
+      clientId: process.env.KAFKA_CLIENT_ID || 'gravito',
+    },
+  },
+} as const

package/templates/overlays/enterprise/config/security.ts

@@ -0,0 +1,20 @@
+import { defineConfig } from '@gravito/core/security'
+
+export default defineConfig({
+  headers: {
+    'X-Content-Type-Options': 'nosniff',
+    'X-Frame-Options': 'SAMEORIGIN',
+    'X-XSS-Protection': '1; mode=block',
+    'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+    'Content-Security-Policy':
+      "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:;",
+  },
+  cors: {
+    allowed_methods: ['*'],
+    allowed_origins: ['*'], // Configure this in production
+    allowed_headers: ['*'],
+    exposed_headers: [],
+    max_age: 0,
+    supports_credentials: false,
+  },
+})

package/templates/overlays/enterprise/docker-compose.yml

@@ -0,0 +1,32 @@
+services:
+  gravito.db:
+    image: postgres:15-alpine
+    environment:
+      POSTGRES_DB: ${DB_DATABASE:-gravito}
+      POSTGRES_USER: ${DB_USERNAME:-gravito}
+      POSTGRES_PASSWORD: ${DB_PASSWORD:-secret}
+    ports:
+      - '${DB_PORT:-5432}:5432'
+    volumes:
+      - gravito-db:/var/lib/postgresql/data
+    networks:
+      - gravito
+
+  gravito.redis:
+    image: redis:alpine
+    ports:
+      - '${REDIS_PORT:-6379}:6379'
+    volumes:
+      - gravito-redis:/data
+    networks:
+      - gravito
+
+networks:
+  gravito:
+    driver: bridge
+
+volumes:
+  gravito-db:
+    driver: local
+  gravito-redis:
+    driver: local

package/templates/overlays/enterprise/package.json

@@ -0,0 +1,7 @@
+{
+    "dependencies": {
+        "ioredis": "^5.0.0",
+        "pg": "^8.0.0",
+        "@gravito/spectrum": "workspace:*"
+    }
+}

package/templates/overlays/scale/.env.example

@@ -0,0 +1,22 @@
+APP_NAME=Gravito
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=http://localhost:3000
+
+LOG_LEVEL=debug
+
+DB_CONNECTION=pgsql
+DB_HOST=127.0.0.1
+DB_PORT=5432
+DB_DATABASE=gravito
+DB_USERNAME=gravito
+DB_PASSWORD=secret
+
+CACHE_DRIVER=redis
+QUEUE_CONNECTION=redis
+SESSION_DRIVER=redis
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379

package/templates/overlays/scale/config/cache.ts

@@ -0,0 +1,31 @@
+/**
+ * Cache Configuration
+ *
+ * Defines cache stores and default cache driver.
+ * This configuration is used by @gravito/stasis cache orbit.
+ *
+ * Scale profile: Configured for high-scale scenarios with Redis as default.
+ *
+ * Supported drivers: 'memory', 'file', 'null', 'redis'
+ */
+export default {
+  default: process.env.CACHE_DRIVER || 'redis',
+  stores: {
+    // Redis - Redis 快取（生產環境推薦）
+    redis: {
+      driver: 'redis',
+      connection: process.env.REDIS_CACHE_CONNECTION || 'default',
+      prefix: process.env.REDIS_CACHE_PREFIX || 'cache:',
+    },
+    // Memory - 記憶體快取（開發/測試環境）
+    memory: {
+      driver: 'memory',
+      maxItems: 10_000,
+    },
+    // File - 檔案快取
+    file: {
+      driver: 'file',
+      path: process.env.CACHE_PATH || 'storage/framework/cache',
+    },
+  },
+} as const

package/templates/overlays/scale/config/database.ts

@@ -0,0 +1,34 @@
+/**
+ * Database Configuration
+ *
+ * Defines database connections and default connection driver.
+ * This configuration is used by @gravito/atlas ORM.
+ *
+ * Scale profile: Configured for high-scale scenarios with PostgreSQL as default.
+ */
+export default {
+  default: process.env.DB_CONNECTION || 'postgres',
+  connections: {
+    postgres: {
+      driver: 'postgres',
+      host: process.env.DB_HOST || '127.0.0.1',
+      port: parseInt(process.env.DB_PORT || '5432', 10),
+      database: process.env.DB_DATABASE || 'gravito',
+      username: process.env.DB_USERNAME || 'postgres',
+      password: process.env.DB_PASSWORD || '',
+      charset: 'utf8',
+      search_path: 'public',
+      sslmode: process.env.DB_SSLMODE || 'prefer',
+    },
+    mysql: {
+      driver: 'mysql',
+      host: process.env.DB_HOST || '127.0.0.1',
+      port: parseInt(process.env.DB_PORT || '3306', 10),
+      database: process.env.DB_DATABASE || 'gravito',
+      username: process.env.DB_USERNAME || 'root',
+      password: process.env.DB_PASSWORD || '',
+      charset: 'utf8mb4',
+      collation: 'utf8mb4_unicode_ci',
+    },
+  },
+} as const

package/templates/overlays/scale/config/queue.ts

@@ -0,0 +1,34 @@
+/**
+ * Queue Configuration
+ *
+ * Defines queue connections and default queue driver.
+ * This configuration is used by @gravito/stream queue system.
+ *
+ * Scale profile: Configured for high-scale scenarios with Redis and Kafka support.
+ */
+export default {
+  default: process.env.QUEUE_CONNECTION || 'redis',
+  connections: {
+    redis: {
+      driver: 'redis',
+      host: process.env.REDIS_HOST || '127.0.0.1',
+      port: parseInt(process.env.REDIS_PORT || '6379', 10),
+      password: process.env.REDIS_PASSWORD,
+      db: parseInt(process.env.REDIS_DB || '0', 10),
+      prefix: process.env.REDIS_PREFIX || 'queue:',
+    },
+    kafka: {
+      driver: 'kafka',
+      brokers: (process.env.KAFKA_BROKERS || 'localhost:9092').split(','),
+      consumerGroupId: process.env.KAFKA_CONSUMER_GROUP_ID || 'gravito-workers',
+      clientId: process.env.KAFKA_CLIENT_ID || 'gravito',
+    },
+    database: {
+      driver: 'database',
+      table: process.env.QUEUE_TABLE || 'jobs',
+    },
+    sync: {
+      driver: 'sync',
+    },
+  },
+} as const

package/templates/overlays/scale/docker-compose.yml

@@ -0,0 +1,32 @@
+services:
+  gravito.db:
+    image: postgres:15-alpine
+    environment:
+      POSTGRES_DB: ${DB_DATABASE:-gravito}
+      POSTGRES_USER: ${DB_USERNAME:-gravito}
+      POSTGRES_PASSWORD: ${DB_PASSWORD:-secret}
+    ports:
+      - '${DB_PORT:-5432}:5432'
+    volumes:
+      - gravito-db:/var/lib/postgresql/data
+    networks:
+      - gravito
+
+  gravito.redis:
+    image: redis:alpine
+    ports:
+      - '${REDIS_PORT:-6379}:6379'
+    volumes:
+      - gravito-redis:/data
+    networks:
+      - gravito
+
+networks:
+  gravito:
+    driver: bridge
+
+volumes:
+  gravito-db:
+    driver: local
+  gravito-redis:
+    driver: local

package/templates/overlays/scale/package.json

@@ -0,0 +1,6 @@
+{
+    "dependencies": {
+        "ioredis": "^5.0.0",
+        "pg": "^8.0.0"
+    }
+}