Rename public uploads to file uploads

.changeset/beige-brooms-try.md

@@ -0,0 +1,7 @@
+---
+"@comet/cms-api": major
+---
+
+Remove `download` helper
+
+Use `createFileUploadInputFromUrl` instead.

.changeset/bright-lobsters-shout.md

@@ -0,0 +1,7 @@
+---
+"@comet/cms-api": major
+---
+
+Remove `FileUploadService`
+
+Use `createFileUploadInputFromUrl` instead of `FileUploadService#createFileUploadInputFromUrl`.

.changeset/nice-pigs-mate.md

@@ -0,0 +1,15 @@
+---
+"@comet/cms-api": major
+---
+
+Rename "public uploads" to "file uploads"
+
+The name "public uploads" was not fitting since the uploads can also be used for "private" uploads in the Admin.
+The feature was therefore renamed to "file uploads".
+
+This requires the following changes:
+
+-   Use `FileUploadsModule` instead of `PublicUploadModule`
+-   Use `FileUpload` instead of `PublicUpload`
+-   Use `FileUploadsService` instead of `PublicUploadsService`
+-   Change the upload URL from `/public-upload/files/upload` to `/files-uploads/upload`

demo/api/schema.gql

@@ -43,23 +43,6 @@ A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date
 """
 scalar DateTime
 
-type Dependency {
-  rootId: String!
-  rootGraphqlObjectType: String!
-  rootColumnName: String!
-  jsonPath: String!
-  visible: Boolean!
-  targetGraphqlObjectType: String!
-  targetId: String!
-  name: String
-  secondaryInformation: String
-}
-
-type PaginatedDependencies {
-  nodes: [Dependency!]!
-  totalCount: Int!
-}
-
 type ImageCropArea {
   focalPoint: FocalPoint!
   width: Float
@@ -107,6 +90,23 @@ enum LicenseType {
   RIGHTS_MANAGED
 }
 
+type Dependency {
+  rootId: String!
+  rootGraphqlObjectType: String!
+  rootColumnName: String!
+  jsonPath: String!
+  visible: Boolean!
+  targetGraphqlObjectType: String!
+  targetId: String!
+  name: String
+  secondaryInformation: String
+}
+
+type PaginatedDependencies {
+  nodes: [Dependency!]!
+  totalCount: Int!
+}
+
 type BuildTemplate {
   id: ID!
   name: String!

demo/api/src/app.module.ts

@@ -10,9 +10,9 @@ import {
     CronJobsModule,
     DamModule,
     DependenciesModule,
+    FileUploadsModule,
     KubernetesModule,
     PageTreeModule,
-    PublicUploadModule,
     RedirectsModule,
     UserPermissionsModule,
 } from "@comet/cms-api";
@@ -136,9 +136,9 @@ export class AppModule {
                     File: DamFile,
                     Folder: DamFolder,
                 }),
-                PublicUploadModule.register({
-                    maxFileSize: config.publicUploads.maxFileSize,
-                    directory: `${config.blob.storageDirectoryPrefix}-public-uploads`,
+                FileUploadsModule.register({
+                    maxFileSize: config.fileUploads.maxFileSize,
+                    directory: `${config.blob.storageDirectoryPrefix}-file-uploads`,
                     acceptedMimeTypes: ["application/pdf", "application/x-zip-compressed", "application/zip"],
                 }),
                 ...(config.contentGeneration

demo/api/src/comet-config.json

@@ -1,5 +1,5 @@
 {
-    "publicUploads": {
+    "fileUploads": {
         "maxFileSize": 15
     },
     "imgproxy": {

demo/api/src/db/fixtures/fixtures.console.ts

@@ -17,9 +17,9 @@ import faker from "faker";
 import { Command, Console } from "nestjs-console";
 import slugify from "slugify";
 
+import { FileUploadsFixtureService } from "./generators/file-uploads-fixture.service";
 import { generateLinks } from "./generators/links.generator";
 import { ManyImagesTestPageFixtureService } from "./generators/many-images-test-page-fixture.service";
-import { PublicUploadsFixtureService } from "./generators/public-uploads-fixture.service";
 
 export interface PageTreeNodesFixtures {
     home?: PageTreeNodeInterface;
@@ -48,7 +48,7 @@ export class FixturesConsole {
         @InjectRepository(Page) private readonly pagesRepository: EntityRepository<Page>,
         @InjectRepository(Link) private readonly linksRepository: EntityRepository<Link>,
         private readonly manyImagesTestPageFixtureService: ManyImagesTestPageFixtureService,
-        private readonly publicUploadsFixtureService: PublicUploadsFixtureService,
+        private readonly fileUploadsFixtureService: FileUploadsFixtureService,
     ) {}
 
     @Command({
@@ -275,7 +275,7 @@ export class FixturesConsole {
             console.log(`Generated ${pagesCount} lorem ipsum pages for ${domain}`);
         }
 
-        await this.publicUploadsFixtureService.generatePublicUploads();
+        await this.fileUploadsFixtureService.generateFileUploads();
 
         await this.orm.em.flush();
     }

demo/api/src/db/fixtures/fixtures.module.ts

@@ -5,8 +5,8 @@ import { LinksModule } from "@src/links/links.module";
 import { PagesModule } from "@src/pages/pages.module";
 import { ConsoleModule } from "nestjs-console";
 
+import { FileUploadsFixtureService } from "./generators/file-uploads-fixture.service";
 import { ManyImagesTestPageFixtureService } from "./generators/many-images-test-page-fixture.service";
-import { PublicUploadsFixtureService } from "./generators/public-uploads-fixture.service";
 import { SvgImageFileFixtureService } from "./generators/svg-image-file-fixture.service";
 import { UnsplashImageFileFixtureService } from "./generators/unsplash-image-file-fixture.service";
 
@@ -17,7 +17,7 @@ import { UnsplashImageFileFixtureService } from "./generators/unsplash-image-fil
         ManyImagesTestPageFixtureService,
         UnsplashImageFileFixtureService,
         SvgImageFileFixtureService,
-        PublicUploadsFixtureService,
+        FileUploadsFixtureService,
     ],
 })
 export class FixturesModule {}

demo/api/src/db/fixtures/generators/file-uploads-fixture.service.ts

@@ -0,0 +1,22 @@
+import { createFileUploadInputFromUrl, FileUpload, FileUploadsService } from "@comet/cms-api";
+import { Injectable } from "@nestjs/common";
+import path from "path";
+
+@Injectable()
+export class FileUploadsFixtureService {
+    constructor(private readonly fileUploadsService: FileUploadsService) {}
+
+    async generateFileUploads(): Promise<FileUpload[]> {
+        console.log("Generating file uploads...");
+
+        const images = ["01.jpg", "02.jpg", "03.jpg", "04.jpg", "05.jpg"];
+        const fileUploads: FileUpload[] = [];
+
+        for (const image of images) {
+            const file = await createFileUploadInputFromUrl(path.resolve(`./src/db/fixtures/generators/images/${image}`));
+            fileUploads.push(await this.fileUploadsService.upload(file));
+        }
+
+        return fileUploads;
+    }
+}

demo/api/src/db/fixtures/generators/svg-image-file-fixture.service.ts

@@ -1,16 +1,14 @@
-import { FileInterface, FilesService, FileUploadService } from "@comet/cms-api";
+import { createFileUploadInputFromUrl, FileInterface, FilesService } from "@comet/cms-api";
 import { Injectable } from "@nestjs/common";
 import { DamScope } from "@src/dam/dto/dam-scope";
 import path from "path";
 
 @Injectable()
 export class SvgImageFileFixtureService {
-    constructor(private readonly filesService: FilesService, private readonly fileUploadService: FileUploadService) {}
+    constructor(private readonly filesService: FilesService) {}
 
     async generateImage(scope: DamScope): Promise<FileInterface> {
-        const file = await this.fileUploadService.createFileUploadInputFromUrl(
-            path.resolve(`./src/db/fixtures/generators/images/comet-logo-claim.svg`),
-        );
+        const file = await createFileUploadInputFromUrl(path.resolve(`./src/db/fixtures/generators/images/comet-logo-claim.svg`));
         // Convert to what the browser would send
         file.mimetype = "image/svg+xml";
         file.originalname = "comet-logo-claim.svg";

demo/api/src/db/fixtures/generators/unsplash-image-file-fixture.service.ts

@@ -1,11 +1,11 @@
-import { FileInterface, FilesService, FileUploadService } from "@comet/cms-api";
+import { createFileUploadInputFromUrl, FileInterface, FilesService } from "@comet/cms-api";
 import { Injectable } from "@nestjs/common";
 import { DamScope } from "@src/dam/dto/dam-scope";
 import faker from "faker";
 
 @Injectable()
 export class UnsplashImageFileFixtureService {
-    constructor(private readonly filesService: FilesService, private readonly fileUploadService: FileUploadService) {}
+    constructor(private readonly filesService: FilesService) {}
 
     async generateImage(scope: DamScope): Promise<FileInterface> {
         const width = faker.datatype.number({
@@ -19,7 +19,7 @@ export class UnsplashImageFileFixtureService {
 
         const imageUrl = `https://source.unsplash.com/all/${width}x${height}`;
         console.log(`Downloading ${imageUrl}.`);
-        const downloadedImage = await this.fileUploadService.createFileUploadInputFromUrl(imageUrl);
+        const downloadedImage = await createFileUploadInputFromUrl(imageUrl);
         console.log(`Downloading ${imageUrl} done.`);
         console.log(`Uploading ${downloadedImage.originalname}.`);
         const file = await this.filesService.upload(downloadedImage, { scope });

docs/docs/migration/migration-from-v6-to-v7.md

@@ -339,6 +339,69 @@ import { NewsResolver } from "./generated/news.resolver";
 export class NewsModule {}
 ```
 
+### Rename public uploads
+
+The `PublicUploadModule` was renamed to `FileUploadsModule`.
+
+:::warning
+
+The public uploads module was unintentionally added to the Starter. If you don't use the feature in your application, remove the module instead.
+
+:::
+
+This requires the following changes:
+
+-   In `comet-config.json` rename `publicUploads` to `fileUploads`.
+
+    ```diff
+    {
+    -   "publicUploads": {
+    +   "fileUploads": {
+            "maxFileSize": 15
+        }
+    }
+    ```
+
+-   In `app.module.ts` change the import from `PublicUploadModule` to `FileUploadsModule`.
+
+    ```diff
+    - PublicUploadModule.register({
+    + FileUploadsModule.register({
+    -    maxFileSize: config.publicUploads.maxFileSize,
+    -    directory: `${config.blob.storageDirectoryPrefix}-public-uploads`,
+    +    maxFileSize: config.fileUploads.maxFileSize,
+    +    directory: `${config.blob.storageDirectoryPrefix}-file-uploads`,
+    })
+    ```
+
+-   Change all usages of the `PublicUpload` entity to `FileUpload`.
+-   Change all usages of the `PublicUploadsService` to `FileUploadsService`.
+-   In the site or the Admin change the upload URL from `/public-upload/files/upload` to `/files-uploads/upload`.
+
+### Remove usages of `download` or `FileUploadService`
+
+Use `createFileUploadInputFromUrl` instead:
+
+```diff
+- import { FileUploadService } from "@comet/cms-api";
++ import { createFileUploadInputFromUrl } from "@comet/cms-api";
+
+@Injectable()
+export class SvgImageFileFixtureService {
+    constructor(
+        private readonly filesService: FilesService,
+-       private readonly fileUploadService: FileUploadService,
+    ) {}
+
+    async generateImage(scope: DamScope): Promise<FileInterface> {
+-       const file = await this.fileUploadService.createFileUploadInputFromUrl(
++       const file = await createFileUploadInputFromUrl(
+            path.resolve(`./src/db/fixtures/generators/images/comet-logo-claim.svg`),
+        );
+    }
+}
+```
+
 ## Admin
 
 ### Remove `axios` dependency

packages/api/cms-api/schema.gql

@@ -39,23 +39,6 @@ A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date
 """
 scalar DateTime
 
-type Dependency {
-  rootId: String!
-  rootGraphqlObjectType: String!
-  rootColumnName: String!
-  jsonPath: String!
-  visible: Boolean!
-  targetGraphqlObjectType: String!
-  targetId: String!
-  name: String
-  secondaryInformation: String
-}
-
-type PaginatedDependencies {
-  nodes: [Dependency!]!
-  totalCount: Int!
-}
-
 type ImageCropArea {
   focalPoint: FocalPoint!
   width: Float
@@ -103,6 +86,23 @@ enum LicenseType {
   RIGHTS_MANAGED
 }
 
+type Dependency {
+  rootId: String!
+  rootGraphqlObjectType: String!
+  rootColumnName: String!
+  jsonPath: String!
+  visible: Boolean!
+  targetGraphqlObjectType: String!
+  targetId: String!
+  name: String
+  secondaryInformation: String
+}
+
+type PaginatedDependencies {
+  nodes: [Dependency!]!
+  totalCount: Int!
+}
+
 type BuildTemplate {
   id: ID!
   name: String!

packages/api/cms-api/src/dam/dam.module.ts

@@ -18,7 +18,6 @@ import { DamFileImage } from "./files/entities/file-image.entity";
 import { createFolderEntity, FolderInterface } from "./files/entities/folder.entity";
 import { FileImagesResolver } from "./files/file-image.resolver";
 import { FileLicensesResolver } from "./files/file-licenses.resolver";
-import { FileUploadService } from "./files/file-upload.service";
 import { FileValidationService } from "./files/file-validation.service";
 import { createFilesController } from "./files/files.controller";
 import { createFilesResolver } from "./files/files.resolver";
@@ -126,7 +125,6 @@ export class DamModule {
                 FileImagesResolver,
                 CalculateDominantImageColor,
                 FileValidationService,
-                FileUploadService,
                 PixelImageBlockTransformerService,
                 SvgImageBlockTransformerService,
                 DamVideoBlockTransformerService,
@@ -141,7 +139,6 @@ export class DamModule {
                 ImagesService,
                 ScaledImagesCacheService,
                 damConfigProvider,
-                FileUploadService,
                 PixelImageBlockTransformerService,
                 SvgImageBlockTransformerService,
                 DamVideoBlockTransformerService,