@gamaro.io/core-types 0.6.0 → 1.0.0

package/README.md

@@ -4,7 +4,7 @@ Cross-workspace TypeScript contracts and Zod schemas consumed by
 [`@gamaro.io/widget`](https://www.npmjs.com/package/@gamaro.io/widget).
 
 > **Companion package — not for standalone use.** This package exists to share
-> type definitions between the Versiq backend, the marketing site, and the
+> type definitions between the Gamaro backend, the marketing site, and the
 > public widget SDK. If you are integrating the widget into your site, you need
 > [`@gamaro.io/widget`](https://www.npmjs.com/package/@gamaro.io/widget), not
 > this one. The widget already re-exports the types you need.
@@ -12,8 +12,8 @@ Cross-workspace TypeScript contracts and Zod schemas consumed by
 ## When you might need this directly
 
 You only need to depend on `@gamaro.io/core-types` if you are building a custom
-integration that talks to the Versiq backend without going through the widget
-SDK — for example, a server-to-server pipeline that posts events to the Versiq
+integration that talks to the Gamaro backend without going through the widget
+SDK — for example, a server-to-server pipeline that posts events to the Gamaro
 API and wants the same Zod schemas the official widget uses.
 
 ## Installation

package/dist/postmessage.d.ts

@@ -1,13 +1,13 @@
 /**
  * postMessage protocol between the widget iframe and its host page.
  *
- * Two directions share the `versiq:*` prefix:
+ * Two directions share the `gamaro:*` prefix:
  *   - `WidgetCommand` — parent page → iframe (commands)
  *   - `WidgetEvent`   — iframe → parent page (events)
  *
  * The `MESSAGE_TYPES` const aggregates every message type string across both
  * directions. Consumers that treat the protocol opaquely (e.g. origin
- * validation helpers) can rely on it to check `type.startsWith("versiq:")`
+ * validation helpers) can rely on it to check `type.startsWith("gamaro:")`
  * without enumerating every member.
  */
 import { z } from "zod";
@@ -40,30 +40,30 @@ export type WidgetMessage = z.infer<typeof widgetMessageSchema>;
  */
 export type WidgetProfile = Record<string, unknown>;
 /**
- * Exhaustive catalogue of every `versiq:*` message type used in either
+ * Exhaustive catalogue of every `gamaro:*` message type used in either
  * direction. Kept as a single const so a new event or command is declared in
  * one place.
  */
 export declare const MESSAGE_TYPES: {
-    readonly INIT: "versiq:init";
-    readonly OPEN: "versiq:open";
-    readonly CLOSE: "versiq:close";
-    readonly RESET: "versiq:reset";
-    readonly SET_THEME: "versiq:setTheme";
-    readonly VIEWPORT: "versiq:viewport";
-    readonly IDENTIFY: "versiq:identify";
-    readonly READY: "versiq:ready";
-    readonly PROFILE_UPDATE: "versiq:profile-update";
-    readonly MESSAGE: "versiq:message";
-    readonly QUALIFIED: "versiq:qualified";
-    readonly ERROR: "versiq:error";
-    readonly QUOTA_WARNING: "versiq:quota-warning";
-    readonly QUOTA_EXCEEDED: "versiq:quota-exceeded";
-    readonly FUNNEL_STAGE_CHANGE: "versiq:funnel-stage-change";
-    readonly CTA_SHOWN: "versiq:cta-shown";
-    readonly CTA_CLICKED: "versiq:cta-clicked";
-    readonly LEAD_CAPTURED: "versiq:lead-captured";
-    readonly IDENTITY_VERIFIED: "versiq:identity-verified";
+    readonly INIT: "gamaro:init";
+    readonly OPEN: "gamaro:open";
+    readonly CLOSE: "gamaro:close";
+    readonly RESET: "gamaro:reset";
+    readonly SET_THEME: "gamaro:setTheme";
+    readonly VIEWPORT: "gamaro:viewport";
+    readonly IDENTIFY: "gamaro:identify";
+    readonly READY: "gamaro:ready";
+    readonly PROFILE_UPDATE: "gamaro:profile-update";
+    readonly MESSAGE: "gamaro:message";
+    readonly QUALIFIED: "gamaro:qualified";
+    readonly ERROR: "gamaro:error";
+    readonly QUOTA_WARNING: "gamaro:quota-warning";
+    readonly QUOTA_EXCEEDED: "gamaro:quota-exceeded";
+    readonly FUNNEL_STAGE_CHANGE: "gamaro:funnel-stage-change";
+    readonly CTA_SHOWN: "gamaro:cta-shown";
+    readonly CTA_CLICKED: "gamaro:cta-clicked";
+    readonly LEAD_CAPTURED: "gamaro:lead-captured";
+    readonly IDENTITY_VERIFIED: "gamaro:identity-verified";
 };
 export type MessageType = (typeof MESSAGE_TYPES)[keyof typeof MESSAGE_TYPES];
 export type WidgetCommand = {
@@ -132,14 +132,14 @@ export type WidgetEvent = {
     userId?: string;
 };
 /**
- * Short keys (no `versiq:` prefix) used by the widget public API (on/off).
+ * Short keys (no `gamaro:` prefix) used by the widget public API (on/off).
  */
 export type WidgetEventType = "ready" | "profile-update" | "message" | "qualified" | "error" | "open" | "close" | "quota-warning" | "quota-exceeded" | "funnel-stage-change" | "cta-shown" | "cta-clicked" | "lead-captured" | "identity-verified" | "widget-unavailable";
 /**
  * Payload emitted with the `widget-unavailable` SDK event (#867).
  *
  * Fired by the SDK (parent side) when the iframe loader exhausted all
- * retries — distinct from the iframe-emitted `versiq:error` which signals
+ * retries — distinct from the iframe-emitted `gamaro:error` which signals
  * a runtime failure of an already-loaded widget.
  *
  * Dual-emission contract: when the loader fails, the SDK emits BOTH

package/dist/postmessage.js

@@ -1,13 +1,13 @@
 /**
  * postMessage protocol between the widget iframe and its host page.
  *
- * Two directions share the `versiq:*` prefix:
+ * Two directions share the `gamaro:*` prefix:
  *   - `WidgetCommand` — parent page → iframe (commands)
  *   - `WidgetEvent`   — iframe → parent page (events)
  *
  * The `MESSAGE_TYPES` const aggregates every message type string across both
  * directions. Consumers that treat the protocol opaquely (e.g. origin
- * validation helpers) can rely on it to check `type.startsWith("versiq:")`
+ * validation helpers) can rely on it to check `type.startsWith("gamaro:")`
  * without enumerating every member.
  */
 import { z } from "zod";
@@ -31,38 +31,38 @@ export const widgetMessageSchema = z.object({
 // Message type catalogue
 // ============================================================================
 /**
- * Exhaustive catalogue of every `versiq:*` message type used in either
+ * Exhaustive catalogue of every `gamaro:*` message type used in either
  * direction. Kept as a single const so a new event or command is declared in
  * one place.
  */
 export const MESSAGE_TYPES = {
     // Parent → iframe (commands)
-    INIT: "versiq:init",
-    OPEN: "versiq:open",
-    CLOSE: "versiq:close",
-    RESET: "versiq:reset",
-    SET_THEME: "versiq:setTheme",
-    VIEWPORT: "versiq:viewport",
-    IDENTIFY: "versiq:identify",
+    INIT: "gamaro:init",
+    OPEN: "gamaro:open",
+    CLOSE: "gamaro:close",
+    RESET: "gamaro:reset",
+    SET_THEME: "gamaro:setTheme",
+    VIEWPORT: "gamaro:viewport",
+    IDENTIFY: "gamaro:identify",
     // iframe → parent (events)
-    READY: "versiq:ready",
-    PROFILE_UPDATE: "versiq:profile-update",
-    MESSAGE: "versiq:message",
-    QUALIFIED: "versiq:qualified",
-    ERROR: "versiq:error",
-    QUOTA_WARNING: "versiq:quota-warning",
-    QUOTA_EXCEEDED: "versiq:quota-exceeded",
-    FUNNEL_STAGE_CHANGE: "versiq:funnel-stage-change",
-    CTA_SHOWN: "versiq:cta-shown",
-    CTA_CLICKED: "versiq:cta-clicked",
-    LEAD_CAPTURED: "versiq:lead-captured",
-    IDENTITY_VERIFIED: "versiq:identity-verified",
+    READY: "gamaro:ready",
+    PROFILE_UPDATE: "gamaro:profile-update",
+    MESSAGE: "gamaro:message",
+    QUALIFIED: "gamaro:qualified",
+    ERROR: "gamaro:error",
+    QUOTA_WARNING: "gamaro:quota-warning",
+    QUOTA_EXCEEDED: "gamaro:quota-exceeded",
+    FUNNEL_STAGE_CHANGE: "gamaro:funnel-stage-change",
+    CTA_SHOWN: "gamaro:cta-shown",
+    CTA_CLICKED: "gamaro:cta-clicked",
+    LEAD_CAPTURED: "gamaro:lead-captured",
+    IDENTITY_VERIFIED: "gamaro:identity-verified",
 };
 /**
  * Payload emitted with the `widget-unavailable` SDK event (#867).
  *
  * Fired by the SDK (parent side) when the iframe loader exhausted all
- * retries — distinct from the iframe-emitted `versiq:error` which signals
+ * retries — distinct from the iframe-emitted `gamaro:error` which signals
  * a runtime failure of an already-loaded widget.
  *
  * Dual-emission contract: when the loader fails, the SDK emits BOTH

package/dist/session.d.ts

@@ -15,7 +15,7 @@
  * Per-vertical session cookie name. Each vertical owns its own cookie to prevent
  * profile-schema conflicts. Any character outside `[a-z0-9-]` (case-insensitive)
  * is sanitized to `_` (each char maps to one `_`, no collapsing), so
- * `real-estate` stays `versiq_session_real-estate`.
+ * `real-estate` stays `gamaro_session_real-estate`.
  */
 export declare function getSessionCookieName(verticalId: string): string;
 /**

package/dist/session.js

@@ -15,11 +15,11 @@
  * Per-vertical session cookie name. Each vertical owns its own cookie to prevent
  * profile-schema conflicts. Any character outside `[a-z0-9-]` (case-insensitive)
  * is sanitized to `_` (each char maps to one `_`, no collapsing), so
- * `real-estate` stays `versiq_session_real-estate`.
+ * `real-estate` stays `gamaro_session_real-estate`.
  */
 export function getSessionCookieName(verticalId) {
     const sanitized = verticalId.replace(/[^a-z0-9-]/gi, "_");
-    return `versiq_session_${sanitized}`;
+    return `gamaro_session_${sanitized}`;
 }
 /**
  * Validate the UUID shape of a session id. The length pre-check is

package/dist/widget-config.d.ts

@@ -5,6 +5,17 @@
  * `apps/app` sandbox/preview components via `@gamaro.io/widget`'s re-export.
  */
 import { z } from "zod";
+/**
+ * Max length of an auto-sent "example question" deep-linked into a widget at
+ * mount (#3058, e.g. the funnel canvas's "Tester en conditions réelles"
+ * link). Deliberately far tighter than `widgetMessageSchema.content`'s 10000
+ * (real chat input) — this is a short canned example string, resolved from a
+ * fixed i18n key, never free-form visitor input. Not the primary guard
+ * against unbounded LLM input either (`chatMessageSchema.content.max(5000)`
+ * already bounds that server-side) — this bound is about UX consistency, and
+ * is re-enforced authoritatively at the embed's INIT handler, not solely here.
+ */
+export declare const WIDGET_INITIAL_MESSAGE_MAX_LENGTH = 300;
 export declare const widgetConfigSchema: z.ZodObject<{
     theme: z.ZodOptional<z.ZodObject<{
         primaryColor: z.ZodOptional<z.ZodString>;
@@ -40,5 +51,6 @@ export declare const widgetConfigSchema: z.ZodObject<{
     email: z.ZodOptional<z.ZodString>;
     userId: z.ZodOptional<z.ZodString>;
     userHash: z.ZodOptional<z.ZodString>;
+    initialMessage: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type WidgetConfig = z.infer<typeof widgetConfigSchema>;

package/dist/widget-config.js

@@ -7,6 +7,17 @@
 import { z } from "zod";
 import { themeConfigSchema } from "./theme";
 import { responsiveConfigSchema, widgetPositionSchema } from "./viewport";
+/**
+ * Max length of an auto-sent "example question" deep-linked into a widget at
+ * mount (#3058, e.g. the funnel canvas's "Tester en conditions réelles"
+ * link). Deliberately far tighter than `widgetMessageSchema.content`'s 10000
+ * (real chat input) — this is a short canned example string, resolved from a
+ * fixed i18n key, never free-form visitor input. Not the primary guard
+ * against unbounded LLM input either (`chatMessageSchema.content.max(5000)`
+ * already bounds that server-side) — this bound is about UX consistency, and
+ * is re-enforced authoritatively at the embed's INIT handler, not solely here.
+ */
+export const WIDGET_INITIAL_MESSAGE_MAX_LENGTH = 300;
 export const widgetConfigSchema = z.object({
     theme: themeConfigSchema.describe("Custom theme configuration").optional(),
     position: widgetPositionSchema
@@ -32,7 +43,7 @@ export const widgetConfigSchema = z.object({
         .optional(),
     showProfile: z
         .boolean()
-        .describe("Show profile panel in widget header (default: false)")
+        .describe("Force the profile panel visible in the widget header from the start of the conversation. The panel already shows on its own once the visitor's profile has data, regardless of this flag (default: false).")
         .optional(),
     language: z
         .string()
@@ -59,4 +70,9 @@ export const widgetConfigSchema = z.object({
         .max(128)
         .describe("HMAC-SHA256 of email (or userId), signed with identity secret")
         .optional(),
+    initialMessage: z
+        .string()
+        .max(WIDGET_INITIAL_MESSAGE_MAX_LENGTH)
+        .describe("Auto-sent first visitor message, injected once via postMessage when the widget is ready (e.g. a demo deep-link). Never carried on the iframe URL. The authoritative bound is enforced again at the embed's trust boundary (useEmbedChatHandlers' INIT handler), this schema is not the sole enforcement point.")
+        .optional(),
 });

package/dist/widget-runtime-config.js

@@ -36,18 +36,18 @@ export const widgetRuntimeConfigSchema = z
         .optional(),
     showProfile: z
         .boolean()
-        .describe("Whether the widget header exposes the profile panel to end-users.")
+        .describe("Forces the profile panel visible from the start of the conversation. The panel already shows on its own once the visitor's profile has data, regardless of this flag.")
         .optional(),
     open: z
         .boolean()
-        .describe("Default open state on load. Host can still call `window.Versiq.open()` programmatically.")
+        .describe("Default open state on load. Host can still call `window.Gamaro.open()` programmatically.")
         .optional(),
     brand: z
         .object({
         title: z
             .string()
             .max(60)
-            .describe("Custom widget header title. Falls back to a vertical-specific default (e.g. 'Versiq Chat' for B2B) when unset.")
+            .describe("Custom widget header title. Falls back to a vertical-specific default (e.g. 'Gamaro Chat' for B2B) when unset.")
             .optional(),
         avatarUrl: z
             .string()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gamaro.io/core-types",
-  "version": "0.6.0",
+  "version": "1.0.0",
   "description": "Cross-workspace TypeScript contracts and Zod schemas consumed by @gamaro.io/widget. Intended as a peer of the widget SDK.",
   "type": "module",
   "main": "./dist/index.js",