create-forgeon 0.3.19 → 0.3.21

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

@@ -1,102 +1,7 @@
 import { Readable } from 'node:stream';
-import type { FileVariantKey } from './files.types';
 
-export const FILES_PERSISTENCE_PORT = 'FORGEON_FILES_PERSISTENCE_PORT';
 export const FILES_STORAGE_ADAPTER = 'FORGEON_FILES_STORAGE_ADAPTER';
 
-export type FilesBlobRecord = {
-  id: string;
-  hash: string;
-  size: number;
-  mimeType: string;
-  storageDriver: string;
-  storageKey: string;
-};
-
-export type FilesBlobRef = FilesBlobRecord & {
-  created: boolean;
-};
-
-export type FilesRecordVariant = {
-  variantKey: string;
-  blobId: string;
-  mimeType: string;
-  size: number;
-  status: string;
-  blob?: {
-    storageDriver: string;
-    storageKey: string;
-  };
-};
-
-export type FilesRecordAggregate = {
-  id: string;
-  publicId: string;
-  storageKey: string;
-  originalName: string;
-  mimeType: string;
-  size: number;
-  storageDriver: string;
-  ownerType: string;
-  ownerId: string | null;
-  visibility: string;
-  createdById: string | null;
-  createdAt: Date;
-  updatedAt: Date;
-  variants?: FilesRecordVariant[];
-};
-
-export type FilesRecordCreateInput = {
-  publicId: string;
-  storageKey: string;
-  originalName: string;
-  mimeType: string;
-  size: number;
-  storageDriver: string;
-  ownerType: string;
-  ownerId: string | null;
-  visibility: string;
-  createdById: string | null;
-};
-
-export type FilesBlobCreateInput = {
-  hash: string;
-  size: number;
-  mimeType: string;
-  storageDriver: string;
-  storageKey: string;
-};
-
-export type FilesVariantCreateInput = {
-  fileId: string;
-  variantKey: FileVariantKey;
-  blobId: string;
-  mimeType: string;
-  size: number;
-  status: string;
-};
-
-export interface FilesPersistencePort {
-  createFileRecord(data: FilesRecordCreateInput): Promise<{
-    id: string;
-    publicId: string;
-  }>;
-  deleteFileRecordById(id: string): Promise<void>;
-  deleteFileRecordByPublicId(publicId: string): Promise<void>;
-  findFileRecordWithVariantKeys(publicId: string): Promise<FilesRecordAggregate | null>;
-  findFileRecordForDelete(publicId: string): Promise<FilesRecordAggregate | null>;
-  findFileRecordForDownload(publicId: string): Promise<FilesRecordAggregate | null>;
-  countOwnerUsage(ownerType: string, ownerId: string): Promise<{
-    filesCount: number;
-    totalBytes: number;
-  }>;
-  findBlobRef(hash: string, size: number, mimeType: string, storageDriver: string): Promise<FilesBlobRef | null>;
-  createBlob(data: FilesBlobCreateInput): Promise<FilesBlobRecord>;
-  createVariants(data: FilesVariantCreateInput[]): Promise<void>;
-  findBlobById(id: string): Promise<FilesBlobRecord | null>;
-  deleteBlobIfUnreferenced(id: string): Promise<boolean>;
-}
-
 export interface FilesStorageAdapter {
   readonly driver: string;
   put(buffer: Buffer, fileName: string): Promise<{

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

@@ -5,22 +5,15 @@ import {
   BadRequestException,
   Inject,
   Injectable,
-  InternalServerErrorException,
   NotFoundException,
+  Optional,
   ServiceUnavailableException,
 } from '@nestjs/common';
 import { FilesConfigService } from './files-config.service';
-import {
-  FILES_PERSISTENCE_PORT,
-  FILES_STORAGE_ADAPTER,
-} from './files.ports';
-import type {
-  FilesBlobRecord,
-  FilesBlobRef,
-  FilesPersistencePort,
-  FilesRecordAggregate,
-  FilesStorageAdapter,
-} from './files.ports';
+import { FILES_STORAGE_ADAPTER } from './files.ports';
+import type { FilesStorageAdapter } from './files.ports';
+import { FilesStore } from './files.store';
+import type { FilesBlobRef, FilesRecordAggregate } from './files.store';
 import type { FileRecordDto, FileVariantKey, StoredFileInput } from './files.types';
 
 type PrismaLikeError = {
@@ -44,10 +37,8 @@ type PersistedVariant = {
 @Injectable()
 export class FilesService {
   constructor(
-    @Inject(FILES_PERSISTENCE_PORT)
-    private readonly persistence: FilesPersistencePort,
-    @Inject(FILES_STORAGE_ADAPTER)
-    private readonly storageAdapter: FilesStorageAdapter,
+    private readonly filesStore: FilesStore,
+    @Optional() @Inject(FILES_STORAGE_ADAPTER) private readonly storageAdapter: FilesStorageAdapter | undefined,
     private readonly filesConfigService: FilesConfigService,
   ) {}
 
@@ -69,7 +60,7 @@ export class FilesService {
         createdBlobIds.push(originalBlob.id);
       }
 
-      const record = await this.persistence.createFileRecord({
+      const record = await this.filesStore.createFileRecord({
         publicId: this.generatePublicId(),
         storageKey: originalBlob.storageKey,
         originalName: input.originalName,
@@ -110,7 +101,7 @@ export class FilesService {
         persistedVariantBlobIds.push(previewBlob.id);
       }
 
-      await this.persistence.createVariants(
+      await this.filesStore.createVariants(
         persistedVariants.map((item, index) => ({
           fileId: record.id,
           variantKey: item.variantKey,
@@ -124,7 +115,7 @@ export class FilesService {
       return this.getByPublicId(record.publicId);
     } catch (error) {
       if (recordId) {
-        await this.persistence.deleteFileRecordById(recordId).catch(() => undefined);
+        await this.filesStore.deleteFileRecordById(recordId).catch(() => undefined);
       }
       await this.cleanupCreatedBlobs(createdBlobIds);
       throw error;
@@ -144,13 +135,13 @@ export class FilesService {
   }
 
   async deleteByPublicId(publicId: string): Promise<{ deleted: boolean }> {
-    const record = await this.persistence.findFileRecordForDelete(publicId);
+    const record = await this.filesStore.findFileRecordForDelete(publicId);
     if (!record) {
       throw new NotFoundException('File not found');
     }
 
     const blobIds = (record.variants ?? []).map((variant) => variant.blobId);
-    await this.persistence.deleteFileRecordByPublicId(publicId);
+    await this.filesStore.deleteFileRecordByPublicId(publicId);
     await this.cleanupReferencedBlobs(blobIds);
 
     if ((record.variants ?? []).length === 0) {
@@ -161,7 +152,7 @@ export class FilesService {
   }
 
   async getByPublicId(publicId: string): Promise<FileRecordDto> {
-    const record = await this.persistence.findFileRecordWithVariantKeys(publicId);
+    const record = await this.filesStore.findFileRecordWithVariantKeys(publicId);
     if (!record) {
       throw new NotFoundException('File not found');
     }
@@ -169,7 +160,7 @@ export class FilesService {
   }
 
   async getOwnerUsage(ownerType: string, ownerId: string): Promise<{ filesCount: number; totalBytes: number }> {
-    return this.persistence.countOwnerUsage(ownerType, ownerId);
+    return this.filesStore.countOwnerUsage(ownerType, ownerId);
   }
 
   async openDownload(publicId: string, variant: FileVariantKey = 'original'): Promise<{
@@ -177,7 +168,7 @@ export class FilesService {
     mimeType: string;
     fileName: string;
   }> {
-    const record = await this.persistence.findFileRecordForDownload(publicId);
+    const record = await this.filesStore.findFileRecordForDownload(publicId);
     if (!record) {
       throw new NotFoundException('File not found');
     }
@@ -215,6 +206,7 @@ export class FilesService {
     supportedVariants: FileVariantKey[];
     previewGenerationEnabled: boolean;
   }> {
+    this.requireStorageAdapter();
     return {
       status: 'ok',
       feature: 'files-variants',
@@ -250,14 +242,26 @@ export class FilesService {
     }
   }
 
+  private requireStorageAdapter(): FilesStorageAdapter {
+    if (this.storageAdapter) {
+      return this.storageAdapter;
+    }
+
+    throw new ServiceUnavailableException(
+      'Files storage adapter is not configured. Install/add a files-storage-adapter provider.',
+    );
+  }
+
   private async store(buffer: Buffer, originalName: string): Promise<{ storageKey: string }> {
+    const storageAdapter = this.requireStorageAdapter();
     const extension = path.extname(originalName).toLowerCase();
     const fileName = `${Date.now()}-${crypto.randomUUID()}${extension}`;
-    return this.storageAdapter.put(buffer, fileName);
+    return storageAdapter.put(buffer, fileName);
   }
 
   private async getOrCreateBlob(input: PreparedStoredFile, dedupe: boolean): Promise<FilesBlobRef> {
-    const storageDriver = this.storageAdapter.driver;
+    const storageAdapter = this.requireStorageAdapter();
+    const storageDriver = storageAdapter.driver;
     const hash = this.computeContentHash(input.buffer);
 
     if (dedupe) {
@@ -269,7 +273,7 @@ export class FilesService {
 
     const stored = await this.store(input.buffer, input.fileName);
     try {
-      const created = await this.persistence.createBlob({
+      const created = await this.filesStore.createBlob({
         hash,
         size: input.size,
         mimeType: input.mimeType,
@@ -321,21 +325,23 @@ export class FilesService {
   }
 
   private async openStoredContent(storageDriver: string, storageKey: string): Promise<Readable> {
-    if (storageDriver !== this.storageAdapter.driver) {
+    const storageAdapter = this.requireStorageAdapter();
+    if (storageDriver !== storageAdapter.driver) {
       throw new ServiceUnavailableException(
-        `File was stored with driver "${storageDriver}", but current adapter is "${this.storageAdapter.driver}".`,
+        `File was stored with driver "${storageDriver}", but current adapter is "${storageAdapter.driver}".`,
       );
     }
-    return this.storageAdapter.open(storageKey);
+    return storageAdapter.open(storageKey);
   }
 
   private async deleteStoredContent(storageDriver: string, storageKey: string): Promise<void> {
-    if (storageDriver !== this.storageAdapter.driver) {
+    const storageAdapter = this.requireStorageAdapter();
+    if (storageDriver !== storageAdapter.driver) {
       throw new ServiceUnavailableException(
-        `File was stored with driver "${storageDriver}", but current adapter is "${this.storageAdapter.driver}".`,
+        `File was stored with driver "${storageDriver}", but current adapter is "${storageAdapter.driver}".`,
       );
     }
-    await this.storageAdapter.delete(storageKey);
+    await storageAdapter.delete(storageKey);
   }
 
   private generatePublicId(): string {
@@ -353,12 +359,12 @@ export class FilesService {
   private async cleanupReferencedBlobs(blobIds: string[]): Promise<void> {
     const uniqueIds = [...new Set(blobIds.filter(Boolean))];
     for (const blobId of uniqueIds) {
-      const blob = await this.persistence.findBlobById(blobId);
+      const blob = await this.filesStore.findBlobById(blobId);
       if (!blob) {
         continue;
       }
 
-      const deleted = await this.persistence.deleteBlobIfUnreferenced(blob.id);
+      const deleted = await this.filesStore.deleteBlobIfUnreferenced(blob.id);
       if (!deleted) {
         continue;
       }
@@ -372,7 +378,7 @@ export class FilesService {
     mimeType: string,
     storageDriver: string,
   ): Promise<FilesBlobRef | null> {
-    const existing = await this.persistence.findBlobRef(hash, size, mimeType, storageDriver);
+    const existing = await this.filesStore.findBlobRef(hash, size, mimeType, storageDriver);
     if (!existing) {
       return null;
     }
@@ -446,3 +452,4 @@ export class FilesService {
     return `${basePath}/${publicId}/download`;
   }
 }
+

package/templates/module-presets/files/{apps/api/src/files/prisma-files-persistence.store.ts → packages/files/src/files.store.ts}

@@ -1,17 +1,81 @@
-import {
-  FILES_PERSISTENCE_PORT,
-  type FilesBlobCreateInput,
-  type FilesBlobRef,
-  type FilesPersistencePort,
-  type FilesRecordAggregate,
-  type FilesRecordCreateInput,
-  type FilesVariantCreateInput,
-} from '@forgeon/files';
-import { PrismaService } from '@forgeon/db-prisma';
 import { Injectable } from '@nestjs/common';
+import { PrismaService } from '@forgeon/db-prisma';
+import type { FileVariantKey } from './files.types';
+
+export type FilesBlobRecord = {
+  id: string;
+  hash: string;
+  size: number;
+  mimeType: string;
+  storageDriver: string;
+  storageKey: string;
+};
+
+export type FilesBlobRef = FilesBlobRecord & {
+  created: boolean;
+};
+
+export type FilesRecordVariant = {
+  variantKey: string;
+  blobId: string;
+  mimeType: string;
+  size: number;
+  status: string;
+  blob?: {
+    storageDriver: string;
+    storageKey: string;
+  };
+};
+
+export type FilesRecordAggregate = {
+  id: string;
+  publicId: string;
+  storageKey: string;
+  originalName: string;
+  mimeType: string;
+  size: number;
+  storageDriver: string;
+  ownerType: string;
+  ownerId: string | null;
+  visibility: string;
+  createdById: string | null;
+  createdAt: Date;
+  updatedAt: Date;
+  variants?: FilesRecordVariant[];
+};
+
+export type FilesRecordCreateInput = {
+  publicId: string;
+  storageKey: string;
+  originalName: string;
+  mimeType: string;
+  size: number;
+  storageDriver: string;
+  ownerType: string;
+  ownerId: string | null;
+  visibility: string;
+  createdById: string | null;
+};
+
+export type FilesBlobCreateInput = {
+  hash: string;
+  size: number;
+  mimeType: string;
+  storageDriver: string;
+  storageKey: string;
+};
+
+export type FilesVariantCreateInput = {
+  fileId: string;
+  variantKey: FileVariantKey;
+  blobId: string;
+  mimeType: string;
+  size: number;
+  status: string;
+};
 
 @Injectable()
-export class PrismaFilesPersistenceStore implements FilesPersistencePort {
+export class FilesStore {
   constructor(private readonly prisma: PrismaService) {}
 
   async createFileRecord(data: FilesRecordCreateInput): Promise<{ id: string; publicId: string }> {
@@ -136,7 +200,7 @@ export class PrismaFilesPersistenceStore implements FilesPersistencePort {
     };
   }
 
-  async createBlob(data: FilesBlobCreateInput) {
+  async createBlob(data: FilesBlobCreateInput): Promise<FilesBlobRecord> {
     return this.prisma.fileBlob.create({ data });
   }
 
@@ -144,7 +208,7 @@ export class PrismaFilesPersistenceStore implements FilesPersistencePort {
     await this.prisma.fileVariant.createMany({ data });
   }
 
-  async findBlobById(id: string) {
+  async findBlobById(id: string): Promise<FilesBlobRecord | null> {
     return this.prisma.fileBlob.findUnique({
       where: { id },
     });

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

@@ -1,136 +1,27 @@
 import {
   DynamicModule,
-  Injectable,
   Module,
   ModuleMetadata,
-  Provider,
-  ServiceUnavailableException,
 } from '@nestjs/common';
-import type {
-  FilesBlobCreateInput,
-  FilesPersistencePort,
-  FilesRecordCreateInput,
-  FilesStorageAdapter,
-  FilesVariantCreateInput,
-} from './files.ports';
-import { FILES_PERSISTENCE_PORT, FILES_STORAGE_ADAPTER } from './files.ports';
+import { DbPrismaModule } from '@forgeon/db-prisma';
 import { FilesController } from './files.controller';
 import { FilesConfigModule } from './files-config.module';
 import { FilesService } from './files.service';
+import { FilesStore } from './files.store';
 
 export interface ForgeonFilesModuleOptions {
   imports?: ModuleMetadata['imports'];
-  persistenceProvider?: Provider;
-  storageAdapterProvider?: Provider;
 }
 
-@Injectable()
-class MissingFilesPersistencePort implements FilesPersistencePort {
-  private unconfigured(): never {
-    throw new ServiceUnavailableException(
-      'Files persistence provider is not configured. Install/add a db-adapter provider and wire FILES_PERSISTENCE_PORT.',
-    );
-  }
-
-  async createFileRecord(_data: FilesRecordCreateInput): Promise<{ id: string; publicId: string }> {
-    return this.unconfigured();
-  }
-
-  async deleteFileRecordById(_id: string): Promise<void> {
-    return this.unconfigured();
-  }
-
-  async deleteFileRecordByPublicId(_publicId: string): Promise<void> {
-    return this.unconfigured();
-  }
-
-  async findFileRecordWithVariantKeys(_publicId: string) {
-    return this.unconfigured();
-  }
-
-  async findFileRecordForDelete(_publicId: string) {
-    return this.unconfigured();
-  }
-
-  async findFileRecordForDownload(_publicId: string) {
-    return this.unconfigured();
-  }
-
-  async countOwnerUsage(_ownerType: string, _ownerId: string) {
-    return this.unconfigured();
-  }
-
-  async findBlobRef(_hash: string, _size: number, _mimeType: string, _storageDriver: string) {
-    return this.unconfigured();
-  }
-
-  async createBlob(_data: FilesBlobCreateInput) {
-    return this.unconfigured();
-  }
-
-  async createVariants(_data: FilesVariantCreateInput[]): Promise<void> {
-    return this.unconfigured();
-  }
-
-  async findBlobById(_id: string) {
-    return this.unconfigured();
-  }
-
-  async deleteBlobIfUnreferenced(_id: string) {
-    return this.unconfigured();
-  }
-}
-
-@Injectable()
-class MissingFilesStorageAdapter implements FilesStorageAdapter {
-  readonly driver = 'unconfigured';
-
-  private unconfigured(): never {
-    throw new ServiceUnavailableException(
-      'Files storage adapter is not configured. Install/add a files-storage-adapter provider and wire FILES_STORAGE_ADAPTER.',
-    );
-  }
-
-  async put(_buffer: Buffer, _fileName: string): Promise<{ storageKey: string }> {
-    return this.unconfigured();
-  }
-
-  async open(_storageKey: string) {
-    return this.unconfigured();
-  }
-
-  async delete(_storageKey: string): Promise<void> {
-    return this.unconfigured();
-  }
-}
-
-@Module({
-  imports: [FilesConfigModule],
-  controllers: [FilesController],
-  providers: [FilesService],
-  exports: [FilesConfigModule, FilesService],
-})
+@Module({})
 export class ForgeonFilesModule {
   static register(options: ForgeonFilesModuleOptions = {}): DynamicModule {
-    const persistenceProvider =
-      options.persistenceProvider ??
-      ({
-        provide: FILES_PERSISTENCE_PORT,
-        useClass: MissingFilesPersistencePort,
-      } satisfies Provider);
-
-    const storageAdapterProvider =
-      options.storageAdapterProvider ??
-      ({
-        provide: FILES_STORAGE_ADAPTER,
-        useClass: MissingFilesStorageAdapter,
-      } satisfies Provider);
-
     return {
       module: ForgeonFilesModule,
-      imports: [...(options.imports ?? [])],
-      providers: [persistenceProvider, storageAdapterProvider],
-      exports: [FILES_PERSISTENCE_PORT, FILES_STORAGE_ADAPTER],
+      imports: [FilesConfigModule, DbPrismaModule, ...(options.imports ?? [])],
+      controllers: [FilesController],
+      providers: [FilesStore, FilesService],
+      exports: [FilesConfigModule, FilesStore, FilesService],
     };
   }
 }

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

@@ -7,4 +7,5 @@ export * from './files-config.service';
 export * from './files-env.schema';
 export * from './files.ports';
 export * from './files.service';
+export * from './files.store';
 export * from './files.types';

package/templates/module-presets/files-quotas/packages/files-quotas/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@forgeon/files-quotas",
-  "version": "0.1.0",
-  "private": true,
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsc -p tsconfig.json"
-  },
-  "dependencies": {
-    "@forgeon/files": "workspace:*",
-    "@nestjs/common": "^11.0.1",
-    "@nestjs/config": "^4.0.0",
-    "zod": "^3.24.2"
-  },
-  "devDependencies": {
-    "@types/node": "^22.10.7",
-    "typescript": "^5.7.3"
-  }
-}
+{
+  "name": "@forgeon/files-quotas",
+  "version": "0.1.0",
+  "private": true,
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@forgeon/files": "workspace:*",
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/config": "^4.0.0",
+    "zod": "^3.24.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.7",
+    "typescript": "^5.7.3"
+  }
+}