@posthog/core 1.1.0 → 1.2.0

package/dist/posthog-core.d.ts

@@ -0,0 +1,171 @@
+import type { PostHogAutocaptureElement, PostHogFlagsResponse, PostHogCoreOptions, PostHogEventProperties, PostHogCaptureOptions, JsonType, PostHogRemoteConfig, FeatureFlagValue, PostHogFeatureFlagDetails, PostHogGroupProperties } from './types';
+import { PostHogPersistedProperty } from './types';
+import { PostHogCoreStateless } from './posthog-core-stateless';
+export declare abstract class PostHogCore extends PostHogCoreStateless {
+    private sendFeatureFlagEvent;
+    private flagCallReported;
+    protected _flagsResponsePromise?: Promise<PostHogFlagsResponse | undefined>;
+    protected _sessionExpirationTimeSeconds: number;
+    private _sessionMaxLengthSeconds;
+    protected sessionProps: PostHogEventProperties;
+    constructor(apiKey: string, options?: PostHogCoreOptions);
+    protected setupBootstrap(options?: Partial<PostHogCoreOptions>): void;
+    private clearProps;
+    on(event: string, cb: (...args: any[]) => void): () => void;
+    reset(propertiesToKeep?: PostHogPersistedProperty[]): void;
+    protected getCommonEventProperties(): PostHogEventProperties;
+    private enrichProperties;
+    /**
+     * Returns the current session_id.
+     *
+     * @remarks
+     * This should only be used for informative purposes.
+     * Any actual internal use case for the session_id should be handled by the sessionManager.
+     *
+     * @public
+     *
+     * @returns The stored session ID for the current session. This may be an empty string if the client is not yet fully initialized.
+     */
+    getSessionId(): string;
+    resetSessionId(): void;
+    /**
+     * Returns the current anonymous ID.
+     *
+     * This is the ID assigned to users before they are identified. It's used to track
+     * anonymous users and link them to identified users when they sign up.
+     *
+     * {@label Identification}
+     *
+     * @example
+     * ```js
+     * // get the anonymous ID
+     * const anonId = posthog.getAnonymousId()
+     * console.log('Anonymous ID:', anonId)
+     * ```
+     *
+     * @public
+     *
+     * @returns {string} The stored anonymous ID. This may be an empty string if the client is not yet fully initialized.
+     */
+    getAnonymousId(): string;
+    /**
+     * * @returns {string} The stored distinct ID. This may be an empty string if the client is not yet fully initialized.
+     */
+    getDistinctId(): string;
+    registerForSession(properties: PostHogEventProperties): void;
+    unregisterForSession(property: string): void;
+    /***
+     *** TRACKING
+     ***/
+    identify(distinctId?: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
+    capture(event: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
+    alias(alias: string): void;
+    autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
+    /***
+     *** GROUPS
+     ***/
+    groups(groups: PostHogGroupProperties): void;
+    group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
+    groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
+    /***
+     * PROPERTIES
+     ***/
+    setPersonPropertiesForFlags(properties: {
+        [type: string]: string;
+    }): void;
+    resetPersonPropertiesForFlags(): void;
+    setGroupPropertiesForFlags(properties: {
+        [type: string]: Record<string, string>;
+    }): void;
+    resetGroupPropertiesForFlags(): void;
+    private remoteConfigAsync;
+    /***
+     *** FEATURE FLAGS
+     ***/
+    private flagsAsync;
+    private cacheSessionReplay;
+    private _remoteConfigAsync;
+    private _flagsAsync;
+    private setKnownFeatureFlagDetails;
+    private getKnownFeatureFlagDetails;
+    protected getKnownFeatureFlags(): PostHogFlagsResponse['featureFlags'] | undefined;
+    private getKnownFeatureFlagPayloads;
+    private getBootstrappedFeatureFlagDetails;
+    private setBootstrappedFeatureFlagDetails;
+    private getBootstrappedFeatureFlags;
+    private getBootstrappedFeatureFlagPayloads;
+    getFeatureFlag(key: string): FeatureFlagValue | undefined;
+    getFeatureFlagPayload(key: string): JsonType | undefined;
+    getFeatureFlagPayloads(): PostHogFlagsResponse['featureFlagPayloads'] | undefined;
+    getFeatureFlags(): PostHogFlagsResponse['featureFlags'] | undefined;
+    getFeatureFlagDetails(): PostHogFeatureFlagDetails | undefined;
+    getFeatureFlagsAndPayloads(): {
+        flags: PostHogFlagsResponse['featureFlags'] | undefined;
+        payloads: PostHogFlagsResponse['featureFlagPayloads'] | undefined;
+    };
+    isFeatureEnabled(key: string): boolean | undefined;
+    reloadFeatureFlags(options?: {
+        cb?: (err?: Error, flags?: PostHogFlagsResponse['featureFlags']) => void;
+    }): void;
+    reloadRemoteConfigAsync(): Promise<PostHogRemoteConfig | undefined>;
+    reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogFlagsResponse['featureFlags'] | undefined>;
+    onFeatureFlags(cb: (flags: PostHogFlagsResponse['featureFlags']) => void): () => void;
+    onFeatureFlag(key: string, cb: (value: FeatureFlagValue) => void): () => void;
+    overrideFeatureFlag(flags: PostHogFlagsResponse['featureFlags'] | null): Promise<void>;
+    /**
+     * Capture a caught exception manually
+     *
+     * {@label Error tracking}
+     *
+     * @public
+     *
+     * @example
+     * ```js
+     * // Capture a caught exception
+     * try {
+     *   // something that might throw
+     * } catch (error) {
+     *   posthog.captureException(error)
+     * }
+     * ```
+     *
+     * @example
+     * ```js
+     * // With additional properties
+     * posthog.captureException(error, {
+     *   customProperty: 'value',
+     *   anotherProperty: ['I', 'can be a list'],
+     *   ...
+     * })
+     * ```
+     *
+     * @param {Error} error The error to capture
+     * @param {Object} [additionalProperties] Any additional properties to add to the error event
+     * @returns {CaptureResult} The result of the capture
+     */
+    captureException(error: unknown, additionalProperties?: PostHogEventProperties): void;
+    /**
+     * Capture written user feedback for a LLM trace. Numeric values are converted to strings.
+     *
+     * {@label LLM analytics}
+     *
+     * @public
+     *
+     * @param traceId The trace ID to capture feedback for.
+     * @param userFeedback The feedback to capture.
+     */
+    captureTraceFeedback(traceId: string | number, userFeedback: string): void;
+    /**
+     * Capture a metric for a LLM trace. Numeric values are converted to strings.
+     *
+     * {@label LLM analytics}
+     *
+     * @public
+     *
+     * @param traceId The trace ID to capture the metric for.
+     * @param metricName The name of the metric to capture.
+     * @param metricValue The value of the metric to capture.
+     */
+    captureTraceMetric(traceId: string | number, metricName: string, metricValue: string | number | boolean): void;
+}
+//# sourceMappingURL=posthog-core.d.ts.map

package/dist/posthog-core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"posthog-core.d.ts","sourceRoot":"","sources":["../src/posthog-core.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,QAAQ,EACR,mBAAmB,EACnB,gBAAgB,EAGhB,yBAAyB,EAKzB,sBAAsB,EACvB,MAAM,SAAS,CAAA;AAShB,OAAO,EAAe,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAC/D,OAAO,EAAY,oBAAoB,EAAuB,MAAM,0BAA0B,CAAA;AAI9F,8BAAsB,WAAY,SAAQ,oBAAoB;IAE5D,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,gBAAgB,CAAiC;IAGzD,SAAS,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAA;IAC3E,SAAS,CAAC,6BAA6B,EAAE,MAAM,CAAA;IAC/C,OAAO,CAAC,wBAAwB,CAAuB;IACvD,SAAS,CAAC,YAAY,EAAE,sBAAsB,CAAK;gBAEvC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB;IAaxD,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,IAAI;IAiDrE,OAAO,CAAC,UAAU;IAMlB,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,MAAM,IAAI;IAI3D,KAAK,CAAC,gBAAgB,CAAC,EAAE,wBAAwB,EAAE,GAAG,IAAI;IAiB1D,SAAS,CAAC,wBAAwB,IAAI,sBAAsB;IAgB5D,OAAO,CAAC,gBAAgB;IAUxB;;;;;;;;;;OAUG;IACH,YAAY,IAAI,MAAM;IAyBtB,cAAc,IAAI,IAAI;IAQtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,IAAI,MAAM;IAaxB;;OAEG;IACH,aAAa,IAAI,MAAM;IAQvB,kBAAkB,CAAC,UAAU,EAAE,sBAAsB,GAAG,IAAI;IAO5D,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAI5C;;SAEK;IAEL,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAiCzG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAclG,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAS1B,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,yBAAyB,EAAE,EACrC,UAAU,GAAE,sBAA2B,EACvC,OAAO,CAAC,EAAE,qBAAqB,GAC9B,IAAI;IAiBP;;SAEK;IAEL,MAAM,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAkB5C,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,eAAe,CAAC,EAAE,sBAAsB,EACxC,OAAO,CAAC,EAAE,qBAAqB,GAC9B,IAAI;IAYP,aAAa,CACX,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,eAAe,CAAC,EAAE,sBAAsB,EACxC,OAAO,CAAC,EAAE,qBAAqB,GAC9B,IAAI;IAQP;;SAEK;IACL,2BAA2B,CAAC,UAAU,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI;IAazE,6BAA6B,IAAI,IAAI;IAMrC,0BAA0B,CAAC,UAAU,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,GAAG,IAAI;IAwBxF,4BAA4B,IAAI,IAAI;YAMtB,iBAAiB;IAQ/B;;SAEK;YACS,UAAU;IAQxB,OAAO,CAAC,kBAAkB;YAeZ,kBAAkB;YA8ElB,WAAW;IAgEzB,OAAO,CAAC,0BAA0B;IAQlC,OAAO,CAAC,0BAA0B;IAyBlC,SAAS,CAAC,oBAAoB,IAAI,oBAAoB,CAAC,cAAc,CAAC,GAAG,SAAS;IAQlF,OAAO,CAAC,2BAA2B;IAQnC,OAAO,CAAC,iCAAiC;IAUzC,OAAO,CAAC,iCAAiC;IAIzC,OAAO,CAAC,2BAA2B;IAQnC,OAAO,CAAC,kCAAkC;IAQ1C,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAwCzD,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAiBxD,sBAAsB,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,GAAG,SAAS;IAIjF,eAAe,IAAI,oBAAoB,CAAC,cAAc,CAAC,GAAG,SAAS;IAMnE,qBAAqB,IAAI,yBAAyB,GAAG,SAAS;IAgC9D,0BAA0B,IAAI;QAC5B,KAAK,EAAE,oBAAoB,CAAC,cAAc,CAAC,GAAG,SAAS,CAAA;QACvD,QAAQ,EAAE,oBAAoB,CAAC,qBAAqB,CAAC,GAAG,SAAS,CAAA;KAClE;IAUD,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IASlD,kBAAkB,CAAC,OAAO,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,KAAK,IAAI,CAAA;KAAE,GAAG,IAAI;IAa1G,uBAAuB,IAAI,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAInE,uBAAuB,CAC3B,kBAAkB,CAAC,EAAE,OAAO,GAC3B,OAAO,CAAC,oBAAoB,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAI5D,cAAc,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,oBAAoB,CAAC,cAAc,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI;IASrF,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,GAAG,MAAM,IAAI;IASvE,mBAAmB,CAAC,KAAK,EAAE,oBAAoB,CAAC,cAAc,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAS5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,oBAAoB,CAAC,EAAE,sBAAsB,GAAG,IAAI;IAwBrF;;;;;;;;;OASG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;IAO1E;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI;CAO/G"}