ai-publish-sdk 1.6.0 → 1.7.0

package/README.md

@@ -110,6 +110,14 @@ Execute JavaScript on the host page.
 executeScript(code: string): Promise<void>
 ```
 
+### trackEvent(params)
+
+Emit structured analytics events from your app. The host auto-populates `timestamp`, `userId`, `email`, `userName`, `tenantId`, `application`, `appType` (widget / fullpage / sidepanel), and (sidepanel only) `activeSite` — you only supply the app-specific fields.
+
+```typescript
+trackEvent(params: TrackEventParams): Promise<void>
+```
+
 ## Device API
 
 Each `device.*` method returns `null` if the device API is unavailable

package/index.d.ts

@@ -1,5 +1,5 @@
-export { device, getAllowedModels, generateMessage, getBrandingAssets, getToken, getUserInfo } from './lib/functions';
+export { device, generateMessage, getAllowedModels, getBrandingAssets, getToken, getUserInfo, trackEvent } from './lib/functions';
 export { tcp } from './lib/tcp-socket';
 export type { TcpSocket } from './lib/tcp-socket';
 export { setGlobalTimeout, withTimeout } from './lib/rpc-bridge';
-export type { AllowedModelsInfo, BrandingAssets, BrowserMetrics, CertError, ConnectionError, DesktopAppInfo, DeviceMetrics, DeviceSnapshot, DeviceSnapshotOptions, DisplayUnit, FailedRequest, GenerateMessageOptions, GetTokenOptions, GetTokenResult, InstalledExtension, IntegrationAppName, NetworkInfo, ProcessInfo, SiteStatusInfo, SoftwareVersions, StatusPageResult, TabSnapshot, UserInfo } from './lib/types';
+export type { AllowedModelsInfo, BrandingAssets, BrowserMetrics, CertError, ConnectionError, DesktopAppInfo, DeviceMetrics, DeviceSnapshot, DeviceSnapshotOptions, DisplayUnit, FailedRequest, GenerateMessageOptions, GetTokenOptions, GetTokenResult, InstalledExtension, IntegrationAppName, NetworkInfo, ProcessInfo, SiteStatusInfo, SnakeCase, SoftwareVersions, StatusPageResult, TabSnapshot, TrackEventDetailValue, TrackEventDetails, TrackEventParams, UserInfo } from './lib/types';

package/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});let u=15e3;const c=new Map;let a=!1;function d(e){u=e}let i;function f(e,t){i=t;try{return e()}finally{i=void 0}}function m(){a||(a=!0,window.addEventListener("message",e=>{const t=e.data;if(!t?.messageId||!("name"in t))return;const s=c.get(t.messageId);s&&(clearTimeout(s.timer),c.delete(t.messageId),t.error?s.reject(new Error(t.error.message??"RPC error")):s.resolve(t.data))}))}function n(e,t){return m(),new Promise((s,r)=>{const o=crypto.randomUUID(),l=setTimeout(()=>{c.delete(o),r(new Error(`RPC timeout: ${e}`))},i??u);c.set(o,{resolve:s,reject:r,timer:l});const g={action:e,params:t,messageId:o};window.parent.postMessage(g,"*")})}async function w(){return n("getAllowedModels",[])}async function v(e,t){return n("generateMessage",[e,t])}async function p(e,t){return n("getToken",[e,t])}async function y(){return n("getUserInfo",[])}async function S(){return n("getBrandingAssets",[])}async function T(e){return n("tcpConnect",[e])}async function G(e,t){return n("tcpSend",[e,t])}async function M(e,t){return n("tcpReceive",[e,t])}async function b(e){return n("tcpClose",[e])}const I={getSnapshot:e=>n("deviceGetSnapshot",[e]),getSoftware:()=>n("deviceGetSoftware",[]),getDevice:()=>n("deviceGetDevice",[]),getBrowser:()=>n("deviceGetBrowser",[]),getNetwork:()=>n("deviceGetNetwork",[]),getTabs:()=>n("deviceGetTabs",[]),getSiteStatus:e=>n("deviceGetSiteStatus",[e]),getStatusPage:e=>n("deviceGetStatusPage",[e])},C={async connect(e,t){const s=await T({host:e,port:t});return s===null?null:{send:async r=>(await G(s,{dataBase64:r}))?.bytesSent??null,receive:async()=>(await M(s))?.data??null,close:()=>b(s)}}};exports.device=I;exports.generateMessage=v;exports.getAllowedModels=w;exports.getBrandingAssets=S;exports.getToken=p;exports.getUserInfo=y;exports.setGlobalTimeout=d;exports.tcp=C;exports.withTimeout=f;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});let u=15e3;const c=new Map;let i=!1;function d(e){u=e}let a;function f(e,t){a=t;try{return e()}finally{a=void 0}}function m(){i||(i=!0,window.addEventListener("message",e=>{const t=e.data;if(!t?.messageId||!("name"in t))return;const r=c.get(t.messageId);r&&(clearTimeout(r.timer),c.delete(t.messageId),t.error?r.reject(new Error(t.error.message??"RPC error")):r.resolve(t.data))}))}function n(e,t){return m(),new Promise((r,s)=>{const o=crypto.randomUUID(),l=setTimeout(()=>{c.delete(o),s(new Error(`RPC timeout: ${e}`))},a??u);c.set(o,{resolve:r,reject:s,timer:l});const g={action:e,params:t,messageId:o};window.parent.postMessage(g,"*")})}async function v(){return n("getAllowedModels",[])}async function w(e,t){return n("generateMessage",[e,t])}async function y(e,t){return n("getToken",[e,t])}async function p(){return n("getUserInfo",[])}async function S(){return n("getBrandingAssets",[])}async function T(e){return n("tcpConnect",[e])}async function G(e,t){return n("tcpSend",[e,t])}async function M(e,t){return n("tcpReceive",[e,t])}async function b(e){return n("tcpClose",[e])}async function k(e){return n("trackEvent",[e])}const I={getSnapshot:e=>n("deviceGetSnapshot",[e]),getSoftware:()=>n("deviceGetSoftware",[]),getDevice:()=>n("deviceGetDevice",[]),getBrowser:()=>n("deviceGetBrowser",[]),getNetwork:()=>n("deviceGetNetwork",[]),getTabs:()=>n("deviceGetTabs",[]),getSiteStatus:e=>n("deviceGetSiteStatus",[e]),getStatusPage:e=>n("deviceGetStatusPage",[e])},C={async connect(e,t){const r=await T({host:e,port:t});return r===null?null:{send:async s=>(await G(r,{dataBase64:s}))?.bytesSent??null,receive:async()=>(await M(r))?.data??null,close:()=>b(r)}}};exports.device=I;exports.generateMessage=w;exports.getAllowedModels=v;exports.getBrandingAssets=S;exports.getToken=y;exports.getUserInfo=p;exports.setGlobalTimeout=d;exports.tcp=C;exports.trackEvent=k;exports.withTimeout=f;

package/index.mjs

@@ -1,20 +1,20 @@
 let u = 15e3;
 const c = /* @__PURE__ */ new Map();
-let a = !1;
+let i = !1;
 function y(e) {
   u = e;
 }
-let i;
+let a;
 function S(e, t) {
-  i = t;
+  a = t;
   try {
     return e();
   } finally {
-    i = void 0;
+    a = void 0;
   }
 }
 function g() {
-  a || (a = !0, window.addEventListener("message", (e) => {
+  i || (i = !0, window.addEventListener("message", (e) => {
     const t = e.data;
     if (!t?.messageId || !("name" in t)) return;
     const r = c.get(t.messageId);
@@ -25,7 +25,7 @@ function n(e, t) {
   return g(), new Promise((r, s) => {
     const o = crypto.randomUUID(), l = setTimeout(() => {
       c.delete(o), s(new Error(`RPC timeout: ${e}`));
-    }, i ?? u);
+    }, a ?? u);
     c.set(o, {
       resolve: r,
       reject: s,
@@ -47,7 +47,7 @@ async function C(e, t) {
 async function I() {
   return n("getUserInfo", []);
 }
-async function M() {
+async function k() {
   return n("getBrandingAssets", []);
 }
 async function f(e) {
@@ -56,12 +56,15 @@ async function f(e) {
 async function m(e, t) {
   return n("tcpSend", [e, t]);
 }
-async function w(e, t) {
+async function v(e, t) {
   return n("tcpReceive", [e, t]);
 }
-async function p(e) {
+async function w(e) {
   return n("tcpClose", [e]);
 }
+async function M(e) {
+  return n("trackEvent", [e]);
+}
 const b = {
   getSnapshot: (e) => n("deviceGetSnapshot", [e]),
   getSoftware: () => n("deviceGetSoftware", []),
@@ -71,7 +74,7 @@ const b = {
   getTabs: () => n("deviceGetTabs", []),
   getSiteStatus: (e) => n("deviceGetSiteStatus", [e]),
   getStatusPage: (e) => n("deviceGetStatusPage", [e])
-}, P = {
+}, E = {
   /**
    * Opens a TCP connection and returns a `TcpSocket` wrapper.
    *
@@ -84,8 +87,8 @@ const b = {
     const r = await f({ host: e, port: t });
     return r === null ? null : {
       send: async (s) => (await m(r, { dataBase64: s }))?.bytesSent ?? null,
-      receive: async () => (await w(r))?.data ?? null,
-      close: () => p(r)
+      receive: async () => (await v(r))?.data ?? null,
+      close: () => w(r)
     };
   }
 };
@@ -93,10 +96,11 @@ export {
   b as device,
   G as generateMessage,
   T as getAllowedModels,
-  M as getBrandingAssets,
+  k as getBrandingAssets,
   C as getToken,
   I as getUserInfo,
   y as setGlobalTimeout,
-  P as tcp,
+  E as tcp,
+  M as trackEvent,
   S as withTimeout
 };

package/lib/functions.d.ts

@@ -1,4 +1,4 @@
-import { AllowedModelsInfo, BrandingAssets, BrowserMetrics, DeviceMetrics, DeviceSnapshot, DeviceSnapshotOptions, GenerateMessageOptions, GetTokenOptions, GetTokenResult, IntegrationAppName, NetworkInfo, SiteStatusInfo, SoftwareVersions, StatusPageResult, TabSnapshot, TcpConnectOptions, TcpConnectionSettings, TcpReceiveOptions, TcpReceiveResult, TcpSendMessage, TcpSendResult, UserInfo } from './types';
+import { AllowedModelsInfo, BrandingAssets, BrowserMetrics, DeviceMetrics, DeviceSnapshot, DeviceSnapshotOptions, GenerateMessageOptions, GetTokenOptions, GetTokenResult, IntegrationAppName, NetworkInfo, SiteStatusInfo, SoftwareVersions, StatusPageResult, TabSnapshot, TcpConnectOptions, TcpConnectionSettings, TcpReceiveOptions, TcpReceiveResult, TcpSendMessage, TcpSendResult, TrackEventParams, UserInfo } from './types';
 export declare function getAllowedModels(): Promise<AllowedModelsInfo>;
 export declare function generateMessage(prompt: string, options: GenerateMessageOptions): Promise<string | null>;
 export declare function getToken(appName: IntegrationAppName, options?: GetTokenOptions): Promise<GetTokenResult | null>;
@@ -9,6 +9,7 @@ export declare function tcpConnect(options: TcpConnectOptions): Promise<TcpConne
 export declare function tcpSend(connection: TcpConnectionSettings, message: TcpSendMessage): Promise<TcpSendResult | null>;
 export declare function tcpReceive(connection: TcpConnectionSettings, options?: TcpReceiveOptions): Promise<TcpReceiveResult | null>;
 export declare function tcpClose(connection: TcpConnectionSettings): Promise<void>;
+export declare function trackEvent(params: TrackEventParams): Promise<void>;
 export declare const device: {
     getSnapshot: (options?: DeviceSnapshotOptions) => Promise<DeviceSnapshot | null>;
     getSoftware: () => Promise<SoftwareVersions | null>;

package/lib/types.d.ts

@@ -121,6 +121,10 @@ export interface StatusPageResult {
     description: string;
     domain: string;
 }
+export interface TrackEventParams {
+    eventName: SnakeCase<string>;
+    additionalDetails?: TrackEventDetails;
+}
 export interface DisplayUnit {
     top: number;
     left: number;
@@ -165,3 +169,7 @@ export interface ConnectionError {
     reason: 'host-policy' | 'host-throttle' | 'other-extension' | 'network';
     extensionId?: string;
 }
+export type SnakeCase<S extends string> = SnakeCaseInner<S> extends `_${infer Rest}` ? Rest : SnakeCaseInner<S>;
+export type TrackEventDetails = Record<string, TrackEventDetailValue | Record<string, TrackEventDetailValue>>;
+export type SnakeCaseInner<S extends string> = S extends `${infer T}${infer U}` ? `${T extends Uppercase<T> ? '_' : ''}${Lowercase<T>}${SnakeCaseInner<U>}` : S;
+export type TrackEventDetailValue = string | number | boolean | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-publish-sdk",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "module": "./index.mjs",
   "main": "./index.js",
   "types": "./index.d.ts",