API Reference

INFO

Detailed API documentation is available in the individual package documentation pages.

Core Packages

Framework

Package	Description
@geekmidas/constructs	HTTP endpoints, functions, crons, and event subscribers
@geekmidas/cli	CLI for building, development, and deployment
@geekmidas/envkit	Environment configuration parser
@geekmidas/services	Service discovery and dependency injection

Data & Storage

Package	Description
@geekmidas/db	Database utilities for Kysely
@geekmidas/cache	Unified caching interface
@geekmidas/storage	Cloud storage abstraction (S3)
@geekmidas/events	Event messaging (RabbitMQ, SQS, SNS)

Security

Package	Description
@geekmidas/auth	JWT/OIDC authentication
@geekmidas/errors	HTTP error classes
@geekmidas/rate-limit	Rate limiting utilities
@geekmidas/audit	Type-safe audit logging

Development Tools

Package	Description
@geekmidas/telescope	Debugging dashboard
@geekmidas/studio	Database browser
@geekmidas/logger	Structured logging
@geekmidas/testkit	Testing utilities and factories

Frontend & API Client

Package	Description
@geekmidas/client	Type-safe API client with React Query
@geekmidas/ui	React components (shadcn/ui based)
@geekmidas/emailkit	Email templates with React

Infrastructure

Package	Description
@geekmidas/cloud	SST integration utilities
@geekmidas/schema	StandardSchema type utilities

Quick Reference

Endpoint Builder

import { e } from '@geekmidas/constructs/endpoints';
import { z } from 'zod';

export const getUser = e
  .get('/users/:id')
  .params(z.object({ id: z.string() }))
  .output(z.object({ id: z.string(), name: z.string() }))
  .handle(async ({ params }) => {
    return { id: params.id, name: 'John Doe' };
  });

Service Pattern

import type { Service } from '@geekmidas/services';

const dbService = {
  serviceName: 'db' as const,
  async register(envParser) {
    const config = envParser.create((get) => ({
      url: get('DATABASE_URL').string(),
    })).parse();
    return createConnection(config.url);
  },
} satisfies Service<'db', Database>;

Error Handling

import { createError } from '@geekmidas/errors';

throw createError.notFound('User not found');
throw createError.unauthorized('Invalid credentials');
throw createError.forbidden('Access denied');

Workspace Configuration

import { defineWorkspace } from '@geekmidas/cli/config';

export default defineWorkspace({
  apps: {
    api: {
      path: 'apps/api',
      type: 'backend',
      port: 3000,
      routes: './src/endpoints/**/*.ts',
    },
  },
  services: { db: true, cache: true },
  deploy: {
    default: 'dokploy',
    dns: { provider: 'route53', domain: 'myapp.com' },
  },
});