@venizia/ignis-docs 0.0.3 → 0.0.4-1

package/wiki/references/index.md

@@ -0,0 +1,177 @@
+# API Reference
+
+Complete reference documentation for the Ignis framework. Find detailed API docs, type definitions, and usage examples for every class, component, and utility in the framework.
+
+<div class="guide-cards">
+
+<a href="./base/" class="guide-card highlight">
+<span class="guide-icon">🏗️</span>
+<h3>Base Abstractions</h3>
+<p>Application, Controller, Service, Repository, Model</p>
+</a>
+
+<a href="./components/" class="guide-card">
+<span class="guide-icon">🧩</span>
+<h3>Components</h3>
+<p>Auth, Mail, Socket.IO, Swagger, Health Check</p>
+</a>
+
+<a href="./helpers/" class="guide-card">
+<span class="guide-icon">🛠️</span>
+<h3>Helpers</h3>
+<p>Logger, Redis, Queue, Storage, Cron, Crypto</p>
+</a>
+
+<a href="./utilities/" class="guide-card">
+<span class="guide-icon">⚙️</span>
+<h3>Utilities</h3>
+<p>Date, Parse, Promise, Schema, Performance</p>
+</a>
+
+<a href="./configuration/" class="guide-card">
+<span class="guide-icon">📝</span>
+<h3>Configuration</h3>
+<p>Environment variables and settings</p>
+</a>
+
+<a href="./src-details/" class="guide-card">
+<span class="guide-icon">📦</span>
+<h3>Framework Internals</h3>
+<p>Package structure and architecture</p>
+</a>
+
+</div>
+
+## Find What You Need
+
+<div class="roadmap">
+
+<div class="roadmap-stage">
+<div class="stage-header">
+<span class="stage-num">1</span>
+<h4>Building an API</h4>
+</div>
+<p><a href="./base/application">Application</a> → <a href="./base/controllers">Controllers</a> → <a href="./base/services">Services</a> → <a href="./base/repositories/">Repositories</a></p>
+<span class="stage-desc">Request handling, business logic, and data access</span>
+</div>
+
+<div class="roadmap-stage">
+<div class="stage-header">
+<span class="stage-num">2</span>
+<h4>Data Layer</h4>
+</div>
+<p><a href="./base/models">Models</a> → <a href="./base/datasources">DataSources</a> → <a href="./base/filter-system/">Filtering</a> → <a href="./base/repositories/relations">Relations</a></p>
+<span class="stage-desc">Entities, database connections, and query building</span>
+</div>
+
+<div class="roadmap-stage">
+<div class="stage-header">
+<span class="stage-num">3</span>
+<h4>Adding Features</h4>
+</div>
+<p><a href="./components/authentication">Auth</a> → <a href="./components/socket-io">Real-time</a> → <a href="./components/mail">Email</a> → <a href="./components/swagger">API Docs</a></p>
+<span class="stage-desc">Pre-built components for common features</span>
+</div>
+
+<div class="roadmap-stage">
+<div class="stage-header">
+<span class="stage-num">4</span>
+<h4>Infrastructure</h4>
+</div>
+<p><a href="./helpers/logger">Logging</a> → <a href="./helpers/redis">Caching</a> → <a href="./helpers/queue">Queues</a> → <a href="./helpers/cron">Scheduling</a></p>
+<span class="stage-desc">Background jobs, caching, and observability</span>
+</div>
+
+<div class="roadmap-stage">
+<div class="stage-header">
+<span class="stage-num">5</span>
+<h4>Advanced Patterns</h4>
+</div>
+<p><a href="./base/dependency-injection">Dependency Injection</a> → <a href="./base/providers">Custom Providers</a> → <a href="./base/middlewares">Middlewares</a> → <a href="./base/components">Components</a></p>
+<span class="stage-desc">Advanced architecture patterns and customization</span>
+</div>
+
+<div class="roadmap-stage">
+<div class="stage-header">
+<span class="stage-num">6</span>
+<h4>Production Ready</h4>
+</div>
+<p><a href="./base/middlewares">Error Handling</a> → <a href="./components/health-check">Health Checks</a> → <a href="./configuration/environment-variables">Configuration</a> → <a href="./base/bootstrapping">Auto-Discovery</a></p>
+<span class="stage-desc">Production deployment, monitoring, and reliability</span>
+</div>
+
+<div class="roadmap-stage">
+<div class="stage-header">
+<span class="stage-num">7</span>
+<h4>Testing & Quality</h4>
+</div>
+<p><a href="./helpers/testing">Unit Testing</a> → <a href="./base/repositories/advanced">Mocking & Stubs</a> → <a href="./quick-reference">Best Practices</a></p>
+<span class="stage-desc">Testing strategies, quality assurance, and code review</span>
+</div>
+
+</div>
+
+::: tip Looking for tutorials?
+Check out the [Getting Started Guide](/guides/) for step-by-step tutorials and the [Core Concepts](/guides/core-concepts/application/) for architectural explanations.
+:::
+
+## Quick Examples
+
+**Define a Controller:**
+```typescript
+@controller({ path: '/users' })
+class UserController extends BaseController {
+  @get({ configs: { path: '/:id' } })
+  getUser(c: Context) {
+    return c.json({ id: c.req.param('id') });
+  }
+}
+```
+
+**Query with Repository:**
+```typescript
+const users = await userRepo.find({
+  where: { isActive: true },
+  orderBy: { createdAt: 'desc' },
+  limit: 10,
+});
+```
+
+**Schedule a Job:**
+```typescript
+CronHelper.schedule('0 * * * *', async () => {
+  await cleanupExpiredSessions();
+});
+```
+
+## Common Imports
+
+```typescript
+// Core framework
+import {
+  BaseApplication,
+  BaseController,
+  BaseService,
+  BaseRepository,
+  controller,
+  get, post, put, del,
+  inject,
+} from '@venizia/ignis';
+
+// Helpers
+import {
+  LoggerFactory,
+  RedisHelper,
+  QueueHelper,
+} from '@venizia/ignis-helpers';
+
+// DI Container
+import { Container } from '@venizia/ignis-inversion';
+```
+
+## See Also
+
+- [Getting Started](/guides/) - New to Ignis? Start here
+- [Core Concepts](/guides/core-concepts/application/) - Deep dive into architecture
+- [Best Practices](/best-practices/) - Production patterns
+- [Changelogs](/changelogs/) - Version history