@gapi/schematics 1.8.122

package/dist/lib/client-app/angular/angular.factory.ts

@@ -0,0 +1,139 @@
+import { strings } from '@angular-devkit/core';
+import {
+  apply,
+  branchAndMerge,
+  chain,
+  externalSchematic,
+  mergeWith,
+  move,
+  noop,
+  Rule,
+  SchematicContext,
+  template,
+  Tree,
+  url,
+} from '@angular-devkit/schematics';
+import { join } from 'path';
+import * as ts from 'ts-morph';
+import { Path } from 'typescript';
+import {
+  DeclarationOptions,
+  ModuleDeclarator,
+} from '../../../utils/module.declarator';
+import { ModuleFinder } from '../../../utils/module.finder';
+import { Location, NameParser } from '../../../utils/name.parser';
+import { mergeSourceRoot } from '../../../utils/source-root.helpers';
+import { ModuleOptions } from '../../module/module.schema';
+import { AngularOptions } from './angular.schema';
+
+export function main(options: AngularOptions): Rule {
+  options = transform(options);
+  return (tree: Tree, context: SchematicContext) => {
+    return branchAndMerge(
+      chain([
+        createAngularApplication(options),
+        mergeSourceRoot(options),
+        addDeclarationToModule(options),
+        addGlobalPrefix(),
+        mergeWith(generate(options)),
+      ]),
+    )(tree, context);
+  };
+}
+
+function transform(source: AngularOptions): ModuleOptions {
+  const target: AngularOptions = Object.assign({}, source);
+  target.directory = target.name ? strings.dasherize(target.name) : 'client';
+  target.name = 'Angular';
+  target.metadata = 'imports';
+  target.type = 'module';
+
+  const location: Location = new NameParser().parse(target);
+  target.name = strings.dasherize(location.name);
+  target.path = join(strings.dasherize(location.path) as Path, target.name);
+  return target;
+}
+
+function generate(options: AngularOptions) {
+  return (context: SchematicContext) =>
+    apply(url('./files' as Path), [
+      template({
+        ...strings,
+        ...options,
+      }),
+      move(options.path),
+    ])(context);
+}
+
+function createAngularApplication(options: AngularOptions): Rule {
+  if (!options.initApp) {
+    return noop();
+  }
+  return externalSchematic('@schematics/angular', 'ng-new', {
+    name: options.directory,
+    version: '7.0.0',
+  });
+}
+
+function addDeclarationToModule(options: AngularOptions): Rule {
+  return (tree: Tree) => {
+    options.module = new ModuleFinder(tree).find({
+      name: options.name,
+      path: options.path as any,
+    });
+    if (!options.module) {
+      return tree;
+    }
+    const content = tree.read(options.module).toString();
+    const declarator: ModuleDeclarator = new ModuleDeclarator();
+
+    const rootPath = `${options.directory}/dist/${options.directory}`;
+    const declarationOptions = ({
+      ...options,
+      staticOptions: {
+        name: 'forRoot',
+        value: {
+          rootPath,
+        },
+      },
+    } as unknown) as DeclarationOptions;
+    tree.overwrite(
+      options.module,
+      declarator.declare(content, declarationOptions),
+    );
+    return tree;
+  };
+}
+
+function addGlobalPrefix(): Rule {
+  return (tree: Tree) => {
+    const mainFilePath = 'src/main.ts';
+    const fileRef = tree.get(mainFilePath);
+    if (!fileRef) {
+      return tree;
+    }
+    const tsProject = new ts.Project({
+      manipulationSettings: {
+        indentationText: ts.IndentationText.TwoSpaces,
+      },
+    });
+    const tsFile = tsProject.addExistingSourceFile(mainFilePath);
+    const bootstrapFunction = tsFile.getFunction('bootstrap');
+    const listenStatement = bootstrapFunction.getStatement(node =>
+      node.getText().includes('listen'),
+    );
+    const setPrefixStatement = bootstrapFunction.getStatement(node =>
+      node.getText().includes('setGlobalPrefix'),
+    );
+    if (!listenStatement || setPrefixStatement) {
+      return tree;
+    }
+    const listenExprIndex = listenStatement.getChildIndex();
+    bootstrapFunction.insertStatements(
+      listenExprIndex,
+      `app.setGlobalPrefix('api');`,
+    );
+    tree.overwrite(mainFilePath, tsFile.getFullText());
+    return tree;
+  };
+}

package/dist/lib/client-app/angular/angular.schema.d.ts

@@ -0,0 +1,32 @@
+import { Path } from '@angular-devkit/core';
+
+export interface AngularOptions {
+  /**
+   * The name of the application.
+   */
+  name: string;
+  /**
+   * The directory of the application.
+   */
+  directory?: string;
+  /**
+   * The path to create the module.
+   */
+  path?: string;
+  /**
+   * The path to insert the module declaration.
+   */
+  module?: Path;
+  /**
+   * Flag which indicates if Angular app should be scaffolded
+   */
+  initApp?: boolean;
+  /**
+   * Metadata name affected by declaration insertion.
+   */
+  metadata?: string;
+  /**
+   * Nest element type name
+   */
+  type?: string;
+}

package/dist/lib/client-app/angular/files/angular.constants.ts

@@ -0,0 +1,4 @@
+export const ANGULAR_MODULE_OPTIONS = 'ANGULAR_MODULE_OPTIONS';
+
+export const DEFAULT_ROOT_PATH = 'client/dist';
+export const DEFAULT_RENDER_PATH = '*';

package/dist/lib/client-app/angular/files/angular.module.ts

@@ -0,0 +1,41 @@
+import { DynamicModule, Inject, Module, OnModuleInit } from '@nestjs/common';
+import { HttpAdapterHost } from '@nestjs/core';
+import {
+  ANGULAR_MODULE_OPTIONS,
+  DEFAULT_RENDER_PATH,
+  DEFAULT_ROOT_PATH,
+} from './angular.constants';
+import { angularProviders } from './angular.providers';
+import { AngularModuleOptions } from './interfaces/angular-options.interface';
+import { AbstractLoader } from './loaders/abstract.loader';
+
+@Module({
+  providers: [...angularProviders],
+})
+export class AngularModule implements OnModuleInit {
+  constructor(
+    @Inject(ANGULAR_MODULE_OPTIONS)
+    private readonly ngOptions: AngularModuleOptions,
+    private readonly loader: AbstractLoader,
+    private readonly httpAdapterHost: HttpAdapterHost,
+  ) {}
+
+  public static forRoot(options: AngularModuleOptions = {}): DynamicModule {
+    options.rootPath = options.rootPath || DEFAULT_ROOT_PATH;
+    options.renderPath = options.renderPath || DEFAULT_RENDER_PATH;
+    return {
+      module: AngularModule,
+      providers: [
+        {
+          provide: ANGULAR_MODULE_OPTIONS,
+          useValue: options,
+        },
+      ],
+    };
+  }
+
+  public async onModuleInit() {
+    const httpAdapter = this.httpAdapterHost.httpAdapter;
+    this.loader.register(httpAdapter, this.ngOptions);
+  }
+}

package/dist/lib/client-app/angular/files/angular.providers.ts

@@ -0,0 +1,27 @@
+import { Provider } from '@nestjs/common';
+import { HttpAdapterHost } from '@nestjs/core';
+import { AbstractLoader } from './loaders/abstract.loader';
+import { ExpressLoader } from './loaders/express.loader';
+import { FastifyLoader } from './loaders/fastify.loader';
+import { NoopLoader } from './loaders/noop.loader';
+
+export const angularProviders: Provider[] = [
+  {
+    provide: AbstractLoader,
+    useFactory: (httpAdapterHost: HttpAdapterHost) => {
+      if (!httpAdapterHost) {
+        return new NoopLoader();
+      }
+      const httpAdapter = httpAdapterHost.httpAdapter;
+      if (
+        httpAdapter &&
+        httpAdapter.constructor &&
+        httpAdapter.constructor.name === 'FastifyAdapter'
+      ) {
+        return new FastifyLoader();
+      }
+      return new ExpressLoader();
+    },
+    inject: [HttpAdapterHost],
+  },
+];

package/dist/lib/client-app/angular/files/angular.utils.ts

@@ -0,0 +1,19 @@
+import { Logger } from '@nestjs/common';
+
+const MISSING_REQUIRED_DEPENDENCY = (name: string, reason: string) =>
+  `The "${name}" package is missing. Please, make sure to install this library ($ npm install ${name}) to take advantage of ${reason}.`;
+
+const logger = new Logger('PackageLoader');
+
+export function loadPackage<T = any>(
+  packageName: string,
+  context: string,
+  loaderFn?: () => T,
+): T {
+  try {
+    return loaderFn ? loaderFn() : require(packageName);
+  } catch (e) {
+    logger.error(MISSING_REQUIRED_DEPENDENCY(packageName, context));
+    process.exit(1);
+  }
+}

package/dist/lib/client-app/angular/files/interfaces/angular-options.interface.ts

@@ -0,0 +1,87 @@
+export interface AngularModuleOptions {
+  /**
+   * Static files root directory.
+   * Default: "client/dist"
+   */
+  rootPath?: string;
+  /**
+   * Path to render Angular app.
+   * Default: * (wildcard - all paths)
+   */
+  renderPath?: string;
+  /**
+   * Serve static options (static files)
+   * Passed down to the underlying either `express.static` or `fastify-static.send`
+   */
+  serveStaticOptions?: {
+    /**
+     * Enable or disable setting Cache-Control response header, defaults to true.
+     * Disabling this will ignore the immutable and maxAge options.
+     */
+    cacheControl?: boolean;
+
+    /**
+     * Set how "dotfiles" are treated when encountered. A dotfile is a file or directory that begins with a dot (".").
+     * Note this check is done on the path itself without checking if the path actually exists on the disk.
+     * If root is specified, only the dotfiles above the root are checked
+     * (i.e. the root itself can be within a dotfile when when set to "deny").
+     * The default value is 'ignore'.
+     * 'allow' No special treatment for dotfiles
+     * 'deny' Send a 403 for any request for a dotfile
+     * 'ignore' Pretend like the dotfile does not exist and call next()
+     */
+    dotfiles?: string;
+
+    /**
+     * Enable or disable etag generation, defaults to true.
+     */
+    etag?: boolean;
+
+    /**
+     * Set file extension fallbacks. When set, if a file is not found, the given extensions
+     * will be added to the file name and search for.
+     * The first that exists will be served. Example: ['html', 'htm'].
+     * The default value is false.
+     */
+    extensions?: string[];
+
+    /**
+     * Enable or disable the immutable directive in the Cache-Control response header.
+     * If enabled, the maxAge option should also be specified to enable caching.
+     * The immutable directive will prevent supported clients from making conditional
+     * requests during the life of the maxAge option to check if the file has changed.
+     */
+    immutable?: boolean;
+
+    /**
+     * By default this module will send "index.html" files in response to a request on a directory.
+     * To disable this set false or to supply a new index pass a string or an array in preferred order.
+     */
+    index?: boolean | string | string[];
+
+    /**
+     * Enable or disable Last-Modified header, defaults to true. Uses the file system's last modified value.
+     */
+    lastModified?: boolean;
+
+    /**
+     * Provide a max-age in milliseconds for http caching, defaults to 0.
+     * This can also be a string accepted by the ms module.
+     */
+    maxAge?: number | string;
+
+    /**
+     * Redirect to trailing "/" when the pathname is a dir. Defaults to true.
+     */
+    redirect?: boolean;
+
+    /**
+     * Function to set custom headers on response. Alterations to the headers need to occur synchronously.
+     * The function is called as fn(res, path, stat), where the arguments are:
+     * res the response object
+     * path the file path that is being sent
+     * stat the stat object of the file that is being sent
+     */
+    setHeaders?: (res: any, path: string, stat: any) => any;
+  };
+}

package/dist/lib/client-app/angular/files/loaders/abstract.loader.ts

@@ -0,0 +1,16 @@
+import { Injectable } from '@nestjs/common';
+import { AbstractHttpAdapter } from '@nestjs/core';
+import { join } from 'path';
+import { AngularModuleOptions } from '../interfaces/angular-options.interface';
+
+@Injectable()
+export abstract class AbstractLoader {
+  public abstract register(
+    httpAdapter: AbstractHttpAdapter,
+    options: AngularModuleOptions,
+  );
+
+  public getIndexFilePath(clientPath: string): string {
+    return join(clientPath, 'index.html');
+  }
+}

package/dist/lib/client-app/angular/files/loaders/express.loader.ts

@@ -0,0 +1,25 @@
+import { Injectable } from '@nestjs/common';
+import { AbstractHttpAdapter } from '@nestjs/core';
+import { loadPackage } from '../angular.utils';
+import { AngularModuleOptions } from '../interfaces/angular-options.interface';
+import { AbstractLoader } from './abstract.loader';
+
+@Injectable()
+export class ExpressLoader extends AbstractLoader {
+  public register(
+    httpAdapter: AbstractHttpAdapter,
+    options: AngularModuleOptions,
+  ) {
+    const app = httpAdapter.getInstance();
+    const express = loadPackage('express', 'AngularModule', () =>
+      require('express'),
+    );
+    const clientPath = options.rootPath;
+    const indexFilePath = this.getIndexFilePath(clientPath);
+
+    app.use(express.static(clientPath, options.serveStaticOptions));
+    app.get(options.renderPath, (req: any, res: any) =>
+      res.sendFile(indexFilePath),
+    );
+  }
+}

package/dist/lib/client-app/angular/files/loaders/fastify.loader.ts

@@ -0,0 +1,34 @@
+import { Injectable } from '@nestjs/common';
+import { AbstractHttpAdapter } from '@nestjs/core';
+import * as fs from 'fs';
+import { loadPackage } from '../angular.utils';
+import { AngularModuleOptions } from '../interfaces/angular-options.interface';
+import { AbstractLoader } from './abstract.loader';
+
+@Injectable()
+export class FastifyLoader extends AbstractLoader {
+  public register(
+    httpAdapter: AbstractHttpAdapter,
+    options: AngularModuleOptions,
+  ) {
+    const app = httpAdapter.getInstance();
+    const fastifyStatic = loadPackage('fastify-static', 'AngularModule', () =>
+      require('fastify-static'),
+    );
+    const { setHeaders, redirect, ...send } =
+      options.serveStaticOptions || ({} as any);
+    const clientPath = options.rootPath;
+    const indexFilePath = this.getIndexFilePath(clientPath);
+
+    app.register(fastifyStatic, {
+      root: clientPath,
+      setHeaders,
+      redirect,
+      send,
+    });
+    app.get(options.renderPath, (req: any, res: any) => {
+      const stream = fs.createReadStream(indexFilePath);
+      res.type('text/html').send(stream);
+    });
+  }
+}

package/dist/lib/client-app/angular/files/loaders/noop.loader.ts

@@ -0,0 +1,12 @@
+import { Injectable } from '@nestjs/common';
+import { AbstractHttpAdapter } from '@nestjs/core';
+import { AngularModuleOptions } from '../interfaces/angular-options.interface';
+import { AbstractLoader } from './abstract.loader';
+
+@Injectable()
+export class NoopLoader extends AbstractLoader {
+  public register(
+    httpAdapter: AbstractHttpAdapter,
+    options: AngularModuleOptions,
+  ) {}
+}