@knocklabs/client 0.16.4 → 0.17.0

package/src/clients/guide/types.ts

@@ -4,6 +4,9 @@ import { GenericData } from "@knocklabs/types";
 // Fetch guides API
 //
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type Any = any;
+
 export interface StepMessageState {
   id: string;
   seen_at: string | null;
@@ -13,30 +16,37 @@ export interface StepMessageState {
   link_clicked_at: string | null;
 }
 
-export interface GuideStepData {
+export interface GuideStepData<TContent = Any> {
   ref: string;
   schema_key: string;
   schema_semver: string;
   schema_variant_key: string;
   message: StepMessageState;
-  // eslint-disable-next-line
-  content: any;
+  content: TContent;
 }
 
-interface GuideActivationLocationRuleData {
+export interface GuideActivationUrlRuleData {
+  directive: "allow" | "block";
+  variable: "pathname";
+  operator: "equal_to" | "contains";
+  argument: string;
+}
+
+interface GuideActivationUrlPatternData {
   directive: "allow" | "block";
   pathname: string;
 }
 
-export interface GuideData {
+export interface GuideData<TContent = Any> {
   __typename: "Guide";
   channel_id: string;
   id: string;
   key: string;
   type: string;
   semver: string;
-  steps: GuideStepData[];
-  activation_location_rules: GuideActivationLocationRuleData[];
+  steps: GuideStepData<TContent>[];
+  activation_url_rules: GuideActivationUrlRuleData[];
+  activation_url_patterns: GuideActivationUrlPatternData[];
   bypass_global_group_limit: boolean;
   inserted_at: string;
   updated_at: string;
@@ -57,6 +67,7 @@ export type GetGuidesQueryParams = {
   data?: string;
   tenant?: string;
   type?: string;
+  force_all_guides?: boolean;
 };
 
 export type GetGuidesResponse = {
@@ -103,7 +114,8 @@ type SocketEventType =
   | "guide.updated"
   | "guide.removed"
   | "guide_group.added"
-  | "guide_group.updated";
+  | "guide_group.updated"
+  | "guide.live_preview_updated";
 
 type SocketEventPayload<E extends SocketEventType, D> = {
   topic: string;
@@ -136,32 +148,39 @@ export type GuideGroupUpdatedEvent = SocketEventPayload<
   { guide_group: GuideGroupData }
 >;
 
+export type GuideLivePreviewUpdatedEvent = SocketEventPayload<
+  "guide.live_preview_updated",
+  { guide: GuideData; eligible: boolean }
+>;
+
 export type GuideSocketEvent =
   | GuideAddedEvent
   | GuideUpdatedEvent
   | GuideRemovedEvent
   | GuideGroupAddedEvent
-  | GuideGroupUpdatedEvent;
+  | GuideGroupUpdatedEvent
+  | GuideLivePreviewUpdatedEvent;
 
 //
 // Guide client
 //
 
-export interface KnockGuideStep extends GuideStepData {
+export interface KnockGuideStep<TContent = Any>
+  extends GuideStepData<TContent> {
   markAsSeen: () => void;
   markAsInteracted: (params?: { metadata?: GenericData }) => void;
   markAsArchived: () => void;
 }
 
-interface KnockGuideActivationLocationRule
-  extends GuideActivationLocationRuleData {
+export interface KnockGuideActivationUrlPattern
+  extends GuideActivationUrlPatternData {
   pattern: URLPattern;
 }
 
-export interface KnockGuide extends GuideData {
-  steps: KnockGuideStep[];
-  activation_location_rules: KnockGuideActivationLocationRule[];
-  getStep: () => KnockGuideStep | undefined;
+export interface KnockGuide<TContent = Any> extends GuideData<TContent> {
+  steps: KnockGuideStep<TContent>[];
+  activation_url_patterns: KnockGuideActivationUrlPattern[];
+  getStep: () => KnockGuideStep<TContent> | undefined;
 }
 
 type QueryKey = string;
@@ -171,13 +190,20 @@ export type QueryStatus = {
   error?: Error;
 };
 
+export type DebugState = {
+  forcedGuideKey?: string | null;
+  previewSessionId?: string | null;
+};
+
 export type StoreState = {
   guideGroups: GuideGroupData[];
   guideGroupDisplayLogs: Record<GuideGroupData["key"], string>;
   guides: Record<KnockGuide["key"], KnockGuide>;
+  previewGuides: Record<KnockGuide["key"], KnockGuide>;
   queries: Record<QueryKey, QueryStatus>;
   location: string | undefined;
   counter: number;
+  debug: DebugState;
 };
 
 export type QueryFilterParams = Pick<GetGuidesQueryParams, "type">;