inversify 4.9.0 → 4.13.0

package/es/constants/error_msgs.js

@@ -7,6 +7,11 @@ export var CANNOT_UNBIND = "Could not unbind serviceIdentifier:";
 export var NOT_REGISTERED = "No matching bindings found for serviceIdentifier:";
 export var MISSING_INJECTABLE_ANNOTATION = "Missing required @injectable annotation in:";
 export var MISSING_INJECT_ANNOTATION = "Missing required @inject or @multiInject annotation in:";
+export var UNDEFINED_INJECT_ANNOTATION = function (name) {
+    return "@inject called with undefined this could mean that the class " + name + " has " +
+        "a circular dependency problem. You can use a LazyServiceIdentifer to  " +
+        "overcome this limitation.";
+};
 export var CIRCULAR_DEPENDENCY = "Circular dependency found:";
 export var NOT_IMPLEMENTED = "Sorry, this feature is not fully implemented yet.";
 export var INVALID_BINDING_TYPE = "Invalid binding type:";
@@ -17,14 +22,22 @@ export var INVALID_TO_SELF_VALUE = "The toSelf function can only be applied when
     "used as service identifier";
 export var INVALID_DECORATOR_OPERATION = "The @inject @multiInject @tagged and @named decorators " +
     "must be applied to the parameters of a class constructor or a class property.";
-export var ARGUMENTS_LENGTH_MISMATCH_1 = "The number of constructor arguments in the derived class ";
-export var ARGUMENTS_LENGTH_MISMATCH_2 = " must be >= than the number of constructor arguments of its base class.";
+export var ARGUMENTS_LENGTH_MISMATCH = function () {
+    var values = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        values[_i] = arguments[_i];
+    }
+    return "The number of constructor arguments in the derived class " +
+        (values[0] + " must be >= than the number of constructor arguments of its base class.");
+};
 export var CONTAINER_OPTIONS_MUST_BE_AN_OBJECT = "Invalid Container constructor argument. Container options " +
     "must be an object.";
 export var CONTAINER_OPTIONS_INVALID_DEFAULT_SCOPE = "Invalid Container option. Default scope must " +
     "be a string ('singleton' or 'transient').";
 export var CONTAINER_OPTIONS_INVALID_AUTO_BIND_INJECTABLE = "Invalid Container option. Auto bind injectable must " +
     "be a boolean";
+export var CONTAINER_OPTIONS_INVALID_SKIP_BASE_CHECK = "Invalid Container option. Skip base check must " +
+    "be a boolean";
 export var MULTIPLE_POST_CONSTRUCT_METHODS = "Cannot apply @postConstruct decorator multiple times in the same class";
 export var POST_CONSTRUCT_ERROR = function () {
     var values = [];

package/es/container/container.js

@@ -1,3 +1,38 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = y[op[0] & 2 ? "return" : op[0] ? "throw" : "next"]) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [0, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 import { Binding } from "../bindings/binding";
 import * as ERROR_MSGS from "../constants/error_msgs";
 import { BindingScopeEnum, TargetTypeEnum } from "../constants/literal_types";
@@ -12,33 +47,35 @@ import { ContainerSnapshot } from "./container_snapshot";
 import { Lookup } from "./lookup";
 var Container = (function () {
     function Container(containerOptions) {
-        if (containerOptions !== undefined) {
-            if (typeof containerOptions !== "object") {
-                throw new Error("" + ERROR_MSGS.CONTAINER_OPTIONS_MUST_BE_AN_OBJECT);
-            }
-            else {
-                if (containerOptions.defaultScope !== undefined &&
-                    containerOptions.defaultScope !== BindingScopeEnum.Singleton &&
-                    containerOptions.defaultScope !== BindingScopeEnum.Transient &&
-                    containerOptions.defaultScope !== BindingScopeEnum.Request) {
-                    throw new Error("" + ERROR_MSGS.CONTAINER_OPTIONS_INVALID_DEFAULT_SCOPE);
-                }
-                if (containerOptions.autoBindInjectable !== undefined &&
-                    typeof containerOptions.autoBindInjectable !== "boolean") {
-                    throw new Error("" + ERROR_MSGS.CONTAINER_OPTIONS_INVALID_AUTO_BIND_INJECTABLE);
-                }
-            }
-            this.options = {
-                autoBindInjectable: containerOptions.autoBindInjectable,
-                defaultScope: containerOptions.defaultScope
-            };
+        var options = containerOptions || {};
+        if (typeof options !== "object") {
+            throw new Error("" + ERROR_MSGS.CONTAINER_OPTIONS_MUST_BE_AN_OBJECT);
         }
-        else {
-            this.options = {
-                autoBindInjectable: false,
-                defaultScope: BindingScopeEnum.Transient
-            };
+        if (options.defaultScope === undefined) {
+            options.defaultScope = BindingScopeEnum.Transient;
+        }
+        else if (options.defaultScope !== BindingScopeEnum.Singleton &&
+            options.defaultScope !== BindingScopeEnum.Transient &&
+            options.defaultScope !== BindingScopeEnum.Request) {
+            throw new Error("" + ERROR_MSGS.CONTAINER_OPTIONS_INVALID_DEFAULT_SCOPE);
+        }
+        if (options.autoBindInjectable === undefined) {
+            options.autoBindInjectable = false;
         }
+        else if (typeof options.autoBindInjectable !== "boolean") {
+            throw new Error("" + ERROR_MSGS.CONTAINER_OPTIONS_INVALID_AUTO_BIND_INJECTABLE);
+        }
+        if (options.skipBaseClassChecks === undefined) {
+            options.skipBaseClassChecks = false;
+        }
+        else if (typeof options.skipBaseClassChecks !== "boolean") {
+            throw new Error("" + ERROR_MSGS.CONTAINER_OPTIONS_INVALID_SKIP_BASE_CHECK);
+        }
+        this.options = {
+            autoBindInjectable: options.autoBindInjectable,
+            defaultScope: options.defaultScope,
+            skipBaseClassChecks: options.skipBaseClassChecks
+        };
         this.guid = guid();
         this._bindingDictionary = new Lookup();
         this._snapshots = [];
@@ -63,46 +100,44 @@ var Container = (function () {
         return container;
     };
     Container.prototype.load = function () {
-        var _this = this;
         var modules = [];
         for (var _i = 0; _i < arguments.length; _i++) {
             modules[_i] = arguments[_i];
         }
-        var setModuleId = function (bindingToSyntax, moduleId) {
-            bindingToSyntax._binding.moduleId = moduleId;
-        };
-        var getBindFunction = function (moduleId) {
-            return function (serviceIdentifier) {
-                var bindingToSyntax = _this.bind.call(_this, serviceIdentifier);
-                setModuleId(bindingToSyntax, moduleId);
-                return bindingToSyntax;
-            };
-        };
-        var getUnbindFunction = function (moduleId) {
-            return function (serviceIdentifier) {
-                var _unbind = _this.unbind.bind(_this);
-                _unbind(serviceIdentifier);
-            };
-        };
-        var getIsboundFunction = function (moduleId) {
-            return function (serviceIdentifier) {
-                var _isBound = _this.isBound.bind(_this);
-                return _isBound(serviceIdentifier);
-            };
-        };
-        var getRebindFunction = function (moduleId) {
-            return function (serviceIdentifier) {
-                var bindingToSyntax = _this.rebind.call(_this, serviceIdentifier);
-                setModuleId(bindingToSyntax, moduleId);
-                return bindingToSyntax;
-            };
-        };
-        modules.forEach(function (module) {
-            var bindFunction = getBindFunction(module.guid);
-            var unbindFunction = getUnbindFunction(module.guid);
-            var isboundFunction = getIsboundFunction(module.guid);
-            var rebindFunction = getRebindFunction(module.guid);
-            module.registry(bindFunction, unbindFunction, isboundFunction, rebindFunction);
+        var getHelpers = this._getContainerModuleHelpersFactory();
+        for (var _a = 0, modules_1 = modules; _a < modules_1.length; _a++) {
+            var currentModule = modules_1[_a];
+            var containerModuleHelpers = getHelpers(currentModule.guid);
+            currentModule.registry(containerModuleHelpers.bindFunction, containerModuleHelpers.unbindFunction, containerModuleHelpers.isboundFunction, containerModuleHelpers.rebindFunction);
+        }
+    };
+    Container.prototype.loadAsync = function () {
+        var modules = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            modules[_i] = arguments[_i];
+        }
+        return __awaiter(this, void 0, void 0, function () {
+            var getHelpers, _a, modules_2, currentModule, containerModuleHelpers;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        getHelpers = this._getContainerModuleHelpersFactory();
+                        _a = 0, modules_2 = modules;
+                        _b.label = 1;
+                    case 1:
+                        if (!(_a < modules_2.length)) return [3, 4];
+                        currentModule = modules_2[_a];
+                        containerModuleHelpers = getHelpers(currentModule.guid);
+                        return [4, currentModule.registry(containerModuleHelpers.bindFunction, containerModuleHelpers.unbindFunction, containerModuleHelpers.isboundFunction, containerModuleHelpers.rebindFunction)];
+                    case 2:
+                        _b.sent();
+                        _b.label = 3;
+                    case 3:
+                        _a++;
+                        return [3, 1];
+                    case 4: return [2];
+                }
+            });
         });
     };
     Container.prototype.unload = function () {
@@ -173,8 +208,8 @@ var Container = (function () {
         this._bindingDictionary = snapshot.bindings;
         this._middleware = snapshot.middleware;
     };
-    Container.prototype.createChild = function () {
-        var child = new Container();
+    Container.prototype.createChild = function (containerOptions) {
+        var child = new Container(containerOptions);
         child.parent = this;
         return child;
     };
@@ -213,6 +248,46 @@ var Container = (function () {
         tempContainer.parent = this;
         return tempContainer.get(constructorFunction);
     };
+    Container.prototype._getContainerModuleHelpersFactory = function () {
+        var _this = this;
+        var setModuleId = function (bindingToSyntax, moduleId) {
+            bindingToSyntax._binding.moduleId = moduleId;
+        };
+        var getBindFunction = function (moduleId) {
+            return function (serviceIdentifier) {
+                var _bind = _this.bind.bind(_this);
+                var bindingToSyntax = _bind(serviceIdentifier);
+                setModuleId(bindingToSyntax, moduleId);
+                return bindingToSyntax;
+            };
+        };
+        var getUnbindFunction = function (moduleId) {
+            return function (serviceIdentifier) {
+                var _unbind = _this.unbind.bind(_this);
+                _unbind(serviceIdentifier);
+            };
+        };
+        var getIsboundFunction = function (moduleId) {
+            return function (serviceIdentifier) {
+                var _isBound = _this.isBound.bind(_this);
+                return _isBound(serviceIdentifier);
+            };
+        };
+        var getRebindFunction = function (moduleId) {
+            return function (serviceIdentifier) {
+                var _rebind = _this.rebind.bind(_this);
+                var bindingToSyntax = _rebind(serviceIdentifier);
+                setModuleId(bindingToSyntax, moduleId);
+                return bindingToSyntax;
+            };
+        };
+        return function (mId) { return ({
+            bindFunction: getBindFunction(mId),
+            isboundFunction: getIsboundFunction(mId),
+            rebindFunction: getRebindFunction(mId),
+            unbindFunction: getUnbindFunction(mId)
+        }); };
+    };
     Container.prototype._get = function (avoidConstraints, isMultiInject, targetType, serviceIdentifier, key, value) {
         var result = null;
         var defaultArgs = {

package/es/container/container_module.js

@@ -7,3 +7,11 @@ var ContainerModule = (function () {
     return ContainerModule;
 }());
 export { ContainerModule };
+var AsyncContainerModule = (function () {
+    function AsyncContainerModule(registry) {
+        this.guid = guid();
+        this.registry = registry;
+    }
+    return AsyncContainerModule;
+}());
+export { AsyncContainerModule };

package/es/inversify.js

@@ -2,11 +2,11 @@ import * as keys from "./constants/metadata_keys";
 export var METADATA_KEY = keys;
 export { Container } from "./container/container";
 export { BindingScopeEnum, BindingTypeEnum, TargetTypeEnum } from "./constants/literal_types";
-export { ContainerModule } from "./container/container_module";
+export { AsyncContainerModule, ContainerModule } from "./container/container_module";
 export { injectable } from "./annotation/injectable";
 export { tagged } from "./annotation/tagged";
 export { named } from "./annotation/named";
-export { inject } from "./annotation/inject";
+export { inject, LazyServiceIdentifer } from "./annotation/inject";
 export { optional } from "./annotation/optional";
 export { unmanaged } from "./annotation/unmanaged";
 export { multiInject } from "./annotation/multi_inject";

package/es/planning/planner.js

@@ -7,7 +7,7 @@ import { circularDependencyToException, getServiceIdentifierAsString, listMetada
 import { Context } from "./context";
 import { Metadata } from "./metadata";
 import { Plan } from "./plan";
-import { getDependencies } from "./reflection_utils";
+import { getBaseClassDependencyCount, getDependencies, getFunctionName } from "./reflection_utils";
 import { Request } from "./request";
 import { Target } from "./target";
 function getBindingDictionary(cntnr) {
@@ -101,6 +101,13 @@ function _createSubRequests(metadataReader, avoidConstraints, serviceIdentifier,
         }
         if (binding.type === BindingTypeEnum.Instance && binding.implementationType !== null) {
             var dependencies = getDependencies(metadataReader, binding.implementationType);
+            if (!context.container.options.skipBaseClassChecks) {
+                var baseClassDependencyCount = getBaseClassDependencyCount(metadataReader, binding.implementationType);
+                if (dependencies.length < baseClassDependencyCount) {
+                    var error = ERROR_MSGS.ARGUMENTS_LENGTH_MISMATCH(getFunctionName(binding.implementationType));
+                    throw new Error(error);
+                }
+            }
             dependencies.forEach(function (dependency) {
                 _createSubRequests(metadataReader, false, dependency.serviceIdentifier, context, subChildRequest, dependency);
             });

package/es/planning/reflection_utils.js

@@ -1,3 +1,4 @@
+import { LazyServiceIdentifer } from "../annotation/inject";
 import * as ERROR_MSGS from "../constants/error_msgs";
 import { TargetTypeEnum } from "../constants/literal_types";
 import * as METADATA_KEY from "../constants/metadata_keys";
@@ -22,12 +23,6 @@ function getTargets(metadataReader, constructorName, func, isBaseClass) {
     var constructorTargets = getConstructorArgsAsTargets(isBaseClass, constructorName, serviceIdentifiers, constructorArgsMetadata, iterations);
     var propertyTargets = getClassPropsAsTargets(metadataReader, func);
     var targets = constructorTargets.concat(propertyTargets);
-    var baseClassDependencyCount = getBaseClassDependencyCount(metadataReader, func);
-    if (targets.length < baseClassDependencyCount) {
-        var error = ERROR_MSGS.ARGUMENTS_LENGTH_MISMATCH_1 +
-            constructorName + ERROR_MSGS.ARGUMENTS_LENGTH_MISMATCH_2;
-        throw new Error(error);
-    }
     return targets;
 }
 function getConstructorArgsAsTarget(index, isBaseClass, constructorName, serviceIdentifiers, constructorArgsMetadata) {
@@ -37,6 +32,9 @@ function getConstructorArgsAsTarget(index, isBaseClass, constructorName, service
     var serviceIdentifier = serviceIdentifiers[index];
     var injectIdentifier = (metadata.inject || metadata.multiInject);
     serviceIdentifier = (injectIdentifier) ? (injectIdentifier) : serviceIdentifier;
+    if (serviceIdentifier instanceof LazyServiceIdentifer) {
+        serviceIdentifier = serviceIdentifier.unwrap();
+    }
     if (isManaged) {
         var isObject = serviceIdentifier === Object;
         var isFunction = serviceIdentifier === Function;
@@ -119,4 +117,4 @@ function formatTargetMetadata(targetMetadata) {
         unmanaged: targetMetadataMap[METADATA_KEY.UNMANAGED_TAG]
     };
 }
-export { getDependencies };
+export { getDependencies, getBaseClassDependencyCount, getFunctionName };

package/lib/annotation/inject.js

@@ -1,10 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var error_msgs_1 = require("../constants/error_msgs");
 var METADATA_KEY = require("../constants/metadata_keys");
 var metadata_1 = require("../planning/metadata");
 var decorator_utils_1 = require("./decorator_utils");
+var LazyServiceIdentifer = (function () {
+    function LazyServiceIdentifer(cb) {
+        this._cb = cb;
+    }
+    LazyServiceIdentifer.prototype.unwrap = function () {
+        return this._cb();
+    };
+    return LazyServiceIdentifer;
+}());
+exports.LazyServiceIdentifer = LazyServiceIdentifer;
 function inject(serviceIdentifier) {
     return function (target, targetKey, index) {
+        if (serviceIdentifier === undefined) {
+            throw new Error(error_msgs_1.UNDEFINED_INJECT_ANNOTATION(target.name));
+        }
         var metadata = new metadata_1.Metadata(METADATA_KEY.INJECT_TAG, serviceIdentifier);
         if (typeof index === "number") {
             decorator_utils_1.tagParameter(target, targetKey, index, metadata);

package/lib/constants/error_msgs.js

@@ -9,6 +9,11 @@ exports.CANNOT_UNBIND = "Could not unbind serviceIdentifier:";
 exports.NOT_REGISTERED = "No matching bindings found for serviceIdentifier:";
 exports.MISSING_INJECTABLE_ANNOTATION = "Missing required @injectable annotation in:";
 exports.MISSING_INJECT_ANNOTATION = "Missing required @inject or @multiInject annotation in:";
+exports.UNDEFINED_INJECT_ANNOTATION = function (name) {
+    return "@inject called with undefined this could mean that the class " + name + " has " +
+        "a circular dependency problem. You can use a LazyServiceIdentifer to  " +
+        "overcome this limitation.";
+};
 exports.CIRCULAR_DEPENDENCY = "Circular dependency found:";
 exports.NOT_IMPLEMENTED = "Sorry, this feature is not fully implemented yet.";
 exports.INVALID_BINDING_TYPE = "Invalid binding type:";
@@ -19,14 +24,22 @@ exports.INVALID_TO_SELF_VALUE = "The toSelf function can only be applied when a
     "used as service identifier";
 exports.INVALID_DECORATOR_OPERATION = "The @inject @multiInject @tagged and @named decorators " +
     "must be applied to the parameters of a class constructor or a class property.";
-exports.ARGUMENTS_LENGTH_MISMATCH_1 = "The number of constructor arguments in the derived class ";
-exports.ARGUMENTS_LENGTH_MISMATCH_2 = " must be >= than the number of constructor arguments of its base class.";
+exports.ARGUMENTS_LENGTH_MISMATCH = function () {
+    var values = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        values[_i] = arguments[_i];
+    }
+    return "The number of constructor arguments in the derived class " +
+        (values[0] + " must be >= than the number of constructor arguments of its base class.");
+};
 exports.CONTAINER_OPTIONS_MUST_BE_AN_OBJECT = "Invalid Container constructor argument. Container options " +
     "must be an object.";
 exports.CONTAINER_OPTIONS_INVALID_DEFAULT_SCOPE = "Invalid Container option. Default scope must " +
     "be a string ('singleton' or 'transient').";
 exports.CONTAINER_OPTIONS_INVALID_AUTO_BIND_INJECTABLE = "Invalid Container option. Auto bind injectable must " +
     "be a boolean";
+exports.CONTAINER_OPTIONS_INVALID_SKIP_BASE_CHECK = "Invalid Container option. Skip base check must " +
+    "be a boolean";
 exports.MULTIPLE_POST_CONSTRUCT_METHODS = "Cannot apply @postConstruct decorator multiple times in the same class";
 exports.POST_CONSTRUCT_ERROR = function () {
     var values = [];