@guidelytech/shared 0.2.0 → 0.4.0

package/dist/index.js

@@ -1,27 +1,49 @@
 import {
+  DEFAULT_PLATFORMS,
+  GUIDELY_ID_ATTRIBUTE,
   MAX_PROPERTY_BYTES,
+  MAX_STACK_FRAMES,
+  NETWORK_PLUGIN,
+  PLATFORMS,
   RULE_FIELDS,
   RULE_OPERATORS,
+  SENSITIVE_HEADER_PATTERN,
+  SENSITIVE_PARAM_PATTERN,
   SENSITIVE_PROPERTY_PATTERN,
   SERVER_ASSISTED_FIELDS,
+  SOURCEMAP_MAX_FILES_PER_UPLOAD,
+  SOURCEMAP_MAX_FILE_BYTES,
+  WS_MAX_MESSAGES_PER_SOCKET,
+  WS_MAX_MESSAGE_BYTES,
   clamp,
   compare,
+  compareVersions,
   describeRule,
   emptyRuleGroup,
   evaluateRule,
   evaluateRules,
+  fingerprintError,
   fnv1a,
   getPath,
+  guidePlatforms,
+  guidelyIdFromSelector,
+  isChecklistComplete,
   isPlainObject,
+  isQuestionVisible,
   isRuleGroup,
   matchUrlPattern,
+  normalizeErrorMessage,
+  normalizeFrameFile,
+  parseStack,
   randomId,
   rolloutBucket,
   safeRegExp,
   sanitizeProperties,
+  screenPath,
   slugify,
-  stripOrigin
-} from "./chunk-OFBIZEM5.js";
+  stripOrigin,
+  supportsPlatform
+} from "./chunk-QUKMOTT4.js";
 
 // src/targeting.ts
 import { z } from "zod";
@@ -48,7 +70,7 @@ var GUIDE_KINDS = ["flow", "modal", "tooltip", "banner", "checklist", "survey",
 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 SELECTOR_KINDS = ["css", "id", "data-attr", "aria", "text", "xpath", "guidely-id"];
 var SelectorStrategySchema = z2.object({
   kind: z2.enum(SELECTOR_KINDS),
   value: z2.string().min(1).max(1e3),
@@ -207,8 +229,10 @@ var GuideConfigSchema = z2.object({
   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([])
+  /** Restrict guide to url pattern(s) (applied before trigger). On mobile these match the screen path `/<Screen>`. */
+  urlPatterns: z2.array(z2.string().max(500)).max(20).default([]),
+  /** Platforms that receive this guide. Guides created before mobile support are web-only. */
+  platforms: z2.array(z2.enum(PLATFORMS)).max(PLATFORMS.length).default(["web"])
 });
 function defaultGuideConfig(kind) {
   return GuideConfigSchema.parse({
@@ -254,12 +278,17 @@ function validateGuideConfig(kind, config) {
   } else {
     if (config.steps.length === 0) issues.push({ level: "error", message: "Add at least one step." });
   }
+  if (config.platforms.length === 0) issues.push({ level: "error", message: "Choose at least one platform (web, iOS or Android)." });
+  const mobile = config.platforms.some((p) => p !== "web");
   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 (mobile && anchored && step.target && step.target.selectors.length > 0 && !step.target.selectors.some((s) => s.kind === "guidely-id" || s.kind === "id"))
+      issues.push({ level: "warning", stepId: step.id, message: `Step ${i + 1} has no Guidely id or element id target, so mobile apps cannot find its element.` });
+    if (mobile && step.type === "custom") issues.push({ level: "warning", stepId: step.id, message: `Step ${i + 1} is a custom HTML step; mobile apps show it as a plain modal.` });
     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) => {
@@ -311,8 +340,15 @@ var EVENT_NAMES = [
   "scout_answered",
   "custom",
   "page_view",
-  "identify"
+  "identify",
+  // Product analytics (autocapture + error tracking)
+  "page_leave",
+  "click",
+  "rage_click",
+  "exception",
+  "heatmap"
 ];
+var AUTOCAPTURE_EVENTS = ["page_view", "page_leave", "click", "rage_click", "exception", "heatmap"];
 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),
@@ -412,6 +448,55 @@ var ConversationRatingSchema = z5.object({
   comment: z5.string().max(1e3).optional()
 });
 
+// src/capture.ts
+import { z as z6 } from "zod";
+var AutocaptureSettingsSchema = z6.object({ pageviews: z6.boolean(), pageLeave: z6.boolean(), clicks: z6.boolean(), rageClicks: z6.boolean(), heatmaps: z6.boolean(), mouseMovement: z6.boolean() }).partial();
+var ErrorTrackingSettingsSchema = z6.object({ enabled: z6.boolean() }).partial();
+var ReplaySettingsSchema = z6.object({
+  enabled: z6.boolean(),
+  sampleRate: z6.number().int().min(0).max(100),
+  recordConsole: z6.boolean(),
+  recordNetwork: z6.boolean(),
+  recordNetworkPayloads: z6.boolean(),
+  maskAllText: z6.boolean(),
+  blockSelectors: z6.array(z6.string().min(1).max(200)).max(50),
+  retentionDays: z6.number().int().min(1).max(365)
+}).partial();
+var DEFAULT_CAPTURE_SETTINGS = {
+  autocapture: { pageviews: true, pageLeave: true, clicks: true, rageClicks: true, heatmaps: true, mouseMovement: true },
+  errorTracking: { enabled: true },
+  replay: { enabled: false, sampleRate: 100, recordConsole: true, recordNetwork: true, recordNetworkPayloads: false, maskAllText: false, blockSelectors: [], retentionDays: 30 }
+};
+function resolveCaptureSettings(settings) {
+  const s = settings && typeof settings === "object" ? settings : {};
+  const obj = (v) => v && typeof v === "object" && !Array.isArray(v) ? v : {};
+  const d = DEFAULT_CAPTURE_SETTINGS;
+  const a = AutocaptureSettingsSchema.safeParse(obj(s.autocapture));
+  const e = ErrorTrackingSettingsSchema.safeParse(obj(s.errorTracking));
+  const r = ReplaySettingsSchema.safeParse(obj(s.replay));
+  return {
+    autocapture: { ...d.autocapture, ...a.success ? a.data : {} },
+    errorTracking: { ...d.errorTracking, ...e.success ? e.data : {} },
+    replay: { ...d.replay, ...r.success ? r.data : {} }
+  };
+}
+var HEATMAP_VIEWPORTS = { mobile: [0, 767], tablet: [768, 1279], desktop: [1280, 1e5] };
+var ReplayChunkSchema = z6.object({
+  sessionId: z6.string().min(1).max(128),
+  windowId: z6.string().min(1).max(64),
+  seq: z6.number().int().min(0).max(1e6),
+  anonymousId: z6.string().min(1).max(128),
+  userId: z6.string().max(256).optional().nullable(),
+  /** rrweb `eventWithTime` objects, in order. */
+  events: z6.array(z6.object({ type: z6.number().int(), timestamp: z6.number() }).passthrough()).min(1).max(5e4),
+  url: z6.string().max(2e3).optional(),
+  device: z6.object({ type: z6.string().max(20), browser: z6.string().max(40).optional(), os: z6.string().max(40).optional() }).optional(),
+  viewport: z6.object({ width: z6.number().int().min(0).max(1e5), height: z6.number().int().min(0).max(1e5) }).optional(),
+  sdk: z6.object({ name: z6.string().max(60), version: z6.string().max(30) }).optional()
+});
+var REPLAY_MAX_COMPRESSED_BYTES = 2 * 1024 * 1024;
+var REPLAY_MAX_RAW_BYTES = 16 * 1024 * 1024;
+
 // src/templates.ts
 var nav = (opts = {}) => [
   ...opts.first ? [] : [{ id: "back", label: "Back", action: "back", variant: "ghost" }],
@@ -592,11 +677,13 @@ function templateConfig(id) {
 
 // src/index.ts
 var SDK_API_VERSION = "v1";
-var SHARED_VERSION = "0.2.0";
+var SHARED_VERSION = "0.4.0";
 export {
   ADVANCE_ON,
+  AUTOCAPTURE_EVENTS,
   AppearanceSchema,
   AuthoringPickSchema,
+  AutocaptureSettingsSchema,
   BUTTON_ACTIONS,
   ButtonSchema,
   ChecklistConfigSchema,
@@ -604,32 +691,48 @@ export {
   ChecklistTaskSchema,
   ConversationLookupSchema,
   ConversationRatingSchema,
+  DEFAULT_CAPTURE_SETTINGS,
+  DEFAULT_PLATFORMS,
   EVENT_NAMES,
+  ErrorTrackingSettingsSchema,
   EventBatchSchema,
   FrequencySchema,
+  GUIDELY_ID_ATTRIBUTE,
   GUIDE_KINDS,
   GUIDE_LIFECYCLE_EVENTS,
   GUIDE_STATUSES,
   GUIDE_TEMPLATES,
   GuideConfigSchema,
   GuideStateUpdateSchema,
+  HEATMAP_VIEWPORTS,
   IdentifyRequestSchema,
   MAX_MESSAGE_LENGTH,
   MAX_PROPERTY_BYTES,
+  MAX_STACK_FRAMES,
   MESSAGE_AUTHORS,
+  NETWORK_PLUGIN,
   PLACEMENTS,
+  PLATFORMS,
   PostMessageSchema,
   ProjectThemeSchema,
   PublishedGuideSchema,
+  REPLAY_MAX_COMPRESSED_BYTES,
+  REPLAY_MAX_RAW_BYTES,
   RULE_FIELDS,
   RULE_OPERATORS,
+  ReplayChunkSchema,
+  ReplaySettingsSchema,
   RuleGroupSchema,
   RuleSchema,
   SDK_API_VERSION,
   SELECTOR_KINDS,
+  SENSITIVE_HEADER_PATTERN,
+  SENSITIVE_PARAM_PATTERN,
   SENSITIVE_PROPERTY_PATTERN,
   SERVER_ASSISTED_FIELDS,
   SHARED_VERSION,
+  SOURCEMAP_MAX_FILES_PER_UPLOAD,
+  SOURCEMAP_MAX_FILE_BYTES,
   STEP_TYPES,
   SURVEY_QUESTION_TYPES,
   SdkEventSchema,
@@ -643,25 +746,39 @@ export {
   TRIGGER_TYPES,
   TargetSchema,
   TriggerSchema,
+  WS_MAX_MESSAGES_PER_SOCKET,
+  WS_MAX_MESSAGE_BYTES,
   clamp,
   compare,
+  compareVersions,
   defaultGuideConfig,
   defaultStep,
   describeRule,
   emptyRuleGroup,
   evaluateRule,
   evaluateRules,
+  fingerprintError,
   fnv1a,
   getPath,
+  guidePlatforms,
+  guidelyIdFromSelector,
+  isChecklistComplete,
   isPlainObject,
+  isQuestionVisible,
   isRuleGroup,
   matchUrlPattern,
+  normalizeErrorMessage,
+  normalizeFrameFile,
+  parseStack,
   randomId,
+  resolveCaptureSettings,
   rolloutBucket,
   safeRegExp,
   sanitizeProperties,
+  screenPath,
   slugify,
   stripOrigin,
+  supportsPlatform,
   templateConfig,
   validateGuideConfig,
   visibleButtons