@liforma/client 0.2.1

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.
Files changed (274) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/LICENSE +21 -0
  3. package/README.md +103 -0
  4. package/dist/next/index.js +5186 -0
  5. package/dist/next/index.js.map +1 -0
  6. package/dist/next/next/createLiformaSessionRouteHandler.d.ts +45 -0
  7. package/dist/next/next/createLiformaSessionRouteHandler.d.ts.map +1 -0
  8. package/dist/next/next/index.d.ts +8 -0
  9. package/dist/next/next/index.d.ts.map +1 -0
  10. package/dist/next/react/ExperienceThumbnail.d.ts +22 -0
  11. package/dist/next/react/ExperienceThumbnail.d.ts.map +1 -0
  12. package/dist/next/react/ExperienceWidget.d.ts +35 -0
  13. package/dist/next/react/ExperienceWidget.d.ts.map +1 -0
  14. package/dist/next/shims/apiBaseUrl.d.ts +14 -0
  15. package/dist/next/shims/apiBaseUrl.d.ts.map +1 -0
  16. package/dist/next/shims/localStack.d.ts +6 -0
  17. package/dist/next/shims/localStack.d.ts.map +1 -0
  18. package/dist/next/thumbnail/attachThumbnailParallax.d.ts +7 -0
  19. package/dist/next/thumbnail/attachThumbnailParallax.d.ts.map +1 -0
  20. package/dist/next/thumbnail/ensureStyles.d.ts +3 -0
  21. package/dist/next/thumbnail/ensureStyles.d.ts.map +1 -0
  22. package/dist/next/thumbnail/hostedLaunchUrl.d.ts +23 -0
  23. package/dist/next/thumbnail/hostedLaunchUrl.d.ts.map +1 -0
  24. package/dist/next/thumbnail/index.d.ts +9 -0
  25. package/dist/next/thumbnail/index.d.ts.map +1 -0
  26. package/dist/next/thumbnail/lazyLoad.d.ts +8 -0
  27. package/dist/next/thumbnail/lazyLoad.d.ts.map +1 -0
  28. package/dist/next/thumbnail/scrollParallax.d.ts +13 -0
  29. package/dist/next/thumbnail/scrollParallax.d.ts.map +1 -0
  30. package/dist/next/thumbnail/styles.d.ts +3 -0
  31. package/dist/next/thumbnail/styles.d.ts.map +1 -0
  32. package/dist/next/thumbnail/toGalleryThumbUrl.d.ts +23 -0
  33. package/dist/next/thumbnail/toGalleryThumbUrl.d.ts.map +1 -0
  34. package/dist/next/thumbnail/toGalleryThumbUrl.test.d.ts +2 -0
  35. package/dist/next/thumbnail/toGalleryThumbUrl.test.d.ts.map +1 -0
  36. package/dist/next/thumbnail/types.d.ts +37 -0
  37. package/dist/next/thumbnail/types.d.ts.map +1 -0
  38. package/dist/next/v2/api/fetchExperiencePreview.d.ts +15 -0
  39. package/dist/next/v2/api/fetchExperiencePreview.d.ts.map +1 -0
  40. package/dist/next/v2/api/mintPublicSession.d.ts +25 -0
  41. package/dist/next/v2/api/mintPublicSession.d.ts.map +1 -0
  42. package/dist/next/v2/api/sessionEndpointRequest.d.ts +16 -0
  43. package/dist/next/v2/api/sessionEndpointRequest.d.ts.map +1 -0
  44. package/dist/next/v2/conversationProcessor.d.ts +6 -0
  45. package/dist/next/v2/conversationProcessor.d.ts.map +1 -0
  46. package/dist/next/v2/embed/iframeHost.d.ts +70 -0
  47. package/dist/next/v2/embed/iframeHost.d.ts.map +1 -0
  48. package/dist/next/v2/embed/playerReachability.d.ts +4 -0
  49. package/dist/next/v2/embed/playerReachability.d.ts.map +1 -0
  50. package/dist/next/v2/embed/protocol.d.ts +181 -0
  51. package/dist/next/v2/embed/protocol.d.ts.map +1 -0
  52. package/dist/next/v2/embed/readyGate.d.ts +7 -0
  53. package/dist/next/v2/embed/readyGate.d.ts.map +1 -0
  54. package/dist/next/v2/experience.d.ts +133 -0
  55. package/dist/next/v2/experience.d.ts.map +1 -0
  56. package/dist/next/v2/experienceEvents.d.ts +27 -0
  57. package/dist/next/v2/experienceEvents.d.ts.map +1 -0
  58. package/dist/next/v2/shims/embedBaseUrl.d.ts +19 -0
  59. package/dist/next/v2/shims/embedBaseUrl.d.ts.map +1 -0
  60. package/dist/next/v2/speechOnlyManifest.d.ts +7 -0
  61. package/dist/next/v2/speechOnlyManifest.d.ts.map +1 -0
  62. package/dist/next/v2/types/sessionInteraction.d.ts +120 -0
  63. package/dist/next/v2/types/sessionInteraction.d.ts.map +1 -0
  64. package/dist/next/v2/types/sessionManifest.d.ts +93 -0
  65. package/dist/next/v2/types/sessionManifest.d.ts.map +1 -0
  66. package/dist/next/v2/types/sessionManifestSchema.d.ts +183 -0
  67. package/dist/next/v2/types/sessionManifestSchema.d.ts.map +1 -0
  68. package/dist/next/v2/types/sessionPipeline.d.ts +23 -0
  69. package/dist/next/v2/types/sessionPipeline.d.ts.map +1 -0
  70. package/dist/next/widget/dockGeometry.d.ts +26 -0
  71. package/dist/next/widget/dockGeometry.d.ts.map +1 -0
  72. package/dist/next/widget/index.d.ts +5 -0
  73. package/dist/next/widget/index.d.ts.map +1 -0
  74. package/dist/next/widget/mountExperienceWidget.d.ts +13 -0
  75. package/dist/next/widget/mountExperienceWidget.d.ts.map +1 -0
  76. package/dist/next/widget/styles.d.ts +4 -0
  77. package/dist/next/widget/styles.d.ts.map +1 -0
  78. package/dist/next/widget/types.d.ts +62 -0
  79. package/dist/next/widget/types.d.ts.map +1 -0
  80. package/dist/npm/index.js +4859 -0
  81. package/dist/npm/index.js.map +1 -0
  82. package/dist/npm/shims/apiBaseUrl.d.ts +14 -0
  83. package/dist/npm/shims/apiBaseUrl.d.ts.map +1 -0
  84. package/dist/npm/shims/localStack.d.ts +6 -0
  85. package/dist/npm/shims/localStack.d.ts.map +1 -0
  86. package/dist/npm/svelte/experienceLoadError.d.ts +16 -0
  87. package/dist/npm/svelte/experienceLoadError.d.ts.map +1 -0
  88. package/dist/npm/svelte/experienceLoadErrorOverlay.d.ts +8 -0
  89. package/dist/npm/svelte/experienceLoadErrorOverlay.d.ts.map +1 -0
  90. package/dist/npm/svelte/experienceLoadErrorStyles.d.ts +5 -0
  91. package/dist/npm/svelte/experienceLoadErrorStyles.d.ts.map +1 -0
  92. package/dist/npm/thumbnail/attachThumbnailParallax.d.ts +7 -0
  93. package/dist/npm/thumbnail/attachThumbnailParallax.d.ts.map +1 -0
  94. package/dist/npm/thumbnail/ensureStyles.d.ts +3 -0
  95. package/dist/npm/thumbnail/ensureStyles.d.ts.map +1 -0
  96. package/dist/npm/thumbnail/hostedLaunchUrl.d.ts +23 -0
  97. package/dist/npm/thumbnail/hostedLaunchUrl.d.ts.map +1 -0
  98. package/dist/npm/thumbnail/index.d.ts +9 -0
  99. package/dist/npm/thumbnail/index.d.ts.map +1 -0
  100. package/dist/npm/thumbnail/lazyLoad.d.ts +8 -0
  101. package/dist/npm/thumbnail/lazyLoad.d.ts.map +1 -0
  102. package/dist/npm/thumbnail/scrollParallax.d.ts +13 -0
  103. package/dist/npm/thumbnail/scrollParallax.d.ts.map +1 -0
  104. package/dist/npm/thumbnail/styles.d.ts +3 -0
  105. package/dist/npm/thumbnail/styles.d.ts.map +1 -0
  106. package/dist/npm/thumbnail/toGalleryThumbUrl.d.ts +23 -0
  107. package/dist/npm/thumbnail/toGalleryThumbUrl.d.ts.map +1 -0
  108. package/dist/npm/thumbnail/types.d.ts +37 -0
  109. package/dist/npm/thumbnail/types.d.ts.map +1 -0
  110. package/dist/npm/v2/api/fetchExperiencePreview.d.ts +15 -0
  111. package/dist/npm/v2/api/fetchExperiencePreview.d.ts.map +1 -0
  112. package/dist/npm/v2/api/mintPublicSession.d.ts +25 -0
  113. package/dist/npm/v2/api/mintPublicSession.d.ts.map +1 -0
  114. package/dist/npm/v2/api/sessionEndpointRequest.d.ts +16 -0
  115. package/dist/npm/v2/api/sessionEndpointRequest.d.ts.map +1 -0
  116. package/dist/npm/v2/conversationProcessor.d.ts +6 -0
  117. package/dist/npm/v2/conversationProcessor.d.ts.map +1 -0
  118. package/dist/npm/v2/embed/iframeHost.d.ts +70 -0
  119. package/dist/npm/v2/embed/iframeHost.d.ts.map +1 -0
  120. package/dist/npm/v2/embed/playerReachability.d.ts +4 -0
  121. package/dist/npm/v2/embed/playerReachability.d.ts.map +1 -0
  122. package/dist/npm/v2/embed/protocol.d.ts +181 -0
  123. package/dist/npm/v2/embed/protocol.d.ts.map +1 -0
  124. package/dist/npm/v2/embed/readyGate.d.ts +7 -0
  125. package/dist/npm/v2/embed/readyGate.d.ts.map +1 -0
  126. package/dist/npm/v2/embed/returnNavigation.d.ts +4 -0
  127. package/dist/npm/v2/embed/returnNavigation.d.ts.map +1 -0
  128. package/dist/npm/v2/experience.d.ts +133 -0
  129. package/dist/npm/v2/experience.d.ts.map +1 -0
  130. package/dist/npm/v2/experienceEvents.d.ts +27 -0
  131. package/dist/npm/v2/experienceEvents.d.ts.map +1 -0
  132. package/dist/npm/v2/index.d.ts +21 -0
  133. package/dist/npm/v2/index.d.ts.map +1 -0
  134. package/dist/npm/v2/liforma-experience-thumbnail.d.ts +9 -0
  135. package/dist/npm/v2/liforma-experience-thumbnail.d.ts.map +1 -0
  136. package/dist/npm/v2/liforma-experience-widget.d.ts +8 -0
  137. package/dist/npm/v2/liforma-experience-widget.d.ts.map +1 -0
  138. package/dist/npm/v2/liforma-experience.d.ts +15 -0
  139. package/dist/npm/v2/liforma-experience.d.ts.map +1 -0
  140. package/dist/npm/v2/npm.d.ts +10 -0
  141. package/dist/npm/v2/npm.d.ts.map +1 -0
  142. package/dist/npm/v2/shims/embedBaseUrl.d.ts +19 -0
  143. package/dist/npm/v2/shims/embedBaseUrl.d.ts.map +1 -0
  144. package/dist/npm/v2/speechOnlyManifest.d.ts +7 -0
  145. package/dist/npm/v2/speechOnlyManifest.d.ts.map +1 -0
  146. package/dist/npm/v2/types/index.d.ts +3 -0
  147. package/dist/npm/v2/types/index.d.ts.map +1 -0
  148. package/dist/npm/v2/types/sessionInteraction.d.ts +120 -0
  149. package/dist/npm/v2/types/sessionInteraction.d.ts.map +1 -0
  150. package/dist/npm/v2/types/sessionManifest.d.ts +93 -0
  151. package/dist/npm/v2/types/sessionManifest.d.ts.map +1 -0
  152. package/dist/npm/v2/types/sessionManifestSchema.d.ts +183 -0
  153. package/dist/npm/v2/types/sessionManifestSchema.d.ts.map +1 -0
  154. package/dist/npm/v2/types/sessionPipeline.d.ts +23 -0
  155. package/dist/npm/v2/types/sessionPipeline.d.ts.map +1 -0
  156. package/dist/npm/widget/dockGeometry.d.ts +26 -0
  157. package/dist/npm/widget/dockGeometry.d.ts.map +1 -0
  158. package/dist/npm/widget/index.d.ts +5 -0
  159. package/dist/npm/widget/index.d.ts.map +1 -0
  160. package/dist/npm/widget/mountExperienceWidget.d.ts +13 -0
  161. package/dist/npm/widget/mountExperienceWidget.d.ts.map +1 -0
  162. package/dist/npm/widget/styles.d.ts +4 -0
  163. package/dist/npm/widget/styles.d.ts.map +1 -0
  164. package/dist/npm/widget/types.d.ts +62 -0
  165. package/dist/npm/widget/types.d.ts.map +1 -0
  166. package/dist/react/component/experienceComponentLaunch.d.ts +7 -0
  167. package/dist/react/component/experienceComponentLaunch.d.ts.map +1 -0
  168. package/dist/react/component/experienceComponentRuntime.d.ts +55 -0
  169. package/dist/react/component/experienceComponentRuntime.d.ts.map +1 -0
  170. package/dist/react/component/experienceComponentTypes.d.ts +60 -0
  171. package/dist/react/component/experienceComponentTypes.d.ts.map +1 -0
  172. package/dist/react/index.js +5499 -0
  173. package/dist/react/index.js.map +1 -0
  174. package/dist/react/react/Experience.d.ts +4 -0
  175. package/dist/react/react/Experience.d.ts.map +1 -0
  176. package/dist/react/react/ExperienceThumbnail.d.ts +22 -0
  177. package/dist/react/react/ExperienceThumbnail.d.ts.map +1 -0
  178. package/dist/react/react/ExperienceWidget.d.ts +35 -0
  179. package/dist/react/react/ExperienceWidget.d.ts.map +1 -0
  180. package/dist/react/react/index.d.ts +8 -0
  181. package/dist/react/react/index.d.ts.map +1 -0
  182. package/dist/react/shims/apiBaseUrl.d.ts +14 -0
  183. package/dist/react/shims/apiBaseUrl.d.ts.map +1 -0
  184. package/dist/react/shims/localStack.d.ts +6 -0
  185. package/dist/react/shims/localStack.d.ts.map +1 -0
  186. package/dist/react/svelte/experienceLoadError.d.ts +16 -0
  187. package/dist/react/svelte/experienceLoadError.d.ts.map +1 -0
  188. package/dist/react/svelte/experienceLoadErrorOverlay.d.ts +8 -0
  189. package/dist/react/svelte/experienceLoadErrorOverlay.d.ts.map +1 -0
  190. package/dist/react/svelte/experienceLoadErrorStyles.d.ts +5 -0
  191. package/dist/react/svelte/experienceLoadErrorStyles.d.ts.map +1 -0
  192. package/dist/react/thumbnail/attachThumbnailParallax.d.ts +7 -0
  193. package/dist/react/thumbnail/attachThumbnailParallax.d.ts.map +1 -0
  194. package/dist/react/thumbnail/ensureStyles.d.ts +3 -0
  195. package/dist/react/thumbnail/ensureStyles.d.ts.map +1 -0
  196. package/dist/react/thumbnail/hostedLaunchUrl.d.ts +23 -0
  197. package/dist/react/thumbnail/hostedLaunchUrl.d.ts.map +1 -0
  198. package/dist/react/thumbnail/index.d.ts +9 -0
  199. package/dist/react/thumbnail/index.d.ts.map +1 -0
  200. package/dist/react/thumbnail/lazyLoad.d.ts +8 -0
  201. package/dist/react/thumbnail/lazyLoad.d.ts.map +1 -0
  202. package/dist/react/thumbnail/scrollParallax.d.ts +13 -0
  203. package/dist/react/thumbnail/scrollParallax.d.ts.map +1 -0
  204. package/dist/react/thumbnail/styles.d.ts +3 -0
  205. package/dist/react/thumbnail/styles.d.ts.map +1 -0
  206. package/dist/react/thumbnail/toGalleryThumbUrl.d.ts +23 -0
  207. package/dist/react/thumbnail/toGalleryThumbUrl.d.ts.map +1 -0
  208. package/dist/react/thumbnail/toGalleryThumbUrl.test.d.ts +2 -0
  209. package/dist/react/thumbnail/toGalleryThumbUrl.test.d.ts.map +1 -0
  210. package/dist/react/thumbnail/types.d.ts +37 -0
  211. package/dist/react/thumbnail/types.d.ts.map +1 -0
  212. package/dist/react/v2/api/fetchExperiencePreview.d.ts +15 -0
  213. package/dist/react/v2/api/fetchExperiencePreview.d.ts.map +1 -0
  214. package/dist/react/v2/api/mintPublicSession.d.ts +25 -0
  215. package/dist/react/v2/api/mintPublicSession.d.ts.map +1 -0
  216. package/dist/react/v2/api/sessionEndpointRequest.d.ts +16 -0
  217. package/dist/react/v2/api/sessionEndpointRequest.d.ts.map +1 -0
  218. package/dist/react/v2/conversationProcessor.d.ts +6 -0
  219. package/dist/react/v2/conversationProcessor.d.ts.map +1 -0
  220. package/dist/react/v2/embed/iframeHost.d.ts +70 -0
  221. package/dist/react/v2/embed/iframeHost.d.ts.map +1 -0
  222. package/dist/react/v2/embed/playerReachability.d.ts +4 -0
  223. package/dist/react/v2/embed/playerReachability.d.ts.map +1 -0
  224. package/dist/react/v2/embed/protocol.d.ts +181 -0
  225. package/dist/react/v2/embed/protocol.d.ts.map +1 -0
  226. package/dist/react/v2/embed/readyGate.d.ts +7 -0
  227. package/dist/react/v2/embed/readyGate.d.ts.map +1 -0
  228. package/dist/react/v2/experience.d.ts +133 -0
  229. package/dist/react/v2/experience.d.ts.map +1 -0
  230. package/dist/react/v2/experienceEvents.d.ts +27 -0
  231. package/dist/react/v2/experienceEvents.d.ts.map +1 -0
  232. package/dist/react/v2/shims/embedBaseUrl.d.ts +19 -0
  233. package/dist/react/v2/shims/embedBaseUrl.d.ts.map +1 -0
  234. package/dist/react/v2/speechOnlyManifest.d.ts +7 -0
  235. package/dist/react/v2/speechOnlyManifest.d.ts.map +1 -0
  236. package/dist/react/v2/types/sessionInteraction.d.ts +120 -0
  237. package/dist/react/v2/types/sessionInteraction.d.ts.map +1 -0
  238. package/dist/react/v2/types/sessionManifest.d.ts +93 -0
  239. package/dist/react/v2/types/sessionManifest.d.ts.map +1 -0
  240. package/dist/react/v2/types/sessionManifestSchema.d.ts +183 -0
  241. package/dist/react/v2/types/sessionManifestSchema.d.ts.map +1 -0
  242. package/dist/react/v2/types/sessionPipeline.d.ts +23 -0
  243. package/dist/react/v2/types/sessionPipeline.d.ts.map +1 -0
  244. package/dist/react/widget/dockGeometry.d.ts +26 -0
  245. package/dist/react/widget/dockGeometry.d.ts.map +1 -0
  246. package/dist/react/widget/index.d.ts +5 -0
  247. package/dist/react/widget/index.d.ts.map +1 -0
  248. package/dist/react/widget/mountExperienceWidget.d.ts +13 -0
  249. package/dist/react/widget/mountExperienceWidget.d.ts.map +1 -0
  250. package/dist/react/widget/styles.d.ts +4 -0
  251. package/dist/react/widget/styles.d.ts.map +1 -0
  252. package/dist/react/widget/types.d.ts +62 -0
  253. package/dist/react/widget/types.d.ts.map +1 -0
  254. package/dist/sdk/v2/client.js +806 -0
  255. package/dist/sdk/v2/client.js.map +1 -0
  256. package/dist/svelte/Experience.svelte +522 -0
  257. package/dist/svelte/Experience.svelte.d.ts +15 -0
  258. package/dist/svelte/ExperienceThumbnail.svelte +376 -0
  259. package/dist/svelte/ExperienceThumbnail.svelte.d.ts +22 -0
  260. package/dist/svelte/ExperienceWidget.svelte +146 -0
  261. package/dist/svelte/ExperienceWidget.svelte.d.ts +35 -0
  262. package/dist/svelte/experienceLoadError.d.ts +15 -0
  263. package/dist/svelte/experienceLoadError.js +82 -0
  264. package/dist/svelte/experienceLoadError.test.d.ts +1 -0
  265. package/dist/svelte/experienceLoadError.test.js +18 -0
  266. package/dist/svelte/experienceLoadErrorOverlay.d.ts +7 -0
  267. package/dist/svelte/experienceLoadErrorOverlay.js +48 -0
  268. package/dist/svelte/experienceLoadErrorStyles.d.ts +4 -0
  269. package/dist/svelte/experienceLoadErrorStyles.js +112 -0
  270. package/dist/svelte/index.d.ts +7 -0
  271. package/dist/svelte/index.js +5 -0
  272. package/dist/svelte/types.d.ts +1 -0
  273. package/dist/svelte/types.js +1 -0
  274. package/package.json +154 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,28 @@
1
+ # @liforma/client changelog
2
+
3
+ ## 0.2.1 — 2026-08-05
4
+
5
+ ### Changed
6
+
7
+ - Public `README.md` is integrator-facing (install, hello world, mint paths, docs links)
8
+ - Operator / R2 / CORS / publish notes moved to `OPERATOR.md` (not included in the npm tarball)
9
+
10
+ ## 0.2.0 — 2026-08-03
11
+
12
+ ### Added
13
+
14
+ - npm package `@liforma/client` with ESM build (`dist/npm/`)
15
+ - Svelte component `<Experience />` via `@liforma/client/svelte`
16
+ - Deprecated alias export `LiformaExperience` (same component)
17
+ - `ExperienceSession` type for live session handles
18
+ - `navigateOnExperienceClose` export for custom close handling
19
+
20
+ ### Changed
21
+
22
+ - Canonical Svelte hello-world is `<Experience experienceId="…" />` (replaces `LiformaExperience`)
23
+
24
+ ### Unchanged
25
+
26
+ - Browser IIFE bundle: `https://cdn.liforma.ai/sdk/v2/client.js`
27
+ - Web component tag: `<liforma-experience>`
28
+ - JS API class name: `Experience`
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Liforma Ltd
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,103 @@
1
+ # @liforma/client
2
+
3
+ Browser SDK for [Liforma](https://www.liforma.ai) — embed real-time AI avatar experiences in web apps.
4
+
5
+ ```text
6
+ Experience (exp_…) → Session Manifest → @liforma/client
7
+ ```
8
+
9
+ Docs: [docs.liforma.ai](https://docs.liforma.ai) · [Quick start](https://docs.liforma.ai/getting-started/quick-start) · [llms.txt](https://docs.liforma.ai/llms.txt)
10
+ Examples: [examples.liforma.ai](https://examples.liforma.ai)
11
+ Portal (API keys & origins): [app.liforma.ai](https://app.liforma.ai)
12
+
13
+ ## Install
14
+
15
+ ```bash
16
+ npm install @liforma/client
17
+ ```
18
+
19
+ Optional peers: `svelte` ^5 for the Svelte entry; `react` / `react-dom` ^18 or ^19 for React / Next.
20
+
21
+ ## Hello world
22
+
23
+ ### Svelte
24
+
25
+ ```svelte
26
+ <script>
27
+ import { Experience } from '@liforma/client/svelte';
28
+ </script>
29
+
30
+ <Experience experienceId="exp_01EXAMPLES_COFFEE_BARISTA" />
31
+ ```
32
+
33
+ ### React
34
+
35
+ ```tsx
36
+ import { Experience } from '@liforma/client/react';
37
+
38
+ export function Demo() {
39
+ return <Experience experienceId="exp_01EXAMPLES_COFFEE_BARISTA" />;
40
+ }
41
+ ```
42
+
43
+ ### Next.js (App Router session route)
44
+
45
+ ```ts
46
+ import { createLiformaSessionRouteHandler } from '@liforma/client/next';
47
+
48
+ export const POST = createLiformaSessionRouteHandler({
49
+ // Production: supply authorize() that checks your app session.
50
+ allowUnauthenticated: true // demos only
51
+ });
52
+ ```
53
+
54
+ ```tsx
55
+ 'use client';
56
+
57
+ import { Experience } from '@liforma/client/next';
58
+
59
+ export function Demo() {
60
+ return (
61
+ <Experience
62
+ experienceId="exp_01EXAMPLES_COFFEE_BARISTA"
63
+ sessionEndpoint="/api/liforma-session"
64
+ />
65
+ );
66
+ }
67
+ ```
68
+
69
+ ### Vanilla (CDN)
70
+
71
+ ```html
72
+ <script src="https://cdn.liforma.ai/sdk/v2/client.js" defer></script>
73
+ <liforma-experience experience-id="exp_01EXAMPLES_COFFEE_BARISTA"></liforma-experience>
74
+ ```
75
+
76
+ ## Package entry points
77
+
78
+ | Import | Surface |
79
+ |--------|---------|
80
+ | `@liforma/client` | JS API (`Experience.startSession`, types) |
81
+ | `@liforma/client/svelte` | `<Experience />`, `<ExperienceThumbnail />`, `<ExperienceWidget />` |
82
+ | `@liforma/client/react` | React components |
83
+ | `@liforma/client/next` | Next helpers + client components |
84
+ | CDN `sdk/v2/client.js` | Web components + `window.Liforma` |
85
+
86
+ ## Session minting
87
+
88
+ | Situation | Path |
89
+ |-----------|------|
90
+ | You have a backend | Mint with API key via `POST /v1/sessions`; pass a same-origin `sessionEndpoint` to the component |
91
+ | Client-only / public demos | Allowlist your origin in the [developer portal](https://app.liforma.ai); the SDK mints via `POST /v1/public-sessions` |
92
+
93
+ Never put API keys in browser code. Details: [Server sessions](https://docs.liforma.ai/avatar-experiences/server-sessions), [Browser embeds](https://docs.liforma.ai/avatar-experiences/browser-embeds).
94
+
95
+ ## More components
96
+
97
+ - [ExperienceThumbnail](https://docs.liforma.ai/avatar-experiences/experience-thumbnail) — gallery cards (no session)
98
+ - [ExperienceWidget](https://docs.liforma.ai/avatar-experiences/experience-widget) — corner launcher
99
+ - [Experience API](https://docs.liforma.ai/avatar-experiences/experience-api) — `speak()`, listen, events
100
+
101
+ ## License
102
+
103
+ MIT