@ngageoint/mage.service 6.3.0-beta.0

package/bin/mage.service.js

@@ -0,0 +1,230 @@
+#!/usr/bin/env node
+
+const { Command, Option, InvalidArgumentError } = require('commander');
+const path = require('path');
+const _ = require('lodash');
+const magePackage = require('../package.json');
+
+const mageCmd = new Command('mage');
+mageCmd.version(magePackage.version);
+
+const optConfigDesc =
+  `A JSON document or path to a JSON file or path to a Node module whose export is a MAGE configuration object, e.g.,
+  ${JSON.stringify({
+    mage: {
+      address: '0.0.0.0',
+      port: 4242,
+      attachmentDir: '/mage/data/attachments',
+      mongo: {
+        poolSize: 2
+      }
+    }
+  }, null, 2).replace(/\n/g, '\n  ')}
+
+Further individual command line parameters will override those in the configuration document.
+`;
+
+const optPluginsDesc =
+  `A JSON document or path to a JSON file in the form
+  ${JSON.stringify({
+    servicePlugins: [
+      '@my/mage-service-plugin-module'
+    ],
+    webUIPlugins: [
+      '@my/mage-web-ui-plugin-module'
+    ]
+  }, null, 2).replace(/\n/g, '\n  ')}
+
+`;
+
+const options = [
+  new Option('-C --config <string>', optConfigDesc).env('MAGE_CONFIG').argParser(parseConfigJsonFromStringOrFile),
+  new Option('-a --address <string>', 'The address on which the web server listens for HTTP requests').env('MAGE_ADDRESS').default('0.0.0.0'),
+  new Option('-p --port <number>', 'The port on which which the web server listens for HTTP requests').env('MAGE_PORT').default(4242).argParser(x => parseInt(x)),
+  new Option('--attachment-dir <string>').env('MAGE_ATTACHMENT_DIR').default('/var/lib/mage/attachments'),
+  new Option('--export-dir <string>').env('MAGE_EXPORT_DIR').default('/var/lib/mage/export'),
+  new Option('--icon-dir <string>').env('MAGE_ICON_DIR').default('/var/lib/mage/icons'),
+  new Option('--layer-dir <string>').env('MAGE_LAYER_DIR').default('/var/lib/mage/layers'),
+  new Option('--security-dir <string>').env('MAGE_SECURITY_DIR').default('/var/lib/mage/security'),
+  new Option('--temp-dir <string>').env('MAGE_TEMP_DIR').default('/tmp'),
+  new Option('--user-dir <string>').env('MAGE_USER_DIR').default('/var/lib/mage/users'),
+  new Option('--export-sweep-interval <number>').env('MAGE_EXPORT_SWEEP_INTERVAL').default(28800, '8 hours').argParser(x => parseInt(x)),
+  new Option('--export-ttl <number>').env('MAGE_EXPORT_TTL').default(259200, '72 hours').argParser(x => parseInt(x)),
+  new Option('--token-expiration <number>').env('MAGE_TOKEN_EXPIRATION').default(28800, '8 hours').argParser(x => parseInt(x)),
+  new Option('--mongo.url <string>', 'The URL to the MongoDB database, e.g., mongodb://127.0.0.1/mage').env('MAGE_MONGO_URL').default('mongodb://127.0.0.1:27017/magedb'),
+  new Option('--mongo.conn-timeout <string>').env('MAGE_MONGO_CONN_TIMEOUT').default(300, '300 seconds').argParser(x => parseInt(x)),
+  new Option('--mongo.conn-retry-delay <string>').env('MAGE_MONGO_CONN_RETRY_DELAY').default(5, '5 seconds').argParser(x => parseInt(x)),
+  new Option('--mongo.pool-size <string>').env('MAGE_MONGO_POOL_SIZE').default(5).argParser(x => parseInt(x)),
+  new Option('--mongo.user <string>').env('MAGE_MONGO_USER'),
+  new Option('--mongo.password <string>').env('MAGE_MONGO_PASSWORD'),
+  new Option('--mongo.ssl [string]').env('MAGE_MONGO_SSL').default(false),
+  new Option('--mongo.replica-set <string>').env('MAGE_MONGO_REPLICA_SET'),
+  new Option('--mongo.x509-key <string>').env('MAGE_MONGO_X509_KEY'),
+  new Option('--mongo.x509-key-file <string>').env('MAGE_MONGO_X509_KEY_FILE'),
+  new Option('--mongo.x509-cert <string>').env('MAGE_MONGO_X509_CERT'),
+  new Option('--mongo.x509-cert-file <string>').env('MAGE_MONGO_X509_CERT_FILE'),
+  new Option('--mongo.x509-ca-cert <string>').env('MAGE_MONGO_X509_CA_CERT'),
+  new Option('--mongo.x509-ca-cert-file <string>').env('MAGE_MONGO_X509_CA_CERT_FILE'),
+  new Option('-P --plugins <string>', optPluginsDesc).env('MAGE_PLUGINS').argParser(parsePluginsJsonFromStringOrModule),
+  new Option('--plugin <module_name...>'),
+  new Option('--web-plugin <module_name...>'),
+  new Option('--show-config', 'Print the effective configuration and exit without starting the server')
+]
+
+options.forEach(x => mageCmd.addOption(x))
+
+mageCmd.parseAsync().then(
+  async mageCmd => {
+    const opts = mageCmd.opts();
+    const merged = mergeOptsToConfig(opts);
+    tempEnvHack(merged);
+    if (merged.showConfig === true) {
+      console.info(JSON.stringify(merged, null, 2));
+      process.exit(0);
+    }
+    const { boot } = require('../lib/app');
+    const service = await boot(merged);
+    service.open();
+  },
+  err => {
+    console.error(err);
+    process.exit(1);
+  }
+);
+
+const configKeyForOptKey = {
+  exportTtl: 'exportTTL'
+};
+
+function mergeOptsToConfig(opts) {
+  const config = opts.config ? opts.config.mage || {} : {};
+  const manualMergeKeys = [ 'config', 'plugins', 'plugin', 'webPlugin' ];
+  const optsSimple = _.omit(opts, manualMergeKeys);
+  const DefaultValue = function(x) {
+    this.value = x;
+  };
+  const optsDefaultsMarked = _.mapValues(optsSimple, (value, key) => {
+    const optionDef = options.find(x => x.attributeName() === key);
+    if (optionDef.defaultValue && optionDef.defaultValue === value) {
+      return new DefaultValue(value);
+    }
+    return value;
+  });
+  const optsWithConfigKeys = _.mapKeys(optsDefaultsMarked, (v, k) => configKeyForOptKey[k] || k);
+  const optsNested = Object.entries(optsWithConfigKeys).reduce((optsNested, entry) => {
+    if (manualMergeKeys[entry[0]]) {
+      return optsNested;
+    }
+    const nestedEntry = dotsToNested(entry);
+    return _.merge(optsNested, nestedEntry);
+  }, {});
+  const overriddenDefaults = _.mergeWith({}, config, optsNested, (configValue, optValue, key) => {
+    if (!optValue) {
+      return configValue;
+    }
+    if (typeof configValue === 'object') {
+      // nested object - continue recursive merge
+      return void(0);
+    }
+    if (!configValue) {
+      return optValue instanceof DefaultValue ? optValue.value : void(0);
+    }
+    if (optValue instanceof DefaultValue) {
+      return configValue;
+    }
+    if (typeof optValue === 'object') {
+      // nested object - continue recursive merge
+      return void(0);
+    }
+    return optValue;
+  });
+  const plugins = mergePlugins(opts, config);
+  return { ...overriddenDefaults, plugins };
+}
+
+function dotsToNested(entry) {
+  const steps = entry[0].split('.');
+  const nested = steps.slice(0, -1).reduceRight((nested, key) => {
+    return { [key]: nested };
+  }, { [steps.slice(-1)]: entry[1] });
+  return nested;
+}
+
+function mergePlugins(opts, config) {
+  const optsPlugins = opts.plugins || {};
+  const configPlugins = config.plugins || {};
+  const servicePlugins = (opts.plugin || []).concat(optsPlugins.servicePlugins || []).concat(configPlugins.servicePlugins || [])
+  const webUIPlugins = (opts.webPlugin || []).concat(optsPlugins.webUIPlugins || []).concat(configPlugins.webUIPlugins || [])
+  return { servicePlugins, webUIPlugins }
+}
+
+function parseConfigJsonFromStringOrFile(jsonOrPath) {
+  const config = parseJsonFromStringOrModule(jsonOrPath);
+  // TODO: validation
+  return config;
+}
+
+function parsePluginsJsonFromStringOrModule(jsonOrPath) {
+  const plugins = parseJsonFromStringOrModule(jsonOrPath);
+  if (!plugins || typeof plugins !== 'object') {
+    throw new InvalidArgumentError('plugins must be a JSON object');
+  }
+  if (plugins.servicePlugins && !Array.isArray(plugins.servicePlugins)) {
+    throw new InvalidArgumentError('plugins JSON key servicePlugins must be an array of strings')
+  }
+  if (plugins.webUIPlugins && !Array.isArray(plugins.webUIPlugins)) {
+    throw new InvalidArgumentError('plugins JSON key webUIPlugins must an array of strings')
+  }
+  return plugins;
+}
+
+function parseJsonFromStringOrModule(jsonOrModulePath) {
+  let json = null;
+  try {
+    json = JSON.parse(jsonOrModulePath);
+  }
+  catch (err) { }
+  if (!json) {
+    try {
+      const jsonPath = path.resolve(process.cwd(), jsonOrModulePath);
+      json = require(jsonPath);
+    }
+    catch (err) {
+      console.error(err);
+      throw new InvalidArgumentError(`failed to parse JSON file from path ${jsonOrModulePath}`);
+    }
+  }
+  return json;
+}
+
+/**
+ * Populate `process.env` with key-value pairs using the environment variable
+ * names associated with the keys in the given configuration object.  This
+ * supports legacy code that accesses `process.env` directly, or through
+ * MAGE's `environment/env` module and maintains the behavior of overriding
+ * environment variables with command line parameters.
+ * TODO: this will go away when we remove all direct env references
+ * from downstream code, let commander handle the env vars, and pass
+ * the configuration object to the mage app
+ */
+function tempEnvHack(config) {
+  options.forEach(option => {
+    const optKey = option.attributeName();
+    const configKey = configKeyForOptKey[optKey] || optKey;
+    const { envVar } = option;
+    if (!envVar) {
+      return;
+    }
+    const optVal = _.get(config, configKey);
+    if (typeof optVal === 'object') {
+      return;
+    }
+    if (process.env[envVar] && process.env[envVar] === String(optVal)) {
+      return;
+    }
+    if (!optVal) {
+      return;
+    }
+    process.env[envVar] = String(optVal);
+  });
+}

package/bin/migration.js

@@ -0,0 +1,60 @@
+#! /usr/bin/env node
+/* eslint-disable @typescript-eslint/no-use-before-define */
+const path = require('path');
+const fs = require('fs');
+const { program: prog } = require('commander');
+const env = require('../lib/environment/env');
+const mongoose = require('mongoose');
+
+mongoose.set('debug', true)
+const srcMigrationsDir = path.resolve(__dirname, '..', 'src', 'migrations');
+prog.version('0');
+prog.command('create <name>')
+  .description('generate a new migration script in the migrations directory')
+  .action(name => {
+    // had to do this intead of mongodb-migrations's Migrator.create() because
+    // that tries to require() all the migration files instead of just finding
+    // the next ordinal to assign.  loading the migration files with require()
+    // fails because they cannot load the typescript modules in the source tree.
+    const migrationFiles = parseMigrationFileNames();
+    const last = migrationFiles[migrationFiles.length - 1] || null
+    const next = last ? last.ordinal + 1 : 1;
+    const nextFormatted = String(next).padStart(3, '0');
+    const migrationFileName = `${nextFormatted}-${name}.js`;
+    const migrationPath = path.resolve(srcMigrationsDir, migrationFileName);
+    const stub = require('mongodb-migrations/lib/migration-stub')(name);
+    fs.writeFileSync(migrationPath, stub);
+    console.log(`created migration stub ${migrationPath}`);
+  });
+prog.command('run')
+  .description('apply all the migrations in lib/migrations directory.  make sure you npm run build first!')
+  .action(async () => {
+    const { uri, connectRetryDelay, connectTimeout, options } = env.mongo
+    const { waitForDefaultMongooseConnection } = require('../lib/adapters/adapters.db.mongoose')
+    await waitForDefaultMongooseConnection(mongoose, uri, connectTimeout, connectRetryDelay, options)
+    const { runDatabaseMigrations } = require('../lib/migrate')
+    await runDatabaseMigrations(env.mongo.uri, env.mongo.options)
+    return mongoose.connection.close()
+  });
+prog.parse(process.argv);
+function parseMigrationFileNames() {
+  const files = fs.readdirSync(srcMigrationsDir);
+  return files.filter(function (f) {
+    return path.extname(f) === '.js' && !f.startsWith('.');
+  }).map(function (f) {
+    let ordinal = null;
+    const numericPrefix = f.match(/^(\d+)/);
+    if (numericPrefix) {
+      ordinal = parseInt(numericPrefix[1]);
+    }
+    if (!ordinal) {
+      throw new Error(`migration file does not have numeric ordering prefix: ${f}`);
+    }
+    return {
+      ordinal,
+      name: f
+    };
+  }).sort(function (f1, f2) {
+    return f1.ordinal - f2.ordinal;
+  })
+}

package/bin/poststop.sh

@@ -0,0 +1 @@
+# put your poststop specific code here

package/bin/prestart.sh

@@ -0,0 +1 @@
+# put your prestart specific code here

package/lib/@types/express/index.d.ts

@@ -0,0 +1,18 @@
+import { UserDocument } from '../../models/user'
+
+declare module 'express-serve-static-core' {
+  export interface Request {
+    user: UserDocument
+    provisionedDeviceId: string
+    /**
+     * Return the root HTTP URL of the server, including the scheme, e.g.,
+     * `https://mage.io`.
+     */
+    getRoot(): string
+    /**
+     * Return the fully qualified request path, which is the path of the
+     * request concatenated to the result of {@link getRoot()}
+     */
+    getPath(): string
+  }
+}

package/lib/@types/geojson-validation/index.d.ts

@@ -0,0 +1,15 @@
+
+
+declare module 'geojson-validation' {
+
+  import * as geojson from 'geojson'
+
+  namespace GeoJSONValidation {
+
+    export function define(type: geojson.GeoJsonTypes | 'Position', validationErrors: (x: any) => string[]): void
+    export function isGeometryObject(x: any, trace?: false): x is geojson.Geometry
+    export function isGeometryObject(x: any, trace: true): string[]
+  }
+
+  export = GeoJSONValidation
+}

package/lib/@types/mongodb-migrations/index.d.ts

@@ -0,0 +1,99 @@
+
+
+declare module 'mongodb-migrations' {
+
+  import { MongoClientOptions } from 'mongodb'
+  export { MongoClientOptions } from 'mongodb'
+
+  export class Migrator {
+
+    constructor(config: MigratorConfig, log?: LogFunction | null)
+    /**
+     * Return a promise that resolves to the created migration file name.
+     * @param description the migration description
+     */
+    create(dir: string, id: string, callback: (err: any) => any): void
+    /**
+     * Add the given migration to this migrator.
+     */
+    add(m: Migration): void
+    /**
+     * Add all the {@linkcode Migration} objects in the given array to this
+     * migrator.
+     */
+    bulkAdd(m: Migration[]): void
+    /**
+     * Apply the {@link Migration | migrations} {@link Migrator.add | added} to this
+     * migrator by calling {@linkcode Migration.up} on each migration.
+     * @param done
+     * @param progress
+     */
+    migrate(done: DoneCallback, progress: ProgressCallback): void
+    /**
+     * Reverse the {@link Migration | migrations} {@link Migrator.add | added} to this
+     * migrator by calling {@linkcode Migration.down} on each migration.
+     * @param done
+     * @param progress
+     */
+    rollback(done: DoneCallback, progress: ProgressCallback): void
+    /**
+     * Run the {@linkcode Migration} modules found in the given directory.
+     * @param dir a directory path containing migration scripts
+     * @param done a function to call when the whole migration set is complete
+     * @param progress a function to call when each individual migration completes
+     */
+    runFromDir(dir: string, done: DoneCallback, progress?: ProgressCallback): void
+    /**
+     * Release the MongoDB connection pool associted with this migrator.
+     * @param callback
+     */
+    dispose(callback: (err: any) => any): void
+  }
+
+  export type LogFunction = (level: 'system' | 'user', message: string) => any
+  export type DoneCallback = (err: any, results: MigrationSetResults) => any
+  export type ProgressCallback = (migrationId: string, result: MigrationResult) => any
+
+  export interface MigratorConfig {
+    /**
+     * This is the URL that defines how to connect to the MongoDB database
+     * server.
+     */
+    url: string,
+    /**
+     * This is the name of the collection that stores migration information.
+     * The default value is  `'_migrations'`.
+     */
+    collection?: string,
+    /**
+     * `directory` is the path where migration scripts are.  This is only used
+     * when running from the command line, which passes `directory` from the
+     * config object to `{@linkcode Migrator.runFromDir}.
+     */
+    directory?: string,
+    options?: MongoClientOptions
+  }
+
+  export interface Migration {
+    id: string
+    up?: (callback: (err: any) => any) => any
+    down?: (callback: (err: any) => any) => any
+  }
+
+  export interface MigrationResult {
+    status: 'ok' | 'skip' | 'error'
+    error: Error
+    /**
+     * Indicate why a migration was skipped.
+     */
+    code: 'no_up' | 'no_down' | 'already_ran' | 'not_in_recent_migrate'
+    /**
+     * Human-readable explanation of `code`
+     */
+    reason: string
+  }
+
+  export interface MigrationSetResults {
+    [migrationId: string]: MigrationResult
+  }
+}

package/lib/access/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Module dependencies.
+ */
+import express from 'express';
+import { AnyPermission } from '../entities/authorization/entities.permissions';
+import { UserDocument } from '../models/user';
+declare const _default: Readonly<{
+    /**
+     * Return an Express.js middleware function that checks for the given
+     * permission on the requesting user's role.  The request does not have a
+     * user, the middleware will simply delegate to the next middleware in the
+     * queue.  If the requesting user does not have the given permission, send
+     * a 403 status and text response.
+     * @param permission
+     * @returns
+     */
+    authorize(permission: AnyPermission): express.RequestHandler;
+    userHasPermission(user: UserDocument, permission: AnyPermission): boolean;
+}>;
+export = _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/access/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/access/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAA;AAE9E,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;;IAI3C;;;;;;;;OAQG;0BACmB,aAAa,GAAG,QAAQ,cAAc;4BAkBpC,YAAY,cAAc,aAAa;;AA7BjE,kBAoCE"}

package/lib/access/index.js

@@ -0,0 +1,40 @@
+"use strict";
+/**
+ * Module dependencies.
+ */
+module.exports = Object.freeze({
+    /**
+     * Return an Express.js middleware function that checks for the given
+     * permission on the requesting user's role.  The request does not have a
+     * user, the middleware will simply delegate to the next middleware in the
+     * queue.  If the requesting user does not have the given permission, send
+     * a 403 status and text response.
+     * @param permission
+     * @returns
+     */
+    authorize(permission) {
+        return function (req, res, next) {
+            if (!req.user) {
+                return next();
+            }
+            const role = req.user.roleId;
+            if (!role) {
+                return res.sendStatus(403);
+            }
+            const userPermissions = role.permissions;
+            const ok = userPermissions.indexOf(permission) !== -1;
+            if (!ok) {
+                return res.sendStatus(403);
+            }
+            next();
+        };
+    },
+    userHasPermission(user, permission) {
+        if (!user || !user.roleId) {
+            return false;
+        }
+        const role = user.roleId;
+        return role.permissions.indexOf(permission) !== -1;
+    }
+});
+//# sourceMappingURL=index.js.map

package/lib/access/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/access/index.ts"],"names":[],"mappings":";AAAA;;GAEG;AAOH,iBAAS,MAAM,CAAC,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,SAAS,CAAC,UAAyB;QACjC,OAAO,UAAS,GAAG,EAAE,GAAG,EAAE,IAAI;YAC5B,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;gBACb,OAAO,IAAI,EAAE,CAAA;aACd;YACD,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,MAAsB,CAAA;YAC5C,IAAI,CAAC,IAAI,EAAE;gBACT,OAAO,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;aAC3B;YACD,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAA;YACxC,MAAM,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;YACrD,IAAI,CAAC,EAAE,EAAE;gBACP,OAAO,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;aAC3B;YACD,IAAI,EAAE,CAAA;QACR,CAAC,CAAA;IACH,CAAC;IAED,iBAAiB,CAAC,IAAkB,EAAE,UAAyB;QAC7D,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACzB,OAAO,KAAK,CAAA;SACb;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,MAAsB,CAAA;QACxC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;IACpD,CAAC;CACF,CAAC,CAAA"}

package/lib/adapters/adapters.controllers.web.d.ts

@@ -0,0 +1,22 @@
+import express from 'express';
+import { AppRequest } from '../app.api/app.api.global';
+export interface WebAppRequestFactory<Req extends AppRequest = AppRequest> {
+    <RequestParams extends object = {}>(webReq: express.Request, params?: RequestParams): Req & RequestParams;
+}
+/**
+ * Send HTTP responses with status codes that map to error codes of
+ * {@link MageError} instances from the application layer.  For example, send
+ * a `403` response for {@link ErrPermissionDenied}.
+ */
+export declare const mageAppErrorHandler: express.ErrorRequestHandler;
+/**
+ * This is the same as {@link mageAppErrorHandler}, but instead of just a bare
+ * JSON string as the request body, sends a JSON object as the response like
+ * ```
+ * { "message": "the error message" }
+ * ```
+ * This is what clients expect from the legacy routes, so new routes that
+ * replace them need to send errors in this structure.
+ */
+export declare const compatibilityMageAppErrorHandler: express.ErrorRequestHandler;
+//# sourceMappingURL=adapters.controllers.web.d.ts.map

package/lib/adapters/adapters.controllers.web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapters.controllers.web.d.ts","sourceRoot":"","sources":["../../src/adapters/adapters.controllers.web.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAEtD,MAAM,WAAW,oBAAoB,CAAC,GAAG,SAAS,UAAU,GAAG,UAAU;IACvE,CAAC,aAAa,SAAS,MAAM,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,GAAG,GAAG,aAAa,CAAA;CAC1G;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,CAAC,mBAgBzC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC,EAAE,OAAO,CAAC,mBAgBtD,CAAA"}

package/lib/adapters/adapters.controllers.web.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compatibilityMageAppErrorHandler = exports.mageAppErrorHandler = void 0;
+const app_api_errors_1 = require("../app.api/app.api.errors");
+/**
+ * Send HTTP responses with status codes that map to error codes of
+ * {@link MageError} instances from the application layer.  For example, send
+ * a `403` response for {@link ErrPermissionDenied}.
+ */
+const mageAppErrorHandler = (err, req, res, next) => {
+    console.error(new Date().toISOString(), '- error processing request', req.method, req.path, err);
+    if (!(err instanceof app_api_errors_1.MageError)) {
+        return next(err);
+    }
+    switch (err.code) {
+        case app_api_errors_1.ErrPermissionDenied:
+            return res.status(403).json(`permission denied: ${err.data.permission}`);
+        case app_api_errors_1.ErrEntityNotFound:
+            return res.status(404).json(err.message);
+        case app_api_errors_1.ErrInvalidInput:
+            return res.status(400).json(err.message);
+        case app_api_errors_1.ErrInfrastructure:
+            return res.status(500).json(err.message);
+    }
+    next(err);
+};
+exports.mageAppErrorHandler = mageAppErrorHandler;
+/**
+ * This is the same as {@link mageAppErrorHandler}, but instead of just a bare
+ * JSON string as the request body, sends a JSON object as the response like
+ * ```
+ * { "message": "the error message" }
+ * ```
+ * This is what clients expect from the legacy routes, so new routes that
+ * replace them need to send errors in this structure.
+ */
+const compatibilityMageAppErrorHandler = (err, req, res, next) => {
+    console.error(new Date().toISOString(), '- error processing request', req.method, req.path, err);
+    if (!(err instanceof app_api_errors_1.MageError)) {
+        return next(err);
+    }
+    switch (err.code) {
+        case app_api_errors_1.ErrPermissionDenied:
+            return res.status(403).json({ message: `permission denied: ${err.data.permission}` });
+        case app_api_errors_1.ErrEntityNotFound:
+            return res.status(404).json({ message: err.message });
+        case app_api_errors_1.ErrInvalidInput:
+            return res.status(400).json({ message: err.message });
+        case app_api_errors_1.ErrInfrastructure:
+            return res.status(500).json({ message: err.message });
+    }
+    next(err);
+};
+exports.compatibilityMageAppErrorHandler = compatibilityMageAppErrorHandler;
+//# sourceMappingURL=adapters.controllers.web.js.map

package/lib/adapters/adapters.controllers.web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapters.controllers.web.js","sourceRoot":"","sources":["../../src/adapters/adapters.controllers.web.ts"],"names":[],"mappings":";;;AACA,8DAAwJ;AAOxJ;;;;GAIG;AACI,MAAM,mBAAmB,GAAgC,CAAC,GAAQ,EAAE,GAAoB,EAAE,GAAqB,EAAE,IAA0B,EAAQ,EAAE;IAC1J,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,4BAA4B,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;IAChG,IAAI,CAAC,CAAC,GAAG,YAAY,0BAAS,CAAC,EAAE;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAA;KACjB;IACD,QAAQ,GAAG,CAAC,IAAI,EAAE;QAChB,KAAK,oCAAmB;YACtB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,sBAAuB,GAA6B,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QACrG,KAAK,kCAAiB;YACpB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAC1C,KAAK,gCAAe;YAClB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAC1C,KAAK,kCAAiB;YACpB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;KAC3C;IACD,IAAI,CAAC,GAAG,CAAC,CAAA;AACX,CAAC,CAAA;AAhBY,QAAA,mBAAmB,uBAgB/B;AAED;;;;;;;;GAQG;AACI,MAAM,gCAAgC,GAAgC,CAAC,GAAQ,EAAE,GAAoB,EAAE,GAAqB,EAAE,IAA0B,EAAQ,EAAE;IACvK,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,4BAA4B,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;IAChG,IAAI,CAAC,CAAC,GAAG,YAAY,0BAAS,CAAC,EAAE;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAA;KACjB;IACD,QAAQ,GAAG,CAAC,IAAI,EAAE;QAChB,KAAK,oCAAmB;YACtB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,sBAAuB,GAA6B,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;QAClH,KAAK,kCAAiB;YACpB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;QACvD,KAAK,gCAAe;YAClB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;QACvD,KAAK,kCAAiB;YACpB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;KACxD;IACD,IAAI,CAAC,GAAG,CAAC,CAAA;AACX,CAAC,CAAA;AAhBY,QAAA,gCAAgC,oCAgB5C"}

package/lib/adapters/adapters.db.mongoose.d.ts

@@ -0,0 +1,5 @@
+import mongoose, { Mongoose } from 'mongoose';
+import { EntityIdFactory } from '../entities/entities.global';
+export declare const waitForDefaultMongooseConnection: (mongoose: Mongoose, uri: string, retryTotalTime: number, retryInterval: number, options: mongoose.ConnectOptions) => Promise<void>;
+export declare const MongoDbObjectIdFactory: EntityIdFactory;
+//# sourceMappingURL=adapters.db.mongoose.d.ts.map

package/lib/adapters/adapters.db.mongoose.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapters.db.mongoose.d.ts","sourceRoot":"","sources":["../../src/adapters/adapters.db.mongoose.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAA;AAiD7D,eAAO,MAAM,gCAAgC,aAAc,QAAQ,OAAO,MAAM,kBAAkB,MAAM,iBAAiB,MAAM,uCAAqC,QAAQ,IAAI,CAU/K,CAAA;AAED,eAAO,MAAM,sBAAsB,EAAE,eAIpC,CAAA"}