@guidelytech/shared 0.8.0 → 0.10.0

package/dist/index.js

@@ -1,11 +1,22 @@
 import {
+  ARTICLE_VISIBILITIES,
   CAPTURE_PARAM,
   CAPTURE_SCREENSHOT_MAX_BYTES,
+  COMPLAINT_EVENTS,
+  COMPLAINT_FIELD_TYPES,
+  COMPLAINT_STATUSES,
   DEFAULT_PLATFORMS,
   EMBED_IFRAME_ATTRS,
   FILE_LINK_CLASS,
   GUIDELY_ID_ATTRIBUTE,
+  GUIDE_VISIBILITIES,
+  LOGGED_IN_AUDIENCE,
   MAX_COLLECTION_DEPTH,
+  MAX_COMPLAINT_ANSWER_LENGTH,
+  MAX_COMPLAINT_ATTACHMENT_BYTES,
+  MAX_COMPLAINT_CHOICES,
+  MAX_COMPLAINT_FIELDS,
+  MAX_COMPLAINT_LENGTH,
   MAX_PROPERTY_BYTES,
   MAX_STACK_FRAMES,
   MEDIA_FILE_MAX_BYTES,
@@ -27,6 +38,8 @@ import {
   SENSITIVE_PARAM_PATTERN,
   SENSITIVE_PROPERTY_PATTERN,
   SERVER_ASSISTED_FIELDS,
+  SHOW_ME_CLASS,
+  SHOW_ME_HREF_PREFIX,
   SOURCEMAP_MAX_FILES_PER_UPLOAD,
   SOURCEMAP_MAX_FILE_BYTES,
   VIDEO_ATTRS,
@@ -35,6 +48,7 @@ import {
   clamp,
   compare,
   compareVersions,
+  complaintReference,
   describeRule,
   emptyRuleGroup,
   evaluateRule,
@@ -46,6 +60,7 @@ import {
   getPath,
   guidePlatforms,
   guidelyIdFromSelector,
+  hasVideoMedia,
   isAllowedEmbedSrc,
   isArticleListed,
   isChecklistComplete,
@@ -58,6 +73,7 @@ import {
   isVideoContentType,
   matchUrlPattern,
   matchesAudiences,
+  matchesHelpQuery,
   mediaKind,
   mediaMaxBytes,
   normalizeErrorMessage,
@@ -71,12 +87,18 @@ import {
   safeRegExp,
   sanitizeProperties,
   screenPath,
+  servedArticleAudiences,
+  showMeHref,
+  showMeKeyFromHref,
+  showMeKeys,
   slugify,
   stripOrigin,
   supportsPlatform,
   toEmbedUrl,
-  visibleArticleIds
-} from "./chunk-OLWGMDRX.js";
+  visibleArticleIds,
+  visitorAudiences,
+  withVisibility
+} from "./chunk-UW6NRYRY.js";
 
 // src/targeting.ts
 import { z } from "zod";
@@ -222,7 +244,7 @@ var ChecklistTaskSchema = z2.object({
   required: z2.boolean().default(true)
 });
 var ChecklistConfigSchema = z2.object({
-  tasks: z2.array(ChecklistTaskSchema).min(1).max(30),
+  tasks: z2.array(ChecklistTaskSchema).min(1),
   ordered: z2.boolean().default(false),
   launcherLabel: z2.string().max(60).default("Getting started"),
   position: z2.enum(["bottom-right", "bottom-left"]).default("bottom-right"),
@@ -256,6 +278,8 @@ var SurveyConfigSchema = z2.object({
 });
 var GuideConfigSchema = z2.object({
   steps: z2.array(StepSchema).max(50).default([]),
+  /** Everyone, only identified (logged-in) users, or only anonymous visitors; applied on top of `targeting`. */
+  visibility: z2.enum(GUIDE_VISIBILITIES).default("everyone"),
   targeting: RuleGroupSchema.default(() => emptyRuleGroup()),
   trigger: TriggerSchema.default({}),
   frequency: FrequencySchema.default({}),
@@ -495,19 +519,40 @@ var ConversationRatingSchema = z5.object({
   comment: z5.string().max(1e3).optional()
 });
 
-// src/capture.ts
+// src/complaints.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)
+var FileComplaintSchema = z6.object({
+  anonymousId: z6.string().min(1).max(128),
+  userId: z6.string().max(256).optional().nullable(),
+  categoryId: z6.string().min(1).max(64),
+  description: z6.string().trim().min(1).max(MAX_COMPLAINT_LENGTH),
+  /** Answers to the category's extra questions, by field id. */
+  answers: z6.record(z6.string().max(64), z6.string().trim().max(MAX_COMPLAINT_ANSWER_LENGTH)).default({}),
+  /** Required from visitors the app hasn't identified. */
+  email: z6.string().trim().toLowerCase().email().max(254).optional().nullable(),
+  pageUrl: z6.string().max(2e3).optional(),
+  /** File it in this conversation (send its token in `X-Guidely-Conversation`); otherwise a new one is started. */
+  conversationId: z6.string().min(1).max(64).optional().nullable(),
+  /** One screenshot, base64-encoded (png, jpeg, webp or gif). */
+  attachment: z6.object({
+    fileName: z6.string().trim().min(1).max(200),
+    data: z6.string().max(Math.ceil(MAX_COMPLAINT_ATTACHMENT_BYTES * 4 / 3) + 4)
+  }).optional().nullable()
+});
+
+// src/capture.ts
+import { z as z7 } from "zod";
+var AutocaptureSettingsSchema = z7.object({ pageviews: z7.boolean(), pageLeave: z7.boolean(), clicks: z7.boolean(), rageClicks: z7.boolean(), heatmaps: z7.boolean(), mouseMovement: z7.boolean() }).partial();
+var ErrorTrackingSettingsSchema = z7.object({ enabled: z7.boolean() }).partial();
+var ReplaySettingsSchema = z7.object({
+  enabled: z7.boolean(),
+  sampleRate: z7.number().int().min(0).max(100),
+  recordConsole: z7.boolean(),
+  recordNetwork: z7.boolean(),
+  recordNetworkPayloads: z7.boolean(),
+  maskAllText: z7.boolean(),
+  blockSelectors: z7.array(z7.string().min(1).max(200)).max(50),
+  retentionDays: z7.number().int().min(1).max(365)
 }).partial();
 var DEFAULT_CAPTURE_SETTINGS = {
   autocapture: { pageviews: true, pageLeave: true, clicks: true, rageClicks: true, heatmaps: true, mouseMovement: true },
@@ -528,18 +573,18 @@ function resolveCaptureSettings(settings) {
   };
 }
 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(),
+var ReplayChunkSchema = z7.object({
+  sessionId: z7.string().min(1).max(128),
+  windowId: z7.string().min(1).max(64),
+  seq: z7.number().int().min(0).max(1e6),
+  anonymousId: z7.string().min(1).max(128),
+  userId: z7.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()
+  events: z7.array(z7.object({ type: z7.number().int(), timestamp: z7.number() }).passthrough()).min(1).max(5e4),
+  url: z7.string().max(2e3).optional(),
+  device: z7.object({ type: z7.string().max(20), browser: z7.string().max(40).optional(), os: z7.string().max(40).optional() }).optional(),
+  viewport: z7.object({ width: z7.number().int().min(0).max(1e5), height: z7.number().int().min(0).max(1e5) }).optional(),
+  sdk: z7.object({ name: z7.string().max(60), version: z7.string().max(30) }).optional()
 });
 var REPLAY_MAX_COMPRESSED_BYTES = 2 * 1024 * 1024;
 var REPLAY_MAX_RAW_BYTES = 16 * 1024 * 1024;
@@ -723,39 +768,39 @@ function templateConfig(id) {
 }
 
 // src/howto.ts
-import { z as z7 } from "zod";
+import { z as z8 } 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 NormalizedRectSchema = z8.object({
+  x: z8.number().min(0).max(1),
+  y: z8.number().min(0).max(1),
+  width: z8.number().min(0).max(1),
+  height: z8.number().min(0).max(1)
 });
-var CapturedElementSchema = z7.object({
+var CapturedElementSchema = z8.object({
   /** Visible name: aria-label, associated label, text, placeholder, alt or title. */
-  label: z7.string().max(200).default(""),
+  label: z8.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("")
+  role: z8.string().max(40).default("element"),
+  tag: z8.string().max(40).default("")
 });
-var CaptureStepSchema = z7.object({
+var CaptureStepSchema = z8.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(""),
+  clientId: z8.string().min(1).max(64),
+  action: z8.enum(HOWTO_ACTIONS),
+  url: z8.string().max(2e3),
+  pageTitle: z8.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),
+  value: z8.string().max(200).optional(),
+  valueRedacted: z8.boolean().default(false),
   /** Selectors for the element, so the step can later become an interactive tour step. */
-  selectors: z7.array(SelectorStrategySchema).max(10).default([]),
+  selectors: z8.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()
+  redactions: z8.number().int().min(0).max(1e3).default(0),
+  occurredAt: z8.string().datetime().optional()
 });
 function quoted(s) {
   const t = (s ?? "").replace(/\s+/g, " ").trim();
@@ -826,21 +871,55 @@ function hostAndPath(url) {
     return url.slice(0, 80);
   }
 }
-var NormalizedPointSchema = z7.object({ x: z7.number().min(0).max(1), y: z7.number().min(0).max(1) });
+var NormalizedPointSchema = z8.object({ x: z8.number().min(0).max(1), y: z8.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 HowToAnnotationSchema = z8.discriminatedUnion("type", [
+  z8.object({ id: z8.string().min(1).max(32), type: z8.literal("arrow"), from: NormalizedPointSchema, to: NormalizedPointSchema, color: z8.enum(ANNOTATION_COLORS).default("brand") }),
+  z8.object({ id: z8.string().min(1).max(32), type: z8.literal("text"), at: NormalizedPointSchema, text: z8.string().trim().min(1).max(120), color: z8.enum(ANNOTATION_COLORS).default("brand") }),
+  z8.object({ id: z8.string().min(1).max(32), type: z8.literal("box"), rect: NormalizedRectSchema, color: z8.enum(ANNOTATION_COLORS).default("brand") })
 ]);
 var MAX_ANNOTATIONS = 30;
 
+// src/snippet.ts
+var SCRIPT_STUB_METHODS = [
+  "identify",
+  "track",
+  "page",
+  "reset",
+  "setAccount",
+  "updateTraits",
+  "setConsent",
+  "startGuide",
+  "stopGuide",
+  "dismissGuide",
+  "openMessenger",
+  "closeMessenger",
+  "showNewMessage",
+  "openResourceCenter",
+  "closeResourceCenter",
+  "openChecklist",
+  "closeChecklist",
+  "completeChecklistTask",
+  "openComplaint",
+  "captureException",
+  "on"
+];
+var SCRIPT_STUB = `!function(w){if(w.Guidely)return;var g=w.Guidely={_q:[]},c=g._c={};function q(o,k){o[k]=function(){g._q.push([o===c?1:0,k,[].slice.call(arguments)])}}q(g,"init");"${SCRIPT_STUB_METHODS.join(" ")}".split(" ").forEach(function(k){q(c,k)});c.isFeatureEnabled=function(k,f){return!!f};c.getFeatureValue=function(k,f){return f};g.get=function(){return c}}(window);`;
+function scriptSnippet(scriptUrl, initOptions) {
+  return `<script>
+  ${SCRIPT_STUB}
+  Guidely.init(${initOptions});
+</script>
+<script src="${scriptUrl}" async></script>`;
+}
+
 // src/index.ts
 var SDK_API_VERSION = "v1";
-var SHARED_VERSION = "0.8.0";
+var SHARED_VERSION = "0.10.0";
 export {
   ADVANCE_ON,
   ANNOTATION_COLORS,
+  ARTICLE_VISIBILITIES,
   AUTOCAPTURE_EVENTS,
   AppearanceSchema,
   AuthoringPickSchema,
@@ -849,6 +928,9 @@ export {
   ButtonSchema,
   CAPTURE_PARAM,
   CAPTURE_SCREENSHOT_MAX_BYTES,
+  COMPLAINT_EVENTS,
+  COMPLAINT_FIELD_TYPES,
+  COMPLAINT_STATUSES,
   CaptureStepSchema,
   CapturedElementSchema,
   ChecklistConfigSchema,
@@ -863,12 +945,14 @@ export {
   ErrorTrackingSettingsSchema,
   EventBatchSchema,
   FILE_LINK_CLASS,
+  FileComplaintSchema,
   FrequencySchema,
   GUIDELY_ID_ATTRIBUTE,
   GUIDE_KINDS,
   GUIDE_LIFECYCLE_EVENTS,
   GUIDE_STATUSES,
   GUIDE_TEMPLATES,
+  GUIDE_VISIBILITIES,
   GuideConfigSchema,
   GuideStateUpdateSchema,
   HEATMAP_VIEWPORTS,
@@ -876,8 +960,14 @@ export {
   HOWTO_STEP_KINDS,
   HowToAnnotationSchema,
   IdentifyRequestSchema,
+  LOGGED_IN_AUDIENCE,
   MAX_ANNOTATIONS,
   MAX_COLLECTION_DEPTH,
+  MAX_COMPLAINT_ANSWER_LENGTH,
+  MAX_COMPLAINT_ATTACHMENT_BYTES,
+  MAX_COMPLAINT_CHOICES,
+  MAX_COMPLAINT_FIELDS,
+  MAX_COMPLAINT_LENGTH,
   MAX_MESSAGE_LENGTH,
   MAX_PROPERTY_BYTES,
   MAX_STACK_FRAMES,
@@ -911,6 +1001,8 @@ export {
   ReplaySettingsSchema,
   RuleGroupSchema,
   RuleSchema,
+  SCRIPT_STUB,
+  SCRIPT_STUB_METHODS,
   SDK_API_VERSION,
   SELECTOR_KINDS,
   SENSITIVE_HEADER_PATTERN,
@@ -918,6 +1010,8 @@ export {
   SENSITIVE_PROPERTY_PATTERN,
   SERVER_ASSISTED_FIELDS,
   SHARED_VERSION,
+  SHOW_ME_CLASS,
+  SHOW_ME_HREF_PREFIX,
   SOURCEMAP_MAX_FILES_PER_UPLOAD,
   SOURCEMAP_MAX_FILE_BYTES,
   STATUS_LEVELS,
@@ -941,6 +1035,7 @@ export {
   cleanLabel,
   compare,
   compareVersions,
+  complaintReference,
   defaultGuideConfig,
   defaultStep,
   describeCaptureStep,
@@ -955,6 +1050,7 @@ export {
   getPath,
   guidePlatforms,
   guidelyIdFromSelector,
+  hasVideoMedia,
   isAllowedEmbedSrc,
   isArticleListed,
   isChecklistComplete,
@@ -967,6 +1063,7 @@ export {
   isVideoContentType,
   matchUrlPattern,
   matchesAudiences,
+  matchesHelpQuery,
   mediaKind,
   mediaMaxBytes,
   normalizeErrorMessage,
@@ -982,6 +1079,11 @@ export {
   safeRegExp,
   sanitizeProperties,
   screenPath,
+  scriptSnippet,
+  servedArticleAudiences,
+  showMeHref,
+  showMeKeyFromHref,
+  showMeKeys,
   slugify,
   stripOrigin,
   supportsPlatform,
@@ -989,6 +1091,8 @@ export {
   toEmbedUrl,
   validateGuideConfig,
   visibleArticleIds,
-  visibleButtons
+  visibleButtons,
+  visitorAudiences,
+  withVisibility
 };
 //# sourceMappingURL=index.js.map