@pgds/api-interface 1.2.5

package/lib/auth/mustbeConfig.js

@@ -0,0 +1,167 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routeHelpers = void 0;
+exports.configureMustBe = configureMustBe;
+exports.isUserAuthorized = isUserAuthorized;
+var constants_1 = require("../../constants");
+var restifyErrors = __importStar(require("restify-errors"));
+var jsonSchemaUtils_1 = require("../utils/jsonSchemaUtils");
+var logger_1 = __importDefault(require("../utils/logger"));
+var mustbe = require("mustbe");
+/** Only needed if used along side legacy setup */
+var routeHelpers = (function () {
+    var routeHelpers = mustbe.routeHelpers.bind(mustbe)();
+    return {
+        authorized: routeHelpers.authorized.bind(routeHelpers),
+        authenticated: routeHelpers.authenticated.bind(routeHelpers),
+        requestSchema: function (schema) { return (0, jsonSchemaUtils_1.jsonSchemaValidationMiddleware)(schema, jsonSchemaUtils_1.RequestKey.Body); },
+    };
+});
+exports.routeHelpers = routeHelpers;
+function configureMustBe() {
+    mustbe.configure(function (config /* Configurator */) {
+        config.routeHelpers(function (rh) {
+            rh.getUser(function (req, cb) {
+                try {
+                    var user = parseUser(req);
+                    cb(null, user);
+                }
+                catch (err) {
+                    return cb(err, null);
+                }
+            });
+            rh.notAuthorized(function (_req, _res, next) { return next(new restifyErrors.ResourceNotFoundError()); });
+            rh.notAuthenticated(function (_req, _res, next) { return next(new restifyErrors.InvalidCredentialsError()); });
+        });
+        config.activities(function (activities) {
+            activities.allow(function (identity, activity, next) {
+                var user = identity.user;
+                if (userIsUndefined(user)) {
+                    return next(new restifyErrors.InvalidCredentialsError(), false);
+                }
+                if (user === null || user === void 0 ? void 0 : user.userId) {
+                    if (isUserAuthorized(user.activities, activity)) {
+                        return next(null, true);
+                    }
+                }
+                return next(new restifyErrors.ForbiddenError("not authorized for activity: ".concat(activity)), false);
+            });
+        });
+        config.userIdentity(function (id) { return id.isAuthenticated(function (user, cb) { return cb(null, !!user.userId); }); });
+    });
+}
+function parseUser(req) {
+    var userId = req.header(constants_1.AUTH_USER_HEADER, undefined);
+    var organizationId = req.header(constants_1.AUTH_ORGANIZATION_HEADER, undefined);
+    var childOrganizationIds = req
+        .header(constants_1.AUTH_CHILD_ORGANIZATIONS_HEADER, "")
+        .split(",")
+        .filter(function (id) { return id !== ""; });
+    var activities = parseActivities(req.header(constants_1.AUTH_ACTIVITIES_HEADER, ""));
+    var activeLogin = req.header(constants_1.AUTH_ACTIVE_LOGIN_HEADER, undefined);
+    var user = {
+        userId: userId,
+        organizationId: organizationId,
+        childOrganizationIds: childOrganizationIds,
+        activities: activities,
+        activeLogin: activeLogin,
+    };
+    // @ts-ignore
+    req.user = user;
+    return user;
+}
+function userIsUndefined(user) {
+    if (!user) {
+        return true;
+    }
+    var userId = user.userId, organizationId = user.organizationId, activeLogin = user.activeLogin, childOrganizationIds = user.childOrganizationIds;
+    if (!userId && !organizationId && !activeLogin && !(childOrganizationIds === null || childOrganizationIds === void 0 ? void 0 : childOrganizationIds.length)) {
+        return true;
+    }
+    return false;
+}
+function parseActivities(header) {
+    if (!header) {
+        return {};
+    }
+    var activities = header.split(",").reduce(function (acc, activity) {
+        acc[activity] = true;
+        return acc;
+    }, {});
+    return activities;
+}
+function isUserAuthorized(activities, requiredActivitiesString) {
+    var _a;
+    if (activities.global) {
+        return true;
+    }
+    var requiredActivities = Array.isArray(requiredActivitiesString)
+        ? requiredActivitiesString
+        : requiredActivitiesString.split(",");
+    var isAuthorized = requiredActivities.every(function (requiredActivity) {
+        return isActivityAuthorized(activities, requiredActivity);
+    });
+    if (!isAuthorized) {
+        // TODO: move this to utils/index.ts instead to not have dependency to this file in utils/index.ts
+        (_a = logger_1.default === null || logger_1.default === void 0 ? void 0 : logger_1.default.debug) === null || _a === void 0 ? void 0 : _a.call(logger_1.default, "user is not authorized", { activities: activities, requiredActivities: requiredActivities });
+    }
+    return isAuthorized;
+}
+function isActivityAuthorized(activities, requiredActivity) {
+    if (activities[requiredActivity]) {
+        return true;
+    }
+    var isAuthorized = Object.keys(activities).some(function (activity) {
+        var isWildcard = (requiredActivity.includes("*") || activity.includes("*")) && !requiredActivity.includes(constants_1.GLOBAL_ACTIVITY);
+        return isWildcard ? isMatchingWildcard(activity, requiredActivity) : false;
+    });
+    return isAuthorized;
+}
+/**
+ * Matches two activity against each other with two way wildcard matching.
+ */
+function isMatchingWildcard(activity, activity2) {
+    var wildcardActivity = activity.replace("*", ".*");
+    var wildcardActivity2 = activity2.replace("*", ".*");
+    var activityRegex = new RegExp("^".concat(wildcardActivity, "$"));
+    var activity2Regex = new RegExp("^".concat(wildcardActivity2, "$"));
+    var isMatching = activityRegex.test(activity2) || activity2Regex.test(activity);
+    return isMatching;
+}
+//# sourceMappingURL=mustbeConfig.js.map

package/lib/auth/mustbeConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mustbeConfig.js","sourceRoot":"","sources":["mustbeConfig.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,0CAqCC;AAqDD,4CAmBC;AApJD,6CAOyB;AACzB,4DAAgD;AAKhD,4DAAsF;AACtF,2DAAqC;AAErC,IAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAUjC,kDAAkD;AAClD,IAAM,YAAY,GAAG,CAAC;IACpB,IAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;IAExD,OAAO;QACL,UAAU,EAAE,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC;QACtD,aAAa,EAAE,YAAY,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC;QAC5D,aAAa,EAAE,UAAC,MAAW,IAAK,OAAA,IAAA,gDAA8B,EAAC,MAAM,EAAE,4BAAU,CAAC,IAAI,CAAC,EAAvD,CAAuD;KACxF,CAAC;AACJ,CAAC,CAAuB,CAAC;AAEhB,oCAAY;AAErB,SAAgB,eAAe;IAC7B,MAAM,CAAC,SAAS,CAAC,UAAC,MAAW,CAAC,kBAAkB;QAC9C,MAAM,CAAC,YAAY,CAAC,UAAC,EAAO;YAC1B,EAAE,CAAC,OAAO,CAAC,UAAC,GAAQ,EAAE,EAAO;gBAC3B,IAAI,CAAC;oBACH,IAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;oBAC5B,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACjB,CAAC;gBAAC,OAAO,GAAQ,EAAE,CAAC;oBAClB,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,aAAa,CAAC,UAAC,IAAS,EAAE,IAAS,EAAE,IAAS,IAAK,OAAA,IAAI,CAAC,IAAI,aAAa,CAAC,qBAAqB,EAAE,CAAC,EAA/C,CAA+C,CAAC,CAAC;YAEvG,EAAE,CAAC,gBAAgB,CAAC,UAAC,IAAS,EAAE,IAAS,EAAE,IAAS,IAAK,OAAA,IAAI,CAAC,IAAI,aAAa,CAAC,uBAAuB,EAAE,CAAC,EAAjD,CAAiD,CAAC,CAAC;QAC9G,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,UAAC,UAAe;YAChC,UAAU,CAAC,KAAK,CAAC,UAAC,QAAa,EAAE,QAAa,EAAE,IAAS;gBAC/C,IAAA,IAAI,GAAK,QAAQ,KAAb,CAAc;gBAE1B,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC1B,OAAO,IAAI,CAAC,IAAI,aAAa,CAAC,uBAAuB,EAAE,EAAE,KAAK,CAAC,CAAC;gBAClE,CAAC;gBAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAAC;oBACjB,IAAI,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,CAAC;wBAChD,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBAC1B,CAAC;gBACH,CAAC;gBAED,OAAO,IAAI,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,uCAAgC,QAAQ,CAAE,CAAC,EAAE,KAAK,CAAC,CAAC;YACnG,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,YAAY,CAAC,UAAC,EAAO,IAAK,OAAA,EAAE,CAAC,eAAe,CAAC,UAAC,IAAS,EAAE,EAAO,IAAK,OAAA,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAvB,CAAuB,CAAC,EAAnE,CAAmE,CAAC,CAAC;IACxG,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,SAAS,CAAC,GAAY;IAC7B,IAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,4BAAgB,EAAE,SAAS,CAAC,CAAC;IACvD,IAAM,cAAc,GAAG,GAAG,CAAC,MAAM,CAAC,oCAAwB,EAAE,SAAS,CAAC,CAAC;IACvE,IAAM,oBAAoB,GAAG,GAAG;SAC7B,MAAM,CAAC,2CAA+B,EAAE,EAAE,CAAC;SAC3C,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,UAAC,EAAE,IAAK,OAAA,EAAE,KAAK,EAAE,EAAT,CAAS,CAAC,CAAC;IAC7B,IAAM,UAAU,GAAG,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,kCAAsB,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3E,IAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,oCAAwB,EAAE,SAAS,CAAC,CAAC;IAEpE,IAAM,IAAI,GAAY;QACpB,MAAM,QAAA;QACN,cAAc,gBAAA;QACd,oBAAoB,sBAAA;QACpB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;IAEF,aAAa;IACb,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;IAEhB,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,eAAe,CAAC,IAAS;IAChC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,IAAA,MAAM,GAAwD,IAAI,OAA5D,EAAE,cAAc,GAAwC,IAAI,eAA5C,EAAE,WAAW,GAA2B,IAAI,YAA/B,EAAE,oBAAoB,GAAK,IAAI,qBAAT,CAAU;IAE3E,IAAI,CAAC,MAAM,IAAI,CAAC,cAAc,IAAI,CAAC,WAAW,IAAI,CAAC,CAAA,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,MAAM,CAAA,EAAE,CAAC;QAChF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,eAAe,CAAC,MAAc;IACrC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAC,GAAe,EAAE,QAAgB;QAC5E,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;QACrB,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAgB,gBAAgB,CAAC,UAAsB,EAAE,wBAAgC;;IACvF,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,CAAC,wBAAwB,CAAC;QAChE,CAAC,CAAC,wBAAwB;QAC1B,CAAC,CAAC,wBAAwB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAExC,IAAM,YAAY,GAAG,kBAAkB,CAAC,KAAK,CAAC,UAAC,gBAAgB;QAC7D,OAAA,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,CAAC;IAAlD,CAAkD,CACnD,CAAC;IAEF,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,kGAAkG;QAClG,MAAA,gBAAM,aAAN,gBAAM,uBAAN,gBAAM,CAAE,KAAK,iEAAG,wBAAwB,EAAE,EAAE,UAAU,YAAA,EAAE,kBAAkB,oBAAA,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,oBAAoB,CAAC,UAAsB,EAAE,gBAAwB;IAC5E,IAAI,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,UAAC,QAAQ;QACzD,IAAM,UAAU,GACd,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,2BAAe,CAAC,CAAC;QAC5G,OAAO,UAAU,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,QAAgB,EAAE,SAAiB;IAC7D,IAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACrD,IAAM,iBAAiB,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAEvD,IAAM,aAAa,GAAG,IAAI,MAAM,CAAC,WAAI,gBAAgB,MAAG,CAAC,CAAC;IAC1D,IAAM,cAAc,GAAG,IAAI,MAAM,CAAC,WAAI,iBAAiB,MAAG,CAAC,CAAC;IAE5D,IAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAElF,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/lib/constants/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const CI: boolean;
+export declare const SCHEMA_BASE_PATH = "api/schemas";
+export declare const INTERNAL_ENDPOINT_PREFIX = "/internal";

package/lib/constants/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INTERNAL_ENDPOINT_PREFIX = exports.SCHEMA_BASE_PATH = exports.CI = void 0;
+// @ts-ignore
+exports.CI = typeof global.it === "function";
+exports.SCHEMA_BASE_PATH = "api/schemas";
+exports.INTERNAL_ENDPOINT_PREFIX = "/internal";
+//# sourceMappingURL=constants.js.map

package/lib/constants/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["constants.ts"],"names":[],"mappings":";;;AAAA,aAAa;AACA,QAAA,EAAE,GAAG,OAAO,MAAM,CAAC,EAAE,KAAK,UAAU,CAAC;AAErC,QAAA,gBAAgB,GAAG,aAAa,CAAC;AAEjC,QAAA,wBAAwB,GAAG,WAAW,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,255 @@
+import { Db } from "mongodb";
+import type { RouteOptions, Server } from "restify";
+import type { Next, Request, Response } from "./models/Http";
+interface Locator {
+    db: Db;
+    broker: any;
+    api: Server;
+}
+export declare enum Method {
+    Post = "post",
+    Get = "get",
+    Put = "put",
+    Patch = "patch",
+    Del = "del",
+    Head = "head",
+    Options = "options"
+}
+type OmittedFields = "internal" | "method";
+export declare function get(options: Omit<EndpointOptions, OmittedFields>): {
+    (legacyServer?: Server): void;
+    /**
+     * Makes it possible to access the requestHandler through the exported function.
+     * If you need to test the function separately, without starting the server
+     */
+    requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+    /** Endpoint's full path (including any version number and internal prefix) */
+    PATH: string;
+    unregister(): void;
+};
+export declare function post(options: Omit<EndpointOptions, OmittedFields>): {
+    (legacyServer?: Server): void;
+    /**
+     * Makes it possible to access the requestHandler through the exported function.
+     * If you need to test the function separately, without starting the server
+     */
+    requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+    /** Endpoint's full path (including any version number and internal prefix) */
+    PATH: string;
+    unregister(): void;
+};
+export declare function put(options: Omit<EndpointOptions, OmittedFields>): {
+    (legacyServer?: Server): void;
+    /**
+     * Makes it possible to access the requestHandler through the exported function.
+     * If you need to test the function separately, without starting the server
+     */
+    requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+    /** Endpoint's full path (including any version number and internal prefix) */
+    PATH: string;
+    unregister(): void;
+};
+export declare function patch(options: Omit<EndpointOptions, OmittedFields>): {
+    (legacyServer?: Server): void;
+    /**
+     * Makes it possible to access the requestHandler through the exported function.
+     * If you need to test the function separately, without starting the server
+     */
+    requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+    /** Endpoint's full path (including any version number and internal prefix) */
+    PATH: string;
+    unregister(): void;
+};
+export declare function del(options: Omit<EndpointOptions, OmittedFields>): {
+    (legacyServer?: Server): void;
+    /**
+     * Makes it possible to access the requestHandler through the exported function.
+     * If you need to test the function separately, without starting the server
+     */
+    requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+    /** Endpoint's full path (including any version number and internal prefix) */
+    PATH: string;
+    unregister(): void;
+};
+/** Internal endpoints are not available through the API
+ * @deprecated Use internal.get, internal.post, internal.put, internal.patch, internal.del instead
+ */
+export declare function internal(options: Omit<EndpointOptions, "internal">): {
+    (legacyServer?: Server): void;
+    /**
+     * Makes it possible to access the requestHandler through the exported function.
+     * If you need to test the function separately, without starting the server
+     */
+    requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+    /** Endpoint's full path (including any version number and internal prefix) */
+    PATH: string;
+    unregister(): void;
+};
+export declare namespace internal {
+    var get: (options: Omit<EndpointOptions, OmittedFields>) => {
+        (legacyServer?: Server): void;
+        /**
+         * Makes it possible to access the requestHandler through the exported function.
+         * If you need to test the function separately, without starting the server
+         */
+        requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+        /** Endpoint's full path (including any version number and internal prefix) */
+        PATH: string;
+        unregister(): void;
+    };
+    var post: (options: Omit<EndpointOptions, OmittedFields>) => {
+        (legacyServer?: Server): void;
+        /**
+         * Makes it possible to access the requestHandler through the exported function.
+         * If you need to test the function separately, without starting the server
+         */
+        requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+        /** Endpoint's full path (including any version number and internal prefix) */
+        PATH: string;
+        unregister(): void;
+    };
+    var put: (options: Omit<EndpointOptions, OmittedFields>) => {
+        (legacyServer?: Server): void;
+        /**
+         * Makes it possible to access the requestHandler through the exported function.
+         * If you need to test the function separately, without starting the server
+         */
+        requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+        /** Endpoint's full path (including any version number and internal prefix) */
+        PATH: string;
+        unregister(): void;
+    };
+    var patch: (options: Omit<EndpointOptions, OmittedFields>) => {
+        (legacyServer?: Server): void;
+        /**
+         * Makes it possible to access the requestHandler through the exported function.
+         * If you need to test the function separately, without starting the server
+         */
+        requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+        /** Endpoint's full path (including any version number and internal prefix) */
+        PATH: string;
+        unregister(): void;
+    };
+    var del: (options: Omit<EndpointOptions, OmittedFields>) => {
+        (legacyServer?: Server): void;
+        /**
+         * Makes it possible to access the requestHandler through the exported function.
+         * If you need to test the function separately, without starting the server
+         */
+        requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+        /** Endpoint's full path (including any version number and internal prefix) */
+        PATH: string;
+        unregister(): void;
+    };
+}
+export interface JsonResponse<T> {
+    /** Response body */
+    body?: T;
+    /** HTTP status code. @default 200 */
+    status?: number;
+    /** Additional headers */
+    headers?: {
+        totalcount?: number;
+        [key: string]: any;
+    };
+}
+export { Next, Request, Response };
+export interface EndpointOptions {
+    /** Whether to add the endpoint to the metadata or not. @default true */
+    addToMetadata?: boolean;
+    /** Whether the endpoint is internal or not */
+    internal?: boolean;
+    /** The path to the endpoint */
+    path: string;
+    /** The activity that is required to access this endpoint */
+    authorized?: string | string[];
+    /** Whether you need to be logged in or not to access the endpoint. Only needed if authorized is not used. */
+    authenticated?: boolean;
+    /** HTTP method */
+    method: Method;
+    /**
+     * The request body schema, either a JSON schema or the name of a typescript type
+     * (See below. The name must match the name of the file in ./api/schemas).
+     **/
+    requestSchema?: object | string;
+    /**
+     * The query schema, either a JSON schema or the name of a typescript type
+     * (See below. The name must match the name of the file in ./api/schemas).
+     */
+    querySchema?: object | string;
+    /**
+     * The url param schema, either a JSON schema or the name of a typescript type
+     * (See below. The name must match the name of the file in ./api/schemas).
+     */
+    urlParamsSchema?: object | string;
+    /** Additional route options */
+    opts?: RouteOptions;
+    requestHandlers?: any[];
+    /** prefix for the path, e.g. /v1, defaults to what was set in setupApiInterface */
+    version?: string;
+    /** The documentation for the endpoint */
+    documentation?: {
+        /** Short description of the endpoint */
+        summary: string;
+        /** Long description of the endpoint */
+        description?: string;
+        /** Optional array of tags */
+        tags?: string[];
+        /**
+         * Optional description for query params (can also be defined and described in the json schema,
+         * since that's how we validate them)
+         **/
+        query?: Record<string, string>;
+        /**
+         * Optional description of url parameters.
+         * Usually unnecessary since url params should be self descriptive, e.g. /dashboards/:dashboardId
+         **/
+        parameters?: Record<string, string>;
+        /** Response schemas */
+        responses?: {
+            /** HTTP status code */
+            status: number;
+            /** An optional description of the response */
+            description?: string;
+            /**
+             * An optional response schema, either a JSON schema or the name of a typescript type
+             * (See below. The name must match the name of the file in ./api/schemas).
+             **/
+            schema?: any | any[];
+        }[];
+    };
+    /** The request handler function */
+    requestHandler: (req: Request<any, any>, res?: Response<any>, next?: Next) => Promise<JsonResponse<any> | void>;
+}
+export type EndpointMetadata = Omit<EndpointOptions, "requestHandler" | "opts">;
+export declare const endpointMetadata: {
+    [key in Method]: Record<string, EndpointMetadata>;
+};
+export interface ApiInterfaceOptions {
+    /** Name of the service */
+    serviceName: string;
+    /** Default log level for the service */
+    serviceLogLevel: string;
+    /** Whether to use typescript or not */
+    typescript: boolean;
+    /** Global version of the API @default v1. Can be overridden per endpoint */
+    apiVersion: string;
+    /** The base path to the schemas. @default api/schemas */
+    schemaBasePath?: string;
+    /** The port to start the server on */
+    port: number;
+    /** Whether to register the metadata endpoint or not. @default true */
+    registerMetadataEndpoint?: boolean;
+    onUncaughtException?: (err: Error) => void;
+    /** Maximum length of a parameter. @default 2000 after which the default route is used */
+    maxParamLength?: number;
+    legacyMode?: boolean;
+}
+export declare function getApiOptions(): ApiInterfaceOptions;
+export declare function setupApiInterface(options: Omit<ApiInterfaceOptions, "legacyMode">): Promise<Server>;
+/**
+ * Legacy option to enable legacy mode where the server is started with hiot-restify5.
+ * Should only be used (as a temporary solution) where the new server setup is not possible without a complete refactor
+ */
+export declare function setupInterfaceLegacy(options: Omit<ApiInterfaceOptions, "legacyMode">): (locator: Locator) => Promise<Locator>;
+export declare function getServiceName(): string;