@muritavo/testing-toolkit 0.0.1

package/README.md

@@ -0,0 +1,9 @@
+# Introduction
+
+This is a generalization of the functions used for @muritavo/cypress-toolkit so they can be used with other testing frameworks (like jest for example)
+
+# Folder structure
+
+There are 2 main folders where the source is located:
+/native - These are pure nodejs based implementations, that require interfacing with nodejs native libraries (e.g. child_process)
+/client - These are implementations that can be used on jsdom or nodejs and (usually) don't require env specific libraries

package/dist/client/emulator.d.ts

@@ -0,0 +1,65 @@
+import firebase from "firebase/compat";
+/**
+ * Deletes a collection from firebase
+ * @param projectId The current project id of the emulator instance
+ * @param collectionPath The collection path **starting with "/"**
+ */
+export declare const deleteCollection: (projectId: string, collectionPath: string) => Promise<void>;
+/**
+ * Gives the developer the possibility to interact with an admin firestore emulator instance
+ * @param projectId The current project id of the emulator instance
+ * @param cb The callback to be executed
+ */
+export declare const setupEmulator: (projectId: string, cb: (firestore: firebase.firestore.Firestore) => Promise<void>) => Promise<void>;
+/**
+ * Creates a user on the auth emulator allowing him to authenticate to the emulator
+ * @param projectId The current project id of the emulator instance
+ * @param email The email to authenticate the user with
+ * @param password The password to authenticate the user with
+ * @param localId A deterministic Id to be used for this user
+ */
+export declare const addAuthUser: (projectId: string, email: string, password: string, localId?: string) => Promise<void>;
+/**
+ * Clears all accounts from the auth emulator
+ *
+ * @param projectId The current project id of the emulator instance
+ */
+export declare const clearAuth: (projectId: string) => Promise<void>;
+/**
+ * Sets the emulator ports config
+ * @param config Emulator ports config
+ */
+export declare function setEmulatorConfig(config: FirebaseConfigShape): void;
+/**
+ * Clears all firestore documents from local emulator
+ * @param projectId The current project id of the emulator instance
+ */
+export declare const clearFirestore: (projectId: string) => Promise<void>;
+declare const FirebaseConfigEmulatorsShapeExample: {
+    readonly emulators: {
+        readonly auth: {
+            readonly port: number;
+        };
+        readonly functions: {
+            readonly port: number;
+        };
+        readonly firestore: {
+            readonly port: number;
+        };
+        readonly hosting: {
+            readonly port: number;
+        };
+        readonly storage: {
+            readonly port: number;
+        };
+        readonly pubsub: {
+            readonly port: number;
+        };
+        readonly ui: {
+            readonly enabled: true;
+            readonly port: number;
+        };
+    };
+};
+export declare type FirebaseConfigShape = typeof FirebaseConfigEmulatorsShapeExample;
+export {};

package/dist/client/emulator.js

@@ -0,0 +1,230 @@
+"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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+exports.__esModule = true;
+exports.clearFirestore = exports.setEmulatorConfig = exports.clearAuth = exports.addAuthUser = exports.setupEmulator = exports.deleteCollection = void 0;
+var node_fetch_1 = require("node-fetch");
+var rules_unit_testing_1 = require("@firebase/rules-unit-testing");
+var emulatorConfig;
+/**
+ * Deletes a collection from firebase
+ * @param projectId The current project id of the emulator instance
+ * @param collectionPath The collection path **starting with "/"**
+ */
+var deleteCollection = function (projectId, collectionPath) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, node_fetch_1["default"])("http://localhost:".concat(_getPort("firestore"), "/emulator/v1/projects/").concat(projectId, "/databases/(default)/documents").concat(collectionPath), {
+                    method: "delete"
+                })];
+            case 1:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
+exports.deleteCollection = deleteCollection;
+/**
+ * Gives the developer the possibility to interact with an admin firestore emulator instance
+ * @param projectId The current project id of the emulator instance
+ * @param cb The callback to be executed
+ */
+var setupEmulator = function (projectId, cb) { return __awaiter(void 0, void 0, void 0, function () {
+    var testEnv;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, rules_unit_testing_1.initializeTestEnvironment)({
+                    projectId: projectId,
+                    firestore: {
+                        host: "localhost",
+                        port: _getPort("firestore")
+                    }
+                })];
+            case 1:
+                testEnv = _a.sent();
+                return [4 /*yield*/, testEnv.withSecurityRulesDisabled(function (ctx) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0: return [4 /*yield*/, cb(ctx.firestore({
+                                        experimentalForceLongPolling: true,
+                                        merge: true
+                                    }))];
+                                case 1:
+                                    _a.sent();
+                                    return [2 /*return*/];
+                            }
+                        });
+                    }); })];
+            case 2:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
+exports.setupEmulator = setupEmulator;
+/**
+ * Creates a user on the auth emulator allowing him to authenticate to the emulator
+ * @param projectId The current project id of the emulator instance
+ * @param email The email to authenticate the user with
+ * @param password The password to authenticate the user with
+ * @param localId A deterministic Id to be used for this user
+ */
+var addAuthUser = function (projectId, email, password, localId) {
+    if (localId === void 0) { localId = ""; }
+    return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, node_fetch_1["default"])("http://localhost:".concat(_getPort("auth"), "/identitytoolkit.googleapis.com/v1/projects/").concat(projectId, "/accounts"), {
+                        body: JSON.stringify({
+                            email: email,
+                            password: password,
+                            localId: localId
+                        }),
+                        headers: {
+                            "content-type": "application/json",
+                            authorization: "Bearer owner"
+                        },
+                        method: "post"
+                    })];
+                case 1:
+                    result = _a.sent();
+                    if (result.status > 300)
+                        throw new Error("Creating account returned ".concat(result.status));
+                    return [2 /*return*/];
+            }
+        });
+    });
+};
+exports.addAuthUser = addAuthUser;
+/**
+ * Clears all accounts from the auth emulator
+ *
+ * @param projectId The current project id of the emulator instance
+ */
+var clearAuth = function (projectId) { return __awaiter(void 0, void 0, void 0, function () {
+    var result;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, node_fetch_1["default"])("http://localhost:".concat(_getPort("auth"), "/emulator/v1/projects/").concat(projectId, "/accounts"), {
+                    method: "delete"
+                })];
+            case 1:
+                result = _a.sent();
+                if (result.status > 300)
+                    throw new Error("Cleaning accounts returned ".concat(result.status));
+                return [2 /*return*/];
+        }
+    });
+}); };
+exports.clearAuth = clearAuth;
+/**
+ * Sets the emulator ports config
+ * @param config Emulator ports config
+ */
+function setEmulatorConfig(config) {
+    emulatorConfig = config;
+}
+exports.setEmulatorConfig = setEmulatorConfig;
+/**
+ * Clears all firestore documents from local emulator
+ * @param projectId The current project id of the emulator instance
+ */
+var clearFirestore = function (projectId) { return __awaiter(void 0, void 0, void 0, function () {
+    var testEnv;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, rules_unit_testing_1.initializeTestEnvironment)({
+                    projectId: projectId,
+                    firestore: {
+                        host: "localhost",
+                        port: _getPort("firestore")
+                    }
+                })];
+            case 1:
+                testEnv = _a.sent();
+                return [4 /*yield*/, testEnv.clearFirestore()];
+            case 2:
+                _a.sent();
+                testEnv.cleanup();
+                return [2 /*return*/];
+        }
+    });
+}); };
+exports.clearFirestore = clearFirestore;
+var FirebaseConfigEmulatorsShapeExample = {
+    emulators: {
+        auth: {
+            port: 9099
+        },
+        functions: {
+            port: 5001
+        },
+        firestore: {
+            port: 8080
+        },
+        hosting: {
+            port: 5000
+        },
+        storage: {
+            port: 9199
+        },
+        pubsub: {
+            port: 8055
+        },
+        ui: {
+            enabled: true,
+            port: 4000
+        }
+    }
+};
+/**
+ * Guarantees a firebase config has been provided before using the ports
+ * @param emulator The emulator type to get the port from
+ * @returns The port
+ */
+function _getPort(emulator) {
+    if (!emulatorConfig) {
+        throw new Error("You didn't set the emulator config. Provide it by using the following at your cypress support file:\n\nimport { setEmulatorConfig } from '@muritavo/cypress-toolkit/dist/support/emulator'\n...\n...\n...\nbefore() {\n    setEmulatorConfig(require(\"THE_PATH_TO_YOUR_FIREBASE_JSON\"))\n}\n");
+    }
+    var emulatorConfigSet = emulatorConfig.emulators[emulator];
+    if (!emulatorConfigSet || !emulatorConfigSet.port) {
+        throw new Error("Emulator config not found");
+    }
+    return emulatorConfigSet.port;
+}
+//# sourceMappingURL=emulator.js.map

package/dist/client/emulator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emulator.js","sourceRoot":"","sources":["../../src/client/emulator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAAmC;AACnC,mEAAyE;AAGzE,IAAI,cAAmC,CAAC;AAExC;;;;GAIG;AACI,IAAM,gBAAgB,GAAG,UAC9B,SAAiB,EACjB,cAAsB;;;oBAEtB,qBAAM,IAAA,uBAAS,EACb,2BAAoB,QAAQ,CAC1B,WAAW,CACZ,mCAAyB,SAAS,2CAAiC,cAAc,CAAE,EACpF;oBACE,MAAM,EAAE,QAAQ;iBACjB,CACF,EAAA;;gBAPD,SAOC,CAAC;;;;KACH,CAAC;AAZW,QAAA,gBAAgB,oBAY3B;AAEF;;;;GAIG;AACI,IAAM,aAAa,GAAG,UAC3B,SAAiB,EACjB,EAAuE;;;;oBAEvD,qBAAM,IAAA,8CAAyB,EAAC;oBAC9C,SAAS,EAAE,SAAS;oBACpB,SAAS,EAAE;wBACT,IAAI,EAAE,WAAW;wBACjB,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC;qBAC5B;iBACF,CAAC,EAAA;;gBANI,OAAO,GAAG,SAMd;gBACF,qBAAM,OAAO,CAAC,yBAAyB,CAAC,UAAO,GAAQ;;;wCACrD,qBAAM,EAAE,CACN,GAAG,CAAC,SAAS,CAAC;wCACZ,4BAA4B,EAAE,IAAI;wCAClC,KAAK,EAAE,IAAI;qCACZ,CAAC,CACH,EAAA;;oCALD,SAKC,CAAC;;;;yBACH,CAAC,EAAA;;gBAPF,SAOE,CAAC;;;;KACJ,CAAC;AAnBW,QAAA,aAAa,iBAmBxB;AACF;;;;;;GAMG;AACI,IAAM,WAAW,GAAG,UACzB,SAAiB,EACjB,KAAa,EACb,QAAgB,EAChB,OAAoB;IAApB,wBAAA,EAAA,YAAoB;;;;;wBAEL,qBAAM,IAAA,uBAAS,EAC5B,2BAAoB,QAAQ,CAC1B,MAAM,CACP,yDAA+C,SAAS,cAAW,EACpE;wBACE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;4BACnB,KAAK,OAAA;4BACL,QAAQ,UAAA;4BACR,OAAO,SAAA;yBACR,CAAC;wBACF,OAAO,EAAE;4BACP,cAAc,EAAE,kBAAkB;4BAClC,aAAa,EAAE,cAAc;yBAC9B;wBACD,MAAM,EAAE,MAAM;qBACf,CACF,EAAA;;oBAhBK,MAAM,GAAG,SAgBd;oBAED,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG;wBACrB,MAAM,IAAI,KAAK,CAAC,oCAA6B,MAAM,CAAC,MAAM,CAAE,CAAC,CAAC;;;;;CACjE,CAAC;AA1BW,QAAA,WAAW,eA0BtB;AAEF;;;;GAIG;AACI,IAAM,SAAS,GAAG,UAAO,SAAiB;;;;oBAChC,qBAAM,IAAA,uBAAS,EAC5B,2BAAoB,QAAQ,CAC1B,MAAM,CACP,mCAAyB,SAAS,cAAW,EAC9C;oBACE,MAAM,EAAE,QAAQ;iBACjB,CACF,EAAA;;gBAPK,MAAM,GAAG,SAOd;gBACD,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG;oBACrB,MAAM,IAAI,KAAK,CAAC,qCAA8B,MAAM,CAAC,MAAM,CAAE,CAAC,CAAC;;;;KAClE,CAAC;AAXW,QAAA,SAAS,aAWpB;AAEF;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,MAA2B;IAC3D,cAAc,GAAG,MAAM,CAAC;AAC1B,CAAC;AAFD,8CAEC;AAED;;;GAGG;AACI,IAAM,cAAc,GAAG,UAAO,SAAiB;;;;oBACpC,qBAAM,IAAA,8CAAyB,EAAC;oBAC9C,SAAS,EAAE,SAAS;oBACpB,SAAS,EAAE;wBACT,IAAI,EAAE,WAAW;wBACjB,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC;qBAC5B;iBACF,CAAC,EAAA;;gBANI,OAAO,GAAG,SAMd;gBACF,qBAAM,OAAO,CAAC,cAAc,EAAE,EAAA;;gBAA9B,SAA8B,CAAC;gBAC/B,OAAO,CAAC,OAAO,EAAE,CAAC;;;;KACnB,CAAC;AAVW,QAAA,cAAc,kBAUzB;AAEF,IAAM,mCAAmC,GAAG;IAC1C,SAAS,EAAE;QACT,IAAI,EAAE;YACJ,IAAI,EAAE,IAAc;SACrB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,IAAc;SACrB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,IAAc;SACrB;QACD,OAAO,EAAE;YACP,IAAI,EAAE,IAAc;SACrB;QACD,OAAO,EAAE;YACP,IAAI,EAAE,IAAc;SACrB;QACD,MAAM,EAAE;YACN,IAAI,EAAE,IAAc;SACrB;QACD,EAAE,EAAE;YACF,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,IAAc;SACrB;KACF;CACO,CAAC;AAIX;;;;GAIG;AACH,SAAS,QAAQ,CAAC,QAAgD;IAChE,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,gSASnB,CAAC,CAAC;KACA;IACD,IAAM,iBAAiB,GAAG,cAAc,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC7D,IAAI,CAAC,iBAAiB,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE;QACjD,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;KAC9C;IACD,OAAO,iBAAiB,CAAC,IAAI,CAAC;AAChC,CAAC"}

package/dist/native/emulator.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Kills the emulator that was started by this module instance
+ *
+ * @returns A promise that resolves when the emulator is succesfully killed
+ */
+export declare function killEmulator(): Promise<any>;
+/**
+ * With this you can start an firebase emulator
+ * @param args Check property typings for details
+ * @returns A promise that resolves when the emulator is ready or fails if the emulator couldn't start or be reached
+ */
+export declare function startEmulator(args: {
+    /** The project id used by the emulator */
+    projectId: string;
+    /** Optionally indicates the database to import data from */
+    databaseToImport?: string;
+    /** The port where the firebase UI will be running to check if the emulator is up */
+    UIPort: number;
+    /** An optional flag to indicate when a new emulator instance should be created */
+    suiteId?: string;
+}): Promise<null>;

package/dist/native/emulator.js

@@ -0,0 +1,181 @@
+"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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+exports.__esModule = true;
+exports.startEmulator = exports.killEmulator = void 0;
+var node_fetch_1 = require("node-fetch");
+var child_process_1 = require("child_process");
+var log = require("debug")("@muritavo/testing-toolkit/emulator");
+var spawnResult;
+function WaitTimeout(ml) {
+    if (ml === void 0) { ml = 200; }
+    return new Promise(function (r) {
+        setTimeout(function () {
+            r();
+        }, ml);
+    });
+}
+/**
+ * Kills the emulator that was started by this module instance
+ *
+ * @returns A promise that resolves when the emulator is succesfully killed
+ */
+function killEmulator() {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            if (!spawnResult)
+                return [2 /*return*/, Promise.resolve(null)];
+            return [2 /*return*/, new Promise(function (r, rej) {
+                    try {
+                        var t_1 = setTimeout(function () {
+                            spawnResult = undefined;
+                            rej(new Error("Couldn't kill emulator"));
+                        }, 10000);
+                        spawnResult.process.on("close", function () {
+                            clearTimeout(t_1);
+                            r(null);
+                        });
+                        spawnResult.process.kill("SIGINT");
+                    }
+                    catch (e) {
+                        console.log("Unhandled exception", e);
+                        r(null);
+                    }
+                })];
+        });
+    });
+}
+exports.killEmulator = killEmulator;
+/**
+ * With this you can start an firebase emulator
+ * @param args Check property typings for details
+ * @returns A promise that resolves when the emulator is ready or fails if the emulator couldn't start or be reached
+ */
+function startEmulator(args) {
+    return __awaiter(this, void 0, void 0, function () {
+        var suiteId;
+        var _this = this;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    suiteId = args.suiteId || args.databaseToImport || "default";
+                    log("Spawning emulator process");
+                    if (!(suiteId === (spawnResult === null || spawnResult === void 0 ? void 0 : spawnResult.id))) return [3 /*break*/, 1];
+                    log("Emulator with suite id ".concat(suiteId, " already running"));
+                    return [2 /*return*/, null];
+                case 1: return [4 /*yield*/, killEmulator()];
+                case 2:
+                    _a.sent();
+                    _a.label = 3;
+                case 3:
+                    spawnResult = {
+                        id: suiteId,
+                        project: args.projectId,
+                        database: args.databaseToImport,
+                        process: (0, child_process_1.spawn)("firebase emulators:start -P ".concat(args.projectId, " ").concat(args.databaseToImport ? "--import ".concat(args.databaseToImport) : ""), {
+                            cwd: undefined,
+                            env: process.env,
+                            shell: true
+                        })
+                    };
+                    /**
+                     * This script exists so we can start an emulator from inside cypress
+                     */
+                    return [2 /*return*/, new Promise(function (r, rej) { return __awaiter(_this, void 0, void 0, function () {
+                            var breakLoop, timeout, e_1;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0:
+                                        breakLoop = false;
+                                        timeout = setTimeout(function () {
+                                            breakLoop = true;
+                                            console.error("Could not receive ok from firebase emulator");
+                                            clearTimeout(timeout);
+                                            rej(new Error("Timeout"));
+                                            spawnResult = undefined;
+                                        }, 30000);
+                                        log("Process is killed: ", spawnResult.process.killed);
+                                        log("Process exit code", spawnResult.process.exitCode);
+                                        spawnResult.process.on("error", function (e) {
+                                            clearTimeout(timeout);
+                                            log("Spawning emulator process failed with error", e.message);
+                                            rej(new Error("Spawning emulator process failed with error ".concat(e.message)));
+                                            spawnResult = undefined;
+                                        });
+                                        spawnResult.process.on("message", function (e) {
+                                            log("Emulator start sent message", e.toString());
+                                        });
+                                        spawnResult.process.on("close", function (e) {
+                                            clearTimeout(timeout);
+                                            log("Emulator closed with", e);
+                                            rej(new Error("Emulator closed with code ".concat(e, ". Check the firebse-debug.log for more details")));
+                                            spawnResult = undefined;
+                                        });
+                                        _a.label = 1;
+                                    case 1:
+                                        if (!!breakLoop) return [3 /*break*/, 7];
+                                        _a.label = 2;
+                                    case 2:
+                                        _a.trys.push([2, 4, , 5]);
+                                        log("Checking if emulator is up");
+                                        return [4 /*yield*/, (0, node_fetch_1["default"])("http://localhost:".concat(args.UIPort))];
+                                    case 3:
+                                        _a.sent();
+                                        log("Emulator is up and ready");
+                                        clearTimeout(timeout);
+                                        breakLoop = true;
+                                        r(null);
+                                        return [3 /*break*/, 5];
+                                    case 4:
+                                        e_1 = _a.sent();
+                                        log("Process is killed: ", spawnResult === null || spawnResult === void 0 ? void 0 : spawnResult.process.killed);
+                                        log("Emulator is not ready yet, retrying in 1 sec");
+                                        return [3 /*break*/, 5];
+                                    case 5: return [4 /*yield*/, WaitTimeout(1000)];
+                                    case 6:
+                                        _a.sent();
+                                        return [3 /*break*/, 1];
+                                    case 7: return [2 /*return*/];
+                                }
+                            });
+                        }); })];
+            }
+        });
+    });
+}
+exports.startEmulator = startEmulator;
+//# sourceMappingURL=emulator.js.map

package/dist/native/emulator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emulator.js","sourceRoot":"","sources":["../../src/native/emulator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAAmC;AACnC,+CAAoD;AAEpD,IAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,oCAAoC,CAAC,CAAC;AACnE,IAAI,WAKH,CAAC;AACF,SAAS,WAAW,CAAC,EAAQ;IAAR,mBAAA,EAAA,QAAQ;IAC3B,OAAO,IAAI,OAAO,CAAO,UAAC,CAAC;QACzB,UAAU,CAAC;YACT,CAAC,EAAE,CAAC;QACN,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAsB,YAAY;;;YAChC,IAAI,CAAC,WAAW;gBAAE,sBAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAC;YAC/C,sBAAO,IAAI,OAAO,CAAC,UAAC,CAAC,EAAE,GAAG;oBACxB,IAAI;wBACF,IAAM,GAAC,GAAG,UAAU,CAAC;4BACnB,WAAW,GAAG,SAAgB,CAAC;4BAC/B,GAAG,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC;wBAC3C,CAAC,EAAE,KAAK,CAAC,CAAC;wBACV,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE;4BAC9B,YAAY,CAAC,GAAC,CAAC,CAAC;4BAChB,CAAC,CAAC,IAAI,CAAC,CAAC;wBACV,CAAC,CAAC,CAAC;wBACH,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;qBACpC;oBAAC,OAAO,CAAC,EAAE;wBACV,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;wBACtC,CAAC,CAAC,IAAI,CAAC,CAAC;qBACT;gBACH,CAAC,CAAC,EAAC;;;CACJ;AAlBD,oCAkBC;AAED;;;;GAIG;AACH,SAAsB,aAAa,CAAC,IASnC;;;;;;;oBACO,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,gBAAgB,IAAI,SAAS,CAAC;oBACnE,GAAG,CAAC,2BAA2B,CAAC,CAAC;yBAC7B,CAAA,OAAO,MAAK,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,EAAE,CAAA,CAAA,EAA3B,wBAA2B;oBAC7B,GAAG,CAAC,iCAA0B,OAAO,qBAAkB,CAAC,CAAC;oBACzD,sBAAO,IAAI,EAAC;wBACP,qBAAM,YAAY,EAAE,EAAA;;oBAApB,SAAoB,CAAC;;;oBAC5B,WAAW,GAAG;wBACZ,EAAE,EAAE,OAAO;wBACX,OAAO,EAAE,IAAI,CAAC,SAAS;wBACvB,QAAQ,EAAE,IAAI,CAAC,gBAAgB;wBAC/B,OAAO,EAAE,IAAA,qBAAK,EACZ,sCAA+B,IAAI,CAAC,SAAS,cAC3C,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,mBAAY,IAAI,CAAC,gBAAgB,CAAE,CAAC,CAAC,CAAC,EAAE,CAChE,EACF;4BACE,GAAG,EAAE,SAAS;4BACd,GAAG,EAAE,OAAO,CAAC,GAAG;4BAChB,KAAK,EAAE,IAAI;yBACZ,CACF;qBACF,CAAC;oBAEF;;uBAEG;oBACH,sBAAO,IAAI,OAAO,CAAO,UAAO,CAAC,EAAE,GAAG;;;;;wCAChC,SAAS,GAAG,KAAK,CAAC;wCAChB,OAAO,GAAG,UAAU,CAAC;4CACzB,SAAS,GAAG,IAAI,CAAC;4CACjB,OAAO,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;4CAC7D,YAAY,CAAC,OAAO,CAAC,CAAC;4CACtB,GAAG,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;4CAC1B,WAAW,GAAG,SAAgB,CAAC;wCACjC,CAAC,EAAE,KAAK,CAAC,CAAC;wCAEV,GAAG,CAAC,qBAAqB,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;wCACvD,GAAG,CAAC,mBAAmB,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;wCAEvD,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,CAAC;4CAChC,YAAY,CAAC,OAAO,CAAC,CAAC;4CACtB,GAAG,CAAC,6CAA6C,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;4CAC9D,GAAG,CACD,IAAI,KAAK,CAAC,sDAA+C,CAAC,CAAC,OAAO,CAAE,CAAC,CACtE,CAAC;4CACF,WAAW,GAAG,SAAgB,CAAC;wCACjC,CAAC,CAAC,CAAC;wCAEH,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,UAAC,CAAC;4CAClC,GAAG,CAAC,6BAA6B,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;wCACnD,CAAC,CAAC,CAAC;wCAEH,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,CAAC;4CAChC,YAAY,CAAC,OAAO,CAAC,CAAC;4CACtB,GAAG,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;4CAC/B,GAAG,CACD,IAAI,KAAK,CACP,oCAA6B,CAAC,mDAAgD,CAC/E,CACF,CAAC;4CACF,WAAW,GAAG,SAAgB,CAAC;wCACjC,CAAC,CAAC,CAAC;;;6CACI,CAAC,SAAS;;;;wCAEb,GAAG,CAAC,4BAA4B,CAAC,CAAC;wCAClC,qBAAM,IAAA,uBAAS,EAAC,2BAAoB,IAAI,CAAC,MAAM,CAAE,CAAC,EAAA;;wCAAlD,SAAkD,CAAC;wCACnD,GAAG,CAAC,0BAA0B,CAAC,CAAC;wCAChC,YAAY,CAAC,OAAO,CAAC,CAAC;wCACtB,SAAS,GAAG,IAAI,CAAC;wCACjB,CAAC,CAAC,IAAI,CAAC,CAAC;;;;wCAER,GAAG,CAAC,qBAAqB,EAAE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,MAAM,CAAC,CAAC;wCACxD,GAAG,CAAC,8CAA8C,CAAC,CAAC;;4CAEtD,qBAAM,WAAW,CAAC,IAAI,CAAC,EAAA;;wCAAvB,SAAuB,CAAC;;;;;6BAE3B,CAAC,EAAC;;;;CACJ;AAtFD,sCAsFC"}

package/dist/types/contract.d.ts

@@ -0,0 +1,78 @@
+import { Contract, ContractOptions, EventData, PastEventOptions } from "web3-eth-contract";
+declare type ExtractMethods<A extends any[number]> = A extends {
+    type: "function";
+} ? A["name"] : never;
+declare type ExtractEvents<A extends any[number]> = A extends {
+    type: "event";
+} ? A["name"] : never;
+declare type TypeOrInternalType<T> = T["internalType"] extends unknown ? T["type"] : T["internalType"];
+declare type MapTypeToJS<L, C> = L extends "address" | "uint256" | "uint128" | "uint8" | "string" | "bytes32" ? string : L extends "bool" ? boolean : L extends "tuple" ? TuplifyUnion<C[number], C[number]["name"]> : unknown;
+declare type ExtractFromObj<R extends any[number] & {
+    type: "function";
+}> = {
+    [K in R["outputs"][number]["name"]]: MapTypeToJS<TypeOrInternalType<R["outputs"][number] & {
+        name: K;
+    }>, (R["outputs"][number] & {
+        name: K;
+    })["components"]>;
+};
+export declare type ExtractMethodDefinition<A extends any, N extends (any[number] & {
+    type: "function";
+})["name"], R = A[number] & {
+    type: "function";
+    name: N;
+}> = (...args: TuplifyUnion<(A[number] & {
+    type: "function";
+    name: N;
+})["inputs"][number], (A[number] & {
+    type: "function";
+    name: N;
+})["inputs"][number]["name"]>) => {
+    call: () => Promise<R extends {
+        outputs: {
+            length: 1;
+        };
+    } ? MapTypeToJS<TypeOrInternalType<R["outputs"][0]>, R["outputs"][0]["components"]> : R extends {
+        outputs: any;
+    } ? ExtractFromObj<R> : void>;
+    send: (prop: {
+        from: string;
+        maxPriorityFeePerGas?: number;
+        gas?: number;
+        gasPrice?: string;
+    }) => Promise<void>;
+};
+declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+declare type LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends () => infer R ? R : never;
+declare type Push<T extends any[], V> = [...T, V];
+export declare type TuplifyUnion<FUNCS, T, L = LastOf<T>, N = [T] extends [never] ? true : false> = true extends N ? [] : Push<TuplifyUnion<FUNCS, Exclude<T, L>>, MapTypeToJS<TypeOrInternalType<FUNCS & {
+    name: L;
+}>, (FUNCS & {
+    name: L;
+})["components"]>>;
+export declare class GenericContract<A extends any = any, E extends string = ExtractEvents<A[number]> | "allEvents"> extends Contract {
+    events: Exclude<E, "allEvents">;
+    constructor(jsonInterface: A, address?: string, options?: ContractOptions);
+    methods: {
+        [k in ExtractMethods<A[number]>]: ExtractMethodDefinition<A, k>;
+    };
+    getPastEvents(event: E): Promise<GenericEventData<A>[]>;
+    getPastEvents(event: E, options: PastEventOptions, callback: (error: Error, event: EventData) => void): Promise<GenericEventData<A>[]>;
+    getPastEvents(event: E, options: PastEventOptions): Promise<GenericEventData<A>[]>;
+    getPastEvents(event: E, callback: (error: Error, event: EventData) => void): Promise<GenericEventData<A>[]>;
+}
+export declare type GenericEventData<E extends any> = EventData & GenericEvent<E>;
+declare type ABIEvent = any[number] & {
+    type: "event";
+};
+declare type GenericEvent<ABI extends any, E extends string = ExtractEvents<ABI[number]>> = {
+    event: E;
+    returnValues: ExtractReturnValues<ABIEvent & {
+        name: E;
+    }>;
+};
+declare type ExtractReturnValues<E extends ABIEvent> = ExtractInputType<E["inputs"][number]>;
+declare type ExtractInputType<I extends ABIEvent["inputs"][number]> = {
+    [k in I["name"]]: MapTypeToJS<TypeOrInternalType<I>, I["components"]>;
+};
+export {};

package/dist/types/contract.js

@@ -0,0 +1,32 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+exports.__esModule = true;
+exports.GenericContract = void 0;
+// @ts-nocheck
+var web3_eth_contract_1 = require("web3-eth-contract");
+var GenericContract = /** @class */ (function (_super) {
+    __extends(GenericContract, _super);
+    function GenericContract(jsonInterface, address, options) {
+        return _super.call(this, jsonInterface, address, options) || this;
+    }
+    GenericContract.prototype.getPastEvents = function (event, options, callback) {
+        return _super.prototype.getPastEvents.call(this, event, options, callback);
+    };
+    return GenericContract;
+}(web3_eth_contract_1.Contract));
+exports.GenericContract = GenericContract;
+//# sourceMappingURL=contract.js.map

package/dist/types/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../src/types/contract.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,cAAc;AACd,uDAK2B;AAkH3B;IAGU,mCAAQ;IAEhB,yBAAY,aAAgB,EAAE,OAAgB,EAAE,OAAyB;eACvE,kBAAM,aAAqC,EAAE,OAAO,EAAE,OAAO,CAAC;IAChE,CAAC;IAkBQ,uCAAa,GAAtB,UACE,KAAU,EACV,OAAa,EACb,QAAc;QAEd,OAAO,iBAAM,aAAa,YAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAQ,CAAC;IAC9D,CAAC;IACH,sBAAC;AAAD,CAAC,AAhCD,CAGU,4BAAQ,GA6BjB;AAhCY,0CAAe"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@muritavo/testing-toolkit",
+  "version": "0.0.1",
+  "description": "A series of functions to help with testing",
+  "main": "index.js",
+  "files": ["./dist"],
+  "scripts": {
+    "dev": "tsc --watch",
+    "prepack": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Muritavo/testing-toolkit.git"
+  },
+  "author": "Murilo Oliveira de Araujo",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Muritavo/testing-toolkit/issues"
+  },
+  "homepage": "https://github.com/Muritavo/testing-toolkit#readme",
+  "devDependencies": {
+    "firebase": "^9.10.0",
+    "web3": "^1.8.0"
+  },
+  "dependencies": {
+    "@firebase/rules-unit-testing": "^2.0.4",
+    "@types/node-fetch": "^2.6.2",
+    "node-fetch": "^1",
+    "typescript": "^4.8.4"
+  }
+}