@nestledjs/api 0.0.1

package/src/prisma/files/src/lib/seed/seed-data/seed-users.ts__tmpl__

@@ -0,0 +1,32 @@
+import { UserRole } from '../../prisma-generated'
+
+
+export const seedUsers = [
+  {
+    id: '1',
+    firstName: 'SuperAdmin',
+    lastName: 'User',
+    email: 'superadmin@example.com',
+    displayName: 'Super Admin',
+    role: UserRole.SUPER_ADMIN,
+    password: 'password123',
+  },
+  {
+    id: '2',
+    firstName: 'Admin',
+    lastName: 'User',
+    email: 'admin@example.com',
+    displayName: 'Admin User',
+    role: UserRole.ADMIN,
+    password: 'password123',
+  },
+  {
+    id: '3',
+    firstName: 'User',
+    lastName: 'User',
+    email: 'user@example.com',
+    displayName: 'Regular User',
+    role: UserRole.USER,
+    password: 'password123',
+  },
+];

package/src/prisma/files/src/lib/seed/seed.ts__tmpl__

@@ -0,0 +1,64 @@
+import { PrismaClient } from '../prisma-generated'
+import { countries } from './seed-data/iso-3166-countries'
+import { seedUsers } from './seed-data/seed-users'
+import { hashSync } from 'bcryptjs'
+
+const prisma = new PrismaClient()
+async function main() {
+  for (const country of countries) {
+    await prisma.country.upsert({
+      where: { alpha2: country['alpha-2'] },
+      update: {},
+      create: {
+        name: country.name,
+        alpha2: country['alpha-2'],
+        alpha3: country['alpha-3'],
+        countryCode: country['country-code'],
+        iso3166_2: country['iso_3166-2'],
+        region: country.region,
+        subRegion: country['sub-region'],
+        intermediateRegion: country['intermediate-region'],
+        regionCode: country['region-code'],
+        subRegionCode: country['sub-region-code'],
+        intermediateRegionCode: country['intermediate-region-code'],
+      },
+    })
+  }
+  for (const user of seedUsers) {
+    try {
+      await prisma.user.upsert({
+        where: { id: user.id },
+        update: {},
+        create: {
+          firstName: user.firstName,
+          lastName: user.lastName,
+          displayName: user.displayName,
+          emails: {
+            create: {
+              email: user.email,
+              primary: true,
+            },
+          },
+          password: hashSync(user.password, 10),
+          role: user.role,
+        },
+      });
+      console.log(`User ${user.displayName} seeded.`);
+    } catch (e) {
+      if ((e as any).code === 'P2002' && (e as any).meta?.target?.includes('displayName')) {
+        console.log(`User with displayName \"${user.displayName}\" already exists. Skipping.`);
+      } else {
+        throw e;
+      }
+    }
+  }
+}
+main()
+  .then(async () => {
+    await prisma.$disconnect()
+  })
+  .catch(async (e) => {
+    console.error(e)
+    await prisma.$disconnect()
+    process.exit(1)
+  })

package/src/prisma/generator.spec.ts

@@ -0,0 +1,60 @@
+import { formatFiles, installPackagesTask, Tree } from '@nx/devkit'
+import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing'
+import { describe, expect, it, vi } from 'vitest'
+import { apiLibraryGenerator } from '@nestledjs/utils'
+
+import generator from './generator'
+
+vi.mock('@nestledjs/utils', async () => {
+  const actual = await vi.importActual('@nestledjs/utils')
+  return {
+    ...actual,
+    apiLibraryGenerator: vi.fn(),
+  }
+})
+
+vi.mock('@nx/devkit', async () => {
+  const actual = await vi.importActual('@nx/devkit')
+  return {
+    ...actual,
+    formatFiles: vi.fn(),
+    installPackagesTask: vi.fn(),
+  }
+})
+
+describe('prisma generator', () => {
+  let tree: Tree
+
+  beforeEach(() => {
+    tree = createTreeWithEmptyWorkspace()
+    tree.write('package.json', JSON.stringify({ name: 'test' }))
+  })
+
+  it('should run successfully', async () => {
+    const callback = await generator(tree)
+    callback()
+
+    const packageJson = JSON.parse(tree.read('package.json', 'utf-8'))
+
+    expect(packageJson.prisma).toEqual({
+      schema: 'libs/api/prisma/src/lib/schemas',
+      seed: 'ts-node --project libs/api/core/models/tsconfig.lib.json libs/api/prisma/src/lib/seed/seed.ts',
+    })
+
+    expect(packageJson.scripts['generate:models']).toBe(
+      'ts-node --project libs/api/core/models/tsconfig.lib.json libs/api/core/models/src/lib/generate-models.ts',
+    )
+
+    expect(apiLibraryGenerator).toHaveBeenCalledWith(tree, { name: 'prisma', overwrite: false }, expect.any(String))
+    expect(formatFiles).toHaveBeenCalledWith(tree)
+    expect(installPackagesTask).toHaveBeenCalledWith(tree)
+  })
+
+  it('should pass overwrite flag to apiLibraryGenerator when overwrite is true', async () => {
+    tree.write('package.json', JSON.stringify({ name: 'test' }))
+    const callback = await generator(tree, { overwrite: true })
+    callback()
+
+    expect(apiLibraryGenerator).toHaveBeenCalledWith(tree, { name: 'prisma', overwrite: true }, expect.any(String))
+  })
+})

package/src/prisma/generator.ts

@@ -0,0 +1,61 @@
+import { formatFiles, installPackagesTask, joinPathFragments, Tree, updateJson } from '@nx/devkit'
+import { apiLibraryGenerator } from '@nestledjs/utils'
+import { ApiPrismaGeneratorSchema } from './schema'
+
+export default async function generateLibraries(tree: Tree, options: ApiPrismaGeneratorSchema = {}) {
+  const templateRootPath = joinPathFragments(__dirname, './files')
+  const overwrite = options.overwrite === true
+
+  // Update package.json
+  updateJson(tree, 'package.json', (json) => {
+    // Add prisma schema path
+    json.prisma = {
+      schema: 'libs/api/prisma/src/lib/schemas',
+      seed: 'ts-node --project libs/api/core/models/tsconfig.lib.json libs/api/prisma/src/lib/seed/seed.ts',
+    }
+    // Add GraphQL model generation script for the 'core' library
+    if (!json.scripts) {
+      json.scripts = {}
+    }
+    if (!json.scripts['generate:models']) {
+      json.scripts['generate:models'] =
+        'ts-node --project libs/api/core/models/tsconfig.lib.json libs/api/core/models/src/lib/generate-models.ts'
+    }
+
+    // Add all requested prisma scripts if not already present
+    if (!json.scripts['prisma:apply']) {
+      json.scripts['prisma:apply'] = 'pnpm prisma:format && pnpm prisma db push'
+    }
+    if (!json.scripts['prisma:db-push']) {
+      json.scripts['prisma:db-push'] = 'pnpm prisma db push'
+    }
+    if (!json.scripts['prisma:format']) {
+      json.scripts['prisma:format'] = 'pnpm prisma format'
+    }
+    if (!json.scripts['prisma:generate']) {
+      json.scripts['prisma:generate'] = 'pnpm prisma generate'
+    }
+    if (!json.scripts['prisma:migrate']) {
+      json.scripts['prisma:migrate'] = 'pnpm prisma migrate save && pnpm prisma migrate up'
+    }
+    if (!json.scripts['prisma:seed']) {
+      json.scripts['prisma:seed'] =
+        'ts-node --project libs/api/prisma/tsconfig.lib.json libs/api/prisma/src/lib/seed/seed.ts'
+    }
+    if (!json.scripts['prisma:studio']) {
+      json.scripts['prisma:studio'] = 'pnpm nx prisma:studio api'
+    }
+    if (!json.scripts['prisma:reset']) {
+      json.scripts['prisma:reset'] = 'pnpm prisma migrate reset && pnpm prisma:seed'
+    }
+    return json
+  })
+
+  await apiLibraryGenerator(tree, { name: 'prisma', overwrite }, templateRootPath)
+
+  await formatFiles(tree)
+
+  return () => {
+    installPackagesTask(tree)
+  }
+}

package/src/prisma/schema.d.ts

@@ -0,0 +1,3 @@
+export interface ApiPrismaGeneratorSchema {
+  overwrite?: boolean
+}

package/src/prisma/schema.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "ApiPrisma",
+  "title": "Create the API Prisma library",
+  "type": "object",
+  "properties": {
+    "overwrite": {
+      "type": "boolean",
+      "description": "Whether to overwrite the existing prisma library if it exists.",
+      "default": false
+    }
+  }
+}

package/src/setup/generator.md

@@ -0,0 +1,49 @@
+# Overview
+This code is a generator function that sets up a NestJS-based API project with various dependencies and configurations. The generator performs the following tasks:
+
+1. Adds necessary dependencies to the `package.json` file.
+2. Updates the `tsconfig.base.json` file to set the `baseUrl` for path aliases and remove the `emitDeclarationOnly` option if it exists.
+3. Updates the `package.json` file to:
+   - Initialize the `pnpm.onlyBuiltDependencies` array if it doesn't exist.
+   - Add required packages to the `pnpm.onlyBuiltDependencies` array.
+   - Add a `generate:models` script to generate GraphQL models.
+4. Removes the `workspaces` section from the `package.json` file if it exists.
+5. Runs `pnpm install` after the generator completes.
+
+# Functions/Classes
+## `updateTypeScriptConfig(tree: Tree)`
+- This function updates the `tsconfig.base.json` file in the project.
+- It sets the `baseUrl` for path aliases and removes the `emitDeclarationOnly` option if it exists.
+- The updated configuration is then written back to the file.
+
+## `updatePackageJson(tree: Tree)`
+- This function updates the `package.json` file in the project.
+- It initializes the `pnpm` section and the `pnpm.onlyBuiltDependencies` array if they don't exist.
+- It adds a list of required packages to the `pnpm.onlyBuiltDependencies` array if they don't already exist.
+- It adds a `generate:models` script to the `scripts` section.
+- The updated `package.json` file is then written back to the file.
+
+## `removeWorkspacesFromPackageJson(tree: Tree)`
+- This function removes the `workspaces` section from the `package.json` file if it exists.
+
+## `apiSetupGenerator(tree: Tree): Promise<GeneratorCallback>`
+- This is the main generator function that orchestrates the entire setup process.
+- It calls the `addDependenciesToPackageJson` function to add the necessary dependencies to the `package.json` file.
+- It calls the `updateTypeScriptConfig`, `updatePackageJson`, and `removeWorkspacesFromPackageJson` functions to update the respective configuration files.
+- Finally, it returns a callback function that will run `pnpm install` after the generator completes.
+
+# Behavior Flow
+1. The `apiSetupGenerator` function is called with a `Tree` object, which represents the file system of the project.
+2. The function adds the necessary dependencies to the `package.json` file using the `addDependenciesToPackageJson` function.
+3. The `updateTypeScriptConfig` function is called to update the `tsconfig.base.json` file.
+4. The `updatePackageJson` function is called to update the `package.json` file with the `pnpm` settings and the `generate:models` script.
+5. The `removeWorkspacesFromPackageJson` function is called to remove the `workspaces` section from the `package.json` file if it exists.
+6. The generator function returns a callback that will run `pnpm install` after the generator completes.
+
+# Key Points
+- This generator is designed to set up a NestJS-based API project with various dependencies and configurations.
+- It ensures that the necessary TypeScript and package.json configurations are in place for the project to function correctly.
+- The generator relies on the `@nx/devkit` library to perform file system operations and update configuration files.
+- The `pnpm.onlyBuiltDependencies` array is used to specify the packages that should be built from source, which can improve build performance.
+- The `generate:models` script is added to the `package.json` file to provide a convenient way to generate GraphQL models.
+- The removal of the `workspaces` section from the `package.json` file is necessary to ensure compatibility with the `pnpm` package manager.

package/src/setup/generator.spec.ts

@@ -0,0 +1,18 @@
+import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing'
+import { Tree } from '@nx/devkit'
+import { apiSetupGenerator } from './generator'
+
+describe('api-dependencies generator', () => {
+  let tree: Tree
+
+  beforeEach(() => {
+    tree = createTreeWithEmptyWorkspace()
+  })
+
+  it('should add required dependencies to package.json', async () => {
+    await apiSetupGenerator(tree)
+    // Note: We can't easily test package.json modifications in the tree
+    // since addDependenciesToPackageJson is mocked in tests
+    expect(tree).toBeDefined()
+  })
+})

package/src/setup/generator.ts

@@ -0,0 +1,106 @@
+import { addDependenciesToPackageJson, GeneratorCallback, Tree } from '@nx/devkit'
+import { pnpmInstallCallback, updatePnpmWorkspaceConfig } from '@nestledjs/utils'
+
+function ensureNpmrc(tree: Tree) {
+  const npmrcPath = '.npmrc'
+  const content = 'ignore-workspace-root-check=true\n'
+  tree.write(npmrcPath, content)
+}
+
+export async function apiSetupGenerator(tree: Tree): Promise<GeneratorCallback> {
+  // Add dependencies
+  addDependenciesToPackageJson(
+    tree,
+    {
+      '@nestjs/apollo': '^13.1.0',
+      '@nestjs/axios': '^4.0.0',
+      '@nestjs/common': '^11.1.3',
+      '@nestjs/config': '^4.0.2',
+      '@nestjs/core': '^11.1.3',
+      '@nestjs/graphql': '^13.1.0',
+      '@nestjs/jwt': '^11.0.0',
+      '@nestjs/passport': '^11.0.5',
+      '@nestjs/platform-express': '^11.1.3',
+      '@paljs/plugins': '^8.2.0',
+      axios: '^1.9.0',
+      bcryptjs: '^3.0.2',
+      express: '^5.1.0',
+      graphql: '^16.11.0',
+      'graphql-query-complexity': '1.1.0',
+      'graphql-scalars': '^1.24.2',
+      'graphql-subscriptions': '^3.0.0',
+      'graphql-ws': '^6.0.5',
+      joi: '^17.13.3',
+      nodemailer: '^7.0.3',
+      'reflect-metadata': '^0.2.2',
+      rxjs: '^7.8.2',
+      'type-graphql': '^2.0.0-rc.2',
+      'graphql-fields': '^2.0.3',
+      'class-validator': '^0.14.0',
+      'class-transformer': '^0.5.1',
+      'graphql-redis-subscriptions': '^2.7.0',
+      ioredis: '^5.6.1',
+      'cookie-parser': '^1.4.7',
+      'passport-jwt': '^4.0.1',
+    },
+    {
+      nx: '21.2.0',
+      '@nx/js': '21.2.0',
+      '@nx/nest': '21.2.0',
+      '@nx/node': '21.2.0',
+      '@nx/webpack': '21.2.0',
+      '@nestjs/schematics': '^11.0.5',
+      '@nestjs/testing': '^11.1.3',
+      '@prisma/extension-optimize': '2.0.0',
+      '@swc-node/register': '~1.10.10',
+      '@swc/cli': '~0.7.7',
+      '@swc/core': '~1.12.1',
+      '@types/cookie-parser': '^1.4.3',
+      '@types/express': '^5.0.3',
+      '@types/nodemailer': '^6.4.7',
+      '@types/passport-jwt': '^4.0.1',
+      '@types/node': '^24.0.1',
+      '@prisma/internals': '^6.9.0',
+      autoprefixer: '10.4.21',
+      jest: '^30.0.0',
+      'jest-environment-node': '^30.0.0',
+      pg: '8.16.0',
+      prisma: '^6.9.0',
+      'ts-node': '10.9.2',
+      yaml: '^2.4.2',
+      'ts-loader': '^9.5.2',
+      'webpack-cli': '^6.0.1',
+      'webpack-node-externals': '^3.0.0',
+      'tsconfig-paths-webpack-plugin': '^4.2.0',
+      'prisma-graphql-type-decimal': '^3.0.1',
+      'graphql-type-json': '^0.3.2',
+    },
+  )
+
+  // Update pnpm-workspace.yaml with build dependencies
+  const packagesToBuild = [
+    '@apollo/protobufjs',
+    '@parcel/watcher',
+    '@prisma/client',
+    '@prisma/extension-optimize',
+    '@prisma/engines',
+    'esbuild',
+    'nx',
+    'prisma',
+    'ioredis',
+    'prisma-graphql-type-decimal',
+    '@nestjs/core',
+    'type-graphql',
+    'express',
+    'unrs-resolver',
+  ]
+  updatePnpmWorkspaceConfig(tree, { onlyBuiltDependencies: packagesToBuild })
+
+  // Ensure .npmrc exists with the required content
+  ensureNpmrc(tree)
+
+  // Return a callback that will run after the generator completes
+  return pnpmInstallCallback()
+}
+
+export default apiSetupGenerator

package/src/setup/schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "id": "api-setup",
+  "type": "object",
+  "properties": {},
+  "required": []
+}

package/src/smtp-mailer/files/data-access/src/index.ts__tmpl__

@@ -0,0 +1,2 @@
+export * from './lib/api-smtp-mailer-data-access.module'
+export * from './lib/api-smtp-mailer-data-access.service'

package/src/smtp-mailer/files/data-access/src/lib/api-smtp-mailer-data-access.module.ts__tmpl__

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common'
+import { SmtpMailerService } from './api-smtp-mailer-data-access.service'
+import { ApiCoreFeatureModule } from '@<%= npmScope %>/api/core/feature'
+
+@Module({
+  imports: [ApiCoreFeatureModule],
+  providers: [SmtpMailerService],
+  exports: [SmtpMailerService],
+})
+export class SmtpMailerModule {}

package/src/smtp-mailer/files/data-access/src/lib/api-smtp-mailer-data-access.service.ts__tmpl__

@@ -0,0 +1,61 @@
+import { Injectable, Logger } from '@nestjs/common'
+import { createTransport, Transporter } from 'nodemailer'
+import { ApiCoreFeatureService } from '@<%= npmScope %>/api/core/feature'
+import { SentMessageInfo } from 'nodemailer/lib/smtp-transport'
+
+export interface SendMailParams {
+  to: string
+  subject: string
+  html: string
+  text: string
+  from?: string
+  appSupportEmail?: string
+}
+
+@Injectable()
+export class SmtpMailerService {
+  private readonly logger = new Logger('ApiMailerService')
+  private readonly mailer: Transporter<SentMessageInfo>
+  private readonly appEmail: string
+  private readonly appName: string
+  private readonly appSupportEmail: string
+
+  constructor(private readonly config: ApiCoreFeatureService) {
+    this.mailer = createTransport({
+      host: this.config.mailerConfig.host,
+      port: parseInt(this.config.mailerConfig.port),
+      auth: {
+        user: this.config.mailerConfig.auth.user,
+        pass: this.config.mailerConfig.auth.pass,
+      },
+    })
+    this.appEmail = this.config.appEmail
+    this.appName = this.config.appName
+    this.appSupportEmail = this.config.appSupportEmail
+  }
+
+  async send(params: SendMailParams) {
+    const {
+      to,
+      subject,
+      html,
+      text,
+      from,
+      appSupportEmail,
+    } = params
+
+    const sender = from || `${this.appName} <${this.appEmail}>`
+    const supportEmail = appSupportEmail || this.appSupportEmail
+
+    const res = await this.mailer.sendMail({
+      to,
+      from: sender,
+      subject,
+      html,
+      text,
+      replyTo: supportEmail,
+    })
+    this.logger.verbose(`sendMail to ${to} result: ${res.response} ${res.messageId}`)
+    return res
+  }
+}

package/src/smtp-mailer/generator.spec.ts

@@ -0,0 +1,41 @@
+import { formatFiles, Tree } from '@nx/devkit'
+import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing'
+import { describe, expect, it, vi } from 'vitest'
+import { apiLibraryGenerator } from '@nestledjs/utils'
+import { installPackagesTask } from '@nx/devkit'
+
+import generator from './generator'
+
+vi.mock('@nestledjs/utils', async () => {
+  const actual = await vi.importActual('@nestledjs/utils')
+  return {
+    ...actual,
+    apiLibraryGenerator: vi.fn(),
+  }
+})
+
+vi.mock('@nx/devkit', async () => {
+  const actual = await vi.importActual('@nx/devkit')
+  return {
+    ...actual,
+    formatFiles: vi.fn(),
+    installPackagesTask: vi.fn(),
+  }
+})
+
+describe('mailer generator', () => {
+  let tree: Tree
+
+  beforeEach(() => {
+    tree = createTreeWithEmptyWorkspace()
+  })
+
+  it('should run successfully', async () => {
+    const callback = await generator(tree)
+    callback()
+
+    expect(apiLibraryGenerator).toHaveBeenCalledWith(tree, { name: 'smtp-mailer' }, expect.any(String), 'data-access')
+    expect(formatFiles).toHaveBeenCalledWith(tree)
+    expect(installPackagesTask).toHaveBeenCalledWith(tree)
+  })
+})

package/src/smtp-mailer/generator.ts

@@ -0,0 +1,14 @@
+import { formatFiles, GeneratorCallback, installPackagesTask, joinPathFragments, Tree } from '@nx/devkit'
+import { apiLibraryGenerator } from '@nestledjs/utils'
+
+export default async function generateLibraries(tree: Tree): Promise<GeneratorCallback> {
+  const templateRootPath = joinPathFragments(__dirname, './files')
+
+  await apiLibraryGenerator(tree, { name: 'smtp-mailer' }, templateRootPath, 'data-access')
+
+  await formatFiles(tree)
+
+  return () => {
+    installPackagesTask(tree)
+  }
+}

package/src/smtp-mailer/schema.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "ApiSMTPMailer",
+  "title": "Create an API Mailer Library",
+  "type": "object",
+  "properties": {}
+}

package/src/user/files/data-access/src/index.ts__tmpl__

@@ -0,0 +1,5 @@
+export * from './lib/api-user-data-access.module'
+export * from './lib/api-user-data-access.module'
+export * from './lib/api-user-data-access.service'
+export * from './lib/dto/admin-create-user.input'
+export * from './lib/dto/admin-update-user.input'

package/src/user/files/data-access/src/lib/api-user-data-access.module.ts__tmpl__

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common'
+import { ApiCoreDataAccessModule } from '@<%= npmScope %>/api/core/data-access'
+import { ApiUserDataAccessService } from './api-user-data-access.service'
+
+@Module({
+  imports: [ApiCoreDataAccessModule],
+  providers: [ApiUserDataAccessService],
+  exports: [ApiUserDataAccessService],
+})
+export class ApiUserDataAccessModule {}