create-forgeon 0.3.6 → 0.3.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-forgeon",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "description": "Forgeon project generator CLI",
   "license": "MIT",
   "author": "Forgeon",

package/src/modules/executor.test.mjs

@@ -324,6 +324,11 @@ function assertFilesAccessWiring(projectRoot) {
   const apiPackage = fs.readFileSync(path.join(projectRoot, 'apps', 'api', 'package.json'), 'utf8');
   assert.match(apiPackage, /@forgeon\/files-access/);
   assert.match(apiPackage, /pnpm --filter @forgeon\/files-access build/);
+  assert.equal(
+    apiPackage.indexOf('pnpm --filter @forgeon/files-access build') <
+      apiPackage.indexOf('pnpm --filter @forgeon/files build'),
+    true,
+  );
 
   const filesPackage = fs.readFileSync(path.join(projectRoot, 'packages', 'files', 'package.json'), 'utf8');
   assert.match(filesPackage, /@forgeon\/files-access/);
@@ -335,6 +340,11 @@ function assertFilesAccessWiring(projectRoot) {
   );
   assert.match(apiDockerfile, /COPY packages\/files-access packages\/files-access/);
   assert.match(apiDockerfile, /RUN pnpm --filter @forgeon\/files-access build/);
+  assert.equal(
+    apiDockerfile.indexOf('RUN pnpm --filter @forgeon/files-access build') <
+      apiDockerfile.indexOf('RUN pnpm --filter @forgeon/files build'),
+    true,
+  );
 
   const filesController = fs.readFileSync(
     path.join(projectRoot, 'packages', 'files', 'src', 'files.controller.ts'),
@@ -373,6 +383,14 @@ function assertFilesQuotasWiring(projectRoot) {
   const apiPackage = fs.readFileSync(path.join(projectRoot, 'apps', 'api', 'package.json'), 'utf8');
   assert.match(apiPackage, /@forgeon\/files-quotas/);
   assert.match(apiPackage, /pnpm --filter @forgeon\/files-quotas build/);
+  assert.equal(
+    apiPackage.indexOf('pnpm --filter @forgeon/files-quotas build') <
+      apiPackage.indexOf('pnpm --filter @forgeon/files build'),
+    true,
+  );
+
+  const filesPackage = fs.readFileSync(path.join(projectRoot, 'packages', 'files', 'package.json'), 'utf8');
+  assert.match(filesPackage, /@forgeon\/files-quotas/);
 
   const apiDockerfile = fs.readFileSync(path.join(projectRoot, 'apps', 'api', 'Dockerfile'), 'utf8');
   assert.match(
@@ -381,6 +399,11 @@ function assertFilesQuotasWiring(projectRoot) {
   );
   assert.match(apiDockerfile, /COPY packages\/files-quotas packages\/files-quotas/);
   assert.match(apiDockerfile, /RUN pnpm --filter @forgeon\/files-quotas build/);
+  assert.equal(
+    apiDockerfile.indexOf('RUN pnpm --filter @forgeon/files-quotas build') <
+      apiDockerfile.indexOf('RUN pnpm --filter @forgeon/files build'),
+    true,
+  );
 
   const filesController = fs.readFileSync(
     path.join(projectRoot, 'packages', 'files', 'src', 'files.controller.ts'),
@@ -421,6 +444,11 @@ function assertFilesImageWiring(projectRoot) {
   const apiPackage = fs.readFileSync(path.join(projectRoot, 'apps', 'api', 'package.json'), 'utf8');
   assert.match(apiPackage, /@forgeon\/files-image/);
   assert.match(apiPackage, /pnpm --filter @forgeon\/files-image build/);
+  assert.equal(
+    apiPackage.indexOf('pnpm --filter @forgeon/files-image build') <
+      apiPackage.indexOf('pnpm --filter @forgeon/files build'),
+    true,
+  );
 
   const filesPackage = fs.readFileSync(path.join(projectRoot, 'packages', 'files', 'package.json'), 'utf8');
   assert.match(filesPackage, /@forgeon\/files-image/);
@@ -457,6 +485,11 @@ function assertFilesImageWiring(projectRoot) {
   );
   assert.match(apiDockerfile, /COPY packages\/files-image packages\/files-image/);
   assert.match(apiDockerfile, /RUN pnpm --filter @forgeon\/files-image build/);
+  assert.equal(
+    apiDockerfile.indexOf('RUN pnpm --filter @forgeon/files-image build') <
+      apiDockerfile.indexOf('RUN pnpm --filter @forgeon/files build'),
+    true,
+  );
 
   const healthController = fs.readFileSync(
     path.join(projectRoot, 'apps', 'api', 'src', 'health', 'health.controller.ts'),

package/src/modules/files-access.mjs

@@ -2,6 +2,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { copyRecursive, writeJson } from '../utils/fs.mjs';
 import {
+  ensureBuildStepBefore,
   ensureBuildSteps,
   ensureClassMember,
   ensureDependency,
@@ -29,6 +30,12 @@ function patchApiPackage(targetRoot) {
   const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
   ensureDependency(packageJson, '@forgeon/files-access', 'workspace:*');
   ensureBuildSteps(packageJson, 'predev', ['pnpm --filter @forgeon/files-access build']);
+  ensureBuildStepBefore(
+    packageJson,
+    'predev',
+    'pnpm --filter @forgeon/files-access build',
+    'pnpm --filter @forgeon/files build',
+  );
   writeJson(packagePath, packageJson);
 }
 
@@ -373,9 +380,11 @@ function patchApiDockerfile(targetRoot) {
   content = ensureLineAfter(content, sourceAnchor, 'COPY packages/files-access packages/files-access');
 
   content = content.replace(/^RUN pnpm --filter @forgeon\/files-access build\r?\n?/gm, '');
-  const buildAnchor = content.includes('RUN pnpm --filter @forgeon/api prisma:generate')
-    ? 'RUN pnpm --filter @forgeon/api prisma:generate'
-    : 'RUN pnpm --filter @forgeon/api build';
+  const buildAnchor = content.includes('RUN pnpm --filter @forgeon/files build')
+    ? 'RUN pnpm --filter @forgeon/files build'
+    : content.includes('RUN pnpm --filter @forgeon/api prisma:generate')
+      ? 'RUN pnpm --filter @forgeon/api prisma:generate'
+      : 'RUN pnpm --filter @forgeon/api build';
   content = ensureLineBefore(content, buildAnchor, 'RUN pnpm --filter @forgeon/files-access build');
 
   fs.writeFileSync(dockerfilePath, `${content.trimEnd()}\n`, 'utf8');

package/src/modules/files-image.mjs

@@ -2,6 +2,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { copyRecursive, writeJson } from '../utils/fs.mjs';
 import {
+  ensureBuildStepBefore,
   ensureBuildSteps,
   ensureClassMember,
   ensureDependency,
@@ -32,6 +33,12 @@ function patchApiPackage(targetRoot) {
   const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
   ensureDependency(packageJson, '@forgeon/files-image', 'workspace:*');
   ensureBuildSteps(packageJson, 'predev', ['pnpm --filter @forgeon/files-image build']);
+  ensureBuildStepBefore(
+    packageJson,
+    'predev',
+    'pnpm --filter @forgeon/files-image build',
+    'pnpm --filter @forgeon/files build',
+  );
   writeJson(packagePath, packageJson);
 }
 
@@ -402,9 +409,11 @@ function patchApiDockerfile(targetRoot) {
   content = ensureLineAfter(content, sourceAnchor, 'COPY packages/files-image packages/files-image');
 
   content = content.replace(/^RUN pnpm --filter @forgeon\/files-image build\r?\n?/gm, '');
-  const buildAnchor = content.includes('RUN pnpm --filter @forgeon/api prisma:generate')
-    ? 'RUN pnpm --filter @forgeon/api prisma:generate'
-    : 'RUN pnpm --filter @forgeon/api build';
+  const buildAnchor = content.includes('RUN pnpm --filter @forgeon/files build')
+    ? 'RUN pnpm --filter @forgeon/files build'
+    : content.includes('RUN pnpm --filter @forgeon/api prisma:generate')
+      ? 'RUN pnpm --filter @forgeon/api prisma:generate'
+      : 'RUN pnpm --filter @forgeon/api build';
   content = ensureLineBefore(content, buildAnchor, 'RUN pnpm --filter @forgeon/files-image build');
 
   fs.writeFileSync(dockerfilePath, `${content.trimEnd()}\n`, 'utf8');

package/src/modules/files-quotas.mjs

@@ -2,6 +2,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { copyRecursive, writeJson } from '../utils/fs.mjs';
 import {
+  ensureBuildStepBefore,
   ensureBuildSteps,
   ensureClassMember,
   ensureDependency,
@@ -32,6 +33,23 @@ function patchApiPackage(targetRoot) {
   const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
   ensureDependency(packageJson, '@forgeon/files-quotas', 'workspace:*');
   ensureBuildSteps(packageJson, 'predev', ['pnpm --filter @forgeon/files-quotas build']);
+  ensureBuildStepBefore(
+    packageJson,
+    'predev',
+    'pnpm --filter @forgeon/files-quotas build',
+    'pnpm --filter @forgeon/files build',
+  );
+  writeJson(packagePath, packageJson);
+}
+
+function patchFilesPackage(targetRoot) {
+  const packagePath = path.join(targetRoot, 'packages', 'files', 'package.json');
+  if (!fs.existsSync(packagePath)) {
+    return;
+  }
+
+  const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
+  ensureDependency(packageJson, '@forgeon/files-quotas', 'workspace:*');
   writeJson(packagePath, packageJson);
 }
 
@@ -280,9 +298,11 @@ function patchApiDockerfile(targetRoot) {
   content = ensureLineAfter(content, sourceAnchor, 'COPY packages/files-quotas packages/files-quotas');
 
   content = content.replace(/^RUN pnpm --filter @forgeon\/files-quotas build\r?\n?/gm, '');
-  const buildAnchor = content.includes('RUN pnpm --filter @forgeon/api prisma:generate')
-    ? 'RUN pnpm --filter @forgeon/api prisma:generate'
-    : 'RUN pnpm --filter @forgeon/api build';
+  const buildAnchor = content.includes('RUN pnpm --filter @forgeon/files build')
+    ? 'RUN pnpm --filter @forgeon/files build'
+    : content.includes('RUN pnpm --filter @forgeon/api prisma:generate')
+      ? 'RUN pnpm --filter @forgeon/api prisma:generate'
+      : 'RUN pnpm --filter @forgeon/api build';
   content = ensureLineBefore(content, buildAnchor, 'RUN pnpm --filter @forgeon/files-quotas build');
 
   fs.writeFileSync(dockerfilePath, `${content.trimEnd()}\n`, 'utf8');
@@ -360,6 +380,7 @@ Key env:
 export function applyFilesQuotasModule({ packageRoot, targetRoot }) {
   copyFromPreset(packageRoot, targetRoot, path.join('packages', 'files-quotas'));
   patchApiPackage(targetRoot);
+  patchFilesPackage(targetRoot);
   patchAppModule(targetRoot);
   patchFilesController(targetRoot);
   patchHealthController(targetRoot);

package/src/modules/shared/patch-utils.mjs

@@ -46,6 +46,31 @@ export function ensureBuildSteps(packageJson, scriptName, requiredCommands) {
   }
 }
 
+export function ensureBuildStepBefore(packageJson, scriptName, command, beforeCommand) {
+  if (!packageJson.scripts) {
+    packageJson.scripts = {};
+  }
+
+  const current = packageJson.scripts[scriptName];
+  const steps =
+    typeof current === 'string' && current.trim().length > 0
+      ? current
+          .split('&&')
+          .map((item) => item.trim())
+          .filter(Boolean)
+      : [];
+
+  const withoutCommand = steps.filter((item) => item !== command);
+  const beforeIndex = withoutCommand.indexOf(beforeCommand);
+  if (beforeIndex >= 0) {
+    withoutCommand.splice(beforeIndex, 0, command);
+  } else {
+    withoutCommand.push(command);
+  }
+
+  packageJson.scripts[scriptName] = withoutCommand.join(' && ');
+}
+
 export function ensureLineAfter(content, anchorLine, lineToInsert) {
   if (content.includes(lineToInsert)) {
     return content;

package/templates/module-presets/files/packages/files/src/files.controller.ts

@@ -12,6 +12,7 @@ import {
   UseInterceptors,
 } from '@nestjs/common';
 import { FileInterceptor } from '@nestjs/platform-express';
+import { Readable } from 'node:stream';
 import { CreateFileDto } from './dto/create-file.dto';
 import { FilesService } from './files.service';
 import type { FileVariantKey } from './files.types';
@@ -58,7 +59,7 @@ export class FilesController {
   async download(@Param('publicId') publicId: string, @Query('variant') variantQuery?: string) {
     const variant = this.parseVariant(variantQuery);
     const payload = await this.filesService.openDownload(publicId, variant);
-    return new StreamableFile(payload.stream, {
+    return new StreamableFile(payload.stream as Readable, {
       disposition: `inline; filename="${payload.fileName}"`,
       type: payload.mimeType,
     });

package/templates/module-presets/files/packages/files/src/files.service.ts

@@ -15,6 +15,17 @@ import { PrismaService } from '@forgeon/db-prisma';
 import { FilesConfigService } from './files-config.service';
 import type { FileRecordDto, FileVariantKey, StoredFileInput } from './files.types';
 
+type S3ModuleLike = {
+  S3Client: new (config: Record<string, unknown>) => {
+    send: (command: unknown) => Promise<{
+      Body?: unknown;
+    }>;
+  };
+  PutObjectCommand: new (input: Record<string, unknown>) => unknown;
+  GetObjectCommand: new (input: Record<string, unknown>) => unknown;
+  DeleteObjectCommand: new (input: Record<string, unknown>) => unknown;
+};
+
 type BlobRef = {
   id: string;
   hash: string;
@@ -225,7 +236,7 @@ export class FilesService {
   }
 
   async openDownload(publicId: string, variant: FileVariantKey = 'original'): Promise<{
-    stream: NodeJS.ReadableStream;
+    stream: Readable;
     mimeType: string;
     fileName: string;
   }> {
@@ -439,7 +450,7 @@ export class FilesService {
   }
 
   private async storeS3(buffer: Buffer, storageKey: string): Promise<{ storageKey: string }> {
-    const { PutObjectCommand } = await import('@aws-sdk/client-s3');
+    const { PutObjectCommand } = await this.loadS3Module();
     const client = await this.getS3Client();
     const config = this.resolveS3Config();
 
@@ -454,8 +465,8 @@ export class FilesService {
     return { storageKey };
   }
 
-  private async openS3(storageKey: string): Promise<NodeJS.ReadableStream> {
-    const { GetObjectCommand } = await import('@aws-sdk/client-s3');
+  private async openS3(storageKey: string): Promise<Readable> {
+    const { GetObjectCommand } = await this.loadS3Module();
     const client = await this.getS3Client();
     const config = this.resolveS3Config();
 
@@ -473,7 +484,7 @@ export class FilesService {
   }
 
   private async deleteS3(storageKey: string): Promise<void> {
-    const { DeleteObjectCommand } = await import('@aws-sdk/client-s3');
+    const { DeleteObjectCommand } = await this.loadS3Module();
     const client = await this.getS3Client();
     const config = this.resolveS3Config();
     await client.send(
@@ -566,7 +577,7 @@ export class FilesService {
     if (this.s3Client) {
       return this.s3Client;
     }
-    const { S3Client } = await import('@aws-sdk/client-s3');
+    const { S3Client } = await this.loadS3Module();
     const config = this.resolveS3Config();
     this.s3Client = new S3Client({
       region: config.region,
@@ -581,7 +592,7 @@ export class FilesService {
     return this.s3Client;
   }
 
-  private toNodeReadable(body: unknown): NodeJS.ReadableStream {
+  private toNodeReadable(body: unknown): Readable {
     if (body instanceof Readable) {
       return body;
     }
@@ -594,12 +605,19 @@ export class FilesService {
       typeof (body as { transformToWebStream?: unknown }).transformToWebStream === 'function'
     ) {
       return Readable.fromWeb(
-        (body as { transformToWebStream: () => ReadableStream<Uint8Array> }).transformToWebStream(),
+        (body as { transformToWebStream: () => unknown }).transformToWebStream() as never,
       );
     }
     throw new InternalServerErrorException('Unsupported S3 response body type');
   }
 
+  private async loadS3Module(): Promise<S3ModuleLike> {
+    const importModule = new Function('specifier', 'return import(specifier)') as (
+      specifier: string,
+    ) => Promise<S3ModuleLike>;
+    return importModule('@aws-sdk/client-s3');
+  }
+
   private generatePublicId(): string {
     return crypto.randomUUID().replace(/-/g, '');
   }