import { provide, platform, ApplicationRef, AppViewManager, Compiler, Injector, NgZone, PlatformRef, HostViewFactoryRef, Provider, Type, APPLICATION_COMMON_PROVIDERS } from 'angular2/core'; import {ObservableWrapper} from 'angular2/src/facade/async'; import {BROWSER_PROVIDERS, BROWSER_APP_PROVIDERS} from 'angular2/platform/browser'; import {getComponentInfo, ComponentInfo} from './metadata'; import {onError, controllerKey} from './util'; import { NG1_COMPILE, NG1_INJECTOR, NG1_PARSE, NG1_ROOT_SCOPE, NG1_SCOPE, NG2_APP_VIEW_MANAGER, NG2_COMPILER, NG2_INJECTOR, NG2_HOST_VIEW_FACTORY_REF_MAP, NG2_ZONE, REQUIRE_INJECTOR } from './constants'; import {DowngradeNg2ComponentAdapter} from './downgrade_ng2_adapter'; import {UpgradeNg1ComponentAdapterBuilder} from './upgrade_ng1_adapter'; import * as angular from './angular_js'; var upgradeCount: number = 0; /** * Use `UpgradeAdapter` to allow AngularJS v1 and Angular v2 to coexist in a single application. * * The `UpgradeAdapter` allows: * 1. creation of Angular v2 component from AngularJS v1 component directive * (See [UpgradeAdapter#upgradeNg1Component()]) * 2. creation of AngularJS v1 directive from Angular v2 component. * (See [UpgradeAdapter#downgradeNg2Component()]) * 3. Bootstrapping of a hybrid Angular application which contains both of the frameworks * coexisting in a single application. * * ## Mental Model * * When reasoning about how a hybrid application works it is useful to have a mental model which * describes what is happening and explains what is happening at the lowest level. * * 1. There are two independent frameworks running in a single application, each framework treats * the other as a black box. * 2. Each DOM element on the page is owned exactly by one framework. Whichever framework * instantiated the element is the owner. Each framework only updates/interacts with its own * DOM elements and ignores others. * 3. AngularJS v1 directives always execute inside AngularJS v1 framework codebase regardless of * where they are instantiated. * 4. Angular v2 components always execute inside Angular v2 framework codebase regardless of * where they are instantiated. * 5. An AngularJS v1 component can be upgraded to an Angular v2 component. This creates an * Angular v2 directive, which bootstraps the AngularJS v1 component directive in that location. * 6. An Angular v2 component can be downgraded to an AngularJS v1 component directive. This creates * an AngularJS v1 directive, which bootstraps the Angular v2 component in that location. * 7. Whenever an adapter component is instantiated the host element is owned by the framework * doing the instantiation. The other framework then instantiates and owns the view for that * component. This implies that component bindings will always follow the semantics of the * instantiation framework. The syntax is always that of Angular v2 syntax. * 8. AngularJS v1 is always bootstrapped first and owns the bottom most view. * 9. The new application is running in Angular v2 zone, and therefore it no longer needs calls to * `$apply()`. * * ### Example * * ``` * var adapter = new UpgradeAdapter(); * var module = angular.module('myExample', []); * module.directive('ng2', adapter.downgradeNg2Component(Ng2)); * * module.directive('ng1', function() { * return { * scope: { title: '=' }, * template: 'ng1[Hello {{title}}!]()' * }; * }); * * * @Component({ * selector: 'ng2', * inputs: ['name'], * template: 'ng2[transclude]()', * directives: [adapter.upgradeNg1Component('ng1')] * }) * class Ng2 { * } * * document.body.innerHTML = 'project'; * * adapter.bootstrap(document.body, ['myExample']).ready(function() { * expect(document.body.textContent).toEqual( * "ng2[ng1[Hello World!](transclude)](project)"); * }); * ``` */ export class UpgradeAdapter { /* @internal */ private idPrefix: string = `NG2_UPGRADE_${upgradeCount++}_`; /* @internal */ private upgradedComponents: Type[] = []; /* @internal */ private downgradedComponents: {[name: string]: UpgradeNg1ComponentAdapterBuilder} = {}; /* @internal */ private providers: Array = []; /** * Allows Angular v2 Component to be used from AngularJS v1. * * Use `downgradeNg2Component` to create an AngularJS v1 Directive Definition Factory from * Angular v2 Component. The adapter will bootstrap Angular v2 component from within the * AngularJS v1 template. * * ## Mental Model * * 1. The component is instantiated by being listed in AngularJS v1 template. This means that the * host element is controlled by AngularJS v1, but the component's view will be controlled by * Angular v2. * 2. Even thought the component is instantiated in AngularJS v1, it will be using Angular v2 * syntax. This has to be done, this way because we must follow Angular v2 components do not * declare how the attributes should be interpreted. * * ## Supported Features * * - Bindings: * - Attribute: `` * - Interpolation: `` * - Expression: `` * - Event: `` * - Content projection: yes * * ### Example * * ``` * var adapter = new UpgradeAdapter(); * var module = angular.module('myExample', []); * module.directive('greet', adapter.downgradeNg2Component(Greeter)); * * @Component({ * selector: 'greet', * template: '{{salutation}} {{name}}! - ' * }) * class Greeter { * @Input() salutation: string; * @Input() name: string; * } * * document.body.innerHTML = * 'ng1 template: text'; * * adapter.bootstrap(document.body, ['myExample']).ready(function() { * expect(document.body.textContent).toEqual("ng1 template: Hello world! - text"); * }); * ``` */ downgradeNg2Component(type: Type): Function { this.upgradedComponents.push(type); var info: ComponentInfo = getComponentInfo(type); return ng1ComponentDirective(info, `${this.idPrefix}${info.selector}_c`); } /** * Allows AngularJS v1 Component to be used from Angular v2. * * Use `upgradeNg1Component` to create an Angular v2 component from AngularJS v1 Component * directive. The adapter will bootstrap AngularJS v1 component from within the Angular v2 * template. * * ## Mental Model * * 1. The component is instantiated by being listed in Angular v2 template. This means that the * host element is controlled by Angular v2, but the component's view will be controlled by * AngularJS v1. * * ## Supported Features * * - Bindings: * - Attribute: `` * - Interpolation: `` * - Expression: `` * - Event: `` * - Transclusion: yes * - Only some of the features of * [Directive Definition Object](https://docs.angularjs.org/api/ng/service/$compile) are * supported: * - `compile`: not supported because the host element is owned by Angular v2, which does * not allow modifying DOM structure during compilation. * - `controller`: supported. (NOTE: injection of `$attrs` and `$transclude` is not supported.) * - `controllerAs': supported. * - `bindToController': supported. * - `link': supported. (NOTE: only pre-link function is supported.) * - `name': supported. * - `priority': ignored. * - `replace': not supported. * - `require`: supported. * - `restrict`: must be set to 'E'. * - `scope`: supported. * - `template`: supported. * - `templateUrl`: supported. * - `terminal`: ignored. * - `transclude`: supported. * * * ### Example * * ``` * var adapter = new UpgradeAdapter(); * var module = angular.module('myExample', []); * * module.directive('greet', function() { * return { * scope: {salutation: '=', name: '=' }, * template: '{{salutation}} {{name}}! - ' * }; * }); * * module.directive('ng2', adapter.downgradeNg2Component(Ng2)); * * @Component({ * selector: 'ng2', * template: 'ng2 template: text' * directives: [adapter.upgradeNg1Component('greet')] * }) * class Ng2 { * } * * document.body.innerHTML = ''; * * adapter.bootstrap(document.body, ['myExample']).ready(function() { * expect(document.body.textContent).toEqual("ng2 template: Hello world! - text"); * }); * ``` */ upgradeNg1Component(name: string): Type { if ((this.downgradedComponents).hasOwnProperty(name)) { return this.downgradedComponents[name].type; } else { return (this.downgradedComponents[name] = new UpgradeNg1ComponentAdapterBuilder(name)).type; } } /** * Bootstrap a hybrid AngularJS v1 / Angular v2 application. * * This `bootstrap` method is a direct replacement (takes same arguments) for AngularJS v1 * [`bootstrap`](https://docs.angularjs.org/api/ng/function/angular.bootstrap) method. Unlike * AngularJS v1, this bootstrap is asynchronous. * * ### Example * * ``` * var adapter = new UpgradeAdapter(); * var module = angular.module('myExample', []); * module.directive('ng2', adapter.downgradeNg2Component(Ng2)); * * module.directive('ng1', function() { * return { * scope: { title: '=' }, * template: 'ng1[Hello {{title}}!]()' * }; * }); * * * @Component({ * selector: 'ng2', * inputs: ['name'], * template: 'ng2[transclude]()', * directives: [adapter.upgradeNg1Component('ng1')] * }) * class Ng2 { * } * * document.body.innerHTML = 'project'; * * adapter.bootstrap(document.body, ['myExample']).ready(function() { * expect(document.body.textContent).toEqual( * "ng2[ng1[Hello World!](transclude)](project)"); * }); * ``` */ bootstrap(element: Element, modules?: any[], config?: angular.IAngularBootstrapConfig): UpgradeAdapterRef { var upgrade = new UpgradeAdapterRef(); var ng1Injector: angular.IInjectorService = null; var platformRef: PlatformRef = platform(BROWSER_PROVIDERS); var applicationRef: ApplicationRef = platformRef.application([ BROWSER_APP_PROVIDERS, provide(NG1_INJECTOR, {useFactory: () => ng1Injector}), provide(NG1_COMPILE, {useFactory: () => ng1Injector.get(NG1_COMPILE)}), this.providers ]); var injector: Injector = applicationRef.injector; var ngZone: NgZone = injector.get(NgZone); var compiler: Compiler = injector.get(Compiler); var delayApplyExps: Function[] = []; var original$applyFn: Function; var rootScopePrototype: any; var rootScope: angular.IRootScopeService; var hostViewFactoryRefMap: HostViewFactoryRefMap = {}; var ng1Module = angular.module(this.idPrefix, modules); var ng1compilePromise: Promise = null; ng1Module.value(NG2_INJECTOR, injector) .value(NG2_ZONE, ngZone) .value(NG2_COMPILER, compiler) .value(NG2_HOST_VIEW_FACTORY_REF_MAP, hostViewFactoryRefMap) .value(NG2_APP_VIEW_MANAGER, injector.get(AppViewManager)) .config([ '$provide', (provide) => { provide.decorator(NG1_ROOT_SCOPE, [ '$delegate', function(rootScopeDelegate: angular.IRootScopeService) { rootScopePrototype = rootScopeDelegate.constructor.prototype; if (rootScopePrototype.hasOwnProperty('$apply')) { original$applyFn = rootScopePrototype.$apply; rootScopePrototype.$apply = (exp) => delayApplyExps.push(exp); } else { throw new Error("Failed to find '$apply' on '$rootScope'!"); } return rootScope = rootScopeDelegate; } ]); } ]) .run([ '$injector', '$rootScope', (injector: angular.IInjectorService, rootScope: angular.IRootScopeService) => { ng1Injector = injector; ObservableWrapper.subscribe(ngZone.onTurnDone, (_) => ngZone.runOutsideAngular(() => rootScope.$apply())); ng1compilePromise = UpgradeNg1ComponentAdapterBuilder.resolve(this.downgradedComponents, injector); } ]); angular.element(element).data(controllerKey(NG2_INJECTOR), injector); ngZone.run(() => { angular.bootstrap(element, [this.idPrefix], config); }); Promise.all([this.compileNg2Components(compiler, hostViewFactoryRefMap), ng1compilePromise]) .then(() => { ngZone.run(() => { if (rootScopePrototype) { rootScopePrototype.$apply = original$applyFn; // restore original $apply while (delayApplyExps.length) { rootScope.$apply(delayApplyExps.shift()); } (upgrade)._bootstrapDone(applicationRef, ng1Injector); rootScopePrototype = null; } }); }, onError); return upgrade; } /** * Adds a provider to the top level environment of a hybrid AngularJS v1 / Angular v2 application. * * In hybrid AngularJS v1 / Angular v2 application, there is no one root Angular v2 component, * for this reason we provide an application global way of registering providers which is * consistent with single global injection in AngularJS v1. * * ### Example * * ``` * class Greeter { * greet(name) { * alert('Hello ' + name + '!'); * } * } * * @Component({ * selector: 'app', * template: '' * }) * class App { * constructor(greeter: Greeter) { * this.greeter('World'); * } * } * * var adapter = new UpgradeAdapter(); * adapter.addProvider(Greeter); * * var module = angular.module('myExample', []); * module.directive('app', adapter.downgradeNg2Component(App)); * * document.body.innerHTML = '' * adapter.bootstrap(document.body, ['myExample']); *``` */ public addProvider(provider: Type | Provider | any[]): void { this.providers.push(provider); } /** * Allows AngularJS v1 service to be accessible from Angular v2. * * * ### Example * * ``` * class Login { ... } * class Server { ... } * * @Injectable() * class Example { * constructor(@Inject('server') server, login: Login) { * ... * } * } * * var module = angular.module('myExample', []); * module.service('server', Server); * module.service('login', Login); * * var adapter = new UpgradeAdapter(); * adapter.upgradeNg1Provider('server'); * adapter.upgradeNg1Provider('login', {asToken: Login}); * adapter.addProvider(Example); * * adapter.bootstrap(document.body, ['myExample']).ready((ref) => { * var example: Example = ref.ng2Injector.get(Example); * }); * * ``` */ public upgradeNg1Provider(name: string, options?: {asToken: any}) { var token = options && options.asToken || name; this.providers.push(provide(token, { useFactory: (ng1Injector: angular.IInjectorService) => ng1Injector.get(name), deps: [NG1_INJECTOR] })); } /** * Allows Angular v2 service to be accessible from AngularJS v1. * * * ### Example * * ``` * class Example { * } * * var adapter = new UpgradeAdapter(); * adapter.addProvider(Example); * * var module = angular.module('myExample', []); * module.factory('example', adapter.downgradeNg2Provider(Example)); * * adapter.bootstrap(document.body, ['myExample']).ready((ref) => { * var example: Example = ref.ng1Injector.get('example'); * }); * * ``` */ public downgradeNg2Provider(token: any): Function { var factory = function(injector: Injector) { return injector.get(token); }; (factory).$inject = [NG2_INJECTOR]; return factory; } /* @internal */ private compileNg2Components(compiler: Compiler, hostViewFactoryRefMap: HostViewFactoryRefMap): Promise { var promises: Array> = []; var types = this.upgradedComponents; for (var i = 0; i < types.length; i++) { promises.push(compiler.compileInHost(types[i])); } return Promise.all(promises).then((hostViewFactories: Array) => { var types = this.upgradedComponents; for (var i = 0; i < hostViewFactories.length; i++) { hostViewFactoryRefMap[getComponentInfo(types[i]).selector] = hostViewFactories[i]; } return hostViewFactoryRefMap; }, onError); } } interface HostViewFactoryRefMap { [selector: string]: HostViewFactoryRef; } function ng1ComponentDirective(info: ComponentInfo, idPrefix: string): Function { (directiveFactory).$inject = [NG2_HOST_VIEW_FACTORY_REF_MAP, NG2_APP_VIEW_MANAGER, NG1_PARSE]; function directiveFactory(hostViewFactoryRefMap: HostViewFactoryRefMap, viewManager: AppViewManager, parse: angular.IParseService): angular.IDirective { var hostViewFactory: HostViewFactoryRef = hostViewFactoryRefMap[info.selector]; if (!hostViewFactory) throw new Error('Expecting HostViewFactoryRef for: ' + info.selector); var idCount = 0; return { restrict: 'E', require: REQUIRE_INJECTOR, link: { post: (scope: angular.IScope, element: angular.IAugmentedJQuery, attrs: angular.IAttributes, parentInjector: any, transclude: angular.ITranscludeFunction): void => { var domElement = element[0]; var facade = new DowngradeNg2ComponentAdapter(idPrefix + (idCount++), info, element, attrs, scope, parentInjector, parse, viewManager, hostViewFactory); facade.setupInputs(); facade.bootstrapNg2(); facade.projectContent(); facade.setupOutputs(); facade.registerCleanup(); } } }; } return directiveFactory; } /** * Use `UgradeAdapterRef` to control a hybrid AngularJS v1 / Angular v2 application. */ export class UpgradeAdapterRef { /* @internal */ private _readyFn: (upgradeAdapterRef?: UpgradeAdapterRef) => void = null; public ng1RootScope: angular.IRootScopeService = null; public ng1Injector: angular.IInjectorService = null; public ng2ApplicationRef: ApplicationRef = null; public ng2Injector: Injector = null; /* @internal */ private _bootstrapDone(applicationRef: ApplicationRef, ng1Injector: angular.IInjectorService) { this.ng2ApplicationRef = applicationRef; this.ng2Injector = applicationRef.injector; this.ng1Injector = ng1Injector; this.ng1RootScope = ng1Injector.get(NG1_ROOT_SCOPE); this._readyFn && this._readyFn(this); } /** * Register a callback function which is notified upon successful hybrid AngularJS v1 / Angular v2 * application has been bootstrapped. * * The `ready` callback function is invoked inside the Angular v2 zone, therefore it does not * require a call to `$apply()`. */ public ready(fn: (upgradeAdapterRef?: UpgradeAdapterRef) => void) { this._readyFn = fn; } /** * Dispose of running hybrid AngularJS v1 / Angular v2 application. */ public dispose() { this.ng1Injector.get(NG1_ROOT_SCOPE).$destroy(); this.ng2ApplicationRef.dispose(); } }