@guidelytech/shared 0.15.0 → 0.16.0

package/dist/index.cjs

@@ -31,6 +31,7 @@ __export(index_exports, {
   AGENT_TURN_ROLES: () => AGENT_TURN_ROLES,
   ANNOTATION_COLORS: () => ANNOTATION_COLORS,
   APP_LIFECYCLE_EVENTS: () => APP_LIFECYCLE_EVENTS,
+  ARTICLE_HREF_PREFIX: () => ARTICLE_HREF_PREFIX,
   ARTICLE_VISIBILITIES: () => ARTICLE_VISIBILITIES,
   AUTOCAPTURE_EVENTS: () => AUTOCAPTURE_EVENTS,
   AgentEventsRequestSchema: () => AgentEventsRequestSchema,
@@ -145,6 +146,7 @@ __export(index_exports, {
   PublishedGuideSchema: () => PublishedGuideSchema,
   RC_MODULE_IDS: () => RC_MODULE_IDS,
   RC_MODULE_LABELS: () => RC_MODULE_LABELS,
+  RECORDING_LEVELS: () => RECORDING_LEVELS,
   REPLAY_MAX_COMPRESSED_BYTES: () => REPLAY_MAX_COMPRESSED_BYTES,
   REPLAY_MAX_RAW_BYTES: () => REPLAY_MAX_RAW_BYTES,
   REPLY_TIMES: () => REPLY_TIMES,
@@ -194,6 +196,8 @@ __export(index_exports, {
   WS_MAX_MESSAGES_PER_SOCKET: () => WS_MAX_MESSAGES_PER_SOCKET,
   WS_MAX_MESSAGE_BYTES: () => WS_MAX_MESSAGE_BYTES,
   applyGuideTranslations: () => applyGuideTranslations,
+  articleHref: () => articleHref,
+  articleIdFromHref: () => articleIdFromHref,
   articleTextEntries: () => articleTextEntries,
   assignGuideVariant: () => assignGuideVariant,
   baseLanguage: () => baseLanguage,
@@ -240,6 +244,7 @@ __export(index_exports, {
   isRuleGroup: () => isRuleGroup,
   isSafeMediaUrl: () => isSafeMediaUrl,
   isVideoContentType: () => isVideoContentType,
+  isVideoFileUrl: () => isVideoFileUrl,
   localeName: () => localeName,
   localizeAnnouncement: () => localizeAnnouncement,
   localizeArticle: () => localizeArticle,
@@ -274,6 +279,7 @@ __export(index_exports, {
   queryConditionRegex: () => queryConditionRegex,
   randomId: () => randomId,
   readableTextOn: () => readableTextOn,
+  recordingLevel: () => recordingLevel,
   relativeLuminance: () => relativeLuminance,
   resolveCaptureSettings: () => resolveCaptureSettings,
   resolveLocale: () => resolveLocale,
@@ -294,6 +300,7 @@ __export(index_exports, {
   slugify: () => slugify,
   snapshotFromSelector: () => snapshotFromSelector,
   stableStringify: () => stableStringify,
+  stepVideo: () => stepVideo,
   stripOrigin: () => stripOrigin,
   supportsPlatform: () => supportsPlatform,
   templateConfig: () => templateConfig,
@@ -305,12 +312,14 @@ __export(index_exports, {
   validateGuideConfig: () => validateGuideConfig,
   variantProblems: () => variantProblems,
   variantRanges: () => variantRanges,
+  videoThumbnailUrl: () => videoThumbnailUrl,
   visibleAnnouncements: () => visibleAnnouncements,
   visibleArticleIds: () => visibleArticleIds,
   visibleButtons: () => visibleButtons,
   visitorAudiences: () => visitorAudiences,
   visitorLocales: () => visitorLocales,
   withExperimentBucket: () => withExperimentBucket,
+  withRecordingLevel: () => withRecordingLevel,
   withVisibility: () => withVisibility
 });
 module.exports = __toCommonJS(index_exports);
@@ -820,6 +829,11 @@ var StepSchema = import_zod2.z.object({
   imageUrl: import_zod2.z.string().url().max(2e3).optional().or(import_zod2.z.literal("")),
   /** Alternative text for `imageUrl` (screen readers); empty = decorative. */
   imageAlt: import_zod2.z.string().max(300).optional(),
+  /**
+   * Video (YouTube, Vimeo, Loom, a file…): drawn as a poster with a play button that opens the video
+   * in a new tab. The poster is `imageUrl` when set, else the provider's thumbnail.
+   */
+  videoUrl: import_zod2.z.string().url().max(2e3).optional().or(import_zod2.z.literal("")),
   buttons: import_zod2.z.array(ButtonSchema).max(6).default([]),
   target: TargetSchema.optional(),
   placement: import_zod2.z.enum(PLACEMENTS).default("auto"),
@@ -965,9 +979,9 @@ var GuideConfigSchema = import_zod2.z.object({
   /** Everyone, only identified (logged-in) users, or only anonymous visitors; applied on top of `targeting`. */
   visibility: import_zod2.z.enum(GUIDE_VISIBILITIES).default("everyone"),
   targeting: RuleGroupSchema.default(() => emptyRuleGroup()),
-  trigger: TriggerSchema.default({}),
-  frequency: FrequencySchema.default({}),
-  appearance: AppearanceSchema.default({}),
+  trigger: TriggerSchema.prefault({}),
+  frequency: FrequencySchema.prefault({}),
+  appearance: AppearanceSchema.prefault({}),
   checklist: ChecklistConfigSchema.optional(),
   survey: SurveyConfigSchema.optional(),
   /** Restrict guide to url pattern(s) (applied before trigger). On mobile these match the screen path `/<Screen>`. */
@@ -1143,6 +1157,8 @@ var EVENT_NAMES = [
   "guide_skipped",
   "guide_dismissed",
   "guide_abandoned",
+  /** The video on a guide step was clicked (opened in a new tab). Properties: videoUrl. */
+  "guide_video_clicked",
   "checklist_task_completed",
   "checklist_completed",
   "checklist_dismissed",
@@ -1190,7 +1206,7 @@ var SdkEventSchema = import_zod3.z.object({
   stepId: import_zod3.z.string().max(64).optional(),
   stepIndex: import_zod3.z.number().int().min(0).optional(),
   url: import_zod3.z.string().max(2e3).optional(),
-  properties: import_zod3.z.record(import_zod3.z.unknown()).optional()
+  properties: import_zod3.z.record(import_zod3.z.string(), import_zod3.z.unknown()).optional()
 });
 var EventBatchSchema = import_zod3.z.object({
   events: import_zod3.z.array(SdkEventSchema).min(1).max(50),
@@ -1203,8 +1219,8 @@ var import_zod4 = require("zod");
 var IdentifyRequestSchema = import_zod4.z.object({
   anonymousId: import_zod4.z.string().min(1).max(128),
   userId: import_zod4.z.string().min(1).max(256).optional().nullable(),
-  traits: import_zod4.z.record(import_zod4.z.unknown()).optional(),
-  account: import_zod4.z.object({ id: import_zod4.z.string().min(1).max(256), traits: import_zod4.z.record(import_zod4.z.unknown()).optional() }).optional().nullable(),
+  traits: import_zod4.z.record(import_zod4.z.string(), import_zod4.z.unknown()).optional(),
+  account: import_zod4.z.object({ id: import_zod4.z.string().min(1).max(256), traits: import_zod4.z.record(import_zod4.z.string(), import_zod4.z.unknown()).optional() }).optional().nullable(),
   sessionId: import_zod4.z.string().max(128).optional(),
   url: import_zod4.z.string().max(2e3).optional()
 });
@@ -1221,7 +1237,7 @@ var SurveyResponseRequestSchema = import_zod4.z.object({
   userId: import_zod4.z.string().max(256).optional().nullable(),
   accountId: import_zod4.z.string().max(256).optional().nullable(),
   guideVersion: import_zod4.z.number().int(),
-  answers: import_zod4.z.record(import_zod4.z.union([import_zod4.z.string().max(5e3), import_zod4.z.number(), import_zod4.z.boolean(), import_zod4.z.array(import_zod4.z.string().max(500)).max(50)])),
+  answers: import_zod4.z.record(import_zod4.z.string(), import_zod4.z.union([import_zod4.z.string().max(5e3), import_zod4.z.number(), import_zod4.z.boolean(), import_zod4.z.array(import_zod4.z.string().max(500)).max(50)])),
   responseId: import_zod4.z.string().min(8).max(64)
 });
 var GuideStateUpdateSchema = import_zod4.z.object({
@@ -1243,7 +1259,7 @@ var AuthoringPickSchema = import_zod4.z.object({
   url: import_zod4.z.string().max(2e3).optional(),
   rect: import_zod4.z.object({ x: import_zod4.z.number(), y: import_zod4.z.number(), width: import_zod4.z.number(), height: import_zod4.z.number() }).optional(),
   /** Compact snapshot of the picked element (tag mode: feature rules are proposed from it). */
-  elementSnapshot: import_zod4.z.record(import_zod4.z.unknown()).optional()
+  elementSnapshot: import_zod4.z.record(import_zod4.z.string(), import_zod4.z.unknown()).optional()
 });
 var PublishedGuideSchema = import_zod4.z.object({
   id: import_zod4.z.string(),
@@ -1471,6 +1487,23 @@ var DEFAULT_CAPTURE_SETTINGS = {
   errorTracking: { enabled: true },
   replay: { enabled: false, sampleRate: 100, recordConsole: true, recordNetwork: true, recordNetworkPayloads: false, maskAllText: false, blockSelectors: [], retentionDays: 30 }
 };
+var RECORDING_LEVELS = ["off", "privacy", "standard", "full"];
+var RECORDING_PRESETS = {
+  privacy: { maskAllText: true, recordConsole: false, recordNetwork: false, recordNetworkPayloads: false },
+  standard: { maskAllText: false, recordConsole: true, recordNetwork: true, recordNetworkPayloads: false },
+  full: { maskAllText: false, recordConsole: true, recordNetwork: true, recordNetworkPayloads: true }
+};
+function recordingLevel(replay) {
+  if (!replay.enabled) return "off";
+  for (const level of ["privacy", "standard", "full"]) {
+    const preset = RECORDING_PRESETS[level];
+    if (Object.keys(preset).every((k) => replay[k] === preset[k])) return level;
+  }
+  return "custom";
+}
+function withRecordingLevel(replay, level) {
+  return level === "off" ? { ...replay, enabled: false } : { ...replay, ...RECORDING_PRESETS[level], enabled: true };
+}
 function resolveCaptureSettings(settings) {
   const s = settings && typeof settings === "object" ? settings : {};
   const obj = (v) => v && typeof v === "object" && !Array.isArray(v) ? v : {};
@@ -1813,6 +1846,19 @@ function isSafeMediaUrl(url) {
     return false;
   }
 }
+function videoThumbnailUrl(url) {
+  const embed = url ? toEmbedUrl(url) : null;
+  if (embed?.provider !== "youtube") return null;
+  const id2 = embed.src.split("/embed/")[1]?.split("?")[0];
+  return id2 ? `https://i.ytimg.com/vi/${id2}/hqdefault.jpg` : null;
+}
+function isVideoFileUrl(url) {
+  return isSafeMediaUrl(url) && /\.(mp4|webm|m4v|mov|ogv)$/i.test(new URL(url).pathname);
+}
+function stepVideo(step) {
+  if (!step.videoUrl || !isSafeMediaUrl(step.videoUrl)) return null;
+  return { url: step.videoUrl, poster: (step.imageUrl && isSafeMediaUrl(step.imageUrl) ? step.imageUrl : null) ?? videoThumbnailUrl(step.videoUrl) };
+}
 
 // src/resource-center.ts
 var MAX_COLLECTION_DEPTH = 3;
@@ -1935,6 +1981,16 @@ function unreadAnnouncements(items, lastSeenAt) {
   if (Number.isNaN(seen)) return items.length;
   return items.filter((a) => Date.parse(a.publishedAt) > seen).length;
 }
+var ARTICLE_HREF_PREFIX = "#guidely-article:";
+var ARTICLE_ID = /^[A-Za-z0-9_-]{1,64}$/;
+function articleHref(articleId) {
+  return `${ARTICLE_HREF_PREFIX}${articleId}`;
+}
+function articleIdFromHref(href) {
+  if (!href || !href.startsWith(ARTICLE_HREF_PREFIX)) return null;
+  const id2 = href.slice(ARTICLE_HREF_PREFIX.length);
+  return ARTICLE_ID.test(id2) ? id2 : null;
+}
 
 // src/howto.ts
 var import_zod10 = require("zod");
@@ -3184,7 +3240,7 @@ function parseTranslationCsv(text) {
 
 // src/index.ts
 var SDK_API_VERSION = "v1";
-var SHARED_VERSION = "0.15.0";
+var SHARED_VERSION = "0.16.0";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ADVANCE_ON,
@@ -3198,6 +3254,7 @@ var SHARED_VERSION = "0.15.0";
   AGENT_TURN_ROLES,
   ANNOTATION_COLORS,
   APP_LIFECYCLE_EVENTS,
+  ARTICLE_HREF_PREFIX,
   ARTICLE_VISIBILITIES,
   AUTOCAPTURE_EVENTS,
   AgentEventsRequestSchema,
@@ -3312,6 +3369,7 @@ var SHARED_VERSION = "0.15.0";
   PublishedGuideSchema,
   RC_MODULE_IDS,
   RC_MODULE_LABELS,
+  RECORDING_LEVELS,
   REPLAY_MAX_COMPRESSED_BYTES,
   REPLAY_MAX_RAW_BYTES,
   REPLY_TIMES,
@@ -3361,6 +3419,8 @@ var SHARED_VERSION = "0.15.0";
   WS_MAX_MESSAGES_PER_SOCKET,
   WS_MAX_MESSAGE_BYTES,
   applyGuideTranslations,
+  articleHref,
+  articleIdFromHref,
   articleTextEntries,
   assignGuideVariant,
   baseLanguage,
@@ -3407,6 +3467,7 @@ var SHARED_VERSION = "0.15.0";
   isRuleGroup,
   isSafeMediaUrl,
   isVideoContentType,
+  isVideoFileUrl,
   localeName,
   localizeAnnouncement,
   localizeArticle,
@@ -3441,6 +3502,7 @@ var SHARED_VERSION = "0.15.0";
   queryConditionRegex,
   randomId,
   readableTextOn,
+  recordingLevel,
   relativeLuminance,
   resolveCaptureSettings,
   resolveLocale,
@@ -3461,6 +3523,7 @@ var SHARED_VERSION = "0.15.0";
   slugify,
   snapshotFromSelector,
   stableStringify,
+  stepVideo,
   stripOrigin,
   supportsPlatform,
   templateConfig,
@@ -3472,12 +3535,14 @@ var SHARED_VERSION = "0.15.0";
   validateGuideConfig,
   variantProblems,
   variantRanges,
+  videoThumbnailUrl,
   visibleAnnouncements,
   visibleArticleIds,
   visibleButtons,
   visitorAudiences,
   visitorLocales,
   withExperimentBucket,
+  withRecordingLevel,
   withVisibility
 });
 //# sourceMappingURL=index.cjs.map