npm - create-mantiq - Versions diffs - 0.7.0 → 0.7.1 - Mend

create-mantiq 0.7.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (220) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "create-mantiq",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Scaffold a new MantiqJS application",
   "type": "module",
   "license": "MIT",
@@ -35,6 +35,7 @@
   "files": [
     "src/",
     "stubs/",
+    "skeleton/",
     "package.json",
     "README.md"
   ],

package/skeleton/.env.example ADDED Viewed

@@ -0,0 +1,64 @@
+# Application
+APP_NAME=MantiqJS
+APP_ENV=local
+APP_DEBUG=true
+APP_KEY=
+APP_URL=http://localhost:3000
+APP_PORT=3000
+# Database
+DB_CONNECTION=sqlite
+DB_DATABASE=database/database.sqlite
+# DB_HOST=127.0.0.1
+# DB_PORT=5432
+# DB_USERNAME=postgres
+# DB_PASSWORD=
+# Session
+SESSION_DRIVER=memory
+SESSION_LIFETIME=120
+SESSION_COOKIE=mantiq_session
+# Cache
+CACHE_STORE=memory
+# REDIS_HOST=127.0.0.1
+# REDIS_PORT=6379
+# REDIS_PASSWORD=
+# Queue
+QUEUE_CONNECTION=sync
+# Mail
+MAIL_MAILER=log
+MAIL_FROM_ADDRESS=hello@example.com
+MAIL_FROM_NAME=${APP_NAME}
+# MAIL_HOST=localhost
+# MAIL_PORT=587
+# MAIL_USERNAME=
+# MAIL_PASSWORD=
+# Logging
+LOG_CHANNEL=stack
+# Hashing
+HASH_DRIVER=bcrypt
+BCRYPT_ROUNDS=10
+# Broadcasting
+BROADCAST_DRIVER=bun
+# Filesystem
+FILESYSTEM_DISK=local
+# Search
+# ALGOLIA_APP_ID=
+# ALGOLIA_SECRET=
+# MEILISEARCH_HOST=http://127.0.0.1:7700
+# MEILISEARCH_KEY=
+# AI
+AI_PROVIDER=openai
+AI_MODEL=gpt-4o
+OPENAI_API_KEY=
+ANTHROPIC_API_KEY=
+GEMINI_API_KEY=

package/skeleton/README.md ADDED Viewed

@@ -0,0 +1,46 @@
+# MantiqJS Skeleton
+The official MantiqJS application skeleton — API-only, no frontend framework.
+This is the reference implementation used by `create-mantiq` to scaffold new projects.
+## Getting Started
+```bash
+bun install
+bun mantiq migrate
+bun run dev
+```
+## Structure
+```
+├── app/
+│   ├── Http/Controllers/    # Request handlers
+│   ├── Models/              # Database models
+│   └── Providers/           # Service providers
+├── config/                  # Configuration files
+├── database/
+│   ├── migrations/          # Database migrations
+│   ├── seeders/             # Data seeders
+│   └── factories/           # Model factories
+├── routes/
+│   ├── web.ts               # Web routes
+│   └── api.ts               # API routes
+├── storage/                 # Logs, cache, uploads
+├── index.ts                 # Application bootstrap
+├── mantiq.ts                # CLI entry point
+└── package.json
+```
+## Available Commands
+```bash
+bun run dev              # Start dev server (with watch)
+bun run start            # Start production server
+bun mantiq migrate       # Run migrations
+bun mantiq seed          # Run seeders
+bun mantiq make:model    # Generate a model
+bun mantiq make:migration # Generate a migration
+bun mantiq route:list    # List all routes
+```

package/skeleton/app/Console/Commands/.gitkeep ADDED Viewed

File without changes

package/skeleton/app/Enums/UserStatus.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import { Enum } from '@mantiq/core'
+export class UserStatus extends Enum {
+  static Active = new UserStatus('active')
+  static Inactive = new UserStatus('inactive')
+  static Banned = new UserStatus('banned')
+}

package/skeleton/app/Http/Controllers/HomeController.ts ADDED Viewed

@@ -0,0 +1,78 @@
+import type { MantiqRequest } from '@mantiq/core'
+import { config } from '@mantiq/core'
+export class HomeController {
+  async index(_request: MantiqRequest): Promise<Response> {
+    const appName = config('app.name') ?? 'MantiqJS'
+    const appEnv = config('app.env') ?? 'production'
+    const debug = config('app.debug') ? 'Enabled' : 'Disabled'
+    const bunVersion = typeof Bun !== 'undefined' ? Bun.version : 'unknown'
+    let mantiqVersion = '0.0.0'
+    try {
+      const pkg = await Bun.file(require.resolve('@mantiq/core/package.json')).json()
+      mantiqVersion = pkg.version
+    } catch { /* fallback */ }
+    const html = `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>${appName}</title>
+  <style>
+    *,*::before,*::after{box-sizing:border-box;margin:0;padding:0}
+    body{
+      font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',system-ui,sans-serif;
+      background:#0a0a0b;color:#fafafa;min-height:100vh;
+      display:flex;align-items:center;justify-content:center;
+      -webkit-font-smoothing:antialiased;
+    }
+    .c{width:100%;max-width:460px;padding:32px;animation:up .5s ease}
+    @keyframes up{from{opacity:0;transform:translateY(12px)}to{opacity:1;transform:translateY(0)}}
+    .w{font-size:28px;font-weight:600;letter-spacing:-0.04em;color:#fafafa}
+    .w .d{color:#10b981}
+    .v{font-family:'SF Mono',ui-monospace,monospace;font-size:12px;color:#52525b;margin-top:6px}
+    hr{border:none;border-top:1px solid #1e1e1e;margin:24px 0}
+    .g{display:grid;grid-template-columns:1fr 1fr;gap:8px}
+    .l{
+      background:#111113;border:1px solid #1e1e1e;border-radius:8px;
+      padding:14px 16px;text-decoration:none;color:#a1a1aa;font-size:13px;
+      display:flex;align-items:center;justify-content:space-between;
+      transition:border-color .15s,color .15s;
+    }
+    .l:hover{border-color:#27272a;color:#34d399}
+    .l .a{color:#52525b;font-size:11px;transition:color .15s}
+    .l:hover .a{color:#34d399}
+    .e{
+      margin-top:24px;font-family:'SF Mono',ui-monospace,monospace;
+      font-size:11px;color:#3f3f46;line-height:2;
+    }
+    .e span{color:#52525b}
+  </style>
+</head>
+<body>
+  <div class="c">
+    <div class="w"><span class="d">.</span>mantiq</div>
+    <div class="v">v${mantiqVersion} — ${appName}</div>
+    <hr>
+    <div class="g">
+      <a class="l" href="/_heartbeat">Heartbeat<span class="a">&rarr;</span></a>
+      <a class="l" href="/api/ping">API Ping<span class="a">&rarr;</span></a>
+      <a class="l" href="https://github.com/mantiqjs/mantiq" target="_blank" rel="noopener">GitHub<span class="a">&nearr;</span></a>
+      <a class="l" href="https://www.npmjs.com/org/mantiq" target="_blank" rel="noopener">npm<span class="a">&nearr;</span></a>
+    </div>
+    <div class="e">
+      <span>Runtime</span> Bun ${bunVersion}<br>
+      <span>Environment</span> ${appEnv}<br>
+      <span>Debug</span> ${debug}
+    </div>
+  </div>
+</body>
+</html>`
+    return new Response(html, {
+      headers: { 'Content-Type': 'text/html; charset=utf-8' },
+    })
+  }
+}

package/skeleton/app/Http/Middleware/.gitkeep ADDED Viewed

File without changes

package/skeleton/app/Models/User.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import { Model } from '@mantiq/database'
+import { AuthenticatableModel } from '@mantiq/auth'
+export class User extends AuthenticatableModel(Model) {
+  static override fillable = ['name', 'email', 'password']
+  static override hidden = ['password', 'remember_token']
+}

package/skeleton/app/Providers/AppServiceProvider.ts ADDED Viewed

@@ -0,0 +1,25 @@
+import { ServiceProvider } from '@mantiq/core'
+/**
+ * Application Service Provider
+ *
+ * Register application-level bindings and run bootstrap logic here.
+ * This provider is auto-discovered from app/Providers/.
+ */
+export class AppServiceProvider extends ServiceProvider {
+  /**
+   * Register bindings into the container.
+   * Called before any provider's boot() method.
+   */
+  override register(): void {
+    //
+  }
+  /**
+   * Bootstrap application services.
+   * Called after all providers have been registered.
+   */
+  override async boot(): Promise<void> {
+    //
+  }
+}

package/skeleton/app/Providers/DatabaseServiceProvider.ts ADDED Viewed

@@ -0,0 +1,17 @@
+import { ServiceProvider, config } from '@mantiq/core'
+import { DatabaseManager, setupModels, setManager } from '@mantiq/database'
+export class DatabaseServiceProvider extends ServiceProvider {
+  override register(): void {
+    this.app.singleton(DatabaseManager, () => {
+      const manager = new DatabaseManager(config('database'))
+      setManager(manager)
+      setupModels(manager)
+      return manager
+    })
+  }
+  override async boot(): Promise<void> {
+    this.app.make(DatabaseManager)
+  }
+}

package/skeleton/bootstrap/.gitkeep ADDED Viewed

File without changes

package/skeleton/config/ai.ts ADDED Viewed

@@ -0,0 +1,51 @@
+import { env } from '@mantiq/core'
+export default {
+  default: env('AI_PROVIDER', 'openai'),
+  providers: {
+    openai: {
+      driver: 'openai' as const,
+      apiKey: env('OPENAI_API_KEY', ''),
+    },
+    anthropic: {
+      driver: 'anthropic' as const,
+      apiKey: env('ANTHROPIC_API_KEY', ''),
+    },
+    gemini: {
+      driver: 'gemini' as const,
+      apiKey: env('GEMINI_API_KEY', ''),
+    },
+    ollama: {
+      driver: 'ollama' as const,
+      host: env('OLLAMA_HOST', 'http://localhost'),
+      port: 11434,
+    },
+  },
+  defaultModel: env('AI_MODEL', 'gpt-4o'),
+  embeddings: {
+    default: 'openai',
+    providers: {},
+    defaultModel: 'text-embedding-3-small',
+  },
+  vectorStores: {
+    default: 'memory',
+    stores: {
+      memory: { driver: 'memory' as const },
+    },
+  },
+  observability: {
+    enabled: true,
+    logRequests: env('AI_LOG_REQUESTS', 'false') === 'true',
+    trackCosts: true,
+  },
+  limits: {
+    maxTokensPerRequest: 4096,
+    maxCostPerDay: 100.00,
+  },
+}

package/skeleton/config/app.ts ADDED Viewed

@@ -0,0 +1,108 @@
+import { env } from '@mantiq/core'
+export default {
+  /*
+  |--------------------------------------------------------------------------
+  | Application Name
+  |--------------------------------------------------------------------------
+  |
+  | This value is the name of your application. It is used when the
+  | framework needs to place the application's name in a notification,
+  | log entry, or any other location as required by the application.
+  |
+  */
+  name: env('APP_NAME', 'MantiqJS'),
+  /*
+  |--------------------------------------------------------------------------
+  | Application Environment
+  |--------------------------------------------------------------------------
+  |
+  | This value determines the "environment" your application is running in.
+  | This may influence how you configure various services the application
+  | uses. Set this in your ".env" file.
+  |
+  | Supported: 'production', 'local', 'staging', 'testing'
+  |
+  */
+  env: env('APP_ENV', 'production'),
+  /*
+  |--------------------------------------------------------------------------
+  | Application Debug Mode
+  |--------------------------------------------------------------------------
+  |
+  | When your application is in debug mode, detailed error messages with
+  | stack traces will be shown on every error. If disabled, a simple
+  | generic error page is shown. Also controls the heartbeat debug widget.
+  |
+  | WARNING: Never enable debug mode in production.
+  |
+  */
+  debug: env('APP_DEBUG', false),
+  /*
+  |--------------------------------------------------------------------------
+  | Encryption Key
+  |--------------------------------------------------------------------------
+  |
+  | This key is used by the encryption service and should be set to a
+  | random, 32-character string. You should do this before deploying.
+  |
+  | Generate with: bun mantiq key:generate
+  |
+  */
+  key: env('APP_KEY', ''),
+  /*
+  |--------------------------------------------------------------------------
+  | Application URL
+  |--------------------------------------------------------------------------
+  |
+  | This URL is used by the framework to generate URLs, configure CORS
+  | origin, and properly redirect. You should set this to the root of
+  | your application so that it is used when running CLI commands.
+  |
+  */
+  url: env('APP_URL', 'http://localhost:3000'),
+  /*
+  |--------------------------------------------------------------------------
+  | Application Port
+  |--------------------------------------------------------------------------
+  |
+  | The port the HTTP server will listen on.
+  |
+  */
+  port: Number(env('APP_PORT', '3000')),
+  /*
+  |--------------------------------------------------------------------------
+  | Base Path
+  |--------------------------------------------------------------------------
+  |
+  | The absolute path to the project root directory. Used for resolving
+  | config files, routes, migrations, and other project resources.
+  |
+  */
+  basePath: import.meta.dir + '/..',
+  /*
+  |--------------------------------------------------------------------------
+  | Middleware Groups
+  |--------------------------------------------------------------------------
+  |
+  | Middleware groups are applied automatically based on the route file:
+  |   routes/web.ts → 'web' group (stateful: sessions, CSRF, cookies)
+  |   routes/api.ts → 'api' group (stateless: rate-limited, no sessions)
+  |
+  | Available aliases: cors, encrypt.cookies, session, csrf, throttle,
+  |   auth, guest, trim, static, heartbeat
+  |
+  */
+  middlewareGroups: {
+    web: ['cors', 'encrypt.cookies', 'session', 'csrf'],
+    api: ['cors', 'throttle'],
+  },
+}

package/skeleton/config/auth.ts ADDED Viewed

@@ -0,0 +1,51 @@
+import { User } from '../app/Models/User.ts'
+export default {
+  /*
+  |--------------------------------------------------------------------------
+  | Authentication Defaults
+  |--------------------------------------------------------------------------
+  |
+  | This option controls the default authentication "guard" for your
+  | application. You may change this to any of the guards defined below.
+  |
+  */
+  defaults: {
+    guard: 'web',
+  },
+  /*
+  |--------------------------------------------------------------------------
+  | Authentication Guards
+  |--------------------------------------------------------------------------
+  |
+  | Guards define how users are authenticated for each request. The "web"
+  | guard uses session cookies (for browsers and SPAs). The "api" guard
+  | uses Sanctum-style bearer tokens (for mobile apps and third-party).
+  |
+  | Supported drivers: 'session', 'token'
+  |
+  | Token format: Authorization: Bearer {id}|{plaintext}
+  |
+  */
+  guards: {
+    web: { driver: 'session', provider: 'users' },
+    api: { driver: 'token', provider: 'users' },
+  },
+  /*
+  |--------------------------------------------------------------------------
+  | User Providers
+  |--------------------------------------------------------------------------
+  |
+  | Providers define how users are retrieved from your database. The
+  | "database" driver queries the model specified below.
+  |
+  | Supported drivers: 'database'
+  |
+  */
+  providers: {
+    users: { driver: 'database', model: User },
+  },
+}

package/skeleton/config/broadcasting.ts ADDED Viewed

@@ -0,0 +1,93 @@
+import { env } from '@mantiq/core'
+export default {
+  /*
+  |--------------------------------------------------------------------------
+  | Realtime Enabled
+  |--------------------------------------------------------------------------
+  |
+  | Master switch for the realtime server. When disabled, WebSocket and
+  | SSE endpoints are not registered and broadcast events are no-ops.
+  |
+  */
+  enabled: true,
+  /*
+  |--------------------------------------------------------------------------
+  | Broadcast Driver
+  |--------------------------------------------------------------------------
+  |
+  | The default broadcast driver for sending real-time events to clients.
+  | The 'bun' driver works in-process with zero dependencies. Use 'redis'
+  | for multi-server deployments.
+  |
+  | Supported: 'bun', 'redis', 'log', 'null'
+  |
+  */
+  driver: env('BROADCAST_DRIVER', 'bun'),
+  /*
+  |--------------------------------------------------------------------------
+  | WebSocket Server
+  |--------------------------------------------------------------------------
+  |
+  | Bun's native WebSocket server handles real-time connections. Clients
+  | connect to ws://host:port/<path>. The server sends heartbeat pings
+  | and closes idle connections after the timeout.
+  |
+  */
+  websocket: {
+    path: '/ws',
+    maxConnectionsPerUser: 10,  // Per-user limit (0 = unlimited)
+    maxConnections: 0,          // Total limit (0 = unlimited)
+    heartbeatInterval: 25_000,  // Ping interval (ms)
+    heartbeatTimeout: 10_000,   // Close if no pong after (ms)
+  },
+  /*
+  |--------------------------------------------------------------------------
+  | Server-Sent Events (SSE) Fallback
+  |--------------------------------------------------------------------------
+  |
+  | SSE provides a fallback for clients that can't use WebSockets
+  | (corporate proxies, older browsers). One-directional: server → client.
+  |
+  */
+  sse: {
+    enabled: true,
+    path: '/_sse',
+    keepAliveInterval: 15_000,  // Keep-alive ping interval (ms)
+  },
+  /*
+  |--------------------------------------------------------------------------
+  | Presence Channels
+  |--------------------------------------------------------------------------
+  |
+  | Presence channels track which users are currently subscribed.
+  | memberTtl controls how long a disconnected user stays in the member
+  | list before being removed (handles brief network interruptions).
+  |
+  */
+  presence: {
+    memberTtl: 30_000,  // Remove member after disconnect (ms)
+  },
+  /*
+  |--------------------------------------------------------------------------
+  | Redis Driver
+  |--------------------------------------------------------------------------
+  |
+  | When using the 'redis' broadcast driver, events are published to
+  | Redis pub/sub. This allows multiple server instances to broadcast
+  | to each other's connected clients.
+  |
+  */
+  redis: {
+    host: env('REDIS_HOST', '127.0.0.1'),
+    port: Number(env('REDIS_PORT', '6379')),
+    password: env('REDIS_PASSWORD', ''),
+    prefix: 'mantiq_realtime:',
+  },
+}

package/skeleton/config/cache.ts ADDED Viewed

@@ -0,0 +1,61 @@
+import { env } from '@mantiq/core'
+export default {
+  /*
+  |--------------------------------------------------------------------------
+  | Default Cache Store
+  |--------------------------------------------------------------------------
+  |
+  | This option controls the default cache connection that gets used
+  | while using this caching library. You may use any of the stores
+  | defined in the "stores" object below.
+  |
+  | Supported: 'memory', 'file', 'redis', 'memcached', 'null'
+  |
+  */
+  default: env('CACHE_STORE', 'memory'),
+  /*
+  |--------------------------------------------------------------------------
+  | Cache Key Prefix
+  |--------------------------------------------------------------------------
+  |
+  | When utilizing a RAM-based store such as Redis or Memcached, there
+  | might be other applications using the same cache. To avoid collisions,
+  | you may prefix every cache key.
+  |
+  */
+  prefix: env('CACHE_PREFIX', 'mantiq_cache_'),
+  /*
+  |--------------------------------------------------------------------------
+  | Cache Stores
+  |--------------------------------------------------------------------------
+  |
+  | Here you may define all of the cache "stores" for your application
+  | as well as their drivers. You may even define multiple stores for
+  | the same driver to group types of items stored in your caches.
+  |
+  */
+  stores: {
+    memory: {},
+    file: {
+      path: 'storage/cache',
+    },
+    redis: {
+      url: env('REDIS_URL', ''),
+      host: env('REDIS_HOST', '127.0.0.1'),
+      port: Number(env('REDIS_PORT', '6379')),
+      password: env('REDIS_PASSWORD', ''),
+      db: Number(env('REDIS_CACHE_DB', '1')),
+    },
+    memcached: {
+      host: env('MEMCACHED_HOST', '127.0.0.1'),
+      port: Number(env('MEMCACHED_PORT', '11211')),
+    },
+  },
+}