sizebay-core-sdk 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [1.1.0](https://github.com/sizebay/events-sdk/compare/v1.0.1...v1.1.0) (2025-04-01)
+
+### Features
+
+* **tracker:** update TrackData types and documentation ([e7187f2](https://github.com/sizebay/events-sdk/commit/e7187f2ca7b5d0ecee3404b19bf3fa21f8c14953))
+
 ## [1.0.1](https://github.com/sizebay/events-sdk/compare/v1.0.0...v1.0.1) (2025-04-01)
 
 ### Bug Fixes

package/README.md

@@ -35,25 +35,63 @@ const client = createClient({
 
 ---
 
-### Tracker Module
+## Tracker Module
 
-#### `track(eventName: string, payload: EventPayload): Promise<any>`
-Sends an event to the designated API endpoint.
+#### `track(eventName: string, payload: TrackData): Promise<TrackResponse>`
+Sends an event to the designated API endpoint, returning a standardized response.
 
 **Parameters**
 
-| Parameter    | Type           | Required | Description                                      |
-|--------------|----------------|----------|--------------------------------------------------|
-| `eventName`  | `string`       | Yes      | The name of the event (e.g., "ADD_TO_CART", "ORDER").     |
-| `payload`    | `EventPayload` | Yes      | An object containing event data.               |
+| Parameter   | Type        | Required | Description                                                           |
+|-------------|-------------|----------|-----------------------------------------------------------------------|
+| `eventName` | `string`    | Yes      | The name of the event (e.g., "ADD_TO_CART", "ORDER").                 |
+| `payload`   | `TrackData` | Yes      | An object containing event data. See the structure of `TrackData` below. |
+
+**TrackData Structure**
+
+| Property    | Type                          | Required | Description                                                           |
+|-------------|-------------------------------|----------|-----------------------------------------------------------------------|
+| **sid**     | `string`                      | Yes      | Unique session identifier.                                            |
+| **tenantId**| `number`                      | Yes      | Identifier of the tenant (client) sending the event.                  |
+| **sessionId**| `number`                     | Yes      | Internal session identifier.                                          |
+| **permalink**| `string` (optional)          | No       | Product URL associated with the event. When the event is linked to product (e.g., ADD_TO_CART RECOMMENDATION_DONE), it is required.                              |
+| **properties**| `Record<string, JSONValue>` | Yes      | Object containing additional properties as key-value pairs.           |
+**Returns**
+
+- **201** – Event successfully created.
+  ```json
+  {
+    "statusCode": 201,
+    "message": "Event successfully created."
+  }
+  ```
+- **400** – Invalid or missing fields.
+  ```json
+  {
+    "statusCode": 400,
+    "error": "Bad Request",
+    "message": [
+      "tenantId must be an integer number"
+    ]
+  }
+  ```
+- **500** – Internal server error.
+  ```json
+  {
+    "statusCode": 500,
+    "error": "Internal server error",
+    "message": [
+      "Unexpected error on server side"
+    ]
+  }
+  ```
 
 **Example**
 
 ```typescript
-const eventPayload = {
+const eventPayload: TrackData = {
   sid: 'a0cf8559-926a-4a75-b4ca-7c4c13fed69c',
   tenantId: 123,
-  eventName: 'ADD_TO_CART',
   sessionId: 123,
   permalink: 'https://www.example.com/2IC-7370',
   properties: {
@@ -66,9 +104,18 @@ const eventPayload = {
 async function trackEvent() {
   try {
     const response = await client.track('ADD_TO_CART', eventPayload);
-    console.log('Event tracked successfully:', response);
+
+    if (response.statusCode === 201) {
+      console.log('Event tracked successfully:', response.message);
+    } else {
+      console.error(
+        `Error tracking event (${response.statusCode}):`,
+        response.error,
+        response.message
+      );
+    }
   } catch (error: any) {
-    console.error('Error tracking event:', error.message);
+    console.error('Unexpected error tracking event:', error.message);
   }
 }
 

package/dist/types/src/modules/tracker.d.ts

@@ -1,7 +1,7 @@
-import { TrackData } from '../types';
+import { TrackData, TrackResponse } from '../types';
 import { Config } from '../config';
 export declare class Tracker {
     private endpoint;
     constructor(config: Config);
-    track(eventName: string, payload: TrackData): Promise<any>;
+    track(eventName: string, payload: TrackData): Promise<TrackResponse>;
 }

package/dist/types/src/types/event.types.d.ts

@@ -11,3 +11,18 @@ export interface TrackData {
 export interface DataEventPayload extends TrackData {
     eventName: string;
 }
+export interface TrackSuccessResponse {
+    statusCode: 201;
+    message: 'Event successfully created.';
+}
+export interface TrackBadRequestResponse {
+    statusCode: 400;
+    error: 'Bad Request';
+    message: string[];
+}
+export interface TrackServerErrorResponse {
+    statusCode: 500;
+    error: 'Internal server error';
+    message: string[];
+}
+export type TrackResponse = TrackSuccessResponse | TrackBadRequestResponse | TrackServerErrorResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sizebay-core-sdk",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "A SDK designed for integrating multiple services (such as event tracking, AI services, etc.) into your application.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/modules/tracker.ts

@@ -1,4 +1,4 @@
-import { DataEventPayload, TrackData } from "../types";
+import { DataEventPayload, TrackData, TrackResponse } from "../types";
 import { Config } from "../config";
 
 export class Tracker {
@@ -9,7 +9,7 @@ export class Tracker {
     this.endpoint =  config.getEndpoint('tracker');
   }
 
-  public async track(eventName: string, payload: TrackData): Promise<any> {
+  public async track(eventName: string, payload: TrackData): Promise<TrackResponse> {
     const data: DataEventPayload = {
       eventName,
       ...payload,

package/src/types/event.types.ts

@@ -1,6 +1,3 @@
-/**
- * Represents any valid JSON value.
- */
 export type JSONValue =
   | string
   | number
@@ -9,9 +6,6 @@ export type JSONValue =
   | JSONValue[]
   | { [key: string]: JSONValue };
 
-/**
- * Interface that defines the structure of a tracked event.
- */
 export interface TrackData {
   sid: string;
   tenantId: number;
@@ -20,9 +14,30 @@ export interface TrackData {
   properties: Record<string, JSONValue>;
 }
 
-/**
- * Payload for the track event.
- */
 export interface DataEventPayload extends TrackData {
   eventName: string;
-}
+}
+
+export interface TrackSuccessResponse {
+  statusCode: 201;
+  message: 'Event successfully created.';
+}
+
+export interface TrackBadRequestResponse {
+  statusCode: 400;
+  error: 'Bad Request';
+
+  message: string[];
+}
+
+export interface TrackServerErrorResponse {
+  statusCode: 500;
+  error: 'Internal server error';
+
+  message: string[];
+}
+
+export type TrackResponse =
+  | TrackSuccessResponse
+  | TrackBadRequestResponse
+  | TrackServerErrorResponse;