@guidelytech/shared 0.8.0 → 0.9.0

package/dist/runtime.d.cts

@@ -78,7 +78,7 @@ declare function isChecklistComplete(config: {
 
 declare const RULE_OPERATORS: readonly ["equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "exists", "not_exists", "gt", "gte", "lt", "lte", "in", "not_in", "regex", "is_true", "is_false", "before", "after"];
 type RuleOperator = (typeof RULE_OPERATORS)[number];
-declare const RULE_FIELDS: readonly ["user.attribute", "account.attribute", "user.role", "user.plan", "url.path", "url.full", "url.query", "device.type", "device.browser", "device.os", "visitor.firstVisit", "visitor.returning", "event.seen", "guide.completed", "guide.dismissed", "guide.seen", "checklist.completed", "audience.member", "datetime.now", "datetime.dayOfWeek", "datetime.hour", "rollout.percentage", "environment", "locale", "app.platform", "app.screen", "app.version"];
+declare const RULE_FIELDS: readonly ["user.attribute", "account.attribute", "user.role", "user.plan", "user.identified", "url.path", "url.full", "url.query", "device.type", "device.browser", "device.os", "visitor.firstVisit", "visitor.returning", "event.seen", "guide.completed", "guide.dismissed", "guide.seen", "checklist.completed", "audience.member", "datetime.now", "datetime.dayOfWeek", "datetime.hour", "rollout.percentage", "environment", "locale", "app.platform", "app.screen", "app.version"];
 type RuleField = (typeof RULE_FIELDS)[number];
 interface Rule {
     id: string;
@@ -137,6 +137,15 @@ declare function evaluateRule(rule: Rule, ctx: TargetingContext): boolean;
 declare function evaluateRules(group: RuleGroup | null | undefined, ctx: TargetingContext): boolean;
 /** Fields whose evaluation requires server-held data. Used by docs/UI to annotate rules. */
 declare const SERVER_ASSISTED_FIELDS: RuleField[];
+/** Who a guide is shown to, before its targeting rules: everyone, only signed-in (identified) users, or only anonymous visitors. */
+declare const GUIDE_VISIBILITIES: readonly ["everyone", "identified", "anonymous"];
+type GuideVisibility = (typeof GUIDE_VISIBILITIES)[number];
+/**
+ * Targeting with the visibility folded in as a `user.identified` rule. The server sends guides to SDKs
+ * this way, so every SDK applies it through the rules it already evaluates (SDKs that predate the field
+ * resolve it as undefined and show the guide to nobody rather than to everyone).
+ */
+declare function withVisibility(targeting: RuleGroup, visibility: GuideVisibility | undefined): RuleGroup;
 declare function describeRule(rule: Rule): string;
 
 /** Reserved property names that are stripped from `properties` to avoid collecting sensitive data. */
@@ -196,6 +205,61 @@ declare const CAPTURE_PARAM = "guidely_capture";
 /** Largest screenshot the capture endpoint accepts. */
 declare const CAPTURE_SCREENSHOT_MAX_BYTES: number;
 
+/** Complaint types and limits shared by the server and the messenger runtime (zod-free). */
+/** Where a complaint is in its handling; the messenger shows it as Received → In review → Resolved. */
+declare const COMPLAINT_STATUSES: readonly ["open", "in_review", "resolved"];
+type ComplaintStatus = (typeof COMPLAINT_STATUSES)[number];
+/** Events a complaint webhook can fire on. */
+declare const COMPLAINT_EVENTS: readonly ["complaint.filed", "complaint.status_changed", "complaint.replied", "complaint.resolved"];
+type ComplaintEvent = (typeof COMPLAINT_EVENTS)[number];
+/** Extra questions a category asks for. */
+declare const COMPLAINT_FIELD_TYPES: readonly ["text", "choice"];
+type ComplaintFieldType = (typeof COMPLAINT_FIELD_TYPES)[number];
+declare const MAX_COMPLAINT_FIELDS = 8;
+declare const MAX_COMPLAINT_CHOICES = 12;
+declare const MAX_COMPLAINT_LENGTH = 4000;
+declare const MAX_COMPLAINT_ANSWER_LENGTH = 500;
+/** Largest screenshot the messenger may attach (after it scales the image down). */
+declare const MAX_COMPLAINT_ATTACHMENT_BYTES: number;
+interface ComplaintField {
+    /** Stable id (`invoice_number`), used as the answer's key in webhook payloads. */
+    id: string;
+    label: string;
+    type: ComplaintFieldType;
+    /** Choices for `choice` questions. */
+    options?: string[];
+    required: boolean;
+}
+/** "CMP-1042" for complaint number 1042. */
+declare const complaintReference: (number: number) => string;
+/** A category as the messenger offers it. */
+interface MessengerComplaintCategory {
+    id: string;
+    name: string;
+    description: string;
+    color: string;
+    fields: ComplaintField[];
+}
+/** Complaints block of `MessengerConfig`; absent when the project doesn't take complaints. */
+interface MessengerComplaintsConfig {
+    categories: MessengerComplaintCategory[];
+    /** Visitors the app hasn't identified may file one (with an email address). */
+    anonymous: boolean;
+}
+/** A complaint as the person who filed it sees it (on its conversation). */
+interface MessengerComplaint {
+    id: string;
+    reference: string;
+    status: ComplaintStatus;
+    categoryName: string;
+    createdAt: string;
+}
+/** Scout offered the complaint form in a reply, with this category picked. */
+interface MessengerComplaintOffer {
+    categoryId: string;
+    name: string;
+}
+
 /** rrweb plugin name for network events in recordings (event type 6, `data.plugin`). */
 declare const NETWORK_PLUGIN = "guidely/network@1";
 /** Request kinds, from `fetch`/`XMLHttpRequest` patching or `PerformanceResourceTiming.initiatorType`. */
@@ -385,8 +449,44 @@ declare function resourceCenterSections<C extends RcCollectionLike, A extends Rc
  * it must match. For articles outside a loaded list (e.g. server search results).
  */
 declare function isArticleListed(collections: readonly RcCollectionLike[], article: RcArticleLike, member?: Membership): boolean;
+/** Who an article is listed for, besides its audiences: everyone, or logged-in (identified) visitors only. */
+declare const ARTICLE_VISIBILITIES: readonly ["everyone", "identified"];
+type ArticleVisibility = (typeof ARTICLE_VISIBILITIES)[number];
+/**
+ * Reserved audience every logged-in visitor belongs to. The server folds an article's visibility into
+ * the audiences it serves and adds this one to identified visitors' memberships, so every SDK (old ones
+ * too) applies "logged-in only" through the audience matching it already does. Anonymous visitors never
+ * identify, so their membership is empty and these articles stay hidden.
+ */
+declare const LOGGED_IN_AUDIENCE = "$identified";
+/**
+ * The audiences an article is served with. Logged-in only with no audiences becomes the reserved
+ * audience; with audiences it is already implied, since audience membership only comes from identify.
+ */
+declare function servedArticleAudiences(audienceIds: readonly string[], visibility: ArticleVisibility | string | null | undefined): string[];
+/** A visitor's memberships as matched against served articles: logged-in visitors are also in `LOGGED_IN_AUDIENCE`. */
+declare function visitorAudiences(audienceIds: readonly string[], identified: boolean): string[];
 /** Ids of the articles a viewer sees (for filtering server search results the same way). */
 declare function visibleArticleIds(collections: readonly RcCollectionLike[], articles: readonly RcArticleLike[], member?: Membership): Set<string>;
+/**
+ * A "Show me" prompt in an article body is a plain link, `<p class="gd-show-me"><a href="#guidely-show-me:<guide key>">Show me how</a></p>`,
+ * so it survives every sanitizer and reads as a harmless link anywhere else. The widgets turn it into a
+ * button that starts the walkthrough (a live flow guide), or hide it when that guide isn't available.
+ */
+declare const SHOW_ME_CLASS = "gd-show-me";
+declare const SHOW_ME_HREF_PREFIX = "#guidely-show-me:";
+declare function showMeHref(guideKey: string): string;
+/** The guide key of a Show me link's `href`, or null. */
+declare function showMeKeyFromHref(href: string | null | undefined): string | null;
+/** Guide keys of the Show me prompts in an article body, in order, without repeats (at most 10). */
+declare function showMeKeys(html: string | null | undefined): string[];
+/** The article body plays a video (uploaded, or embedded from YouTube, Vimeo, Loom or Wistia). */
+declare function hasVideoMedia(html: string | null | undefined): boolean;
+/**
+ * Help search on the device: every word of the query starts a word of the text, in any order, or the
+ * query appears as typed. "add user" finds "Add a new user" and "Users › Add".
+ */
+declare function matchesHelpQuery(text: string, query: string): boolean;
 
 /**
  * Page helpers shared by the SDK (page-aware messenger) and the server (page matching, analytics).
@@ -395,10 +495,11 @@ declare function visibleArticleIds(collections: readonly RcCollectionLike[], art
 /**
  * One path segment that looks like an identifier: digits, a UUID, or a long hex string (hashes,
  * Mongo ids). Written so the same source works as a JS RegExp and a Postgres ARE (`regexp_replace`
- * with flags `gi`), which keeps id folding identical in SQL and in code.
+ * with flags `gi`), which keeps id folding identical in SQL and in code. A segment may be followed
+ * by the page query parameters a project keeps in its paths (`/contacts/42?tab=notes`).
  */
-declare const PATH_ID_PATTERN = "/([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[0-9a-f]{12,})(?=/|$)";
-/** `/contacts/42/notes/9f8e…` → `/contacts/:id/notes/:id`. */
+declare const PATH_ID_PATTERN = "/([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[0-9a-f]{12,})(?=[/?]|$)";
+/** `/contacts/42/notes/9f8e…` → `/contacts/:id/notes/:id`; `/contacts/42?tab=notes` → `/contacts/:id?tab=notes`. */
 declare function foldPathIds(path: string): string;
 /** Words describing a page, from its path (`/settings/billing-plans/42` → `settings billing plans`). */
 declare function pageTerms(path: string): string[];
@@ -407,4 +508,4 @@ declare function pageLabel(path: string): string | null;
 /** The first name in a user's traits (`firstName`, `first_name`, or the first word of `name`), or null. */
 declare function firstNameFromTraits(traits: Record<string, unknown> | null | undefined): string | null;
 
-export { CAPTURE_PARAM, CAPTURE_SCREENSHOT_MAX_BYTES, DEFAULT_PLATFORMS, EMBED_IFRAME_ATTRS, type EmbedProvider, type ExceptionProperties, 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, type MediaContentType, type MediaKind, NETWORK_PLUGIN, type NetworkPluginPayload, type NetworkRequest, type NetworkRequestType, PATH_ID_PATTERN, PDF_BLOCK_CLASS, PDF_MAX_PAGES, PDF_PAGES_CLASS, PLATFORMS, type Platform, RULE_FIELDS, RULE_OPERATORS, type RcArticleLike, type RcCollectionLike, type RcSection, type Rule, type RuleField, type RuleGroup, type RuleOperator, SENSITIVE_HEADER_PATTERN, SENSITIVE_PARAM_PATTERN, SENSITIVE_PROPERTY_PATTERN, SERVER_ASSISTED_FIELDS, SOURCEMAP_MAX_FILES_PER_UPLOAD, SOURCEMAP_MAX_FILE_BYTES, type ShowWhen, type StackFrame, type SurveyAnswer, type SurveyAnswers, type TargetingContext, VIDEO_ATTRS, type VideoEmbed, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, type WebSocketMessage, clamp, compare, compareVersions, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fingerprintError, firstNameFromTraits, fnv1a, foldPathIds, getPath, guidePlatforms, guidelyIdFromSelector, isAllowedEmbedSrc, isArticleListed, isChecklistComplete, isFileLink, isMediaContentType, isPlainObject, isQuestionVisible, isRuleGroup, isSafeMediaUrl, isVideoContentType, matchUrlPattern, matchesAudiences, mediaKind, mediaMaxBytes, normalizeErrorMessage, normalizeFrameFile, pageLabel, pageTerms, parseStack, randomId, resourceCenterSections, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, slugify, stripOrigin, supportsPlatform, toEmbedUrl, visibleArticleIds };
+export { ARTICLE_VISIBILITIES, type ArticleVisibility, CAPTURE_PARAM, CAPTURE_SCREENSHOT_MAX_BYTES, COMPLAINT_EVENTS, COMPLAINT_FIELD_TYPES, COMPLAINT_STATUSES, type ComplaintEvent, type ComplaintField, type ComplaintFieldType, type ComplaintStatus, DEFAULT_PLATFORMS, EMBED_IFRAME_ATTRS, type EmbedProvider, type ExceptionProperties, FILE_LINK_CLASS, GUIDELY_ID_ATTRIBUTE, GUIDE_VISIBILITIES, type GuideVisibility, 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, MEDIA_FILE_TYPES, MEDIA_IMAGE_MAX_BYTES, MEDIA_IMAGE_TYPES, MEDIA_MAX_BYTES, MEDIA_VIDEO_MAX_BYTES, MEDIA_VIDEO_TYPES, type MediaContentType, type MediaKind, type MessengerComplaint, type MessengerComplaintCategory, type MessengerComplaintOffer, type MessengerComplaintsConfig, NETWORK_PLUGIN, type NetworkPluginPayload, type NetworkRequest, type NetworkRequestType, PATH_ID_PATTERN, PDF_BLOCK_CLASS, PDF_MAX_PAGES, PDF_PAGES_CLASS, PLATFORMS, type Platform, RULE_FIELDS, RULE_OPERATORS, type RcArticleLike, type RcCollectionLike, type RcSection, type Rule, type RuleField, type RuleGroup, type RuleOperator, SENSITIVE_HEADER_PATTERN, 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, type ShowWhen, type StackFrame, type SurveyAnswer, type SurveyAnswers, type TargetingContext, VIDEO_ATTRS, type VideoEmbed, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, type WebSocketMessage, clamp, compare, compareVersions, complaintReference, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fingerprintError, firstNameFromTraits, fnv1a, foldPathIds, getPath, guidePlatforms, guidelyIdFromSelector, hasVideoMedia, isAllowedEmbedSrc, isArticleListed, isChecklistComplete, isFileLink, isMediaContentType, isPlainObject, isQuestionVisible, isRuleGroup, isSafeMediaUrl, isVideoContentType, matchUrlPattern, matchesAudiences, matchesHelpQuery, mediaKind, mediaMaxBytes, normalizeErrorMessage, normalizeFrameFile, pageLabel, pageTerms, parseStack, randomId, resourceCenterSections, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, servedArticleAudiences, showMeHref, showMeKeyFromHref, showMeKeys, slugify, stripOrigin, supportsPlatform, toEmbedUrl, visibleArticleIds, visitorAudiences, withVisibility };

package/dist/runtime.d.ts

@@ -78,7 +78,7 @@ declare function isChecklistComplete(config: {
 
 declare const RULE_OPERATORS: readonly ["equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "exists", "not_exists", "gt", "gte", "lt", "lte", "in", "not_in", "regex", "is_true", "is_false", "before", "after"];
 type RuleOperator = (typeof RULE_OPERATORS)[number];
-declare const RULE_FIELDS: readonly ["user.attribute", "account.attribute", "user.role", "user.plan", "url.path", "url.full", "url.query", "device.type", "device.browser", "device.os", "visitor.firstVisit", "visitor.returning", "event.seen", "guide.completed", "guide.dismissed", "guide.seen", "checklist.completed", "audience.member", "datetime.now", "datetime.dayOfWeek", "datetime.hour", "rollout.percentage", "environment", "locale", "app.platform", "app.screen", "app.version"];
+declare const RULE_FIELDS: readonly ["user.attribute", "account.attribute", "user.role", "user.plan", "user.identified", "url.path", "url.full", "url.query", "device.type", "device.browser", "device.os", "visitor.firstVisit", "visitor.returning", "event.seen", "guide.completed", "guide.dismissed", "guide.seen", "checklist.completed", "audience.member", "datetime.now", "datetime.dayOfWeek", "datetime.hour", "rollout.percentage", "environment", "locale", "app.platform", "app.screen", "app.version"];
 type RuleField = (typeof RULE_FIELDS)[number];
 interface Rule {
     id: string;
@@ -137,6 +137,15 @@ declare function evaluateRule(rule: Rule, ctx: TargetingContext): boolean;
 declare function evaluateRules(group: RuleGroup | null | undefined, ctx: TargetingContext): boolean;
 /** Fields whose evaluation requires server-held data. Used by docs/UI to annotate rules. */
 declare const SERVER_ASSISTED_FIELDS: RuleField[];
+/** Who a guide is shown to, before its targeting rules: everyone, only signed-in (identified) users, or only anonymous visitors. */
+declare const GUIDE_VISIBILITIES: readonly ["everyone", "identified", "anonymous"];
+type GuideVisibility = (typeof GUIDE_VISIBILITIES)[number];
+/**
+ * Targeting with the visibility folded in as a `user.identified` rule. The server sends guides to SDKs
+ * this way, so every SDK applies it through the rules it already evaluates (SDKs that predate the field
+ * resolve it as undefined and show the guide to nobody rather than to everyone).
+ */
+declare function withVisibility(targeting: RuleGroup, visibility: GuideVisibility | undefined): RuleGroup;
 declare function describeRule(rule: Rule): string;
 
 /** Reserved property names that are stripped from `properties` to avoid collecting sensitive data. */
@@ -196,6 +205,61 @@ declare const CAPTURE_PARAM = "guidely_capture";
 /** Largest screenshot the capture endpoint accepts. */
 declare const CAPTURE_SCREENSHOT_MAX_BYTES: number;
 
+/** Complaint types and limits shared by the server and the messenger runtime (zod-free). */
+/** Where a complaint is in its handling; the messenger shows it as Received → In review → Resolved. */
+declare const COMPLAINT_STATUSES: readonly ["open", "in_review", "resolved"];
+type ComplaintStatus = (typeof COMPLAINT_STATUSES)[number];
+/** Events a complaint webhook can fire on. */
+declare const COMPLAINT_EVENTS: readonly ["complaint.filed", "complaint.status_changed", "complaint.replied", "complaint.resolved"];
+type ComplaintEvent = (typeof COMPLAINT_EVENTS)[number];
+/** Extra questions a category asks for. */
+declare const COMPLAINT_FIELD_TYPES: readonly ["text", "choice"];
+type ComplaintFieldType = (typeof COMPLAINT_FIELD_TYPES)[number];
+declare const MAX_COMPLAINT_FIELDS = 8;
+declare const MAX_COMPLAINT_CHOICES = 12;
+declare const MAX_COMPLAINT_LENGTH = 4000;
+declare const MAX_COMPLAINT_ANSWER_LENGTH = 500;
+/** Largest screenshot the messenger may attach (after it scales the image down). */
+declare const MAX_COMPLAINT_ATTACHMENT_BYTES: number;
+interface ComplaintField {
+    /** Stable id (`invoice_number`), used as the answer's key in webhook payloads. */
+    id: string;
+    label: string;
+    type: ComplaintFieldType;
+    /** Choices for `choice` questions. */
+    options?: string[];
+    required: boolean;
+}
+/** "CMP-1042" for complaint number 1042. */
+declare const complaintReference: (number: number) => string;
+/** A category as the messenger offers it. */
+interface MessengerComplaintCategory {
+    id: string;
+    name: string;
+    description: string;
+    color: string;
+    fields: ComplaintField[];
+}
+/** Complaints block of `MessengerConfig`; absent when the project doesn't take complaints. */
+interface MessengerComplaintsConfig {
+    categories: MessengerComplaintCategory[];
+    /** Visitors the app hasn't identified may file one (with an email address). */
+    anonymous: boolean;
+}
+/** A complaint as the person who filed it sees it (on its conversation). */
+interface MessengerComplaint {
+    id: string;
+    reference: string;
+    status: ComplaintStatus;
+    categoryName: string;
+    createdAt: string;
+}
+/** Scout offered the complaint form in a reply, with this category picked. */
+interface MessengerComplaintOffer {
+    categoryId: string;
+    name: string;
+}
+
 /** rrweb plugin name for network events in recordings (event type 6, `data.plugin`). */
 declare const NETWORK_PLUGIN = "guidely/network@1";
 /** Request kinds, from `fetch`/`XMLHttpRequest` patching or `PerformanceResourceTiming.initiatorType`. */
@@ -385,8 +449,44 @@ declare function resourceCenterSections<C extends RcCollectionLike, A extends Rc
  * it must match. For articles outside a loaded list (e.g. server search results).
  */
 declare function isArticleListed(collections: readonly RcCollectionLike[], article: RcArticleLike, member?: Membership): boolean;
+/** Who an article is listed for, besides its audiences: everyone, or logged-in (identified) visitors only. */
+declare const ARTICLE_VISIBILITIES: readonly ["everyone", "identified"];
+type ArticleVisibility = (typeof ARTICLE_VISIBILITIES)[number];
+/**
+ * Reserved audience every logged-in visitor belongs to. The server folds an article's visibility into
+ * the audiences it serves and adds this one to identified visitors' memberships, so every SDK (old ones
+ * too) applies "logged-in only" through the audience matching it already does. Anonymous visitors never
+ * identify, so their membership is empty and these articles stay hidden.
+ */
+declare const LOGGED_IN_AUDIENCE = "$identified";
+/**
+ * The audiences an article is served with. Logged-in only with no audiences becomes the reserved
+ * audience; with audiences it is already implied, since audience membership only comes from identify.
+ */
+declare function servedArticleAudiences(audienceIds: readonly string[], visibility: ArticleVisibility | string | null | undefined): string[];
+/** A visitor's memberships as matched against served articles: logged-in visitors are also in `LOGGED_IN_AUDIENCE`. */
+declare function visitorAudiences(audienceIds: readonly string[], identified: boolean): string[];
 /** Ids of the articles a viewer sees (for filtering server search results the same way). */
 declare function visibleArticleIds(collections: readonly RcCollectionLike[], articles: readonly RcArticleLike[], member?: Membership): Set<string>;
+/**
+ * A "Show me" prompt in an article body is a plain link, `<p class="gd-show-me"><a href="#guidely-show-me:<guide key>">Show me how</a></p>`,
+ * so it survives every sanitizer and reads as a harmless link anywhere else. The widgets turn it into a
+ * button that starts the walkthrough (a live flow guide), or hide it when that guide isn't available.
+ */
+declare const SHOW_ME_CLASS = "gd-show-me";
+declare const SHOW_ME_HREF_PREFIX = "#guidely-show-me:";
+declare function showMeHref(guideKey: string): string;
+/** The guide key of a Show me link's `href`, or null. */
+declare function showMeKeyFromHref(href: string | null | undefined): string | null;
+/** Guide keys of the Show me prompts in an article body, in order, without repeats (at most 10). */
+declare function showMeKeys(html: string | null | undefined): string[];
+/** The article body plays a video (uploaded, or embedded from YouTube, Vimeo, Loom or Wistia). */
+declare function hasVideoMedia(html: string | null | undefined): boolean;
+/**
+ * Help search on the device: every word of the query starts a word of the text, in any order, or the
+ * query appears as typed. "add user" finds "Add a new user" and "Users › Add".
+ */
+declare function matchesHelpQuery(text: string, query: string): boolean;
 
 /**
  * Page helpers shared by the SDK (page-aware messenger) and the server (page matching, analytics).
@@ -395,10 +495,11 @@ declare function visibleArticleIds(collections: readonly RcCollectionLike[], art
 /**
  * One path segment that looks like an identifier: digits, a UUID, or a long hex string (hashes,
  * Mongo ids). Written so the same source works as a JS RegExp and a Postgres ARE (`regexp_replace`
- * with flags `gi`), which keeps id folding identical in SQL and in code.
+ * with flags `gi`), which keeps id folding identical in SQL and in code. A segment may be followed
+ * by the page query parameters a project keeps in its paths (`/contacts/42?tab=notes`).
  */
-declare const PATH_ID_PATTERN = "/([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[0-9a-f]{12,})(?=/|$)";
-/** `/contacts/42/notes/9f8e…` → `/contacts/:id/notes/:id`. */
+declare const PATH_ID_PATTERN = "/([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[0-9a-f]{12,})(?=[/?]|$)";
+/** `/contacts/42/notes/9f8e…` → `/contacts/:id/notes/:id`; `/contacts/42?tab=notes` → `/contacts/:id?tab=notes`. */
 declare function foldPathIds(path: string): string;
 /** Words describing a page, from its path (`/settings/billing-plans/42` → `settings billing plans`). */
 declare function pageTerms(path: string): string[];
@@ -407,4 +508,4 @@ declare function pageLabel(path: string): string | null;
 /** The first name in a user's traits (`firstName`, `first_name`, or the first word of `name`), or null. */
 declare function firstNameFromTraits(traits: Record<string, unknown> | null | undefined): string | null;
 
-export { CAPTURE_PARAM, CAPTURE_SCREENSHOT_MAX_BYTES, DEFAULT_PLATFORMS, EMBED_IFRAME_ATTRS, type EmbedProvider, type ExceptionProperties, 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, type MediaContentType, type MediaKind, NETWORK_PLUGIN, type NetworkPluginPayload, type NetworkRequest, type NetworkRequestType, PATH_ID_PATTERN, PDF_BLOCK_CLASS, PDF_MAX_PAGES, PDF_PAGES_CLASS, PLATFORMS, type Platform, RULE_FIELDS, RULE_OPERATORS, type RcArticleLike, type RcCollectionLike, type RcSection, type Rule, type RuleField, type RuleGroup, type RuleOperator, SENSITIVE_HEADER_PATTERN, SENSITIVE_PARAM_PATTERN, SENSITIVE_PROPERTY_PATTERN, SERVER_ASSISTED_FIELDS, SOURCEMAP_MAX_FILES_PER_UPLOAD, SOURCEMAP_MAX_FILE_BYTES, type ShowWhen, type StackFrame, type SurveyAnswer, type SurveyAnswers, type TargetingContext, VIDEO_ATTRS, type VideoEmbed, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, type WebSocketMessage, clamp, compare, compareVersions, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fingerprintError, firstNameFromTraits, fnv1a, foldPathIds, getPath, guidePlatforms, guidelyIdFromSelector, isAllowedEmbedSrc, isArticleListed, isChecklistComplete, isFileLink, isMediaContentType, isPlainObject, isQuestionVisible, isRuleGroup, isSafeMediaUrl, isVideoContentType, matchUrlPattern, matchesAudiences, mediaKind, mediaMaxBytes, normalizeErrorMessage, normalizeFrameFile, pageLabel, pageTerms, parseStack, randomId, resourceCenterSections, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, slugify, stripOrigin, supportsPlatform, toEmbedUrl, visibleArticleIds };
+export { ARTICLE_VISIBILITIES, type ArticleVisibility, CAPTURE_PARAM, CAPTURE_SCREENSHOT_MAX_BYTES, COMPLAINT_EVENTS, COMPLAINT_FIELD_TYPES, COMPLAINT_STATUSES, type ComplaintEvent, type ComplaintField, type ComplaintFieldType, type ComplaintStatus, DEFAULT_PLATFORMS, EMBED_IFRAME_ATTRS, type EmbedProvider, type ExceptionProperties, FILE_LINK_CLASS, GUIDELY_ID_ATTRIBUTE, GUIDE_VISIBILITIES, type GuideVisibility, 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, MEDIA_FILE_TYPES, MEDIA_IMAGE_MAX_BYTES, MEDIA_IMAGE_TYPES, MEDIA_MAX_BYTES, MEDIA_VIDEO_MAX_BYTES, MEDIA_VIDEO_TYPES, type MediaContentType, type MediaKind, type MessengerComplaint, type MessengerComplaintCategory, type MessengerComplaintOffer, type MessengerComplaintsConfig, NETWORK_PLUGIN, type NetworkPluginPayload, type NetworkRequest, type NetworkRequestType, PATH_ID_PATTERN, PDF_BLOCK_CLASS, PDF_MAX_PAGES, PDF_PAGES_CLASS, PLATFORMS, type Platform, RULE_FIELDS, RULE_OPERATORS, type RcArticleLike, type RcCollectionLike, type RcSection, type Rule, type RuleField, type RuleGroup, type RuleOperator, SENSITIVE_HEADER_PATTERN, 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, type ShowWhen, type StackFrame, type SurveyAnswer, type SurveyAnswers, type TargetingContext, VIDEO_ATTRS, type VideoEmbed, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, type WebSocketMessage, clamp, compare, compareVersions, complaintReference, describeRule, emptyRuleGroup, evaluateRule, evaluateRules, fingerprintError, firstNameFromTraits, fnv1a, foldPathIds, getPath, guidePlatforms, guidelyIdFromSelector, hasVideoMedia, isAllowedEmbedSrc, isArticleListed, isChecklistComplete, isFileLink, isMediaContentType, isPlainObject, isQuestionVisible, isRuleGroup, isSafeMediaUrl, isVideoContentType, matchUrlPattern, matchesAudiences, matchesHelpQuery, mediaKind, mediaMaxBytes, normalizeErrorMessage, normalizeFrameFile, pageLabel, pageTerms, parseStack, randomId, resourceCenterSections, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, servedArticleAudiences, showMeHref, showMeKeyFromHref, showMeKeys, slugify, stripOrigin, supportsPlatform, toEmbedUrl, visibleArticleIds, visitorAudiences, withVisibility };

package/dist/runtime.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,20 +87,37 @@ import {
   safeRegExp,
   sanitizeProperties,
   screenPath,
+  servedArticleAudiences,
+  showMeHref,
+  showMeKeyFromHref,
+  showMeKeys,
   slugify,
   stripOrigin,
   supportsPlatform,
   toEmbedUrl,
-  visibleArticleIds
-} from "./chunk-OLWGMDRX.js";
+  visibleArticleIds,
+  visitorAudiences,
+  withVisibility
+} from "./chunk-UW6NRYRY.js";
 export {
+  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,
@@ -106,6 +139,8 @@ export {
   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,
@@ -114,6 +149,7 @@ export {
   clamp,
   compare,
   compareVersions,
+  complaintReference,
   describeRule,
   emptyRuleGroup,
   evaluateRule,
@@ -125,6 +161,7 @@ export {
   getPath,
   guidePlatforms,
   guidelyIdFromSelector,
+  hasVideoMedia,
   isAllowedEmbedSrc,
   isArticleListed,
   isChecklistComplete,
@@ -137,6 +174,7 @@ export {
   isVideoContentType,
   matchUrlPattern,
   matchesAudiences,
+  matchesHelpQuery,
   mediaKind,
   mediaMaxBytes,
   normalizeErrorMessage,
@@ -150,10 +188,16 @@ export {
   safeRegExp,
   sanitizeProperties,
   screenPath,
+  servedArticleAudiences,
+  showMeHref,
+  showMeKeyFromHref,
+  showMeKeys,
   slugify,
   stripOrigin,
   supportsPlatform,
   toEmbedUrl,
-  visibleArticleIds
+  visibleArticleIds,
+  visitorAudiences,
+  withVisibility
 };
 //# sourceMappingURL=runtime.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guidelytech/shared",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Shared schemas, types and pure utilities for Guidely",
   "license": "MIT",
   "type": "module",
@@ -40,12 +40,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/parmarg/Guidely.git",
+    "url": "git+https://github.com/GuidelyTech/Guidely.git",
     "directory": "packages/shared"
   },
-  "homepage": "https://github.com/parmarg/Guidely/tree/main/packages/shared#readme",
+  "homepage": "https://github.com/GuidelyTech/Guidely/tree/main/packages/shared#readme",
   "bugs": {
-    "url": "https://github.com/parmarg/Guidely/issues"
+    "url": "https://github.com/GuidelyTech/Guidely/issues"
   },
   "keywords": [
     "guidely",