node-server-engine 1.0.5

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_report","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_filter","_semverCompare","_dbMigration","_checkEnvironment","_envAssert","_createSortedObject","_jwt","_hmac","_createHttpServer","_request","_tlsConfig","_tlsRequest","_sendPush","_getDynamicLink","_sendEmail","_trimPathSlash"],"sources":["../../src/utils/index.ts"],"sourcesContent":["// general\nexport * from './report';\nexport * from './filter';\nexport * from './semverCompare';\nexport * from './dbMigration';\n\n// env\nexport * from './checkEnvironment';\nexport * from './envAssert';\n\n// auth\nexport * from './createSortedObject';\nexport * from './jwt';\nexport * from './hmac';\n\n// Networking\nexport * from './createHttpServer';\nexport * from './request';\nexport * from './tlsConfig';\nexport * from './tlsRequest';\nexport * from './sendPush';\nexport * from './getDynamicLink';\nexport * from './sendEmail';\n\n// String manipulation\nexport * from './trimPathSlash';\n"],"mappings":";;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,OAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,OAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,OAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,OAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,OAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,OAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,OAAA,CAAAL,GAAA;IAAA;EAAA;AAAA;AACA,IAAAM,cAAA,GAAAV,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAQ,cAAA,EAAAP,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAM,cAAA,CAAAN,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAE,cAAA,CAAAN,GAAA;IAAA;EAAA;AAAA;AACA,IAAAO,YAAA,GAAAX,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAS,YAAA,EAAAR,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAO,YAAA,CAAAP,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAG,YAAA,CAAAP,GAAA;IAAA;EAAA;AAAA;AAGA,IAAAQ,iBAAA,GAAAZ,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAU,iBAAA,EAAAT,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAQ,iBAAA,CAAAR,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAI,iBAAA,CAAAR,GAAA;IAAA;EAAA;AAAA;AACA,IAAAS,UAAA,GAAAb,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAW,UAAA,EAAAV,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAS,UAAA,CAAAT,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAK,UAAA,CAAAT,GAAA;IAAA;EAAA;AAAA;AAGA,IAAAU,mBAAA,GAAAd,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAY,mBAAA,EAAAX,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAU,mBAAA,CAAAV,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAM,mBAAA,CAAAV,GAAA;IAAA;EAAA;AAAA;AACA,IAAAW,IAAA,GAAAf,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAa,IAAA,EAAAZ,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAW,IAAA,CAAAX,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAO,IAAA,CAAAX,GAAA;IAAA;EAAA;AAAA;AACA,IAAAY,KAAA,GAAAhB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAc,KAAA,EAAAb,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAY,KAAA,CAAAZ,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAQ,KAAA,CAAAZ,GAAA;IAAA;EAAA;AAAA;AAGA,IAAAa,iBAAA,GAAAjB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAe,iBAAA,EAAAd,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAa,iBAAA,CAAAb,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAS,iBAAA,CAAAb,GAAA;IAAA;EAAA;AAAA;AACA,IAAAc,QAAA,GAAAlB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAgB,QAAA,EAAAf,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAc,QAAA,CAAAd,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAU,QAAA,CAAAd,GAAA;IAAA;EAAA;AAAA;AACA,IAAAe,UAAA,GAAAnB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAiB,UAAA,EAAAhB,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAe,UAAA,CAAAf,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAW,UAAA,CAAAf,GAAA;IAAA;EAAA;AAAA;AACA,IAAAgB,WAAA,GAAApB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAkB,WAAA,EAAAjB,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAgB,WAAA,CAAAhB,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAY,WAAA,CAAAhB,GAAA;IAAA;EAAA;AAAA;AACA,IAAAiB,SAAA,GAAArB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAmB,SAAA,EAAAlB,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAiB,SAAA,CAAAjB,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAa,SAAA,CAAAjB,GAAA;IAAA;EAAA;AAAA;AACA,IAAAkB,eAAA,GAAAtB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAoB,eAAA,EAAAnB,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAkB,eAAA,CAAAlB,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAc,eAAA,CAAAlB,GAAA;IAAA;EAAA;AAAA;AACA,IAAAmB,UAAA,GAAAvB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAqB,UAAA,EAAApB,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAmB,UAAA,CAAAnB,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAe,UAAA,CAAAnB,GAAA;IAAA;EAAA;AAAA;AAGA,IAAAoB,cAAA,GAAAxB,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAsB,cAAA,EAAArB,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAoB,cAAA,CAAApB,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAgB,cAAA,CAAApB,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/dist/utils/jwt/index.d.ts

@@ -0,0 +1,2 @@
+export * from './jwt';
+export * from './jwt.types';

package/dist/utils/jwt/index.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _jwt = require("./jwt");
+Object.keys(_jwt).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _jwt[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _jwt[key];
+    }
+  });
+});
+var _jwt2 = require("./jwt.types");
+Object.keys(_jwt2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _jwt2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _jwt2[key];
+    }
+  });
+});
+//# sourceMappingURL=index.js.map

package/dist/utils/jwt/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_jwt","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_jwt2"],"sources":["../../../src/utils/jwt/index.ts"],"sourcesContent":["export * from './jwt';\nexport * from './jwt.types';\n"],"mappings":";;;;;AAAA,IAAAA,IAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,IAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,IAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,IAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,KAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,KAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,KAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,KAAA,CAAAL,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/dist/utils/jwt/jwt.d.ts

@@ -0,0 +1,12 @@
+import { UserTokenPayload } from './jwt.types';
+import { TokenIssuer } from '../../const';
+import { KeySet } from '../../entities/KeySet';
+export declare let keySet: KeySet | undefined;
+export declare let adminKeySet: KeySet | undefined;
+/** Initiate key fetching mechanism */
+export declare function initKeySets(): Promise<void>;
+/** Stop fetching keys regularly */
+export declare function shutdownKeySets(): void;
+/** Verify an user Json Web Token */
+export declare function jwtVerify(token: string, issuer?: TokenIssuer): Promise<UserTokenPayload>;
+export declare function generateJwtToken(user: unknown): string;

package/dist/utils/jwt/jwt.js

@@ -0,0 +1,195 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.adminKeySet = void 0;
+exports.generateJwtToken = generateJwtToken;
+exports.initKeySets = initKeySets;
+exports.jwtVerify = jwtVerify;
+exports.keySet = void 0;
+exports.shutdownKeySets = shutdownKeySets;
+var _jsonwebtoken = require("jsonwebtoken");
+var _fs = _interopRequireDefault(require("fs"));
+var _const = require("../../const");
+var _EngineError = require("../../entities/EngineError");
+var _KeySet = require("../../entities/KeySet");
+var _WebError = require("../../entities/WebError");
+var _checkEnvironment = require("../checkEnvironment");
+var _envAssert = require("../envAssert");
+var _report = require("../report");
+let keySet = exports.keySet = void 0;
+let adminKeySet = exports.adminKeySet = void 0;
+const namespace = 'engine:utils:jwt';
+
+/** Initiate key fetching mechanism */
+async function initKeySets() {
+  // Create the KeySet instance
+  // The auth-service fetches its key from its disk and not from a network request
+  // This prevents fetch failures the first time the auth-service is started
+  if (process.env.CHART === 'auth-service') {
+    if (!process.env.ECDSA_PUBLIC_KEY) throw new _EngineError.EngineError({
+      message: 'Environment variable "ECDSA_PUBLIC_KEY" is not defined'
+    });
+    exports.keySet = keySet = new _KeySet.KeySet(process.env.ECDSA_PUBLIC_KEY, {
+      file: true
+    });
+  } else {
+    if (process.env.AUTH_SERVICE_URL) exports.keySet = keySet = new _KeySet.KeySet(`${process.env.AUTH_SERVICE_URL}/.well-known/jwks.json`, {
+      internal: true
+    });else exports.keySet = keySet = new _KeySet.KeySet(`./keys/jwks.json`, {
+      internal: true,
+      file: true
+    });
+    if (!keySet) throw new _EngineError.EngineError({
+      message: 'Environment variable "AUTH_SERVICE_URL" is not defined or JWKS not found'
+    });
+  }
+  const promise = [keySet.init.bind(keySet)()];
+
+  // Load the key set for the admin api
+  if (!process.env.ADMIN_API_ECDSA_PUBLIC_KEY) throw new _EngineError.EngineError({
+    message: "Admin API's authentication JWT signing public key is not defined"
+  });
+  exports.adminKeySet = adminKeySet = new _KeySet.KeySet(process.env.ADMIN_API_ECDSA_PUBLIC_KEY, {
+    pem: true
+  });
+  promise.push(adminKeySet.init.bind(adminKeySet)());
+  await Promise.all(promise);
+}
+
+/** Stop fetching keys regularly */
+function shutdownKeySets() {
+  if (keySet) keySet.shutdown.bind(keySet)();
+  if (adminKeySet) adminKeySet.shutdown.bind(adminKeySet)();
+}
+
+/** Get the JWT public key */
+function jwtGetKey(header, callback) {
+  // In test environment we return the symmetric signature secret
+  if (process.env.NODE_ENV === 'test') {
+    callback(null, process.env.JWT_SECRET);
+    return;
+  }
+  // Check that KeySet has been initialized
+  if (!keySet || !adminKeySet) {
+    callback(new _EngineError.EngineError({
+      message: 'KeySet has not been initialized'
+    }));
+    return;
+  }
+  // Check that the token has a key ID
+  if (!header.kid) {
+    callback(new _EngineError.EngineError({
+      message: 'Token has not key ID in header, impossible to match with known key',
+      data: header
+    }));
+    return;
+  }
+
+  // In test environment we use a symmetrical secret bases signature
+  if (process.env.NODE_ENV === 'test') {
+    callback(null, process.env.JWT_SECRET);
+    return;
+  }
+  (0, _report.reportDebug)({
+    namespace,
+    message: `Looking for key with ID "${header.kid}"`
+  });
+  // Go through each key set to check if the token's key is in one of them
+  let key;
+  try {
+    key = keySet.getKey(header.kid);
+  } catch (error) {
+    callback(error instanceof Error ? error : null);
+    return;
+  }
+  if (key) {
+    (0, _report.reportDebug)({
+      namespace,
+      message: `Found key with ID "${header.kid}"`
+    });
+    callback(null, key);
+    return;
+  }
+  callback(new _WebError.WebError({
+    statusCode: 401,
+    errorCode: 'unauthorized',
+    message: 'Could not find the tokens key in any key set',
+    data: {
+      kid: header.kid
+    }
+  }));
+}
+
+/** Verify an user Json Web Token */
+async function jwtVerify(token, issuer = _const.TokenIssuer.AUTH_SERVICE) {
+  let algorithms = ['ES256'];
+  if (process.env.NODE_ENV === 'test') {
+    (0, _checkEnvironment.assertEnvironment)({
+      JWT_SECRET: _envAssert.envAssert.isString()
+    });
+    algorithms = ['HS256'];
+  }
+  (0, _checkEnvironment.assertEnvironment)({
+    ACCESS_TOKEN_AUDIENCE: _envAssert.envAssert.isString(),
+    ACCESS_TOKEN_ISSUER: _envAssert.envAssert.isString(),
+    ADMIN_API_ACCESS_TOKEN_AUDIENCE: _envAssert.envAssert.isString(),
+    ADMIN_ACCESS_TOKEN_ISSUER: _envAssert.envAssert.isString()
+  });
+  let options;
+  switch (issuer) {
+    case _const.TokenIssuer.AUTH_SERVICE:
+      options = {
+        audience: [process.env.ACCESS_TOKEN_AUDIENCE],
+        issuer: [process.env.ACCESS_TOKEN_ISSUER],
+        algorithms
+      };
+      break;
+    case _const.TokenIssuer.ADMIN_API:
+      options = {
+        audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE],
+        issuer: [process.env.ADMIN_ACCESS_TOKEN_ISSUER],
+        algorithms
+      };
+      break;
+    default:
+      throw new _EngineError.EngineError({
+        message: `Invalid token issuer specified "${issuer}"`
+      });
+  }
+  return new Promise((resolve, reject) => {
+    (0, _jsonwebtoken.verify)(token, jwtGetKey, options, (error, result) => {
+      if (error) {
+        reject(new _WebError.WebError({
+          errorCode: 'unauthorized',
+          statusCode: 401,
+          message: 'Invalid token supplied',
+          data: {
+            token
+          },
+          error: error instanceof Error ? error : undefined
+        }));
+        return;
+      }
+      resolve(result);
+    });
+  });
+}
+function generateJwtToken(user) {
+  const signOptions = {
+    algorithm: 'ES256',
+    // or 'ES256' as Algorithm
+    expiresIn: '1h',
+    issuer: process.env.ACCESS_TOKEN_ISSUER,
+    audience: process.env.ACCESS_TOKEN_AUDIENCE,
+    keyid: Object.keys(keySet?.getKeys() ?? {})[0]
+  };
+  const privateKey = _fs.default.readFileSync(process.env.PRIVATE_KEY_PATH ?? 'keys/private-key.pem', 'utf8');
+  const token = (0, _jsonwebtoken.sign)({
+    user
+  }, privateKey, signOptions);
+  return token;
+}
+//# sourceMappingURL=jwt.js.map

package/dist/utils/jwt/jwt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jwt.js","names":["_jsonwebtoken","require","_fs","_interopRequireDefault","_const","_EngineError","_KeySet","_WebError","_checkEnvironment","_envAssert","_report","keySet","exports","adminKeySet","namespace","initKeySets","process","env","CHART","ECDSA_PUBLIC_KEY","EngineError","message","KeySet","file","AUTH_SERVICE_URL","internal","promise","init","bind","ADMIN_API_ECDSA_PUBLIC_KEY","pem","push","Promise","all","shutdownKeySets","shutdown","jwtGetKey","header","callback","NODE_ENV","JWT_SECRET","kid","data","reportDebug","key","getKey","error","Error","WebError","statusCode","errorCode","jwtVerify","token","issuer","TokenIssuer","AUTH_SERVICE","algorithms","assertEnvironment","envAssert","isString","ACCESS_TOKEN_AUDIENCE","ACCESS_TOKEN_ISSUER","ADMIN_API_ACCESS_TOKEN_AUDIENCE","ADMIN_ACCESS_TOKEN_ISSUER","options","audience","ADMIN_API","resolve","reject","verify","result","undefined","generateJwtToken","user","signOptions","algorithm","expiresIn","keyid","Object","keys","getKeys","privateKey","fs","readFileSync","PRIVATE_KEY_PATH","sign"],"sources":["../../../src/utils/jwt/jwt.ts"],"sourcesContent":["import {\n  verify,\n  JwtHeader,\n  SigningKeyCallback,\n  Algorithm,\n  VerifyOptions,\n  sign\n} from 'jsonwebtoken';\nimport fs from 'fs';\nimport path from 'path';\nimport { UserTokenPayload } from './jwt.types';\nimport { TokenIssuer } from 'const';\nimport { EngineError } from 'entities/EngineError';\nimport { KeySet } from 'entities/KeySet';\nimport { WebError } from 'entities/WebError';\nimport { assertEnvironment } from 'utils/checkEnvironment';\nimport { envAssert } from 'utils/envAssert';\nimport { reportDebug } from 'utils/report';\n\nexport let keySet: KeySet | undefined;\nexport let adminKeySet: KeySet | undefined;\n\nconst namespace = 'engine:utils:jwt';\n\n/** Initiate key fetching mechanism */\nexport async function initKeySets(): Promise<void> {\n  // Create the KeySet instance\n  // The auth-service fetches its key from its disk and not from a network request\n  // This prevents fetch failures the first time the auth-service is started\n  if (process.env.CHART === 'auth-service') {\n    if (!process.env.ECDSA_PUBLIC_KEY)\n      throw new EngineError({\n        message: 'Environment variable \"ECDSA_PUBLIC_KEY\" is not defined'\n      });\n    keySet = new KeySet(process.env.ECDSA_PUBLIC_KEY, { file: true });\n  } else {\n    if (process.env.AUTH_SERVICE_URL)\n      keySet = new KeySet(\n        `${process.env.AUTH_SERVICE_URL}/.well-known/jwks.json`,\n        { internal: true }\n      );\n    else\n      keySet = new KeySet(`./keys/jwks.json`, { internal: true, file: true });\n\n    if (!keySet)\n      throw new EngineError({\n        message:\n          'Environment variable \"AUTH_SERVICE_URL\" is not defined or JWKS not found'\n      });\n  }\n  const promise = [keySet.init.bind(keySet)()];\n\n  // Load the key set for the admin api\n  if (!process.env.ADMIN_API_ECDSA_PUBLIC_KEY)\n    throw new EngineError({\n      message:\n        \"Admin API's authentication JWT signing public key is not defined\"\n    });\n  adminKeySet = new KeySet(process.env.ADMIN_API_ECDSA_PUBLIC_KEY, {\n    pem: true\n  });\n  promise.push(adminKeySet.init.bind(adminKeySet)());\n\n  await Promise.all(promise);\n}\n\n/** Stop fetching keys regularly */\nexport function shutdownKeySets(): void {\n  if (keySet) keySet.shutdown.bind(keySet)();\n  if (adminKeySet) adminKeySet.shutdown.bind(adminKeySet)();\n}\n\n/** Get the JWT public key */\nfunction jwtGetKey(header: JwtHeader, callback: SigningKeyCallback): void {\n  // In test environment we return the symmetric signature secret\n  if (process.env.NODE_ENV === 'test') {\n    callback(null, process.env.JWT_SECRET);\n    return;\n  }\n  // Check that KeySet has been initialized\n  if (!keySet || !adminKeySet) {\n    callback(new EngineError({ message: 'KeySet has not been initialized' }));\n    return;\n  }\n  // Check that the token has a key ID\n  if (!header.kid) {\n    callback(\n      new EngineError({\n        message:\n          'Token has not key ID in header, impossible to match with known key',\n        data: header\n      })\n    );\n    return;\n  }\n\n  // In test environment we use a symmetrical secret bases signature\n  if (process.env.NODE_ENV === 'test') {\n    callback(null, process.env.JWT_SECRET);\n    return;\n  }\n  reportDebug({\n    namespace,\n    message: `Looking for key with ID \"${header.kid}\"`\n  });\n  // Go through each key set to check if the token's key is in one of them\n  let key;\n  try {\n    key = keySet.getKey(header.kid);\n  } catch (error: Error | null | unknown) {\n    callback(error instanceof Error ? error : null);\n    return;\n  }\n\n  if (key) {\n    reportDebug({ namespace, message: `Found key with ID \"${header.kid}\"` });\n    callback(null, key);\n    return;\n  }\n  callback(\n    new WebError({\n      statusCode: 401,\n      errorCode: 'unauthorized',\n      message: 'Could not find the tokens key in any key set',\n      data: { kid: header.kid }\n    })\n  );\n}\n\n/** Verify an user Json Web Token */\nexport async function jwtVerify(\n  token: string,\n  issuer: TokenIssuer = TokenIssuer.AUTH_SERVICE\n): Promise<UserTokenPayload> {\n  let algorithms = ['ES256' as Algorithm];\n  if (process.env.NODE_ENV === 'test') {\n    assertEnvironment({ JWT_SECRET: envAssert.isString() });\n    algorithms = ['HS256' as Algorithm];\n  }\n  assertEnvironment({\n    ACCESS_TOKEN_AUDIENCE: envAssert.isString(),\n    ACCESS_TOKEN_ISSUER: envAssert.isString(),\n    ADMIN_API_ACCESS_TOKEN_AUDIENCE: envAssert.isString(),\n    ADMIN_ACCESS_TOKEN_ISSUER: envAssert.isString()\n  });\n  let options: VerifyOptions | undefined;\n\n  switch (issuer) {\n    case TokenIssuer.AUTH_SERVICE:\n      options = {\n        audience: [process.env.ACCESS_TOKEN_AUDIENCE as string],\n        issuer: [process.env.ACCESS_TOKEN_ISSUER as string],\n        algorithms\n      };\n      break;\n    case TokenIssuer.ADMIN_API:\n      options = {\n        audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],\n        issuer: [process.env.ADMIN_ACCESS_TOKEN_ISSUER as string],\n        algorithms\n      };\n      break;\n    default:\n      throw new EngineError({\n        message: `Invalid token issuer specified \"${issuer as string}\"`\n      });\n  }\n\n  return new Promise<UserTokenPayload>((resolve, reject) => {\n    verify(token, jwtGetKey, options, (error, result) => {\n      if (error) {\n        reject(\n          new WebError({\n            errorCode: 'unauthorized',\n            statusCode: 401,\n            message: 'Invalid token supplied',\n            data: { token },\n            error: error instanceof Error ? error : undefined\n          })\n        );\n        return;\n      }\n      resolve(result as UserTokenPayload);\n    });\n  });\n}\n\nexport function generateJwtToken(user: unknown) {\n  const signOptions = {\n    algorithm: 'ES256' as const, // or 'ES256' as Algorithm\n    expiresIn: '1h',\n    issuer: process.env.ACCESS_TOKEN_ISSUER,\n    audience: process.env.ACCESS_TOKEN_AUDIENCE,\n    keyid: Object.keys(keySet?.getKeys() ?? {})[0]\n  };\n\n  const privateKey = fs.readFileSync(\n    process.env.PRIVATE_KEY_PATH ?? 'keys/private-key.pem',\n    'utf8'\n  );\n  const token = sign({ user }, privateKey, signOptions);\n\n  return token;\n}\n"],"mappings":";;;;;;;;;;;;AAAA,IAAAA,aAAA,GAAAC,OAAA;AAQA,IAAAC,GAAA,GAAAC,sBAAA,CAAAF,OAAA;AAGA,IAAAG,MAAA,GAAAH,OAAA;AACA,IAAAI,YAAA,GAAAJ,OAAA;AACA,IAAAK,OAAA,GAAAL,OAAA;AACA,IAAAM,SAAA,GAAAN,OAAA;AACA,IAAAO,iBAAA,GAAAP,OAAA;AACA,IAAAQ,UAAA,GAAAR,OAAA;AACA,IAAAS,OAAA,GAAAT,OAAA;AAEO,IAAIU,MAA0B,GAAAC,OAAA,CAAAD,MAAA;AAC9B,IAAIE,WAA+B,GAAAD,OAAA,CAAAC,WAAA;AAE1C,MAAMC,SAAS,GAAG,kBAAkB;;AAEpC;AACO,eAAeC,WAAWA,CAAA,EAAkB;EACjD;EACA;EACA;EACA,IAAIC,OAAO,CAACC,GAAG,CAACC,KAAK,KAAK,cAAc,EAAE;IACxC,IAAI,CAACF,OAAO,CAACC,GAAG,CAACE,gBAAgB,EAC/B,MAAM,IAAIC,wBAAW,CAAC;MACpBC,OAAO,EAAE;IACX,CAAC,CAAC;IACJT,OAAA,CAAAD,MAAA,GAAAA,MAAM,GAAG,IAAIW,cAAM,CAACN,OAAO,CAACC,GAAG,CAACE,gBAAgB,EAAE;MAAEI,IAAI,EAAE;IAAK,CAAC,CAAC;EACnE,CAAC,MAAM;IACL,IAAIP,OAAO,CAACC,GAAG,CAACO,gBAAgB,EAC9BZ,OAAA,CAAAD,MAAA,GAAAA,MAAM,GAAG,IAAIW,cAAM,CACjB,GAAGN,OAAO,CAACC,GAAG,CAACO,gBAAgB,wBAAwB,EACvD;MAAEC,QAAQ,EAAE;IAAK,CACnB,CAAC,CAAC,KAEFb,OAAA,CAAAD,MAAA,GAAAA,MAAM,GAAG,IAAIW,cAAM,CAAC,kBAAkB,EAAE;MAAEG,QAAQ,EAAE,IAAI;MAAEF,IAAI,EAAE;IAAK,CAAC,CAAC;IAEzE,IAAI,CAACZ,MAAM,EACT,MAAM,IAAIS,wBAAW,CAAC;MACpBC,OAAO,EACL;IACJ,CAAC,CAAC;EACN;EACA,MAAMK,OAAO,GAAG,CAACf,MAAM,CAACgB,IAAI,CAACC,IAAI,CAACjB,MAAM,CAAC,CAAC,CAAC,CAAC;;EAE5C;EACA,IAAI,CAACK,OAAO,CAACC,GAAG,CAACY,0BAA0B,EACzC,MAAM,IAAIT,wBAAW,CAAC;IACpBC,OAAO,EACL;EACJ,CAAC,CAAC;EACJT,OAAA,CAAAC,WAAA,GAAAA,WAAW,GAAG,IAAIS,cAAM,CAACN,OAAO,CAACC,GAAG,CAACY,0BAA0B,EAAE;IAC/DC,GAAG,EAAE;EACP,CAAC,CAAC;EACFJ,OAAO,CAACK,IAAI,CAAClB,WAAW,CAACc,IAAI,CAACC,IAAI,CAACf,WAAW,CAAC,CAAC,CAAC,CAAC;EAElD,MAAMmB,OAAO,CAACC,GAAG,CAACP,OAAO,CAAC;AAC5B;;AAEA;AACO,SAASQ,eAAeA,CAAA,EAAS;EACtC,IAAIvB,MAAM,EAAEA,MAAM,CAACwB,QAAQ,CAACP,IAAI,CAACjB,MAAM,CAAC,CAAC,CAAC;EAC1C,IAAIE,WAAW,EAAEA,WAAW,CAACsB,QAAQ,CAACP,IAAI,CAACf,WAAW,CAAC,CAAC,CAAC;AAC3D;;AAEA;AACA,SAASuB,SAASA,CAACC,MAAiB,EAAEC,QAA4B,EAAQ;EACxE;EACA,IAAItB,OAAO,CAACC,GAAG,CAACsB,QAAQ,KAAK,MAAM,EAAE;IACnCD,QAAQ,CAAC,IAAI,EAAEtB,OAAO,CAACC,GAAG,CAACuB,UAAU,CAAC;IACtC;EACF;EACA;EACA,IAAI,CAAC7B,MAAM,IAAI,CAACE,WAAW,EAAE;IAC3ByB,QAAQ,CAAC,IAAIlB,wBAAW,CAAC;MAAEC,OAAO,EAAE;IAAkC,CAAC,CAAC,CAAC;IACzE;EACF;EACA;EACA,IAAI,CAACgB,MAAM,CAACI,GAAG,EAAE;IACfH,QAAQ,CACN,IAAIlB,wBAAW,CAAC;MACdC,OAAO,EACL,oEAAoE;MACtEqB,IAAI,EAAEL;IACR,CAAC,CACH,CAAC;IACD;EACF;;EAEA;EACA,IAAIrB,OAAO,CAACC,GAAG,CAACsB,QAAQ,KAAK,MAAM,EAAE;IACnCD,QAAQ,CAAC,IAAI,EAAEtB,OAAO,CAACC,GAAG,CAACuB,UAAU,CAAC;IACtC;EACF;EACA,IAAAG,mBAAW,EAAC;IACV7B,SAAS;IACTO,OAAO,EAAE,4BAA4BgB,MAAM,CAACI,GAAG;EACjD,CAAC,CAAC;EACF;EACA,IAAIG,GAAG;EACP,IAAI;IACFA,GAAG,GAAGjC,MAAM,CAACkC,MAAM,CAACR,MAAM,CAACI,GAAG,CAAC;EACjC,CAAC,CAAC,OAAOK,KAA6B,EAAE;IACtCR,QAAQ,CAACQ,KAAK,YAAYC,KAAK,GAAGD,KAAK,GAAG,IAAI,CAAC;IAC/C;EACF;EAEA,IAAIF,GAAG,EAAE;IACP,IAAAD,mBAAW,EAAC;MAAE7B,SAAS;MAAEO,OAAO,EAAE,sBAAsBgB,MAAM,CAACI,GAAG;IAAI,CAAC,CAAC;IACxEH,QAAQ,CAAC,IAAI,EAAEM,GAAG,CAAC;IACnB;EACF;EACAN,QAAQ,CACN,IAAIU,kBAAQ,CAAC;IACXC,UAAU,EAAE,GAAG;IACfC,SAAS,EAAE,cAAc;IACzB7B,OAAO,EAAE,8CAA8C;IACvDqB,IAAI,EAAE;MAAED,GAAG,EAAEJ,MAAM,CAACI;IAAI;EAC1B,CAAC,CACH,CAAC;AACH;;AAEA;AACO,eAAeU,SAASA,CAC7BC,KAAa,EACbC,MAAmB,GAAGC,kBAAW,CAACC,YAAY,EACnB;EAC3B,IAAIC,UAAU,GAAG,CAAC,OAAO,CAAc;EACvC,IAAIxC,OAAO,CAACC,GAAG,CAACsB,QAAQ,KAAK,MAAM,EAAE;IACnC,IAAAkB,mCAAiB,EAAC;MAAEjB,UAAU,EAAEkB,oBAAS,CAACC,QAAQ,CAAC;IAAE,CAAC,CAAC;IACvDH,UAAU,GAAG,CAAC,OAAO,CAAc;EACrC;EACA,IAAAC,mCAAiB,EAAC;IAChBG,qBAAqB,EAAEF,oBAAS,CAACC,QAAQ,CAAC,CAAC;IAC3CE,mBAAmB,EAAEH,oBAAS,CAACC,QAAQ,CAAC,CAAC;IACzCG,+BAA+B,EAAEJ,oBAAS,CAACC,QAAQ,CAAC,CAAC;IACrDI,yBAAyB,EAAEL,oBAAS,CAACC,QAAQ,CAAC;EAChD,CAAC,CAAC;EACF,IAAIK,OAAkC;EAEtC,QAAQX,MAAM;IACZ,KAAKC,kBAAW,CAACC,YAAY;MAC3BS,OAAO,GAAG;QACRC,QAAQ,EAAE,CAACjD,OAAO,CAACC,GAAG,CAAC2C,qBAAqB,CAAW;QACvDP,MAAM,EAAE,CAACrC,OAAO,CAACC,GAAG,CAAC4C,mBAAmB,CAAW;QACnDL;MACF,CAAC;MACD;IACF,KAAKF,kBAAW,CAACY,SAAS;MACxBF,OAAO,GAAG;QACRC,QAAQ,EAAE,CAACjD,OAAO,CAACC,GAAG,CAAC6C,+BAA+B,CAAW;QACjET,MAAM,EAAE,CAACrC,OAAO,CAACC,GAAG,CAAC8C,yBAAyB,CAAW;QACzDP;MACF,CAAC;MACD;IACF;MACE,MAAM,IAAIpC,wBAAW,CAAC;QACpBC,OAAO,EAAE,mCAAmCgC,MAAM;MACpD,CAAC,CAAC;EACN;EAEA,OAAO,IAAIrB,OAAO,CAAmB,CAACmC,OAAO,EAAEC,MAAM,KAAK;IACxD,IAAAC,oBAAM,EAACjB,KAAK,EAAEhB,SAAS,EAAE4B,OAAO,EAAE,CAAClB,KAAK,EAAEwB,MAAM,KAAK;MACnD,IAAIxB,KAAK,EAAE;QACTsB,MAAM,CACJ,IAAIpB,kBAAQ,CAAC;UACXE,SAAS,EAAE,cAAc;UACzBD,UAAU,EAAE,GAAG;UACf5B,OAAO,EAAE,wBAAwB;UACjCqB,IAAI,EAAE;YAAEU;UAAM,CAAC;UACfN,KAAK,EAAEA,KAAK,YAAYC,KAAK,GAAGD,KAAK,GAAGyB;QAC1C,CAAC,CACH,CAAC;QACD;MACF;MACAJ,OAAO,CAACG,MAA0B,CAAC;IACrC,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ;AAEO,SAASE,gBAAgBA,CAACC,IAAa,EAAE;EAC9C,MAAMC,WAAW,GAAG;IAClBC,SAAS,EAAE,OAAgB;IAAE;IAC7BC,SAAS,EAAE,IAAI;IACfvB,MAAM,EAAErC,OAAO,CAACC,GAAG,CAAC4C,mBAAmB;IACvCI,QAAQ,EAAEjD,OAAO,CAACC,GAAG,CAAC2C,qBAAqB;IAC3CiB,KAAK,EAAEC,MAAM,CAACC,IAAI,CAACpE,MAAM,EAAEqE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;EAC/C,CAAC;EAED,MAAMC,UAAU,GAAGC,WAAE,CAACC,YAAY,CAChCnE,OAAO,CAACC,GAAG,CAACmE,gBAAgB,IAAI,sBAAsB,EACtD,MACF,CAAC;EACD,MAAMhC,KAAK,GAAG,IAAAiC,kBAAI,EAAC;IAAEZ;EAAK,CAAC,EAAEQ,UAAU,EAAEP,WAAW,CAAC;EAErD,OAAOtB,KAAK;AACd","ignoreList":[]}

package/dist/utils/jwt/jwt.types.d.ts

@@ -0,0 +1,20 @@
+import { RequestUser } from "../../middleware/authJwt/authJwt.types";
+/** Content of the payload of user authentication tokens */
+export interface UserTokenPayload {
+    /** ID of the user */
+    sub: string;
+    /** URL of the service that issued the token */
+    iss: string;
+    /** URL of the services that can consume the token */
+    aud: Array<string> | string;
+    /** Unique ID of the token */
+    jti: string;
+    /** ID of the device the token was issued to */
+    dev: string;
+    /** Timestamp at which the token will expire */
+    exp: number;
+    /** List of permissions that the user has (only on the admin API) */
+    per?: Array<string> | string;
+    /** User */
+    user: RequestUser;
+}

package/dist/utils/jwt/jwt.types.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=jwt.types.js.map

package/dist/utils/jwt/jwt.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jwt.types.js","names":[],"sources":["../../../src/utils/jwt/jwt.types.ts"],"sourcesContent":["import { RequestUser } from \"middleware/authJwt/authJwt.types\";\n\n/** Content of the payload of user authentication tokens */\nexport interface UserTokenPayload {\n  /** ID of the user */\n  sub: string;\n  /** URL of the service that issued the token */\n  iss: string;\n  /** URL of the services that can consume the token */\n  aud: Array<string> | string;\n  /** Unique ID of the token */\n  jti: string;\n  /** ID of the device the token was issued to */\n  dev: string;\n  /** Timestamp at which the token will expire */\n  exp: number;\n  /** List of permissions that the user has (only on the admin API) */\n  per?: Array<string> | string;\n  /** User */\n  user: RequestUser;\n}\n"],"mappings":"","ignoreList":[]}

package/dist/utils/report/index.d.ts

@@ -0,0 +1,3 @@
+export * from './report';
+export * from './output.types';
+export * from './report.types';

package/dist/utils/report/index.js

@@ -0,0 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _report = require("./report");
+Object.keys(_report).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _report[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _report[key];
+    }
+  });
+});
+var _output = require("./output.types");
+Object.keys(_output).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _output[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _output[key];
+    }
+  });
+});
+var _report2 = require("./report.types");
+Object.keys(_report2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _report2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _report2[key];
+    }
+  });
+});
+//# sourceMappingURL=index.js.map

package/dist/utils/report/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_report","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_output","_report2"],"sources":["../../../src/utils/report/index.ts"],"sourcesContent":["export * from './report';\nexport * from './output.types';\nexport * from './report.types';\n"],"mappings":";;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,OAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,OAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,OAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,OAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,OAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,OAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,OAAA,CAAAL,GAAA;IAAA;EAAA;AAAA;AACA,IAAAM,QAAA,GAAAV,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAQ,QAAA,EAAAP,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAM,QAAA,CAAAN,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAE,QAAA,CAAAN,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/dist/utils/report/output.d.ts

@@ -0,0 +1,4 @@
+import { LogEntry, FullLogEntry } from './output.types';
+export declare const INSTANCE_ID: `${string}-${string}-${string}-${string}-${string}`;
+/** Add metadata to the log entry and print it */
+export declare function output(data: LogEntry): FullLogEntry;

package/dist/utils/report/output.js

@@ -0,0 +1,49 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.INSTANCE_ID = void 0;
+exports.output = output;
+var _crypto = require("crypto");
+var _callsite = _interopRequireDefault(require("callsite"));
+var _jsonStringifySafe = _interopRequireDefault(require("json-stringify-safe"));
+// NOTE: Server instance id (helpful for distributed logs)
+const INSTANCE_ID = exports.INSTANCE_ID = (0, _crypto.randomUUID)();
+
+/** Add metadata to the log entry and print it */
+function output(data) {
+  // Gather useful information about where the logger was called from
+  const call = (0, _callsite.default)()[2];
+
+  // Append additional metadata to the log entry
+  const fullEntry = {
+    ...data,
+    lineNumber: call.getLineNumber(),
+    fileName: call.getFileName().replace(/.*node_modules\//, '').replace(/.*src\//, 'src/'),
+    serviceContext: {
+      service: process.env.CHART ?? process.env.HOSTNAME,
+      version: process.env.BUILD_ID,
+      environment: process.env.NODE_ENV,
+      instance: process.env.KUBERNETES_POD_NAME ?? INSTANCE_ID
+    }
+  };
+  const entry = (0, _jsonStringifySafe.default)(fullEntry);
+  // Ignore when silenced
+  if (process.env.SILENCE_REPORT) return fullEntry;
+  if (process.env.NODE_ENV === 'test') {
+    // In test mode pretty print
+    console.dir(fullEntry, {
+      depth: 5
+    });
+  } else if (data.statusCode && data.statusCode >= 500) {
+    // Log to stderr when it is a 500+ error
+    console.error(entry);
+  } else {
+    // Default to regular logging
+    console.log(entry);
+  }
+  return fullEntry;
+}
+//# sourceMappingURL=output.js.map

package/dist/utils/report/output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.js","names":["_crypto","require","_callsite","_interopRequireDefault","_jsonStringifySafe","INSTANCE_ID","exports","randomUUID","output","data","call","callsite","fullEntry","lineNumber","getLineNumber","fileName","getFileName","replace","serviceContext","service","process","env","CHART","HOSTNAME","version","BUILD_ID","environment","NODE_ENV","instance","KUBERNETES_POD_NAME","entry","stringify","SILENCE_REPORT","console","dir","depth","statusCode","error","log"],"sources":["../../../src/utils/report/output.ts"],"sourcesContent":["import { randomUUID } from 'crypto';\nimport callsite from 'callsite';\nimport stringify from 'json-stringify-safe';\nimport { LogEntry, FullLogEntry } from './output.types';\n\n// NOTE: Server instance id (helpful for distributed logs)\nexport const INSTANCE_ID = randomUUID();\n\n/** Add metadata to the log entry and print it */\nexport function output(data: LogEntry): FullLogEntry {\n  // Gather useful information about where the logger was called from\n  const call = callsite()[2];\n\n  // Append additional metadata to the log entry\n  const fullEntry: FullLogEntry = {\n    ...data,\n    lineNumber: call.getLineNumber(),\n    fileName: call\n      .getFileName()\n      .replace(/.*node_modules\\//, '')\n      .replace(/.*src\\//, 'src/'),\n    serviceContext: {\n      service: process.env.CHART ?? process.env.HOSTNAME,\n      version: process.env.BUILD_ID,\n      environment: process.env.NODE_ENV,\n      instance: process.env.KUBERNETES_POD_NAME ?? INSTANCE_ID\n    }\n  };\n\n  const entry = stringify(fullEntry);\n  // Ignore when silenced\n  if (process.env.SILENCE_REPORT) return fullEntry;\n\n  if (process.env.NODE_ENV === 'test') {\n    // In test mode pretty print\n    console.dir(fullEntry, { depth: 5 });\n  } else if (data.statusCode && data.statusCode >= 500) {\n    // Log to stderr when it is a 500+ error\n    console.error(entry);\n  } else {\n    // Default to regular logging\n    console.log(entry);\n  }\n  return fullEntry;\n}\n"],"mappings":";;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,SAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,kBAAA,GAAAD,sBAAA,CAAAF,OAAA;AAGA;AACO,MAAMI,WAAW,GAAAC,OAAA,CAAAD,WAAA,GAAG,IAAAE,kBAAU,EAAC,CAAC;;AAEvC;AACO,SAASC,MAAMA,CAACC,IAAc,EAAgB;EACnD;EACA,MAAMC,IAAI,GAAG,IAAAC,iBAAQ,EAAC,CAAC,CAAC,CAAC,CAAC;;EAE1B;EACA,MAAMC,SAAuB,GAAG;IAC9B,GAAGH,IAAI;IACPI,UAAU,EAAEH,IAAI,CAACI,aAAa,CAAC,CAAC;IAChCC,QAAQ,EAAEL,IAAI,CACXM,WAAW,CAAC,CAAC,CACbC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAC/BA,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC;IAC7BC,cAAc,EAAE;MACdC,OAAO,EAAEC,OAAO,CAACC,GAAG,CAACC,KAAK,IAAIF,OAAO,CAACC,GAAG,CAACE,QAAQ;MAClDC,OAAO,EAAEJ,OAAO,CAACC,GAAG,CAACI,QAAQ;MAC7BC,WAAW,EAAEN,OAAO,CAACC,GAAG,CAACM,QAAQ;MACjCC,QAAQ,EAAER,OAAO,CAACC,GAAG,CAACQ,mBAAmB,IAAIxB;IAC/C;EACF,CAAC;EAED,MAAMyB,KAAK,GAAG,IAAAC,0BAAS,EAACnB,SAAS,CAAC;EAClC;EACA,IAAIQ,OAAO,CAACC,GAAG,CAACW,cAAc,EAAE,OAAOpB,SAAS;EAEhD,IAAIQ,OAAO,CAACC,GAAG,CAACM,QAAQ,KAAK,MAAM,EAAE;IACnC;IACAM,OAAO,CAACC,GAAG,CAACtB,SAAS,EAAE;MAAEuB,KAAK,EAAE;IAAE,CAAC,CAAC;EACtC,CAAC,MAAM,IAAI1B,IAAI,CAAC2B,UAAU,IAAI3B,IAAI,CAAC2B,UAAU,IAAI,GAAG,EAAE;IACpD;IACAH,OAAO,CAACI,KAAK,CAACP,KAAK,CAAC;EACtB,CAAC,MAAM;IACL;IACAG,OAAO,CAACK,GAAG,CAACR,KAAK,CAAC;EACpB;EACA,OAAOlB,SAAS;AAClB","ignoreList":[]}

package/dist/utils/report/output.types.d.ts

@@ -0,0 +1,65 @@
+import { LogSeverity } from '../../const';
+/** Structure of the request reporting in log entries */
+interface LogEntryRequest {
+    /** Requested URL */
+    url: string;
+    /** HTTP method used */
+    method: string;
+    /** Referer website */
+    referrer?: string;
+    /** User-Agent of the connected client */
+    userAgent?: string;
+    /** IP address of the client */
+    remoteIp: string | undefined;
+    /** HTTP status code returned to the client */
+    responseStatusCode?: number;
+}
+/** Structure of the context entry in log entries */
+interface LogEntryContext {
+    /** User that made a request */
+    user?: string;
+    /** Info on the processed HTTP request */
+    httpRequest?: LogEntryRequest;
+}
+/** Structure of a log entry */
+export interface LogEntry {
+    /** Severity level at which the entry should be logged */
+    severity: LogSeverity;
+    /** Type of error */
+    errorType?: string;
+    /** Human readable error message that will be logged */
+    message: string;
+    /** Stack-trace of the error */
+    stack_trace?: string;
+    /** Additional data that accompanies the error in the logs */
+    data?: unknown;
+    /** Machine readable error code that is returned to the client */
+    errorCode?: string;
+    /** HTTP status code that is returned to the client */
+    statusCode?: number;
+    /** GCP error type */
+    '@type'?: string;
+    /** Error context */
+    context?: LogEntryContext;
+}
+/** Stricture of a log entry context entry */
+interface LogEntryServiceContext {
+    /** Name of the service in which the error ocurred */
+    service?: string;
+    /** Version of the service in which the error ocurred */
+    version?: string;
+    /** Environment in which the error ocurred (dev/staging/prod) */
+    environment?: string;
+    /** ID of the instance that got the error */
+    instance?: string;
+}
+/** Complete log entry with call-stack */
+export interface FullLogEntry extends LogEntry {
+    /** Line at which the error was thrown */
+    lineNumber: number;
+    /** Name of the file in which the error was thrown */
+    fileName: string;
+    /** Context of the error */
+    serviceContext: LogEntryServiceContext;
+}
+export {};

package/dist/utils/report/output.types.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=output.types.js.map

package/dist/utils/report/output.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.types.js","names":[],"sources":["../../../src/utils/report/output.types.ts"],"sourcesContent":["import { LogSeverity } from 'const';\n\n/** Structure of the request reporting in log entries */\ninterface LogEntryRequest {\n  /** Requested URL */\n  url: string;\n  /** HTTP method used */\n  method: string;\n  /** Referer website */\n  referrer?: string;\n  /** User-Agent of the connected client */\n  userAgent?: string;\n  /** IP address of the client */\n  remoteIp: string | undefined;\n  /** HTTP status code returned to the client */\n  responseStatusCode?: number;\n}\n\n/** Structure of the context entry in log entries */\ninterface LogEntryContext {\n  /** User that made a request */\n  user?: string;\n  /** Info on the processed HTTP request */\n  httpRequest?: LogEntryRequest;\n}\n\n/** Structure of a log entry */\nexport interface LogEntry {\n  /** Severity level at which the entry should be logged */\n  severity: LogSeverity;\n  /** Type of error */\n  errorType?: string;\n  /** Human readable error message that will be logged */\n  message: string;\n  /** Stack-trace of the error */\n\n  stack_trace?: string;\n  /** Additional data that accompanies the error in the logs */\n  data?: unknown;\n  /** Machine readable error code that is returned to the client */\n  errorCode?: string;\n  /** HTTP status code that is returned to the client */\n  statusCode?: number;\n  /** GCP error type */\n  '@type'?: string;\n  /** Error context */\n  context?: LogEntryContext;\n}\n\n/** Stricture of a log entry context entry */\ninterface LogEntryServiceContext {\n  /** Name of the service in which the error ocurred */\n  service?: string;\n  /** Version of the service in which the error ocurred */\n  version?: string;\n  /** Environment in which the error ocurred (dev/staging/prod) */\n  environment?: string;\n  /** ID of the instance that got the error */\n  instance?: string;\n}\n\n/** Complete log entry with call-stack */\nexport interface FullLogEntry extends LogEntry {\n  /** Line at which the error was thrown */\n  lineNumber: number;\n  /** Name of the file in which the error was thrown */\n  fileName: string;\n  /** Context of the error */\n  serviceContext: LogEntryServiceContext;\n}\n"],"mappings":"","ignoreList":[]}

package/dist/utils/report/report.d.ts

@@ -0,0 +1,18 @@
+import { Request } from 'express';
+import { FullLogEntry } from './output.types';
+import { DebugLogEntry, InfoLogEntry } from './report.types';
+import { EngineError } from '../../entities/EngineError';
+import { WebError } from '../../entities/WebError';
+/** Default generic logger */
+export declare function reportInfo(data: InfoLogEntry | string): FullLogEntry;
+/** Error specific logger */
+export declare function reportError(error: unknown | Error | EngineError | WebError, request?: Request): FullLogEntry;
+export declare let NAMESPACE_SELECTORS: undefined | Array<RegExp>;
+/** Reset the namespace selectors */
+export declare function resetNamespaceSelector(): void;
+/** Log a message for debugging purpose, based on a namespace specified in an environment variable */
+export declare function reportDebug(data: DebugLogEntry): FullLogEntry | undefined;
+export declare namespace reportDebug {
+    var setNameSpace: (globalNamespace: string) => void;
+    var clearNamespace: () => void;
+}

package/dist/utils/report/report.js

@@ -0,0 +1,119 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NAMESPACE_SELECTORS = void 0;
+exports.reportDebug = reportDebug;
+exports.reportError = reportError;
+exports.reportInfo = reportInfo;
+exports.resetNamespaceSelector = resetNamespaceSelector;
+var _output = require("./output");
+var _const = require("../../const");
+var _EngineError = require("../../entities/EngineError");
+var _WebError = require("../../entities/WebError");
+require("../../middleware/authHmac/authHmac.types");
+require("../../middleware/authJwt/authJwt.types");
+require("../../middleware/authTls/authTls.types");
+require("../../middleware/authAdmin/authAdmin.types");
+/** Default generic logger */
+function reportInfo(data) {
+  return (0, _output.output)({
+    severity: _const.LogSeverity.INFO,
+    ...(typeof data === 'string' ? {
+      message: data
+    } : data)
+  });
+}
+
+/** Error specific logger */
+function reportError(error, request) {
+  let logEntry = error instanceof Error ? {
+    message: error.message,
+    stack_trace: error.stack,
+    severity: _const.LogSeverity.ERROR
+  } : {
+    message: 'An unknown error occurred',
+    data: error,
+    severity: _const.LogSeverity.CRITICAL
+  };
+  if (error instanceof _EngineError.EngineError) {
+    logEntry = {
+      ...logEntry,
+      severity: error.severity,
+      errorType: error.constructor.name,
+      data: error.data,
+      '@type': !(error instanceof _WebError.WebError) || error.statusCode >= 500 ? 'type.googleapis.com/google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent' : undefined
+    };
+  }
+  if (error instanceof _WebError.WebError) {
+    logEntry = {
+      ...logEntry,
+      errorCode: error.errorCode,
+      statusCode: error.statusCode
+    };
+  }
+  if (request) {
+    logEntry = {
+      ...logEntry,
+      context: {
+        user: request.user?.id ?? request.hosts?.join(',') ?? request.admin?.email,
+        httpRequest: {
+          url: request.originalUrl,
+          method: request.method,
+          referrer: request.header('Referer'),
+          userAgent: request.header('User-Agent'),
+          remoteIp: request.ip,
+          responseStatusCode: error instanceof _WebError.WebError ? error.statusCode : undefined
+        }
+      }
+    };
+  }
+  return (0, _output.output)(logEntry);
+}
+let NAMESPACE_SELECTORS = exports.NAMESPACE_SELECTORS = void 0;
+
+/** Generate the namespace selectors based on the debug variable */
+function initNamespaceSelector() {
+  if (process.env.DEBUG) exports.NAMESPACE_SELECTORS = NAMESPACE_SELECTORS = process.env.DEBUG.split(',').map(namespace => new RegExp('^' + namespace.replace(/\*/g, '.*?') + '$'));
+}
+
+/** Reset the namespace selectors */
+function resetNamespaceSelector() {
+  exports.NAMESPACE_SELECTORS = NAMESPACE_SELECTORS = undefined;
+}
+let debugNamespace;
+
+/** Log a message for debugging purpose, based on a namespace specified in an environment variable */
+function reportDebug(data) {
+  if (!NAMESPACE_SELECTORS) initNamespaceSelector();
+  let {
+    namespace
+  } = data;
+  const isEngineReport = namespace ? namespace.startsWith('engine') : false;
+  if (debugNamespace && !isEngineReport) {
+    namespace = debugNamespace + ':' + namespace;
+  }
+  const match = namespace && NAMESPACE_SELECTORS && NAMESPACE_SELECTORS.some(selector => selector.test(namespace));
+  if (!match) return;
+
+  // Generate a prefix with the right most part of the namespace
+  const spaces = namespace.split(':');
+  const prefix = spaces[spaces.length - 1];
+  return (0, _output.output)({
+    severity: _const.LogSeverity.DEBUG,
+    ...data,
+    message: `[${prefix}] ${data.message}`
+  });
+}
+
+/** Specify a global debugging namespace */
+reportDebug.setNameSpace = function (globalNamespace) {
+  debugNamespace = globalNamespace;
+};
+
+/** Remove any defined global namespace */
+reportDebug.clearNamespace = function () {
+  debugNamespace = undefined;
+};
+//# sourceMappingURL=report.js.map