@croct/sdk 0.6.1 → 0.7.0

package/constants.js

@@ -5,4 +5,4 @@ exports.TRACKER_ENDPOINT_URL = 'wss://api.croct.io/client/web/connect';
 exports.EVALUATION_ENDPOINT_URL = 'https://api.croct.io/client/web/evaluate';
 exports.BOOTSTRAP_ENDPOINT_URL = 'https://api.croct.io/client/web/bootstrap';
 exports.MAX_EXPRESSION_LENGTH = 300;
-exports.VERSION = '0.6.1';
+exports.VERSION = '0.7.0';

package/facade/trackerFacade.js

@@ -11,8 +11,9 @@ var eventSchemas = {
     orderPlaced: schema_1.orderPlaced,
     productViewed: schema_1.productViewed,
     userSignedUp: schema_1.userSignedUp,
-    testGroupAssigned: schema_1.testGroupAssigned,
     eventOccurred: schema_1.eventOccurred,
+    interestShown: schema_1.interestShown,
+    postViewed: schema_1.postViewed,
     goalCompleted: schema_1.goalCompleted,
 };
 function createEvent(type, payload) {

package/package.json

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

package/schema/attributeSchema.d.ts

@@ -0,0 +1,2 @@
+import { StringType } from '../validation';
+export declare const attributeNameSchema: StringType;

package/schema/attributeSchema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.attributeNameSchema = void 0;
+var validation_1 = require("../validation");
+exports.attributeNameSchema = new validation_1.StringType({
+    maxLength: 50,
+    format: 'identifier',
+});

package/schema/contentSchemas.d.ts

@@ -0,0 +1,2 @@
+import { ObjectType } from '../validation';
+export declare const postDetails: ObjectType;

package/schema/contentSchemas.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.postDetails = void 0;
+var validation_1 = require("../validation");
+exports.postDetails = new validation_1.ObjectType({
+    required: ['postId', 'title', 'publishTime'],
+    properties: {
+        postId: new validation_1.StringType({
+            minLength: 1,
+            maxLength: 100,
+        }),
+        url: new validation_1.StringType({
+            format: 'url',
+        }),
+        title: new validation_1.StringType({
+            minLength: 1,
+            maxLength: 100,
+        }),
+        tags: new validation_1.ArrayType({
+            items: new validation_1.StringType({
+                minLength: 1,
+                maxLength: 50,
+            }),
+            minItems: 1,
+            maxItems: 10,
+        }),
+        categories: new validation_1.ArrayType({
+            items: new validation_1.StringType({
+                minLength: 1,
+                maxLength: 50,
+            }),
+            minItems: 1,
+            maxItems: 10,
+        }),
+        authors: new validation_1.ArrayType({
+            items: new validation_1.StringType({
+                minLength: 1,
+                maxLength: 50,
+            }),
+            minItems: 1,
+            maxItems: 10,
+        }),
+        publishTime: new validation_1.NumberType(),
+        updateTime: new validation_1.NumberType(),
+    },
+});

package/schema/eventSchemas.d.ts

@@ -5,6 +5,7 @@ export declare const checkoutStarted: ObjectType;
 export declare const orderPlaced: ObjectType;
 export declare const productViewed: ObjectType;
 export declare const userSignedUp: ObjectType;
-export declare const testGroupAssigned: ObjectType;
 export declare const goalCompleted: ObjectType;
+export declare const interestShown: ObjectType;
+export declare const postViewed: ObjectType;
 export declare const eventOccurred: ObjectType;

package/schema/eventSchemas.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.eventOccurred = exports.goalCompleted = exports.testGroupAssigned = exports.userSignedUp = exports.productViewed = exports.orderPlaced = exports.checkoutStarted = exports.cartViewed = exports.cartModified = void 0;
+exports.eventOccurred = exports.postViewed = exports.interestShown = exports.goalCompleted = exports.userSignedUp = exports.productViewed = exports.orderPlaced = exports.checkoutStarted = exports.cartViewed = exports.cartModified = void 0;
 var validation_1 = require("../validation");
 var ecommerceSchemas_1 = require("./ecommerceSchemas");
 var userSchema_1 = require("./userSchema");
+var contentSchemas_1 = require("./contentSchemas");
 exports.cartModified = new validation_1.ObjectType({
     required: ['cart'],
     properties: {
@@ -48,19 +49,6 @@ exports.userSignedUp = new validation_1.ObjectType({
         profile: userSchema_1.userProfileSchema,
     },
 });
-exports.testGroupAssigned = new validation_1.ObjectType({
-    required: ['testId', 'groupId'],
-    properties: {
-        testId: new validation_1.StringType({
-            minLength: 1,
-            maxLength: 50,
-        }),
-        groupId: new validation_1.StringType({
-            minLength: 1,
-            maxLength: 50,
-        }),
-    },
-});
 exports.goalCompleted = new validation_1.ObjectType({
     required: ['goalId'],
     properties: {
@@ -77,6 +65,25 @@ exports.goalCompleted = new validation_1.ObjectType({
         }),
     },
 });
+exports.interestShown = new validation_1.ObjectType({
+    required: ['interests'],
+    properties: {
+        interests: new validation_1.ArrayType({
+            items: new validation_1.StringType({
+                minLength: 1,
+                maxLength: 50,
+            }),
+            minItems: 1,
+            maxItems: 10,
+        }),
+    },
+});
+exports.postViewed = new validation_1.ObjectType({
+    required: ['post'],
+    properties: {
+        post: contentSchemas_1.postDetails,
+    },
+});
 exports.eventOccurred = new validation_1.ObjectType({
     required: ['name'],
     properties: {

package/schema/operationSchemas.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.unsetOperation = exports.clearOperation = exports.incrementOperation = exports.decrementOperation = exports.mergeOperation = exports.combineOperation = exports.setOperation = exports.addOperation = void 0;
 var validation_1 = require("../validation");
+var attributeSchema_1 = require("./attributeSchema");
 var pointer = new validation_1.StringType({
     format: 'pointer',
 });
@@ -10,9 +11,11 @@ var simpleArray = new validation_1.JsonArrayType({
 });
 var simpleMap = new validation_1.JsonObjectType({
     properties: new validation_1.JsonPrimitiveType(),
+    propertyNames: attributeSchema_1.attributeNameSchema,
 });
 var complexMap = new validation_1.JsonObjectType({
     properties: new validation_1.UnionType(new validation_1.JsonPrimitiveType(), simpleArray, simpleMap),
+    propertyNames: attributeSchema_1.attributeNameSchema,
 });
 var collectionValue = new validation_1.UnionType(simpleArray, complexMap);
 var mixedValue = new validation_1.UnionType(new validation_1.JsonPrimitiveType(), simpleArray, complexMap);

package/schema/userSchema.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.userProfileSchema = void 0;
 var validation_1 = require("../validation");
+var attributeSchema_1 = require("./attributeSchema");
 exports.userProfileSchema = new validation_1.ObjectType({
     properties: {
         firstName: new validation_1.StringType({
@@ -93,10 +94,7 @@ exports.userProfileSchema = new validation_1.ObjectType({
             }),
         }),
         custom: new validation_1.ObjectType({
-            propertyNames: new validation_1.StringType({
-                maxLength: 50,
-                format: 'identifier',
-            }),
+            propertyNames: attributeSchema_1.attributeNameSchema,
             maxProperties: 10,
             additionalProperties: new validation_1.UnionType(new validation_1.BooleanType(), new validation_1.NullType(), new validation_1.NumberType(), new validation_1.StringType({
                 maxLength: 100,
@@ -110,20 +108,14 @@ exports.userProfileSchema = new validation_1.ObjectType({
                         maxLength: 100,
                     })),
                 }), new validation_1.ObjectType({
-                    propertyNames: new validation_1.StringType({
-                        maxLength: 50,
-                        format: 'identifier',
-                    }),
+                    propertyNames: attributeSchema_1.attributeNameSchema,
                     maxProperties: 10,
                     additionalProperties: new validation_1.UnionType(new validation_1.BooleanType(), new validation_1.NullType(), new validation_1.NumberType(), new validation_1.StringType({
                         maxLength: 100,
                     })),
                 })),
             }), new validation_1.ObjectType({
-                propertyNames: new validation_1.StringType({
-                    maxLength: 50,
-                    format: 'identifier',
-                }),
+                propertyNames: attributeSchema_1.attributeNameSchema,
                 maxProperties: 10,
                 additionalProperties: new validation_1.UnionType(new validation_1.BooleanType(), new validation_1.NullType(), new validation_1.NumberType(), new validation_1.StringType({
                     maxLength: 100,
@@ -133,10 +125,7 @@ exports.userProfileSchema = new validation_1.ObjectType({
                         maxLength: 100,
                     })),
                 }), new validation_1.ObjectType({
-                    propertyNames: new validation_1.StringType({
-                        maxLength: 50,
-                        format: 'identifier',
-                    }),
+                    propertyNames: attributeSchema_1.attributeNameSchema,
                     maxProperties: 10,
                     additionalProperties: new validation_1.UnionType(new validation_1.BooleanType(), new validation_1.NullType(), new validation_1.NumberType(), new validation_1.StringType({
                         maxLength: 100,

package/trackingEvents.d.ts

@@ -71,8 +71,8 @@ export declare const cartEventTypes: readonly ["cartModified", "cartViewed", "ch
 export declare const ecommerceEventTypes: readonly ["cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed"];
 export declare const identifiedUserEventTypes: string[];
 export declare const userEventTypes: readonly [...string[], "userProfileChanged"];
-export declare const miscEventTypes: readonly ["nothingChanged", "sessionAttributesChanged", "testGroupAssigned", "goalCompleted", "eventOccurred"];
-export declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "nothingChanged", "sessionAttributesChanged", "testGroupAssigned", "goalCompleted", "eventOccurred"];
+export declare const miscEventTypes: readonly ["nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred"];
+export declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred"];
 interface BaseEvent {
     type: string;
 }
@@ -200,17 +200,30 @@ export interface SessionAttributesChanged extends BaseEvent {
     type: 'sessionAttributesChanged';
     patch: Patch;
 }
-export interface TestGroupAssigned extends BaseEvent {
-    type: 'testGroupAssigned';
-    testId: string;
-    groupId: string;
-}
 export interface GoalCompleted extends BaseEvent {
     type: 'goalCompleted';
     goalId: string;
     value?: number;
     currency?: string;
 }
+export interface InterestShown extends BaseEvent {
+    type: 'interestShown';
+    interests: string[];
+}
+export interface PostDetails {
+    postId: string;
+    url?: string;
+    title: string;
+    tags?: string[];
+    categories?: string[];
+    authors?: string[];
+    publishTime: number;
+    updateTime?: number;
+}
+export interface PostViewed extends BaseEvent {
+    type: 'postViewed';
+    post: PostDetails;
+}
 export interface EventOccurred extends BaseEvent {
     type: 'eventOccurred';
     name: string;
@@ -222,7 +235,7 @@ export interface EventOccurred extends BaseEvent {
         [key: string]: string | number | boolean | null;
     };
 }
-export declare type MiscEvent = NothingChanged | SessionAttributesChanged | TestGroupAssigned | EventOccurred | GoalCompleted;
+export declare type MiscEvent = NothingChanged | SessionAttributesChanged | EventOccurred | GoalCompleted | InterestShown | PostViewed;
 declare type EventMap = {
     tabVisibilityChanged: TabVisibilityChanged;
     tabUrlChanged: TabUrlChanged;
@@ -240,8 +253,9 @@ declare type EventMap = {
     orderPlaced: OrderPlaced;
     nothingChanged: NothingChanged;
     sessionAttributesChanged: SessionAttributesChanged;
-    testGroupAssigned: TestGroupAssigned;
     goalCompleted: GoalCompleted;
+    interestShown: InterestShown;
+    postViewed: PostViewed;
     eventOccurred: EventOccurred;
 };
 export declare type TrackingEventType = keyof EventMap;
@@ -261,8 +275,9 @@ declare type ExternalEventMap = {
     orderPlaced: OrderPlaced;
     productViewed: ProductViewed;
     userSignedUp: UserSignedUp;
-    testGroupAssigned: TestGroupAssigned;
     goalCompleted: GoalCompleted;
+    interestShown: InterestShown;
+    postViewed: PostViewed;
     eventOccurred: EventOccurred;
 };
 export declare type ExternalTrackingEventType = keyof ExternalEventMap;

package/trackingEvents.js

@@ -34,8 +34,9 @@ exports.userEventTypes = tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1
 exports.miscEventTypes = [
     'nothingChanged',
     'sessionAttributesChanged',
-    'testGroupAssigned',
     'goalCompleted',
+    'interestShown',
+    'postViewed',
     'eventOccurred',
 ];
 exports.eventTypes = tslib_1.__spreadArray(tslib_1.__spreadArray(tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1.__read(exports.pageEventTypes)), tslib_1.__read(exports.ecommerceEventTypes)), tslib_1.__read(exports.userEventTypes)), tslib_1.__read(exports.miscEventTypes));

package/validation/jsonType.d.ts

@@ -1,6 +1,7 @@
 import { Schema, TypeSchema } from './schema';
 declare type JsonObjectDefinition = {
     properties?: Schema;
+    propertyNames?: Schema;
 };
 export declare class JsonObjectType implements TypeSchema {
     private readonly definition;

package/validation/jsonType.js

@@ -37,13 +37,19 @@ var JsonObjectType = /** @class */ (function () {
         if (!isJsonObject(value)) {
             throw new schema_1.Violation("Expected a JSON object at path '" + violation_1.formatPath(path) + "', actual " + violation_1.describe(value) + ".", path, { type: 'object' });
         }
-        if (this.definition.properties === undefined) {
+        if (this.definition.properties === undefined && this.definition.propertyNames === undefined) {
             return;
         }
         try {
             for (var _b = tslib_1.__values(Object.entries(value)), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var _d = tslib_1.__read(_c.value, 2), entryName = _d[0], entryValue = _d[1];
-                this.definition.properties.validate(entryValue, path.concat([entryName]));
+                var propertyPath = path.concat([entryName]);
+                if (this.definition.propertyNames !== undefined) {
+                    this.definition.propertyNames.validate(entryName, propertyPath);
+                }
+                if (this.definition.properties !== undefined) {
+                    this.definition.properties.validate(entryValue, path.concat([entryName]));
+                }
             }
         }
         catch (e_1_1) { e_1 = { error: e_1_1 }; }