@vsaas/loopback 10.0.0

package/dist/lib/loopback.cjs

@@ -0,0 +1,313 @@
+"use strict";
+const require_runtime$1 = require("../_virtual/_rolldown/runtime.cjs");
+const require_lib_server_app = require("./server-app.cjs");
+const require_lib_runtime = require("./runtime.cjs");
+const require_lib_registry = require("./registry.cjs");
+const require_lib_application = require("./application.cjs");
+const require_lib_configure_shared_methods = require("./configure-shared-methods.cjs");
+const require_package$1 = require("../package.cjs");
+const require_lib_builtin_models = require("./builtin-models.cjs");
+const require_lib_current_context = require("./current-context.cjs");
+//#region src/lib/loopback.ts
+/*!
+* Module dependencies.
+*/
+var require_loopback = /* @__PURE__ */ require_runtime$1.__commonJSMin(((exports, module) => {
+	const path = require("path");
+	const express = require("express");
+	const loopbackExpress = require_lib_server_app;
+	const runtime = require_lib_runtime;
+	const proto = require_lib_application;
+	const fs = require("fs");
+	const ejs = require("ejs");
+	require("assert");
+	const Registry = require_lib_registry;
+	const juggler = require("@vsaas/loopback-datasource-juggler");
+	const configureSharedMethods = require_lib_configure_shared_methods;
+	/**
+	* LoopBack core module. It provides static properties and
+	* methods to create models and data sources. The module itself is a function
+	* that creates loopback `app`. For example:
+	*
+	* ```js
+	* var loopback = require('loopback');
+	* var app = loopback();
+	* ```
+	*
+	* @property {String} version Version of LoopBack framework.  Static read-only property.
+	* @property {Boolean} isBrowser True if running in a browser environment; false otherwise.  Static read-only property.
+	* @property {Boolean} isServer True if running in a server environment; false otherwise.  Static read-only property.
+	* @property {Registry} registry The global `Registry` object.
+	* @property {String} faviconFile Path to a default favicon shipped with LoopBack.
+	* Use as follows: `app.use(require('serve-favicon')(loopback.faviconFile));`
+	* @class loopback
+	* @header loopback
+	*/
+	const loopback = module.exports = createApplication;
+	/*!
+	* Framework version.
+	*/
+	loopback.version = require_package$1.default.version;
+	loopback.registry = new Registry();
+	runtime.loopback = loopback;
+	Object.defineProperties(loopback, {
+		Model: { get: function() {
+			return this.registry.getModel("Model");
+		} },
+		PersistedModel: { get: function() {
+			return this.registry.getModel("PersistedModel");
+		} },
+		defaultDataSources: { get: function() {
+			return this.registry.defaultDataSources;
+		} },
+		modelBuilder: { get: function() {
+			return this.registry.modelBuilder;
+		} }
+	});
+	/*!
+	* Create an loopback application.
+	*
+	* @return {Function}
+	* @api public
+	*/
+	function createApplication(options) {
+		const app = loopbackExpress();
+		Object.assign(app, proto);
+		app.loopback = loopback;
+		app.on("modelRemoted", function() {
+			app.models().forEach(function(Model) {
+				if (!Model.config) return;
+				configureSharedMethods(Model, app.get("remoting"), Model.config);
+			});
+		});
+		app.models = function() {
+			return proto.models.apply(this, arguments);
+		};
+		app.datasources = app.dataSources = {};
+		app.connectors = {};
+		app.connector("memory", loopback.Memory);
+		app.connector("remote", loopback.Remote);
+		if (loopback.isServer) app.connector("kv-memory", require("@vsaas/loopback-datasource-juggler/connectors/kv-memory"));
+		if (loopback.localRegistry || options && options.localRegistry === true) {
+			const registry = app.registry = new Registry();
+			if (options && options.loadBuiltinModels === true) require_lib_builtin_models(registry);
+		} else app.registry = loopback.registry;
+		return app;
+	}
+	function mixin(source) {
+		for (const key in source) {
+			const desc = Object.getOwnPropertyDescriptor(source, key);
+			if (!desc) continue;
+			Object.defineProperty(loopback, key, desc);
+		}
+	}
+	mixin(runtime);
+	/*!
+	* Expose static express methods like `express.Router`.
+	*/
+	mixin(express);
+	/*!
+	* Expose additional loopback middleware
+	* for example `loopback.configure` etc.
+	*
+	* ***only in node***
+	*/
+	if (loopback.isServer) {
+		const middlewareDir = path.join(__dirname, "..", "server", "middleware");
+		fs.readdirSync(middlewareDir).filter(function(file) {
+			return file.match(/\.cjs$/);
+		}).forEach(function(m) {
+			loopback[m.replace(/\.cjs$/, "")] = require(path.join(middlewareDir, m));
+		});
+		loopback.urlNotFound = loopback["url-not-found"];
+		delete loopback["url-not-found"];
+		loopback.errorHandler = loopback["error-handler"];
+		delete loopback["error-handler"];
+	}
+	if (loopback.isServer)
+ /*!
+	* Path to a default favicon shipped with LoopBack.
+	*
+	* **Example**
+	*
+	* ```js
+	* app.use(require('serve-favicon')(loopback.faviconFile));
+	* ```
+	*/
+	loopback.faviconFile = path.resolve(getPackageRoot(), "favicon.ico");
+	/**
+	* Add a remote method to a model.
+	* @param {Function} fn
+	* @param {Object} options (optional)
+	*/
+	loopback.remoteMethod = function(fn, options) {
+		fn.shared = true;
+		if (typeof options === "object") Object.keys(options).forEach(function(key) {
+			fn[key] = options[key];
+		});
+		fn.http = fn.http || { verb: "get" };
+	};
+	/**
+	* Create a template helper.
+	*
+	*     var render = loopback.template('foo.ejs');
+	*     var html = render({foo: 'bar'});
+	*
+	* @param {String} file Path to the template file.
+	* @returns {Function}
+	*/
+	loopback.template = function(file) {
+		const templates = this._templates || (this._templates = {});
+		let render = templates[file];
+		if (!render) {
+			render = ejs.compile(fs.readFileSync(file, "utf8"), { filename: file });
+			templates[file] = render;
+		}
+		return render;
+	};
+	require_lib_current_context(loopback);
+	/**
+	* Create a named vanilla JavaScript class constructor with an attached
+	* set of properties and options.
+	*
+	* This function comes with two variants:
+	*  * `loopback.createModel(name, properties, options)`
+	*  * `loopback.createModel(config)`
+	*
+	* In the second variant, the parameters `name`, `properties` and `options`
+	* are provided in the config object. Any additional config entries are
+	* interpreted as `options`, i.e. the following two configs are identical:
+	*
+	* ```js
+	* { name: 'Customer', base: 'User' }
+	* { name: 'Customer', options: { base: 'User' } }
+	* ```
+	*
+	* **Example**
+	*
+	* Create an `Author` model using the three-parameter variant:
+	*
+	* ```js
+	* loopback.createModel(
+	*   'Author',
+	*   {
+	*     firstName: 'string',
+	*     lastName: 'string'
+	*   },
+	*   {
+	*     relations: {
+	*       books: {
+	*         model: 'Book',
+	*         type: 'hasAndBelongsToMany'
+	*       }
+	*     }
+	*   }
+	* );
+	* ```
+	*
+	* Create the same model using a config object:
+	*
+	* ```js
+	* loopback.createModel({
+	*   name: 'Author',
+	*   properties: {
+	*     firstName: 'string',
+	*     lastName: 'string'
+	*   },
+	*   relations: {
+	*     books: {
+	*       model: 'Book',
+	*       type: 'hasAndBelongsToMany'
+	*     }
+	*   }
+	* });
+	* ```
+	*
+	* @param {String} name Unique name.
+	* @param {Object} properties
+	* @param {Object} options (optional)
+	*
+	* @header loopback.createModel
+	*/
+	loopback.createModel = function(name, properties, options) {
+		return this.registry.createModel.apply(this.registry, arguments);
+	};
+	/**
+	* Alter an existing Model class.
+	* @param {Model} ModelCtor The model constructor to alter.
+	* @options {Object} config Additional configuration to apply
+	* @property {DataSource} dataSource Attach the model to a dataSource.
+	* @property {Object} [relations] Model relations to add/update.
+	*
+	* @header loopback.configureModel(ModelCtor, config)
+	*/
+	loopback.configureModel = function(ModelCtor, config) {
+		return this.registry.configureModel.apply(this.registry, arguments);
+	};
+	/**
+	* Look up a model class by name from all models created by
+	* `loopback.createModel()`
+	* @param {String} modelName The model name
+	* @returns {Model} The model class
+	*
+	* @header loopback.findModel(modelName)
+	*/
+	loopback.findModel = function(modelName) {
+		return this.registry.findModel.apply(this.registry, arguments);
+	};
+	/**
+	* Look up a model class by name from all models created by
+	* `loopback.createModel()`. Throw an error when no such model exists.
+	*
+	* @param {String} modelName The model name
+	* @returns {Model} The model class
+	*
+	* @header loopback.getModel(modelName)
+	*/
+	loopback.getModel = function(modelName) {
+		return this.registry.getModel.apply(this.registry, arguments);
+	};
+	/**
+	* Look up a model class by the base model class.
+	* The method can be used by LoopBack
+	* to find configured models in models.json over the base model.
+	* @param {Model} modelType The base model class
+	* @returns {Model} The subclass if found or the base class
+	*
+	* @header loopback.getModelByType(modelType)
+	*/
+	loopback.getModelByType = function(modelType) {
+		return this.registry.getModelByType.apply(this.registry, arguments);
+	};
+	/**
+	* Create a data source with passing the provided options to the connector.
+	*
+	* @param {String} name Optional name.
+	* @options {Object} options Data Source options
+	* @property {Object} connector LoopBack connector.
+	* @property {*} [*] Other connector properties.
+	*   See the relevant connector documentation.
+	*/
+	loopback.createDataSource = function(name, options) {
+		return this.registry.createDataSource.apply(this.registry, arguments);
+	};
+	/**
+	* Get an in-memory data source. Use one if it already exists.
+	*
+	* @param {String} [name] The name of the data source.
+	* If not provided, the `'default'` is used.
+	*/
+	loopback.memory = function(name) {
+		return this.registry.memory.apply(this.registry, arguments);
+	};
+	/*!
+	* Built in models / services
+	*/
+	require_lib_builtin_models(loopback);
+	loopback.DataSource = juggler.DataSource;
+	function getPackageRoot() {
+		return path.join(__dirname, "..", "..");
+	}
+}));
+//#endregion
+module.exports = require_loopback();