@base44-preview/sdk 0.8.18-pr.78.04eb7f2 → 0.8.18-pr.79.302a71f

package/dist/client.types.d.ts

@@ -74,23 +74,20 @@ export interface CreateClientConfig {
  * Provides access to all SDK modules for interacting with the app.
  */
 export interface Base44Client {
-    /** {@link EntitiesModule | Entities module} for CRUD operations on your data models. */
-    entities: EntitiesModule;
-    /** {@link IntegrationsModule | Integrations module} for calling pre-built integration endpoints. */
-    integrations: IntegrationsModule;
-    /** {@link AuthModule | Auth module} for user authentication and management. */
-    auth: AuthModule;
-    /** {@link FunctionsModule | Functions module} for invoking custom backend functions. */
-    functions: FunctionsModule;
     /** {@link AgentsModule | Agents module} for managing AI agent conversations. */
     agents: AgentsModule;
+    /** {@link AnalyticsModule | Analytics module} for tracking custom events in your app. */
+    analytics: AnalyticsModule;
     /** {@link AppLogsModule | App logs module} for tracking app usage. */
     appLogs: AppLogsModule;
-    /**
-     * Analytics module for tracking app usage.
-     * @internal
-     */
-    analytics: AnalyticsModule;
+    /** {@link AuthModule | Auth module} for user authentication and management. */
+    auth: AuthModule;
+    /** {@link EntitiesModule | Entities module} for CRUD operations on your data models. */
+    entities: EntitiesModule;
+    /** {@link FunctionsModule | Functions module} for invoking custom backend functions. */
+    functions: FunctionsModule;
+    /** {@link IntegrationsModule | Integrations module} for calling pre-built integration endpoints. */
+    integrations: IntegrationsModule;
     /** Cleanup function to disconnect WebSocket connections. Call when you're done with the client. */
     cleanup: () => void;
     /**
@@ -118,22 +115,22 @@ export interface Base44Client {
      * @throws {Error} When accessed without providing a serviceToken during client creation
      */
     readonly asServiceRole: {
+        /** {@link AgentsModule | Agents module} with elevated permissions. */
+        agents: AgentsModule;
+        /** {@link AppLogsModule | App logs module} with elevated permissions. */
+        appLogs: AppLogsModule;
+        /** {@link ConnectorsModule | Connectors module} for OAuth token retrieval. */
+        connectors: ConnectorsModule;
         /** {@link EntitiesModule | Entities module} with elevated permissions. */
         entities: EntitiesModule;
+        /** {@link FunctionsModule | Functions module} with elevated permissions. */
+        functions: FunctionsModule;
         /** {@link IntegrationsModule | Integrations module} with elevated permissions. */
         integrations: IntegrationsModule;
         /** {@link SsoModule | SSO module} for generating SSO tokens.
          * @internal
          */
         sso: SsoModule;
-        /** {@link ConnectorsModule | Connectors module} for OAuth token retrieval. */
-        connectors: ConnectorsModule;
-        /** {@link FunctionsModule | Functions module} with elevated permissions. */
-        functions: FunctionsModule;
-        /** {@link AgentsModule | Agents module} with elevated permissions. */
-        agents: AgentsModule;
-        /** {@link AppLogsModule | App logs module} with elevated permissions. */
-        appLogs: AppLogsModule;
         /** Cleanup function to disconnect WebSocket connections. */
         cleanup: () => void;
     };

package/dist/modules/analytics.types.d.ts

@@ -1,8 +1,38 @@
+/**
+ * Properties for analytics events.
+ *
+ * Key-value pairs with additional event data. Values can be strings, numbers, booleans, or null.
+ */
 export type TrackEventProperties = {
     [key: string]: string | number | boolean | null | undefined;
 };
+/**
+ * Parameters for tracking an analytics event.
+ */
 export type TrackEventParams = {
+    /**
+     * Name of the event to track.
+     *
+     * Use descriptive names like `button_click`, `form_submit`, or `purchase_completed`.
+     */
     eventName: string;
+    /**
+     * Optional key-value pairs with additional event data.
+     *
+     * Values can be strings, numbers, booleans, or null.
+     *
+     * @example
+     * ```typescript
+     * base44.analytics.track({
+     *   eventName: 'add_to_cart',
+     *   properties: {
+     *     product_id: 'prod_123',
+     *     price: 29.99,
+     *     quantity: 2
+     *   }
+     * });
+     * ```
+     */
     properties?: TrackEventProperties;
 };
 export type TrackEventIntrinsicData = {
@@ -37,6 +67,63 @@ export type AnalyticsModuleOptions = {
     batchSize?: number;
     heartBeatInterval?: number;
 };
-export type AnalyticsModule = {
-    track: (params: TrackEventParams) => void;
-};
+/**
+ * Analytics module for tracking custom events in your app.
+ *
+ * Use this module to track specific user actions that appear as custom event cards in your [Analytics dashboard](/documentation/performance-and-seo/app-analytics). Track things like button clicks, form submissions, purchases, and feature usage.
+ *
+ * Choose clear, descriptive event names in snake_case like `signup_button_click` or `purchase_completed` rather than generic names like `click`. Include relevant context in your properties such as identifiers like `product_id`, measurements like `price`, and flags like `is_first_purchase`.
+ *
+ * This module is only available in user authentication mode (`base44.analytics`).
+ *
+ * ## Built-in vs Custom Analytics
+ *
+ * Your Analytics dashboard shows two types of data:
+ *
+ * **Built-in metrics:**
+ * - Total visits, unique visitors, visit duration, and live visitors.
+ * - Breakdown cards for country, device, operating system, and referrer.
+ *
+ * These begin tracking automatically when {@linkcode createClient | createClient()} is called and continue tracking until the client is cleaned up.
+ *
+ * **Custom events:**
+ * - Each event you track with `track()` appears as its own card in the dashboard.
+ * - Use these to measure specific actions that matter to your app.
+ *
+ * These are tracked when you call the `track()` method.
+ */
+export interface AnalyticsModule {
+    /**
+     * Tracks a custom event that appears as a card in your Analytics dashboard.
+     *
+     * Each unique event name becomes its own card showing total count and trends over time. This method returns immediately and events are sent in batches in the background.
+     *
+     * @param params - Event parameters.
+     * @param params.eventName - Name of the event. This becomes the card title in your dashboard. Use descriptive names like `'signup_button_click'` or `'purchase_completed'`.
+     * @param params.properties - Optional data to attach to the event. You can filter and analyze events by these properties in the dashboard.
+     *
+     * @example Track a button click
+     * ```typescript
+     * // Track a button click
+     * base44.analytics.track({
+     *   eventName: 'signup_button_click'
+     * });
+     * ```
+     *
+     * @example Track with properties
+     * ```typescript
+     * // Track with properties
+     * base44.analytics.track({
+     *   eventName: 'add_to_cart',
+     *   properties: {
+     *     product_id: 'prod_123',
+     *     product_name: 'Premium Widget',
+     *     price: 29.99,
+     *     quantity: 2,
+     *     is_first_purchase: true
+     *   }
+     * });
+     * ```
+     */
+    track(params: TrackEventParams): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.18-pr.78.04eb7f2",
+  "version": "0.8.18-pr.79.302a71f",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",