@engage_so/core 2.1.1 → 2.2.1

package/README.md

@@ -0,0 +1,14 @@
+# Engage JavaScript SDK
+
+Engage is all you need to deliver personalized customer messaging and marketing automation through email, SMS and in-app messaging. The JavaScript SDK allows you to automatically capture user attributes and actions on your site or application.
+
+[Learn more about the JavaScript SDK](https://docs.engage.so/en-us/a/62bbdd2f5bfea4dca4834046-javascript)
+
+## Getting Started
+
+- [Create an Engage account](https://engage.so/) and setup an account to get your API key
+- Follow the [integration guide](https://docs.engage.so/en-us/a/62bbdd2f5bfea4dca4834046-javascript)
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-interface Key {
+export interface Key {
     key?: string;
     secret?: string;
 }
-interface EventParameter {
+export interface EventParameter {
     event: string;
     value?: string | number | Date | boolean;
     properties?: {
@@ -10,23 +10,41 @@ interface EventParameter {
     };
     timestamp?: string | number | Date;
 }
-type UserAttrParams = {
+export interface UserAttrParams {
     [key: string]: string | number | Date | boolean;
-};
-type UserIdentifyParams = UserAttrParams & {
+}
+export type UserIdentifyParams = UserAttrParams & {
     id: string;
 };
-type Methods = 'POST' | 'PUT' | 'DELETE';
-export declare function request(url: string, params: Record<string, any> | null, method: Methods): object;
+type Methods = 'POST' | 'PUT' | 'DELETE' | 'GET';
+export declare function request(url: string, params: Record<string, any> | null | undefined, method?: Methods): Promise<object>;
 export declare function init(key: Key | string): void;
-export declare function identify(user: UserIdentifyParams): Promise<any>;
-export declare function addAttribute(uid: string, attributes: UserAttrParams): Promise<any>;
-export declare function track(uid: string, data: EventParameter): Promise<any>;
-export declare function merge(sourceUid: string, destinationUid: string): Promise<any>;
-export declare function addToAccount(uid: string, accountId: string, role: string): Promise<any>;
-export declare function removeFromAccount(uid: string, accountId: string): Promise<any>;
-export declare function changeAccountRole(uid: string, accountId: string, role: string): Promise<any>;
-export declare function convertToCustomer(uid: string): Promise<any>;
-export declare function convertToAccount(uid: string): Promise<any>;
-export {};
+export declare function identify(user: UserIdentifyParams): Promise<object>;
+export declare function addAttribute(attributes: UserAttrParams): Promise<object>;
+export declare function addAttribute(uid: string, attributes: UserAttrParams): Promise<object>;
+export declare function track(data: EventParameter): Promise<object>;
+export declare function track(uid: string, data: EventParameter): Promise<object>;
+export declare function merge(destinationUid: string): Promise<object>;
+export declare function merge(sourceUid: string, destinationUid: string): Promise<object>;
+export declare function addToAccount(uid: string, accountId: string, role?: string): Promise<object>;
+export declare function removeFromAccount(accountId: string): Promise<object>;
+export declare function removeFromAccount(uid: string, accountId: string): Promise<object>;
+export declare function changeAccountRole(accountId: string, role: string): Promise<object>;
+export declare function changeAccountRole(uid: string, accountId: string, role: string): Promise<object>;
+export declare function convertToCustomer(): Promise<object>;
+export declare function convertToAccount(): Promise<object>;
+declare const EngageSDK: {
+    init: typeof init;
+    identify: typeof identify;
+    addAttribute: typeof addAttribute;
+    track: typeof track;
+    merge: typeof merge;
+    addToAccount: typeof addToAccount;
+    removeFromAccount: typeof removeFromAccount;
+    changeAccountRole: typeof changeAccountRole;
+    convertToCustomer: typeof convertToCustomer;
+    convertToAccount: typeof convertToAccount;
+    request: typeof request;
+};
+export default EngageSDK;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,UAAU,GAAG;IACX,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AACD,UAAU,cAAc;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAA;IACxC,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAA;KAChD,CAAA;IACD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;CACnC;AACD,KAAK,cAAc,GAAG;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAA;CAChD,CAAA;AACD,KAAK,kBAAkB,GAAG,cAAc,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAQzD,KAAK,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAA;AA2CxC,wBAAgB,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAEjG;AAED,wBAAgB,IAAI,CAAE,GAAG,EAAE,GAAG,GAAG,MAAM,QAwBtC;AAGD,wBAAsB,QAAQ,CAAE,IAAI,EAAE,kBAAkB,gBAqBvD;AACD,wBAAsB,YAAY,CAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,gBAwB1E;AACD,wBAAsB,KAAK,CAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,gBAmB7D;AAED,wBAAsB,KAAK,CAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,gBAYrE;AAGD,wBAAsB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,gBAiB9E;AACD,wBAAsB,iBAAiB,CAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,gBAQtE;AACD,wBAAsB,iBAAiB,CAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,gBAWpF;AACD,wBAAsB,iBAAiB,CAAE,GAAG,EAAE,MAAM,gBAKnD;AACD,wBAAsB,gBAAgB,CAAE,GAAG,EAAE,MAAM,gBAKlD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,MAAM,WAAW,GAAG;IAClB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AACD,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAA;IACxC,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAA;KAChD,CAAA;IACD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;CACnC;AACD,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAA;CAChD;AACD,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAQhE,KAAK,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,KAAK,CAAA;AA6DhD,wBAAsB,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAEpI;AAED,wBAAgB,IAAI,CAAE,GAAG,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI,CA4B7C;AAGD,wBAAsB,QAAQ,CAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAwBzE;AAGD,wBAAsB,YAAY,CAAE,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AAChF,wBAAsB,YAAY,CAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AAwC7F,wBAAsB,KAAK,CAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AACnE,wBAAsB,KAAK,CAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AAmChF,wBAAsB,KAAK,CAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AACrE,wBAAsB,KAAK,CAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AA2BxF,wBAAsB,YAAY,CAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAiBlG;AAGD,wBAAsB,iBAAiB,CAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AAC5E,wBAAsB,iBAAiB,CAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AAuBzF,wBAAsB,iBAAiB,CAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AAC1F,wBAAsB,iBAAiB,CAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AA6BvG,wBAAsB,iBAAiB,IAAK,OAAO,CAAC,MAAM,CAAC,CAAA;AAO3D,wBAAsB,gBAAgB,IAAK,OAAO,CAAC,MAAM,CAAC,CAAA;AAO1D,QAAA,MAAM,SAAS;;;;;;;;;;;;CAYd,CAAA;AAGD,eAAe,SAAS,CAAA"}

package/dist/index.js

@@ -28,8 +28,24 @@ if (typeof btoa === 'undefined') {
 // type UserAttrParams = Omit<UserIdentifyParams, 'id'>
 // const rootURL = 'https://api.engage.so/v1'
 let auth = '';
+let currentUserId = '';
 const notMeta = ['created_at', 'is_account', 'number', 'device_token', 'device_platform', 'email', 'first_name', 'last_name', 'tz', 'app_version', 'app_build', 'app_last_active'];
 const apiRoot = 'https://api.engage.so/v1';
+function isNull(v) {
+    return (v === null || v === undefined);
+}
+function isNullString(v) {
+    return (v === null || v === undefined || v === '');
+}
+function resolveUserId(uid) {
+    if (!isNullString(uid)) {
+        return uid;
+    }
+    if (isNullString(currentUserId)) {
+        throw new error_1.EngageError('User ID missing. Call identify() first or provide a uid parameter.');
+    }
+    return currentUserId;
+}
 function _request(url, params, method) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -38,11 +54,11 @@ function _request(url, params, method) {
                 headers: {
                     'Content-Type': 'application/json;charset=utf-8',
                     Authorization: `Basic ${auth}`
-                },
+                }
                 // throwHttpErrors: false,
                 // prefixUrl: rootURL
             };
-            if (params) {
+            if (!isNull(params)) {
                 o.body = JSON.stringify(params);
             }
             // const response = await ky(url, o)
@@ -50,7 +66,7 @@ function _request(url, params, method) {
             const body = yield response.json();
             let error = 'API connection error';
             if (!response.ok) {
-                if (body && body.error) {
+                if (typeof (body === null || body === void 0 ? void 0 : body.error) === 'string') {
                     error = body.error;
                 }
                 return { error };
@@ -64,47 +80,52 @@ function _request(url, params, method) {
 }
 // Alias of _request method
 // Same with _request for now but can later have modifications
-function request(url, params, method) {
-    return _request(url, params, method);
+function request(url, params, method = 'GET') {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yield _request(url, params, method);
+    });
 }
 exports.request = request;
 function init(key) {
-    if (!key) {
+    var _a, _b;
+    if (isNull(key)) {
         throw new error_1.EngageError('You need to pass in your API key(s).');
     }
+    // Clear any stored user ID when reinitializing
+    currentUserId = '';
     const options = {
-        key: undefined,
+        key: '',
         secret: ''
     };
     if (typeof key === 'string') {
+        if (key === '') {
+            throw new error_1.EngageError('`key` is empty.');
+        }
         options.key = key;
     }
     else {
-        if (!key.key) {
+        if (isNullString(key.key)) {
             throw new error_1.EngageError('`key` missing in object.');
         }
-        if (key.key) {
-            options.key = `${key.key}`;
-        }
-        if (key.secret) {
-            options.secret = `${key.secret}`;
+        options.key = key.key;
+        if (!isNullString(key.secret)) {
+            options.secret = key.secret;
         }
     }
     // Set auth
-    // auth = Buffer.from(`${options.key}:${options.secret}`).toString('base64')
-    auth = btoa(`${options.key}:${options.secret}`);
+    auth = btoa(`${(_a = options.key) !== null && _a !== void 0 ? _a : ''}:${(_b = options.secret) !== null && _b !== void 0 ? _b : ''}`);
 }
 exports.init = init;
 // Data tracking
 function identify(user) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!user) {
+        if (isNull(user)) {
             throw new error_1.EngageError('You need to pass an object with at least an id.');
         }
-        if (!user.id) {
+        if (isNullString(user.id)) {
             throw new error_1.EngageError('ID missing.');
         }
-        if (user.email && (typeof user.email !== 'string' || !/^\S+@\S+$/.test(user.email))) {
+        if (!isNull(user.email) && (typeof user.email !== 'string' || !/^\S+@\S+$/.test(user.email))) {
             throw new error_1.EngageError('Email invalid.');
         }
         const params = {};
@@ -117,72 +138,106 @@ function identify(user) {
                 params.meta[k] = user[k];
             }
         }
-        return _request(`/users/${user.id}`, params, 'PUT');
+        // Store the user ID for use in other functions
+        currentUserId = user.id;
+        return yield _request(`/users/${user.id}`, params, 'PUT');
     });
 }
 exports.identify = identify;
-function addAttribute(uid, attributes) {
+function addAttribute(uidOrAttributes, attributes) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!uid) {
-            throw new error_1.EngageError('User ID missing.');
+        let uid;
+        let attrs;
+        // Handle overloaded parameters
+        if (typeof uidOrAttributes === 'string') {
+            uid = resolveUserId(uidOrAttributes);
+            if (isNull(attributes)) {
+                throw new error_1.EngageError('Attributes missing when uid is provided.');
+            }
+            attrs = attributes;
         }
-        if (!attributes) {
+        else {
+            uid = resolveUserId();
+            attrs = uidOrAttributes;
+        }
+        if (isNull(attrs)) {
             throw new error_1.EngageError('Attributes missing.');
         }
-        if (!Object.keys(attributes).length) {
+        if (Object.keys(attrs).length === 0) {
             throw new error_1.EngageError('Attributes missing.');
         }
         const params = {};
         params.meta = {};
-        for (const k in attributes) {
+        for (const k in attrs) {
             if (notMeta.includes(k)) {
-                params[k] = attributes[k];
+                params[k] = attrs[k];
             }
             else {
-                params.meta[k] = attributes[k];
+                params.meta[k] = attrs[k];
             }
         }
-        if (!Object.keys(params.meta).length) {
+        if (Object.keys(params.meta).length === 0) {
             delete params.meta;
         }
-        return _request(`/users/${uid}`, params, 'PUT');
+        return yield _request(`/users/${uid}`, params, 'PUT');
     });
 }
 exports.addAttribute = addAttribute;
-function track(uid, data) {
+function track(uidOrData, data) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!uid) {
-            throw new error_1.EngageError('User ID missing.');
+        let uid;
+        let eventData;
+        // Handle overloaded parameters
+        if (typeof uidOrData === 'string') {
+            uid = resolveUserId(uidOrData);
+            if (isNull(data)) {
+                throw new error_1.EngageError('Event data missing when uid is provided.');
+            }
+            eventData = data;
         }
-        if (!data) {
+        else {
+            uid = resolveUserId();
+            eventData = uidOrData;
+        }
+        if (isNull(eventData)) {
             throw new error_1.EngageError('Event data missing.');
         }
-        if (typeof data === 'string') {
-            data = {
-                event: data,
+        if (typeof eventData === 'string') {
+            eventData = {
+                event: eventData,
                 value: true
             };
         }
         else {
-            if (!Object.keys(data).length) {
+            if (Object.keys(eventData).length === 0) {
                 throw new error_1.EngageError('Attributes missing.');
             }
         }
-        return _request(`/users/${uid}/events`, data, 'POST');
+        return yield _request(`/users/${uid}/events`, eventData, 'POST');
     });
 }
 exports.track = track;
-function merge(sourceUid, destinationUid) {
+function merge(sourceOrDestinationUid, destinationUid) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!sourceUid) {
-            throw new error_1.EngageError('Source ID missing.');
+        let sourceUid;
+        let destUid;
+        // Handle overloaded parameters
+        if (isNullString(destinationUid)) {
+            // Called with one parameter: merge(destinationUid)
+            sourceUid = resolveUserId();
+            destUid = sourceOrDestinationUid;
+        }
+        else {
+            // Called with two parameters: merge(sourceUid, destinationUid)
+            sourceUid = resolveUserId(sourceOrDestinationUid);
+            destUid = destinationUid;
         }
-        if (!destinationUid) {
+        if (isNullString(destUid)) {
             throw new error_1.EngageError('Destination ID missing.');
         }
-        return _request(`/users/merge`, {
+        return yield _request('/users/merge', {
             source: sourceUid,
-            destination: destinationUid
+            destination: destUid
         }, 'POST');
     });
 }
@@ -190,67 +245,102 @@ exports.merge = merge;
 // Account functions
 function addToAccount(uid, accountId, role) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!uid) {
+        if (isNullString(uid)) {
             throw new error_1.EngageError('User ID missing.');
         }
-        if (!accountId) {
+        if (isNullString(accountId)) {
             throw new error_1.EngageError('Account ID missing.');
         }
-        if (role && typeof role !== 'string') {
+        if (!isNull(role) && typeof role !== 'string') {
             throw new error_1.EngageError('Role should be a text.');
         }
         const g = {
             id: accountId
         };
-        if (role) {
+        if (!isNullString(role)) {
             g.role = role;
         }
-        return _request(`/users/${uid}/accounts`, { accounts: [g] }, 'POST');
+        return yield _request(`/users/${uid}/accounts`, { accounts: [g] }, 'POST');
     });
 }
 exports.addToAccount = addToAccount;
-function removeFromAccount(uid, accountId) {
+function removeFromAccount(uidOrAccountId, accountId) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!uid) {
-            throw new error_1.EngageError('User ID missing.');
+        let uid;
+        let acctId;
+        // Handle overloaded parameters
+        if (isNullString(accountId)) {
+            // Called with one parameter: removeFromAccount(accountId)
+            uid = resolveUserId();
+            acctId = uidOrAccountId;
+        }
+        else {
+            // Called with two parameters: removeFromAccount(uid, accountId)
+            uid = resolveUserId(uidOrAccountId);
+            acctId = accountId;
         }
-        if (!accountId) {
+        if (isNullString(acctId)) {
             throw new error_1.EngageError('Account ID missing.');
         }
-        return _request(`/users/${uid}/accounts/${accountId}`, null, 'DELETE');
+        return yield _request(`/users/${uid}/accounts/${acctId}`, null, 'DELETE');
     });
 }
 exports.removeFromAccount = removeFromAccount;
-function changeAccountRole(uid, accountId, role) {
+function changeAccountRole(uidOrAccountId, accountIdOrRole, role) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!uid) {
-            throw new error_1.EngageError('User ID missing.');
+        let uid;
+        let accountId;
+        let newRole;
+        // Handle overloaded parameters
+        if (isNullString(role)) {
+            // Called with two parameters: changeAccountRole(accountId, role)
+            uid = resolveUserId();
+            accountId = uidOrAccountId;
+            newRole = accountIdOrRole;
         }
-        if (!accountId) {
+        else {
+            // Called with three parameters: changeAccountRole(uid, accountId, role)
+            uid = resolveUserId(uidOrAccountId);
+            accountId = accountIdOrRole;
+            newRole = role;
+        }
+        if (isNullString(accountId)) {
             throw new error_1.EngageError('Account ID missing.');
         }
-        if (!role) {
+        if (isNullString(newRole)) {
             throw new error_1.EngageError('New role missing.');
         }
-        return _request(`/users/${uid}/accounts/${accountId}`, { role }, 'PUT');
+        return yield _request(`/users/${uid}/accounts/${accountId}`, { role: newRole }, 'PUT');
     });
 }
 exports.changeAccountRole = changeAccountRole;
 function convertToCustomer(uid) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!uid) {
-            throw new error_1.EngageError('User ID missing.');
-        }
-        return _request(`/users/${uid}/convert`, { type: 'customer' }, 'POST');
+        const userId = resolveUserId(uid);
+        return yield _request(`/users/${userId}/convert`, { type: 'customer' }, 'POST');
     });
 }
 exports.convertToCustomer = convertToCustomer;
 function convertToAccount(uid) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!uid) {
-            throw new error_1.EngageError('User ID missing.');
-        }
-        return _request(`/users/${uid}/convert`, { type: 'account' }, 'POST');
+        const userId = resolveUserId(uid);
+        return yield _request(`/users/${userId}/convert`, { type: 'account' }, 'POST');
     });
 }
 exports.convertToAccount = convertToAccount;
+// Create an object containing all exports for easy access
+const EngageSDK = {
+    init,
+    identify,
+    addAttribute,
+    track,
+    merge,
+    addToAccount,
+    removeFromAccount,
+    changeAccountRole,
+    convertToCustomer,
+    convertToAccount,
+    request
+};
+// Export as default for import EngageSDK syntax
+exports.default = EngageSDK;

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@engage_so/core",
-  "version": "2.1.1",
-  "description": "Engage JS core.",
+  "version": "2.2.1",
+  "description": "Engage JavaScript SDK (core)",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist/",
+    "README.md"
+  ],
   "scripts": {
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
-    "build": "tsc -p tsconfig.json",
-    "prepublishOnly": "npm run build"
-  },
-  "publishConfig": {
-    "access": "public"
+    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "prepare": "npm run build"
   },
   "author": "Engage",
   "license": "MIT",
@@ -23,8 +24,6 @@
     "ts-standard": "^12.0.2"
   },
   "dependencies": {
-    "buffer": "^6.0.3",
     "cross-fetch": "^4.0.0"
-  },
-  "gitHead": "6900dcf5defb812e5182bca56762860c838f5266"
+  }
 }

package/.eslintignore

@@ -1,3 +0,0 @@
-dist
-node_modules
-tests

package/jest.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  transform: {
-    '^.+\\.ts?$': ['ts-jest', { diagnostics: false }]
-  },
-  testRegex: '/tests/.*\\.(test|spec)?\\.(ts|tsx)$',
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node']
-};

package/src/error.ts

@@ -1,6 +0,0 @@
-export class EngageError extends Error {
-  constructor (message: string) {
-    super(message)
-    this.name = 'EngageError'
-  }
-}

package/src/index.ts

@@ -1,241 +0,0 @@
-import { Buffer } from 'buffer'
-import fetch from 'cross-fetch'
-import { EngageError } from './error'
-
-if (typeof btoa === 'undefined') {
-  global.btoa = function (str) {
-    return Buffer.from(str).toString('base64')
-  }
-}
-
-interface Key {
-  key?: string
-  secret?: string
-}
-interface EventParameter {
-  event: string
-  value?: string | number | Date | boolean
-  properties?: {
-    [key: string]: string | number | Date | boolean
-  }
-  timestamp?: string | number | Date
-}
-type UserAttrParams = {
-  [key: string]: string | number | Date | boolean
-}
-type UserIdentifyParams = UserAttrParams & { id: string }
-type DataParameters = {
-  [key: string]: string | number | Date | boolean
-} & {
-  meta?: {
-    [key: string]: string | number | Date | boolean
-  }
-}
-type Methods = 'POST' | 'PUT' | 'DELETE'
-// type UserIdentifyParams = {
-//   id: string
-//   [key: string]: string | number | Date | boolean
-// }
-// type UserAttrParams = Omit<UserIdentifyParams, 'id'>
-
-// const rootURL = 'https://api.engage.so/v1'
-let auth: string = ''
-const notMeta = ['created_at', 'is_account', 'number', 'device_token', 'device_platform', 'email', 'first_name', 'last_name', 'tz', 'app_version', 'app_build', 'app_last_active']
-const apiRoot = 'https://api.engage.so/v1'
-
-async function _request (url: string, params: Record<string, any> | null, method: Methods) {
-  try {
-    const o: any = {
-      method,
-      headers: {
-        'Content-Type': 'application/json;charset=utf-8',
-        Authorization: `Basic ${auth}`
-      },
-      // throwHttpErrors: false,
-      // prefixUrl: rootURL
-    }
-    if (params) {
-      o.body = JSON.stringify(params)
-    }
-    // const response = await ky(url, o)
-    const response = await fetch(`${apiRoot}${url}`, o)
-    const body: any = await response.json()
-    let error = 'API connection error'
-    if (!response.ok) {
-      if (body && body.error) {
-        error = body.error
-      }
-      return { error }
-    }
-    return body
-  } catch (e) {
-    return { error: 'API connection error' }
-  }
-}
-// Alias of _request method
-// Same with _request for now but can later have modifications
-export function request (url: string, params: Record<string, any> | null, method: Methods): object {
-  return _request(url, params, method)
-}
-
-export function init (key: Key | string) {
-  if (!key) {
-    throw new EngageError('You need to pass in your API key(s).')
-  }
-  const options: Key = {
-    key: undefined,
-    secret: ''
-  }
-  if (typeof key === 'string') {
-    options.key = key
-  } else {
-    if (!key.key) {
-      throw new EngageError('`key` missing in object.')
-    }
-    if (key.key) {
-      options.key = `${key.key}`
-    }
-    if (key.secret) {
-      options.secret = `${key.secret}`
-    }
-  }
-  // Set auth
-  // auth = Buffer.from(`${options.key}:${options.secret}`).toString('base64')
-  auth = btoa(`${options.key}:${options.secret}`)
-}
-
-// Data tracking
-export async function identify (user: UserIdentifyParams) {
-  if (!user) {
-    throw new EngageError('You need to pass an object with at least an id.')
-  }
-  if (!user.id) {
-    throw new EngageError('ID missing.')
-  }
-  if (user.email && (typeof user.email !== 'string' || !/^\S+@\S+$/.test(user.email))) {
-    throw new EngageError('Email invalid.')
-  }
-  const params: DataParameters = {}
-  params.meta = {}
-  for (const k in user) {
-    if (k === 'id' || notMeta.includes(k)) {
-      params[k] = user[k]
-    } else {
-      params.meta[k] = user[k]
-    }
-  }
-
-  return _request(`/users/${user.id}`, params, 'PUT')
-}
-export async function addAttribute (uid: string, attributes: UserAttrParams) {
-  if (!uid) {
-    throw new EngageError('User ID missing.')
-  }
-  if (!attributes) {
-    throw new EngageError('Attributes missing.')
-  }
-  if (!Object.keys(attributes).length) {
-    throw new EngageError('Attributes missing.')
-  }
-  const params: DataParameters = {}
-  params.meta = {}
-  for (const k in attributes) {
-    if (notMeta.includes(k)) {
-      params[k] = attributes[k]
-    } else {
-      params.meta[k] = attributes[k]
-    }
-  }
-  if (!Object.keys(params.meta).length) {
-    delete params.meta
-  }
-
-  return _request(`/users/${uid}`, params, 'PUT')
-}
-export async function track (uid: string, data: EventParameter) {
-  if (!uid) {
-    throw new EngageError('User ID missing.')
-  }
-  if (!data) {
-    throw new EngageError('Event data missing.')
-  }
-  if (typeof data === 'string') {
-    data = {
-      event: data,
-      value: true
-    }
-  } else {
-    if (!Object.keys(data).length) {
-      throw new EngageError('Attributes missing.')
-    }
-  }
-
-  return _request(`/users/${uid}/events`, data, 'POST')
-}
-
-export async function merge (sourceUid: string, destinationUid: string) {
-  if (!sourceUid) {
-    throw new EngageError('Source ID missing.')
-  }
-  if (!destinationUid) {
-    throw new EngageError('Destination ID missing.')
-  }
-
-  return _request(`/users/merge`, {
-    source: sourceUid,
-    destination: destinationUid
-  }, 'POST')
-}
-
-// Account functions
-export async function addToAccount(uid: string, accountId: string, role: string) {
-  if (!uid) {
-    throw new EngageError('User ID missing.')
-  }
-  if (!accountId) {
-    throw new EngageError('Account ID missing.')
-  }
-  if (role && typeof role !== 'string') {
-    throw new EngageError('Role should be a text.')
-  }
-  const g: Record<string, string> = {
-    id: accountId
-  }
-  if (role) {
-    g.role = role
-  }
-  return _request(`/users/${uid}/accounts`, { accounts: [g] }, 'POST')
-}
-export async function removeFromAccount (uid: string, accountId: string){
-  if (!uid) {
-    throw new EngageError('User ID missing.')
-  }
-  if (!accountId) {
-    throw new EngageError('Account ID missing.')
-  }
-  return _request(`/users/${uid}/accounts/${accountId}`, null, 'DELETE')
-}
-export async function changeAccountRole (uid: string, accountId: string, role: string) {
-  if (!uid) {
-    throw new EngageError('User ID missing.')
-  }
-  if (!accountId) {
-    throw new EngageError('Account ID missing.')
-  }
-  if (!role) {
-    throw new EngageError('New role missing.')
-  }
-  return _request(`/users/${uid}/accounts/${accountId}`, { role }, 'PUT')
-}
-export async function convertToCustomer (uid: string) {
-  if (!uid) {
-    throw new EngageError('User ID missing.')
-  }
-  return _request(`/users/${uid}/convert`, { type: 'customer' }, 'POST')
-}
-export async function convertToAccount (uid: string) {
-  if (!uid) {
-    throw new EngageError('User ID missing.')
-  }
-  return _request(`/users/${uid}/convert`, { type: 'account' }, 'POST')
-}

package/tests/index.test.ts

@@ -1,231 +0,0 @@
-import * as Engage from '../src/index'
-const id = 'uzl38704@omeie.com'
-const sid = 'a6236e83-f7c1-4003-8e1a-951f6e1d5c60'
-const gid = '7d1a5e27-5a6b-4b38-a8bd-e59b8a1b2f41'
-
-describe('Init', () => {
-  test('should throw if no parameters sent', () => {
-    expect(() => {
-      Engage.init()
-    }).toThrow('API')
-  })
-  test('should throw if parameter is empty object', () => {
-    expect(() => {
-      Engage.init({})
-    }).toThrow('key')
-  })
-  test('should throw if empty key sent', () => {
-    expect(() => {
-      Engage.init('')
-    }).toThrow()
-  })
-  test('should not throw if key/secret is sent', () => {
-    expect(() => {
-      Engage.init({
-        key: process.env.KEY,
-        secret: process.env.SECRET
-      })
-    }).not.toThrow()
-  })
-})
-
-describe('Identify', () => {
-  test('should throw if no parameter passed', async () => {
-    await expect(Engage.identify()).rejects.toThrow('object')
-  })
-  test('should throw if empty string passed', async () => {
-    await expect(Engage.identify('')).rejects.toThrow('id')
-  })
-  test('should throw if empty object passed', async () => {
-    await expect(Engage.identify({})).rejects.toThrow(/id/i)
-  })
-  test('should not throw if no email passed', async () => {
-    await expect(() => {
-      Engage.identify({ id: gid })
-    }).not.toThrow()
-  })
-  test('should throw if invalid email passed', async () => {
-    await expect(Engage.identify({
-      id,
-      email: 'invalid'
-    })).rejects.toThrow(/email/i)
-  })
-  test('should work if id and email passed', async () => {
-    await expect(Engage.identify({
-      id,
-      email: 'fickledreams@yahoo.com'
-    })).resolves.toMatchObject({
-      uid: id,
-      email: 'fickledreams@yahoo.com'
-    })
-  })
-  test('should turn to account if has is_account', async () => {
-    await expect(Engage.identify({
-      id,
-      is_account: true
-    })).resolves.toMatchObject({
-      is_account: true
-    })
-  })
-  test('should turn to user if is_account is false', async () => {
-    await expect(Engage.identify({
-      id,
-      is_account: false
-    })).resolves.toMatchObject({
-      is_account: false
-    })
-  })
-})
-
-describe('Add attribute', () => {
-  test('should throw if no parameter passed', async () => {
-    await expect(Engage.addAttribute()).rejects.toThrow('id')
-  })
-  test('should throw if no data attribute passed', async () => {
-    await expect(Engage.addAttribute(id)).rejects.toThrow(/attributes/i)
-  })
-  test('should throw if empty object passed', async () => {
-    await expect(Engage.addAttribute(id, {})).rejects.toThrow(/attributes/i)
-  })
-  test('should resolve if parameters passed', async () => {
-    await expect(Engage.addAttribute(sid, {
-      first_name: 'Opeyemi',
-      active: true,
-      created_at: '2020-08-11'
-    })).resolves.toMatchObject({
-      uid: sid,
-      first_name: 'Opeyemi'
-    })
-  })
-  test('should turn to account if has is_account', async () => {
-    await expect(Engage.addAttribute(id, {
-      is_account: true
-    })).resolves.toMatchObject({
-      is_account: true
-    })
-  })
-  test('should turn to user if is_account is not added', async () => {
-    await expect(Engage.addAttribute(id, {
-      is_account: false
-    })).resolves.toMatchObject({
-      is_account: false
-    })
-  })
-})
-
-describe('Track', () => {
-  test('should throw if no parameter passed', async () => {
-    await expect(Engage.track()).rejects.toThrow('ID')
-  })
-  test('should throw if no data attribute passed', async () => {
-    await expect(Engage.track(id)).rejects.toThrow(/data/i)
-  })
-  test('should throw if empty object passed', async () => {
-    await expect(Engage.track(id, {})).rejects.toThrow(/attributes/i)
-  })
-  test('should pass if string property passed', async () => {
-    await expect(Engage.track(id, 'loggedin')).resolves.toMatchObject({
-      status: 'ok'
-    })
-  })
-  test('should pass if right parameters passed', async () => {
-    await expect(Engage.track(id, {
-      event: 'played',
-      value: 'vid_133',
-      timestamp: '2020-05-30T09:30:10Z'
-    })).resolves.toMatchObject({
-      status: 'ok'
-    })
-  })
-  test('should resolve if other variant passed', async () => {
-    await expect(Engage.track(id, {
-      event: 'loggedin',
-      properties: {
-        ip: '127.0.0.1',
-        referral: 'localhost'
-      }
-    })).resolves.toMatchObject({
-      status: 'ok'
-    })
-  })
-})
-
-describe('Merge users', () => {
-  test('should throw if no source id', async () => {
-    await expect(Engage.merge()).rejects.toThrow(/id/i)
-  })
-  test('should throw if no destination id', async () => {
-    await expect(Engage.merge(id)).rejects.toThrow(/id/i)
-  })
-  test('should merge if all is well', async () => {
-    await expect(Engage.merge(sid, id)).resolves.toMatchObject({
-      status: 'queued'
-    })
-  })
-})
-
-describe('Convert to account', () => {
-  test('should convert to account', async () => {
-    await expect(Engage.convertToAccount(gid)).resolves.toMatchObject({
-      is_account: true
-    })
-  })
-})
-
-describe('Convert to customer', () => {
-  test('should convert to customer', async () => {
-    await expect(Engage.convertToCustomer(gid)).resolves.toMatchObject({
-      is_account: false
-    })
-  })
-})
-
-describe('Add to account', () => {
-  test('should throw if no account id added', async () => {
-    await expect(Engage.addToAccount(id)).rejects.toThrow(/id/i)
-  })
-  test('should throw if role and role not string', async () => {
-    await expect(Engage.addToAccount(id, gid, [ 'something' ])).rejects.toThrow(/Role/)
-  })
-  test('should pass if account id added', async () => {
-    await expect(Engage.addToAccount(id, gid)).resolves.toMatchObject({
-      accounts: [{
-        id: gid
-      }]
-    })
-  })
-})
-
-describe('Change account role', () => {
-  test('should throw if no parameters', async () => {
-    await expect(Engage.changeAccountRole()).rejects.toThrow(/missing/)
-  })
-  test('should throw if no account id', async () => {
-    await expect(Engage.changeAccountRole(id)).rejects.toThrow(/missing/)
-  })
-  test('should throw if no role', async () => {
-    await expect(Engage.changeAccountRole(id, gid)).rejects.toThrow(/missing/)
-  })
-  test('should pass if all parameters set', async () => {
-    await expect(Engage.changeAccountRole(id, gid, 'owner')).resolves.toMatchObject({
-      accounts: [{
-        id: gid,
-        role: 'owner'
-      }]
-    })
-  })
-})
-
-describe('Remove from account', () => {
-  test('should throw if no parameters', async () => {
-    await expect(Engage.removeFromAccount()).rejects.toThrow(/missing/)
-  })
-  test('should throw if no account id', async () => {
-    await expect(Engage.removeFromAccount(id)).rejects.toThrow(/missing/)
-  })
-  test('should pass if all parameters set', async () => {
-    await expect(Engage.removeFromAccount(id, gid)).resolves.toMatchObject({
-      accounts: []
-    })
-  })
-})

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2015",
-    "module": "NodeNext",
-    "declaration": true,
-    "declarationMap": true,
-    "outDir": "./dist",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true
-  },
-  "exclude": [
-    "node_modules",
-    "tests",
-    "dist"
-  ]
-}