veo-sdk 0.1.0 → 0.2.1

package/dist/index.d.cts

@@ -1,3 +1,5 @@
+export { P as PreviewGuideInput, a as PreviewHandle, b as PreviewResult, c as closeGuidePreview, p as previewGuide } from './guide-preview-CO5ShtNf.cjs';
+
 /**
  * Configuración de la autocaptura de interacciones del DOM.
  */
@@ -31,8 +33,6 @@ interface VeoAutocaptureConfig {
 interface VeoConfig {
     /** API key pública del workspace (formato pk_xxx). */
     apiKey: string;
-    /** URL base del backend de Veo. */
-    apiUrl: string;
     /** Intervalo en ms para flush automático de la queue. Default: 5000. */
     flushInterval?: number;
     /** Tamaño máximo del batch antes de flush. Default: 20. */
@@ -49,6 +49,20 @@ interface VeoConfig {
      * tooltips. Default: `false`.
      */
     guides?: boolean;
+    /**
+     * URL del bundle del builder (`veo-builder.js`). Solo se carga cuando la
+     * página trae `?veoBuilder=<token>` (modo edición desde el dashboard). Si
+     * se omite, el SDK la deriva del `<script>` que cargó `veo.js`.
+     */
+    builderUrl?: string;
+    /**
+     * URL del bundle de guías (`veo-guides.js`). En el build IIFE (`veo.js`) los
+     * renderers de guías se cargan PEREZOSAMENTE desde acá (solo con `guides:true`
+     * o al usar `veo.preview()`), para mantener `veo.js` chico. Si se omite, se
+     * deriva del `<script>` que cargó `veo.js`. (En ESM/CJS no aplica: el bundler
+     * incluye/treeshake las guías estáticamente.)
+     */
+    guidesUrl?: string;
 }
 /**
  * Información del end user (usuario final).
@@ -118,9 +132,33 @@ interface VeoClient {
      */
     getEndUserId(): string | null;
     /** @internal Consumido por plugins. NO es API estable para usuarios. */
+    getAnonymousId(): string;
+    /** @internal Consumido por plugins. NO es API estable para usuarios. */
     getSessionId(): string;
 }
 
+interface GuidesPluginConfig {
+    apiUrl: string;
+    apiKey: string;
+    debug?: boolean;
+}
+/**
+ * Plugin que renderiza guías in-app (modal/banner/tooltip) consultando
+ * `GET /v1/guides/resolve` y registra las interacciones en
+ * `POST /v1/guides/:id/interactions` vía queue dedicada con retry y
+ * sendBeacon en pagehide.
+ *
+ * Opt-in: `init({ ..., guides: true })`. El plugin escucha
+ * `pageview` e `identify` del client; el payload del evento ya trae
+ * `sessionId` y `endUserId` para que no necesitemos consultar al
+ * client en cada disparo.
+ *
+ * Frequency híbrida: el backend filtra autoritariamente; el cache
+ * local (`GuideFrequencyCache`) solo previene el flash visual cuando
+ * la interaction aún no se persistió.
+ */
+declare function guidesPlugin(config: GuidesPluginConfig): VeoPlugin;
+
 /**
  * Tipos del contrato HTTP entre el SDK y el backend.
  * Versión 1.
@@ -157,6 +195,7 @@ declare class Client implements VeoClient {
     flush(): Promise<void>;
     use(plugin: VeoPlugin): VeoClient;
     getEndUserId(): string | null;
+    getAnonymousId(): string;
     getSessionId(): string;
     /**
      * Suscribe `listener` a `event`. Devuelve una función para desuscribir.
@@ -181,28 +220,6 @@ declare class Client implements VeoClient {
  */
 declare function autocapturePlugin(config?: VeoAutocaptureConfig): VeoPlugin;
 
-interface GuidesPluginConfig {
-    apiUrl: string;
-    apiKey: string;
-    debug?: boolean;
-}
-/**
- * Plugin que renderiza guías in-app (modal/banner/tooltip) consultando
- * `GET /v1/guides/resolve` y registra las interacciones en
- * `POST /v1/guides/:id/interactions` vía queue dedicada con retry y
- * sendBeacon en pagehide.
- *
- * Opt-in: `init({ ..., guides: true })`. El plugin escucha
- * `pageview` e `identify` del client; el payload del evento ya trae
- * `sessionId` y `endUserId` para que no necesitemos consultar al
- * client en cada disparo.
- *
- * Frequency híbrida: el backend filtra autoritariamente; el cache
- * local (`GuideFrequencyCache`) solo previene el flash visual cuando
- * la interaction aún no se persistió.
- */
-declare function guidesPlugin(config: GuidesPluginConfig): VeoPlugin;
-
 /**
  * Helper de identidad para definir un plugin con inferencia de tipos.
  * No transforma nada; mejora la ergonomía y deja un punto de extensión futuro.
@@ -224,10 +241,8 @@ declare function spaRouterPlugin(): VeoPlugin;
  * ```ts
  * import { init } from '@veo/sdk';
  *
- * const veo = init({
- *   apiKey: 'pk_xxx',
- *   apiUrl: 'https://api.veo.io'
- * });
+ * // apiUrl es opcional: por defecto apunta al backend gestionado de Veo.
+ * const veo = init({ apiKey: 'pk_xxx' });
  *
  * veo.identify({ visitor: { id: 'user_123' } });
  * veo.track('button_clicked');

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+export { P as PreviewGuideInput, a as PreviewHandle, b as PreviewResult, c as closeGuidePreview, p as previewGuide } from './guide-preview-CO5ShtNf.js';
+
 /**
  * Configuración de la autocaptura de interacciones del DOM.
  */
@@ -31,8 +33,6 @@ interface VeoAutocaptureConfig {
 interface VeoConfig {
     /** API key pública del workspace (formato pk_xxx). */
     apiKey: string;
-    /** URL base del backend de Veo. */
-    apiUrl: string;
     /** Intervalo en ms para flush automático de la queue. Default: 5000. */
     flushInterval?: number;
     /** Tamaño máximo del batch antes de flush. Default: 20. */
@@ -49,6 +49,20 @@ interface VeoConfig {
      * tooltips. Default: `false`.
      */
     guides?: boolean;
+    /**
+     * URL del bundle del builder (`veo-builder.js`). Solo se carga cuando la
+     * página trae `?veoBuilder=<token>` (modo edición desde el dashboard). Si
+     * se omite, el SDK la deriva del `<script>` que cargó `veo.js`.
+     */
+    builderUrl?: string;
+    /**
+     * URL del bundle de guías (`veo-guides.js`). En el build IIFE (`veo.js`) los
+     * renderers de guías se cargan PEREZOSAMENTE desde acá (solo con `guides:true`
+     * o al usar `veo.preview()`), para mantener `veo.js` chico. Si se omite, se
+     * deriva del `<script>` que cargó `veo.js`. (En ESM/CJS no aplica: el bundler
+     * incluye/treeshake las guías estáticamente.)
+     */
+    guidesUrl?: string;
 }
 /**
  * Información del end user (usuario final).
@@ -118,9 +132,33 @@ interface VeoClient {
      */
     getEndUserId(): string | null;
     /** @internal Consumido por plugins. NO es API estable para usuarios. */
+    getAnonymousId(): string;
+    /** @internal Consumido por plugins. NO es API estable para usuarios. */
     getSessionId(): string;
 }
 
+interface GuidesPluginConfig {
+    apiUrl: string;
+    apiKey: string;
+    debug?: boolean;
+}
+/**
+ * Plugin que renderiza guías in-app (modal/banner/tooltip) consultando
+ * `GET /v1/guides/resolve` y registra las interacciones en
+ * `POST /v1/guides/:id/interactions` vía queue dedicada con retry y
+ * sendBeacon en pagehide.
+ *
+ * Opt-in: `init({ ..., guides: true })`. El plugin escucha
+ * `pageview` e `identify` del client; el payload del evento ya trae
+ * `sessionId` y `endUserId` para que no necesitemos consultar al
+ * client en cada disparo.
+ *
+ * Frequency híbrida: el backend filtra autoritariamente; el cache
+ * local (`GuideFrequencyCache`) solo previene el flash visual cuando
+ * la interaction aún no se persistió.
+ */
+declare function guidesPlugin(config: GuidesPluginConfig): VeoPlugin;
+
 /**
  * Tipos del contrato HTTP entre el SDK y el backend.
  * Versión 1.
@@ -157,6 +195,7 @@ declare class Client implements VeoClient {
     flush(): Promise<void>;
     use(plugin: VeoPlugin): VeoClient;
     getEndUserId(): string | null;
+    getAnonymousId(): string;
     getSessionId(): string;
     /**
      * Suscribe `listener` a `event`. Devuelve una función para desuscribir.
@@ -181,28 +220,6 @@ declare class Client implements VeoClient {
  */
 declare function autocapturePlugin(config?: VeoAutocaptureConfig): VeoPlugin;
 
-interface GuidesPluginConfig {
-    apiUrl: string;
-    apiKey: string;
-    debug?: boolean;
-}
-/**
- * Plugin que renderiza guías in-app (modal/banner/tooltip) consultando
- * `GET /v1/guides/resolve` y registra las interacciones en
- * `POST /v1/guides/:id/interactions` vía queue dedicada con retry y
- * sendBeacon en pagehide.
- *
- * Opt-in: `init({ ..., guides: true })`. El plugin escucha
- * `pageview` e `identify` del client; el payload del evento ya trae
- * `sessionId` y `endUserId` para que no necesitemos consultar al
- * client en cada disparo.
- *
- * Frequency híbrida: el backend filtra autoritariamente; el cache
- * local (`GuideFrequencyCache`) solo previene el flash visual cuando
- * la interaction aún no se persistió.
- */
-declare function guidesPlugin(config: GuidesPluginConfig): VeoPlugin;
-
 /**
  * Helper de identidad para definir un plugin con inferencia de tipos.
  * No transforma nada; mejora la ergonomía y deja un punto de extensión futuro.
@@ -224,10 +241,8 @@ declare function spaRouterPlugin(): VeoPlugin;
  * ```ts
  * import { init } from '@veo/sdk';
  *
- * const veo = init({
- *   apiKey: 'pk_xxx',
- *   apiUrl: 'https://api.veo.io'
- * });
+ * // apiUrl es opcional: por defecto apunta al backend gestionado de Veo.
+ * const veo = init({ apiKey: 'pk_xxx' });
  *
  * veo.identify({ visitor: { id: 'user_123' } });
  * veo.track('button_clicked');