@rxdi/schematics 0.7.124 → 0.7.128

package/lib/class/class.factory.test.ts

@@ -0,0 +1,100 @@
+import {
+  SchematicTestRunner,
+  UnitTestTree,
+} from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+import { ClassOptions } from './class.schema';
+
+describe('Class Factory', () => {
+  const runner: SchematicTestRunner = new SchematicTestRunner(
+    '.',
+    path.join(process.cwd(), 'src/collection.json'),
+  );
+  it('should manage name only', () => {
+    const options: ClassOptions = {
+      name: 'foo',
+      spec: true,
+      flat: true,
+    };
+    const tree: UnitTestTree = runner.runSchematic('class', options);
+    const files: string[] = tree.files;
+
+    expect(files.find(filename => filename === '/foo.ts')).not.toBeUndefined();
+    expect(tree.readContent('/foo.ts')).toEqual('export class Foo {}\n');
+  });
+  it('should manage name as a path', () => {
+    const options: ClassOptions = {
+      name: 'bar/foo',
+      flat: false,
+      spec: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('class', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar/foo/foo.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/bar/foo/foo.ts')).toEqual(
+      'export class Foo {}\n',
+    );
+  });
+  it('should manage name and path', () => {
+    const options: ClassOptions = {
+      name: 'foo',
+      path: 'baz',
+      flat: false,
+      spec: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('class', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/baz/foo/foo.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/baz/foo/foo.ts')).toEqual(
+      'export class Foo {}\n',
+    );
+  });
+  it('should manage name to dasherize', () => {
+    const options: ClassOptions = {
+      name: 'fooBar',
+      flat: false,
+      spec: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('class', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo-bar/foo-bar.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/foo-bar/foo-bar.ts')).toEqual(
+      'export class FooBar {}\n',
+    );
+  });
+  it('should manage path to dasherize', () => {
+    const options: ClassOptions = {
+      name: 'barBaz/foo',
+      spec: false,
+      flat: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('class', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/bar-baz/foo/foo.ts'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/bar-baz/foo/foo.ts')).toEqual(
+      'export class Foo {}\n',
+    );
+  });
+  it('should manage javascript file', () => {
+    const options: ClassOptions = {
+      name: 'foo',
+      language: 'js',
+      flat: false,
+      spec: false,
+    };
+    const tree: UnitTestTree = runner.runSchematic('class', options);
+    const files: string[] = tree.files;
+    expect(
+      files.find(filename => filename === '/foo/foo.js'),
+    ).not.toBeUndefined();
+    expect(tree.readContent('/foo/foo.js')).toEqual('export class Foo {}\n');
+  });
+});

package/lib/class/class.factory.ts

@@ -0,0 +1,54 @@
+import { join, Path, strings } from '@angular-devkit/core';
+import {
+  apply,
+  chain,
+  filter,
+  mergeWith,
+  move,
+  noop,
+  Rule,
+  SchematicContext,
+  SchematicsException,
+  Source,
+  template,
+  url,
+} from '@angular-devkit/schematics';
+import { Location, NameParser } from '../../utils/name.parser';
+import { mergeSourceRoot } from '../../utils/source-root.helpers';
+import { DEFAULT_LANGUAGE } from '../defaults';
+import { ClassOptions } from './class.schema';
+
+export function main(options: ClassOptions): Rule {
+  options = transform(options);
+  return chain([mergeSourceRoot(options), mergeWith(generate(options))]);
+}
+
+function transform(options: ClassOptions): ClassOptions {
+  const target: ClassOptions = Object.assign({}, options);
+  if (!target.name) {
+    throw new SchematicsException('Option (name) is required.');
+  }
+  const location: Location = new NameParser().parse(target);
+  target.name = strings.dasherize(location.name);
+  target.language =
+    target.language !== undefined ? target.language : DEFAULT_LANGUAGE;
+
+  target.path = strings.dasherize(location.path);
+  target.path = target.flat
+    ? target.path
+    : join(target.path as Path, target.name);
+
+  return target;
+}
+
+function generate(options: ClassOptions): Source {
+  return (context: SchematicContext) =>
+    apply(url(join('./files' as Path, options.language)), [
+      options.spec ? noop() : filter(path => !path.endsWith('.spec.ts')),
+      template({
+        ...strings,
+        ...options,
+      }),
+      move(options.path),
+    ])(context);
+}

package/lib/class/class.schema.d.ts

@@ -0,0 +1,28 @@
+import { Path } from '@angular-devkit/core';
+
+export interface ClassOptions {
+  /**
+   * The name of the class.
+   */
+  name: string;
+  /**
+   * The path to create the class.
+   */
+  path?: string | Path;
+  /**
+   * Application language.
+   */
+  language?: string;
+  /**
+   * The source root path
+   */
+  sourceRoot?: string;
+  /**
+   * Specifies if a spec file is generated.
+   */
+  spec?: boolean;
+  /**
+   * Flag to indicate if a directory is created.
+   */
+  flat?: boolean;
+}

package/lib/class/files/js/__name__.js

@@ -0,0 +1 @@
+export class <%= classify(name) %> {}

package/lib/class/files/js/__name__.spec.js

@@ -0,0 +1,7 @@
+import { <%= classify(name) %> } from './<%= name %>';
+
+describe('<%= classify(name) %>', () => {
+  it('should be defined', () => {
+    expect(new <%= classify(name) %>()).toBeDefined();
+  });
+});

package/lib/class/files/ts/__name__.spec.ts

@@ -0,0 +1,7 @@
+import { <%= classify(name) %> } from './<%= name %>';
+
+describe('<%= classify(name) %>', () => {
+  it('should be defined', () => {
+    expect(new <%= classify(name) %>()).toBeDefined();
+  });
+});

package/lib/class/files/ts/__name__.ts

@@ -0,0 +1 @@
+export class <%= classify(name) %> {}

package/lib/class/schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "SchematicsNestClass",
+  "title": "Nest Class Options Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the class.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the class?"
+    },
+    "flat": {
+      "default": true,
+      "description": "Flag to indicate if a directory is created."
+    },
+    "spec": {
+      "default": true,
+      "description": "Specifies if a spec file is generated."
+    },
+    "path": {
+      "type": "string",
+      "format": "path",
+      "description": "The path to create the class."
+    },
+    "language": {
+      "type": "string",
+      "description": "Nest class language (ts/js)."
+    },
+    "sourceRoot": {
+      "type": "string",
+      "description": "Nest controller source root directory."
+    }
+  },
+  "required": ["name"]
+}

package/lib/client-app/angular/angular.factory.js

@@ -12,12 +12,12 @@ const source_root_helpers_1 = require("../../../utils/source-root.helpers");
 function main(options) {
     options = transform(options);
     return (tree, context) => {
-        return schematics_1.branchAndMerge(schematics_1.chain([
+        return (0, schematics_1.branchAndMerge)((0, schematics_1.chain)([
             createAngularApplication(options),
-            source_root_helpers_1.mergeSourceRoot(options),
+            (0, source_root_helpers_1.mergeSourceRoot)(options),
             addDeclarationToModule(options),
             addGlobalPrefix(),
-            schematics_1.mergeWith(generate(options)),
+            (0, schematics_1.mergeWith)(generate(options)),
         ]))(tree, context);
     };
 }
@@ -30,20 +30,20 @@ function transform(source) {
     target.type = 'module';
     const location = new name_parser_1.NameParser().parse(target);
     target.name = core_1.strings.dasherize(location.name);
-    target.path = path_1.join(core_1.strings.dasherize(location.path), target.name);
+    target.path = (0, path_1.join)(core_1.strings.dasherize(location.path), target.name);
     return target;
 }
 function generate(options) {
-    return (context) => schematics_1.apply(schematics_1.url('./files'), [
-        schematics_1.template(Object.assign(Object.assign({}, core_1.strings), options)),
-        schematics_1.move(options.path),
+    return (context) => (0, schematics_1.apply)((0, schematics_1.url)('./files'), [
+        (0, schematics_1.template)(Object.assign(Object.assign({}, core_1.strings), options)),
+        (0, schematics_1.move)(options.path),
     ])(context);
 }
 function createAngularApplication(options) {
     if (!options.initApp) {
-        return schematics_1.noop();
+        return (0, schematics_1.noop)();
     }
-    return schematics_1.externalSchematic('@schematics/angular', 'ng-new', {
+    return (0, schematics_1.externalSchematic)('@schematics/angular', 'ng-new', {
         name: options.directory,
         version: '7.0.0',
     });

package/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/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/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/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/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/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/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/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');
+  }
+}