posthog-node 4.4.0 → 4.5.0

package/lib/index.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="node" />
+import { SeverityLevel } from 'posthog-node/src/extensions/error-tracking/types';
+import * as http from 'node:http';
+
 type PostHogCoreOptions = {
     /** PostHog API host, usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com' */
     host?: string;
@@ -372,9 +375,33 @@ type PostHogNodeV1 = {
     shutdown(shutdownTimeoutMs?: number): void;
 };
 
+interface EventHint {
+    mechanism?: Partial<Mechanism>;
+    syntheticException?: Error | null;
+}
+interface Mechanism {
+    handled?: boolean;
+    type?: string;
+    source?: string;
+    synthetic?: boolean;
+}
+
+declare class ErrorTracking {
+    private client;
+    private _exceptionAutocaptureEnabled;
+    static captureException(client: PostHog, error: unknown, distinctId: string, hint: EventHint, additionalProperties?: Record<string | number, any>): Promise<void>;
+    constructor(client: PostHog, options: PostHogOptions);
+    private startAutocaptureIfEnabled;
+    private onException;
+    private onFatalError;
+    isEnabled(): boolean;
+}
+
 type PostHogOptions = PostHogCoreOptions & {
     persistence?: 'memory';
     personalApiKey?: string;
+    privacyMode?: boolean;
+    enableExceptionAutocapture?: boolean;
     featureFlagsPollingInterval?: number;
     maxCacheSize?: number;
     fetch?: (url: string, options: PostHogFetchOptions) => Promise<PostHogFetchResponse>;
@@ -382,6 +409,7 @@ type PostHogOptions = PostHogCoreOptions & {
 declare class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     private _memoryStorage;
     private featureFlagsPoller?;
+    protected errorTracking: ErrorTracking;
     private maxCacheSize;
     readonly options: PostHogOptions;
     distinctIdHasSentFlagCalls: Record<string, string[]>;
@@ -444,14 +472,13 @@ declare class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     reloadFeatureFlags(): Promise<void>;
     shutdown(shutdownTimeoutMs?: number): Promise<void>;
     private addLocalPersonAndGroupProperties;
+    captureException(error: unknown, distinctId: string, additionalProperties?: Record<string | number, any>): void;
 }
 
 /**
  * @file Adapted from [posthog-js](https://github.com/PostHog/posthog-js/blob/8157df935a4d0e71d2fefef7127aa85ee51c82d1/src/extensions/sentry-integration.ts) with modifications for the Node SDK.
  */
 
-declare const severityLevels: readonly ["fatal", "error", "warning", "log", "info", "debug"];
-declare type SeverityLevel = (typeof severityLevels)[number];
 type _SentryEvent = any;
 type _SentryEventProcessor = any;
 type _SentryHub = any;
@@ -478,4 +505,18 @@ declare class PostHogSentryIntegration implements _SentryIntegrationClass {
     constructor(_posthog: PostHog, organization?: string, prefix?: string, severityAllowList?: SeverityLevel[] | '*');
 }
 
-export { PostHog, PostHogOptions, PostHogSentryIntegration, SentryIntegrationOptions, SeverityLevel, createEventProcessor, sentryIntegration, severityLevels };
+type ExpressMiddleware = (req: http.IncomingMessage, res: http.ServerResponse, next: () => void) => void;
+type ExpressErrorMiddleware = (error: MiddlewareError, req: http.IncomingMessage, res: http.ServerResponse, next: (error: MiddlewareError) => void) => void;
+interface MiddlewareError extends Error {
+    status?: number | string;
+    statusCode?: number | string;
+    status_code?: number | string;
+    output?: {
+        statusCode?: number | string;
+    };
+}
+declare function setupExpressErrorHandler(_posthog: PostHog, app: {
+    use: (middleware: ExpressMiddleware | ExpressErrorMiddleware) => unknown;
+}): void;
+
+export { PostHog, PostHogOptions, PostHogSentryIntegration, SentryIntegrationOptions, createEventProcessor, sentryIntegration, setupExpressErrorHandler };