@nsshunt/stsappframework 3.1.149 → 3.1.151

package/types/processoptions.d.ts

@@ -1,128 +0,0 @@
-import express from 'express';
-import { IProcessBase, IServiceProcessContext } from './commonTypes';
-import { ISTSLogger } from '@nsshunt/stsutils';
-export interface STSExpressServer {
-    get App(): express.Express;
-}
-/**
- * Factory method that adds express routes to the express app object.
- */
-export type ExpressRouteFactory = (app: express.Express, stsApp: IProcessBase) => void;
-export declare enum STSServerType {
-    NONE = "NONE",
-    EXPRESS = "EXPRESS",
-    EXPRESS_TLS = "EXPRESS_TLS",
-    TCPRAW_TLS = "TCPRAW_TLS",
-    JSONRPC2_TLS = "JSONRPC_TLS"
-}
-export interface ProcessOptions {
-    /**
- * Is this service worker the master worker (thread).
- */
-    isMaster: boolean;
-    /**
-     * Unique service instance ID (uuidv4).
-     */
-    serviceInstanceId: string;
-    serverType: STSServerType;
-    /**
-     * HTTPS service public key path.
-     */
-    httpsServerKeyPath: string;
-    /**
-     * HTTPS service certificate (private key) path.
-     */
-    httpsServerCertificatePath: string;
-    /**
-     * Determines whether the process will explicitly exit (using code 0) when any terminate signal is received.
-     */
-    processExitOnTerminate: boolean;
-    /**
-     * Does this service run a Web Socket Server (wss).
-     */
-    wssServer: boolean;
-    /**
-     * Service Prometheus metric support.
-     */
-    prometheusSupport: boolean;
-    /**
-     * Service endpoint (without trailing /). Example: https://localhost
-     */
-    endpoint: string;
-    /**
-     * Service API root (without trailing /). Example: /stsrest01/v1
-     */
-    apiRoot: string;
-    /**
-     * Service listen port. Example: 3001.
-     * Note that unix domain sockets are also supported. Example: /tmp/stsrest01.sock.
-     * The socket file may also need permissions changed, i.e. chmodSync(port, 511); or chmodSync(port, 777);
-     * Axios client calls will also need to use socketPath. Example:  ..., socketPath: '/tmp/stsrest01.sock'
-     * Ref: https://stackoverflow.com/questions/21342828/node-express-unix-domain-socket-permissions
-     * To setup side car service (per running machine/node)
-     * sudo mkdir /var/run/sts
-     * sudo chown marcusbettens /var/run/sts
-     * In .env file per service
-     * PORT=/var/run/sts/stsrest01.sock
-     */
-    listenPort: string;
-    /**
-     * Port that this service will be exposed externally on, i.e. clients will use this port to invoke APIs on this service.
-     */
-    port: string;
-    /**
-     * Prometheus Cluster Server port (port used for cluster prometheus scrapes). Example: 3011.
-     */
-    prometheusClusterPort: string;
-    /**
-     * Service Name. Example: Rest01
-     */
-    serviceName: string;
-    /**
-     * Service Version. Example: 1.0.0
-     */
-    serviceVersion: string;
-    /**
-     * Determines where logging is output to the console (stdout).
-     */
-    consoleLogging: boolean;
-    /**
-     * Determines where logging is output to the logging instrument (if present).
-     */
-    instrumentLogging: boolean;
-    serviceProcessContext?: IServiceProcessContext;
-    /**
-     * Factory method that adds express routes to the express app object. Used for non-static content.
-     * Non-Static content is applied after logging middleware.
-     */
-    expressServerRouteFactory?: ExpressRouteFactory;
-    /**
-     * Factory method that adds express routes to the express app object for static content.
-     * Static content is applied before logging middleware.
-     */
-    expressServerRouteStaticFactory?: ExpressRouteFactory;
-    /**
-     * Determines whether the service will monitor its own health via the /latency API endpoint.
-     * Note: The service must implement the /latency end-point for this to work.
-     */
-    useLatency: boolean;
-    /**
-     * Determines whether this service is going to need database access.
-     */
-    useDatabase: boolean;
-    instrumentationObservationInterval: number;
-    instrumentationTimeWindow: number;
-    useSocketIoRedisAdaptor: boolean;
-    socketIoRedisAdaptorUrl?: string;
-    useRedisInstrumentationTransport?: boolean;
-    redisInstrumentationTransportUrl?: string;
-    workerExec?: string;
-    /**
-     * Is this application using nodejs cluster mode?
-     */
-    clusterMode: boolean;
-    logger: ISTSLogger;
-    publisherLogger: ISTSLogger;
-    publishInterval: number;
-}
-//# sourceMappingURL=processoptions.d.ts.map

package/types/processoptions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"processoptions.d.ts","sourceRoot":"","sources":["../src/processoptions.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,OAAO,EAAE,YAAY,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAE9C,MAAM,WAAW,gBAAgB;IAChC,IAAI,GAAG,IAAI,OAAO,CAAC,OAAO,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;AAEtF,oBAAY,aAAa;IACrB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC9B,UAAU,eAAe;IACtB,YAAY,gBAAgB;CAC/B;AAGD,MAAM,WAAW,cAAc;IACvB;;GAED;IACH,QAAQ,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACN,iBAAiB,EAAE,MAAM,CAAA;IAItB,UAAU,EAAE,aAAa,CAAA;IAE5B;;OAEG;IACA,kBAAkB,EAAE,MAAM,CAAA;IAE7B;;OAEG;IACA,0BAA0B,EAAE,MAAM,CAAA;IAElC;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAA;IAE/B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAA;IAErB;;OAEG;IACA,iBAAiB,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACA,QAAQ,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACA,OAAO,EAAE,MAAM,CAAA;IAEf;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEf;;OAEG;IACA,qBAAqB,EAAE,MAAM,CAAA;IAEhC;;OAEG;IACA,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEA;IACA,cAAc,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAA;IAEvB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAA;IAI1B,qBAAqB,CAAC,EAAE,sBAAsB,CAAA;IAE9C;;;OAGG;IACH,yBAAyB,CAAC,EAAE,mBAAmB,CAAA;IAE/C;;;OAGG;IACH,+BAA+B,CAAC,EAAE,mBAAmB,CAAA;IAErD;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAA;IAEpB,kCAAkC,EAAE,MAAM,CAAA;IAE1C,yBAAyB,EAAE,MAAM,CAAA;IAEjC,uBAAuB,EAAE,OAAO,CAAA;IAEhC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAEhC,gCAAgC,CAAC,EAAE,OAAO,CAAA;IAE1C,gCAAgC,CAAC,EAAE,MAAM,CAAA;IAEzC,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAA;IAEpB,MAAM,EAAE,UAAU,CAAA;IAElB,eAAe,EAAE,UAAU,CAAA;IAE3B,eAAe,EAAE,MAAM,CAAA;CAC1B"}