@guidelytech/react-native 0.4.1 → 0.6.1

package/dist/index.d.cts

@@ -319,7 +319,7 @@ interface UiState {
 }
 
 declare const SDK_NAME = "@guidelytech/react-native";
-declare const SDK_VERSION = "0.4.1";
+declare const SDK_VERSION = "0.6.1";
 declare const DEFAULT_API_URL = "https://guidelytech.com";
 /** Host-platform services the engine needs; the provider supplies React Native implementations. */
 interface PlatformBridge {
@@ -474,6 +474,8 @@ declare class GuidelyClient {
     dismissChecklist(guideId: string): void;
     submitSurvey(guideId: string, answers: Record<string, unknown>): void;
     closeSurvey(guideId: string): void;
+    /** The visitor's audiences (from the last identify), for audience-targeted help articles. */
+    getAudienceIds(): readonly string[];
     getResourceCenter(): ResourceCenterConfig | null;
     searchResourceCenter(q: string): Promise<ResourceCenterArticle[]>;
     articleViewed(article: ResourceCenterArticle): void;
@@ -634,8 +636,17 @@ declare function GuidelyOverlay({ client, insets: insetsProp, launcherOffset }:
 /**
  * Tiny, tolerant HTML → rich-text converter for guide bodies (already sanitized server-side).
  * Supports p, div, br, strong/b, em/i, u, a, code, ul/ol/li, h1–h6 and blockquote; every other tag
- * is reduced to its text. Output is plain data so it can be unit-tested without React Native.
+ * is reduced to its text. `img` becomes an image block, and `video` / canonical embed `iframe`s
+ * become video blocks (shown as a link that opens the video). A PDF (`div.gd-pdf`: its link and its
+ * pages as images) becomes one pdf block, and a lone file link (`a.gd-file`) a file block. Output is
+ * plain data so it can be unit-tested without React Native.
  */
+interface PdfPage {
+    src: string;
+    alt: string;
+    width?: number;
+    height?: number;
+}
 interface TextRun {
     text: string;
     bold?: boolean;
@@ -645,12 +656,23 @@ interface TextRun {
     href?: string;
 }
 interface TextBlock {
-    kind: "paragraph" | "heading" | "list-item" | "quote";
+    kind: "paragraph" | "heading" | "list-item" | "quote" | "image" | "video" | "pdf" | "file";
     /** Heading level 1–3, list nesting depth from 1. */
     level: number;
     /** For list items: the bullet ("•") or number ("1.") to show. */
     marker?: string;
     runs: TextRun[];
+    /** Image blocks: http(s) or data:image source. */
+    src?: string;
+    /** Image alt text, a video's label, or a PDF's file name. */
+    alt?: string;
+    /** Video, pdf and file blocks: the page or file to open. */
+    href?: string;
+    /** Pdf blocks: the rendered pages, in order. */
+    pages?: PdfPage[];
+    /** Image intrinsic size from `width`/`height`, when present. */
+    width?: number;
+    height?: number;
 }
 declare function parseHtml(html: string): TextBlock[];
 /** Plain-text rendering of an HTML body (accessibility labels, previews). */

package/dist/index.d.ts

@@ -319,7 +319,7 @@ interface UiState {
 }
 
 declare const SDK_NAME = "@guidelytech/react-native";
-declare const SDK_VERSION = "0.4.1";
+declare const SDK_VERSION = "0.6.1";
 declare const DEFAULT_API_URL = "https://guidelytech.com";
 /** Host-platform services the engine needs; the provider supplies React Native implementations. */
 interface PlatformBridge {
@@ -474,6 +474,8 @@ declare class GuidelyClient {
     dismissChecklist(guideId: string): void;
     submitSurvey(guideId: string, answers: Record<string, unknown>): void;
     closeSurvey(guideId: string): void;
+    /** The visitor's audiences (from the last identify), for audience-targeted help articles. */
+    getAudienceIds(): readonly string[];
     getResourceCenter(): ResourceCenterConfig | null;
     searchResourceCenter(q: string): Promise<ResourceCenterArticle[]>;
     articleViewed(article: ResourceCenterArticle): void;
@@ -634,8 +636,17 @@ declare function GuidelyOverlay({ client, insets: insetsProp, launcherOffset }:
 /**
  * Tiny, tolerant HTML → rich-text converter for guide bodies (already sanitized server-side).
  * Supports p, div, br, strong/b, em/i, u, a, code, ul/ol/li, h1–h6 and blockquote; every other tag
- * is reduced to its text. Output is plain data so it can be unit-tested without React Native.
+ * is reduced to its text. `img` becomes an image block, and `video` / canonical embed `iframe`s
+ * become video blocks (shown as a link that opens the video). A PDF (`div.gd-pdf`: its link and its
+ * pages as images) becomes one pdf block, and a lone file link (`a.gd-file`) a file block. Output is
+ * plain data so it can be unit-tested without React Native.
  */
+interface PdfPage {
+    src: string;
+    alt: string;
+    width?: number;
+    height?: number;
+}
 interface TextRun {
     text: string;
     bold?: boolean;
@@ -645,12 +656,23 @@ interface TextRun {
     href?: string;
 }
 interface TextBlock {
-    kind: "paragraph" | "heading" | "list-item" | "quote";
+    kind: "paragraph" | "heading" | "list-item" | "quote" | "image" | "video" | "pdf" | "file";
     /** Heading level 1–3, list nesting depth from 1. */
     level: number;
     /** For list items: the bullet ("•") or number ("1.") to show. */
     marker?: string;
     runs: TextRun[];
+    /** Image blocks: http(s) or data:image source. */
+    src?: string;
+    /** Image alt text, a video's label, or a PDF's file name. */
+    alt?: string;
+    /** Video, pdf and file blocks: the page or file to open. */
+    href?: string;
+    /** Pdf blocks: the rendered pages, in order. */
+    pages?: PdfPage[];
+    /** Image intrinsic size from `width`/`height`, when present. */
+    width?: number;
+    height?: number;
 }
 declare function parseHtml(html: string): TextBlock[];
 /** Plain-text rendering of an HTML body (accessibility labels, previews). */