@guidelytech/shared 0.4.1 → 0.5.0

package/dist/runtime.d.ts

@@ -266,4 +266,92 @@ declare const SENSITIVE_HEADER_PATTERN: RegExp;
 /** Query parameter and JSON field names whose values are redacted. */
 declare const SENSITIVE_PARAM_PATTERN: RegExp;
 
-export { DEFAULT_PLATFORMS, type ExceptionProperties, GUIDELY_ID_ATTRIBUTE, MAX_PROPERTY_BYTES, MAX_STACK_FRAMES, NETWORK_PLUGIN, type NetworkPluginPayload, type NetworkRequest, type NetworkRequestType, PLATFORMS, type Platform, RULE_FIELDS, RULE_OPERATORS, 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, WS_MAX_MESSAGES_PER_SOCKET, WS_MAX_MESSAGE_BYTES, type WebSocketMessage, 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, supportsPlatform };
+/**
+ * Media in article bodies: uploaded images and videos, and video embeds from a fixed set of hosts.
+ * Sanitizers (server, browser runtime) only keep an `<iframe>` whose `src` is the canonical embed URL
+ * that `toEmbedUrl` produces, so authors can never point a frame anywhere else.
+ */
+type EmbedProvider = "youtube" | "vimeo" | "loom" | "wistia";
+interface VideoEmbed {
+    provider: EmbedProvider;
+    /** Canonical player URL, safe to use as an iframe `src`. */
+    src: string;
+    /** Page a viewer can open instead (native SDKs show a link rather than a player). */
+    watchUrl: string;
+    /** Accessible iframe title. */
+    title: string;
+}
+declare const MEDIA_IMAGE_TYPES: readonly ["image/png", "image/jpeg", "image/gif", "image/webp"];
+declare const MEDIA_VIDEO_TYPES: readonly ["video/mp4", "video/webm"];
+type MediaContentType = (typeof MEDIA_IMAGE_TYPES)[number] | (typeof MEDIA_VIDEO_TYPES)[number];
+declare const MEDIA_IMAGE_MAX_BYTES: number;
+declare const MEDIA_VIDEO_MAX_BYTES: number;
+declare function isMediaContentType(type: string): type is MediaContentType;
+declare function isVideoContentType(type: string): boolean;
+declare function mediaMaxBytes(type: string): number;
+/**
+ * Turns a pasted video page or player URL from YouTube, Vimeo, Loom or Wistia into its canonical
+ * embed. Returns null for anything else, including lookalike hosts.
+ */
+declare function toEmbedUrl(input: string): VideoEmbed | null;
+/** True only for a canonical embed URL (exactly what `toEmbedUrl` returns), so an iframe can't be pointed elsewhere. */
+declare function isAllowedEmbedSrc(src: string | null | undefined): boolean;
+/** Fixed iframe attributes for an embed; sanitizers overwrite whatever the author's HTML carried. */
+declare const EMBED_IFRAME_ATTRS: Readonly<Record<string, string>>;
+/** Fixed `<video>` attributes: player controls, no autoplay or loop. */
+declare const VIDEO_ATTRS: Readonly<Record<string, string>>;
+/** `<video src>` / `poster` must be plain http(s): no data:, blob: or relative URLs (bodies render on customer sites). */
+declare function isSafeMediaUrl(url: string | null | undefined): boolean;
+
+/**
+ * Resource center structure shared by every SDK: nested collections and audience targeting.
+ *
+ * Audience targeting decides what the help widget lists; it is not access control. The published
+ * config (and every article body) is the same for all visitors of an environment, and end-user
+ * identities are self-asserted, so never rely on it to keep an article private.
+ */
+/** Collections nest at most this deep (a collection, its sections, and their sub-sections). */
+declare const MAX_COLLECTION_DEPTH = 3;
+interface RcCollectionLike {
+    id: string;
+    name: string;
+    order: number;
+    /** Parent collection; null/absent for a top-level collection. */
+    parentId?: string | null;
+    /** Shown only to members of any of these audiences; empty/absent means everyone. */
+    audienceIds?: string[];
+}
+interface RcArticleLike {
+    id: string;
+    collectionId?: string | null;
+    audienceIds?: string[];
+}
+interface RcSection<C extends RcCollectionLike, A extends RcArticleLike> {
+    /** null for articles outside any (known) collection. */
+    collection: C | null;
+    /** Collection names from the top level down, e.g. ["Billing", "Invoices"]. */
+    path: string[];
+    /** 0 for a top-level collection. */
+    depth: number;
+    articles: A[];
+}
+type Membership = ReadonlySet<string> | readonly string[] | undefined | null;
+/** True when an item targeted at `required` audiences is shown to someone in `member`. */
+declare function matchesAudiences(required: readonly string[] | undefined | null, member: Membership): boolean;
+/**
+ * Article sections in display order: each collection (depth first, siblings by `order`) with the
+ * visible articles filed directly in it, then the uncategorized articles. A collection the viewer
+ * isn't targeted by hides its whole subtree, and sections without visible articles are left out
+ * (their sub-collections still appear). Unknown parents count as top level, so an old config or a
+ * dangling reference never hides content.
+ */
+declare function resourceCenterSections<C extends RcCollectionLike, A extends RcArticleLike>(collections: readonly C[], articles: readonly A[], member?: Membership): Array<RcSection<C, A>>;
+/**
+ * Whether one article is listed for a viewer: its own audiences and those of every collection above
+ * 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;
+/** 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>;
+
+export { DEFAULT_PLATFORMS, EMBED_IFRAME_ATTRS, type EmbedProvider, type ExceptionProperties, GUIDELY_ID_ATTRIBUTE, MAX_COLLECTION_DEPTH, MAX_PROPERTY_BYTES, MAX_STACK_FRAMES, MEDIA_IMAGE_MAX_BYTES, MEDIA_IMAGE_TYPES, MEDIA_VIDEO_MAX_BYTES, MEDIA_VIDEO_TYPES, type MediaContentType, NETWORK_PLUGIN, type NetworkPluginPayload, type NetworkRequest, type NetworkRequestType, 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, fnv1a, getPath, guidePlatforms, guidelyIdFromSelector, isAllowedEmbedSrc, isArticleListed, isChecklistComplete, isMediaContentType, isPlainObject, isQuestionVisible, isRuleGroup, isSafeMediaUrl, isVideoContentType, matchUrlPattern, matchesAudiences, mediaMaxBytes, normalizeErrorMessage, normalizeFrameFile, parseStack, randomId, resourceCenterSections, rolloutBucket, safeRegExp, sanitizeProperties, screenPath, slugify, stripOrigin, supportsPlatform, toEmbedUrl, visibleArticleIds };

package/dist/runtime.js

@@ -1,8 +1,14 @@
 import {
   DEFAULT_PLATFORMS,
+  EMBED_IFRAME_ATTRS,
   GUIDELY_ID_ATTRIBUTE,
+  MAX_COLLECTION_DEPTH,
   MAX_PROPERTY_BYTES,
   MAX_STACK_FRAMES,
+  MEDIA_IMAGE_MAX_BYTES,
+  MEDIA_IMAGE_TYPES,
+  MEDIA_VIDEO_MAX_BYTES,
+  MEDIA_VIDEO_TYPES,
   NETWORK_PLUGIN,
   PLATFORMS,
   RULE_FIELDS,
@@ -13,6 +19,7 @@ import {
   SERVER_ASSISTED_FIELDS,
   SOURCEMAP_MAX_FILES_PER_UPLOAD,
   SOURCEMAP_MAX_FILE_BYTES,
+  VIDEO_ATTRS,
   WS_MAX_MESSAGES_PER_SOCKET,
   WS_MAX_MESSAGE_BYTES,
   clamp,
@@ -27,28 +34,44 @@ import {
   getPath,
   guidePlatforms,
   guidelyIdFromSelector,
+  isAllowedEmbedSrc,
+  isArticleListed,
   isChecklistComplete,
+  isMediaContentType,
   isPlainObject,
   isQuestionVisible,
   isRuleGroup,
+  isSafeMediaUrl,
+  isVideoContentType,
   matchUrlPattern,
+  matchesAudiences,
+  mediaMaxBytes,
   normalizeErrorMessage,
   normalizeFrameFile,
   parseStack,
   randomId,
+  resourceCenterSections,
   rolloutBucket,
   safeRegExp,
   sanitizeProperties,
   screenPath,
   slugify,
   stripOrigin,
-  supportsPlatform
-} from "./chunk-QUKMOTT4.js";
+  supportsPlatform,
+  toEmbedUrl,
+  visibleArticleIds
+} from "./chunk-5IQVBZO6.js";
 export {
   DEFAULT_PLATFORMS,
+  EMBED_IFRAME_ATTRS,
   GUIDELY_ID_ATTRIBUTE,
+  MAX_COLLECTION_DEPTH,
   MAX_PROPERTY_BYTES,
   MAX_STACK_FRAMES,
+  MEDIA_IMAGE_MAX_BYTES,
+  MEDIA_IMAGE_TYPES,
+  MEDIA_VIDEO_MAX_BYTES,
+  MEDIA_VIDEO_TYPES,
   NETWORK_PLUGIN,
   PLATFORMS,
   RULE_FIELDS,
@@ -59,6 +82,7 @@ export {
   SERVER_ASSISTED_FIELDS,
   SOURCEMAP_MAX_FILES_PER_UPLOAD,
   SOURCEMAP_MAX_FILE_BYTES,
+  VIDEO_ATTRS,
   WS_MAX_MESSAGES_PER_SOCKET,
   WS_MAX_MESSAGE_BYTES,
   clamp,
@@ -73,21 +97,31 @@ export {
   getPath,
   guidePlatforms,
   guidelyIdFromSelector,
+  isAllowedEmbedSrc,
+  isArticleListed,
   isChecklistComplete,
+  isMediaContentType,
   isPlainObject,
   isQuestionVisible,
   isRuleGroup,
+  isSafeMediaUrl,
+  isVideoContentType,
   matchUrlPattern,
+  matchesAudiences,
+  mediaMaxBytes,
   normalizeErrorMessage,
   normalizeFrameFile,
   parseStack,
   randomId,
+  resourceCenterSections,
   rolloutBucket,
   safeRegExp,
   sanitizeProperties,
   screenPath,
   slugify,
   stripOrigin,
-  supportsPlatform
+  supportsPlatform,
+  toEmbedUrl,
+  visibleArticleIds
 };
 //# sourceMappingURL=runtime.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guidelytech/shared",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Shared schemas, types and pure utilities for Guidely",
   "license": "MIT",
   "type": "module",