saasco-sdk 0.1.40 → 0.1.42

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "saasco-sdk",
-  "version": "0.1.40",
+  "version": "0.1.42",
   "dependencies": {
     "tslib": "^2.3.0",
     "@lukeed/uuid": "^2.0.1",
     "zod": "^3.22.4",
-    "psl": "^1.9.0"
+    "psl": "^1.9.0",
+    "js-sha256": "^0.11.1"
   },
   "main": "./index.cjs.js",
   "typings": "./src/index.d.ts",

package/src/lib/analytics.d.ts

@@ -1,4 +1,5 @@
 import { FacebookPixelIntegrationConfig } from './integrations/facebook-pixel';
+import { TikTokPixelIntegrationConfig } from './integrations/tiktok-pixel';
 declare global {
     interface Window {
         saascoAutoPageTrackingActive?: boolean;
@@ -29,7 +30,7 @@ export type IntegrationConfigBase = {
     type: string;
     config: Record<string, any>;
 };
-export type IntegrationsConfig = FacebookPixelIntegrationConfig[];
+export type IntegrationsConfig = (FacebookPixelIntegrationConfig | TikTokPixelIntegrationConfig)[];
 export declare class Saasco {
     private config;
     private lastPageViewPath;

package/src/lib/integrations/index.d.ts

@@ -1,2 +1,3 @@
 export * from './integration-manager';
 export * from './facebook-pixel';
+export * from './tiktok-pixel';

package/src/lib/integrations/tiktok-pixel.d.ts

@@ -0,0 +1,59 @@
+/**
+ * TikTok Pixel Integration
+ *
+ * This integration provides TikTok Pixel tracking capabilities including:
+ * - Event tracking for standard and custom events
+ * - Advanced matching with hashed user identification data
+ * - Automatic script loading and initialization
+ *
+ * Key Resources:
+ * - Advanced Matching: https://business-api.tiktok.com/portal/docs?rid=5ipocbxyw8v&id=1739585700402178
+ * - Standard Events: https://business-api.tiktok.com/portal/docs?id=1771101186666498
+ */
+import { IntegrationConfigBase } from '../analytics';
+import { Integration } from './integration-manager';
+declare global {
+    interface Window {
+        ttq?: Ttq;
+        TiktokAnalyticsObject?: string;
+    }
+    interface Ttq {
+        (...args: any[]): void;
+        methods?: string[];
+        _i?: Record<string, any>;
+        _t?: Record<string, number>;
+        _o?: Record<string, any>;
+        load?: (pixelId: string, options?: any) => void;
+        page?: () => void;
+        track?: (eventName: string, properties?: Record<string, unknown>) => void;
+        identify?: (properties?: Record<string, unknown>) => void;
+        setAndDefer?: (obj: any, method: string) => void;
+        instance?: (pixelId: string) => any;
+    }
+}
+export type TikTokEventMapping = {
+    [key: string]: StandardTikTokEvent;
+};
+export type TikTokPixelIntegrationConfig = IntegrationConfigBase & {
+    type: 'tiktok-pixel';
+    config: TikTokPixelConfig;
+};
+export type TikTokPixelConfig = {
+    pixelId: string;
+    eventMapping?: TikTokEventMapping;
+    testMode?: boolean;
+};
+/**
+ * Standard TikTok events supported by the pixel
+ *
+ * Note: This list reflects TikTok's official standard events. Events like 'CompletePayment'
+ * are not standard events and should be tracked as custom events if needed.
+ *
+ * Documentation: https://business-api.tiktok.com/portal/docs?id=1771101186666498
+ */
+export declare const standardTikTokEvents: readonly ["AddPaymentInfo", "AddToCart", "AddToWishlist", "ApplicationApproval", "CompleteRegistration", "Contact", "CustomizeProduct", "Download", "FindLocation", "InitiateCheckout", "Lead", "Purchase", "Schedule", "Search", "StartTrial", "SubmitApplication", "Subscribe", "ViewContent", "PageView"];
+export type StandardTikTokEvent = (typeof standardTikTokEvents)[number];
+/**
+ * Create a TikTok Pixel integration instance
+ */
+export declare function createTikTokPixelIntegration(config: TikTokPixelConfig): Integration;