@croct/sdk 0.18.2 → 0.19.0

package/constants.cjs

@@ -25,7 +25,7 @@ __export(constants_exports, {
 module.exports = __toCommonJS(constants_exports);
 const BASE_ENDPOINT_URL = "https://api.croct.io";
 const MAX_QUERY_LENGTH = parseInt("<@maxQueryLength@>", 10);
-const VERSION = "0.18.2";
+const VERSION = "0.19.0";
 const CLIENT_LIBRARY = `Croct SDK JS v${VERSION}`;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/constants.d.cts

@@ -1,6 +1,6 @@
 declare const BASE_ENDPOINT_URL = "https://api.croct.io";
 declare const MAX_QUERY_LENGTH: number;
-declare const VERSION = "0.18.2";
-declare const CLIENT_LIBRARY = "Croct SDK JS v0.18.2";
+declare const VERSION = "0.19.0";
+declare const CLIENT_LIBRARY = "Croct SDK JS v0.19.0";
 
 export { BASE_ENDPOINT_URL, CLIENT_LIBRARY, MAX_QUERY_LENGTH, VERSION };

package/constants.d.ts

@@ -1,6 +1,6 @@
 declare const BASE_ENDPOINT_URL = "https://api.croct.io";
 declare const MAX_QUERY_LENGTH: number;
-declare const VERSION = "0.18.2";
-declare const CLIENT_LIBRARY = "Croct SDK JS v0.18.2";
+declare const VERSION = "0.19.0";
+declare const CLIENT_LIBRARY = "Croct SDK JS v0.19.0";
 
 export { BASE_ENDPOINT_URL, CLIENT_LIBRARY, MAX_QUERY_LENGTH, VERSION };

package/constants.js

@@ -1,6 +1,6 @@
 const BASE_ENDPOINT_URL = "https://api.croct.io";
 const MAX_QUERY_LENGTH = parseInt("<@maxQueryLength@>", 10);
-const VERSION = "0.18.2";
+const VERSION = "0.19.0";
 const CLIENT_LIBRARY = `Croct SDK JS v${VERSION}`;
 export {
   BASE_ENDPOINT_URL,

package/facade/trackerFacade.cjs

@@ -33,7 +33,8 @@ const eventSchemas = {
   interestShown: import_schema.interestShown,
   postViewed: import_schema.postViewed,
   goalCompleted: import_schema.goalCompleted,
-  linkOpened: import_schema.linkOpened
+  linkOpened: import_schema.linkOpened,
+  leadGenerated: import_schema.leadGenerated
 };
 function validateEvent(event) {
   const { type, ...payload } = event;

package/facade/trackerFacade.js

@@ -10,7 +10,8 @@ import {
   orderPlaced,
   productViewed,
   userSignedUp,
-  linkOpened
+  linkOpened,
+  leadGenerated
 } from "../schema/index.js";
 const eventSchemas = {
   cartViewed,
@@ -23,7 +24,8 @@ const eventSchemas = {
   interestShown,
   postViewed,
   goalCompleted,
-  linkOpened
+  linkOpened,
+  leadGenerated
 };
 function validateEvent(event) {
   const { type, ...payload } = event;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croct/sdk",
-  "version": "0.18.2",
+  "version": "0.19.0",
   "description": "Croct SDK for JavaScript.",
   "license": "MIT",
   "author": {

package/schema/eventSchemas.cjs

@@ -23,6 +23,7 @@ __export(eventSchemas_exports, {
   eventOccurred: () => eventOccurred,
   goalCompleted: () => goalCompleted,
   interestShown: () => interestShown,
+  leadGenerated: () => leadGenerated,
   linkOpened: () => linkOpened,
   orderPlaced: () => orderPlaced,
   postViewed: () => postViewed,
@@ -145,6 +146,22 @@ const eventOccurred = new import_validation.ObjectType({
     })
   }
 });
+const leadGenerated = new import_validation.ObjectType({
+  properties: {
+    leadId: new import_validation.StringType({
+      minLength: 1,
+      maxLength: 100
+    }),
+    currency: new import_validation.StringType({
+      maxLength: 10,
+      minLength: 1
+    }),
+    value: new import_validation.NumberType({
+      minimum: 0
+    }),
+    lead: import_userSchema.userProfileSchema
+  }
+});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   cartModified,
@@ -153,6 +170,7 @@ const eventOccurred = new import_validation.ObjectType({
   eventOccurred,
   goalCompleted,
   interestShown,
+  leadGenerated,
   linkOpened,
   orderPlaced,
   postViewed,

package/schema/eventSchemas.d.cts

@@ -12,5 +12,6 @@ declare const interestShown: ObjectType;
 declare const postViewed: ObjectType;
 declare const linkOpened: ObjectType;
 declare const eventOccurred: ObjectType;
+declare const leadGenerated: ObjectType;
 
-export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp };
+export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp };

package/schema/eventSchemas.d.ts

@@ -12,5 +12,6 @@ declare const interestShown: ObjectType;
 declare const postViewed: ObjectType;
 declare const linkOpened: ObjectType;
 declare const eventOccurred: ObjectType;
+declare const leadGenerated: ObjectType;
 
-export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp };
+export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp };

package/schema/eventSchemas.js

@@ -121,6 +121,22 @@ const eventOccurred = new ObjectType({
     })
   }
 });
+const leadGenerated = new ObjectType({
+  properties: {
+    leadId: new StringType({
+      minLength: 1,
+      maxLength: 100
+    }),
+    currency: new StringType({
+      maxLength: 10,
+      minLength: 1
+    }),
+    value: new NumberType({
+      minimum: 0
+    }),
+    lead: userProfileSchema
+  }
+});
 export {
   cartModified,
   cartViewed,
@@ -128,6 +144,7 @@ export {
   eventOccurred,
   goalCompleted,
   interestShown,
+  leadGenerated,
   linkOpened,
   orderPlaced,
   postViewed,

package/schema/index.d.cts

@@ -2,7 +2,7 @@ export { tokenScopeSchema } from './contextSchemas.cjs';
 export { cart, cartItem, order, orderItem, productDetails } from './ecommerceSchemas.cjs';
 export { evaluationOptionsSchema } from './evaluatorSchemas.cjs';
 export { fetchOptionsSchema } from './contentFetcherSchemas.cjs';
-export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp } from './eventSchemas.cjs';
+export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp } from './eventSchemas.cjs';
 export { loggerSchema } from './loggerSchema.cjs';
 export { addOperation, clearOperation, combineOperation, decrementOperation, incrementOperation, mergeOperation, removeOperation, setOperation, unsetOperation } from './operationSchemas.cjs';
 export { sdkFacadeConfigurationSchema } from './sdkFacadeSchemas.cjs';

package/schema/index.d.ts

@@ -2,7 +2,7 @@ export { tokenScopeSchema } from './contextSchemas.js';
 export { cart, cartItem, order, orderItem, productDetails } from './ecommerceSchemas.js';
 export { evaluationOptionsSchema } from './evaluatorSchemas.js';
 export { fetchOptionsSchema } from './contentFetcherSchemas.js';
-export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp } from './eventSchemas.js';
+export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp } from './eventSchemas.js';
 export { loggerSchema } from './loggerSchema.js';
 export { addOperation, clearOperation, combineOperation, decrementOperation, incrementOperation, mergeOperation, removeOperation, setOperation, unsetOperation } from './operationSchemas.js';
 export { sdkFacadeConfigurationSchema } from './sdkFacadeSchemas.js';

package/tracker.cjs

@@ -314,6 +314,21 @@ class Tracker {
     };
   }
   createBeaconPayload(event) {
+    if (event.type === "leadGenerated" && event.lead !== void 0) {
+      const { lead, ...payload2 } = event;
+      return {
+        ...payload2,
+        patch: {
+          operations: [
+            {
+              type: "merge",
+              path: ".",
+              value: lead
+            }
+          ]
+        }
+      };
+    }
     if (!(0, import_trackingEvents.isIdentifiedUserEvent)(event)) {
       return event;
     }

package/tracker.js

@@ -295,6 +295,21 @@ class Tracker {
     };
   }
   createBeaconPayload(event) {
+    if (event.type === "leadGenerated" && event.lead !== void 0) {
+      const { lead, ...payload2 } = event;
+      return {
+        ...payload2,
+        patch: {
+          operations: [
+            {
+              type: "merge",
+              path: ".",
+              value: lead
+            }
+          ]
+        }
+      };
+    }
     if (!isIdentifiedUserEvent(event)) {
       return event;
     }

package/trackingEvents.cjs

@@ -64,7 +64,8 @@ const miscEventTypes = [
   "interestShown",
   "postViewed",
   "eventOccurred",
-  "linkOpened"
+  "linkOpened",
+  "leadGenerated"
 ];
 const eventTypes = [
   ...pageEventTypes,

package/trackingEvents.d.cts

@@ -73,8 +73,8 @@ declare const cartEventTypes: readonly ["cartModified", "cartViewed", "checkoutS
 declare const ecommerceEventTypes: readonly ["cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed"];
 declare const identifiedUserEventTypes: string[];
 declare const userEventTypes: readonly [...string[], "userProfileChanged"];
-declare const miscEventTypes: readonly ["nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened"];
-declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened"];
+declare const miscEventTypes: readonly ["nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
+declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
 interface BaseEvent {
     type: string;
 }
@@ -237,7 +237,14 @@ interface LinkOpened extends BaseEvent {
     type: 'linkOpened';
     link: string;
 }
-type MiscEvent = NothingChanged | SessionAttributesChanged | EventOccurred | GoalCompleted | InterestShown | PostViewed | LinkOpened;
+interface LeadGenerated extends BaseEvent {
+    type: 'leadGenerated';
+    leadId?: string;
+    currency?: string;
+    value?: number;
+    lead?: UserProfile;
+}
+type MiscEvent = NothingChanged | SessionAttributesChanged | EventOccurred | GoalCompleted | InterestShown | PostViewed | LinkOpened | LeadGenerated;
 type EventMap = {
     tabVisibilityChanged: TabVisibilityChanged;
     tabUrlChanged: TabUrlChanged;
@@ -260,6 +267,7 @@ type EventMap = {
     postViewed: PostViewed;
     eventOccurred: EventOccurred;
     linkOpened: LinkOpened;
+    leadGenerated: LeadGenerated;
 };
 type TrackingEventType = keyof EventMap;
 type TrackingEvent<T extends TrackingEventType = TrackingEventType> = T extends TrackingEventType ? EventMap[T] : EventMap[TrackingEventType];
@@ -283,6 +291,7 @@ type ExternalEventMap = {
     postViewed: PostViewed;
     linkOpened: LinkOpened;
     eventOccurred: EventOccurred;
+    leadGenerated: LeadGenerated;
 };
 type ExternalTrackingEventType = keyof ExternalEventMap;
 type ExternalTrackingEvent<T extends ExternalTrackingEventType = ExternalTrackingEventType> = T extends ExternalTrackingEventType ? ExternalEventMap[T] : ExternalEventMap[ExternalTrackingEventType];
@@ -296,7 +305,9 @@ type TrackingEventContext = {
         [key: string]: string;
     };
 };
-type BeaconPayload = Exclude<TrackingEvent, IdentifiedUserEvent> | DistributiveOmit<Exclude<IdentifiedUserEvent, UserSignedUp>, 'userId'> & Record<'externalUserId', IdentifiedUserEvent['userId']> | Omit<UserSignedUp, 'userId' | 'profile'> & Record<'externalUserId', IdentifiedUserEvent['userId']> & {
+type BeaconPayload = Exclude<TrackingEvent, IdentifiedUserEvent | LeadGenerated> | DistributiveOmit<Exclude<IdentifiedUserEvent, UserSignedUp>, 'userId'> & Record<'externalUserId', IdentifiedUserEvent['userId']> | Omit<UserSignedUp, 'userId' | 'profile'> & Record<'externalUserId', IdentifiedUserEvent['userId']> & {
+    patch?: Patch;
+} | Omit<LeadGenerated, 'lead'> & {
     patch?: Patch;
 };
 type Beacon = {
@@ -306,4 +317,4 @@ type Beacon = {
     payload: BeaconPayload;
 };
 
-export { type Beacon, type BeaconPayload, type Cart, type CartEvent, type CartEventType, type CartItem, type CartModified, type CartViewed, type CheckoutStarted, type EcommerceEvent, type EventOccurred, type ExternalTrackingEvent, type ExternalTrackingEventPayload, type ExternalTrackingEventType, type Gender, type GoalCompleted, type IdentifiedUserEvent, type InterestShown, type LinkOpened, type MiscEvent, type NothingChanged, type Order, type OrderItem, type OrderPlaced, type OrderStatus, type PageEvent, type PageEventType, type PageLoaded, type PageOpened, type PartialTrackingEvent, type PostDetails, type PostViewed, type ProductDetails, type ProductViewed, type SessionAttributesChanged, type TabEvent, type TabEventType, type TabOpened, type TabUrlChanged, type TabVisibilityChanged, type TrackingEvent, type TrackingEventContext, type TrackingEventType, type UserEvent, type UserProfile, type UserProfileChanged, type UserSignedIn, type UserSignedOut, type UserSignedUp, cartEventTypes, ecommerceEventTypes, eventTypes, identifiedUserEventTypes, isCartPartialEvent, isIdentifiedUserEvent, miscEventTypes, pageEventTypes, tabEventTypes, userEventTypes };
+export { type Beacon, type BeaconPayload, type Cart, type CartEvent, type CartEventType, type CartItem, type CartModified, type CartViewed, type CheckoutStarted, type EcommerceEvent, type EventOccurred, type ExternalTrackingEvent, type ExternalTrackingEventPayload, type ExternalTrackingEventType, type Gender, type GoalCompleted, type IdentifiedUserEvent, type InterestShown, type LeadGenerated, type LinkOpened, type MiscEvent, type NothingChanged, type Order, type OrderItem, type OrderPlaced, type OrderStatus, type PageEvent, type PageEventType, type PageLoaded, type PageOpened, type PartialTrackingEvent, type PostDetails, type PostViewed, type ProductDetails, type ProductViewed, type SessionAttributesChanged, type TabEvent, type TabEventType, type TabOpened, type TabUrlChanged, type TabVisibilityChanged, type TrackingEvent, type TrackingEventContext, type TrackingEventType, type UserEvent, type UserProfile, type UserProfileChanged, type UserSignedIn, type UserSignedOut, type UserSignedUp, cartEventTypes, ecommerceEventTypes, eventTypes, identifiedUserEventTypes, isCartPartialEvent, isIdentifiedUserEvent, miscEventTypes, pageEventTypes, tabEventTypes, userEventTypes };

package/trackingEvents.d.ts

@@ -73,8 +73,8 @@ declare const cartEventTypes: readonly ["cartModified", "cartViewed", "checkoutS
 declare const ecommerceEventTypes: readonly ["cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed"];
 declare const identifiedUserEventTypes: string[];
 declare const userEventTypes: readonly [...string[], "userProfileChanged"];
-declare const miscEventTypes: readonly ["nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened"];
-declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened"];
+declare const miscEventTypes: readonly ["nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
+declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
 interface BaseEvent {
     type: string;
 }
@@ -237,7 +237,14 @@ interface LinkOpened extends BaseEvent {
     type: 'linkOpened';
     link: string;
 }
-type MiscEvent = NothingChanged | SessionAttributesChanged | EventOccurred | GoalCompleted | InterestShown | PostViewed | LinkOpened;
+interface LeadGenerated extends BaseEvent {
+    type: 'leadGenerated';
+    leadId?: string;
+    currency?: string;
+    value?: number;
+    lead?: UserProfile;
+}
+type MiscEvent = NothingChanged | SessionAttributesChanged | EventOccurred | GoalCompleted | InterestShown | PostViewed | LinkOpened | LeadGenerated;
 type EventMap = {
     tabVisibilityChanged: TabVisibilityChanged;
     tabUrlChanged: TabUrlChanged;
@@ -260,6 +267,7 @@ type EventMap = {
     postViewed: PostViewed;
     eventOccurred: EventOccurred;
     linkOpened: LinkOpened;
+    leadGenerated: LeadGenerated;
 };
 type TrackingEventType = keyof EventMap;
 type TrackingEvent<T extends TrackingEventType = TrackingEventType> = T extends TrackingEventType ? EventMap[T] : EventMap[TrackingEventType];
@@ -283,6 +291,7 @@ type ExternalEventMap = {
     postViewed: PostViewed;
     linkOpened: LinkOpened;
     eventOccurred: EventOccurred;
+    leadGenerated: LeadGenerated;
 };
 type ExternalTrackingEventType = keyof ExternalEventMap;
 type ExternalTrackingEvent<T extends ExternalTrackingEventType = ExternalTrackingEventType> = T extends ExternalTrackingEventType ? ExternalEventMap[T] : ExternalEventMap[ExternalTrackingEventType];
@@ -296,7 +305,9 @@ type TrackingEventContext = {
         [key: string]: string;
     };
 };
-type BeaconPayload = Exclude<TrackingEvent, IdentifiedUserEvent> | DistributiveOmit<Exclude<IdentifiedUserEvent, UserSignedUp>, 'userId'> & Record<'externalUserId', IdentifiedUserEvent['userId']> | Omit<UserSignedUp, 'userId' | 'profile'> & Record<'externalUserId', IdentifiedUserEvent['userId']> & {
+type BeaconPayload = Exclude<TrackingEvent, IdentifiedUserEvent | LeadGenerated> | DistributiveOmit<Exclude<IdentifiedUserEvent, UserSignedUp>, 'userId'> & Record<'externalUserId', IdentifiedUserEvent['userId']> | Omit<UserSignedUp, 'userId' | 'profile'> & Record<'externalUserId', IdentifiedUserEvent['userId']> & {
+    patch?: Patch;
+} | Omit<LeadGenerated, 'lead'> & {
     patch?: Patch;
 };
 type Beacon = {
@@ -306,4 +317,4 @@ type Beacon = {
     payload: BeaconPayload;
 };
 
-export { type Beacon, type BeaconPayload, type Cart, type CartEvent, type CartEventType, type CartItem, type CartModified, type CartViewed, type CheckoutStarted, type EcommerceEvent, type EventOccurred, type ExternalTrackingEvent, type ExternalTrackingEventPayload, type ExternalTrackingEventType, type Gender, type GoalCompleted, type IdentifiedUserEvent, type InterestShown, type LinkOpened, type MiscEvent, type NothingChanged, type Order, type OrderItem, type OrderPlaced, type OrderStatus, type PageEvent, type PageEventType, type PageLoaded, type PageOpened, type PartialTrackingEvent, type PostDetails, type PostViewed, type ProductDetails, type ProductViewed, type SessionAttributesChanged, type TabEvent, type TabEventType, type TabOpened, type TabUrlChanged, type TabVisibilityChanged, type TrackingEvent, type TrackingEventContext, type TrackingEventType, type UserEvent, type UserProfile, type UserProfileChanged, type UserSignedIn, type UserSignedOut, type UserSignedUp, cartEventTypes, ecommerceEventTypes, eventTypes, identifiedUserEventTypes, isCartPartialEvent, isIdentifiedUserEvent, miscEventTypes, pageEventTypes, tabEventTypes, userEventTypes };
+export { type Beacon, type BeaconPayload, type Cart, type CartEvent, type CartEventType, type CartItem, type CartModified, type CartViewed, type CheckoutStarted, type EcommerceEvent, type EventOccurred, type ExternalTrackingEvent, type ExternalTrackingEventPayload, type ExternalTrackingEventType, type Gender, type GoalCompleted, type IdentifiedUserEvent, type InterestShown, type LeadGenerated, type LinkOpened, type MiscEvent, type NothingChanged, type Order, type OrderItem, type OrderPlaced, type OrderStatus, type PageEvent, type PageEventType, type PageLoaded, type PageOpened, type PartialTrackingEvent, type PostDetails, type PostViewed, type ProductDetails, type ProductViewed, type SessionAttributesChanged, type TabEvent, type TabEventType, type TabOpened, type TabUrlChanged, type TabVisibilityChanged, type TrackingEvent, type TrackingEventContext, type TrackingEventType, type UserEvent, type UserProfile, type UserProfileChanged, type UserSignedIn, type UserSignedOut, type UserSignedUp, cartEventTypes, ecommerceEventTypes, eventTypes, identifiedUserEventTypes, isCartPartialEvent, isIdentifiedUserEvent, miscEventTypes, pageEventTypes, tabEventTypes, userEventTypes };

package/trackingEvents.js

@@ -33,7 +33,8 @@ const miscEventTypes = [
   "interestShown",
   "postViewed",
   "eventOccurred",
-  "linkOpened"
+  "linkOpened",
+  "leadGenerated"
 ];
 const eventTypes = [
   ...pageEventTypes,