@guidelytech/shared 0.5.0 → 0.6.1

package/dist/index.js

@@ -1,15 +1,25 @@
 import {
+  CAPTURE_PARAM,
+  CAPTURE_SCREENSHOT_MAX_BYTES,
   DEFAULT_PLATFORMS,
   EMBED_IFRAME_ATTRS,
+  FILE_LINK_CLASS,
   GUIDELY_ID_ATTRIBUTE,
   MAX_COLLECTION_DEPTH,
   MAX_PROPERTY_BYTES,
   MAX_STACK_FRAMES,
+  MEDIA_FILE_MAX_BYTES,
+  MEDIA_FILE_TYPES,
   MEDIA_IMAGE_MAX_BYTES,
   MEDIA_IMAGE_TYPES,
+  MEDIA_MAX_BYTES,
   MEDIA_VIDEO_MAX_BYTES,
   MEDIA_VIDEO_TYPES,
   NETWORK_PLUGIN,
+  PATH_ID_PATTERN,
+  PDF_BLOCK_CLASS,
+  PDF_MAX_PAGES,
+  PDF_PAGES_CLASS,
   PLATFORMS,
   RULE_FIELDS,
   RULE_OPERATORS,
@@ -30,13 +40,16 @@ import {
   evaluateRule,
   evaluateRules,
   fingerprintError,
+  firstNameFromTraits,
   fnv1a,
+  foldPathIds,
   getPath,
   guidePlatforms,
   guidelyIdFromSelector,
   isAllowedEmbedSrc,
   isArticleListed,
   isChecklistComplete,
+  isFileLink,
   isMediaContentType,
   isPlainObject,
   isQuestionVisible,
@@ -45,9 +58,12 @@ import {
   isVideoContentType,
   matchUrlPattern,
   matchesAudiences,
+  mediaKind,
   mediaMaxBytes,
   normalizeErrorMessage,
   normalizeFrameFile,
+  pageLabel,
+  pageTerms,
   parseStack,
   randomId,
   resourceCenterSections,
@@ -60,7 +76,7 @@ import {
   supportsPlatform,
   toEmbedUrl,
   visibleArticleIds
-} from "./chunk-5IQVBZO6.js";
+} from "./chunk-OLWGMDRX.js";
 
 // src/targeting.ts
 import { z } from "zod";
@@ -447,6 +463,14 @@ var PublishedGuideSchema = z4.object({
 
 // src/messenger.ts
 import { z as z5 } from "zod";
+var REPLY_TIMES = ["minutes", "hour", "hours", "day"];
+var STATUS_LEVELS = ["operational", "degraded", "outage", "maintenance"];
+var MessengerPageRequestSchema = z5.object({
+  anonymousId: z5.string().min(1).max(128),
+  userId: z5.string().max(256).optional().nullable(),
+  /** Pathname only: query strings and fragments are never sent. */
+  path: z5.string().min(1).max(1e3)
+});
 var MESSAGE_AUTHORS = ["user", "scout", "agent", "system"];
 var MAX_MESSAGE_LENGTH = 4e3;
 var messageText = z5.string().trim().min(1).max(MAX_MESSAGE_LENGTH);
@@ -459,7 +483,11 @@ var StartConversationSchema = z5.object({
 var ConversationLookupSchema = z5.object({
   tokens: z5.array(z5.string().min(16).max(128)).max(50)
 });
-var PostMessageSchema = z5.object({ message: messageText });
+var PostMessageSchema = z5.object({
+  message: messageText,
+  /** The page the user is on now (omitted when URL collection is off and by older SDKs), so Scout answers for that page. */
+  pageUrl: z5.string().max(2e3).optional()
+});
 var ConversationRatingSchema = z5.object({
   rating: z5.number().int().min(1).max(5),
   comment: z5.string().max(1e3).optional()
@@ -692,17 +720,135 @@ function templateConfig(id) {
   return { template: t, config: GuideConfigSchema.parse(t.config) };
 }
 
+// src/howto.ts
+import { z as z7 } from "zod";
+var HOWTO_STEP_KINDS = ["action", "text", "heading", "tip", "alert"];
+var HOWTO_ACTIONS = ["click", "type", "select", "navigate"];
+var NormalizedRectSchema = z7.object({
+  x: z7.number().min(0).max(1),
+  y: z7.number().min(0).max(1),
+  width: z7.number().min(0).max(1),
+  height: z7.number().min(0).max(1)
+});
+var CapturedElementSchema = z7.object({
+  /** Visible name: aria-label, associated label, text, placeholder, alt or title. */
+  label: z7.string().max(200).default(""),
+  /** button, link, tab, menuitem, checkbox, radio, field, dropdown, option, element… */
+  role: z7.string().max(40).default("element"),
+  tag: z7.string().max(40).default("")
+});
+var CaptureStepSchema = z7.object({
+  /** Random id from the SDK; a retried upload with the same id is stored once. */
+  clientId: z7.string().min(1).max(64),
+  action: z7.enum(HOWTO_ACTIONS),
+  url: z7.string().max(2e3),
+  pageTitle: z7.string().max(300).default(""),
+  element: CapturedElementSchema.optional(),
+  /** Typed text or chosen option; absent when it was sensitive (`valueRedacted`). */
+  value: z7.string().max(200).optional(),
+  valueRedacted: z7.boolean().default(false),
+  /** Selectors for the element, so the step can later become an interactive tour step. */
+  selectors: z7.array(SelectorStrategySchema).max(10).default([]),
+  /** Where the element sits in the screenshot. */
+  highlight: NormalizedRectSchema.optional(),
+  /** Number of regions the SDK blurred in the screenshot before upload. */
+  redactions: z7.number().int().min(0).max(1e3).default(0),
+  occurredAt: z7.string().datetime().optional()
+});
+function quoted(s) {
+  const t = (s ?? "").replace(/\s+/g, " ").trim();
+  return t.length > 60 ? `\u201C${t.slice(0, 57)}\u2026\u201D` : `\u201C${t}\u201D`;
+}
+function cleanLabel(label) {
+  const raw = (label ?? "").replace(/\s+/g, " ").trim();
+  const cleaned = raw.replace(/^[^\p{L}\p{N}“"'(]+/u, "").replace(/[\s:*]+$/u, "").replace(/[^\p{L}\p{N})”"'?!.%]+$/u, "").trim();
+  return cleaned || raw;
+}
+var SEPARATORS = /\s+[·|•–—-]\s+|\s*[|·•]\s*/;
+var ID_SEGMENT = /^(?:\d+|[0-9a-f]{8,}(?:-[0-9a-f]{4,})*|[A-Za-z0-9_-]{20,})$/i;
+function humanize(segment) {
+  const words = decodeURIComponent(segment).replace(/[-_+]+/g, " ").trim();
+  return words ? words.charAt(0).toUpperCase() + words.slice(1) : "";
+}
+function pageName(url, pageTitle) {
+  const title = (pageTitle ?? "").replace(/\s+/g, " ").trim();
+  const parts = title.split(SEPARATORS).map((p) => p.trim()).filter(Boolean);
+  if (parts.length > 1) return parts[0];
+  let segments = [];
+  try {
+    segments = new URL(url).pathname.split("/").filter((p) => p && !ID_SEGMENT.test(p));
+  } catch {
+    segments = [];
+  }
+  const fromPath = segments.slice(-2).map(humanize).filter(Boolean).join(" \u203A ");
+  if (!fromPath) return title || hostAndPath(url);
+  if (!title) return fromPath;
+  const lower = title.toLowerCase();
+  const mentionsPath = segments.some((seg) => humanize(seg).toLowerCase().split(" ").some((w) => w.length > 2 && lower.includes(w)));
+  return mentionsPath ? title : fromPath;
+}
+var ROLE_NOUN = { tab: "tab", menuitem: "menu item", field: "field", dropdown: "dropdown", option: "option" };
+function describeCaptureStep(step) {
+  const label = cleanLabel(step.element?.label);
+  const role = step.element?.role ?? "";
+  switch (step.action) {
+    case "navigate": {
+      const where = pageName(step.url, step.pageTitle);
+      return where ? `Go to ${quoted(where)}` : "Open the page";
+    }
+    case "type": {
+      const field = label ? quoted(label) : "the field";
+      if (step.valueRedacted || !step.value) return `Fill in ${field}`;
+      return `Type ${quoted(step.value)} into ${field}`;
+    }
+    case "select":
+      if (step.value && label) return `Select ${quoted(step.value)} from ${quoted(label)}`;
+      if (step.value) return `Select ${quoted(step.value)}`;
+      return label ? `Choose an option in ${quoted(label)}` : "Choose an option";
+    case "click":
+    default:
+      if (role === "checkbox") return label ? `Check ${quoted(label)}` : "Check the box";
+      if (role === "switch") return label ? `Turn ${quoted(label)} on or off` : "Flip the switch";
+      if (role === "radio") return label ? `Select ${quoted(label)}` : "Select the option";
+      if (role === "menuitem") return label ? `Choose ${quoted(label)} from the menu` : "Choose the menu item";
+      if (role === "tab") return label ? `Open the ${quoted(label)} tab` : "Open the tab";
+      if (label) return `Click ${quoted(label)}`;
+      return ROLE_NOUN[role] ? `Click the ${ROLE_NOUN[role]}` : role === "link" ? "Click the link" : "Click the button";
+  }
+}
+function hostAndPath(url) {
+  try {
+    const u = new URL(url);
+    return `${u.host}${u.pathname === "/" ? "" : u.pathname}`;
+  } catch {
+    return url.slice(0, 80);
+  }
+}
+var NormalizedPointSchema = z7.object({ x: z7.number().min(0).max(1), y: z7.number().min(0).max(1) });
+var ANNOTATION_COLORS = ["brand", "red", "amber", "green", "black", "white"];
+var HowToAnnotationSchema = z7.discriminatedUnion("type", [
+  z7.object({ id: z7.string().min(1).max(32), type: z7.literal("arrow"), from: NormalizedPointSchema, to: NormalizedPointSchema, color: z7.enum(ANNOTATION_COLORS).default("brand") }),
+  z7.object({ id: z7.string().min(1).max(32), type: z7.literal("text"), at: NormalizedPointSchema, text: z7.string().trim().min(1).max(120), color: z7.enum(ANNOTATION_COLORS).default("brand") }),
+  z7.object({ id: z7.string().min(1).max(32), type: z7.literal("box"), rect: NormalizedRectSchema, color: z7.enum(ANNOTATION_COLORS).default("brand") })
+]);
+var MAX_ANNOTATIONS = 30;
+
 // src/index.ts
 var SDK_API_VERSION = "v1";
-var SHARED_VERSION = "0.5.0";
+var SHARED_VERSION = "0.6.1";
 export {
   ADVANCE_ON,
+  ANNOTATION_COLORS,
   AUTOCAPTURE_EVENTS,
   AppearanceSchema,
   AuthoringPickSchema,
   AutocaptureSettingsSchema,
   BUTTON_ACTIONS,
   ButtonSchema,
+  CAPTURE_PARAM,
+  CAPTURE_SCREENSHOT_MAX_BYTES,
+  CaptureStepSchema,
+  CapturedElementSchema,
   ChecklistConfigSchema,
   ChecklistProgressRequestSchema,
   ChecklistTaskSchema,
@@ -714,6 +860,7 @@ export {
   EVENT_NAMES,
   ErrorTrackingSettingsSchema,
   EventBatchSchema,
+  FILE_LINK_CLASS,
   FrequencySchema,
   GUIDELY_ID_ATTRIBUTE,
   GUIDE_KINDS,
@@ -723,17 +870,31 @@ export {
   GuideConfigSchema,
   GuideStateUpdateSchema,
   HEATMAP_VIEWPORTS,
+  HOWTO_ACTIONS,
+  HOWTO_STEP_KINDS,
+  HowToAnnotationSchema,
   IdentifyRequestSchema,
+  MAX_ANNOTATIONS,
   MAX_COLLECTION_DEPTH,
   MAX_MESSAGE_LENGTH,
   MAX_PROPERTY_BYTES,
   MAX_STACK_FRAMES,
+  MEDIA_FILE_MAX_BYTES,
+  MEDIA_FILE_TYPES,
   MEDIA_IMAGE_MAX_BYTES,
   MEDIA_IMAGE_TYPES,
+  MEDIA_MAX_BYTES,
   MEDIA_VIDEO_MAX_BYTES,
   MEDIA_VIDEO_TYPES,
   MESSAGE_AUTHORS,
+  MessengerPageRequestSchema,
   NETWORK_PLUGIN,
+  NormalizedPointSchema,
+  NormalizedRectSchema,
+  PATH_ID_PATTERN,
+  PDF_BLOCK_CLASS,
+  PDF_MAX_PAGES,
+  PDF_PAGES_CLASS,
   PLACEMENTS,
   PLATFORMS,
   PostMessageSchema,
@@ -741,6 +902,7 @@ export {
   PublishedGuideSchema,
   REPLAY_MAX_COMPRESSED_BYTES,
   REPLAY_MAX_RAW_BYTES,
+  REPLY_TIMES,
   RULE_FIELDS,
   RULE_OPERATORS,
   ReplayChunkSchema,
@@ -756,6 +918,7 @@ export {
   SHARED_VERSION,
   SOURCEMAP_MAX_FILES_PER_UPLOAD,
   SOURCEMAP_MAX_FILE_BYTES,
+  STATUS_LEVELS,
   STEP_TYPES,
   SURVEY_QUESTION_TYPES,
   SdkEventSchema,
@@ -773,22 +936,27 @@ export {
   WS_MAX_MESSAGES_PER_SOCKET,
   WS_MAX_MESSAGE_BYTES,
   clamp,
+  cleanLabel,
   compare,
   compareVersions,
   defaultGuideConfig,
   defaultStep,
+  describeCaptureStep,
   describeRule,
   emptyRuleGroup,
   evaluateRule,
   evaluateRules,
   fingerprintError,
+  firstNameFromTraits,
   fnv1a,
+  foldPathIds,
   getPath,
   guidePlatforms,
   guidelyIdFromSelector,
   isAllowedEmbedSrc,
   isArticleListed,
   isChecklistComplete,
+  isFileLink,
   isMediaContentType,
   isPlainObject,
   isQuestionVisible,
@@ -797,9 +965,13 @@ export {
   isVideoContentType,
   matchUrlPattern,
   matchesAudiences,
+  mediaKind,
   mediaMaxBytes,
   normalizeErrorMessage,
   normalizeFrameFile,
+  pageLabel,
+  pageName,
+  pageTerms,
   parseStack,
   randomId,
   resolveCaptureSettings,