@sprucelabs/spruce-mmp-vc-plugin 2.1.4 → 2.1.5

package/README.md

@@ -0,0 +1,3 @@
+# MMP View Controller Plugin
+
+More coming soon...

package/build/AdjustMmpVcPlugin.d.ts

@@ -1,10 +1,11 @@
 import { ViewControllerPlugin, ViewControllerPluginOptions } from '@sprucelabs/heartwood-view-controllers';
-export default class AdjustMmpVcPlugin implements ViewControllerPlugin {
+import { MmpVcPlugin } from './mmp.types';
+export default class AdjustMmpVcPlugin implements ViewControllerPlugin, MmpVcPlugin<AdjustMmpVcPluginSetupOptions, AdjustTrackEventOptions> {
     private device;
     private isSetup;
     constructor(options: ViewControllerPluginOptions);
-    setup(appToken: string, environment: string): void;
-    trackEvent(eventToken: string, options?: AdjustTrackEventOptions): void;
+    setup(options: AdjustMmpVcPluginSetupOptions): void;
+    trackEvent(eventName: string, options?: AdjustTrackEventOptions): void;
 }
 export interface AdjustTrackEventOptions {
     revenue?: {
@@ -14,3 +15,7 @@ export interface AdjustTrackEventOptions {
     transationId?: string;
     productId?: string;
 }
+export interface AdjustMmpVcPluginSetupOptions {
+    appToken: string;
+    environment: string;
+}

package/build/AdjustMmpVcPlugin.js

@@ -11,26 +11,26 @@ class AdjustMmpVcPlugin {
         const { device } = options;
         this.device = device;
     }
-    setup(appToken, environment) {
-        (0, schema_1.assertOptions)({
-            appToken,
-            environment,
-        }, ['appToken', 'environment']);
+    setup(options) {
+        const { appToken, environment } = (0, schema_1.assertOptions)(options, [
+            'appToken',
+            'environment',
+        ]);
         this.device.sendCommand('mmp_setup:adjust', {
             appToken,
             env: environment,
         });
         this.isSetup = true;
     }
-    trackEvent(eventToken, options) {
+    trackEvent(eventName, options) {
         if (!this.isSetup) {
             throw new SpruceError_1.default({
                 code: 'ADJUST_NOT_SETUP',
             });
         }
-        (0, schema_1.assertOptions)({ eventToken }, ['eventToken']);
+        (0, schema_1.assertOptions)({ eventName }, ['eventName']);
         this.device.sendCommand('mmp_track_event:adjust', {
-            eventToken,
+            eventName,
             ...options,
         });
     }

package/build/MockAdjustMmpVcPlugin.d.ts

@@ -0,0 +1,13 @@
+import { ViewControllerPlugin } from '@sprucelabs/heartwood-view-controllers';
+import { AdjustMmpVcPluginSetupOptions } from './AdjustMmpVcPlugin';
+import { MmpVcPlugin } from './mmp.types';
+export default class MockAdjustMmpVcPlugin implements ViewControllerPlugin, MmpVcPlugin<Record<string, any>, Record<string, any>> {
+    private lastSetupOptions?;
+    private lastTrackedEvent?;
+    setup(options: Record<string, any>): void;
+    trackEvent(eventName: string, options?: Record<string, any> | undefined): void;
+    assertTrackEventWasCalled(): void;
+    assertTrackEventWasCalledWith(eventName: string, options?: Record<string, any>): void;
+    assertSetupWasCalled(): void;
+    assertSetupWasCalledWith(setupOptions: AdjustMmpVcPluginSetupOptions): void;
+}

package/build/MockAdjustMmpVcPlugin.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_utils_1 = require("@sprucelabs/test-utils");
+class MockAdjustMmpVcPlugin {
+    setup(options) {
+        this.lastSetupOptions = options;
+    }
+    trackEvent(eventName, options) {
+        this.lastTrackedEvent = {
+            eventName,
+            options,
+        };
+    }
+    assertTrackEventWasCalled() {
+        test_utils_1.assert.isTruthy(this.lastTrackedEvent, `You gotta call this.plugins.mmp.trackEvent(...)`);
+    }
+    assertTrackEventWasCalledWith(eventName, options) {
+        var _a, _b, _c;
+        test_utils_1.assert.isEqual(eventName, (_a = this.lastTrackedEvent) === null || _a === void 0 ? void 0 : _a.eventName, `this.plugins.mmp.trackEvent(...) was not called with the expected eventName. Expected: ${eventName}, got: ${(_b = this.lastTrackedEvent) === null || _b === void 0 ? void 0 : _b.eventName}`);
+        test_utils_1.assert.isEqualDeep(options, (_c = this.lastTrackedEvent) === null || _c === void 0 ? void 0 : _c.options, `this.plugins.mmp.trackEvent(...) was not called with the expected options.`);
+    }
+    assertSetupWasCalled() {
+        test_utils_1.assert.isTruthy(this.lastSetupOptions, `You gotta call this.plugins.mmp.setup(...)`);
+    }
+    assertSetupWasCalledWith(setupOptions) {
+        test_utils_1.assert.isEqualDeep(this.lastSetupOptions, setupOptions, `this.plugins.mmp.setup(...) was not called with the expected options.`);
+    }
+}
+exports.default = MockAdjustMmpVcPlugin;

package/build/esm/AdjustMmpVcPlugin.d.ts

@@ -1,10 +1,11 @@
 import { ViewControllerPlugin, ViewControllerPluginOptions } from '@sprucelabs/heartwood-view-controllers';
-export default class AdjustMmpVcPlugin implements ViewControllerPlugin {
+import { MmpVcPlugin } from './mmp.types';
+export default class AdjustMmpVcPlugin implements ViewControllerPlugin, MmpVcPlugin<AdjustMmpVcPluginSetupOptions, AdjustTrackEventOptions> {
     private device;
     private isSetup;
     constructor(options: ViewControllerPluginOptions);
-    setup(appToken: string, environment: string): void;
-    trackEvent(eventToken: string, options?: AdjustTrackEventOptions): void;
+    setup(options: AdjustMmpVcPluginSetupOptions): void;
+    trackEvent(eventName: string, options?: AdjustTrackEventOptions): void;
 }
 export interface AdjustTrackEventOptions {
     revenue?: {
@@ -14,3 +15,7 @@ export interface AdjustTrackEventOptions {
     transationId?: string;
     productId?: string;
 }
+export interface AdjustMmpVcPluginSetupOptions {
+    appToken: string;
+    environment: string;
+}

package/build/esm/AdjustMmpVcPlugin.js

@@ -6,24 +6,24 @@ export default class AdjustMmpVcPlugin {
         const { device } = options;
         this.device = device;
     }
-    setup(appToken, environment) {
-        assertOptions({
-            appToken,
-            environment,
-        }, ['appToken', 'environment']);
+    setup(options) {
+        const { appToken, environment } = assertOptions(options, [
+            'appToken',
+            'environment',
+        ]);
         this.device.sendCommand('mmp_setup:adjust', {
             appToken,
             env: environment,
         });
         this.isSetup = true;
     }
-    trackEvent(eventToken, options) {
+    trackEvent(eventName, options) {
         if (!this.isSetup) {
             throw new SpruceError({
                 code: 'ADJUST_NOT_SETUP',
             });
         }
-        assertOptions({ eventToken }, ['eventToken']);
-        this.device.sendCommand('mmp_track_event:adjust', Object.assign({ eventToken }, options));
+        assertOptions({ eventName }, ['eventName']);
+        this.device.sendCommand('mmp_track_event:adjust', Object.assign({ eventName }, options));
     }
 }

package/build/esm/MockAdjustMmpVcPlugin.d.ts

@@ -0,0 +1,13 @@
+import { ViewControllerPlugin } from '@sprucelabs/heartwood-view-controllers';
+import { AdjustMmpVcPluginSetupOptions } from './AdjustMmpVcPlugin';
+import { MmpVcPlugin } from './mmp.types';
+export default class MockAdjustMmpVcPlugin implements ViewControllerPlugin, MmpVcPlugin<Record<string, any>, Record<string, any>> {
+    private lastSetupOptions?;
+    private lastTrackedEvent?;
+    setup(options: Record<string, any>): void;
+    trackEvent(eventName: string, options?: Record<string, any> | undefined): void;
+    assertTrackEventWasCalled(): void;
+    assertTrackEventWasCalledWith(eventName: string, options?: Record<string, any>): void;
+    assertSetupWasCalled(): void;
+    assertSetupWasCalledWith(setupOptions: AdjustMmpVcPluginSetupOptions): void;
+}

package/build/esm/MockAdjustMmpVcPlugin.js

@@ -0,0 +1,26 @@
+import { assert } from '@sprucelabs/test-utils';
+export default class MockAdjustMmpVcPlugin {
+    setup(options) {
+        this.lastSetupOptions = options;
+    }
+    trackEvent(eventName, options) {
+        this.lastTrackedEvent = {
+            eventName,
+            options,
+        };
+    }
+    assertTrackEventWasCalled() {
+        assert.isTruthy(this.lastTrackedEvent, `You gotta call this.plugins.mmp.trackEvent(...)`);
+    }
+    assertTrackEventWasCalledWith(eventName, options) {
+        var _a, _b, _c;
+        assert.isEqual(eventName, (_a = this.lastTrackedEvent) === null || _a === void 0 ? void 0 : _a.eventName, `this.plugins.mmp.trackEvent(...) was not called with the expected eventName. Expected: ${eventName}, got: ${(_b = this.lastTrackedEvent) === null || _b === void 0 ? void 0 : _b.eventName}`);
+        assert.isEqualDeep(options, (_c = this.lastTrackedEvent) === null || _c === void 0 ? void 0 : _c.options, `this.plugins.mmp.trackEvent(...) was not called with the expected options.`);
+    }
+    assertSetupWasCalled() {
+        assert.isTruthy(this.lastSetupOptions, `You gotta call this.plugins.mmp.setup(...)`);
+    }
+    assertSetupWasCalledWith(setupOptions) {
+        assert.isEqualDeep(this.lastSetupOptions, setupOptions, `this.plugins.mmp.setup(...) was not called with the expected options.`);
+    }
+}

package/build/esm/index.d.ts

@@ -1 +1,5 @@
 export { default as AdjustMmpVcPlugin } from './AdjustMmpVcPlugin';
+export * from './AdjustMmpVcPlugin';
+export * from './mmp.types';
+export { default as mmpAssert } from './mmpAssert';
+export * from './mmpAssert';

package/build/esm/index.js

@@ -1 +1,5 @@
 export { default as AdjustMmpVcPlugin } from './AdjustMmpVcPlugin.js';
+export * from './AdjustMmpVcPlugin.js';
+export * from './mmp.types.js';
+export { default as mmpAssert } from './mmpAssert.js';
+export * from './mmpAssert.js';

package/build/esm/mmp.types.d.ts

@@ -0,0 +1,5 @@
+export type Partner = 'adjust';
+export interface MmpVcPlugin<SetupOptions, TrackEventOptions> {
+    setup(options: SetupOptions): void;
+    trackEvent(eventName: string, options?: TrackEventOptions): void;
+}

package/build/esm/mmp.types.js

@@ -0,0 +1 @@
+export {};

package/build/esm/mmpAssert.d.ts

@@ -0,0 +1,19 @@
+import { ViewControllerFactory } from '@sprucelabs/heartwood-view-controllers';
+import { AdjustMmpVcPluginSetupOptions } from './AdjustMmpVcPlugin';
+import { Partner } from './mmp.types';
+declare const mmpAssert: {
+    beforeEach(views: ViewControllerFactory): void;
+    pluginIsSetup(options: PluginIsSetupOptions): Promise<void>;
+    didTrackEvent(options: DidTrackEventOptions): Promise<void>;
+};
+export default mmpAssert;
+export interface PluginIsSetupOptions {
+    action: () => void | Promise<void>;
+    partner: Partner;
+    setupOptions?: AdjustMmpVcPluginSetupOptions;
+}
+export interface DidTrackEventOptions {
+    action: () => void | Promise<void>;
+    eventName: string;
+    trackOptions?: Record<string, any>;
+}

package/build/esm/mmpAssert.js

@@ -0,0 +1,51 @@
+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());
+    });
+};
+import { assertOptions } from '@sprucelabs/schema';
+import { assert } from '@sprucelabs/test-utils';
+import MockAdjustMmpVcPlugin from './MockAdjustMmpVcPlugin.js';
+let mockPlugin;
+const mmpAssert = {
+    beforeEach(views) {
+        mockPlugin = new MockAdjustMmpVcPlugin();
+        views.addPlugin('mmp', mockPlugin);
+    },
+    pluginIsSetup(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { action, partner, setupOptions } = options !== null && options !== void 0 ? options : {};
+            assertBeforeEachCalled();
+            assertOptions({
+                action,
+                partner,
+            }, ['action', 'partner']);
+            assert.isEqual(partner, 'adjust', 'The partner you passed was invalid. For now I only support Adjust.');
+            yield action();
+            mockPlugin === null || mockPlugin === void 0 ? void 0 : mockPlugin.assertSetupWasCalled();
+            if (setupOptions) {
+                mockPlugin === null || mockPlugin === void 0 ? void 0 : mockPlugin.assertSetupWasCalledWith(setupOptions);
+            }
+        });
+    },
+    didTrackEvent(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            assertBeforeEachCalled();
+            const { action, eventName, trackOptions } = assertOptions(options, [
+                'action',
+                'eventName',
+            ]);
+            yield action();
+            mockPlugin === null || mockPlugin === void 0 ? void 0 : mockPlugin.assertTrackEventWasCalled();
+            mockPlugin === null || mockPlugin === void 0 ? void 0 : mockPlugin.assertTrackEventWasCalledWith(eventName, trackOptions);
+        });
+    },
+};
+export default mmpAssert;
+function assertBeforeEachCalled() {
+    assert.isTruthy(mockPlugin, 'You must call mmpAssert.beforeEach(this.views.getFactory()) before using this assert util.');
+}

package/build/index.d.ts

@@ -1 +1,5 @@
 export { default as AdjustMmpVcPlugin } from './AdjustMmpVcPlugin';
+export * from './AdjustMmpVcPlugin';
+export * from './mmp.types';
+export { default as mmpAssert } from './mmpAssert';
+export * from './mmpAssert';

package/build/index.js

@@ -1,8 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdjustMmpVcPlugin = void 0;
+exports.mmpAssert = exports.AdjustMmpVcPlugin = void 0;
 var AdjustMmpVcPlugin_1 = require("./AdjustMmpVcPlugin");
 Object.defineProperty(exports, "AdjustMmpVcPlugin", { enumerable: true, get: function () { return __importDefault(AdjustMmpVcPlugin_1).default; } });
+__exportStar(require("./AdjustMmpVcPlugin"), exports);
+__exportStar(require("./mmp.types"), exports);
+var mmpAssert_1 = require("./mmpAssert");
+Object.defineProperty(exports, "mmpAssert", { enumerable: true, get: function () { return __importDefault(mmpAssert_1).default; } });
+__exportStar(require("./mmpAssert"), exports);

package/build/mmp.types.d.ts

@@ -0,0 +1,5 @@
+export type Partner = 'adjust';
+export interface MmpVcPlugin<SetupOptions, TrackEventOptions> {
+    setup(options: SetupOptions): void;
+    trackEvent(eventName: string, options?: TrackEventOptions): void;
+}

package/build/mmp.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/mmpAssert.d.ts

@@ -0,0 +1,19 @@
+import { ViewControllerFactory } from '@sprucelabs/heartwood-view-controllers';
+import { AdjustMmpVcPluginSetupOptions } from './AdjustMmpVcPlugin';
+import { Partner } from './mmp.types';
+declare const mmpAssert: {
+    beforeEach(views: ViewControllerFactory): void;
+    pluginIsSetup(options: PluginIsSetupOptions): Promise<void>;
+    didTrackEvent(options: DidTrackEventOptions): Promise<void>;
+};
+export default mmpAssert;
+export interface PluginIsSetupOptions {
+    action: () => void | Promise<void>;
+    partner: Partner;
+    setupOptions?: AdjustMmpVcPluginSetupOptions;
+}
+export interface DidTrackEventOptions {
+    action: () => void | Promise<void>;
+    eventName: string;
+    trackOptions?: Record<string, any>;
+}

package/build/mmpAssert.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+const test_utils_1 = require("@sprucelabs/test-utils");
+const MockAdjustMmpVcPlugin_1 = __importDefault(require("./MockAdjustMmpVcPlugin"));
+let mockPlugin;
+const mmpAssert = {
+    beforeEach(views) {
+        mockPlugin = new MockAdjustMmpVcPlugin_1.default();
+        views.addPlugin('mmp', mockPlugin);
+    },
+    async pluginIsSetup(options) {
+        const { action, partner, setupOptions } = options !== null && options !== void 0 ? options : {};
+        assertBeforeEachCalled();
+        (0, schema_1.assertOptions)({
+            action,
+            partner,
+        }, ['action', 'partner']);
+        test_utils_1.assert.isEqual(partner, 'adjust', 'The partner you passed was invalid. For now I only support Adjust.');
+        await action();
+        mockPlugin === null || mockPlugin === void 0 ? void 0 : mockPlugin.assertSetupWasCalled();
+        if (setupOptions) {
+            mockPlugin === null || mockPlugin === void 0 ? void 0 : mockPlugin.assertSetupWasCalledWith(setupOptions);
+        }
+    },
+    async didTrackEvent(options) {
+        assertBeforeEachCalled();
+        const { action, eventName, trackOptions } = (0, schema_1.assertOptions)(options, [
+            'action',
+            'eventName',
+        ]);
+        await action();
+        mockPlugin === null || mockPlugin === void 0 ? void 0 : mockPlugin.assertTrackEventWasCalled();
+        mockPlugin === null || mockPlugin === void 0 ? void 0 : mockPlugin.assertTrackEventWasCalledWith(eventName, trackOptions);
+    },
+};
+exports.default = mmpAssert;
+function assertBeforeEachCalled() {
+    test_utils_1.assert.isTruthy(mockPlugin, 'You must call mmpAssert.beforeEach(this.views.getFactory()) before using this assert util.');
+}

package/package.json

@@ -13,7 +13,7 @@
     "sprucebot",
     "sprucelabs"
   ],
-  "version": "2.1.4",
+  "version": "2.1.5",
   "scripts": {
     "build.ci": "yarn run build.tsc && yarn run build.resolve-paths && yarn run lint",
     "build.copy-files": "mkdir -p build && rsync -avzq --exclude='*.ts' ./src/ ./build/",