@syntrologie/runtime-sdk 2.8.0-canary.205 → 2.8.0-canary.207

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/version.d.ts CHANGED
@@ -10,4 +10,4 @@
10
10
  *
11
11
  * @since 2.0.0
12
12
  */
13
- export declare const SDK_VERSION = "2.8.0-canary.205";
13
+ export declare const SDK_VERSION = "2.8.0-canary.207";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@syntrologie/runtime-sdk",
3
- "version": "2.8.0-canary.205",
3
+ "version": "2.8.0-canary.207",
4
4
  "description": "Syntrologie Runtime SDK for web experimentation and analytics",
5
5
  "license": "Proprietary",
6
6
  "private": false,
@@ -29,7 +29,8 @@
29
29
  "standard",
30
30
  "focused",
31
31
  "inline"
32
- ]
32
+ ],
33
+ "description": "DO NOT SET — determined automatically by the runtime based on the surface type (web → standard, agent/MCP → inline). Setting this field will be stripped by the config fixer."
33
34
  },
34
35
  "tiles": {
35
36
  "type": "array",
@@ -2919,7 +2920,7 @@
2919
2920
  "type": {
2920
2921
  "type": "string",
2921
2922
  "const": "rich",
2922
- "description": "Use this variant when the answer is pre-rendered HTML."
2923
+ "description": "Last-resort variant. Only use when the answer needs HTML elements markdown cannot produce: a real <button>, an embedded <iframe>, a <form>, or a structural <table> with attributes. Otherwise use a plain string with markdown."
2923
2924
  },
2924
2925
  "html": {
2925
2926
  "type": "string",
@@ -2931,7 +2932,7 @@
2931
2932
  "html"
2932
2933
  ],
2933
2934
  "additionalProperties": false,
2934
- "description": "Rich HTML answer: use when the answer content is pre-rendered HTML markup."
2935
+ "description": "Rich HTML answer. Use only when the answer needs HTML markdown cannot produce — buttons, iframes, forms, structural tables. Plain text, bold/italic, links, and lists all belong in a plain string with markdown."
2935
2936
  },
2936
2937
  {
2937
2938
  "type": "object",
@@ -2939,7 +2940,7 @@
2939
2940
  "type": {
2940
2941
  "type": "string",
2941
2942
  "const": "markdown",
2942
- "description": "Use this variant for markdown with embedded images or video via the assets array."
2943
+ "description": "Markdown answer with a sidecar `assets` array. Renders identically to a plain-string answer — the only reason to choose this shape is to attach named media (images, video) with metadata (alt, width, height) and reference them via `asset:<id>` URIs. For inline images with raw URLs, a plain string is simpler."
2943
2944
  },
2944
2945
  "content": {
2945
2946
  "type": "string",
@@ -2995,10 +2996,10 @@
2995
2996
  "content"
2996
2997
  ],
2997
2998
  "additionalProperties": false,
2998
- "description": "Enhanced markdown answer: use when the answer mixes formatted text with images or video assets."
2999
+ "description": "Markdown answer with a named-assets sidecar. Same renderer as a plain-string answer; the only difference is that media is referenced by id with metadata instead of inlined as raw URLs."
2999
3000
  }
3000
3001
  ],
3001
- "description": "Answer content. Use a plain string for simple text, \"rich\" for pre-rendered HTML, or \"markdown\" for formatted text with embedded assets."
3002
+ "description": "Answer content. DEFAULT: a plain string with markdown — paragraphs, **bold**, *italic*, `code`, [links](url), and bulleted/numbered lists all render via GFM. Use \"rich\" HTML ONLY when the answer needs HTML markdown cannot produce (buttons, iframes, forms, structural tables) — there must be a real reason. Use \"markdown\" (the object form) only when you need named media assets with metadata; otherwise a plain string is simpler."
3002
3003
  },
3003
3004
  "category": {
3004
3005
  "type": "string",
@@ -3267,7 +3268,7 @@
3267
3268
  "type": {
3268
3269
  "type": "string",
3269
3270
  "const": "rich",
3270
- "description": "Use this variant when the answer is pre-rendered HTML."
3271
+ "description": "Last-resort variant. Only use when the answer needs HTML elements markdown cannot produce: a real <button>, an embedded <iframe>, a <form>, or a structural <table> with attributes. Otherwise use a plain string with markdown."
3271
3272
  },
3272
3273
  "html": {
3273
3274
  "type": "string",
@@ -3279,7 +3280,7 @@
3279
3280
  "html"
3280
3281
  ],
3281
3282
  "additionalProperties": false,
3282
- "description": "Rich HTML answer: use when the answer content is pre-rendered HTML markup."
3283
+ "description": "Rich HTML answer. Use only when the answer needs HTML markdown cannot produce — buttons, iframes, forms, structural tables. Plain text, bold/italic, links, and lists all belong in a plain string with markdown."
3283
3284
  },
3284
3285
  {
3285
3286
  "type": "object",
@@ -3287,7 +3288,7 @@
3287
3288
  "type": {
3288
3289
  "type": "string",
3289
3290
  "const": "markdown",
3290
- "description": "Use this variant for markdown with embedded images or video via the assets array."
3291
+ "description": "Markdown answer with a sidecar `assets` array. Renders identically to a plain-string answer — the only reason to choose this shape is to attach named media (images, video) with metadata (alt, width, height) and reference them via `asset:<id>` URIs. For inline images with raw URLs, a plain string is simpler."
3291
3292
  },
3292
3293
  "content": {
3293
3294
  "type": "string",
@@ -3343,10 +3344,10 @@
3343
3344
  "content"
3344
3345
  ],
3345
3346
  "additionalProperties": false,
3346
- "description": "Enhanced markdown answer: use when the answer mixes formatted text with images or video assets."
3347
+ "description": "Markdown answer with a named-assets sidecar. Same renderer as a plain-string answer; the only difference is that media is referenced by id with metadata instead of inlined as raw URLs."
3347
3348
  }
3348
3349
  ],
3349
- "description": "Answer content. Use a plain string for simple text, \"rich\" for pre-rendered HTML, or \"markdown\" for formatted text with embedded assets."
3350
+ "description": "Answer content. DEFAULT: a plain string with markdown — paragraphs, **bold**, *italic*, `code`, [links](url), and bulleted/numbered lists all render via GFM. Use \"rich\" HTML ONLY when the answer needs HTML markdown cannot produce (buttons, iframes, forms, structural tables) — there must be a real reason. Use \"markdown\" (the object form) only when you need named media assets with metadata; otherwise a plain string is simpler."
3350
3351
  },
3351
3352
  "category": {
3352
3353
  "type": "string",
@@ -4368,7 +4369,7 @@
4368
4369
  "type": {
4369
4370
  "type": "string",
4370
4371
  "const": "rich",
4371
- "description": "Use this variant when the answer is pre-rendered HTML."
4372
+ "description": "Last-resort variant. Only use when the answer needs HTML elements markdown cannot produce: a real <button>, an embedded <iframe>, a <form>, or a structural <table> with attributes. Otherwise use a plain string with markdown."
4372
4373
  },
4373
4374
  "html": {
4374
4375
  "type": "string",
@@ -4380,7 +4381,7 @@
4380
4381
  "html"
4381
4382
  ],
4382
4383
  "additionalProperties": false,
4383
- "description": "Rich HTML answer: use when the answer content is pre-rendered HTML markup."
4384
+ "description": "Rich HTML answer. Use only when the answer needs HTML markdown cannot produce — buttons, iframes, forms, structural tables. Plain text, bold/italic, links, and lists all belong in a plain string with markdown."
4384
4385
  },
4385
4386
  {
4386
4387
  "type": "object",
@@ -4388,7 +4389,7 @@
4388
4389
  "type": {
4389
4390
  "type": "string",
4390
4391
  "const": "markdown",
4391
- "description": "Use this variant for markdown with embedded images or video via the assets array."
4392
+ "description": "Markdown answer with a sidecar `assets` array. Renders identically to a plain-string answer — the only reason to choose this shape is to attach named media (images, video) with metadata (alt, width, height) and reference them via `asset:<id>` URIs. For inline images with raw URLs, a plain string is simpler."
4392
4393
  },
4393
4394
  "content": {
4394
4395
  "type": "string",
@@ -4444,10 +4445,10 @@
4444
4445
  "content"
4445
4446
  ],
4446
4447
  "additionalProperties": false,
4447
- "description": "Enhanced markdown answer: use when the answer mixes formatted text with images or video assets."
4448
+ "description": "Markdown answer with a named-assets sidecar. Same renderer as a plain-string answer; the only difference is that media is referenced by id with metadata instead of inlined as raw URLs."
4448
4449
  }
4449
4450
  ],
4450
- "description": "Answer content. Use a plain string for simple text, \"rich\" for pre-rendered HTML, or \"markdown\" for formatted text with embedded assets."
4451
+ "description": "Answer content. DEFAULT: a plain string with markdown — paragraphs, **bold**, *italic*, `code`, [links](url), and bulleted/numbered lists all render via GFM. Use \"rich\" HTML ONLY when the answer needs HTML markdown cannot produce (buttons, iframes, forms, structural tables) — there must be a real reason. Use \"markdown\" (the object form) only when you need named media assets with metadata; otherwise a plain string is simpler."
4451
4452
  },
4452
4453
  "category": {
4453
4454
  "type": "string",
@@ -5635,7 +5636,7 @@
5635
5636
  "type": {
5636
5637
  "type": "string",
5637
5638
  "const": "rich",
5638
- "description": "Use this variant when the answer is pre-rendered HTML."
5639
+ "description": "Last-resort variant. Only use when the answer needs HTML elements markdown cannot produce: a real <button>, an embedded <iframe>, a <form>, or a structural <table> with attributes. Otherwise use a plain string with markdown."
5639
5640
  },
5640
5641
  "html": {
5641
5642
  "type": "string",
@@ -5647,7 +5648,7 @@
5647
5648
  "html"
5648
5649
  ],
5649
5650
  "additionalProperties": false,
5650
- "description": "Rich HTML answer: use when the answer content is pre-rendered HTML markup."
5651
+ "description": "Rich HTML answer. Use only when the answer needs HTML markdown cannot produce — buttons, iframes, forms, structural tables. Plain text, bold/italic, links, and lists all belong in a plain string with markdown."
5651
5652
  },
5652
5653
  {
5653
5654
  "type": "object",
@@ -5655,7 +5656,7 @@
5655
5656
  "type": {
5656
5657
  "type": "string",
5657
5658
  "const": "markdown",
5658
- "description": "Use this variant for markdown with embedded images or video via the assets array."
5659
+ "description": "Markdown answer with a sidecar `assets` array. Renders identically to a plain-string answer — the only reason to choose this shape is to attach named media (images, video) with metadata (alt, width, height) and reference them via `asset:<id>` URIs. For inline images with raw URLs, a plain string is simpler."
5659
5660
  },
5660
5661
  "content": {
5661
5662
  "type": "string",
@@ -5711,10 +5712,10 @@
5711
5712
  "content"
5712
5713
  ],
5713
5714
  "additionalProperties": false,
5714
- "description": "Enhanced markdown answer: use when the answer mixes formatted text with images or video assets."
5715
+ "description": "Markdown answer with a named-assets sidecar. Same renderer as a plain-string answer; the only difference is that media is referenced by id with metadata instead of inlined as raw URLs."
5715
5716
  }
5716
5717
  ],
5717
- "description": "Answer content. Use a plain string for simple text, \"rich\" for pre-rendered HTML, or \"markdown\" for formatted text with embedded assets."
5718
+ "description": "Answer content. DEFAULT: a plain string with markdown — paragraphs, **bold**, *italic*, `code`, [links](url), and bulleted/numbered lists all render via GFM. Use \"rich\" HTML ONLY when the answer needs HTML markdown cannot produce (buttons, iframes, forms, structural tables) — there must be a real reason. Use \"markdown\" (the object form) only when you need named media assets with metadata; otherwise a plain string is simpler."
5718
5719
  },
5719
5720
  "category": {
5720
5721
  "type": "string",
@@ -7533,8 +7534,8 @@
7533
7534
  "description": "faq:question actions are configuration data rendered by the accordion widget, not actions executed by the runtime. This allows per-item conditional visibility via triggerWhen, category grouping under collapsible section headers, and dynamic injection of contextual items."
7534
7535
  },
7535
7536
  {
7536
- "name": "Rich answer content formats",
7537
- "description": "FAQ answers support three formats: plain string (simple text with basic markdown), rich HTML ({ \"type\": \"rich\", \"html\": \"<p>...</p>\" } for pre-rendered content), or enhanced markdown ({ \"type\": \"markdown\", \"content\": \"...\", \"assets\": [...] } with embedded media via asset:<id> URIs)."
7537
+ "name": "Answer format always prefer markdown",
7538
+ "description": "Always use a plain string with markdown for FAQ answers. The only real reason to reach for the \"rich\" HTML variant is when the answer needs an HTML element markdown cannot produce — a real <button>, an <iframe>, a <form>, or a structural <table>. Bold/italic, links, lists, code blocks, and inline images all render fine from a plain string. The \"markdown\" object variant exists only for named-asset references with metadata; otherwise a plain string is simpler."
7538
7539
  },
7539
7540
  {
7540
7541
  "name": "Companion overlay tooltips",