feat: initial commit

2025-06-26 18:27:28 +00:00 · 2024-09-10 10:50:11 +01:00
commit 30e5766487
879 changed files with 122820 additions and 0 deletions
--- a/api/src/setting/repositories/setting.repository.ts
+++ b/api/src/setting/repositories/setting.repository.ts
@@ -0,0 +1,118 @@
+/*
+ * Copyright © 2024 Hexastack. All rights reserved.
+ *
+ * Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
+ * 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
+ * 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
+ * 3. SaaS Restriction: This software, or any derivative of it, may not be used to offer a competing product or service (SaaS) without prior written consent from Hexastack. Offering the software as a service or using it in a commercial cloud environment without express permission is strictly prohibited.
+ */
+
+import { Injectable } from '@nestjs/common';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { InjectModel } from '@nestjs/mongoose';
+import { Document, Model, Query, Types } from 'mongoose';
+
+import { config } from '@/config';
+import { ExtendedI18nService } from '@/extended-i18n.service';
+import { BaseRepository } from '@/utils/generics/base-repository';
+
+import { Setting } from '../schemas/setting.schema';
+
+@Injectable()
+export class SettingRepository extends BaseRepository<Setting> {
+  constructor(
+    @InjectModel(Setting.name) readonly model: Model<Setting>,
+    private readonly eventEmitter: EventEmitter2,
+    private readonly i18n: ExtendedI18nService,
+  ) {
+    super(model, Setting);
+  }
+
+  /**
+   * Validates the `Setting` document after it has been retrieved.
+   *
+   * Checks the `type` of the setting and validates the `value` field according to the type:
+   * - `text` expects a string.
+   * - `multiple_text` expects an array of strings.
+   * - `checkbox` expects a boolean.
+   *
+   * @param setting The `Setting` document to be validated.
+   */
+  async postValidate(
+    setting: Document<unknown, unknown, Setting> &
+      Setting & { _id: Types.ObjectId },
+  ) {
+    if (setting.type === 'text' && typeof setting.value !== 'string') {
+      throw new Error('Setting Model : Value must be a string!');
+    } else if (setting.type === 'multiple_text') {
+      const isStringArray =
+        Array.isArray(setting.value) &&
+        setting.value.every((v) => {
+          return typeof v === 'string';
+        });
+      if (!isStringArray) {
+        throw new Error('Setting Model : Value must be a string array!');
+      }
+    } else if (
+      setting.type === 'checkbox' &&
+      typeof setting.value !== 'boolean'
+    ) {
+      throw new Error('Setting Model : Value must be a boolean!');
+    }
+  }
+
+  /**
+   * Emits an event after a `Setting` has been updated.
+   *
+   * This method is used to synchronize global settings by emitting an event
+   * based on the `group` and `label` of the `Setting`. It also updates the i18n
+   * default language setting when the `default_lang` label is updated.
+   *
+   * @param _query The Mongoose query object used to find and update the document.
+   * @param setting The updated `Setting` object.
+   */
+  async postUpdate(
+    _query: Query<
+      Document<Setting, any, any>,
+      Document<Setting, any, any>,
+      unknown,
+      Setting,
+      'findOneAndUpdate'
+    >,
+    setting: Setting,
+  ) {
+    // Sync global settings var
+    this.eventEmitter.emit(
+      'hook:settings:' + setting.group + ':' + setting.label,
+      setting,
+    );
+
+    if (setting.label === 'default_lang') {
+      // @todo : check if this actually updates the default lang
+      this.i18n.resolveLanguage(setting.value as string);
+    }
+  }
+
+  /**
+   * Sets default values before creating a `Setting` document.
+   *
+   * If the setting is part of the `nlp_settings` group, it sets specific values
+   * for `languages` and `default_lang` labels, using configuration values from the
+   * chatbot settings.
+   *
+   * @param setting The `Setting` document to be created.
+   */
+  async preCreate(
+    setting: Document<unknown, unknown, Setting> &
+      Setting & { _id: Types.ObjectId },
+  ) {
+    if (setting.group === 'nlp_settings') {
+      if (setting.label === 'languages') {
+        setting.value = config.chatbot.lang.available;
+      } else if (setting.label === 'default_lang') {
+        setting.value = config.chatbot.lang.default;
+        setting.options = config.chatbot.lang.available;
+      }
+    }
+  }
+}