@posthog/types 1.313.0

package/dist/session-recording.js

@@ -0,0 +1,18 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+for(var __webpack_i__ in __webpack_exports__)exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@posthog/types",
+  "version": "1.313.0",
+  "description": "Type definitions for the PostHog JavaScript SDK",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PostHog/posthog-js.git",
+    "directory": "packages/types"
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/__tests__"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "devDependencies": {
+    "@rslib/core": "0.10.6",
+    "@types/jest": "^29.5.14",
+    "jest": "29.7.0",
+    "ts-jest": "29.4.0",
+    "typescript": "5.8.2",
+    "@posthog-tooling/tsconfig-base": "1.1.1"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "build": "rslib build",
+    "dev": "rslib build -w",
+    "test:unit": "jest",
+    "package": "pnpm pack --out $PACKAGE_DEST/%s.tgz"
+  }
+}

package/src/capture.ts

@@ -0,0 +1,101 @@
+/**
+ * Capture-related types
+ */
+
+import type { Properties } from './common'
+
+/**
+ * These are known events PostHog events that can be processed by the `beforeCapture` function
+ * That means PostHog functionality does not rely on receiving 100% of these for calculations
+ * So, it is safe to sample them to reduce the volume of events sent to PostHog
+ */
+export type KnownEventName =
+    | '$heatmaps_data'
+    | '$opt_in'
+    | '$exception'
+    | '$$heatmap'
+    | '$web_vitals'
+    | '$dead_click'
+    | '$autocapture'
+    | '$copy_autocapture'
+    | '$rageclick'
+
+/**
+ * Known events that can be safely edited in beforeCapture without breaking PostHog functionality
+ */
+export type KnownUnsafeEditableEvent =
+    | '$set'
+    | '$pageview'
+    | '$pageleave'
+    | '$identify'
+    | '$groupidentify'
+    | '$create_alias'
+    | '$feature_flag_called'
+
+export type EventName =
+    | KnownUnsafeEditableEvent
+    | KnownEventName
+    // magic value so that the type of EventName is a set of known strings or any other string
+    // which means you get autocomplete for known strings
+    // but no type complaints when you add an arbitrary string
+    | (string & {})
+
+export interface CaptureResult {
+    uuid: string
+    event: EventName
+    properties: Properties
+    $set?: Properties
+    $set_once?: Properties
+    timestamp?: Date
+}
+
+export interface CaptureOptions {
+    /**
+     * Used when `$identify` is called
+     * Will set person properties overriding previous values
+     */
+    $set?: Properties
+
+    /**
+     * Used when `$identify` is called
+     * Will set person properties but only once, it will NOT override previous values
+     */
+    $set_once?: Properties
+
+    /**
+     * Used to override the desired endpoint for the captured event
+     */
+    _url?: string
+
+    /**
+     * key of queue, e.g. 'sessionRecording' vs 'event'
+     */
+    _batchKey?: string
+
+    /**
+     * If set, overrides and disables config.properties_string_max_length
+     */
+    _noTruncate?: boolean
+
+    /**
+     * If set, skips the batched queue
+     */
+    send_instantly?: boolean
+
+    /**
+     * If set, skips the client side rate limiting
+     */
+    skip_client_rate_limiting?: boolean
+
+    /**
+     * If set, overrides the desired transport method
+     */
+    transport?: 'XHR' | 'fetch' | 'sendBeacon'
+
+    /**
+     * If set, overrides the current timestamp
+     */
+    timestamp?: Date
+}
+
+export type BeforeSendFn = (cr: CaptureResult | null) => CaptureResult | null

package/src/common.ts

@@ -0,0 +1,9 @@
+/**
+ * Common types shared across PostHog SDKs
+ */
+
+export type Property = any
+export type Properties = Record<string, Property>
+
+export type JsonRecord = { [key: string]: JsonType }
+export type JsonType = string | number | boolean | null | undefined | JsonRecord | Array<JsonType>

package/src/feature-flags.ts

@@ -0,0 +1,60 @@
+/**
+ * Feature flag types
+ */
+
+import type { JsonType } from './common'
+
+export type FeatureFlagsCallback = (
+    flags: string[],
+    variants: Record<string, string | boolean>,
+    context?: {
+        errorsLoading?: boolean
+    }
+) => void
+
+export type FeatureFlagDetail = {
+    key: string
+    enabled: boolean
+    // Only used when overriding a flag payload.
+    original_enabled?: boolean | undefined
+    variant: string | undefined
+    // Only used when overriding a flag payload.
+    original_variant?: string | undefined
+    reason: EvaluationReason | undefined
+    metadata: FeatureFlagMetadata | undefined
+}
+
+export type FeatureFlagMetadata = {
+    id: number
+    version: number | undefined
+    description: string | undefined
+    payload: JsonType | undefined
+    // Only used when overriding a flag payload.
+    original_payload?: JsonType | undefined
+}
+
+export type EvaluationReason = {
+    code: string
+    condition_index: number | undefined
+    description: string | undefined
+}
+
+export type RemoteConfigFeatureFlagCallback = (payload: JsonType) => void
+
+// Sync this with the backend's EarlyAccessFeatureSerializer!
+/** A feature that isn't publicly available yet.*/
+export interface EarlyAccessFeature {
+    name: string
+    description: string
+    stage: 'concept' | 'alpha' | 'beta'
+    documentationUrl: string | null
+    payload: JsonType
+    flagKey: string | null
+}
+
+export type EarlyAccessFeatureStage = 'concept' | 'alpha' | 'beta' | 'general-availability'
+export type EarlyAccessFeatureCallback = (earlyAccessFeatures: EarlyAccessFeature[]) => void
+
+export interface EarlyAccessFeatureResponse {
+    earlyAccessFeatures: EarlyAccessFeature[]
+}

package/src/index.ts

@@ -0,0 +1,74 @@
+/**
+ * @posthog/types - Type definitions for the PostHog JavaScript SDK
+ *
+ * This package provides TypeScript type definitions for the PostHog SDK,
+ * allowing you to type the PostHog instance and its configuration options.
+ */
+
+// PostHog instance type
+export type { PostHog } from './posthog'
+
+// Common types
+export type { Property, Properties, JsonType, JsonRecord } from './common'
+
+// Capture types
+export type {
+    KnownEventName,
+    KnownUnsafeEditableEvent,
+    EventName,
+    CaptureResult,
+    CaptureOptions,
+    BeforeSendFn,
+} from './capture'
+
+// Feature flag types
+export type {
+    FeatureFlagsCallback,
+    FeatureFlagDetail,
+    FeatureFlagMetadata,
+    EvaluationReason,
+    RemoteConfigFeatureFlagCallback,
+    EarlyAccessFeature,
+    EarlyAccessFeatureStage,
+    EarlyAccessFeatureCallback,
+    EarlyAccessFeatureResponse,
+} from './feature-flags'
+
+// Request types
+export type { Headers, RequestResponse, RequestCallback } from './request'
+
+// Session recording types
+export type {
+    SessionRecordingCanvasOptions,
+    InitiatorType,
+    NetworkRequest,
+    CapturedNetworkRequest,
+    SessionIdChangedCallback,
+    SeverityLevel,
+} from './session-recording'
+
+// Config types
+export type {
+    AutocaptureCompatibleElement,
+    DomAutocaptureEvents,
+    AutocaptureConfig,
+    RageclickConfig,
+    BootstrapConfig,
+    SupportedWebVitalsMetrics,
+    PerformanceCaptureConfig,
+    DeadClickCandidate,
+    ExceptionAutoCaptureConfig,
+    DeadClicksAutoCaptureConfig,
+    HeatmapConfig,
+    ConfigDefaults,
+    ExternalIntegrationKind,
+    ErrorTrackingOptions,
+    MaskInputOptions,
+    SlimDOMOptions,
+    SessionRecordingOptions,
+    RequestQueueConfig,
+    PostHogConfig,
+} from './posthog-config'
+
+// Segment integration types
+export type { SegmentUser, SegmentAnalytics, SegmentPlugin, SegmentContext, SegmentFunction } from './segment'