@engage_so/core 2.2.0 → 2.2.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,50 @@
+export interface Key {
+    key?: string;
+    secret?: string;
+}
+export interface EventParameter {
+    event: string;
+    value?: string | number | Date | boolean;
+    properties?: {
+        [key: string]: string | number | Date | boolean;
+    };
+    timestamp?: string | number | Date;
+}
+export interface UserAttrParams {
+    [key: string]: string | number | Date | boolean;
+}
+export type UserIdentifyParams = UserAttrParams & {
+    id: string;
+};
+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<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

@@ -0,0 +1 @@
+{"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,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAErI;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

@@ -0,0 +1,346 @@
+"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 = '';
+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 {
+            const o = {
+                method,
+                headers: {
+                    'Content-Type': 'application/json;charset=utf-8',
+                    Authorization: `Basic ${auth}`
+                }
+                // throwHttpErrors: false,
+                // prefixUrl: rootURL
+            };
+            if (!isNull(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 (typeof (body === null || body === void 0 ? void 0 : body.error) === 'string') {
+                    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 = 'GET') {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yield _request(url, params, method);
+    });
+}
+exports.request = request;
+function init(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: '',
+        secret: ''
+    };
+    if (typeof key === 'string') {
+        if (key === '') {
+            throw new error_1.EngageError('`key` is empty.');
+        }
+        options.key = key;
+    }
+    else {
+        if (isNullString(key.key)) {
+            throw new error_1.EngageError('`key` missing in object.');
+        }
+        options.key = key.key;
+        if (!isNullString(key.secret)) {
+            options.secret = key.secret;
+        }
+    }
+    // Set auth
+    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 (isNull(user)) {
+            throw new error_1.EngageError('You need to pass an object with at least an id.');
+        }
+        if (isNullString(user.id)) {
+            throw new error_1.EngageError('ID missing.');
+        }
+        if (!isNull(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];
+            }
+        }
+        // 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(uidOrAttributes, attributes) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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;
+        }
+        else {
+            uid = resolveUserId();
+            attrs = uidOrAttributes;
+        }
+        if (isNull(attrs)) {
+            throw new error_1.EngageError('Attributes missing.');
+        }
+        if (Object.keys(attrs).length === 0) {
+            throw new error_1.EngageError('Attributes missing.');
+        }
+        const params = {};
+        params.meta = {};
+        for (const k in attrs) {
+            if (notMeta.includes(k)) {
+                params[k] = attrs[k];
+            }
+            else {
+                params.meta[k] = attrs[k];
+            }
+        }
+        if (Object.keys(params.meta).length === 0) {
+            delete params.meta;
+        }
+        return yield _request(`/users/${uid}`, params, 'PUT');
+    });
+}
+exports.addAttribute = addAttribute;
+function track(uidOrData, data) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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;
+        }
+        else {
+            uid = resolveUserId();
+            eventData = uidOrData;
+        }
+        if (isNull(eventData)) {
+            throw new error_1.EngageError('Event data missing.');
+        }
+        if (typeof eventData === 'string') {
+            eventData = {
+                event: eventData,
+                value: true
+            };
+        }
+        else {
+            if (Object.keys(eventData).length === 0) {
+                throw new error_1.EngageError('Attributes missing.');
+            }
+        }
+        return yield _request(`/users/${uid}/events`, eventData, 'POST');
+    });
+}
+exports.track = track;
+function merge(sourceOrDestinationUid, destinationUid) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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 (isNullString(destUid)) {
+            throw new error_1.EngageError('Destination ID missing.');
+        }
+        return yield _request('/users/merge', {
+            source: sourceUid,
+            destination: destUid
+        }, 'POST');
+    });
+}
+exports.merge = merge;
+// Account functions
+function addToAccount(uid, accountId, role) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (isNullString(uid)) {
+            throw new error_1.EngageError('User ID missing.');
+        }
+        if (isNullString(accountId)) {
+            throw new error_1.EngageError('Account ID missing.');
+        }
+        if (!isNull(role) && typeof role !== 'string') {
+            throw new error_1.EngageError('Role should be a text.');
+        }
+        const g = {
+            id: accountId
+        };
+        if (!isNullString(role)) {
+            g.role = role;
+        }
+        return yield _request(`/users/${uid}/accounts`, { accounts: [g] }, 'POST');
+    });
+}
+exports.addToAccount = addToAccount;
+function removeFromAccount(uidOrAccountId, accountId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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 (isNullString(acctId)) {
+            throw new error_1.EngageError('Account ID missing.');
+        }
+        return yield _request(`/users/${uid}/accounts/${acctId}`, null, 'DELETE');
+    });
+}
+exports.removeFromAccount = removeFromAccount;
+function changeAccountRole(uidOrAccountId, accountIdOrRole, role) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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;
+        }
+        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 (isNullString(newRole)) {
+            throw new error_1.EngageError('New role missing.');
+        }
+        return yield _request(`/users/${uid}/accounts/${accountId}`, { role: newRole }, 'PUT');
+    });
+}
+exports.changeAccountRole = changeAccountRole;
+function convertToCustomer(uid) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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* () {
+        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,9 +1,13 @@
 {
   "name": "@engage_so/core",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "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": "rm -rf dist && tsc -p tsconfig.json",

package/.github/workflows/test.yml

@@ -1,75 +0,0 @@
-name: Test
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-  workflow_dispatch: # Allow manual trigger
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x, 22.x]
-    
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-    
-    - name: Setup Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    
-    - name: Install dependencies
-      run: npm ci
-    
-    - name: Build project
-      run: npm run build
-    
-    - name: Run tests
-      run: npm test
-      env:
-        KEY: ${{ secrets.ENGAGE_API_KEY }}
-        SECRET: ${{ secrets.ENGAGE_API_SECRET }}
-    
-    - name: Upload test results
-      uses: actions/upload-artifact@v4
-      if: always()
-      with:
-        name: test-results-node-${{ matrix.node-version }}
-        path: |
-          coverage/
-          test-results.xml
-        retention-days: 7
-
-  build-check:
-    runs-on: ubuntu-latest
-    
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-    
-    - name: Setup Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: '20.x'
-        cache: 'npm'
-    
-    - name: Install dependencies
-      run: npm ci
-    
-    - name: Build project
-      run: npm run build
-    
-    - name: Check build output
-      run: |
-        echo "Checking if dist files were created..."
-        ls -la dist/
-        echo "Checking TypeScript declaration files..."
-        ls -la dist/*.d.ts
-        echo "Build successful!"

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'
-  }
-}