# NX Graphql Mesh

[Nx](https://nx.dev) plugin for [GraphQL Mesh](https://www.graphql-mesh.com) integration within a Nx Workspace.

## Setup

### Npm

```shell
npm install -D @diogovcs/graphql-mesh
```

### Yarn

```shell
yarn add -D @diogovcs/graphql-mesh
```

### Pnpm

```shell
pnpm add -D @diogovcs/graphql-mesh
```

### Add to Workspace

```shell
nx generate @diogovcs/graphql-mesh:install [APP_NAME] [...OPTIONS]
```

This command will create a graphql mesh application with the name APP_NAME for the provided options. By default, this
will create a `.meshrc.yml` file that is separated into multiple yaml files. This uses the `yamlinc` project to merge
all the different configurations before build the application (this configuration can be overridden in the options). The
available options allowed when generating an application are the following:

| name             | type      | default | description                                                  |
|------------------|-----------|---------|--------------------------------------------------------------|
| --dryRun         | `boolean` | `false` | run with dry mode                                            |
| --singleMeshFile | `boolean` | `false` | Creates a project with a single `.meshrc` configuration file |
| --directory      | `string`  | `apps`  | Directory where the application will be created at.          |

### Examples

Run with single mesh configuration:

```shell
nx generate @diogovcs/graphql-mesh:install my-graphql-mesh --singleMeshFile
```

Create app on specif folder:

```shell
nx generate @diogovcs/graphql-mesh:install my-graphql-mesh --directory=api-gateways
```

## Build

The build executor can take optional parameters as the location of the main `.meshrc.yml` folder and a boolean flagging
if the build should use the `yamlinc` to build the full `.mesrc.yml` configuration or not.

Here it is an example a build executor configuration:

```json
{
  "build": {
    "executor": "@diogovcs/graphql-mesh:build",
    "options": {
      "meshYmlPath": "apps/api-gateway/config",
      "singleMeshFile": false
    }
  }
}
```

### Options

| name              | type      | default | description                                                                                                                                          |
|-------------------|-----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| meshYmlPath       | `string`  | `false` | Path to the `.meshrc.yml` file.                                                                                                                      |
| singleMeshFile    | `boolean` | `false` | Creates a project with a single `.meshrc` configuration file                                                                                         |
| envFile           | `string`  | -       | Path to the `.env` file where the environment variables are located. Defaults to do not use environment files.                                       |
| fileType          | `json`    | `ts`    | `ts` Type of file.                                                                                                                                   |
| outputPath        | `string`  |         | Path to where the built files will be placed.                                                                                                        |
| rootPath          | `string`  |         | Root path of the application.                                                                                                                        |
| tsconfigPath      | `string`  |         | Path to where the tsconfig file is located.                                                                                                          |
| typescriptSupport | `boolean` | `true`  | Either if typescript should be provided to transpile files. IF only using Javascript files, turn this to false, because it will decrease build time. |

When using the `singleMeshFile` configuration with `false`, the compiled `.meshrc.yml` will be created under
the `.compiled` folder.

## Serve

The serve is intended to be used only in development as it creates a development server to listen for code changes. For
Production use the start executor. Here it is an example a serve executor configuration:

```json
{
  "serve": {
    "executor": "@diogovcs/graphql-mesh:serve",
    "options": {
      "meshYmlPath": "apps/api-gateway/config"
    }
  }
}
```

### Options

| name         | type     | default                   | description                                                                                                    |
|--------------|----------|---------------------------|----------------------------------------------------------------------------------------------------------------|
| meshYmlPath  | `string` | `false`                   | Path to the `.meshrc.yml` file.                                                                                |
| envFile      | `string` | -                         | Path to the `.env` file where the environment variables are located. Defaults to do not use environment files. |
| tsConfigPath | `string` | Graphql Mesh default port | Path to the `tsconfig.json` file.                                                                              |
| mainPath     | `string` | Graphql Mesh default port | Path to the `main.ts` file.                                                                                    |
| rootPath     | `string` | Graphql Mesh default port | Root folder of the project.                                                                                    |

## Start

Triggers the mesh start command. Should be used for production:

```json
{
  "serve": {
    "executor": "@diogovcs/graphql-mesh:start",
    "options": {
      "meshYmlPath": "apps/api-gateway/config"
    }
  }
}
```

### Options

| name              | type      | default | description                                                                                                                                          |
|-------------------|-----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| meshYmlPath       | `string`  | `false` | Path to the `.meshrc.yml` file.                                                                                                                      |
| envFile           | `string`  | -       | Path to the `.env` file where the environment variables are located. Defaults to do not use environment files.                                       |
| typescriptSupport | `boolean` | `true`  | Either if typescript should be provided to transpile files. IF only using Javascript files, turn this to false, because it will decrease build time. |