@statly/observe 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,273 @@
+export { expressErrorHandler, requestHandler } from './integrations/express.mjs';
+export { captureNextJsError, withStatly, withStatlyGetServerSideProps, withStatlyGetStaticProps, withStatlyPagesApi, withStatlyServerAction } from './integrations/nextjs.mjs';
+export { createRequestCapture, statlyFastifyPlugin, statlyPlugin } from './integrations/fastify.mjs';
+
+/**
+ * Statly Observe SDK Types
+ */
+interface StatlyOptions {
+    /** DSN for your organization: https://<api-key>@statly.live/<org-slug> */
+    dsn: string;
+    /** Release/version identifier */
+    release?: string;
+    /** Environment (e.g., 'production', 'staging', 'development') */
+    environment?: string;
+    /** Enable debug logging */
+    debug?: boolean;
+    /** Sample rate for error events (0.0 to 1.0) */
+    sampleRate?: number;
+    /** Maximum breadcrumbs to capture */
+    maxBreadcrumbs?: number;
+    /** Auto-attach global error handlers */
+    autoCapture?: boolean;
+    /** Capture console errors as breadcrumbs */
+    captureConsole?: boolean;
+    /** Capture XHR/fetch requests as breadcrumbs */
+    captureNetwork?: boolean;
+    /** Custom tags to attach to all events */
+    tags?: Record<string, string>;
+    /** Before send hook - return null to drop the event */
+    beforeSend?: (event: StatlyEvent) => StatlyEvent | null;
+}
+interface User {
+    id?: string;
+    email?: string;
+    name?: string;
+    username?: string;
+    [key: string]: unknown;
+}
+interface Breadcrumb {
+    timestamp?: number;
+    category?: string;
+    message?: string;
+    level?: 'debug' | 'info' | 'warning' | 'error';
+    data?: Record<string, unknown>;
+}
+interface StackFrame {
+    filename?: string;
+    function?: string;
+    lineno?: number;
+    colno?: number;
+    in_app?: boolean;
+    context_line?: string;
+    pre_context?: string[];
+    post_context?: string[];
+}
+interface Exception {
+    type?: string;
+    value?: string;
+    stacktrace?: {
+        frames?: StackFrame[];
+    };
+}
+interface BrowserInfo {
+    name?: string;
+    version?: string;
+}
+interface OSInfo {
+    name?: string;
+    version?: string;
+}
+interface DeviceInfo {
+    type?: string;
+    model?: string;
+    vendor?: string;
+}
+interface StatlyEvent {
+    message: string;
+    timestamp?: number;
+    level?: 'debug' | 'info' | 'warning' | 'error' | 'fatal';
+    stack?: string;
+    exception?: Exception;
+    environment?: string;
+    release?: string;
+    url?: string;
+    user?: User;
+    tags?: Record<string, string>;
+    extra?: Record<string, unknown>;
+    breadcrumbs?: Breadcrumb[];
+    browser?: BrowserInfo;
+    os?: OSInfo;
+    device?: DeviceInfo;
+    sdk?: {
+        name: string;
+        version: string;
+    };
+    fingerprint?: string[];
+}
+type EventLevel = 'debug' | 'info' | 'warning' | 'error' | 'fatal';
+
+/**
+ * Statly Observe Client
+ * Main SDK entry point for error tracking
+ */
+
+declare class StatlyClient {
+    private options;
+    private transport;
+    private breadcrumbs;
+    private globalHandlers;
+    private consoleIntegration;
+    private user;
+    private initialized;
+    constructor(options: StatlyOptions);
+    private mergeOptions;
+    private detectEnvironment;
+    /**
+     * Initialize the SDK
+     */
+    init(): void;
+    /**
+     * Capture an exception/error
+     */
+    captureException(error: Error | unknown, context?: Record<string, unknown>): string;
+    /**
+     * Capture a message
+     */
+    captureMessage(message: string, level?: EventLevel): string;
+    /**
+     * Internal method to capture an error
+     */
+    private captureError;
+    /**
+     * Build a complete event from partial data
+     */
+    private buildEvent;
+    /**
+     * Parse a stack trace string into structured frames
+     */
+    private parseStackTrace;
+    /**
+     * Send an event to the server
+     */
+    private sendEvent;
+    private generateEventId;
+    /**
+     * Set user context
+     */
+    setUser(user: User | null): void;
+    /**
+     * Set a single tag
+     */
+    setTag(key: string, value: string): void;
+    /**
+     * Set multiple tags
+     */
+    setTags(tags: Record<string, string>): void;
+    /**
+     * Add a breadcrumb
+     */
+    addBreadcrumb(breadcrumb: Omit<Breadcrumb, 'timestamp'>): void;
+    /**
+     * Get browser info
+     */
+    private getBrowserInfo;
+    /**
+     * Get OS info
+     */
+    private getOSInfo;
+    /**
+     * Flush pending events and clean up
+     */
+    close(): Promise<void>;
+    /**
+     * Force flush pending events
+     */
+    flush(): Promise<void>;
+}
+
+/**
+ * Statly Observe SDK
+ *
+ * Error tracking and monitoring for JavaScript applications.
+ *
+ * @example
+ * ```typescript
+ * import { Statly } from '@statly/observe-sdk';
+ *
+ * Statly.init({
+ *   dsn: 'https://sk_live_xxx@statly.live/your-org',
+ *   release: '1.0.0',
+ *   environment: 'production',
+ * });
+ *
+ * // Errors are captured automatically
+ *
+ * // Manual capture
+ * try {
+ *   riskyOperation();
+ * } catch (error) {
+ *   Statly.captureException(error);
+ * }
+ *
+ * // Capture a message
+ * Statly.captureMessage('Something happened', 'warning');
+ *
+ * // Set user context
+ * Statly.setUser({
+ *   id: 'user-123',
+ *   email: 'user@example.com',
+ * });
+ *
+ * // Add breadcrumb
+ * Statly.addBreadcrumb({
+ *   category: 'auth',
+ *   message: 'User logged in',
+ * });
+ * ```
+ */
+
+/**
+ * Initialize the Statly SDK
+ */
+declare function init(options: StatlyOptions): void;
+/**
+ * Capture an exception
+ */
+declare function captureException(error: Error | unknown, context?: Record<string, unknown>): string;
+/**
+ * Capture a message
+ */
+declare function captureMessage(message: string, level?: EventLevel): string;
+/**
+ * Set user context
+ */
+declare function setUser(user: User | null): void;
+/**
+ * Set a tag
+ */
+declare function setTag(key: string, value: string): void;
+/**
+ * Set multiple tags
+ */
+declare function setTags(tags: Record<string, string>): void;
+/**
+ * Add a breadcrumb
+ */
+declare function addBreadcrumb(breadcrumb: Omit<Breadcrumb, 'timestamp'>): void;
+/**
+ * Flush pending events
+ */
+declare function flush(): Promise<void>;
+/**
+ * Close the SDK and flush pending events
+ */
+declare function close(): Promise<void>;
+/**
+ * Get the current client instance
+ */
+declare function getClient(): StatlyClient | null;
+declare const Statly: {
+    readonly init: typeof init;
+    readonly captureException: typeof captureException;
+    readonly captureMessage: typeof captureMessage;
+    readonly setUser: typeof setUser;
+    readonly setTag: typeof setTag;
+    readonly setTags: typeof setTags;
+    readonly addBreadcrumb: typeof addBreadcrumb;
+    readonly flush: typeof flush;
+    readonly close: typeof close;
+    readonly getClient: typeof getClient;
+};
+
+export { type Breadcrumb, type BrowserInfo, type DeviceInfo, type EventLevel, type Exception, type OSInfo, type StackFrame, Statly, StatlyClient, type StatlyEvent, type StatlyOptions, type User, addBreadcrumb, captureException, captureMessage, close, flush, getClient, init, setTag, setTags, setUser };

package/dist/index.d.ts

@@ -0,0 +1,273 @@
+export { expressErrorHandler, requestHandler } from './integrations/express.js';
+export { captureNextJsError, withStatly, withStatlyGetServerSideProps, withStatlyGetStaticProps, withStatlyPagesApi, withStatlyServerAction } from './integrations/nextjs.js';
+export { createRequestCapture, statlyFastifyPlugin, statlyPlugin } from './integrations/fastify.js';
+
+/**
+ * Statly Observe SDK Types
+ */
+interface StatlyOptions {
+    /** DSN for your organization: https://<api-key>@statly.live/<org-slug> */
+    dsn: string;
+    /** Release/version identifier */
+    release?: string;
+    /** Environment (e.g., 'production', 'staging', 'development') */
+    environment?: string;
+    /** Enable debug logging */
+    debug?: boolean;
+    /** Sample rate for error events (0.0 to 1.0) */
+    sampleRate?: number;
+    /** Maximum breadcrumbs to capture */
+    maxBreadcrumbs?: number;
+    /** Auto-attach global error handlers */
+    autoCapture?: boolean;
+    /** Capture console errors as breadcrumbs */
+    captureConsole?: boolean;
+    /** Capture XHR/fetch requests as breadcrumbs */
+    captureNetwork?: boolean;
+    /** Custom tags to attach to all events */
+    tags?: Record<string, string>;
+    /** Before send hook - return null to drop the event */
+    beforeSend?: (event: StatlyEvent) => StatlyEvent | null;
+}
+interface User {
+    id?: string;
+    email?: string;
+    name?: string;
+    username?: string;
+    [key: string]: unknown;
+}
+interface Breadcrumb {
+    timestamp?: number;
+    category?: string;
+    message?: string;
+    level?: 'debug' | 'info' | 'warning' | 'error';
+    data?: Record<string, unknown>;
+}
+interface StackFrame {
+    filename?: string;
+    function?: string;
+    lineno?: number;
+    colno?: number;
+    in_app?: boolean;
+    context_line?: string;
+    pre_context?: string[];
+    post_context?: string[];
+}
+interface Exception {
+    type?: string;
+    value?: string;
+    stacktrace?: {
+        frames?: StackFrame[];
+    };
+}
+interface BrowserInfo {
+    name?: string;
+    version?: string;
+}
+interface OSInfo {
+    name?: string;
+    version?: string;
+}
+interface DeviceInfo {
+    type?: string;
+    model?: string;
+    vendor?: string;
+}
+interface StatlyEvent {
+    message: string;
+    timestamp?: number;
+    level?: 'debug' | 'info' | 'warning' | 'error' | 'fatal';
+    stack?: string;
+    exception?: Exception;
+    environment?: string;
+    release?: string;
+    url?: string;
+    user?: User;
+    tags?: Record<string, string>;
+    extra?: Record<string, unknown>;
+    breadcrumbs?: Breadcrumb[];
+    browser?: BrowserInfo;
+    os?: OSInfo;
+    device?: DeviceInfo;
+    sdk?: {
+        name: string;
+        version: string;
+    };
+    fingerprint?: string[];
+}
+type EventLevel = 'debug' | 'info' | 'warning' | 'error' | 'fatal';
+
+/**
+ * Statly Observe Client
+ * Main SDK entry point for error tracking
+ */
+
+declare class StatlyClient {
+    private options;
+    private transport;
+    private breadcrumbs;
+    private globalHandlers;
+    private consoleIntegration;
+    private user;
+    private initialized;
+    constructor(options: StatlyOptions);
+    private mergeOptions;
+    private detectEnvironment;
+    /**
+     * Initialize the SDK
+     */
+    init(): void;
+    /**
+     * Capture an exception/error
+     */
+    captureException(error: Error | unknown, context?: Record<string, unknown>): string;
+    /**
+     * Capture a message
+     */
+    captureMessage(message: string, level?: EventLevel): string;
+    /**
+     * Internal method to capture an error
+     */
+    private captureError;
+    /**
+     * Build a complete event from partial data
+     */
+    private buildEvent;
+    /**
+     * Parse a stack trace string into structured frames
+     */
+    private parseStackTrace;
+    /**
+     * Send an event to the server
+     */
+    private sendEvent;
+    private generateEventId;
+    /**
+     * Set user context
+     */
+    setUser(user: User | null): void;
+    /**
+     * Set a single tag
+     */
+    setTag(key: string, value: string): void;
+    /**
+     * Set multiple tags
+     */
+    setTags(tags: Record<string, string>): void;
+    /**
+     * Add a breadcrumb
+     */
+    addBreadcrumb(breadcrumb: Omit<Breadcrumb, 'timestamp'>): void;
+    /**
+     * Get browser info
+     */
+    private getBrowserInfo;
+    /**
+     * Get OS info
+     */
+    private getOSInfo;
+    /**
+     * Flush pending events and clean up
+     */
+    close(): Promise<void>;
+    /**
+     * Force flush pending events
+     */
+    flush(): Promise<void>;
+}
+
+/**
+ * Statly Observe SDK
+ *
+ * Error tracking and monitoring for JavaScript applications.
+ *
+ * @example
+ * ```typescript
+ * import { Statly } from '@statly/observe-sdk';
+ *
+ * Statly.init({
+ *   dsn: 'https://sk_live_xxx@statly.live/your-org',
+ *   release: '1.0.0',
+ *   environment: 'production',
+ * });
+ *
+ * // Errors are captured automatically
+ *
+ * // Manual capture
+ * try {
+ *   riskyOperation();
+ * } catch (error) {
+ *   Statly.captureException(error);
+ * }
+ *
+ * // Capture a message
+ * Statly.captureMessage('Something happened', 'warning');
+ *
+ * // Set user context
+ * Statly.setUser({
+ *   id: 'user-123',
+ *   email: 'user@example.com',
+ * });
+ *
+ * // Add breadcrumb
+ * Statly.addBreadcrumb({
+ *   category: 'auth',
+ *   message: 'User logged in',
+ * });
+ * ```
+ */
+
+/**
+ * Initialize the Statly SDK
+ */
+declare function init(options: StatlyOptions): void;
+/**
+ * Capture an exception
+ */
+declare function captureException(error: Error | unknown, context?: Record<string, unknown>): string;
+/**
+ * Capture a message
+ */
+declare function captureMessage(message: string, level?: EventLevel): string;
+/**
+ * Set user context
+ */
+declare function setUser(user: User | null): void;
+/**
+ * Set a tag
+ */
+declare function setTag(key: string, value: string): void;
+/**
+ * Set multiple tags
+ */
+declare function setTags(tags: Record<string, string>): void;
+/**
+ * Add a breadcrumb
+ */
+declare function addBreadcrumb(breadcrumb: Omit<Breadcrumb, 'timestamp'>): void;
+/**
+ * Flush pending events
+ */
+declare function flush(): Promise<void>;
+/**
+ * Close the SDK and flush pending events
+ */
+declare function close(): Promise<void>;
+/**
+ * Get the current client instance
+ */
+declare function getClient(): StatlyClient | null;
+declare const Statly: {
+    readonly init: typeof init;
+    readonly captureException: typeof captureException;
+    readonly captureMessage: typeof captureMessage;
+    readonly setUser: typeof setUser;
+    readonly setTag: typeof setTag;
+    readonly setTags: typeof setTags;
+    readonly addBreadcrumb: typeof addBreadcrumb;
+    readonly flush: typeof flush;
+    readonly close: typeof close;
+    readonly getClient: typeof getClient;
+};
+
+export { type Breadcrumb, type BrowserInfo, type DeviceInfo, type EventLevel, type Exception, type OSInfo, type StackFrame, Statly, StatlyClient, type StatlyEvent, type StatlyOptions, type User, addBreadcrumb, captureException, captureMessage, close, flush, getClient, init, setTag, setTags, setUser };