123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280 |
- "use strict";
- /**
- * @license
- * Copyright Google LLC All Rights Reserved.
- *
- * Use of this source code is governed by an MIT-style license that can be
- * found in the LICENSE file at https://angular.dev/license
- */
- var __importDefault = (this && this.__importDefault) || function (mod) {
- return (mod && mod.__esModule) ? mod : { "default": mod };
- };
- Object.defineProperty(exports, "__esModule", { value: true });
- exports.default = default_1;
- const schematics_1 = require("@angular-devkit/schematics");
- const posix_1 = require("node:path/posix");
- const typescript_1 = __importDefault(require("../third_party/github.com/Microsoft/TypeScript/lib/typescript"));
- const ast_utils_1 = require("../utility/ast-utils");
- const change_1 = require("../utility/change");
- const ng_ast_utils_1 = require("../utility/ng-ast-utils");
- const util_1 = require("../utility/standalone/util");
- const workspace_1 = require("../utility/workspace");
- const workspace_models_1 = require("../utility/workspace-models");
- const APP_SHELL_ROUTE = 'shell';
- function getSourceFile(host, path) {
- const content = host.readText(path);
- const source = typescript_1.default.createSourceFile(path, content, typescript_1.default.ScriptTarget.Latest, true);
- return source;
- }
- function getServerModulePath(host, sourceRoot, mainPath) {
- const mainSource = getSourceFile(host, (0, posix_1.join)(sourceRoot, mainPath));
- const allNodes = (0, ast_utils_1.getSourceNodes)(mainSource);
- const expNode = allNodes.find((node) => typescript_1.default.isExportDeclaration(node));
- if (!expNode) {
- return null;
- }
- const relativePath = expNode.moduleSpecifier;
- const modulePath = (0, posix_1.join)(sourceRoot, `${relativePath.text}.ts`);
- return modulePath;
- }
- function getComponentTemplateInfo(host, componentPath) {
- const compSource = getSourceFile(host, componentPath);
- const compMetadata = (0, ast_utils_1.getDecoratorMetadata)(compSource, 'Component', '@angular/core')[0];
- return {
- templateProp: getMetadataProperty(compMetadata, 'template'),
- templateUrlProp: getMetadataProperty(compMetadata, 'templateUrl'),
- };
- }
- function getComponentTemplate(host, compPath, tmplInfo) {
- let template = '';
- if (tmplInfo.templateProp) {
- template = tmplInfo.templateProp.getFullText();
- }
- else if (tmplInfo.templateUrlProp) {
- const templateUrl = tmplInfo.templateUrlProp.initializer.text;
- const dir = (0, posix_1.dirname)(compPath);
- const templatePath = (0, posix_1.join)(dir, templateUrl);
- try {
- template = host.readText(templatePath);
- }
- catch { }
- }
- return template;
- }
- function getBootstrapComponentPath(host, mainPath) {
- let bootstrappingFilePath;
- let bootstrappingSource;
- let componentName;
- if ((0, ng_ast_utils_1.isStandaloneApp)(host, mainPath)) {
- // Standalone Application
- const bootstrapCall = (0, util_1.findBootstrapApplicationCall)(host, mainPath);
- componentName = bootstrapCall.arguments[0].getText();
- bootstrappingFilePath = mainPath;
- bootstrappingSource = getSourceFile(host, mainPath);
- }
- else {
- // NgModule Application
- const modulePath = (0, ng_ast_utils_1.getAppModulePath)(host, mainPath);
- const moduleSource = getSourceFile(host, modulePath);
- const metadataNode = (0, ast_utils_1.getDecoratorMetadata)(moduleSource, 'NgModule', '@angular/core')[0];
- const bootstrapProperty = getMetadataProperty(metadataNode, 'bootstrap');
- const arrLiteral = bootstrapProperty.initializer;
- componentName = arrLiteral.elements[0].getText();
- bootstrappingSource = moduleSource;
- bootstrappingFilePath = modulePath;
- }
- const componentRelativeFilePath = (0, ast_utils_1.getSourceNodes)(bootstrappingSource)
- .filter(typescript_1.default.isImportDeclaration)
- .filter((imp) => {
- return (0, ast_utils_1.findNode)(imp, typescript_1.default.SyntaxKind.Identifier, componentName);
- })
- .map((imp) => {
- const pathStringLiteral = imp.moduleSpecifier;
- return pathStringLiteral.text;
- })[0];
- return (0, posix_1.join)((0, posix_1.dirname)(bootstrappingFilePath), componentRelativeFilePath + '.ts');
- }
- // end helper functions.
- function validateProject(mainPath) {
- return (host) => {
- const routerOutletCheckRegex = /<router-outlet.*?>([\s\S]*?)(?:<\/router-outlet>)?/;
- const componentPath = getBootstrapComponentPath(host, mainPath);
- const tmpl = getComponentTemplateInfo(host, componentPath);
- const template = getComponentTemplate(host, componentPath, tmpl);
- if (!routerOutletCheckRegex.test(template)) {
- throw new schematics_1.SchematicsException(`Prerequisite for application shell is to define a router-outlet in your root component.`);
- }
- };
- }
- function getMetadataProperty(metadata, propertyName) {
- const properties = metadata.properties;
- const property = properties.filter(typescript_1.default.isPropertyAssignment).filter((prop) => {
- const name = prop.name;
- switch (name.kind) {
- case typescript_1.default.SyntaxKind.Identifier:
- return name.getText() === propertyName;
- case typescript_1.default.SyntaxKind.StringLiteral:
- return name.text === propertyName;
- }
- return false;
- })[0];
- return property;
- }
- function addAppShellConfigToWorkspace(options) {
- return (0, workspace_1.updateWorkspace)((workspace) => {
- const project = workspace.projects.get(options.project);
- if (!project) {
- return;
- }
- const buildTarget = project.targets.get('build');
- if (buildTarget?.builder === workspace_models_1.Builders.Application ||
- buildTarget?.builder === workspace_models_1.Builders.BuildApplication) {
- // Application builder configuration.
- const prodConfig = buildTarget.configurations?.production;
- if (!prodConfig) {
- throw new schematics_1.SchematicsException(`A "production" configuration is not defined for the "build" builder.`);
- }
- prodConfig.appShell = true;
- }
- });
- }
- function addServerRoutes(options) {
- return async (host) => {
- // The workspace gets updated so this needs to be reloaded
- const workspace = await (0, workspace_1.getWorkspace)(host);
- const project = workspace.projects.get(options.project);
- if (!project) {
- throw new schematics_1.SchematicsException(`Invalid project name (${options.project})`);
- }
- const modulePath = getServerModulePath(host, project.sourceRoot || 'src', 'main.server.ts');
- if (modulePath === null) {
- throw new schematics_1.SchematicsException('Server module not found.');
- }
- let moduleSource = getSourceFile(host, modulePath);
- if (!(0, ast_utils_1.isImported)(moduleSource, 'Routes', '@angular/router')) {
- const recorder = host.beginUpdate(modulePath);
- const routesChange = (0, ast_utils_1.insertImport)(moduleSource, modulePath, 'Routes', '@angular/router');
- if (routesChange) {
- (0, change_1.applyToUpdateRecorder)(recorder, [routesChange]);
- }
- const imports = (0, ast_utils_1.getSourceNodes)(moduleSource)
- .filter((node) => node.kind === typescript_1.default.SyntaxKind.ImportDeclaration)
- .sort((a, b) => a.getStart() - b.getStart());
- const insertPosition = imports[imports.length - 1].getEnd();
- const routeText = `\n\nconst routes: Routes = [ { path: '${APP_SHELL_ROUTE}', component: AppShellComponent }];`;
- recorder.insertRight(insertPosition, routeText);
- host.commitUpdate(recorder);
- }
- moduleSource = getSourceFile(host, modulePath);
- if (!(0, ast_utils_1.isImported)(moduleSource, 'RouterModule', '@angular/router')) {
- const recorder = host.beginUpdate(modulePath);
- const routerModuleChange = (0, ast_utils_1.insertImport)(moduleSource, modulePath, 'RouterModule', '@angular/router');
- if (routerModuleChange) {
- (0, change_1.applyToUpdateRecorder)(recorder, [routerModuleChange]);
- }
- const metadataChange = (0, ast_utils_1.addSymbolToNgModuleMetadata)(moduleSource, modulePath, 'imports', 'RouterModule.forRoot(routes)');
- if (metadataChange) {
- (0, change_1.applyToUpdateRecorder)(recorder, metadataChange);
- }
- host.commitUpdate(recorder);
- }
- };
- }
- function addStandaloneServerRoute(options) {
- return async (host) => {
- const workspace = await (0, workspace_1.getWorkspace)(host);
- const project = workspace.projects.get(options.project);
- if (!project) {
- throw new schematics_1.SchematicsException(`Project name "${options.project}" doesn't not exist.`);
- }
- const configFilePath = (0, posix_1.join)(project.sourceRoot ?? 'src', 'app/app.config.server.ts');
- if (!host.exists(configFilePath)) {
- throw new schematics_1.SchematicsException(`Cannot find "${configFilePath}".`);
- }
- const recorder = host.beginUpdate(configFilePath);
- let configSourceFile = getSourceFile(host, configFilePath);
- if (!(0, ast_utils_1.isImported)(configSourceFile, 'ROUTES', '@angular/router')) {
- const routesChange = (0, ast_utils_1.insertImport)(configSourceFile, configFilePath, 'ROUTES', '@angular/router');
- if (routesChange) {
- (0, change_1.applyToUpdateRecorder)(recorder, [routesChange]);
- }
- }
- configSourceFile = getSourceFile(host, configFilePath);
- const providersLiteral = (0, ast_utils_1.findNodes)(configSourceFile, typescript_1.default.isPropertyAssignment).find((n) => typescript_1.default.isArrayLiteralExpression(n.initializer) && n.name.getText() === 'providers')?.initializer;
- if (!providersLiteral) {
- throw new schematics_1.SchematicsException(`Cannot find the "providers" configuration in "${configFilePath}".`);
- }
- // Add route to providers literal.
- recorder.remove(providersLiteral.getStart(), providersLiteral.getWidth());
- const updatedProvidersString = [
- ...providersLiteral.elements.map((element) => ' ' + element.getText()),
- ` {
- provide: ROUTES,
- multi: true,
- useValue: [{
- path: '${APP_SHELL_ROUTE}',
- component: AppShellComponent
- }]
- }\n `,
- ];
- recorder.insertRight(providersLiteral.getStart(), `[\n${updatedProvidersString.join(',\n')}]`);
- (0, change_1.applyToUpdateRecorder)(recorder, [
- (0, ast_utils_1.insertImport)(configSourceFile, configFilePath, 'AppShellComponent', './app-shell/app-shell.component'),
- ]);
- host.commitUpdate(recorder);
- };
- }
- function addServerRoutingConfig(options, isStandalone) {
- return async (host) => {
- const workspace = await (0, workspace_1.getWorkspace)(host);
- const project = workspace.projects.get(options.project);
- if (!project) {
- throw new schematics_1.SchematicsException(`Project name "${options.project}" doesn't not exist.`);
- }
- const configFilePath = isStandalone
- ? (0, posix_1.join)(project.sourceRoot ?? 'src', 'app/app.config.server.ts')
- : getServerModulePath(host, project.sourceRoot || 'src', 'main.server.ts');
- if (!configFilePath || !host.exists(configFilePath)) {
- throw new schematics_1.SchematicsException(`Cannot find "${configFilePath}".`);
- }
- let recorder = host.beginUpdate(configFilePath);
- const configSourceFile = getSourceFile(host, configFilePath);
- const functionCall = (0, ast_utils_1.findNodes)(configSourceFile, typescript_1.default.isCallExpression,
- /** max */ undefined,
- /** recursive */ true).find((n) => typescript_1.default.isIdentifier(n.expression) && n.expression.getText() === 'provideServerRouting');
- if (!functionCall) {
- throw new schematics_1.SchematicsException(`Cannot find the "provideServerRouting" function call in "${configFilePath}".`);
- }
- recorder = host.beginUpdate(configFilePath);
- recorder.insertLeft(functionCall.end - 1, `, withAppShell(AppShellComponent)`);
- (0, change_1.applyToUpdateRecorder)(recorder, [
- (0, ast_utils_1.insertImport)(configSourceFile, configFilePath, 'withAppShell', '@angular/ssr'),
- (0, ast_utils_1.insertImport)(configSourceFile, configFilePath, 'AppShellComponent', './app-shell/app-shell.component'),
- ]);
- host.commitUpdate(recorder);
- };
- }
- function default_1(options) {
- return async (tree) => {
- const browserEntryPoint = await (0, util_1.getMainFilePath)(tree, options.project);
- const isStandalone = (0, ng_ast_utils_1.isStandaloneApp)(tree, browserEntryPoint);
- return (0, schematics_1.chain)([
- validateProject(browserEntryPoint),
- (0, schematics_1.schematic)('server', options),
- ...(options.serverRouting
- ? [(0, schematics_1.noop)()]
- : isStandalone
- ? [addStandaloneServerRoute(options)]
- : [addServerRoutes(options)]),
- options.serverRouting
- ? addServerRoutingConfig(options, isStandalone)
- : addAppShellConfigToWorkspace(options),
- (0, schematics_1.schematic)('component', {
- name: 'app-shell',
- module: 'app.module.server.ts',
- project: options.project,
- standalone: isStandalone,
- }),
- ]);
- };
- }
|