@xapp/stentor-service 1.77.2 → 1.78.2

package/lib/FetchService.d.ts

@@ -0,0 +1,31 @@
+/*! Copyright (c) 2019, XAPPmedia */
+import "isomorphic-fetch";
+import "abort-controller/polyfill";
+import { AbstractService } from "./Service";
+export interface WithTimeout {
+    /**
+     * Timeout in milliseconds
+     */
+    timeout?: number;
+}
+export declare class TimeoutError extends Error {
+    constructor(message: string);
+}
+/**
+ * Abstract service for services that primarily rely on the fetch API.
+ *
+ * It includes built-in timeout feature to better keep track of external APIs.
+ *
+ * @export
+ * @abstract
+ * @class FetchService
+ * @extends {AbstractService}
+ */
+export declare abstract class FetchService extends AbstractService {
+    /**
+     * Wrapper around fetch to add some basic diagnostics
+     *
+     * Will throw a TimeoutError if the timeout is reached.
+     */
+    protected fetch(url: string, options?: RequestInit & WithTimeout): Promise<Response>;
+}

package/lib/FetchService.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchService = exports.TimeoutError = void 0;
+/*! Copyright (c) 2019, XAPPmedia */
+require("isomorphic-fetch");
+require("abort-controller/polyfill");
+const Service_1 = require("./Service");
+const now = require("performance-now");
+class TimeoutError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "TimeoutError";
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+exports.TimeoutError = TimeoutError;
+/**
+ * Abstract service for services that primarily rely on the fetch API.
+ *
+ * It includes built-in timeout feature to better keep track of external APIs.
+ *
+ * @export
+ * @abstract
+ * @class FetchService
+ * @extends {AbstractService}
+ */
+class FetchService extends Service_1.AbstractService {
+    /**
+     * Wrapper around fetch to add some basic diagnostics
+     *
+     * Will throw a TimeoutError if the timeout is reached.
+     */
+    fetch(url, options) {
+        const start = now();
+        const controller = new AbortController();
+        if (options) {
+            if (!options.signal) {
+                options.signal = controller.signal;
+            }
+        }
+        else {
+            options = {
+                signal: controller.signal
+            };
+        }
+        const timeoutInMS = (options === null || options === void 0 ? void 0 : options.timeout) || this.timeout;
+        const timeout = setTimeout(() => {
+            controller.abort();
+        }, timeoutInMS);
+        return fetch(url, options).then(response => {
+            const end = now();
+            if (this.logs) {
+                console.info(`Resource took ${url} ${end - start} ms to receive`);
+            }
+            return response;
+        }).catch((error) => {
+            if (error.name === "AbortError") {
+                throw new TimeoutError(`Timeout of ${this.timeout} ms reached.`);
+            }
+            throw error;
+        }).finally(() => {
+            clearTimeout(timeout);
+        });
+    }
+}
+exports.FetchService = FetchService;
+//# sourceMappingURL=FetchService.js.map

package/lib/FetchService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FetchService.js","sourceRoot":"","sources":["../src/FetchService.ts"],"names":[],"mappings":";;;AAAA,oCAAoC;AACpC,4BAA0B;AAC1B,qCAAkC;AAElC,uCAA4C;AAE5C,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AASvC,MAAa,YAAa,SAAQ,KAAK;IAEnC,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAC3B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;CACJ;AAPD,oCAOC;AAED;;;;;;;;;GASG;AACH,MAAsB,YAAa,SAAQ,yBAAe;IACtD;;;;OAIG;IACO,KAAK,CAAC,GAAW,EAAE,OAAmC;QAC5D,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC;QAEpB,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;QAExC,IAAI,OAAO,EAAE;YACT,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBACjB,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;aACtC;SACJ;aAAM;YACH,OAAO,GAAG;gBACN,MAAM,EAAE,UAAU,CAAC,MAAM;aAC5B,CAAA;SACJ;QAED,MAAM,WAAW,GAAW,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,IAAI,CAAC,OAAO,CAAC;QAE7D,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,UAAU,CAAC,KAAK,EAAE,CAAA;QACtB,CAAC,EAAE,WAAW,CAAC,CAAC;QAEhB,OAAO,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACvC,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,IAAI,EAAE;gBACX,OAAO,CAAC,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,GAAG,KAAK,gBAAgB,CAAC,CAAC;aACrE;YACD,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;YAEtB,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE;gBAC7B,MAAM,IAAI,YAAY,CAAC,cAAc,IAAI,CAAC,OAAO,cAAc,CAAC,CAAC;aACpE;YAED,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;YACZ,YAAY,CAAC,OAAO,CAAC,CAAA;QACzB,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AA5CD,oCA4CC"}

package/lib/Service/AbstractService.d.ts

@@ -0,0 +1,16 @@
+/*! Copyright (c) 2019, XAPPmedia */
+import { Service } from "./Service";
+/**
+ * Abstract service
+ *
+ * @export
+ * @abstract
+ * @class AbstractService
+ * @implements {Service}
+ */
+export declare abstract class AbstractService implements Service {
+    readonly timeout: number;
+    readonly retryAttempts: number;
+    readonly logs: boolean;
+    constructor(props?: Service);
+}

package/lib/Service/AbstractService.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractService = void 0;
+/**
+ * Abstract service
+ *
+ * @export
+ * @abstract
+ * @class AbstractService
+ * @implements {Service}
+ */
+class AbstractService {
+    constructor(props) {
+        this.timeout = 1000;
+        this.retryAttempts = 0;
+        this.logs = false;
+        if (props) {
+            this.timeout = props.timeout !== undefined ? props.timeout : this.timeout;
+            this.retryAttempts = props.retryAttempts !== undefined ? props.retryAttempts : this.retryAttempts;
+            this.logs = typeof props.logs === "boolean" ? props.logs : this.logs;
+        }
+    }
+}
+exports.AbstractService = AbstractService;
+//# sourceMappingURL=AbstractService.js.map

package/lib/Service/AbstractService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractService.js","sourceRoot":"","sources":["../../src/Service/AbstractService.ts"],"names":[],"mappings":";;;AAGA;;;;;;;GAOG;AACH,MAAsB,eAAe;IAKjC,YAAY,KAAe;QAJlB,YAAO,GAAW,IAAI,CAAC;QACvB,kBAAa,GAAW,CAAC,CAAC;QAC1B,SAAI,GAAY,KAAK,CAAC;QAG3B,IAAI,KAAK,EAAE;YACP,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1E,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;YAClG,IAAI,CAAC,IAAI,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;SACxE;IACL,CAAC;CACJ;AAZD,0CAYC"}

package/lib/Service/Service.d.ts

@@ -0,0 +1,17 @@
+/*! Copyright (c) 2019, XAPPmedia */
+export interface Service {
+    name?: string;
+    /**
+     * Timeout
+     */
+    timeout?: number;
+    /**
+     * How many attempts to make on the API
+     */
+    retryAttempts?: number;
+    type?: string;
+    /**
+     * Log information from the service
+     */
+    logs?: boolean;
+}

package/lib/Service/Service.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Service.js.map

package/lib/Service/Service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../src/Service/Service.ts"],"names":[],"mappings":""}

package/lib/Service/index.d.ts

@@ -0,0 +1,3 @@
+/*! Copyright (c) 2019, XAPPmedia */
+export * from "./AbstractService";
+export * from "./Service";

package/lib/Service/index.js

@@ -0,0 +1,20 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*! Copyright (c) 2019, XAPPmedia */
+__exportStar(require("./AbstractService"), exports);
+__exportStar(require("./Service"), exports);
+//# sourceMappingURL=index.js.map

package/lib/Service/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Service/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,oDAAkC;AAClC,4CAA0B"}

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "1.77.2",
+    "version": "1.78.2",
     "description": "Base service to be extended for making API calls",
     "types": "lib/index",
     "main": "lib/index",
@@ -27,12 +27,12 @@
         "mocha": "11.7.5",
         "sinon": "21.0.0",
         "sinon-chai": "3.7.0",
-        "stentor-constants": "1.71.0",
-        "stentor-context": "1.71.0",
-        "stentor-models": "1.71.0",
-        "stentor-request": "1.71.0",
-        "stentor-service-fetch": "1.71.0",
-        "stentor-utils": "1.71.0",
+        "stentor-constants": "1.72.0",
+        "stentor-context": "1.72.0",
+        "stentor-models": "1.72.0",
+        "stentor-request": "1.72.0",
+        "stentor-service-fetch": "1.72.0",
+        "stentor-utils": "1.72.0",
         "ts-node": "10.9.2",
         "typescript": "5.9.3"
     },
@@ -55,5 +55,5 @@
         "clean": "rm -rf ./lib/*",
         "ftest": "mocha --recursive -r ts-node/register \"./src/**/*.ftest.ts\""
     },
-    "gitHead": "2ad66e5027dcf0a1aae780792cd30c7a5f284c76"
+    "gitHead": "aa12717f4c89adc8be07967d8aabe33671d787b1"
 }