@engage_so/core 2.0.0 → 2.0.2

package/dist/error.d.ts

@@ -0,0 +1,4 @@
+export declare class EngageError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,qBAAa,WAAY,SAAQ,KAAK;gBACvB,OAAO,EAAE,MAAM;CAI7B"}

package/dist/error.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EngageError = void 0;
+class EngageError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'EngageError';
+    }
+}
+exports.EngageError = EngageError;

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+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 Methods = 'POST' | 'PUT' | 'DELETE';
+export declare function request(url: string, params: Record<string, any> | null, method: Methods): 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 {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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,gBAyB1E;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"}

package/dist/index.js

@@ -0,0 +1,257 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToAccount = exports.convertToCustomer = exports.changeAccountRole = exports.removeFromAccount = exports.addToAccount = exports.merge = exports.track = exports.addAttribute = exports.identify = exports.init = exports.request = void 0;
+const buffer_1 = require("buffer");
+const cross_fetch_1 = __importDefault(require("cross-fetch"));
+const error_1 = require("./error");
+if (typeof btoa === 'undefined') {
+    global.btoa = function (str) {
+        return buffer_1.Buffer.from(str).toString('base64');
+    };
+}
+// type UserIdentifyParams = {
+//   id: string
+//   [key: string]: string | number | Date | boolean
+// }
+// type UserAttrParams = Omit<UserIdentifyParams, 'id'>
+const rootURL = 'https://api.engage.so/v1';
+let auth = '';
+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/';
+function _request(url, params, method) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const o = {
+                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 = yield (0, cross_fetch_1.default)(`${apiRoot}${url}`, o);
+            const body = yield 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
+function request(url, params, method) {
+    return _request(url, params, method);
+}
+exports.request = request;
+function init(key) {
+    if (!key) {
+        throw new error_1.EngageError('You need to pass in your API key(s).');
+    }
+    const options = {
+        key: undefined,
+        secret: ''
+    };
+    if (typeof key === 'string') {
+        options.key = key;
+    }
+    else {
+        if (!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}`;
+        }
+    }
+    // Set auth
+    // auth = Buffer.from(`${options.key}:${options.secret}`).toString('base64')
+    auth = btoa(`${options.key}:${options.secret}`);
+}
+exports.init = init;
+// Data tracking
+function identify(user) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!user) {
+            throw new error_1.EngageError('You need to pass an object with at least an id.');
+        }
+        if (!user.id) {
+            throw new error_1.EngageError('ID missing.');
+        }
+        if (user.email && (typeof user.email !== 'string' || !/^\S+@\S+$/.test(user.email))) {
+            throw new error_1.EngageError('Email invalid.');
+        }
+        const params = {};
+        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');
+    });
+}
+exports.identify = identify;
+function addAttribute(uid, attributes) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!uid) {
+            throw new error_1.EngageError('User ID missing.');
+        }
+        if (!attributes) {
+            throw new error_1.EngageError('Attributes missing.');
+        }
+        if (!Object.keys(attributes).length) {
+            throw new error_1.EngageError('Attributes missing.');
+        }
+        const params = {};
+        params.meta = {};
+        for (const k in attributes) {
+            if (notMeta.includes(k)) {
+                params[k] = attributes[k];
+            }
+            else {
+                params.meta[k] = attributes[k];
+                Object.assign(params.meta, k, attributes[k]);
+            }
+        }
+        if (Object.keys(params.meta).length) {
+            delete params.meta;
+        }
+        return _request(`users/${uid}`, params, 'PUT');
+    });
+}
+exports.addAttribute = addAttribute;
+function track(uid, data) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!uid) {
+            throw new error_1.EngageError('User ID missing.');
+        }
+        if (!data) {
+            throw new error_1.EngageError('Event data missing.');
+        }
+        if (typeof data === 'string') {
+            data = {
+                event: data,
+                value: true
+            };
+        }
+        else {
+            if (!Object.keys(data).length) {
+                throw new error_1.EngageError('Attributes missing.');
+            }
+        }
+        return _request(`users/${uid}/events`, data, 'POST');
+    });
+}
+exports.track = track;
+function merge(sourceUid, destinationUid) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!sourceUid) {
+            throw new error_1.EngageError('Source ID missing.');
+        }
+        if (!destinationUid) {
+            throw new error_1.EngageError('Destination ID missing.');
+        }
+        return _request(`users/merge`, {
+            source: sourceUid,
+            destination: destinationUid
+        }, 'POST');
+    });
+}
+exports.merge = merge;
+// Account functions
+function addToAccount(uid, accountId, role) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!uid) {
+            throw new error_1.EngageError('User ID missing.');
+        }
+        if (!accountId) {
+            throw new error_1.EngageError('Account ID missing.');
+        }
+        if (role && typeof role !== 'string') {
+            throw new error_1.EngageError('Role should be a text.');
+        }
+        const g = {
+            id: accountId
+        };
+        if (role) {
+            g.role = role;
+        }
+        return _request(`users/${uid}/accounts`, { accounts: [g] }, 'POST');
+    });
+}
+exports.addToAccount = addToAccount;
+function removeFromAccount(uid, accountId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!uid) {
+            throw new error_1.EngageError('User ID missing.');
+        }
+        if (!accountId) {
+            throw new error_1.EngageError('Account ID missing.');
+        }
+        return _request(`users/${uid}/accounts/${accountId}`, null, 'DELETE');
+    });
+}
+exports.removeFromAccount = removeFromAccount;
+function changeAccountRole(uid, accountId, role) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!uid) {
+            throw new error_1.EngageError('User ID missing.');
+        }
+        if (!accountId) {
+            throw new error_1.EngageError('Account ID missing.');
+        }
+        if (!role) {
+            throw new error_1.EngageError('New role missing.');
+        }
+        return _request(`users/${uid}/accounts/${accountId}`, { role }, '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');
+    });
+}
+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');
+    });
+}
+exports.convertToAccount = convertToAccount;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@engage_so/core",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Engage JS core.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -25,5 +25,5 @@
   "dependencies": {
     "cross-fetch": "^4.0.0"
   },
-  "gitHead": "ecc6ef9a3277da36b56fb4169dbfafbdde9b926b"
+  "gitHead": "b3efe1705878e55156fe82fd8b9c1a3c52f4ed04"
 }