posthog-node 4.11.5 → 4.11.6

package/lib/index.d.ts

@@ -2,212 +2,6 @@
 import { SeverityLevel } from 'posthog-node/src/extensions/error-tracking/types';
 import * as http from 'node:http';
 
-type SurveyAppearance = {
-  // keep in sync with frontend/src/types.ts -> SurveyAppearance
-  backgroundColor?: string
-  submitButtonColor?: string
-  // deprecate submit button text eventually
-  submitButtonText?: string
-  submitButtonTextColor?: string
-  ratingButtonColor?: string
-  ratingButtonActiveColor?: string
-  autoDisappear?: boolean
-  displayThankYouMessage?: boolean
-  thankYouMessageHeader?: string
-  thankYouMessageDescription?: string
-  thankYouMessageDescriptionContentType?: SurveyQuestionDescriptionContentType
-  thankYouMessageCloseButtonText?: string
-  borderColor?: string
-  position?: SurveyPosition
-  placeholder?: string
-  shuffleQuestions?: boolean
-  surveyPopupDelaySeconds?: number
-  // widget options
-  widgetType?: SurveyWidgetType
-  widgetSelector?: string
-  widgetLabel?: string
-  widgetColor?: string
-}
-
-enum SurveyPosition {
-  Left = 'left',
-  Right = 'right',
-  Center = 'center',
-}
-
-enum SurveyWidgetType {
-  Button = 'button',
-  Tab = 'tab',
-  Selector = 'selector',
-}
-
-enum SurveyType {
-  Popover = 'popover',
-  API = 'api',
-  Widget = 'widget',
-}
-
-type SurveyQuestion = BasicSurveyQuestion | LinkSurveyQuestion | RatingSurveyQuestion | MultipleSurveyQuestion
-
-enum SurveyQuestionDescriptionContentType {
-  Html = 'html',
-  Text = 'text',
-}
-
-type SurveyQuestionBase = {
-  question: string
-  id?: string // TODO: use this for the question id
-  description?: string
-  descriptionContentType?: SurveyQuestionDescriptionContentType
-  optional?: boolean
-  buttonText?: string
-  originalQuestionIndex: number
-  branching?: NextQuestionBranching | EndBranching | ResponseBasedBranching | SpecificQuestionBranching
-}
-
-interface BasicSurveyQuestion extends SurveyQuestionBase {
-  type: SurveyQuestionType.Open
-}
-
-interface LinkSurveyQuestion extends SurveyQuestionBase {
-  type: SurveyQuestionType.Link
-  link?: string
-}
-
-interface RatingSurveyQuestion extends SurveyQuestionBase {
-  type: SurveyQuestionType.Rating
-  display: SurveyRatingDisplay
-  scale: 3 | 5 | 7 | 10
-  lowerBoundLabel: string
-  upperBoundLabel: string
-}
-
-enum SurveyRatingDisplay {
-  Number = 'number',
-  Emoji = 'emoji',
-}
-
-interface MultipleSurveyQuestion extends SurveyQuestionBase {
-  type: SurveyQuestionType.SingleChoice | SurveyQuestionType.MultipleChoice
-  choices: string[]
-  hasOpenChoice?: boolean
-  shuffleOptions?: boolean
-}
-
-enum SurveyQuestionType {
-  Open = 'open',
-  MultipleChoice = 'multiple_choice',
-  SingleChoice = 'single_choice',
-  Rating = 'rating',
-  Link = 'link',
-}
-
-enum SurveyQuestionBranchingType {
-  NextQuestion = 'next_question',
-  End = 'end',
-  ResponseBased = 'response_based',
-  SpecificQuestion = 'specific_question',
-}
-
-type NextQuestionBranching = {
-  type: SurveyQuestionBranchingType.NextQuestion
-}
-
-type EndBranching = {
-  type: SurveyQuestionBranchingType.End
-}
-
-type ResponseBasedBranching = {
-  type: SurveyQuestionBranchingType.ResponseBased
-  responseValues: Record<string, any>
-}
-
-type SpecificQuestionBranching = {
-  type: SurveyQuestionBranchingType.SpecificQuestion
-  index: number
-}
-
-type SurveyResponse = {
-  surveys: Survey[]
-}
-
-enum SurveyMatchType {
-  Regex = 'regex',
-  NotRegex = 'not_regex',
-  Exact = 'exact',
-  IsNot = 'is_not',
-  Icontains = 'icontains',
-  NotIcontains = 'not_icontains',
-}
-
-type Survey = {
-  // Sync this with the backend's SurveyAPISerializer!
-  id: string
-  name: string
-  description?: string
-  type: SurveyType
-  feature_flag_keys?:
-    | {
-        key: string
-        value?: string
-      }[]
-  linked_flag_key?: string
-  targeting_flag_key?: string
-  internal_targeting_flag_key?: string
-  questions: SurveyQuestion[]
-  appearance?: SurveyAppearance
-  conditions?: {
-    url?: string
-    selector?: string
-    seenSurveyWaitPeriodInDays?: number
-    urlMatchType?: SurveyMatchType
-    events?: {
-      repeatedActivation?: boolean
-      values?: {
-        name: string
-      }[]
-    }
-    actions?: {
-      values: SurveyActionType[]
-    }
-    deviceTypes?: string[]
-    deviceTypesMatchType?: SurveyMatchType
-  }
-  start_date?: string
-  end_date?: string
-  current_iteration?: number
-  current_iteration_start_date?: string
-}
-
-type SurveyActionType = {
-  id: number
-  name?: string
-  steps?: ActionStepType[]
-}
-
-/** Sync with plugin-server/src/types.ts */
-enum ActionStepStringMatching {
-  Contains = 'contains',
-  Exact = 'exact',
-  Regex = 'regex',
-}
-
-type ActionStepType = {
-  event?: string
-  selector?: string
-  /** @deprecated Only `selector` should be used now. */
-  tag_name?: string
-  text?: string
-  /** @default StringMatching.Exact */
-  text_matching?: ActionStepStringMatching
-  href?: string
-  /** @default ActionStepStringMatching.Exact */
-  href_matching?: ActionStepStringMatching
-  url?: string
-  /** @default StringMatching.Contains */
-  url_matching?: ActionStepStringMatching
-}
-
 type PostHogCoreOptions = {
     /** PostHog API host, usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com' */
     host?: string;
@@ -317,7 +111,7 @@ type PostHogFetchResponse = {
 type PostHogEventProperties = {
     [key: string]: any;
 };
-interface PostHogRemoteConfig {
+type PostHogRemoteConfig = {
     sessionRecording?: boolean | {
         [key: string]: JsonType;
     };
@@ -329,9 +123,9 @@ interface PostHogRemoteConfig {
      * Indicates if the team has any flags enabled (if not we don't need to load them)
      */
     hasFeatureFlags?: boolean;
-}
+};
 type FeatureFlagValue = string | boolean;
-interface PostHogDecideResponse extends Omit<PostHogRemoteConfig, 'surveys' | 'hasFeatureFlags'> {
+type PostHogDecideResponse = Omit<PostHogRemoteConfig, 'surveys' | 'hasFeatureFlags'> & {
     featureFlags: {
         [key: string]: FeatureFlagValue;
     };
@@ -347,7 +141,7 @@ interface PostHogDecideResponse extends Omit<PostHogRemoteConfig, 'surveys' | 'h
     };
     quotaLimited?: string[];
     requestId?: string;
-}
+};
 /**
  * Creates a type with all properties of T, but makes only K properties required while the rest remain optional.
  *
@@ -404,6 +198,183 @@ type EvaluationReason = {
     code: string | undefined;
     condition_index: number | undefined;
     description: string | undefined;
+};
+type SurveyAppearance = {
+    backgroundColor?: string;
+    submitButtonColor?: string;
+    submitButtonText?: string;
+    submitButtonTextColor?: string;
+    ratingButtonColor?: string;
+    ratingButtonActiveColor?: string;
+    autoDisappear?: boolean;
+    displayThankYouMessage?: boolean;
+    thankYouMessageHeader?: string;
+    thankYouMessageDescription?: string;
+    thankYouMessageDescriptionContentType?: SurveyQuestionDescriptionContentType;
+    thankYouMessageCloseButtonText?: string;
+    borderColor?: string;
+    position?: SurveyPosition;
+    placeholder?: string;
+    shuffleQuestions?: boolean;
+    surveyPopupDelaySeconds?: number;
+    widgetType?: SurveyWidgetType;
+    widgetSelector?: string;
+    widgetLabel?: string;
+    widgetColor?: string;
+};
+declare enum SurveyPosition {
+    Left = "left",
+    Right = "right",
+    Center = "center"
+}
+declare enum SurveyWidgetType {
+    Button = "button",
+    Tab = "tab",
+    Selector = "selector"
+}
+declare enum SurveyType {
+    Popover = "popover",
+    API = "api",
+    Widget = "widget"
+}
+type SurveyQuestion = BasicSurveyQuestion | LinkSurveyQuestion | RatingSurveyQuestion | MultipleSurveyQuestion;
+declare enum SurveyQuestionDescriptionContentType {
+    Html = "html",
+    Text = "text"
+}
+type SurveyQuestionBase = {
+    question: string;
+    id?: string;
+    description?: string;
+    descriptionContentType?: SurveyQuestionDescriptionContentType;
+    optional?: boolean;
+    buttonText?: string;
+    originalQuestionIndex: number;
+    branching?: NextQuestionBranching | EndBranching | ResponseBasedBranching | SpecificQuestionBranching;
+};
+type BasicSurveyQuestion = SurveyQuestionBase & {
+    type: SurveyQuestionType.Open;
+};
+type LinkSurveyQuestion = SurveyQuestionBase & {
+    type: SurveyQuestionType.Link;
+    link?: string;
+};
+type RatingSurveyQuestion = SurveyQuestionBase & {
+    type: SurveyQuestionType.Rating;
+    display: SurveyRatingDisplay;
+    scale: 3 | 5 | 7 | 10;
+    lowerBoundLabel: string;
+    upperBoundLabel: string;
+};
+declare enum SurveyRatingDisplay {
+    Number = "number",
+    Emoji = "emoji"
+}
+type MultipleSurveyQuestion = SurveyQuestionBase & {
+    type: SurveyQuestionType.SingleChoice | SurveyQuestionType.MultipleChoice;
+    choices: string[];
+    hasOpenChoice?: boolean;
+    shuffleOptions?: boolean;
+};
+declare enum SurveyQuestionType {
+    Open = "open",
+    MultipleChoice = "multiple_choice",
+    SingleChoice = "single_choice",
+    Rating = "rating",
+    Link = "link"
+}
+declare enum SurveyQuestionBranchingType {
+    NextQuestion = "next_question",
+    End = "end",
+    ResponseBased = "response_based",
+    SpecificQuestion = "specific_question"
+}
+type NextQuestionBranching = {
+    type: SurveyQuestionBranchingType.NextQuestion;
+};
+type EndBranching = {
+    type: SurveyQuestionBranchingType.End;
+};
+type ResponseBasedBranching = {
+    type: SurveyQuestionBranchingType.ResponseBased;
+    responseValues: Record<string, any>;
+};
+type SpecificQuestionBranching = {
+    type: SurveyQuestionBranchingType.SpecificQuestion;
+    index: number;
+};
+type SurveyResponse = {
+    surveys: Survey[];
+};
+declare enum SurveyMatchType {
+    Regex = "regex",
+    NotRegex = "not_regex",
+    Exact = "exact",
+    IsNot = "is_not",
+    Icontains = "icontains",
+    NotIcontains = "not_icontains"
+}
+type Survey = {
+    id: string;
+    name: string;
+    description?: string;
+    type: SurveyType;
+    feature_flag_keys?: {
+        key: string;
+        value?: string;
+    }[];
+    linked_flag_key?: string;
+    targeting_flag_key?: string;
+    internal_targeting_flag_key?: string;
+    questions: SurveyQuestion[];
+    appearance?: SurveyAppearance;
+    conditions?: {
+        url?: string;
+        selector?: string;
+        seenSurveyWaitPeriodInDays?: number;
+        urlMatchType?: SurveyMatchType;
+        events?: {
+            repeatedActivation?: boolean;
+            values?: {
+                name: string;
+            }[];
+        };
+        actions?: {
+            values: SurveyActionType[];
+        };
+        deviceTypes?: string[];
+        deviceTypesMatchType?: SurveyMatchType;
+    };
+    start_date?: string;
+    end_date?: string;
+    current_iteration?: number;
+    current_iteration_start_date?: string;
+};
+type SurveyActionType = {
+    id: number;
+    name?: string;
+    steps?: ActionStepType[];
+};
+/** Sync with plugin-server/src/types.ts */
+declare enum ActionStepStringMatching {
+    Contains = "contains",
+    Exact = "exact",
+    Regex = "regex"
+}
+type ActionStepType = {
+    event?: string;
+    selector?: string;
+    /** @deprecated Only `selector` should be used now. */
+    tag_name?: string;
+    text?: string;
+    /** @default StringMatching.Exact */
+    text_matching?: ActionStepStringMatching;
+    href?: string;
+    /** @default ActionStepStringMatching.Exact */
+    href_matching?: ActionStepStringMatching;
+    url?: string;
+    /** @default StringMatching.Contains */
+    url_matching?: ActionStepStringMatching;
 };
 
 interface RetriableOptions {

package/lib/index.esm.js

@@ -1,6 +1,6 @@
 import { posix, dirname, sep } from 'node:path';
 
-var version = "4.11.5";
+var version = "4.11.6";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -28,7 +28,66 @@ var PostHogPersistedProperty;
     PostHogPersistedProperty["SurveysSeen"] = "surveys_seen";
     PostHogPersistedProperty["Surveys"] = "surveys";
     PostHogPersistedProperty["RemoteConfig"] = "remote_config";
-})(PostHogPersistedProperty || (PostHogPersistedProperty = {}));
+})(PostHogPersistedProperty || (PostHogPersistedProperty = {}));
+var SurveyPosition;
+(function (SurveyPosition) {
+    SurveyPosition["Left"] = "left";
+    SurveyPosition["Right"] = "right";
+    SurveyPosition["Center"] = "center";
+})(SurveyPosition || (SurveyPosition = {}));
+var SurveyWidgetType;
+(function (SurveyWidgetType) {
+    SurveyWidgetType["Button"] = "button";
+    SurveyWidgetType["Tab"] = "tab";
+    SurveyWidgetType["Selector"] = "selector";
+})(SurveyWidgetType || (SurveyWidgetType = {}));
+var SurveyType;
+(function (SurveyType) {
+    SurveyType["Popover"] = "popover";
+    SurveyType["API"] = "api";
+    SurveyType["Widget"] = "widget";
+})(SurveyType || (SurveyType = {}));
+var SurveyQuestionDescriptionContentType;
+(function (SurveyQuestionDescriptionContentType) {
+    SurveyQuestionDescriptionContentType["Html"] = "html";
+    SurveyQuestionDescriptionContentType["Text"] = "text";
+})(SurveyQuestionDescriptionContentType || (SurveyQuestionDescriptionContentType = {}));
+var SurveyRatingDisplay;
+(function (SurveyRatingDisplay) {
+    SurveyRatingDisplay["Number"] = "number";
+    SurveyRatingDisplay["Emoji"] = "emoji";
+})(SurveyRatingDisplay || (SurveyRatingDisplay = {}));
+var SurveyQuestionType;
+(function (SurveyQuestionType) {
+    SurveyQuestionType["Open"] = "open";
+    SurveyQuestionType["MultipleChoice"] = "multiple_choice";
+    SurveyQuestionType["SingleChoice"] = "single_choice";
+    SurveyQuestionType["Rating"] = "rating";
+    SurveyQuestionType["Link"] = "link";
+})(SurveyQuestionType || (SurveyQuestionType = {}));
+var SurveyQuestionBranchingType;
+(function (SurveyQuestionBranchingType) {
+    SurveyQuestionBranchingType["NextQuestion"] = "next_question";
+    SurveyQuestionBranchingType["End"] = "end";
+    SurveyQuestionBranchingType["ResponseBased"] = "response_based";
+    SurveyQuestionBranchingType["SpecificQuestion"] = "specific_question";
+})(SurveyQuestionBranchingType || (SurveyQuestionBranchingType = {}));
+var SurveyMatchType;
+(function (SurveyMatchType) {
+    SurveyMatchType["Regex"] = "regex";
+    SurveyMatchType["NotRegex"] = "not_regex";
+    SurveyMatchType["Exact"] = "exact";
+    SurveyMatchType["IsNot"] = "is_not";
+    SurveyMatchType["Icontains"] = "icontains";
+    SurveyMatchType["NotIcontains"] = "not_icontains";
+})(SurveyMatchType || (SurveyMatchType = {}));
+/** Sync with plugin-server/src/types.ts */
+var ActionStepStringMatching;
+(function (ActionStepStringMatching) {
+    ActionStepStringMatching["Contains"] = "contains";
+    ActionStepStringMatching["Exact"] = "exact";
+    ActionStepStringMatching["Regex"] = "regex";
+})(ActionStepStringMatching || (ActionStepStringMatching = {}));
 
 const normalizeDecideResponse = (decideResponse) => {
     if ('flags' in decideResponse) {