@sipgate/integration-bridge 0.22.7 → 0.22.9

package/README.md

@@ -7,29 +7,33 @@ way to connect apps to any provider of external data management, like contacts o
 
 To test your changes to the integration-bridge framework locally, follow these steps:
 
-* Run `npm run dev` in sipgate-integration-bridge repo
-* Run `npm link @sipgate/integration-bridge` in *-integration-bridge-repo
-* Add the following to your `tsconfig.json`:
+- Run `npm run dev` in sipgate-integration-bridge repo
+- Run `npm link @sipgate/integration-bridge` in \*-integration-bridge-repo
+- Add the following to your `tsconfig.json`:
   ```json
   {
     "compilerOptions": {
       "paths": {
-        "@sipgate/integration-bridge": ["node_modules/@sipgate/integration-bridge/src"]
+        "@sipgate/integration-bridge": [
+          "node_modules/@sipgate/integration-bridge/src"
+        ]
       }
     }
   }
   ```
 
 ## Publishing a version
+
 To publish a new framework version, simply create a new tag and push it:
+
 ```
 
 npm version <minor|patch>
 git push --follow-tags
 
 ```
-This will automatically publish the package in the npm registry via the CI pipeline. 
 
+This will automatically publish the package in the npm registry via the CI pipeline.
 
 ## Bootstrapping a new bridge
 
@@ -48,30 +52,30 @@ yarn add @sipgate/integration-bridge
 The minimum adapter implements the `getContacts` method:
 
 ```js
-const bridge = require("@sipgate/integration-bridge");
-const fetch = require("node-fetch");
+const bridge = require('@sipgate/integration-bridge');
+const fetch = require('node-fetch');
 
-const {ServerError} = bridge;
+const { ServerError } = bridge;
 
 const adapter = {
-    getContacts: async ({apiKey, apiUrl}) => {
-        // Fetch contacts using apiUrl and apiKey
-        const response = await fetch(`${apiUrl}/api/contacts`, {
-            headers: {Authorization: `Bearer ${apiKey}`},
-        });
-
-        if (response.status === 401) {
-            throw new ServerError(401, "Unauthorized");
-        }
+  getContacts: async ({ apiKey, apiUrl }) => {
+    // Fetch contacts using apiUrl and apiKey
+    const response = await fetch(`${apiUrl}/api/contacts`, {
+      headers: { Authorization: `Bearer ${apiKey}` },
+    });
+
+    if (response.status === 401) {
+      throw new ServerError(401, 'Unauthorized');
+    }
 
-        if (!response.ok) {
-            throw new ServerError(500, "Could not fetch contacts");
-        }
+    if (!response.ok) {
+      throw new ServerError(500, 'Could not fetch contacts');
+    }
 
-        // TODO: Convert contacts to the structure below
-        const contacts = await response.json();
-        return contacts;
-    },
+    // TODO: Convert contacts to the structure below
+    const contacts = await response.json();
+    return contacts;
+  },
 };
 
 bridge.start(adapter);

package/dist/cache/index.d.ts

@@ -1 +1 @@
-export * from "./storage-cache";
+export * from './storage-cache';

package/dist/cache/storage/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./memory-storage-adapter";
-export * from "./redis-storage-adapter";
+export * from './memory-storage-adapter';
+export * from './redis-storage-adapter';

package/dist/cache/storage/memory-storage-adapter.d.ts

@@ -1,4 +1,4 @@
-import { StorageAdapter } from "../../models/storage-adapter.model";
+import { StorageAdapter } from '../../models/storage-adapter.model';
 export declare class MemoryStorageAdapter implements StorageAdapter {
     private cache;
     constructor(ttl?: number);

package/dist/cache/storage/redis-storage-adapter.d.ts

@@ -1,4 +1,4 @@
-import { StorageAdapter } from "../../models/storage-adapter.model";
+import { StorageAdapter } from '../../models/storage-adapter.model';
 export declare class RedisStorageAdapter implements StorageAdapter {
     private client;
     constructor(url: string);

package/dist/cache/storage/redis-storage-adapter.js

@@ -20,22 +20,22 @@ class RedisStorageAdapter {
     constructor(url) {
         this.client = (0, redis_1.createClient)({ url });
         console.log(`Initialized Redis storage with URL ${url}`);
-        this.client.on("error", (error) => {
-            console.error("Redis error: ", error.message);
+        this.client.on('error', (error) => {
+            console.error('Redis error: ', error.message);
         });
-        this.client.on("ready", () => {
-            console.info("Redis is ready");
+        this.client.on('ready', () => {
+            console.info('Redis is ready');
         });
-        this.client.on("reconnecting", () => {
-            console.warn("Redis is reconnecting");
+        this.client.on('reconnecting', () => {
+            console.warn('Redis is reconnecting');
         });
         this.client
             .connect()
             .then(() => {
-            console.info("Redis successfully connected");
+            console.info('Redis successfully connected');
         })
             .catch((error) => {
-            console.warn("Redis connection error: ", error.message);
+            console.warn('Redis connection error: ', error.message);
         });
     }
     get(key) {
@@ -44,7 +44,7 @@ class RedisStorageAdapter {
             if (!value) {
                 return null;
             }
-            const decompressed = yield inflate(Buffer.from(value, "base64"));
+            const decompressed = yield inflate(Buffer.from(value, 'base64'));
             const result = JSON.parse(decompressed.toString());
             return result;
         });
@@ -53,7 +53,7 @@ class RedisStorageAdapter {
         return __awaiter(this, void 0, void 0, function* () {
             const stringified = JSON.stringify(value);
             const compressed = yield deflate(stringified);
-            yield this.client.set(key, compressed.toString("base64"), {
+            yield this.client.set(key, compressed.toString('base64'), {
                 EX: ttl !== null && ttl !== void 0 ? ttl : DEFAULT_CACHE_TTL,
             });
         });

package/dist/cache/storage-cache.d.ts

@@ -1,8 +1,8 @@
-import { Contact, ContactCache } from "../models";
-import { CacheItemState } from "../models/cache-item-state.model";
-import { StorageAdapter } from "../models/storage-adapter.model";
-import { TokenCache } from "../models/token-cache.model";
-import { TokenWithStatus } from "../models/token.model";
+import { Contact, ContactCache } from '../models';
+import { CacheItemState } from '../models/cache-item-state.model';
+import { StorageAdapter } from '../models/storage-adapter.model';
+import { TokenCache } from '../models/token-cache.model';
+import { TokenWithStatus } from '../models/token.model';
 export declare class StorageCache implements ContactCache {
     private LOG_PREFIX;
     private storage;

package/dist/cache/storage-cache.js

@@ -12,11 +12,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TokenStorageCache = exports.StorageCache = void 0;
 const cache_item_state_model_1 = require("../models/cache-item-state.model");
 const util_1 = require("../util");
-const CACHE_STATE_PREFIX = "cache-state:";
+const CACHE_STATE_PREFIX = 'cache-state:';
 const CACHE_STATE_SECONDS_TTL = 1800; // 30 minutes
 class StorageCache {
     constructor(storageAdapter) {
-        this.LOG_PREFIX = "CONTACT CACHE";
+        this.LOG_PREFIX = 'CONTACT CACHE';
         this.cacheRefreshIntervalMs = 30 * 60 * 1000; // 30 minutes
         this.storage = storageAdapter;
         const { CACHE_REFRESH_INTERVAL } = process.env;
@@ -29,11 +29,11 @@ class StorageCache {
     get(key, getFreshValue) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                (0, util_1.infoLogger)(this.LOG_PREFIX, "Trying to get contacts from cache", key);
+                (0, util_1.infoLogger)(this.LOG_PREFIX, 'Trying to get contacts from cache', key);
                 const cacheItemState = yield this.storage.get(this.getCacheItemKey(key));
                 const contacts = yield this.storage.get(key);
                 if ((cacheItemState === null || cacheItemState === void 0 ? void 0 : cacheItemState.state) === cache_item_state_model_1.CacheItemStateType.FETCHING) {
-                    (0, util_1.infoLogger)(this.LOG_PREFIX, "Not refreshing contacts, because cache state is FETCHING", key);
+                    (0, util_1.infoLogger)(this.LOG_PREFIX, 'Not refreshing contacts, because cache state is FETCHING', key);
                     // if we have old contacts saved in cache we return them instead
                     if (contacts && (contacts === null || contacts === void 0 ? void 0 : contacts.length) > 0) {
                         (0, util_1.infoLogger)(this.LOG_PREFIX, `Returning previously cached contacts (${contacts.length}), because new contacts are still being fetched`, key);
@@ -128,14 +128,14 @@ class StorageCache {
 exports.StorageCache = StorageCache;
 class TokenStorageCache {
     constructor(storageAdapter) {
-        this.LOG_PREFIX = "TOKEN CACHE";
+        this.LOG_PREFIX = 'TOKEN CACHE';
         this.storage = storageAdapter;
         (0, util_1.infoLogger)(this.LOG_PREFIX, `Initialized token storage cache.`, undefined);
     }
     get(key) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                (0, util_1.infoLogger)(this.LOG_PREFIX, "Trying to get token from cache", key);
+                (0, util_1.infoLogger)(this.LOG_PREFIX, 'Trying to get token from cache', key);
                 return yield this.storage.get(key);
             }
             catch (e) {

package/dist/index.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="node" />
-import { Server } from "http";
-import { TokenStorageCache } from "./cache";
-import { Adapter } from "./models";
-import { CustomRouter } from "./models/custom-router.model";
-import { CustomRoute } from "./models/custom-routes.model";
+import { Server } from 'http';
+import { TokenStorageCache } from './cache';
+import { Adapter } from './models';
+import { CustomRouter } from './models/custom-router.model';
+import { CustomRoute } from './models/custom-routes.model';
 export declare let tokenCache: TokenStorageCache;
 export declare function start(adapter: Adapter, customRouters?: CustomRouter[], customRoutes?: CustomRoute[]): Server;
 export declare const deleteContactCacheItem: (key: string) => Promise<void>;
 export declare const getContactCacheItem: (key: string) => Promise<import("./models").Contact[] | import("./models/cache-item-state.model").CacheItemState>;
-export * from "./models";
-export * from "./util";
+export * from './models';
+export * from './util';

package/dist/index.js

@@ -41,7 +41,7 @@ app.use((0, compression_1.default)());
 app.use((0, cors_1.default)({
     credentials: true,
     origin: true,
-    allowedHeaders: "*",
+    allowedHeaders: '*',
 }));
 app.use(body_parser_1.default.json());
 app.use(middlewares_1.extractHeaderMiddleware);
@@ -50,50 +50,50 @@ function start(adapter, customRouters = [], customRoutes = []) {
     contactCache = (0, get_contact_cache_1.getContactCache)();
     exports.tokenCache = (0, util_1.getTokenCache)();
     const controller = new models_1.Controller(adapter, contactCache);
-    app.get("/contacts", (req, res, next) => controller.getContacts(req, res, next));
-    app.post("/contacts", (req, res, next) => controller.createContact(req, res, next));
-    app.put("/contacts/:id", (req, res, next) => controller.updateContact(req, res, next));
-    app.delete("/contacts/:id", (req, res, next) => controller.deleteContact(req, res, next));
-    app.post("/contacts/stream", (req, res, next) => controller.streamContacts(req, res, next));
-    app.get("/entity/:type/:id", (req, res, next) => controller.getEntity(req, res, next));
-    app.get("/calendar", (req, res, next) => controller.getCalendarEvents(req, res, next));
-    app.post("/calendar", (req, res, next) => controller.createCalendarEvent(req, res, next));
-    app.put("/calendar/:id", (req, res, next) => controller.updateCalendarEvent(req, res, next));
-    app.delete("/calendar/:id", (req, res, next) => controller.deleteCalendarEvent(req, res, next));
-    app.post("/events/calls", (req, res, next) => controller.handleCallEvent(req, res, next));
-    app.put("/events/calls/:id", (req, res, next) => controller.updateCallEvent(req, res, next));
-    app.post("/events/connected", (req, res, next) => controller.handleConnectedEvent(req, res, next));
-    app.put("/call-log", (req, res, next) => controller.createOrUpdateCallLogsForEntities(req, res, next));
-    app.put("/call-log/phoneNumber", (req, res, next) => controller.createCallLogForPhoneNumber(req, res, next));
-    app.get("/health", (req, res, next) => controller.getHealth(req, res, next));
-    app.get("/oauth2/redirect", (req, res, next) => controller.oAuth2Redirect(req, res, next));
-    app.get("/oauth2/callback", (req, res) => controller.oAuth2Callback(req, res));
+    app.get('/contacts', (req, res, next) => controller.getContacts(req, res, next));
+    app.post('/contacts', (req, res, next) => controller.createContact(req, res, next));
+    app.put('/contacts/:id', (req, res, next) => controller.updateContact(req, res, next));
+    app.delete('/contacts/:id', (req, res, next) => controller.deleteContact(req, res, next));
+    app.post('/contacts/stream', (req, res, next) => controller.streamContacts(req, res, next));
+    app.get('/entity/:type/:id', (req, res, next) => controller.getEntity(req, res, next));
+    app.get('/calendar', (req, res, next) => controller.getCalendarEvents(req, res, next));
+    app.post('/calendar', (req, res, next) => controller.createCalendarEvent(req, res, next));
+    app.put('/calendar/:id', (req, res, next) => controller.updateCalendarEvent(req, res, next));
+    app.delete('/calendar/:id', (req, res, next) => controller.deleteCalendarEvent(req, res, next));
+    app.post('/events/calls', (req, res, next) => controller.handleCallEvent(req, res, next));
+    app.put('/events/calls/:id', (req, res, next) => controller.updateCallEvent(req, res, next));
+    app.post('/events/connected', (req, res, next) => controller.handleConnectedEvent(req, res, next));
+    app.put('/call-log', (req, res, next) => controller.createOrUpdateCallLogsForEntities(req, res, next));
+    app.put('/call-log/phoneNumber', (req, res, next) => controller.createCallLogForPhoneNumber(req, res, next));
+    app.get('/health', (req, res, next) => controller.getHealth(req, res, next));
+    app.get('/oauth2/redirect', (req, res, next) => controller.oAuth2Redirect(req, res, next));
+    app.get('/oauth2/callback', (req, res) => controller.oAuth2Callback(req, res));
     app.use(middlewares_1.errorHandlerMiddleware);
     customRouters.forEach(({ path, router }) => app.use(path, router));
     customRoutes.forEach(({ requestType, path, handler: customHandler }) => {
-        (0, util_1.infoLogger)("start", `CustomRoute ${path} added.`, undefined);
+        (0, util_1.infoLogger)('start', `CustomRoute ${path} added.`, undefined);
         const handler = (req, res, next) => {
             try {
-                (0, util_1.infoLogger)(path, "START", undefined);
+                (0, util_1.infoLogger)(path, 'START', undefined);
                 customHandler(req, res, next);
-                (0, util_1.infoLogger)(path, "END", undefined);
+                (0, util_1.infoLogger)(path, 'END', undefined);
             }
             catch (error) {
-                (0, util_1.errorLogger)(path, "Error while executing custom route", undefined, error !== null && error !== void 0 ? error : undefined);
+                (0, util_1.errorLogger)(path, 'Error while executing custom route', undefined, error !== null && error !== void 0 ? error : undefined);
                 next(error);
             }
         };
         switch (requestType) {
-            case "get":
+            case 'get':
                 app.get(path, handler);
                 break;
-            case "post":
+            case 'post':
                 app.post(path, handler);
                 break;
-            case "put":
+            case 'put':
                 app.put(path, handler);
                 break;
-            case "delete":
+            case 'delete':
                 app.delete(path, handler);
                 break;
             default:

package/dist/index.test.js

@@ -11,8 +11,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const _1 = require(".");
 const testAdapter = {};
-describe("Framework", () => {
-    it("should start the server", () => __awaiter(void 0, void 0, void 0, function* () {
+describe('Framework', () => {
+    it('should start the server', () => __awaiter(void 0, void 0, void 0, function* () {
         const server = (0, _1.start)(testAdapter);
         expect(server).toBeDefined();
         server.close();

package/dist/middlewares/error-handler.middleware.d.ts

@@ -1,3 +1,3 @@
-import { NextFunction, Request, Response } from "express";
-import { ServerError } from "../models";
+import { NextFunction, Request, Response } from 'express';
+import { ServerError } from '../models';
 export declare function errorHandlerMiddleware(error: Error | ServerError, req: Request, res: Response, next: NextFunction): void;

package/dist/middlewares/extract-header.middleware.d.ts

@@ -1,3 +1,3 @@
-import { NextFunction, Response } from "express";
-import { BridgeRequest } from "../models";
+import { NextFunction, Response } from 'express';
+import { BridgeRequest } from '../models';
 export declare function extractHeaderMiddleware(req: BridgeRequest<any>, res: Response, next: NextFunction): void;

package/dist/middlewares/extract-header.middleware.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractHeaderMiddleware = void 0;
-const DEFAULT_LOCALE = "en-GB";
+const DEFAULT_LOCALE = 'en-GB';
 function extractHeaderMiddleware(req, res, next) {
-    const userId = req.get("x-user-id") || "";
-    const apiKey = req.get("x-provider-key") || "";
-    const apiUrl = req.get("x-provider-url") || "";
-    const locale = req.get("x-provider-locale") || DEFAULT_LOCALE;
+    const userId = req.get('x-user-id') || '';
+    const apiKey = req.get('x-provider-key') || '';
+    const apiUrl = req.get('x-provider-url') || '';
+    const locale = req.get('x-provider-locale') || DEFAULT_LOCALE;
     req.providerConfig = {
         userId,
         apiKey,

package/dist/middlewares/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./error-handler.middleware";
-export * from "./extract-header.middleware";
+export * from './error-handler.middleware';
+export * from './extract-header.middleware';

package/dist/models/adapter.model.d.ts

@@ -1,6 +1,6 @@
-import { Request, Response } from "express";
-import { CalendarEvent, CalendarEventTemplate, CalendarFilterOptions, CallEvent, CallEventWithIntegrationEntities, Config, Contact, ContactTemplate, ContactUpdate, LabeledIntegrationEntity, LoggedIntegrationEntity } from ".";
-import { IntegrationEntityType } from "./integration-entity.model";
+import { Request, Response } from 'express';
+import { CalendarEvent, CalendarEventTemplate, CalendarFilterOptions, CallEvent, CallEventWithIntegrationEntities, Config, Contact, ContactTemplate, ContactUpdate, LabeledIntegrationEntity, LoggedIntegrationEntity } from '.';
+import { IntegrationEntityType } from './integration-entity.model';
 export interface Adapter {
     getToken?: (config: Config) => Promise<{
         apiKey: string;

package/dist/models/api-contact.model.d.ts

@@ -1,4 +1,4 @@
-import { BaseContact, ContactResult, PhoneNumberLabel, PhoneNumberType } from "./contact.model";
+import { BaseContact, ContactResult, PhoneNumberLabel, PhoneNumberType } from './contact.model';
 export interface APIPhoneNumber {
     label: PhoneNumberLabel | string;
     type: PhoneNumberType;

package/dist/models/bridge-request.model.d.ts

@@ -1,6 +1,6 @@
-import { IntegrationEntityType } from "./integration-entity.model";
-import { Request } from "express";
-import { Config } from "./config.model";
+import { IntegrationEntityType } from './integration-entity.model';
+import { Request } from 'express';
+import { Config } from './config.model';
 export interface BridgeRequest<BodyType> extends Request {
     providerConfig?: Config;
     body: BodyType;

package/dist/models/call-event.model.d.ts

@@ -1,4 +1,4 @@
-import { CallDirection, IntegrationEntity, LoggedIntegrationEntity } from "./";
+import { CallDirection, IntegrationEntity, LoggedIntegrationEntity } from './';
 /**
  * The type of the call participant.
  * The remote party is the party that is not the user.

package/dist/models/contact-cache.model.d.ts

@@ -1,5 +1,5 @@
-import { CacheItemState } from "./cache-item-state.model";
-import { Contact } from "./contact.model";
+import { CacheItemState } from './cache-item-state.model';
+import { Contact } from './contact.model';
 type FreshValueUpdater = (key: string) => Promise<Contact[]>;
 export interface ContactCache {
     get: (key: string, getFreshValue?: FreshValueUpdater) => Promise<Contact[] | CacheItemState>;

package/dist/models/contact.model.d.ts

@@ -1,4 +1,4 @@
-import { IntegrationEntity, IntegrationEntityType, LabeledIntegrationEntity } from "./integration-entity.model";
+import { IntegrationEntity, IntegrationEntityType, LabeledIntegrationEntity } from './integration-entity.model';
 export declare enum PhoneNumberLabel {
     WORK = "WORK",
     MOBILE = "MOBILE",

package/dist/models/controller.model.d.ts

@@ -1,6 +1,6 @@
-import { NextFunction, Request, Response } from "express";
-import { Adapter, CalendarEventTemplate, CallEvent, CallEventWithIntegrationEntities, ContactCache, ContactTemplate, ContactUpdate } from ".";
-import { BridgeRequest, IdBridgeRequest, IntegrationEntityBridgeRequest } from "./bridge-request.model";
+import { NextFunction, Request, Response } from 'express';
+import { Adapter, CalendarEventTemplate, CallEvent, CallEventWithIntegrationEntities, ContactCache, ContactTemplate, ContactUpdate } from '.';
+import { BridgeRequest, IdBridgeRequest, IntegrationEntityBridgeRequest } from './bridge-request.model';
 export declare class Controller {
     private adapter;
     private contactCache;