@conduitplatform/module-tools 0.16.0-alpha.7

package/README.mdx

@@ -0,0 +1,18 @@
+# Conduit Module Tools
+
+This library provides a framework to build micro-services in NodeJS that can be used with the Conduit platform.
+
+## Build Steps
+
+- run npm build
+
+## Features ✔️
+
+- Service registration & discovery
+- Application route registration
+- Administrative route registration
+- Provides wrappers for gRPC handlers to support async
+- Parses incoming requests and outgoing responses to JSON
+- Provides health check service out of the box
+- Manages the gRPC server so you don't have to
+- Provides classes to facilitate building your own Conduit modules

package/dist/ManagedModule.d.ts

@@ -0,0 +1,79 @@
+import { ConduitServiceModule } from './classes';
+import convict from 'convict';
+import { ConduitService } from './interfaces';
+import { GrpcRequest, GrpcResponse, SetConfigRequest, SetConfigResponse } from '@conduitplatform/grpc-sdk';
+export declare abstract class ManagedModule<T> extends ConduitServiceModule {
+    readonly config?: convict.Config<T>;
+    configOverride: boolean;
+    service?: ConduitService;
+    protected abstract readonly configSchema?: object;
+    protected abstract readonly metricsSchema?: object;
+    private readonly serviceAddress;
+    private readonly servicePort;
+    protected constructor(moduleName: string);
+    get name(): string;
+    get address(): string;
+    start(): Promise<void>;
+    /**
+     * This is the first function triggered on module spin up.
+     * @param address {string} external address:port of service (LoadBalancer)
+     * @param port {string} port to bring up gRPC service
+     */
+    initialize(address: string, port: string): void;
+    /**
+     * This is triggered before spinning up the Grpc Server
+     * of the module. On this stage, the redis bus and state have
+     * not yet been initialized, and only communications with Conduit core
+     * have been established.
+     */
+    preServerStart(): Promise<void>;
+    /**
+     * This is triggered right after Grpc Server start.
+     * At this stage the core module will communicate with your service
+     * for health checks, and the Bus and State management mechanics
+     * are online and available.
+     */
+    onServerStart(): Promise<void>;
+    /**
+     * Triggers right before registering the module with Conduit Core.
+     */
+    preRegister(): Promise<void>;
+    /**
+     * Triggers when module has been registered with Conduit Core
+     * This is the step where you should initialize your
+     * module's general routing (admin or client) and any other operation,
+     * that would require other modules being able to reach you
+     */
+    onRegister(): Promise<void>;
+    /**
+     * This is triggered when the module receives new configuration.
+     * At this step the configuration has not been checked yet,
+     * and has only been parsed.
+     * @param config
+     */
+    preConfig(config: T): Promise<T>;
+    /**
+     * This is triggered when new configuration has been applied.
+     * This happens either when changes are being made on the configuration,
+     * or on module start up, where the config is recovered from the database.
+     * In either case the configuration is now available through the
+     * Config Controller of the sdk.
+     */
+    onConfig(): Promise<void>;
+    /**
+     * Registers common and module-specific metric types.
+     */
+    registerMetrics(): Promise<void>;
+    /**
+     * Initializes metric startup values.
+     * Implemented by individual modules.
+     */
+    initializeMetrics(): Promise<void>;
+    createGrpcServer(): Promise<void>;
+    startGrpcServer(): Promise<void>;
+    setConfig(call: GrpcRequest<SetConfigRequest>, callback: GrpcResponse<SetConfigResponse>): Promise<void>;
+    /** Used to update the module's configuration on initial Redis/DB reconciliation. */
+    handleConfigSyncUpdate(): Promise<void>;
+    private preRegisterLifecycle;
+    private postRegisterLifecycle;
+}

package/dist/ManagedModule.js

@@ -0,0 +1,433 @@
+"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 __());
+    };
+})();
+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 };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManagedModule = void 0;
+var classes_1 = require("./classes");
+var lodash_1 = require("lodash");
+var grpc_js_1 = require("@grpc/grpc-js");
+var convict_1 = __importDefault(require("convict"));
+var grpc_sdk_1 = __importDefault(require("@conduitplatform/grpc-sdk"));
+var utilities_1 = require("./utilities");
+var convictConfigParser_1 = require("./utilities/convictConfigParser");
+var initializeSdk_1 = require("./utilities/initializeSdk");
+var ManagedModule = /** @class */ (function (_super) {
+    __extends(ManagedModule, _super);
+    function ManagedModule(moduleName) {
+        var _this = this;
+        var _a;
+        _this = _super.call(this, moduleName) || this;
+        _this.configOverride = false;
+        if (!process.env.CONDUIT_SERVER) {
+            throw new Error('CONDUIT_SERVER is undefined, specify Conduit server URL');
+        }
+        _this.servicePort = (_a = process.env.GRPC_PORT) !== null && _a !== void 0 ? _a : '5000';
+        _this.serviceAddress =
+            // @compat (v0.15): SERVICE_IP -> SERVICE_URL
+            process.env.SERVICE_URL || process.env.SERVICE_IP || '0.0.0.0:' + _this.servicePort;
+        try {
+            _this.grpcSdk = (0, initializeSdk_1.initializeSdk)(process.env.CONDUIT_SERVER, _this.name, true, function () {
+                return _this.healthState;
+            });
+        }
+        catch (e) {
+            throw new Error('Failed to initialize grpcSdk');
+        }
+        return _this;
+    }
+    Object.defineProperty(ManagedModule.prototype, "name", {
+        get: function () {
+            return this._moduleName;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ManagedModule.prototype, "address", {
+        get: function () {
+            return this._address;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    ManagedModule.prototype.start = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var err_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.grpcSdk.initialize()];
+                    case 1:
+                        _a.sent();
+                        this.initialize(this.serviceAddress, this.servicePort);
+                        _a.label = 2;
+                    case 2:
+                        _a.trys.push([2, 5, , 6]);
+                        return [4 /*yield*/, this.preRegisterLifecycle()];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, this.grpcSdk.config.registerModule(this.name, this.address, this.healthState)];
+                    case 4:
+                        _a.sent();
+                        return [3 /*break*/, 6];
+                    case 5:
+                        err_1 = _a.sent();
+                        grpc_sdk_1.default.Logger.error('Failed to initialize server');
+                        grpc_sdk_1.default.Logger.error(err_1);
+                        process.exit(-1);
+                        return [3 /*break*/, 6];
+                    case 6: return [4 /*yield*/, this.postRegisterLifecycle().catch(function (err) {
+                            grpc_sdk_1.default.Logger.error('Failed to activate module');
+                            grpc_sdk_1.default.Logger.error(err);
+                            process.exit(-1);
+                        })];
+                    case 7:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * This is the first function triggered on module spin up.
+     * @param address {string} external address:port of service (LoadBalancer)
+     * @param port {string} port to bring up gRPC service
+     */
+    ManagedModule.prototype.initialize = function (address, port) {
+        this._address = address;
+        this._port = port;
+        if (this.configSchema) {
+            this.config = (0, convict_1.default)(this.configSchema);
+        }
+    };
+    /**
+     * This is triggered before spinning up the Grpc Server
+     * of the module. On this stage, the redis bus and state have
+     * not yet been initialized, and only communications with Conduit core
+     * have been established.
+     */
+    ManagedModule.prototype.preServerStart = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    /**
+     * This is triggered right after Grpc Server start.
+     * At this stage the core module will communicate with your service
+     * for health checks, and the Bus and State management mechanics
+     * are online and available.
+     */
+    ManagedModule.prototype.onServerStart = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    /**
+     * Triggers right before registering the module with Conduit Core.
+     */
+    ManagedModule.prototype.preRegister = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    /**
+     * Triggers when module has been registered with Conduit Core
+     * This is the step where you should initialize your
+     * module's general routing (admin or client) and any other operation,
+     * that would require other modules being able to reach you
+     */
+    ManagedModule.prototype.onRegister = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    /**
+     * This is triggered when the module receives new configuration.
+     * At this step the configuration has not been checked yet,
+     * and has only been parsed.
+     * @param config
+     */
+    ManagedModule.prototype.preConfig = function (config) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, config];
+            });
+        });
+    };
+    /**
+     * This is triggered when new configuration has been applied.
+     * This happens either when changes are being made on the configuration,
+     * or on module start up, where the config is recovered from the database.
+     * In either case the configuration is now available through the
+     * Config Controller of the sdk.
+     */
+    ManagedModule.prototype.onConfig = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    /**
+     * Registers common and module-specific metric types.
+     */
+    ManagedModule.prototype.registerMetrics = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                if (grpc_sdk_1.default.Metrics) {
+                    grpc_sdk_1.default.Metrics.initializeDefaultMetrics();
+                    if (this.metricsSchema) {
+                        Object.values(this.metricsSchema).forEach(function (metric) {
+                            grpc_sdk_1.default.Metrics.registerMetric(metric.type, metric.config);
+                        });
+                    }
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    /**
+     * Initializes metric startup values.
+     * Implemented by individual modules.
+     */
+    ManagedModule.prototype.initializeMetrics = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    ManagedModule.prototype.createGrpcServer = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        this.grpcServer = new classes_1.GrpcServer(this._port);
+                        _a = this;
+                        return [4 /*yield*/, this.grpcServer.createNewServer()];
+                    case 1:
+                        _a._port = (_b.sent()).toString();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    ManagedModule.prototype.startGrpcServer = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.service) return [3 /*break*/, 2];
+                        this._serviceName = this.service.protoDescription.substring(this.service.protoDescription.indexOf('.') + 1);
+                        return [4 /*yield*/, this.grpcServer.addService(this.service.protoPath, this.service.protoDescription, this.service.functions)];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.addHealthCheckService()];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, this.addModuleService()];
+                    case 4:
+                        _a.sent();
+                        return [4 /*yield*/, this.grpcServer.start()];
+                    case 5:
+                        _a.sent();
+                        grpc_sdk_1.default.Logger.log('gRPC server listening on ' + this._port);
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    ManagedModule.prototype.setConfig = function (call, callback) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var config, previousConfig, e_1;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _b.trys.push([0, 3, , 4]);
+                        if (!this.config) {
+                            return [2 /*return*/, callback({
+                                    code: grpc_js_1.status.INVALID_ARGUMENT,
+                                    message: 'Module is not configurable',
+                                })];
+                        }
+                        config = JSON.parse(call.request.newConfig);
+                        config = (0, utilities_1.merge)(this.config.getProperties(), config);
+                        return [4 /*yield*/, this.preConfig(config)];
+                    case 1:
+                        config = _b.sent();
+                        previousConfig = this.config.getProperties();
+                        try {
+                            this.config.load(config).validate({
+                                allowed: 'warn',
+                            });
+                            config = this.config.getProperties();
+                            callback(null, { updatedConfig: JSON.stringify(config) });
+                        }
+                        catch (e) {
+                            this.config = (0, convict_1.default)(this.configSchema);
+                            this.config.load(previousConfig);
+                            return [2 /*return*/, callback({
+                                    code: grpc_js_1.status.INVALID_ARGUMENT,
+                                    message: 'Invalid configuration values: ' + e.message,
+                                })];
+                        }
+                        classes_1.ConfigController.getInstance().config = config;
+                        return [4 /*yield*/, this.onConfig()];
+                    case 2:
+                        _b.sent();
+                        (_a = this.grpcSdk.bus) === null || _a === void 0 ? void 0 : _a.publish((0, lodash_1.kebabCase)(this.name) + ':config:update', JSON.stringify(config));
+                        return [3 /*break*/, 4];
+                    case 3:
+                        e_1 = _b.sent();
+                        return [2 /*return*/, callback({ code: grpc_js_1.status.INTERNAL, message: e_1.message })];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /** Used to update the module's configuration on initial Redis/DB reconciliation. */
+    ManagedModule.prototype.handleConfigSyncUpdate = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                if (!this.config)
+                    return [2 /*return*/];
+                this.grpcSdk.bus.subscribe("".concat(this.name, ":config:update"), function (message) { return __awaiter(_this, void 0, void 0, function () {
+                    var _a;
+                    return __generator(this, function (_b) {
+                        switch (_b.label) {
+                            case 0:
+                                _a = classes_1.ConfigController.getInstance();
+                                return [4 /*yield*/, this.preConfig(JSON.parse(message))];
+                            case 1:
+                                _a.config = _b.sent();
+                                return [4 /*yield*/, this.onConfig()];
+                            case 2:
+                                _b.sent();
+                                return [2 /*return*/];
+                        }
+                    });
+                }); });
+                return [2 /*return*/];
+            });
+        });
+    };
+    ManagedModule.prototype.preRegisterLifecycle = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.createGrpcServer()];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, this.preServerStart()];
+                    case 2:
+                        _a.sent();
+                        return [4 /*yield*/, this.grpcSdk.initializeEventBus()];
+                    case 3:
+                        _a.sent();
+                        return [4 /*yield*/, this.handleConfigSyncUpdate()];
+                    case 4:
+                        _a.sent();
+                        return [4 /*yield*/, this.registerMetrics()];
+                    case 5:
+                        _a.sent();
+                        return [4 /*yield*/, this.startGrpcServer()];
+                    case 6:
+                        _a.sent();
+                        return [4 /*yield*/, this.onServerStart()];
+                    case 7:
+                        _a.sent();
+                        return [4 /*yield*/, this.initializeMetrics()];
+                    case 8:
+                        _a.sent();
+                        return [4 /*yield*/, this.preRegister()];
+                    case 9:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    ManagedModule.prototype.postRegisterLifecycle = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var configSchema, config;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.onRegister()];
+                    case 1:
+                        _a.sent();
+                        if (!this.config) return [3 /*break*/, 5];
+                        configSchema = this.config.getSchema();
+                        config = this.config.getProperties();
+                        return [4 /*yield*/, this.preConfig(config)];
+                    case 2:
+                        config = _a.sent();
+                        return [4 /*yield*/, this.grpcSdk.config.configure(config, (0, convictConfigParser_1.convictConfigParser)(configSchema), this.configOverride)];
+                    case 3:
+                        config = _a.sent();
+                        classes_1.ConfigController.getInstance();
+                        if (config)
+                            classes_1.ConfigController.getInstance().config = config;
+                        if (!(!config || config.active || !config.hasOwnProperty('active'))) return [3 /*break*/, 5];
+                        return [4 /*yield*/, this.onConfig()];
+                    case 4:
+                        _a.sent();
+                        _a.label = 5;
+                    case 5: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return ManagedModule;
+}(classes_1.ConduitServiceModule));
+exports.ManagedModule = ManagedModule;
+//# sourceMappingURL=ManagedModule.js.map

package/dist/ManagedModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManagedModule.js","sourceRoot":"","sources":["../src/ManagedModule.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAA+E;AAC/E,iCAAmC;AACnC,yCAAuC;AACvC,oDAA8B;AAE9B,uEAKmC;AACnC,yCAAoC;AACpC,uEAAsE;AACtE,2DAA0D;AAE1D;IAA+C,iCAAoB;IASjE,uBAAsB,UAAkB;QAAxC,iBAgBC;;gBAfC,kBAAM,UAAU,CAAC;QARnB,oBAAc,GAAY,KAAK,CAAC;QAS9B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YAC/B,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;SAC5E;QACD,KAAI,CAAC,WAAW,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,SAAS,mCAAI,MAAM,CAAC;QACnD,KAAI,CAAC,cAAc;YACjB,6CAA6C;YAC7C,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,UAAU,GAAG,KAAI,CAAC,WAAW,CAAC;QACrF,IAAI;YACF,KAAI,CAAC,OAAO,GAAG,IAAA,6BAAa,EAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,KAAI,CAAC,IAAI,EAAE,IAAI,EAAE;gBACxE,OAAO,KAAI,CAAC,WAAW,CAAC;YAC1B,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;;IACH,CAAC;IAED,sBAAI,+BAAI;aAAR;YACE,OAAO,IAAI,CAAC,WAAW,CAAC;QAC1B,CAAC;;;OAAA;IAED,sBAAI,kCAAO;aAAX;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;;;OAAA;IAEK,6BAAK,GAAX;;;;;4BACE,qBAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAA;;wBAA/B,SAA+B,CAAC;wBAChC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;;;;wBAErD,qBAAM,IAAI,CAAC,oBAAoB,EAAE,EAAA;;wBAAjC,SAAiC,CAAC;wBAClC,qBAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,EAAA;;wBAAnF,SAAmF,CAAC;;;;wBAEpF,kBAAc,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;wBAC3D,kBAAc,CAAC,MAAM,CAAC,KAAK,CAAC,KAAY,CAAC,CAAC;wBAC1C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;;4BAEnB,qBAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC,KAAK,CAAC,UAAC,GAAU;4BAClD,kBAAc,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;4BACzD,kBAAc,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;4BACjC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;wBACnB,CAAC,CAAC,EAAA;;wBAJF,SAIE,CAAC;;;;;KACJ;IAED;;;;OAIG;IACH,kCAAU,GAAV,UAAW,OAAe,EAAE,IAAY;QACtC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,IAAI,CAAC,YAAY,EAAE;YACpB,IAAI,CAAC,MAAkB,GAAG,IAAA,iBAAO,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SACvD;IACH,CAAC;IAED;;;;;OAKG;IACG,sCAAc,GAApB;;;;KAAyB;IAEzB;;;;;OAKG;IACG,qCAAa,GAAnB;;;;KAAwB;IAExB;;OAEG;IACG,mCAAW,GAAjB;;;;KAAsB;IAEtB;;;;;OAKG;IACG,kCAAU,GAAhB;;;;KAAqB;IAErB;;;;;OAKG;IACG,iCAAS,GAAf,UAAgB,MAAS;;;gBACvB,sBAAO,MAAM,EAAC;;;KACf;IAED;;;;;;OAMG;IACG,gCAAQ,GAAd;;;;KAAmB;IAEnB;;OAEG;IACG,uCAAe,GAArB;;;gBACE,IAAI,kBAAc,CAAC,OAAO,EAAE;oBAC1B,kBAAc,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC;oBAClD,IAAI,IAAI,CAAC,aAAa,EAAE;wBACtB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,UAAA,MAAM;4BAC9C,kBAAc,CAAC,OAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;wBACrE,CAAC,CAAC,CAAC;qBACJ;iBACF;;;;KACF;IAED;;;OAGG;IACG,yCAAiB,GAAvB;;;;KAA4B;IAEtB,wCAAgB,GAAtB;;;;;;wBACE,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;wBAC7C,KAAA,IAAI,CAAA;wBAAU,qBAAM,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,EAAA;;wBAArD,GAAK,KAAK,GAAG,CAAC,SAAuC,CAAC,CAAC,QAAQ,EAAE,CAAC;;;;;KACnE;IAEK,uCAAe,GAArB;;;;;6BACM,IAAI,CAAC,OAAO,EAAZ,wBAAY;wBACd,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,SAAS,CACzD,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAC/C,CAAC;wBACF,qBAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAC9B,IAAI,CAAC,OAAO,CAAC,SAAS,EACtB,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAC7B,IAAI,CAAC,OAAO,CAAC,SAAS,CACvB,EAAA;;wBAJD,SAIC,CAAC;;4BAEJ,qBAAM,IAAI,CAAC,qBAAqB,EAAE,EAAA;;wBAAlC,SAAkC,CAAC;wBACnC,qBAAM,IAAI,CAAC,gBAAgB,EAAE,EAAA;;wBAA7B,SAA6B,CAAC;wBAC9B,qBAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,EAAA;;wBAA7B,SAA6B,CAAC;wBAC9B,kBAAc,CAAC,MAAM,CAAC,GAAG,CAAC,2BAA2B,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;;;;;KACrE;IAEK,iCAAS,GAAf,UACE,IAAmC,EACnC,QAAyC;;;;;;;;wBAGvC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;4BAChB,sBAAO,QAAQ,CAAC;oCACd,IAAI,EAAE,gBAAM,CAAC,gBAAgB;oCAC7B,OAAO,EAAE,4BAA4B;iCACtC,CAAC,EAAC;yBACJ;wBACG,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;wBAChD,MAAM,GAAG,IAAA,iBAAK,EAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,MAAM,CAAC,CAAC;wBAC3C,qBAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAA;;wBAArC,MAAM,GAAG,SAA4B,CAAC;wBAChC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;wBACnD,IAAI;4BACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC;gCAChC,OAAO,EAAE,MAAM;6BAChB,CAAC,CAAC;4BACH,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;4BACrC,QAAQ,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;yBAC3D;wBAAC,OAAO,CAAC,EAAE;4BACT,IAAI,CAAC,MAAkB,GAAG,IAAA,iBAAO,EAAC,IAAI,CAAC,YAAa,CAAC,CAAC;4BACvD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;4BACjC,sBAAO,QAAQ,CAAC;oCACd,IAAI,EAAE,gBAAM,CAAC,gBAAgB;oCAC7B,OAAO,EAAE,gCAAgC,GAAI,CAAW,CAAC,OAAO;iCACjE,CAAC,EAAC;yBACJ;wBACD,0BAAgB,CAAC,WAAW,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;wBAC/C,qBAAM,IAAI,CAAC,QAAQ,EAAE,EAAA;;wBAArB,SAAqB,CAAC;wBACtB,MAAA,IAAI,CAAC,OAAO,CAAC,GAAG,0CAAE,OAAO,CACvB,IAAA,kBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAgB,EACvC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CACvB,CAAC;;;;wBAEF,sBAAO,QAAQ,CAAC,EAAE,IAAI,EAAE,gBAAM,CAAC,QAAQ,EAAE,OAAO,EAAG,GAAW,CAAC,OAAO,EAAE,CAAC,EAAC;;;;;KAE7E;IAED,oFAAoF;IAC9E,8CAAsB,GAA5B;;;;gBACE,IAAI,CAAC,IAAI,CAAC,MAAM;oBAAE,sBAAO;gBACzB,IAAI,CAAC,OAAO,CAAC,GAAI,CAAC,SAAS,CAAC,UAAG,IAAI,CAAC,IAAI,mBAAgB,EAAE,UAAO,OAAe;;;;;gCAC9E,KAAA,0BAAgB,CAAC,WAAW,EAAE,CAAA;gCAAU,qBAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAA;;gCAAjF,GAA+B,MAAM,GAAG,SAAyC,CAAC;gCAClF,qBAAM,IAAI,CAAC,QAAQ,EAAE,EAAA;;gCAArB,SAAqB,CAAC;;;;qBACvB,CAAC,CAAC;;;;KACJ;IAEa,4CAAoB,GAAlC;;;;4BACE,qBAAM,IAAI,CAAC,gBAAgB,EAAE,EAAA;;wBAA7B,SAA6B,CAAC;wBAC9B,qBAAM,IAAI,CAAC,cAAc,EAAE,EAAA;;wBAA3B,SAA2B,CAAC;wBAC5B,qBAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAA;;wBAAvC,SAAuC,CAAC;wBACxC,qBAAM,IAAI,CAAC,sBAAsB,EAAE,EAAA;;wBAAnC,SAAmC,CAAC;wBACpC,qBAAM,IAAI,CAAC,eAAe,EAAE,EAAA;;wBAA5B,SAA4B,CAAC;wBAC7B,qBAAM,IAAI,CAAC,eAAe,EAAE,EAAA;;wBAA5B,SAA4B,CAAC;wBAC7B,qBAAM,IAAI,CAAC,aAAa,EAAE,EAAA;;wBAA1B,SAA0B,CAAC;wBAC3B,qBAAM,IAAI,CAAC,iBAAiB,EAAE,EAAA;;wBAA9B,SAA8B,CAAC;wBAC/B,qBAAM,IAAI,CAAC,WAAW,EAAE,EAAA;;wBAAxB,SAAwB,CAAC;;;;;KAC1B;IAEa,6CAAqB,GAAnC;;;;;4BACE,qBAAM,IAAI,CAAC,UAAU,EAAE,EAAA;;wBAAvB,SAAuB,CAAC;6BACpB,IAAI,CAAC,MAAM,EAAX,wBAAW;wBACP,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;wBAEzC,MAAM,GAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;wBACrC,qBAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAA;;wBAArC,MAAM,GAAG,SAA4B,CAAC;wBAE7B,qBAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAC1C,MAAM,EACN,IAAA,yCAAmB,EAAC,YAAY,CAAC,EACjC,IAAI,CAAC,cAAc,CACpB,EAAA;;wBAJD,MAAM,GAAG,SAIR,CAAC;wBAEF,0BAAgB,CAAC,WAAW,EAAE,CAAC;wBAC/B,IAAI,MAAM;4BAAE,0BAAgB,CAAC,WAAW,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;6BACvD,CAAA,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAA,EAA5D,wBAA4D;wBAC9D,qBAAM,IAAI,CAAC,QAAQ,EAAE,EAAA;;wBAArB,SAAqB,CAAC;;;;;;KAE3B;IACH,oBAAC;AAAD,CAAC,AA7OD,CAA+C,8BAAoB,GA6OlE;AA7OqB,sCAAa"}

package/dist/classes/ConduitActiveSchema.d.ts

@@ -0,0 +1,16 @@
+import { ConduitModel, ConduitSchema, ConduitSchemaOptions, DatabaseProvider, Query } from '@conduitplatform/grpc-sdk';
+export declare class ConduitActiveSchema<T> extends ConduitSchema {
+    private readonly dbInstance;
+    constructor(dbInstance: DatabaseProvider, name: string, fields?: ConduitModel, modelOptions?: ConduitSchemaOptions, collectionName?: string);
+    findOne(query: Query<T>, select?: string, populate?: string | string[]): Promise<T | null>;
+    findMany(query: Query<T>, select?: string, skip?: number, limit?: number, sort?: {
+        [field: string]: -1 | 1;
+    } | string[] | string, populate?: string | string[]): Promise<T[]>;
+    create(query: Query<T>): Promise<T>;
+    createMany(query: Query<T>[]): Promise<T[]>;
+    findByIdAndUpdate(id: string, document: Query<T>, populate?: string | string[]): Promise<T | null>;
+    updateMany(filterQuery: Query<T>, query: Query<T>, populate?: string | string[]): Promise<any>;
+    deleteOne(query: Query<T>): Promise<any>;
+    deleteMany(query: Query<T>): Promise<any>;
+    countDocuments(query: Query<T>): Promise<number>;
+}

package/dist/classes/ConduitActiveSchema.js

@@ -0,0 +1,57 @@
+"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 __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConduitActiveSchema = void 0;
+var grpc_sdk_1 = require("@conduitplatform/grpc-sdk");
+var ConduitActiveSchema = /** @class */ (function (_super) {
+    __extends(ConduitActiveSchema, _super);
+    function ConduitActiveSchema(dbInstance, name, fields, modelOptions, collectionName) {
+        var _this = _super.call(this, name, fields !== null && fields !== void 0 ? fields : {}, modelOptions, collectionName) || this;
+        _this.dbInstance = dbInstance;
+        return _this;
+    }
+    ConduitActiveSchema.prototype.findOne = function (query, select, populate) {
+        return this.dbInstance.findOne(this.name, query, select, populate);
+    };
+    ConduitActiveSchema.prototype.findMany = function (query, select, skip, limit, sort, populate) {
+        return this.dbInstance.findMany(this.name, query, select, skip, limit, sort, populate);
+    };
+    ConduitActiveSchema.prototype.create = function (query) {
+        return this.dbInstance.create(this.name, query);
+    };
+    ConduitActiveSchema.prototype.createMany = function (query) {
+        return this.dbInstance.createMany(this.name, query);
+    };
+    ConduitActiveSchema.prototype.findByIdAndUpdate = function (id, document, populate) {
+        return this.dbInstance.findByIdAndUpdate(this.name, id, document, populate);
+    };
+    ConduitActiveSchema.prototype.updateMany = function (filterQuery, query, populate) {
+        return this.dbInstance.updateMany(this.name, filterQuery, query, populate);
+    };
+    ConduitActiveSchema.prototype.deleteOne = function (query) {
+        return this.dbInstance.deleteOne(this.name, query);
+    };
+    ConduitActiveSchema.prototype.deleteMany = function (query) {
+        return this.dbInstance.deleteMany(this.name, query);
+    };
+    ConduitActiveSchema.prototype.countDocuments = function (query) {
+        return this.dbInstance.countDocuments(this.name, query);
+    };
+    return ConduitActiveSchema;
+}(grpc_sdk_1.ConduitSchema));
+exports.ConduitActiveSchema = ConduitActiveSchema;
+//# sourceMappingURL=ConduitActiveSchema.js.map

package/dist/classes/ConduitActiveSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConduitActiveSchema.js","sourceRoot":"","sources":["../../src/classes/ConduitActiveSchema.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,sDAMmC;AAEnC;IAA4C,uCAAa;IAGvD,6BACE,UAA4B,EAC5B,IAAY,EACZ,MAAqB,EACrB,YAAmC,EACnC,cAAuB;QALzB,YAOE,kBAAM,IAAI,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,EAAE,YAAY,EAAE,cAAc,CAAC,SAExD;QADC,KAAI,CAAC,UAAU,GAAG,UAAU,CAAC;;IAC/B,CAAC;IAED,qCAAO,GAAP,UACE,KAAe,EACf,MAAe,EACf,QAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,sCAAQ,GAAR,UACE,KAAe,EACf,MAAe,EACf,IAAa,EACb,KAAc,EACd,IAAsD,EACtD,QAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAC7B,IAAI,CAAC,IAAI,EACT,KAAK,EACL,MAAM,EACN,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,oCAAM,GAAN,UAAO,KAAe;QACpB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAI,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,wCAAU,GAAV,UAAW,KAAiB;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAI,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACzD,CAAC;IAED,+CAAiB,GAAjB,UACE,EAAU,EACV,QAAkB,EAClB,QAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAI,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACjF,CAAC;IAED,wCAAU,GAAV,UAAW,WAAqB,EAAE,KAAe,EAAE,QAA4B;QAC7E,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC7E,CAAC;IAED,uCAAS,GAAT,UAAU,KAAe;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,wCAAU,GAAV,UAAW,KAAe;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED,4CAAc,GAAd,UAAe,KAAe;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IACH,0BAAC;AAAD,CAAC,AAxED,CAA4C,wBAAa,GAwExD;AAxEY,kDAAmB"}

package/dist/classes/ConduitServiceModule.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { ServerWritableStream } from '@grpc/grpc-js';
+import { GrpcServer } from './GrpcServer';
+import ConduitGrpcSdk, { GrpcCallback, GrpcRequest, GrpcResponse, HealthCheckRequest, HealthCheckResponse, HealthCheckStatus, SetConfigRequest, SetConfigResponse } from '@conduitplatform/grpc-sdk';
+export declare abstract class ConduitServiceModule {
+    protected readonly _moduleName: string;
+    protected _serviceName?: string;
+    protected _address: string;
+    protected grpcServer: GrpcServer;
+    protected readonly events: EventEmitter;
+    private _serviceHealthState;
+    protected constructor(moduleName: string);
+    protected _port: string;
+    get port(): string;
+    private _grpcSdk;
+    get grpcSdk(): ConduitGrpcSdk;
+    set grpcSdk(grpcSdk: ConduitGrpcSdk);
+    get healthState(): HealthCheckStatus;
+    updateHealth(state: HealthCheckStatus, init?: boolean): void;
+    healthCheck(call: GrpcRequest<HealthCheckRequest>, callback: GrpcCallback<HealthCheckResponse>): void;
+    healthWatch(call: ServerWritableStream<HealthCheckRequest, HealthCheckResponse>): void;
+    abstract setConfig(call: GrpcRequest<SetConfigRequest>, callback: GrpcResponse<SetConfigResponse>): Promise<void>;
+    protected addHealthCheckService(): Promise<void>;
+    protected addModuleService(): Promise<void>;
+}