create-forgeon 0.3.5 → 0.3.6

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

@@ -0,0 +1,35 @@
+export type StoredFileInput = {
+  originalName: string;
+  mimeType: string;
+  size: number;
+  buffer: Buffer;
+  ownerType?: string;
+  ownerId?: string;
+  visibility?: string;
+  createdById?: string;
+  auditContext?: {
+    requestId?: string | null;
+    ip?: string | null;
+    userId?: string | null;
+  };
+};
+
+export type FileVariantKey = 'original' | 'preview';
+
+export type FileRecordDto = {
+  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: string;
+  updatedAt: string;
+  url: string;
+  availableVariants: FileVariantKey[];
+};

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

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { FilesController } from './files.controller';
+import { FilesConfigModule } from './files-config.module';
+import { FilesService } from './files.service';
+
+@Module({
+  imports: [FilesConfigModule],
+  controllers: [FilesController],
+  providers: [FilesService],
+  exports: [FilesConfigModule, FilesService],
+})
+export class ForgeonFilesModule {}

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

@@ -0,0 +1,9 @@
+export * from './dto/create-file.dto';
+export * from './files.controller';
+export * from './forgeon-files.module';
+export * from './files-config.loader';
+export * from './files-config.module';
+export * from './files-config.service';
+export * from './files-env.schema';
+export * from './files.service';
+export * from './files.types';

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

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.node.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist",
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"]
+}

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

@@ -0,0 +1,17 @@
+{
+  "name": "@forgeon/files-access",
+  "version": "0.1.0",
+  "private": true,
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.7",
+    "typescript": "^5.7.3"
+  }
+}

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

@@ -0,0 +1,59 @@
+import { ForbiddenException, Injectable } from '@nestjs/common';
+import type { FilesAccessRecord, FilesAccessSubject } from './files-access.types';
+
+@Injectable()
+export class FilesAccessService {
+  can(action: 'read' | 'delete', record: FilesAccessRecord, subject: FilesAccessSubject): boolean {
+    if (subject.permissions.includes('files.manage')) {
+      return true;
+    }
+
+    const isOwner =
+      subject.actorId !== null &&
+      record.ownerType === 'user' &&
+      record.ownerId !== null &&
+      record.ownerId === subject.actorId;
+
+    if (isOwner) {
+      return true;
+    }
+
+    if (action === 'read' && record.visibility === 'public') {
+      return true;
+    }
+
+    return false;
+  }
+
+  canRead(record: FilesAccessRecord, subject: FilesAccessSubject): boolean {
+    return this.can('read', record, subject);
+  }
+
+  canDelete(record: FilesAccessRecord, subject: FilesAccessSubject): boolean {
+    return this.can('delete', record, subject);
+  }
+
+  assertCanRead(record: FilesAccessRecord, subject: FilesAccessSubject): void {
+    if (!this.canRead(record, subject)) {
+      throw new ForbiddenException({
+        message: 'You do not have permission to read this file.',
+        details: {
+          required: 'owner or files.manage or public visibility',
+          action: 'read',
+        },
+      });
+    }
+  }
+
+  assertCanDelete(record: FilesAccessRecord, subject: FilesAccessSubject): void {
+    if (!this.canDelete(record, subject)) {
+      throw new ForbiddenException({
+        message: 'You do not have permission to delete this file.',
+        details: {
+          required: 'owner or files.manage',
+          action: 'delete',
+        },
+      });
+    }
+  }
+}

package/templates/module-presets/files-access/packages/files-access/src/files-access.subject.ts

@@ -0,0 +1,45 @@
+import type { FilesAccessSubject } from './files-access.types';
+
+type HeaderValue = string | string[] | undefined;
+
+type RequestLike = {
+  user?: {
+    sub?: string;
+    id?: string;
+  };
+  headers?: Record<string, HeaderValue>;
+};
+
+function getHeaderValue(headers: Record<string, HeaderValue> | undefined, key: string): string | null {
+  if (!headers) {
+    return null;
+  }
+  const value = headers[key];
+  if (Array.isArray(value)) {
+    return value.length > 0 ? value[0] : null;
+  }
+  if (typeof value !== 'string') {
+    return null;
+  }
+  return value;
+}
+
+export function extractFilesAccessSubject(request: RequestLike): FilesAccessSubject {
+  const actorId =
+    request.user?.sub ??
+    request.user?.id ??
+    getHeaderValue(request.headers, 'x-forgeon-user-id') ??
+    null;
+
+  const permissionsRaw = getHeaderValue(request.headers, 'x-forgeon-permissions');
+  const permissions =
+    permissionsRaw
+      ?.split(',')
+      .map((item) => item.trim())
+      .filter(Boolean) ?? [];
+
+  return {
+    actorId,
+    permissions,
+  };
+}

package/templates/module-presets/files-access/packages/files-access/src/files-access.types.ts

@@ -0,0 +1,14 @@
+export type FilesAccessAction = 'read' | 'delete';
+
+export type FilesAccessVisibility = 'private' | 'owner' | 'group' | 'public' | string;
+
+export type FilesAccessRecord = {
+  ownerType: string;
+  ownerId: string | null;
+  visibility: FilesAccessVisibility;
+};
+
+export type FilesAccessSubject = {
+  actorId: string | null;
+  permissions: string[];
+};

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

@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+import { FilesAccessService } from './files-access.service';
+
+@Module({
+  providers: [FilesAccessService],
+  exports: [FilesAccessService],
+})
+export class ForgeonFilesAccessModule {}

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

@@ -0,0 +1,4 @@
+export * from './files-access.subject';
+export * from './files-access.service';
+export * from './files-access.types';
+export * from './forgeon-files-access.module';

package/templates/module-presets/files-access/packages/files-access/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.node.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist",
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"]
+}

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

@@ -0,0 +1,21 @@
+{
+  "name": "@forgeon/files-image",
+  "version": "0.1.0",
+  "private": true,
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/config": "^4.0.0",
+    "file-type": "^19.6.0",
+    "sharp": "^0.34.2",
+    "zod": "^3.24.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.7",
+    "typescript": "^5.7.3"
+  }
+}

package/templates/module-presets/files-image/packages/files-image/src/files-image-config.loader.ts

@@ -0,0 +1,32 @@
+import { registerAs } from '@nestjs/config';
+import { parseFilesImageEnv } from './files-image-env.schema';
+
+export const FILES_IMAGE_CONFIG_NAMESPACE = 'filesImage';
+
+export interface FilesImageConfigValues {
+  enabled: boolean;
+  stripMetadata: boolean;
+  maxWidth: number;
+  maxHeight: number;
+  maxPixels: number;
+  maxFrames: number;
+  processTimeoutMs: number;
+  allowedMimeTypes: string[];
+}
+
+export const filesImageConfig = registerAs(
+  FILES_IMAGE_CONFIG_NAMESPACE,
+  (): FilesImageConfigValues => {
+    const env = parseFilesImageEnv(process.env);
+    return {
+      enabled: env.FILES_IMAGE_ENABLED,
+      stripMetadata: env.FILES_IMAGE_STRIP_METADATA,
+      maxWidth: env.FILES_IMAGE_MAX_WIDTH,
+      maxHeight: env.FILES_IMAGE_MAX_HEIGHT,
+      maxPixels: env.FILES_IMAGE_MAX_PIXELS,
+      maxFrames: env.FILES_IMAGE_MAX_FRAMES,
+      processTimeoutMs: env.FILES_IMAGE_PROCESS_TIMEOUT_MS,
+      allowedMimeTypes: env.FILES_IMAGE_ALLOWED_MIME_TYPES,
+    };
+  },
+);

package/templates/module-presets/files-image/packages/files-image/src/files-image-config.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { filesImageConfig } from './files-image-config.loader';
+import { FilesImageConfigService } from './files-image-config.service';
+
+@Module({
+  imports: [ConfigModule.forFeature(filesImageConfig)],
+  providers: [FilesImageConfigService],
+  exports: [FilesImageConfigService],
+})
+export class FilesImageConfigModule {}

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

@@ -0,0 +1,55 @@
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import {
+  FILES_IMAGE_CONFIG_NAMESPACE,
+  FilesImageConfigValues,
+} from './files-image-config.loader';
+
+@Injectable()
+export class FilesImageConfigService {
+  constructor(private readonly configService: ConfigService) {}
+
+  get enabled(): boolean {
+    return this.configService.getOrThrow<boolean>(`${FILES_IMAGE_CONFIG_NAMESPACE}.enabled`);
+  }
+
+  get stripMetadata(): boolean {
+    return this.configService.getOrThrow<boolean>(`${FILES_IMAGE_CONFIG_NAMESPACE}.stripMetadata`);
+  }
+
+  get maxWidth(): FilesImageConfigValues['maxWidth'] {
+    return this.configService.getOrThrow<FilesImageConfigValues['maxWidth']>(
+      `${FILES_IMAGE_CONFIG_NAMESPACE}.maxWidth`,
+    );
+  }
+
+  get maxHeight(): FilesImageConfigValues['maxHeight'] {
+    return this.configService.getOrThrow<FilesImageConfigValues['maxHeight']>(
+      `${FILES_IMAGE_CONFIG_NAMESPACE}.maxHeight`,
+    );
+  }
+
+  get maxPixels(): FilesImageConfigValues['maxPixels'] {
+    return this.configService.getOrThrow<FilesImageConfigValues['maxPixels']>(
+      `${FILES_IMAGE_CONFIG_NAMESPACE}.maxPixels`,
+    );
+  }
+
+  get maxFrames(): FilesImageConfigValues['maxFrames'] {
+    return this.configService.getOrThrow<FilesImageConfigValues['maxFrames']>(
+      `${FILES_IMAGE_CONFIG_NAMESPACE}.maxFrames`,
+    );
+  }
+
+  get processTimeoutMs(): FilesImageConfigValues['processTimeoutMs'] {
+    return this.configService.getOrThrow<FilesImageConfigValues['processTimeoutMs']>(
+      `${FILES_IMAGE_CONFIG_NAMESPACE}.processTimeoutMs`,
+    );
+  }
+
+  get allowedMimeTypes(): FilesImageConfigValues['allowedMimeTypes'] {
+    return this.configService.getOrThrow<FilesImageConfigValues['allowedMimeTypes']>(
+      `${FILES_IMAGE_CONFIG_NAMESPACE}.allowedMimeTypes`,
+    );
+  }
+}

package/templates/module-presets/files-image/packages/files-image/src/files-image-env.schema.ts

@@ -0,0 +1,28 @@
+import { z } from 'zod';
+
+export const filesImageEnvSchema = z
+  .object({
+    FILES_IMAGE_ENABLED: z.coerce.boolean().default(true),
+    FILES_IMAGE_STRIP_METADATA: z.coerce.boolean().default(true),
+    FILES_IMAGE_MAX_WIDTH: z.coerce.number().int().positive().default(4096),
+    FILES_IMAGE_MAX_HEIGHT: z.coerce.number().int().positive().default(4096),
+    FILES_IMAGE_MAX_PIXELS: z.coerce.number().int().positive().default(16777216),
+    FILES_IMAGE_MAX_FRAMES: z.coerce.number().int().positive().default(1),
+    FILES_IMAGE_PROCESS_TIMEOUT_MS: z.coerce.number().int().positive().default(5000),
+    FILES_IMAGE_ALLOWED_MIME_TYPES: z
+      .string()
+      .default('image/jpeg,image/png,image/webp')
+      .transform((value) =>
+        value
+          .split(',')
+          .map((item) => item.trim())
+          .filter(Boolean),
+      ),
+  })
+  .passthrough();
+
+export type FilesImageEnv = z.infer<typeof filesImageEnvSchema>;
+
+export function parseFilesImageEnv(input: Record<string, unknown>): FilesImageEnv {
+  return filesImageEnvSchema.parse(input);
+}