@classytic/arc 1.1.0 → 2.1.2

package/dist/arcCorePlugin-CsShQdyP.d.ts

@@ -1,273 +0,0 @@
-import { FastifyPluginAsync, FastifyInstance, FastifyRequest } from 'fastify';
-import { H as HookSystem, j as ResourceRegistry } from './index-B4t03KQ0.js';
-
-/**
- * Request ID Plugin
- *
- * Propagates request IDs for distributed tracing.
- * - Accepts incoming x-request-id header
- * - Generates UUID if not provided
- * - Attaches to request.id and response header
- *
- * @example
- * import { requestIdPlugin } from '@classytic/arc';
- *
- * await fastify.register(requestIdPlugin);
- *
- * // In handlers, access via request.id
- * fastify.get('/', async (request) => {
- *   console.log(request.id); // UUID
- * });
- */
-
-interface RequestIdOptions {
-    /** Header name to read/write request ID (default: 'x-request-id') */
-    header?: string;
-    /** Custom ID generator (default: crypto.randomUUID) */
-    generator?: () => string;
-    /** Whether to set response header (default: true) */
-    setResponseHeader?: boolean;
-}
-declare module 'fastify' {
-    interface FastifyRequest {
-        /** Unique request identifier for tracing */
-        requestId: string;
-    }
-}
-declare const requestIdPlugin: FastifyPluginAsync<RequestIdOptions>;
-declare const _default$4: FastifyPluginAsync<RequestIdOptions>;
-
-/**
- * Health Check Plugin
- *
- * Kubernetes-ready health endpoints:
- * - /health/live  - Liveness probe (is the process alive?)
- * - /health/ready - Readiness probe (can we serve traffic?)
- * - /health/metrics - Prometheus metrics (optional)
- *
- * @example
- * import { healthPlugin } from '@classytic/arc';
- *
- * await fastify.register(healthPlugin, {
- *   prefix: '/_health',
- *   checks: [
- *     { name: 'mongodb', check: async () => mongoose.connection.readyState === 1 },
- *     { name: 'redis', check: async () => redis.ping() === 'PONG' },
- *   ],
- * });
- */
-
-interface HealthCheck {
-    /** Name of the dependency */
-    name: string;
-    /** Function that returns true if healthy, false otherwise */
-    check: () => Promise<boolean> | boolean;
-    /** Optional timeout in ms (default: 5000) */
-    timeout?: number;
-    /** Whether this check is critical for readiness (default: true) */
-    critical?: boolean;
-}
-interface HealthOptions {
-    /** Route prefix (default: '/_health') */
-    prefix?: string;
-    /** Health check dependencies */
-    checks?: HealthCheck[];
-    /** Enable metrics endpoint (default: false) */
-    metrics?: boolean;
-    /** Custom metrics collector function */
-    metricsCollector?: () => Promise<string> | string;
-    /** Version info to include in responses */
-    version?: string;
-    /** Collect HTTP request metrics (default: true if metrics enabled) */
-    collectHttpMetrics?: boolean;
-}
-declare const healthPlugin: FastifyPluginAsync<HealthOptions>;
-declare const _default$3: FastifyPluginAsync<HealthOptions>;
-
-/**
- * OpenTelemetry Distributed Tracing Plugin
- *
- * Traces HTTP requests, repository operations, and MongoDB queries
- * across the entire application lifecycle.
- *
- * @example
- * import { tracingPlugin } from '@classytic/arc/plugins';
- *
- * await fastify.register(tracingPlugin, {
- *   serviceName: 'my-api',
- *   exporterUrl: 'http://localhost:4318/v1/traces', // OTLP endpoint
- * });
- */
-
-interface TracingOptions {
-    /**
-     * Service name for traces
-     */
-    serviceName?: string;
-    /**
-     * OTLP exporter endpoint URL
-     * @default 'http://localhost:4318/v1/traces'
-     */
-    exporterUrl?: string;
-    /**
-     * Enable auto-instrumentation for HTTP, MongoDB, etc.
-     * @default true
-     */
-    autoInstrumentation?: boolean;
-    /**
-     * Trace all repository operations
-     * @default true
-     */
-    traceRepository?: boolean;
-    /**
-     * Trace all controller operations
-     * @default true
-     */
-    traceController?: boolean;
-    /**
-     * Sample rate (0.0 to 1.0)
-     * @default 1.0 (trace everything)
-     */
-    sampleRate?: number;
-}
-interface TracerContext {
-    tracer: any;
-    currentSpan: any;
-}
-declare module 'fastify' {
-    interface FastifyRequest {
-        tracer?: TracerContext;
-    }
-}
-/**
- * OpenTelemetry Distributed Tracing Plugin
- */
-declare function tracingPlugin(fastify: FastifyInstance, options?: TracingOptions): Promise<void>;
-/**
- * Utility to create custom spans in your code
- *
- * @example
- * import { createSpan } from '@classytic/arc/plugins';
- *
- * async function expensiveOperation(req) {
- *   return createSpan(req, 'expensiveOperation', async (span) => {
- *     span.setAttribute('custom.attribute', 'value');
- *     return await doWork();
- *   });
- * }
- */
-declare function createSpan<T>(request: FastifyRequest, name: string, fn: (span: any) => Promise<T>, attributes?: Record<string, any>): Promise<T>;
-/**
- * Decorator to automatically trace repository methods
- *
- * @example
- * class ProductRepository extends Repository {
- *   @traced()
- *   async findActive() {
- *     return this.findAll({ filter: { isActive: true } });
- *   }
- * }
- */
-declare function traced(spanName?: string): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-/**
- * Check if OpenTelemetry is available
- */
-declare function isTracingAvailable(): boolean;
-declare const _default$2: typeof tracingPlugin;
-
-/**
- * Graceful Shutdown Plugin
- *
- * Handles SIGTERM and SIGINT signals for clean shutdown:
- * - Stops accepting new connections
- * - Waits for in-flight requests to complete
- * - Closes database connections
- * - Exits cleanly
- *
- * Essential for Kubernetes deployments.
- *
- * @example
- * import { gracefulShutdownPlugin } from '@classytic/arc';
- *
- * await fastify.register(gracefulShutdownPlugin, {
- *   timeout: 30000, // 30 seconds max
- *   onShutdown: async () => {
- *     await mongoose.disconnect();
- *     await redis.quit();
- *   },
- * });
- */
-
-interface GracefulShutdownOptions {
-    /** Maximum time to wait for graceful shutdown in ms (default: 30000) */
-    timeout?: number;
-    /** Custom cleanup function called before exit */
-    onShutdown?: () => Promise<void> | void;
-    /** Signals to handle (default: ['SIGTERM', 'SIGINT']) */
-    signals?: NodeJS.Signals[];
-    /** Whether to log shutdown events (default: true) */
-    logEvents?: boolean;
-}
-declare const gracefulShutdownPlugin: FastifyPluginAsync<GracefulShutdownOptions>;
-declare module 'fastify' {
-    interface FastifyInstance {
-        /** Trigger graceful shutdown manually */
-        shutdown: () => Promise<void>;
-    }
-}
-declare const _default$1: FastifyPluginAsync<GracefulShutdownOptions>;
-
-/**
- * Arc Core Plugin
- *
- * Sets up instance-scoped Arc systems:
- * - HookSystem: Lifecycle hooks per app instance
- * - ResourceRegistry: Resource tracking per app instance
- * - Event integration: Wires CRUD operations to fastify.events
- *
- * This solves the global singleton leak problem where multiple
- * app instances (e.g., in tests) would share state.
- *
- * @example
- * import { arcCorePlugin } from '@classytic/arc';
- *
- * const app = Fastify();
- * await app.register(arcCorePlugin);
- *
- * // Now use instance-scoped hooks
- * app.arc.hooks.before('product', 'create', async (ctx) => {
- *   ctx.data.slug = slugify(ctx.data.name);
- * });
- */
-
-interface ArcCorePluginOptions {
-    /** Enable event emission for CRUD operations (requires eventPlugin) */
-    emitEvents?: boolean;
-    /** Hook system instance (for testing/custom setup) */
-    hookSystem?: HookSystem;
-    /** Resource registry instance (for testing/custom setup) */
-    registry?: ResourceRegistry;
-    /**
-     * Use global singletons for backward compatibility with presets
-     * When false (default), creates new isolated instances for better test isolation
-     * When true, uses global hookSystem/registry (for preset compatibility)
-     */
-    useGlobalSingletons?: boolean;
-}
-interface ArcCore {
-    /** Instance-scoped hook system */
-    hooks: HookSystem;
-    /** Instance-scoped resource registry */
-    registry: ResourceRegistry;
-    /** Whether event emission is enabled */
-    emitEvents: boolean;
-}
-declare module 'fastify' {
-    interface FastifyInstance {
-        arc: ArcCore;
-    }
-}
-declare const arcCorePlugin: FastifyPluginAsync<ArcCorePluginOptions>;
-declare const _default: FastifyPluginAsync<ArcCorePluginOptions>;
-
-export { type ArcCorePluginOptions as A, type GracefulShutdownOptions as G, type HealthOptions as H, type RequestIdOptions as R, type TracingOptions as T, _default$4 as _, _default$3 as a, type HealthCheck as b, _default$2 as c, createSpan as d, _default$1 as e, _default as f, gracefulShutdownPlugin as g, healthPlugin as h, isTracingAvailable as i, arcCorePlugin as j, type ArcCore as k, requestIdPlugin as r, traced as t };

package/dist/audit/index.d.ts

@@ -1,195 +0,0 @@
-import { U as UserBase } from '../types-B99TBmFV.js';
-import { FastifyPluginAsync } from 'fastify';
-
-/**
- * Audit Store Interface
- *
- * Pluggable storage backend for audit logs.
- * Implementations: memory (dev), mongodb, event (emit only)
- */
-
-type AuditAction = 'create' | 'update' | 'delete' | 'restore' | 'custom';
-interface AuditEntry {
-    /** Unique audit log ID */
-    id: string;
-    /** Resource name (e.g., 'product', 'user') */
-    resource: string;
-    /** Document/entity ID */
-    documentId: string;
-    /** Action performed */
-    action: AuditAction;
-    /** User who performed the action */
-    userId?: string;
-    /** Organization context */
-    organizationId?: string;
-    /** Previous state (for updates) */
-    before?: Record<string, unknown>;
-    /** New state (for creates/updates) */
-    after?: Record<string, unknown>;
-    /** Changed fields (for updates) */
-    changes?: string[];
-    /** Request ID for tracing */
-    requestId?: string;
-    /** IP address */
-    ipAddress?: string;
-    /** User agent */
-    userAgent?: string;
-    /** Custom metadata */
-    metadata?: Record<string, unknown>;
-    /** When the action occurred */
-    timestamp: Date;
-}
-interface AuditContext {
-    user?: UserBase;
-    organizationId?: string;
-    requestId?: string;
-    ipAddress?: string;
-    userAgent?: string;
-}
-interface AuditStoreOptions {
-    /** Store name for logging */
-    name: string;
-}
-/**
- * Abstract audit store interface
- */
-interface AuditStore {
-    /** Store name */
-    readonly name: string;
-    /** Log an audit entry */
-    log(entry: AuditEntry): Promise<void>;
-    /** Query audit logs (optional - not all stores support querying) */
-    query?(options: AuditQueryOptions): Promise<AuditEntry[]>;
-    /** Close/cleanup (optional) */
-    close?(): Promise<void>;
-}
-interface AuditQueryOptions {
-    resource?: string;
-    documentId?: string;
-    userId?: string;
-    organizationId?: string;
-    action?: AuditAction | AuditAction[];
-    from?: Date;
-    to?: Date;
-    limit?: number;
-    offset?: number;
-}
-/**
- * Create audit entry from context
- */
-declare function createAuditEntry(resource: string, documentId: string, action: AuditAction, context: AuditContext, data?: {
-    before?: Record<string, unknown>;
-    after?: Record<string, unknown>;
-    metadata?: Record<string, unknown>;
-}): AuditEntry;
-
-interface AuditPluginOptions {
-    /** Enable audit logging (default: false) */
-    enabled?: boolean;
-    /** Storage backends to use */
-    stores?: ('memory' | 'mongodb')[];
-    /** MongoDB connection (required if using mongodb store) */
-    mongoConnection?: {
-        collection: (name: string) => unknown;
-    };
-    /** MongoDB collection name (default: 'audit_logs') */
-    mongoCollection?: string;
-    /** TTL in days for MongoDB (default: 90) */
-    ttlDays?: number;
-    /** Custom stores (advanced) */
-    customStores?: AuditStore[];
-}
-declare module 'fastify' {
-    interface FastifyInstance {
-        /** Log an audit entry */
-        audit: AuditLogger;
-    }
-    interface FastifyRequest {
-        /** Audit context for current request */
-        auditContext?: AuditContext;
-    }
-}
-interface AuditLogger {
-    /** Log a create action */
-    create: (resource: string, documentId: string, data: Record<string, unknown>, context?: AuditContext) => Promise<void>;
-    /** Log an update action */
-    update: (resource: string, documentId: string, before: Record<string, unknown>, after: Record<string, unknown>, context?: AuditContext) => Promise<void>;
-    /** Log a delete action */
-    delete: (resource: string, documentId: string, data: Record<string, unknown>, context?: AuditContext) => Promise<void>;
-    /** Log a restore action (soft delete undo) */
-    restore: (resource: string, documentId: string, data: Record<string, unknown>, context?: AuditContext) => Promise<void>;
-    /** Log a custom action */
-    custom: (resource: string, documentId: string, action: string, data?: Record<string, unknown>, context?: AuditContext) => Promise<void>;
-    /** Query audit logs (if stores support it) */
-    query: (options: AuditQueryOptions) => Promise<AuditEntry[]>;
-}
-declare const auditPlugin: FastifyPluginAsync<AuditPluginOptions>;
-declare const _default: FastifyPluginAsync<AuditPluginOptions>;
-
-/**
- * In-Memory Audit Store
- *
- * For development and testing. Not suitable for production.
- * Logs are lost on restart.
- */
-
-interface MemoryAuditStoreOptions {
-    /** Maximum entries to keep (default: 1000) */
-    maxEntries?: number;
-}
-declare class MemoryAuditStore implements AuditStore {
-    readonly name = "memory";
-    private entries;
-    private maxEntries;
-    constructor(options?: MemoryAuditStoreOptions);
-    log(entry: AuditEntry): Promise<void>;
-    query(options?: AuditQueryOptions): Promise<AuditEntry[]>;
-    close(): Promise<void>;
-    /** Get all entries (for testing) */
-    getAll(): AuditEntry[];
-    /** Clear all entries (for testing) */
-    clear(): void;
-}
-
-/**
- * MongoDB Audit Store
- *
- * Persists audit logs to MongoDB collection with TTL support.
- * Suitable for production use.
- */
-
-interface MongoAuditStoreOptions {
-    /** MongoDB connection or mongoose instance */
-    connection: MongoConnection;
-    /** Collection name (default: 'audit_logs') */
-    collection?: string;
-    /** TTL in days (default: 90, 0 = no expiry) */
-    ttlDays?: number;
-}
-interface MongoConnection {
-    collection: (name: string) => MongoCollection;
-}
-interface MongoCollection {
-    insertOne: (doc: Record<string, unknown>) => Promise<unknown>;
-    find: (query: Record<string, unknown>) => MongoCursor;
-    createIndex: (spec: Record<string, unknown>, options?: Record<string, unknown>) => Promise<unknown>;
-}
-interface MongoCursor {
-    sort: (spec: Record<string, unknown>) => MongoCursor;
-    skip: (n: number) => MongoCursor;
-    limit: (n: number) => MongoCursor;
-    toArray: () => Promise<Record<string, unknown>[]>;
-}
-declare class MongoAuditStore implements AuditStore {
-    private options;
-    readonly name = "mongodb";
-    private collection;
-    private initialized;
-    private ttlDays;
-    constructor(options: MongoAuditStoreOptions);
-    private ensureIndexes;
-    log(entry: AuditEntry): Promise<void>;
-    query(options?: AuditQueryOptions): Promise<AuditEntry[]>;
-}
-
-export { type AuditAction, type AuditContext, type AuditEntry, type AuditLogger, type AuditPluginOptions, type AuditQueryOptions, type AuditStore, type AuditStoreOptions, MemoryAuditStore, type MemoryAuditStoreOptions, MongoAuditStore, type MongoAuditStoreOptions, _default as auditPlugin, auditPlugin as auditPluginFn, createAuditEntry };