@guidelytech/shared 0.0.0-stage → 0.2.0

package/dist/index.js

@@ -0,0 +1,669 @@
+import {
+  MAX_PROPERTY_BYTES,
+  RULE_FIELDS,
+  RULE_OPERATORS,
+  SENSITIVE_PROPERTY_PATTERN,
+  SERVER_ASSISTED_FIELDS,
+  clamp,
+  compare,
+  describeRule,
+  emptyRuleGroup,
+  evaluateRule,
+  evaluateRules,
+  fnv1a,
+  getPath,
+  isPlainObject,
+  isRuleGroup,
+  matchUrlPattern,
+  randomId,
+  rolloutBucket,
+  safeRegExp,
+  sanitizeProperties,
+  slugify,
+  stripOrigin
+} from "./chunk-OFBIZEM5.js";
+
+// src/targeting.ts
+import { z } from "zod";
+var RuleSchema = z.object({
+  id: z.string().min(1),
+  field: z.enum(RULE_FIELDS),
+  key: z.string().max(200).optional(),
+  op: z.enum(RULE_OPERATORS),
+  value: z.union([z.string(), z.number(), z.boolean(), z.array(z.string())]).optional(),
+  negate: z.boolean().optional()
+});
+var RuleGroupSchema = z.lazy(
+  () => z.object({
+    id: z.string().min(1),
+    op: z.enum(["and", "or"]),
+    rules: z.array(z.union([RuleSchema, RuleGroupSchema])).max(100),
+    negate: z.boolean().optional()
+  })
+);
+
+// src/guide.ts
+import { z as z2 } from "zod";
+var GUIDE_KINDS = ["flow", "modal", "tooltip", "banner", "checklist", "survey", "announcement"];
+var GUIDE_STATUSES = ["draft", "published", "paused", "archived"];
+var STEP_TYPES = ["modal", "tooltip", "popover", "spotlight", "hotspot", "banner", "slideout", "checklist", "custom", "survey"];
+var PLACEMENTS = ["top", "top-start", "top-end", "right", "right-start", "right-end", "bottom", "bottom-start", "bottom-end", "left", "left-start", "left-end", "auto"];
+var SELECTOR_KINDS = ["css", "id", "data-attr", "aria", "text", "xpath"];
+var SelectorStrategySchema = z2.object({
+  kind: z2.enum(SELECTOR_KINDS),
+  value: z2.string().min(1).max(1e3),
+  /** Optional human-readable label captured at pick time. */
+  label: z2.string().max(200).optional()
+});
+var TargetSchema = z2.object({
+  /** Ordered strategies; the first one resolving to exactly one element wins. */
+  selectors: z2.array(SelectorStrategySchema).max(10),
+  /** How long to wait for the element before applying fallback. */
+  waitMs: z2.number().int().min(0).max(6e4).default(5e3),
+  /** What to do when the element never shows up. */
+  fallback: z2.enum(["skip", "show_as_modal", "end_guide", "wait"]).default("skip"),
+  /** Scroll the element into view before positioning. */
+  scrollIntoView: z2.boolean().default(true),
+  /** Text snapshot captured at pick time; used for authoring warnings. */
+  textSnapshot: z2.string().max(200).optional()
+});
+var BUTTON_ACTIONS = ["next", "back", "dismiss", "complete", "skip", "url", "start_guide", "event", "open_resource_center", "none"];
+var ButtonSchema = z2.object({
+  id: z2.string().min(1),
+  label: z2.string().min(1).max(80),
+  action: z2.enum(BUTTON_ACTIONS),
+  variant: z2.enum(["primary", "secondary", "ghost", "link"]).default("primary"),
+  /** url for `url`, guide id for `start_guide`, event name for `event`, step id for `next` branch override */
+  value: z2.string().max(2e3).optional(),
+  newTab: z2.boolean().optional()
+});
+var StepBranchSchema = z2.object({
+  id: z2.string(),
+  /** Rule group evaluated against targeting context when leaving the step. */
+  when: RuleGroupSchema,
+  /** Step id to jump to. */
+  goTo: z2.string()
+});
+var ADVANCE_ON = ["button", "element_click", "element_visible", "event", "delay", "any"];
+var StepSchema = z2.object({
+  id: z2.string().min(1).max(64),
+  type: z2.enum(STEP_TYPES),
+  title: z2.string().max(200).default(""),
+  /** Sanitized HTML body (links, images, lists, formatting). */
+  body: z2.string().max(2e4).default(""),
+  imageUrl: z2.string().url().max(2e3).optional().or(z2.literal("")),
+  buttons: z2.array(ButtonSchema).max(6).default([]),
+  target: TargetSchema.optional(),
+  placement: z2.enum(PLACEMENTS).default("auto"),
+  /** Pixel offset between anchor and card. */
+  offset: z2.number().int().min(0).max(64).default(10),
+  showOverlay: z2.boolean().default(false),
+  showProgress: z2.boolean().default(true),
+  showClose: z2.boolean().default(true),
+  dismissOnOutsideClick: z2.boolean().default(false),
+  /** Highlight padding for spotlight. */
+  spotlightPadding: z2.number().int().min(0).max(64).default(6),
+  /** Banner/slideout position. */
+  position: z2.enum(["top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right", "center"]).default("bottom-right"),
+  /** URL pattern this step belongs to (for multi-page flows). */
+  url: z2.string().max(500).optional(),
+  /** Automatic advancement. */
+  advanceOn: z2.enum(ADVANCE_ON).default("button"),
+  advanceValue: z2.string().max(500).optional(),
+  advanceDelayMs: z2.number().int().min(0).max(6e5).optional(),
+  branches: z2.array(StepBranchSchema).max(10).default([]),
+  width: z2.number().int().min(200).max(900).optional(),
+  /** Step-level targeting: skip step when rules do not match. */
+  targeting: RuleGroupSchema.optional(),
+  /** Hotspot pulse dot settings. */
+  hotspot: z2.object({ size: z2.number().int().min(8).max(40).default(14), pulse: z2.boolean().default(true), openOn: z2.enum(["click", "hover"]).default("click") }).optional(),
+  /** Custom step: arbitrary sanitized HTML with no chrome. */
+  customHtml: z2.string().max(5e4).optional()
+});
+var TRIGGER_TYPES = ["page_load", "url_match", "event", "element_click", "element_visible", "manual", "delay", "after_guide", "segment_enter"];
+var TriggerSchema = z2.object({
+  type: z2.enum(TRIGGER_TYPES).default("page_load"),
+  /** url pattern, event name, selector, guide id, audience id depending on type */
+  value: z2.string().max(1e3).optional(),
+  delayMs: z2.number().int().min(0).max(6e5).default(0),
+  /** Also require URL to match this pattern (any trigger). */
+  urlPattern: z2.string().max(500).optional()
+});
+var FrequencySchema = z2.object({
+  mode: z2.enum(["once", "once_per_session", "every_time", "interval"]).default("once"),
+  intervalHours: z2.number().int().min(1).max(8760).optional(),
+  maxImpressions: z2.number().int().min(1).max(1e3).optional(),
+  /** Hours to wait after dismissal before eligible again (when not `once`). */
+  cooldownHours: z2.number().int().min(0).max(8760).default(0),
+  /** Lower number wins when multiple guides qualify. */
+  priority: z2.number().int().min(0).max(1e3).default(100),
+  /** Guide ids that must not be active at the same time. */
+  mutuallyExclusiveWith: z2.array(z2.string()).max(50).default([]),
+  /** Re-show if dismissed (otherwise dismissal counts as completion for frequency). */
+  reshowAfterDismiss: z2.boolean().default(false)
+});
+var AppearanceSchema = z2.object({
+  theme: z2.enum(["light", "dark", "auto"]).default("auto"),
+  primaryColor: z2.string().regex(/^#[0-9a-fA-F]{6}$/).optional(),
+  backgroundColor: z2.string().regex(/^#[0-9a-fA-F]{6}$/).optional(),
+  textColor: z2.string().regex(/^#[0-9a-fA-F]{6}$/).optional(),
+  borderRadius: z2.number().int().min(0).max(32).optional(),
+  fontFamily: z2.string().max(200).optional(),
+  overlayOpacity: z2.number().min(0).max(1).optional(),
+  zIndex: z2.number().int().min(1).max(2147483647).optional(),
+  preset: z2.string().max(50).optional(),
+  animation: z2.enum(["fade", "slide", "none"]).default("fade")
+});
+var ChecklistTaskSchema = z2.object({
+  id: z2.string().min(1),
+  title: z2.string().min(1).max(200),
+  description: z2.string().max(2e3).default(""),
+  /** How the task completes. */
+  completion: z2.enum(["manual", "event", "guide_completed", "url_visited", "click"]).default("manual"),
+  completionValue: z2.string().max(500).optional(),
+  /** Optional action when clicking the task. */
+  action: z2.enum(["none", "start_guide", "url", "event"]).default("none"),
+  actionValue: z2.string().max(2e3).optional(),
+  required: z2.boolean().default(true)
+});
+var ChecklistConfigSchema = z2.object({
+  tasks: z2.array(ChecklistTaskSchema).min(1).max(30),
+  ordered: z2.boolean().default(false),
+  launcherLabel: z2.string().max(60).default("Getting started"),
+  position: z2.enum(["bottom-right", "bottom-left"]).default("bottom-right"),
+  completionTitle: z2.string().max(200).default("You're all set!"),
+  completionBody: z2.string().max(2e3).default(""),
+  autoOpen: z2.boolean().default(true),
+  dismissible: z2.boolean().default(true)
+});
+var SURVEY_QUESTION_TYPES = ["nps", "csat", "thumbs", "single_choice", "multiple_choice", "text", "rating"];
+var SurveyQuestionSchema = z2.object({
+  id: z2.string().min(1),
+  type: z2.enum(SURVEY_QUESTION_TYPES),
+  title: z2.string().min(1).max(500),
+  description: z2.string().max(1e3).default(""),
+  required: z2.boolean().default(true),
+  options: z2.array(z2.object({ id: z2.string(), label: z2.string().max(200) })).max(20).default([]),
+  scaleMax: z2.number().int().min(2).max(10).optional(),
+  lowLabel: z2.string().max(60).optional(),
+  highLabel: z2.string().max(60).optional(),
+  placeholder: z2.string().max(200).optional(),
+  /** Conditional follow-up: show only when a previous answer matches. */
+  showWhen: z2.object({ questionId: z2.string(), op: z2.enum(["equals", "lte", "gte", "in"]), value: z2.union([z2.string(), z2.number(), z2.array(z2.string())]) }).optional()
+});
+var SurveyConfigSchema = z2.object({
+  questions: z2.array(SurveyQuestionSchema).min(1).max(20),
+  thankYouTitle: z2.string().max(200).default("Thanks for your feedback!"),
+  thankYouBody: z2.string().max(2e3).default(""),
+  position: z2.enum(["bottom-right", "bottom-left", "center"]).default("bottom-right"),
+  startAt: z2.string().datetime().optional(),
+  endAt: z2.string().datetime().optional()
+});
+var GuideConfigSchema = z2.object({
+  steps: z2.array(StepSchema).max(50).default([]),
+  targeting: RuleGroupSchema.default(() => emptyRuleGroup()),
+  trigger: TriggerSchema.default({}),
+  frequency: FrequencySchema.default({}),
+  appearance: AppearanceSchema.default({}),
+  checklist: ChecklistConfigSchema.optional(),
+  survey: SurveyConfigSchema.optional(),
+  /** Restrict guide to url pattern(s) (applied before trigger). */
+  urlPatterns: z2.array(z2.string().max(500)).max(20).default([])
+});
+function defaultGuideConfig(kind) {
+  return GuideConfigSchema.parse({
+    steps: kind === "checklist" || kind === "survey" ? [] : [defaultStep(kind === "flow" ? "tooltip" : kind === "banner" ? "banner" : kind === "tooltip" ? "tooltip" : "modal")],
+    checklist: kind === "checklist" ? { tasks: [{ id: "task-1", title: "Complete your profile" }] } : void 0,
+    survey: kind === "survey" ? { questions: [{ id: "q1", type: "nps", title: "How likely are you to recommend us to a friend?" }] } : void 0,
+    trigger: kind === "checklist" ? { type: "page_load" } : {}
+  });
+}
+var stepCounter = 0;
+function defaultStep(type, overrides = {}) {
+  stepCounter += 1;
+  const base = {
+    id: `step-${Date.now().toString(36)}-${stepCounter}`,
+    type,
+    title: type === "modal" ? "Welcome!" : "Step title",
+    body: "<p>Describe what the user should do here.</p>",
+    buttons: [
+      { id: "btn-back", label: "Back", action: "back", variant: "ghost" },
+      { id: "btn-next", label: "Next", action: "next", variant: "primary" }
+    ],
+    placement: type === "banner" ? "top" : "auto",
+    showOverlay: type === "modal" || type === "spotlight",
+    ...overrides
+  };
+  if (["tooltip", "popover", "spotlight", "hotspot"].includes(type) && !base.target) {
+    base.target = { selectors: [], waitMs: 5e3, fallback: "skip", scrollIntoView: true };
+  }
+  return StepSchema.parse(base);
+}
+function visibleButtons(step, canGoBack) {
+  return canGoBack ? step.buttons : step.buttons.filter((b) => b.action !== "back");
+}
+function validateGuideConfig(kind, config) {
+  const issues = [];
+  if (kind === "checklist") {
+    if (!config.checklist || config.checklist.tasks.length === 0) issues.push({ level: "error", message: "Checklist needs at least one task." });
+  } else if (kind === "survey") {
+    if (!config.survey || config.survey.questions.length === 0) issues.push({ level: "error", message: "Survey needs at least one question." });
+    config.survey?.questions.forEach((q) => {
+      if ((q.type === "single_choice" || q.type === "multiple_choice") && q.options.length < 2) issues.push({ level: "error", message: `Question "${q.title}" needs at least two options.` });
+    });
+  } else {
+    if (config.steps.length === 0) issues.push({ level: "error", message: "Add at least one step." });
+  }
+  const ids = /* @__PURE__ */ new Set();
+  config.steps.forEach((step, i) => {
+    if (ids.has(step.id)) issues.push({ level: "error", stepId: step.id, message: `Duplicate step id "${step.id}".` });
+    ids.add(step.id);
+    const anchored = ["tooltip", "popover", "spotlight", "hotspot"].includes(step.type);
+    if (anchored && (!step.target || step.target.selectors.length === 0)) issues.push({ level: "error", stepId: step.id, message: `Step ${i + 1} (${step.type}) needs a target element.` });
+    if (!step.title && !step.body && step.type !== "custom") issues.push({ level: "warning", stepId: step.id, message: `Step ${i + 1} has no title or body.` });
+    if (step.buttons.length === 0 && step.advanceOn === "button" && step.type !== "hotspot" && step.type !== "custom") issues.push({ level: "warning", stepId: step.id, message: `Step ${i + 1} has no buttons and advances on button; users can only close it.` });
+    step.buttons.forEach((b) => {
+      if (b.action === "url" && !/^https?:\/\//i.test(b.value || "") && !(b.value || "").startsWith("/")) issues.push({ level: "error", stepId: step.id, message: `Button "${b.label}" needs an http(s) or relative URL.` });
+      if (b.action === "start_guide" && !b.value) issues.push({ level: "error", stepId: step.id, message: `Button "${b.label}" needs a guide to start.` });
+    });
+    step.branches.forEach((br) => {
+      if (!ids.has(br.goTo) && !config.steps.some((s) => s.id === br.goTo)) issues.push({ level: "error", stepId: step.id, message: `Branch points to unknown step "${br.goTo}".` });
+    });
+  });
+  if (config.trigger.type === "event" && !config.trigger.value) issues.push({ level: "error", message: "Event trigger needs an event name." });
+  if (config.trigger.type === "element_click" && !config.trigger.value) issues.push({ level: "error", message: "Element click trigger needs a selector." });
+  if (config.trigger.type === "url_match" && !config.trigger.value) issues.push({ level: "error", message: "URL trigger needs a pattern." });
+  if (config.frequency.mode === "interval" && !config.frequency.intervalHours) issues.push({ level: "error", message: "Interval frequency needs an interval in hours." });
+  return issues;
+}
+var ProjectThemeSchema = z2.object({
+  primaryColor: z2.string().regex(/^#[0-9a-fA-F]{6}$/).default("#4f46e5"),
+  backgroundColor: z2.string().regex(/^#[0-9a-fA-F]{6}$/).default("#ffffff"),
+  textColor: z2.string().regex(/^#[0-9a-fA-F]{6}$/).default("#111827"),
+  borderRadius: z2.number().int().min(0).max(32).default(12),
+  fontFamily: z2.string().max(200).default("Inter, system-ui, -apple-system, sans-serif"),
+  logoUrl: z2.string().max(2e3).optional(),
+  brandName: z2.string().max(100).optional()
+});
+
+// src/events.ts
+import { z as z3 } from "zod";
+var EVENT_NAMES = [
+  "guide_viewed",
+  "guide_started",
+  "step_viewed",
+  "step_completed",
+  "guide_completed",
+  "guide_skipped",
+  "guide_dismissed",
+  "guide_abandoned",
+  "checklist_task_completed",
+  "checklist_completed",
+  "checklist_dismissed",
+  "survey_displayed",
+  "survey_submitted",
+  "survey_dismissed",
+  "resource_center_opened",
+  "article_viewed",
+  "messenger_opened",
+  "conversation_started",
+  "conversation_handed_off",
+  "scout_answered",
+  "custom",
+  "page_view",
+  "identify"
+];
+var GUIDE_LIFECYCLE_EVENTS = ["guide_viewed", "guide_started", "step_viewed", "step_completed", "guide_completed", "guide_skipped", "guide_dismissed", "guide_abandoned"];
+var SdkEventSchema = z3.object({
+  eventId: z3.string().min(8).max(64),
+  name: z3.enum(EVENT_NAMES),
+  /** For `custom` events: the application-defined name. */
+  customName: z3.string().min(1).max(120).optional(),
+  occurredAt: z3.string().datetime({ offset: true }),
+  anonymousId: z3.string().min(1).max(128),
+  userId: z3.string().max(256).optional().nullable(),
+  accountId: z3.string().max(256).optional().nullable(),
+  sessionId: z3.string().max(128).optional(),
+  guideId: z3.string().max(64).optional(),
+  guideVersion: z3.number().int().optional(),
+  stepId: z3.string().max(64).optional(),
+  stepIndex: z3.number().int().min(0).optional(),
+  url: z3.string().max(2e3).optional(),
+  properties: z3.record(z3.unknown()).optional()
+});
+var EventBatchSchema = z3.object({
+  events: z3.array(SdkEventSchema).min(1).max(50),
+  sentAt: z3.string().datetime({ offset: true }).optional(),
+  sdk: z3.object({ name: z3.string().max(60), version: z3.string().max(30) }).optional()
+});
+
+// src/sdk-api.ts
+import { z as z4 } from "zod";
+var IdentifyRequestSchema = z4.object({
+  anonymousId: z4.string().min(1).max(128),
+  userId: z4.string().min(1).max(256).optional().nullable(),
+  traits: z4.record(z4.unknown()).optional(),
+  account: z4.object({ id: z4.string().min(1).max(256), traits: z4.record(z4.unknown()).optional() }).optional().nullable(),
+  sessionId: z4.string().max(128).optional(),
+  url: z4.string().max(2e3).optional()
+});
+var ChecklistProgressRequestSchema = z4.object({
+  anonymousId: z4.string().min(1).max(128),
+  userId: z4.string().max(256).optional().nullable(),
+  guideVersion: z4.number().int().optional(),
+  completedTaskIds: z4.array(z4.string().max(64)).max(100),
+  dismissed: z4.boolean().optional(),
+  completed: z4.boolean().optional()
+});
+var SurveyResponseRequestSchema = z4.object({
+  anonymousId: z4.string().min(1).max(128),
+  userId: z4.string().max(256).optional().nullable(),
+  accountId: z4.string().max(256).optional().nullable(),
+  guideVersion: z4.number().int(),
+  answers: z4.record(z4.union([z4.string().max(5e3), z4.number(), z4.boolean(), z4.array(z4.string().max(500)).max(50)])),
+  responseId: z4.string().min(8).max(64)
+});
+var GuideStateUpdateSchema = z4.object({
+  anonymousId: z4.string().min(1).max(128),
+  userId: z4.string().max(256).optional().nullable(),
+  updates: z4.array(
+    z4.object({
+      guideId: z4.string(),
+      impression: z4.boolean().optional(),
+      completed: z4.boolean().optional(),
+      dismissed: z4.boolean().optional()
+    })
+  ).max(50)
+});
+var AuthoringPickSchema = z4.object({
+  stepId: z4.string().max(64).optional(),
+  selectors: z4.array(z4.object({ kind: z4.string(), value: z4.string().max(1e3), label: z4.string().max(200).optional() })).max(10),
+  textSnapshot: z4.string().max(200).optional(),
+  url: z4.string().max(2e3).optional(),
+  rect: z4.object({ x: z4.number(), y: z4.number(), width: z4.number(), height: z4.number() }).optional()
+});
+var PublishedGuideSchema = z4.object({
+  id: z4.string(),
+  key: z4.string(),
+  name: z4.string(),
+  kind: z4.string(),
+  version: z4.number(),
+  config: GuideConfigSchema,
+  publishedAt: z4.string()
+});
+
+// src/messenger.ts
+import { z as z5 } from "zod";
+var MESSAGE_AUTHORS = ["user", "scout", "agent", "system"];
+var MAX_MESSAGE_LENGTH = 4e3;
+var messageText = z5.string().trim().min(1).max(MAX_MESSAGE_LENGTH);
+var StartConversationSchema = z5.object({
+  anonymousId: z5.string().min(1).max(128),
+  userId: z5.string().max(256).optional().nullable(),
+  message: messageText,
+  pageUrl: z5.string().max(2e3).optional()
+});
+var ConversationLookupSchema = z5.object({
+  tokens: z5.array(z5.string().min(16).max(128)).max(50)
+});
+var PostMessageSchema = z5.object({ message: messageText });
+var ConversationRatingSchema = z5.object({
+  rating: z5.number().int().min(1).max(5),
+  comment: z5.string().max(1e3).optional()
+});
+
+// src/templates.ts
+var nav = (opts = {}) => [
+  ...opts.first ? [] : [{ id: "back", label: "Back", action: "back", variant: "ghost" }],
+  opts.last ? { id: "done", label: "Finish", action: "complete", variant: "primary" } : { id: "next", label: "Next", action: "next", variant: "primary" }
+];
+var GUIDE_TEMPLATES = [
+  {
+    id: "new-user-onboarding",
+    name: "New-user onboarding tour",
+    description: "A welcome modal followed by three anchored steps that introduce the main navigation.",
+    kind: "flow",
+    category: "onboarding",
+    config: {
+      steps: [
+        { id: "welcome", type: "modal", title: "Welcome aboard \u{1F44B}", body: "<p>We'll show you around in under a minute. You can skip at any time.</p>", showOverlay: true, buttons: [{ id: "skip", label: "Skip tour", action: "dismiss", variant: "ghost" }, { id: "start", label: "Show me around", action: "next" }] },
+        { id: "nav", type: "tooltip", title: "Your navigation", body: "<p>Everything lives in the sidebar. Switch between dashboards, contacts and settings here.</p>", target: { selectors: [{ kind: "data-attr", value: "[data-tour='sidebar']" }], waitMs: 5e3, fallback: "skip", scrollIntoView: true }, placement: "right", buttons: nav() },
+        { id: "create", type: "spotlight", title: "Create your first record", body: "<p>Use the primary button to add something new. We'll highlight it for you.</p>", target: { selectors: [{ kind: "data-attr", value: "[data-tour='primary-action']" }], waitMs: 5e3, fallback: "skip", scrollIntoView: true }, placement: "bottom", showOverlay: true, buttons: nav() },
+        { id: "help", type: "tooltip", title: "Need help later?", body: "<p>Open the help menu any time to replay this tour or browse the resource center.</p>", target: { selectors: [{ kind: "data-attr", value: "[data-tour='help']" }], waitMs: 5e3, fallback: "skip", scrollIntoView: true }, placement: "bottom", buttons: nav({ last: true }) }
+      ],
+      trigger: { type: "page_load" },
+      frequency: { mode: "once", priority: 10 },
+      targeting: { id: "root", op: "and", rules: [{ id: "r1", field: "visitor.firstVisit", op: "is_true" }] }
+    }
+  },
+  {
+    id: "feature-discovery",
+    name: "First-time feature discovery",
+    description: "A hotspot that draws attention to a new capability and expands into a tooltip.",
+    kind: "tooltip",
+    category: "feature",
+    config: {
+      steps: [{ id: "hotspot", type: "hotspot", title: "New: smart filters", body: "<p>Filters now understand natural language. Try <em>\u201Cdeals closing this month\u201D</em>.</p>", target: { selectors: [{ kind: "data-attr", value: "[data-tour='filters']" }], waitMs: 8e3, fallback: "skip", scrollIntoView: true }, placement: "bottom", buttons: [{ id: "got-it", label: "Got it", action: "complete" }], hotspot: { size: 14, pulse: true, openOn: "click" }, showProgress: false }],
+      trigger: { type: "element_visible", value: "[data-tour='filters']" },
+      frequency: { mode: "once", maxImpressions: 3, priority: 50 }
+    }
+  },
+  {
+    id: "setup-wizard",
+    name: "Setup wizard",
+    description: "Multi-step modal wizard that walks a new admin through initial configuration with branching.",
+    kind: "flow",
+    category: "setup",
+    config: {
+      steps: [
+        { id: "intro", type: "modal", title: "Let's set up your workspace", body: "<p>Three quick steps: invite your team, connect a data source, and choose a plan.</p>", showOverlay: true, buttons: [{ id: "later", label: "Later", action: "dismiss", variant: "ghost" }, { id: "go", label: "Start setup", action: "next" }] },
+        { id: "team", type: "popover", title: "Invite teammates", body: "<p>Guidely works best with your whole team. Add a few emails here.</p>", target: { selectors: [{ kind: "data-attr", value: "[data-tour='invite']" }], waitMs: 5e3, fallback: "show_as_modal", scrollIntoView: true }, buttons: nav() },
+        { id: "data", type: "popover", title: "Connect a data source", body: "<p>Import contacts from a CSV or connect your CRM.</p>", target: { selectors: [{ kind: "data-attr", value: "[data-tour='import']" }], waitMs: 5e3, fallback: "show_as_modal", scrollIntoView: true }, buttons: nav() },
+        { id: "done", type: "modal", title: "You're ready \u{1F389}", body: "<p>That's it. Explore the dashboard, and open the help menu if you get stuck.</p>", showOverlay: true, buttons: nav({ last: true }) }
+      ],
+      trigger: { type: "page_load", urlPattern: "/dashboard" },
+      frequency: { mode: "once", priority: 20 },
+      targeting: { id: "root", op: "and", rules: [{ id: "r1", field: "user.role", op: "equals", value: "admin" }] }
+    }
+  },
+  {
+    id: "form-completion",
+    name: "Form completion helper",
+    description: "Tooltips that advance as the user fills out each field of a form.",
+    kind: "flow",
+    category: "forms",
+    config: {
+      steps: [
+        { id: "name", type: "tooltip", title: "Name the contact", body: "<p>Use their full name so search works well.</p>", target: { selectors: [{ kind: "css", value: "input[name='name']" }], waitMs: 5e3, fallback: "skip", scrollIntoView: true }, placement: "right", advanceOn: "element_click", advanceValue: "input[name='email']", buttons: [] },
+        { id: "email", type: "tooltip", title: "Add an email", body: "<p>We'll use it for sequences and reminders.</p>", target: { selectors: [{ kind: "css", value: "input[name='email']" }], waitMs: 5e3, fallback: "skip", scrollIntoView: true }, placement: "right", buttons: nav() },
+        { id: "save", type: "spotlight", title: "Save", body: "<p>Hit save, and your contact appears in the list.</p>", target: { selectors: [{ kind: "css", value: "button[type='submit']" }], waitMs: 5e3, fallback: "skip", scrollIntoView: true }, placement: "top", showOverlay: true, buttons: nav({ last: true }) }
+      ],
+      trigger: { type: "url_match", value: "/contacts/new" },
+      frequency: { mode: "once", priority: 40 }
+    }
+  },
+  {
+    id: "workflow-walkthrough",
+    name: "Complex workflow walkthrough",
+    description: "A multi-page flow that follows the user across routes with URL-aware steps.",
+    kind: "flow",
+    category: "onboarding",
+    config: {
+      steps: [
+        { id: "start", type: "modal", title: "Close your first deal", body: "<p>We'll go from pipeline to closed-won in four steps.</p>", showOverlay: true, buttons: [{ id: "skip", label: "Not now", action: "dismiss", variant: "ghost" }, { id: "next", label: "Let's go", action: "next" }] },
+        { id: "pipeline", type: "tooltip", title: "Open the pipeline", body: "<p>Click here to see your deals by stage.</p>", url: "/dashboard", target: { selectors: [{ kind: "data-attr", value: "[data-tour='nav-deals']" }], waitMs: 5e3, fallback: "skip", scrollIntoView: true }, placement: "right", advanceOn: "element_click", advanceValue: "[data-tour='nav-deals']", buttons: [] },
+        { id: "drag", type: "spotlight", title: "Move a deal", body: "<p>Drag a card to the next stage, or use the stage menu.</p>", url: "/deals", target: { selectors: [{ kind: "data-attr", value: "[data-tour='deal-card']" }], waitMs: 8e3, fallback: "skip", scrollIntoView: true }, placement: "bottom", showOverlay: true, buttons: nav() },
+        { id: "won", type: "tooltip", title: "Mark as won", body: "<p>When it closes, mark it won to update your forecast.</p>", url: "/deals", target: { selectors: [{ kind: "data-attr", value: "[data-tour='mark-won']" }], waitMs: 8e3, fallback: "skip", scrollIntoView: true }, placement: "left", buttons: nav({ last: true }) }
+      ],
+      trigger: { type: "manual" },
+      frequency: { mode: "every_time", priority: 30 }
+    }
+  },
+  {
+    id: "feature-announcement",
+    name: "New feature announcement",
+    description: "A centered modal with an image announcing a new capability.",
+    kind: "announcement",
+    category: "announcement",
+    config: {
+      steps: [{ id: "announce", type: "modal", title: "Introducing Reports 2.0", body: "<p>Build custom reports with drag-and-drop metrics, scheduled emails and shareable links.</p><ul><li>12 new chart types</li><li>Export to CSV and PDF</li></ul>", imageUrl: "https://images.unsplash.com/photo-1551288049-bebda4e38f71?w=800&q=60", showOverlay: true, buttons: [{ id: "later", label: "Maybe later", action: "dismiss", variant: "ghost" }, { id: "try", label: "Try it now", action: "url", value: "/reports" }], showProgress: false }],
+      trigger: { type: "page_load", delayMs: 1500 },
+      frequency: { mode: "once", priority: 60 }
+    }
+  },
+  {
+    id: "contextual-tooltip",
+    name: "Contextual tooltip",
+    description: "A single tooltip that appears when a specific element becomes visible.",
+    kind: "tooltip",
+    category: "help",
+    config: {
+      steps: [{ id: "tip", type: "tooltip", title: "Pro tip", body: "<p>Press <strong>\u2318K</strong> to jump anywhere.</p>", target: { selectors: [{ kind: "data-attr", value: "[data-tour='search']" }], waitMs: 5e3, fallback: "skip", scrollIntoView: true }, placement: "bottom", buttons: [{ id: "ok", label: "Got it", action: "complete" }], showProgress: false }],
+      trigger: { type: "element_visible", value: "[data-tour='search']", delayMs: 500 },
+      frequency: { mode: "once", priority: 80 }
+    }
+  },
+  {
+    id: "product-update-banner",
+    name: "Product update notification",
+    description: "A dismissible top banner linking to release notes.",
+    kind: "banner",
+    category: "announcement",
+    config: {
+      steps: [{ id: "banner", type: "banner", title: "", body: "<p><strong>Scheduled maintenance</strong> on Saturday 02:00\u201303:00 UTC. <a href='/status'>Read more</a>.</p>", position: "top", placement: "top", buttons: [{ id: "dismiss", label: "Dismiss", action: "dismiss", variant: "ghost" }], showProgress: false }],
+      trigger: { type: "page_load" },
+      frequency: { mode: "once_per_session", priority: 90 }
+    }
+  },
+  {
+    id: "onboarding-checklist",
+    name: "User onboarding checklist",
+    description: "A persistent checklist with four tasks that complete automatically from events.",
+    kind: "checklist",
+    category: "onboarding",
+    config: {
+      steps: [],
+      checklist: {
+        tasks: [
+          { id: "profile", title: "Complete your profile", description: "Add a photo and your role.", completion: "event", completionValue: "profile_completed", action: "url", actionValue: "/settings/profile" },
+          { id: "contact", title: "Add your first contact", description: "Import or create a contact.", completion: "event", completionValue: "contact_created", action: "url", actionValue: "/contacts/new" },
+          { id: "deal", title: "Create a deal", description: "Track your first opportunity.", completion: "event", completionValue: "deal_created", action: "url", actionValue: "/deals" },
+          { id: "tour", title: "Take the product tour", description: "A 60-second walkthrough.", completion: "guide_completed", completionValue: "new-user-onboarding", action: "start_guide", actionValue: "new-user-onboarding", required: false }
+        ],
+        ordered: false,
+        launcherLabel: "Getting started",
+        position: "bottom-right",
+        completionTitle: "You're all set! \u{1F389}",
+        completionBody: "You've completed onboarding. Explore the rest of the app at your own pace.",
+        autoOpen: true,
+        dismissible: true
+      },
+      trigger: { type: "page_load" },
+      frequency: { mode: "every_time", priority: 200 }
+    }
+  },
+  {
+    id: "nps-survey",
+    name: "NPS survey",
+    description: "Net Promoter Score with a conditional follow-up question.",
+    kind: "survey",
+    category: "feedback",
+    config: {
+      steps: [],
+      survey: {
+        questions: [
+          { id: "nps", type: "nps", title: "How likely are you to recommend us to a colleague?", lowLabel: "Not likely", highLabel: "Very likely" },
+          { id: "why-low", type: "text", title: "What could we do better?", required: false, placeholder: "Tell us more\u2026", showWhen: { questionId: "nps", op: "lte", value: 6 } },
+          { id: "why-high", type: "text", title: "What do you like most?", required: false, placeholder: "Tell us more\u2026", showWhen: { questionId: "nps", op: "gte", value: 9 } }
+        ],
+        position: "bottom-right"
+      },
+      trigger: { type: "page_load", delayMs: 5e3 },
+      frequency: { mode: "interval", intervalHours: 2160, priority: 150 },
+      targeting: { id: "root", op: "and", rules: [{ id: "r1", field: "visitor.returning", op: "is_true" }] }
+    }
+  }
+];
+function templateConfig(id) {
+  const t = GUIDE_TEMPLATES.find((x) => x.id === id);
+  if (!t) return null;
+  return { template: t, config: GuideConfigSchema.parse(t.config) };
+}
+
+// src/index.ts
+var SDK_API_VERSION = "v1";
+var SHARED_VERSION = "0.2.0";
+export {
+  ADVANCE_ON,
+  AppearanceSchema,
+  AuthoringPickSchema,
+  BUTTON_ACTIONS,
+  ButtonSchema,
+  ChecklistConfigSchema,
+  ChecklistProgressRequestSchema,
+  ChecklistTaskSchema,
+  ConversationLookupSchema,
+  ConversationRatingSchema,
+  EVENT_NAMES,
+  EventBatchSchema,
+  FrequencySchema,
+  GUIDE_KINDS,
+  GUIDE_LIFECYCLE_EVENTS,
+  GUIDE_STATUSES,
+  GUIDE_TEMPLATES,
+  GuideConfigSchema,
+  GuideStateUpdateSchema,
+  IdentifyRequestSchema,
+  MAX_MESSAGE_LENGTH,
+  MAX_PROPERTY_BYTES,
+  MESSAGE_AUTHORS,
+  PLACEMENTS,
+  PostMessageSchema,
+  ProjectThemeSchema,
+  PublishedGuideSchema,
+  RULE_FIELDS,
+  RULE_OPERATORS,
+  RuleGroupSchema,
+  RuleSchema,
+  SDK_API_VERSION,
+  SELECTOR_KINDS,
+  SENSITIVE_PROPERTY_PATTERN,
+  SERVER_ASSISTED_FIELDS,
+  SHARED_VERSION,
+  STEP_TYPES,
+  SURVEY_QUESTION_TYPES,
+  SdkEventSchema,
+  SelectorStrategySchema,
+  StartConversationSchema,
+  StepBranchSchema,
+  StepSchema,
+  SurveyConfigSchema,
+  SurveyQuestionSchema,
+  SurveyResponseRequestSchema,
+  TRIGGER_TYPES,
+  TargetSchema,
+  TriggerSchema,
+  clamp,
+  compare,
+  defaultGuideConfig,
+  defaultStep,
+  describeRule,
+  emptyRuleGroup,
+  evaluateRule,
+  evaluateRules,
+  fnv1a,
+  getPath,
+  isPlainObject,
+  isRuleGroup,
+  matchUrlPattern,
+  randomId,
+  rolloutBucket,
+  safeRegExp,
+  sanitizeProperties,
+  slugify,
+  stripOrigin,
+  templateConfig,
+  validateGuideConfig,
+  visibleButtons
+};
+//# sourceMappingURL=index.js.map