@nestledjs/api 0.0.1

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

@@ -0,0 +1,119 @@
+import { Injectable } from '@nestjs/common'
+import { ApiCoreDataAccessService, CorePaging, CorePagingInput } from '@<%= npmScope %>/api/core/data-access'
+import { getGravatarUrl, hashPassword, uniqueSuffix } from '@<%= npmScope %>/api/auth/data-access'
+import { UserRole } from '@<%= npmScope %>/api/core/data-access';
+import { AdminCreateUserInput } from './dto/admin-create-user.input'
+import { AdminUpdateUserInput } from './dto/admin-update-user.input'
+
+
+@Injectable()
+export class ApiUserDataAccessService {
+  constructor(private readonly data: ApiCoreDataAccessService) {}
+
+  async adminUsers(userId: string, paging?: CorePagingInput) {
+    await this.data.ensureAdminUser(userId);
+    return this.data.user.findMany({
+      take: paging?.take ?? 20,
+      skip: paging?.skip ?? 0,
+      include: { emails: true },
+    });
+  }
+
+  async adminCountUsers(
+    adminId: string,
+    paging?: CorePagingInput
+  ): Promise<CorePaging> {
+    await this.data.ensureAdminUser(adminId);
+    const total = await this.data.user.count();
+    return {
+      take: paging?.take ?? 20,
+      skip: paging?.skip ?? 0,
+      total,
+    };
+  }
+
+  async adminUser(adminId: string, userId: string) {
+    await this.data.ensureAdminUser(adminId);
+    return this.data.user.findUnique({
+      where: { id: userId },
+      include: { emails: true },
+    });
+  }
+
+  async adminCreateUser(adminId: string, input: AdminCreateUserInput) {
+    await this.data.ensureAdminUser(adminId);
+    const email = input?.email?.trim();
+    if (!email) {
+      throw new Error('Email is required to create a user.');
+    }
+    const displayName =
+      input.displayName ||
+      `${input.firstName} ${input.lastName}`.trim() ||
+      email;
+
+    return this.data.user.create({
+      data: {
+        emails: { create: { email, primary: true } },
+        role: input.role ?? UserRole.USER,
+        firstName: input.firstName,
+        lastName: input.lastName,
+        displayName,
+      },
+      include: { emails: true },
+    });
+  }
+
+  async adminUpdateUser(
+    adminId: string,
+    userId: string,
+    input: AdminUpdateUserInput
+  ) {
+    await this.data.ensureAdminUser(adminId);
+    return this.data.user.update({
+      where: { id: userId },
+      data: { ...input },
+      include: { emails: true },
+    });
+  }
+
+  async adminSetUserPassword(
+    adminId: string,
+    userId: string,
+    password: string
+  ) {
+    await this.data.ensureAdminUser(adminId);
+    return this.data.user.update({
+      where: { id: userId },
+      data: { password: hashPassword(password) },
+    });
+  }
+
+  async adminDeleteUser(adminId: string, userId: string) {
+    await this.data.ensureAdminUser(adminId);
+    return this.data.user.delete({ where: { id: userId } });
+  }
+
+  private formatdisplayName(email: string, displayName?: string): string {
+    return displayName?.trim() || uniqueSuffix(email.trim().split('@')[0]);
+  }
+
+  private async ensuredisplayNameAvailable(
+    displayName: string
+  ): Promise<boolean> {
+    const user = await this.data.findUserByDisplayName(displayName);
+    if (user) {
+      throw new Error(`This displayName is not available`);
+    }
+    return true;
+  }
+
+  private async ensureDisplayNameAvailable(
+    displayName: string
+  ): Promise<boolean> {
+    const user = await this.data.findUserByDisplayName(displayName);
+    if (user) {
+      throw new Error(`This display name is not available`);
+    }
+    return true;
+  }
+}

package/src/user/files/data-access/src/lib/dto/admin-create-user.input.ts__tmpl__

@@ -0,0 +1,20 @@
+import { Field, InputType } from '@nestjs/graphql'
+import { UserRole } from '@<%= npmScope %>/api/core/data-access'
+
+@InputType()
+export class AdminCreateUserInput {
+  @Field(() => UserRole, { nullable: true })
+  role?: UserRole
+
+  @Field({ nullable: true })
+  email?: string
+
+  @Field({ nullable: true })
+  displayName?: string
+
+  @Field({ nullable: true })
+  firstName?: string
+
+  @Field({ nullable: true })
+  lastName?: string
+}

package/src/user/files/data-access/src/lib/dto/admin-update-user.input.ts__tmpl__

@@ -0,0 +1,29 @@
+import { Field, InputType } from '@nestjs/graphql'
+import { UserRole } from '@<%= npmScope %>/api/core/data-access'
+
+@InputType()
+export class AdminUpdateUserInput {
+  @Field(() => UserRole, { nullable: true })
+  role?: UserRole
+
+  @Field({ nullable: true })
+  displayName?: string
+
+  @Field({ nullable: true })
+  firstName?: string
+
+  @Field({ nullable: true })
+  lastName?: string
+
+  @Field({ nullable: true })
+  phone?: string
+
+  @Field({ nullable: true })
+  avatarUrl?: string
+
+  @Field({ nullable: true })
+  location?: string
+
+  @Field({ nullable: true })
+  bio?: string
+}

package/src/user/files/feature/src/index.ts__tmpl__

@@ -0,0 +1 @@
+export * from './lib/api-user-feature.module'

package/src/user/files/feature/src/lib/api-user-feature-admin.resolver.ts__tmpl__

@@ -0,0 +1,57 @@
+import { Args, Mutation, Query, Resolver } from '@nestjs/graphql'
+import { UseGuards } from '@nestjs/common'
+import { CorePaging, CorePagingInput } from '@<%= npmScope %>/api/core/data-access'
+import { User } from '@<%= npmScope %>/api/core/models'
+import { CtxUser, GqlAuthAdminGuard } from '@<%= npmScope %>/api/custom'
+import {
+  AdminCreateUserInput,
+  AdminUpdateUserInput,
+  ApiUserDataAccessService,
+} from '@<%= npmScope %>/api/user/data-access'
+
+@Resolver()
+@UseGuards(GqlAuthAdminGuard)
+export class ApiUserFeatureAdminResolver {
+  constructor(private readonly service: ApiUserDataAccessService) {}
+
+  @Query(() => [User], { nullable: true })
+  adminUsers(
+    @CtxUser() admin: User,
+    @Args({ name: 'paging', type: () => CorePagingInput, nullable: true }) paging?: CorePagingInput,
+  ) {
+    return this.service.adminUsers(admin.id, paging)
+  }
+
+  @Query(() => CorePaging, { nullable: true })
+  adminCountUsers(
+    @CtxUser() admin: User,
+    @Args({ name: 'paging', type: () => CorePagingInput, nullable: true }) paging?: CorePagingInput,
+  ) {
+    return this.service.adminCountUsers(admin.id, paging)
+  }
+
+  @Query(() => User, { nullable: true })
+  adminUser(@CtxUser() admin: User, @Args('userId') userId: string) {
+    return this.service.adminUser(admin.id, userId)
+  }
+
+  @Mutation(() => User, { nullable: true })
+  adminCreateUser(@CtxUser() admin: User, @Args('input') input: AdminCreateUserInput) {
+    return this.service.adminCreateUser(admin.id, input)
+  }
+
+  @Mutation(() => User, { nullable: true })
+  adminUpdateUser(@CtxUser() admin: User, @Args('userId') userId: string, @Args('input') input: AdminUpdateUserInput) {
+    return this.service.adminUpdateUser(admin.id, userId, input)
+  }
+
+  @Mutation(() => User, { nullable: true })
+  adminSetUserPassword(@CtxUser() admin: User, @Args('userId') userId: string, @Args('password') password: string) {
+    return this.service.adminSetUserPassword(admin.id, userId, password)
+  }
+
+  @Mutation(() => User, { nullable: true })
+  adminDeleteUser(@CtxUser() admin: User, @Args('userId') userId: string) {
+    return this.service.adminDeleteUser(admin.id, userId)
+  }
+}

package/src/user/files/feature/src/lib/api-user-feature.module.ts__tmpl__

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common'
+import { ApiUserDataAccessModule } from '@<%= npmScope %>/api/user/data-access'
+import { ApiUserFeatureAdminResolver } from './api-user-feature-admin.resolver'
+import { ApiUserFeatureResolver } from './api-user-feature.resolver'
+
+@Module({
+  imports: [ApiUserDataAccessModule],
+  providers: [ApiUserFeatureResolver, ApiUserFeatureAdminResolver],
+})
+export class ApiUserFeatureModule {}

package/src/user/files/feature/src/lib/api-user-feature.resolver.ts__tmpl__

@@ -0,0 +1,17 @@
+import { Parent, ResolveField, Resolver } from '@nestjs/graphql'
+import { User } from '@<%= npmScope %>/api/core/models'
+
+@Resolver(() => User)
+export class ApiUserFeatureResolver {
+  @ResolveField(() => String, { nullable: true })
+  name(@Parent() user: User) {
+    const name = [user?.firstName, user?.lastName].join(' ').trim()
+    return name.length ? name : user?.displayName
+  }
+
+  @ResolveField(() => String, { nullable: true })
+  email(@Parent() user: User) {
+    const hasPrimary = user.emails?.find((email) => email.primary)
+    return hasPrimary?.email ?? user?.emails?.find((e) => e)?.email
+  }
+}

package/src/user/generator.spec.ts

@@ -0,0 +1,41 @@
+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('user generator', () => {
+  let tree: Tree
+
+  beforeEach(() => {
+    tree = createTreeWithEmptyWorkspace()
+  })
+
+  it('should run successfully', async () => {
+    const callback = await generator(tree)
+    callback()
+
+    expect(apiLibraryGenerator).toHaveBeenCalledWith(tree, { name: 'user' }, expect.any(String), 'data-access')
+    expect(apiLibraryGenerator).toHaveBeenCalledWith(tree, { name: 'user' }, expect.any(String), 'feature', true)
+    expect(formatFiles).toHaveBeenCalledWith(tree)
+    expect(installPackagesTask).toHaveBeenCalledWith(tree)
+  })
+})

package/src/user/generator.ts

@@ -0,0 +1,15 @@
+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: 'user' }, templateRootPath, 'data-access')
+  await apiLibraryGenerator(tree, { name: 'user' }, templateRootPath, 'feature', true)
+
+  await formatFiles(tree)
+
+  return () => {
+    installPackagesTask(tree)
+  }
+}

package/src/user/schema.json

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

package/src/utils/files/src/index.ts__tmpl__

@@ -0,0 +1,3 @@
+export * from './lib/guards/gql-auth.guard'
+export * from './lib/guards/gql-auth-admin.guard'
+export * from './lib/decorators/ctx-user.decorator'

package/src/utils/files/src/lib/decorators/ctx-user.decorator.ts__tmpl__

@@ -0,0 +1,6 @@
+import { createParamDecorator } from '@nestjs/common'
+import { GqlExecutionContext } from '@nestjs/graphql'
+
+export const CtxUser = createParamDecorator(
+  (data, ctx) => GqlExecutionContext.create(ctx).getContext().req.user,
+)

package/src/utils/files/src/lib/guards/gql-auth-admin.guard.ts__tmpl__

@@ -0,0 +1,39 @@
+import { ExecutionContext, ForbiddenException, Injectable } from '@nestjs/common'
+import { GqlExecutionContext } from '@nestjs/graphql'
+import { AuthGuard } from '@nestjs/passport'
+import { User } from '@<%= npmScope %>/api/core/models'
+
+@Injectable()
+export class GqlAuthAdminGuard extends AuthGuard('jwt') {
+  private readonly _roles: string[] = ['Admin']
+
+  override getRequest(context: ExecutionContext) {
+    const ctx = GqlExecutionContext.create(context)
+
+    return ctx.getContext().req
+  }
+
+  constructor() {
+    super()
+  }
+
+  override async canActivate(context: ExecutionContext): Promise<boolean> {
+    await super.canActivate(context)
+    const ctx = GqlExecutionContext.create(context)
+    const req = ctx.getContext().req
+
+    if (!req || !req.user) {
+      return false
+    }
+    const hasAccess = this.hasAccess(req.user)
+
+    if (!hasAccess) {
+      throw new ForbiddenException(`You need to have Admin access`)
+    }
+    return req && req.user && this.hasAccess(req.user)
+  }
+
+  private hasAccess(user: User): boolean {
+    return !!(user.role && this._roles.includes(user.role))
+  }
+}

package/src/utils/files/src/lib/guards/gql-auth.guard.ts__tmpl__

@@ -0,0 +1,11 @@
+import { ExecutionContext, Injectable } from '@nestjs/common'
+import { GqlExecutionContext } from '@nestjs/graphql'
+import { AuthGuard } from '@nestjs/passport'
+
+@Injectable()
+export class GqlAuthGuard extends AuthGuard('jwt') {
+  override getRequest(context: ExecutionContext): Promise<Record<string, unknown>> {
+    const ctx = GqlExecutionContext.create(context)
+    return ctx.getContext().req
+  }
+}

package/src/utils/generator.ts

@@ -0,0 +1,14 @@
+import { formatFiles, joinPathFragments, Tree } from '@nx/devkit'
+import { apiLibraryGenerator, deleteFiles } from '@nestledjs/utils'
+
+export default async function generator(tree: Tree) {
+  const templateRootPath = joinPathFragments(__dirname, './files')
+  const overwrite = false
+
+  await apiLibraryGenerator(tree, { name: 'utils', overwrite }, templateRootPath, '', false)
+
+  // Remove the default module file if it exists
+  deleteFiles(tree, ['libs/api/utils/src/lib/api-utils.module.ts'])
+
+  await formatFiles(tree)
+}

package/src/utils/schema.json

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

package/src/workspace-setup/generator.md

@@ -0,0 +1,39 @@
+# Overview
+This code is a setup script that ensures the necessary environment and dependencies are in place for a project. It performs the following key tasks:
+
+- Loads environment variables from a `.env` file
+- Checks if the `DATABASE_URL` environment variable is set and if it points to a local database
+- Ensures that Docker is running and that the necessary Docker Compose services are up and running
+- Runs Prisma setup commands to generate the Prisma client and schema
+- Generates GraphQL types from the Prisma schema
+- Runs Prisma seed scripts to populate the database with initial data
+
+The script is designed to be run during the project setup process to ensure a consistent and reliable development environment.
+
+# Functions/Classes
+The code imports several helper functions from the `./lib/helpers` module:
+
+- `canConnect(DATABASE_URL)`: Checks if the application can connect to the database at the specified `DATABASE_URL`.
+- `ensureDockerIsRunning()`: Ensures that the Docker daemon is running.
+- `ensureDockerComposeIsRunning()`: Ensures that the required Docker Compose services are running.
+- `ensureDotEnv()`: Ensures that a `.env` file exists in the project directory.
+- `log(message)`: Logs a message to the console.
+- `runPrismaSetup()`: Runs the Prisma setup commands to generate the Prisma client and schema.
+- `runGraphQLTypeGeneration()`: Generates GraphQL types from the Prisma schema.
+- `runPrismaSeed()`: Runs the Prisma seed scripts to populate the database with initial data.
+
+The main function exported by the script is an asynchronous function that orchestrates the setup process.
+
+# Behavior Flow
+1. The script loads the environment variables from the `.env` file.
+2. It checks if the `DATABASE_URL` environment variable is set and if it points to a local database. If not, it throws an error.
+3. The script then checks if the application can connect to the database at the specified `DATABASE_URL`. If not, it ensures that Docker is running and that the necessary Docker Compose services are up and running.
+4. The script then runs the Prisma setup commands to generate the Prisma client and schema.
+5. After a 2-second delay, the script generates the GraphQL types from the Prisma schema.
+6. Finally, the script runs the Prisma seed scripts to populate the database with initial data.
+
+# Key Points
+- The script relies on several environment variables, particularly `DATABASE_URL`, to configure the development environment.
+- It ensures that the necessary Docker and Docker Compose services are running before proceeding with the setup.
+- The script uses Prisma to manage the database schema and seed data, and to generate GraphQL types.
+- The script includes error handling to provide informative error messages if any of the setup steps fail.

package/src/workspace-setup/generator.spec.ts

@@ -0,0 +1,82 @@
+import { vi, describe, it, expect, beforeEach } from 'vitest'
+
+const {
+  canConnect,
+  ensureDockerComposeIsRunning,
+  ensureDockerIsRunning,
+  ensureDotEnv,
+  log,
+  runPrismaSeed,
+  runPrismaSetup,
+  runGraphQLTypeGeneration,
+} = vi.hoisted(() => {
+  return {
+    canConnect: vi.fn(),
+    ensureDockerComposeIsRunning: vi.fn(),
+    ensureDockerIsRunning: vi.fn(),
+    ensureDotEnv: vi.fn(),
+    log: vi.fn(),
+    runPrismaSeed: vi.fn(),
+    runPrismaSetup: vi.fn(),
+    runGraphQLTypeGeneration: vi.fn(),
+  }
+})
+
+vi.mock('./lib/helpers', () => ({
+  canConnect,
+  ensureDockerComposeIsRunning,
+  ensureDockerIsRunning,
+  ensureDotEnv,
+  log,
+  runPrismaSeed,
+  runPrismaSetup,
+  runGraphQLTypeGeneration,
+}))
+
+import generator from './generator'
+
+describe('workspace-setup generator', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+    delete process.env.DATABASE_URL
+  })
+
+  it('should throw an error if DATABASE_URL is not provided', async () => {
+    await expect(generator()).rejects.toThrow('Please provide DATABASE_URL env var')
+  })
+
+  it('should throw an error if DATABASE_URL is not on localhost', async () => {
+    process.env.DATABASE_URL = 'some-remote-db'
+    await expect(generator()).rejects.toThrow("Can't connect to DATABASE_URL if it's not on localhost")
+  })
+
+  it('should run setup without docker if already connected', async () => {
+    process.env.DATABASE_URL = 'localhost:5432'
+    canConnect.mockResolvedValue(true)
+
+    await generator()
+
+    expect(ensureDotEnv).toHaveBeenCalled()
+    expect(canConnect).toHaveBeenCalledWith('localhost:5432')
+    expect(ensureDockerIsRunning).not.toHaveBeenCalled()
+    expect(ensureDockerComposeIsRunning).not.toHaveBeenCalled()
+    expect(runPrismaSetup).toHaveBeenCalled()
+    expect(runGraphQLTypeGeneration).toHaveBeenCalled()
+    expect(runPrismaSeed).toHaveBeenCalled()
+  })
+
+  it('should start docker and run setup if not connected', async () => {
+    process.env.DATABASE_URL = 'localhost:5432'
+    canConnect.mockResolvedValue(false)
+
+    await generator()
+
+    expect(ensureDotEnv).toHaveBeenCalled()
+    expect(canConnect).toHaveBeenCalledWith('localhost:5432')
+    expect(ensureDockerIsRunning).toHaveBeenCalled()
+    expect(ensureDockerComposeIsRunning).toHaveBeenCalled()
+    expect(runPrismaSetup).toHaveBeenCalled()
+    expect(runGraphQLTypeGeneration).toHaveBeenCalled()
+    expect(runPrismaSeed).toHaveBeenCalled()
+  })
+}) 

package/src/workspace-setup/generator.ts

@@ -0,0 +1,49 @@
+require('dotenv').config()
+import {
+  canConnect,
+  ensureDockerComposeIsRunning,
+  ensureDockerIsRunning,
+  ensureDotEnv,
+  log,
+  runPrismaSeed,
+  runPrismaSetup,
+  runGraphQLTypeGeneration,
+} from './lib/helpers'
+
+export default async function () {
+  log('Setting up workspace ')
+
+  ensureDotEnv()
+  require('dotenv').config()
+  
+  const DATABASE_URL = process.env.DATABASE_URL
+
+  if (!DATABASE_URL) {
+    throw new Error(`Please provide DATABASE_URL env var`)
+  }
+
+  if (!DATABASE_URL.includes('localhost')) {
+    throw new Error(`Can't connect to DATABASE_URL if it's not on localhost`)
+  }
+
+  const connected = await canConnect(DATABASE_URL)
+
+  if (!connected) {
+    ensureDockerIsRunning()
+    await ensureDockerComposeIsRunning()
+  }
+
+  try {
+    runPrismaSetup()
+    await new Promise(resolve => setTimeout(resolve, 2000))
+    
+    // Generate GraphQL types from Prisma schema
+    log('Generating GraphQL types from Prisma schema...')
+    runGraphQLTypeGeneration()
+    
+    runPrismaSeed()
+    log('Workspace setup done!')
+  } catch (error) {
+    console.error('Error during workspace setup:', error.message)
+  }
+}