123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381 |
- "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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- var desc = Object.getOwnPropertyDescriptor(m, k);
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
- desc = { enumerable: true, get: function() { return m[k]; } };
- }
- Object.defineProperty(o, k2, desc);
- }) : (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- o[k2] = m[k];
- }));
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
- Object.defineProperty(o, "default", { enumerable: true, value: v });
- }) : function(o, v) {
- o["default"] = v;
- });
- var __importStar = (this && this.__importStar) || (function () {
- var ownKeys = function(o) {
- ownKeys = Object.getOwnPropertyNames || function (o) {
- var ar = [];
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
- return ar;
- };
- return ownKeys(o);
- };
- return function (mod) {
- if (mod && mod.__esModule) return mod;
- var result = {};
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
- __setModuleDefault(result, mod);
- return result;
- };
- })();
- Object.defineProperty(exports, "__esModule", { value: true });
- exports.default = default_1;
- exports.setPrompterForTestOnly = setPrompterForTestOnly;
- const core_1 = require("@angular-devkit/core");
- const schematics_1 = require("@angular-devkit/schematics");
- const node_path_1 = require("node:path");
- const utility_1 = require("../utility");
- const json_file_1 = require("../utility/json-file");
- const latest_versions_1 = require("../utility/latest-versions");
- const ng_ast_utils_1 = require("../utility/ng-ast-utils");
- const project_targets_1 = require("../utility/project-targets");
- const util_1 = require("../utility/standalone/util");
- const workspace_1 = require("../utility/workspace");
- const workspace_models_1 = require("../utility/workspace-models");
- const tty_1 = require("./tty");
- const SERVE_SSR_TARGET_NAME = 'serve-ssr';
- const PRERENDER_TARGET_NAME = 'prerender';
- const DEFAULT_BROWSER_DIR = 'browser';
- const DEFAULT_MEDIA_DIR = 'media';
- const DEFAULT_SERVER_DIR = 'server';
- async function getLegacyOutputPaths(host, projectName, target) {
- // Generate new output paths
- const workspace = await (0, utility_1.readWorkspace)(host);
- const project = workspace.projects.get(projectName);
- const architectTarget = project?.targets.get(target);
- if (!architectTarget?.options) {
- throw new schematics_1.SchematicsException(`Cannot find 'options' for ${projectName} ${target} target.`);
- }
- const { outputPath } = architectTarget.options;
- if (typeof outputPath !== 'string') {
- throw new schematics_1.SchematicsException(`outputPath for ${projectName} ${target} target is not a string.`);
- }
- return outputPath;
- }
- async function getApplicationBuilderOutputPaths(host, projectName) {
- // Generate new output paths
- const target = 'build';
- const workspace = await (0, utility_1.readWorkspace)(host);
- const project = workspace.projects.get(projectName);
- const architectTarget = project?.targets.get(target);
- if (!architectTarget?.options) {
- throw new schematics_1.SchematicsException(`Cannot find 'options' for ${projectName} ${target} target.`);
- }
- const { outputPath } = architectTarget.options;
- if (outputPath === null || outputPath === undefined) {
- throw new schematics_1.SchematicsException(`outputPath for ${projectName} ${target} target is undefined or null.`);
- }
- const defaultDirs = {
- server: DEFAULT_SERVER_DIR,
- browser: DEFAULT_BROWSER_DIR,
- };
- if (outputPath && (0, core_1.isJsonObject)(outputPath)) {
- return {
- ...defaultDirs,
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- ...outputPath,
- };
- }
- if (typeof outputPath !== 'string') {
- throw new schematics_1.SchematicsException(`outputPath for ${projectName} ${target} target is not a string.`);
- }
- return {
- base: outputPath,
- ...defaultDirs,
- };
- }
- function addScriptsRule({ project }, isUsingApplicationBuilder) {
- return async (host) => {
- const pkgPath = '/package.json';
- const pkg = host.readJson(pkgPath);
- if (pkg === null) {
- throw new schematics_1.SchematicsException('Could not find package.json');
- }
- if (isUsingApplicationBuilder) {
- const { base, server } = await getApplicationBuilderOutputPaths(host, project);
- pkg.scripts ??= {};
- pkg.scripts[`serve:ssr:${project}`] = `node ${node_path_1.posix.join(base, server)}/server.mjs`;
- }
- else {
- const serverDist = await getLegacyOutputPaths(host, project, 'server');
- pkg.scripts = {
- ...pkg.scripts,
- 'dev:ssr': `ng run ${project}:${SERVE_SSR_TARGET_NAME}`,
- 'serve:ssr': `node ${serverDist}/main.js`,
- 'build:ssr': `ng build && ng run ${project}:server`,
- 'prerender': `ng run ${project}:${PRERENDER_TARGET_NAME}`,
- };
- }
- host.overwrite(pkgPath, JSON.stringify(pkg, null, 2));
- };
- }
- function updateApplicationBuilderTsConfigRule(options) {
- return async (host) => {
- const workspace = await (0, utility_1.readWorkspace)(host);
- const project = workspace.projects.get(options.project);
- const buildTarget = project?.targets.get('build');
- if (!buildTarget || !buildTarget.options) {
- return;
- }
- const tsConfigPath = buildTarget.options.tsConfig;
- if (!tsConfigPath || typeof tsConfigPath !== 'string') {
- // No tsconfig path
- return;
- }
- const json = new json_file_1.JSONFile(host, tsConfigPath);
- const filesPath = ['files'];
- const files = new Set(json.get(filesPath) ?? []);
- files.add('src/server.ts');
- json.modify(filesPath, [...files]);
- };
- }
- function updateApplicationBuilderWorkspaceConfigRule(projectSourceRoot, options, { logger }) {
- return (0, utility_1.updateWorkspace)((workspace) => {
- const buildTarget = workspace.projects.get(options.project)?.targets.get('build');
- if (!buildTarget) {
- return;
- }
- let outputPath = buildTarget.options?.outputPath;
- if (outputPath && (0, core_1.isJsonObject)(outputPath)) {
- if (outputPath.browser === '') {
- const base = outputPath.base;
- logger.warn(`The output location of the browser build has been updated from "${base}" to "${node_path_1.posix.join(base, DEFAULT_BROWSER_DIR)}".
- You might need to adjust your deployment pipeline.`);
- if ((outputPath.media && outputPath.media !== DEFAULT_MEDIA_DIR) ||
- (outputPath.server && outputPath.server !== DEFAULT_SERVER_DIR)) {
- delete outputPath.browser;
- }
- else {
- outputPath = outputPath.base;
- }
- }
- }
- buildTarget.options = {
- ...buildTarget.options,
- outputPath,
- outputMode: options.serverRouting ? 'server' : undefined,
- prerender: options.serverRouting ? undefined : true,
- ssr: {
- entry: (0, core_1.join)((0, core_1.normalize)(projectSourceRoot), 'server.ts'),
- },
- };
- });
- }
- function updateWebpackBuilderWorkspaceConfigRule(projectSourceRoot, options) {
- return (0, utility_1.updateWorkspace)((workspace) => {
- const projectName = options.project;
- const project = workspace.projects.get(projectName);
- if (!project) {
- return;
- }
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
- const serverTarget = project.targets.get('server');
- (serverTarget.options ??= {}).main = node_path_1.posix.join(projectSourceRoot, 'server.ts');
- const serveSSRTarget = project.targets.get(SERVE_SSR_TARGET_NAME);
- if (serveSSRTarget) {
- return;
- }
- project.targets.add({
- name: SERVE_SSR_TARGET_NAME,
- builder: '@angular-devkit/build-angular:ssr-dev-server',
- defaultConfiguration: 'development',
- options: {},
- configurations: {
- development: {
- browserTarget: `${projectName}:build:development`,
- serverTarget: `${projectName}:server:development`,
- },
- production: {
- browserTarget: `${projectName}:build:production`,
- serverTarget: `${projectName}:server:production`,
- },
- },
- });
- const prerenderTarget = project.targets.get(PRERENDER_TARGET_NAME);
- if (prerenderTarget) {
- return;
- }
- project.targets.add({
- name: PRERENDER_TARGET_NAME,
- builder: '@angular-devkit/build-angular:prerender',
- defaultConfiguration: 'production',
- options: {
- routes: ['/'],
- },
- configurations: {
- production: {
- browserTarget: `${projectName}:build:production`,
- serverTarget: `${projectName}:server:production`,
- },
- development: {
- browserTarget: `${projectName}:build:development`,
- serverTarget: `${projectName}:server:development`,
- },
- },
- });
- });
- }
- function updateWebpackBuilderServerTsConfigRule(options) {
- return async (host) => {
- const workspace = await (0, utility_1.readWorkspace)(host);
- const project = workspace.projects.get(options.project);
- const serverTarget = project?.targets.get('server');
- if (!serverTarget || !serverTarget.options) {
- return;
- }
- const tsConfigPath = serverTarget.options.tsConfig;
- if (!tsConfigPath || typeof tsConfigPath !== 'string') {
- // No tsconfig path
- return;
- }
- const tsConfig = new json_file_1.JSONFile(host, tsConfigPath);
- const filesAstNode = tsConfig.get(['files']);
- const serverFilePath = 'src/server.ts';
- if (Array.isArray(filesAstNode) && !filesAstNode.some(({ text }) => text === serverFilePath)) {
- tsConfig.modify(['files'], [...filesAstNode, serverFilePath]);
- }
- };
- }
- function addDependencies({ skipInstall }, isUsingApplicationBuilder) {
- const install = skipInstall ? utility_1.InstallBehavior.None : utility_1.InstallBehavior.Auto;
- const rules = [
- (0, utility_1.addDependency)('express', latest_versions_1.latestVersions['express'], {
- type: utility_1.DependencyType.Default,
- install,
- }),
- (0, utility_1.addDependency)('@types/express', latest_versions_1.latestVersions['@types/express'], {
- type: utility_1.DependencyType.Dev,
- install,
- }),
- ];
- if (!isUsingApplicationBuilder) {
- rules.push((0, utility_1.addDependency)('browser-sync', latest_versions_1.latestVersions['browser-sync'], {
- type: utility_1.DependencyType.Dev,
- install,
- }));
- }
- return (0, schematics_1.chain)(rules);
- }
- function addServerFile(projectSourceRoot, options, isStandalone) {
- return async (host) => {
- const projectName = options.project;
- const workspace = await (0, utility_1.readWorkspace)(host);
- const project = workspace.projects.get(projectName);
- if (!project) {
- throw new schematics_1.SchematicsException(`Invalid project name (${projectName})`);
- }
- const isUsingApplicationBuilder = usingApplicationBuilder(project);
- const browserDistDirectory = isUsingApplicationBuilder
- ? (await getApplicationBuilderOutputPaths(host, projectName)).browser
- : await getLegacyOutputPaths(host, projectName, 'build');
- const applicationBuilderFiles = 'application-builder' + (options.serverRouting ? '' : '-common-engine');
- return (0, schematics_1.mergeWith)((0, schematics_1.apply)((0, schematics_1.url)(`./files/${isUsingApplicationBuilder ? applicationBuilderFiles : 'server-builder'}`), [
- (0, schematics_1.applyTemplates)({
- ...core_1.strings,
- ...options,
- browserDistDirectory,
- isStandalone,
- }),
- (0, schematics_1.move)(projectSourceRoot),
- ]));
- };
- }
- function default_1(inputOptions) {
- return async (host, context) => {
- const browserEntryPoint = await (0, util_1.getMainFilePath)(host, inputOptions.project);
- const isStandalone = (0, ng_ast_utils_1.isStandaloneApp)(host, browserEntryPoint);
- const workspace = await (0, workspace_1.getWorkspace)(host);
- const clientProject = workspace.projects.get(inputOptions.project);
- if (!clientProject) {
- throw (0, project_targets_1.targetBuildNotFoundError)();
- }
- const isUsingApplicationBuilder = usingApplicationBuilder(clientProject);
- const serverRouting = await isServerRoutingEnabled(isUsingApplicationBuilder, inputOptions);
- const options = { ...inputOptions, serverRouting };
- const sourceRoot = clientProject.sourceRoot ?? node_path_1.posix.join(clientProject.root, 'src');
- return (0, schematics_1.chain)([
- (0, schematics_1.schematic)('server', {
- ...options,
- skipInstall: true,
- }),
- ...(isUsingApplicationBuilder
- ? [
- updateApplicationBuilderWorkspaceConfigRule(sourceRoot, options, context),
- updateApplicationBuilderTsConfigRule(options),
- ]
- : [
- updateWebpackBuilderServerTsConfigRule(options),
- updateWebpackBuilderWorkspaceConfigRule(sourceRoot, options),
- ]),
- addServerFile(sourceRoot, options, isStandalone),
- addScriptsRule(options, isUsingApplicationBuilder),
- addDependencies(options, isUsingApplicationBuilder),
- ]);
- };
- }
- function usingApplicationBuilder(project) {
- const buildBuilder = project.targets.get('build')?.builder;
- const isUsingApplicationBuilder = buildBuilder === workspace_models_1.Builders.Application || buildBuilder === workspace_models_1.Builders.BuildApplication;
- return isUsingApplicationBuilder;
- }
- const defaultPrompter = async (message, defaultValue) => {
- const { confirm } = await Promise.resolve().then(() => __importStar(require('@inquirer/prompts')));
- return await confirm({
- message,
- default: defaultValue,
- });
- };
- // Allow the prompt functionality to be overridden to facilitate testing.
- let prompt = defaultPrompter;
- function setPrompterForTestOnly(prompter) {
- prompt = prompter ?? defaultPrompter;
- }
- /** Returns whether or not server routing is enabled, potentially prompting the user if necessary. */
- async function isServerRoutingEnabled(isUsingApplicationBuilder, options) {
- if (!isUsingApplicationBuilder) {
- if (options.serverRouting) {
- throw new schematics_1.SchematicsException('Server routing APIs can only be added to a project using `application` builder.');
- }
- else {
- return false;
- }
- }
- // Use explicit option if provided.
- if (options.serverRouting !== undefined) {
- return options.serverRouting;
- }
- const serverRoutingDefault = false;
- // Use the default if not in an interactive terminal.
- if (!(0, tty_1.isTTY)()) {
- return serverRoutingDefault;
- }
- // `inquirer` requires `async_hooks` which isn't supported by webcontainers, therefore we can't prompt in that context.
- // See: https://github.com/SBoudrias/Inquirer.js/issues/1426
- if (process.versions.webcontainer) {
- return serverRoutingDefault;
- }
- // Prompt the user if in an interactive terminal and no option was provided.
- return await prompt('Would you like to use the Server Routing and App Engine APIs (Developer Preview) for this server application?',
- /* defaultValue */ serverRoutingDefault);
- }
|