feat: enterprise adapter (#1406)

* feat: enterprise adapter

* fix: email

* docs: additional Terms

Author: tea-artist

AGPL_LICENSE

@@ -659,3 +659,21 @@ specific requirements.
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU AGPL, see
 <https://www.gnu.org/licenses/>.
+
+Additional Terms under GNU Affero General Public License Version 3 (AGPLv3)
+
+In accordance with Section 7 of the GNU Affero General Public License Version 3,
+the following additional terms apply to this software:
+
+Brand Protection (Under Section 7(e)):
+
+The Teable brand assets (including but not limited to the Teable name, logo,
+icons, and visual identity elements) are protected intellectual property and
+are not covered by the AGPLv3 license. While the software code may be modified
+under the terms of AGPL, any modification, replacement, or removal of these
+brand assets is explicitly prohibited.
+
+Specifically:
+1. You may not modify or replace the Teable brand assets
+2. You may not remove the Teable brand assets
+3. You may not use the brand assets in a way that suggests endorsement

LICENSE

@@ -17,3 +17,21 @@ This project is a combination of components under different licenses to balance
 As a whole, this project is primarily under the AGPL-3.0 license, with the exception of the packages in the 'packages' directory, which are available under the more permissive MIT License to facilitate wider adoption and integration.
 
 For any questions regarding licensing, please contact [email protected]
+
+Additional Terms under GNU Affero General Public License Version 3 (AGPLv3)
+
+In accordance with Section 7 of the GNU Affero General Public License Version 3,
+the following additional terms apply to this software:
+
+Brand Protection (Under Section 7(e)):
+
+The Teable brand assets (including but not limited to the Teable name, logo,
+icons, and visual identity elements) are protected intellectual property and
+are not covered by the AGPLv3 license. While the software code may be modified
+under the terms of AGPL, any modification, replacement, or removal of these
+brand assets is explicitly prohibited.
+
+Specifically:
+1. You may not modify or replace the Teable brand assets
+2. You may not remove the Teable brand assets
+3. You may not use the brand assets in a way that suggests endorsement

apps/nestjs-backend/src/configs/auth.config.ts

@@ -17,7 +17,7 @@ export const authConfig = registerAs('auth', () => ({
     expiresIn: process.env.BACKEND_SESSION_EXPIRES_IN ?? '7d',
   },
   accessToken: {
-    prefix: process.env.BRAND_NAME!.toLocaleLowerCase(),
+    prefix: 'teable',
     encryption: {
       algorithm: process.env.BACKEND_ACCESS_TOKEN_ENCRYPTION_ALGORITHM ?? 'aes-128-cbc',
       key: process.env.BACKEND_ACCESS_TOKEN_ENCRYPTION_KEY ?? 'ie21hOKjlXUiGDx9',

apps/nestjs-backend/src/configs/base.config.ts

@@ -5,7 +5,6 @@ import { registerAs } from '@nestjs/config';
 
 export const baseConfig = registerAs('base', () => ({
   isCloud: process.env.NEXT_BUILD_ENV_EDITION?.toUpperCase() === 'CLOUD',
-  brandName: process.env.BRAND_NAME,
   publicOrigin: process.env.PUBLIC_ORIGIN,
   storagePrefix: process.env.STORAGE_PREFIX ?? process.env.PUBLIC_ORIGIN,
   secretKey: process.env.SECRET_KEY ?? 'defaultSecretKey',

apps/nestjs-backend/src/configs/env.validation.schema.ts

@@ -19,8 +19,6 @@ export const envValidationSchema = Joi.object({
 
   PUBLIC_ORIGIN: Joi.string().uri().required(),
 
-  BRAND_NAME: Joi.string().required(),
-
   // cache
   BACKEND_CACHE_PROVIDER: Joi.string().valid('memory', 'sqlite', 'redis').default('sqlite'),
   // cache-sqlite

apps/nestjs-backend/src/features/attachments/plugins/adapter.ts

@@ -17,6 +17,7 @@ export default abstract class StorageAdapter {
       case UploadType.OAuth:
       case UploadType.Form:
       case UploadType.Plugin:
+      case UploadType.Logo:
         return storageConfig().publicBucket;
       case UploadType.Comment:
         return storageConfig().privateBucket;
@@ -41,6 +42,8 @@ export default abstract class StorageAdapter {
         return 'plugin';
       case UploadType.Comment:
         return 'comment';
+      case UploadType.Logo:
+        return 'logo';
       default:
         throw new BadRequestException('Invalid upload type');
     }

apps/nestjs-backend/src/features/auth/local-auth/local-auth.module.ts

@@ -2,6 +2,7 @@ import { Module } from '@nestjs/common';
 import { JwtModule } from '@nestjs/jwt';
 import type { IAuthConfig } from '../../../configs/auth.config';
 import { authConfig } from '../../../configs/auth.config';
+import { MailSenderModule } from '../../mail-sender/mail-sender.module';
 import { UserModule } from '../../user/user.module';
 import { SessionStoreService } from '../session/session-store.service';
 import { SessionModule } from '../session/session.module';
@@ -13,6 +14,7 @@ import { LocalAuthService } from './local-auth.service';
   imports: [
     UserModule,
     SessionModule,
+    MailSenderModule.register(),
     JwtModule.registerAsync({
       useFactory: (config: IAuthConfig) => ({
         secret: config.jwt.secret,

apps/nestjs-backend/src/features/auth/local-auth/local-auth.service.ts

@@ -178,7 +178,7 @@ export class LocalAuthService {
     }
     const user = await this.userService.getUserByEmail(email);
     this.isRegisteredValidate(user);
-    const emailOptions = this.mailSenderService.sendEmailVerifyCodeEmailOptions({
+    const emailOptions = await this.mailSenderService.sendEmailVerifyCodeEmailOptions({
       title: 'Signup verification',
       message: `Your verification code is ${code}, expires in ${this.authConfig.signupVerificationExpiresIn}.`,
     });
@@ -223,7 +223,7 @@ export class LocalAuthService {
     const resetPasswordCode = getRandomString(30);
 
     const url = `${this.mailConfig.origin}/auth/reset-password?code=${resetPasswordCode}`;
-    const resetPasswordEmailOptions = this.mailSenderService.resetPasswordEmailOptions({
+    const resetPasswordEmailOptions = await this.mailSenderService.resetPasswordEmailOptions({
       name: user.name,
       email: user.email,
       resetPasswordUrl: url,
@@ -333,7 +333,7 @@ export class LocalAuthService {
     if (this.baseConfig.enableEmailCodeConsole) {
       console.info('Change Email Verification code: ', '\x1b[34m' + code + '\x1b[0m');
     }
-    const emailOptions = this.mailSenderService.sendEmailVerifyCodeEmailOptions({
+    const emailOptions = await this.mailSenderService.sendEmailVerifyCodeEmailOptions({
       title: 'Change Email verification',
       message: `Your verification code is ${code}, expires in ${this.baseConfig.emailCodeExpiresIn}.`,
     });

apps/nestjs-backend/src/features/invitation/invitation.module.ts

@@ -1,11 +1,13 @@
 import { Module } from '@nestjs/common';
 import { CollaboratorModule } from '../collaborator/collaborator.module';
+import { MailSenderModule } from '../mail-sender/mail-sender.module';
+import { SettingModule } from '../setting/setting.module';
 import { UserModule } from '../user/user.module';
 import { InvitationController } from './invitation.controller';
 import { InvitationService } from './invitation.service';
 
 @Module({
-  imports: [CollaboratorModule, UserModule],
+  imports: [SettingModule, CollaboratorModule, UserModule, MailSenderModule.register()],
   providers: [InvitationService],
   exports: [InvitationService],
   controllers: [InvitationController],

apps/nestjs-backend/src/features/invitation/invitation.service.ts

@@ -25,12 +25,14 @@ import type { IClsStore } from '../../types/cls';
 import { generateInvitationCode } from '../../utils/code-generate';
 import { CollaboratorService } from '../collaborator/collaborator.service';
 import { MailSenderService } from '../mail-sender/mail-sender.service';
+import { SettingService } from '../setting/setting.service';
 import { UserService } from '../user/user.service';
 
 @Injectable()
 export class InvitationService {
   constructor(
     private readonly prismaService: PrismaService,
+    private readonly settingService: SettingService,
     private readonly cls: ClsService<IClsStore>,
     private readonly configService: ConfigService,
     private readonly mailSenderService: MailSenderService,
@@ -152,8 +154,11 @@ export class InvitationService {
             invitationId: id,
           },
         });
+        const { brandName } = await this.settingService.getServerBrand();
+
         // get email info
-        const inviteEmailOptions = this.mailSenderService.inviteEmailOptions({
+        const inviteEmailOptions = await this.mailSenderService.inviteEmailOptions({
+          brandName,
           name: user.name,
           email: user.email,
           resourceName,

apps/nestjs-backend/src/features/mail-sender/mail-helpers.ts

@@ -2,15 +2,10 @@ import type { ConfigService } from '@nestjs/config';
 
 export const helpers = (config: ConfigService) => {
   const publicOrigin = config.get<string>('PUBLIC_ORIGIN');
-  const brandName = config.get<string>('BRAND_NAME');
-
   return {
     publicOrigin: function () {
       return publicOrigin;
     },
-    brandName: function () {
-      return brandName;
-    },
     currentYear: function () {
       return new Date().getFullYear();
     },

apps/nestjs-backend/src/features/mail-sender/mail-sender.module.ts

@@ -6,6 +6,7 @@ import { ConfigService } from '@nestjs/config';
 import { MailerModule } from '@nestjs-modules/mailer';
 import { HandlebarsAdapter } from '@nestjs-modules/mailer/dist/adapters/handlebars.adapter';
 import type { IMailConfig } from '../../configs/mail.config';
+import { SettingModule } from '../setting/setting.module';
 import { helpers } from './mail-helpers';
 import { MailSenderService } from './mail-sender.service';
 
@@ -18,9 +19,7 @@ export const { ConfigurableModuleClass: MailSenderModuleClass, OPTIONS_TYPE } =
 
 @Module({})
 export class MailSenderModule extends MailSenderModuleClass {
-  static register(options?: typeof OPTIONS_TYPE): DynamicModule {
-    const { global } = options || {};
-
+  static register(): DynamicModule {
     const module = MailerModule.forRootAsync({
       inject: [ConfigService],
       useFactory: (config: ConfigService) => {
@@ -63,9 +62,8 @@ export class MailSenderModule extends MailSenderModuleClass {
     });
 
     return {
-      imports: [module],
+      imports: [SettingModule, module],
       module: MailSenderModule,
-      global,
       providers: [MailSenderService],
       exports: [MailSenderService],
     };

apps/nestjs-backend/src/features/mail-sender/mail-sender.service.spec.ts

@@ -2,8 +2,8 @@ import { Injectable, Logger } from '@nestjs/common';
 import type { ISendMailOptions } from '@nestjs-modules/mailer';
 import { MailerService } from '@nestjs-modules/mailer';
 import { CollaboratorType } from '@teable/openapi';
-import { BaseConfig, IBaseConfig } from '../../configs/base.config';
 import { IMailConfig, MailConfig } from '../../configs/mail.config';
+import { SettingService } from '../setting/setting.service';
 
 @Injectable()
 export class MailSenderService {
@@ -12,7 +12,7 @@ export class MailSenderService {
   constructor(
     private readonly mailService: MailerService,
     @MailConfig() private readonly mailConfig: IMailConfig,
-    @BaseConfig() private readonly baseConfig: IBaseConfig
+    private readonly settingService: SettingService
   ) {}
 
   async sendMail(
@@ -35,15 +35,17 @@ export class MailSenderService {
 
   inviteEmailOptions(info: {
     name: string;
+    brandName: string;
     email: string;
     resourceName: string;
     resourceType: CollaboratorType;
     inviteUrl: string;
   }) {
-    const { name, email, inviteUrl, resourceName, resourceType } = info;
+    const { name, email, inviteUrl, resourceName, resourceType, brandName } = info;
     const resourceAlias = resourceType === CollaboratorType.Space ? 'Space' : 'Base';
+
     return {
-      subject: `${name} (${email}) invited you to their ${resourceAlias} ${resourceName} - ${this.baseConfig.brandName}`,
+      subject: `${name} (${email}) invited you to their ${resourceAlias} ${resourceName} - ${brandName}`,
       template: 'normal',
       context: {
         name,
@@ -52,11 +54,12 @@ export class MailSenderService {
         resourceAlias,
         inviteUrl,
         partialBody: 'invite',
+        brandName,
       },
     };
   }
 
-  collaboratorCellTagEmailOptions(info: {
+  async collaboratorCellTagEmailOptions(info: {
     notifyId: string;
     fromUserName: string;
     refRecord: {
@@ -76,7 +79,7 @@ export class MailSenderService {
     const refLength = recordIds.length;
 
     const viewRecordUrlPrefix = `${this.mailConfig.origin}/base/${baseId}/${tableId}`;
-
+    const { brandName } = await this.settingService.getServerBrand();
     if (refLength <= 1) {
       subject = `${fromUserName} added you to the ${fieldName} field of a record in ${tableName}`;
       partialBody = 'collaborator-cell-tag';
@@ -87,7 +90,7 @@ export class MailSenderService {
 
     return {
       notifyMessage: subject,
-      subject: `${subject} - ${this.baseConfig.brandName}`,
+      subject: `${subject} - ${brandName}`,
       template: 'normal',
       context: {
         notifyId,
@@ -98,51 +101,57 @@ export class MailSenderService {
         recordIds,
         viewRecordUrlPrefix,
         partialBody,
+        brandName,
       },
     };
   }
 
-  commonEmailOptions(info: {
+  async commonEmailOptions(info: {
     to: string;
     title: string;
     message: string;
     buttonUrl: string;
     buttonText: string;
   }) {
     const { title, message } = info;
-
+    const { brandName } = await this.settingService.getServerBrand();
     return {
       notifyMessage: message,
-      subject: `${title} - ${this.baseConfig.brandName}`,
+      subject: `${title} - ${brandName}`,
       template: 'normal',
       context: {
         partialBody: 'common-body',
+        brandName,
         ...info,
       },
     };
   }
 
-  resetPasswordEmailOptions(info: { name: string; email: string; resetPasswordUrl: string }) {
+  async resetPasswordEmailOptions(info: { name: string; email: string; resetPasswordUrl: string }) {
     const { name, email, resetPasswordUrl } = info;
+    const { brandName } = await this.settingService.getServerBrand();
     return {
-      subject: `Reset your password - ${this.baseConfig.brandName}`,
+      subject: `Reset your password - ${brandName}`,
       template: 'normal',
       context: {
         name,
         email,
         resetPasswordUrl,
+        brandName,
         partialBody: 'reset-password',
       },
     };
   }
 
-  sendEmailVerifyCodeEmailOptions(info: { title: string; message: string }) {
+  async sendEmailVerifyCodeEmailOptions(info: { title: string; message: string }) {
     const { title } = info;
+    const { brandName } = await this.settingService.getServerBrand();
     return {
-      subject: `${title} - ${this.baseConfig.brandName}`,
+      subject: `${title} - ${brandName}`,
       template: 'normal',
       context: {
         partialBody: 'email-verify-code',
+        brandName,
         ...info,
       },
     };

apps/nestjs-backend/src/features/mail-sender/mail-sender.service.ts

@@ -3,7 +3,6 @@
 <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Teable Email</title>
     <style type="text/css">
         /* Client-specific styles */
         #outlook a {

apps/nestjs-backend/src/features/mail-sender/templates/pages/normal.hbs

@@ -1,11 +1,12 @@
 import { Module } from '@nestjs/common';
 import { ShareDbModule } from '../../share-db/share-db.module';
+import { MailSenderModule } from '../mail-sender/mail-sender.module';
 import { UserModule } from '../user/user.module';
 import { NotificationController } from './notification.controller';
 import { NotificationService } from './notification.service';
 
 @Module({
-  imports: [ShareDbModule, UserModule],
+  imports: [ShareDbModule, UserModule, MailSenderModule.register()],
   controllers: [NotificationController],
   providers: [NotificationService],
   exports: [NotificationService],