snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

packages/model-typings/src/models/ISettingsModel.ts

@@ -0,0 +1,63 @@
+import type { ISetting, ISettingColor, ISettingSelectOption, SettingValue } from '@rocket.chat/core-typings';
+import type { FindCursor, UpdateFilter, UpdateResult, Document, FindOneAndUpdateOptions, WithId, UpdateOptions } from 'mongodb';
+
+import type { IBaseModel } from './IBaseModel';
+import type { DocumentWithProjection, FindOptionsWithProjection } from '../types/DocumentWithProjection';
+
+export interface ISettingsModel extends IBaseModel<ISetting> {
+	getValueById<T extends SettingValue = SettingValue>(_id: string): Promise<T | undefined>;
+
+	findNotHidden(params?: { updatedAfter?: Date }): FindCursor<ISetting>;
+
+	findOneNotHiddenById(_id: string): Promise<ISetting | null>;
+
+	findByIds<T extends Document = ISetting, O extends FindOptionsWithProjection<T> = FindOptionsWithProjection<T>>(
+		_id?: string[] | string,
+		options?: O,
+	): FindCursor<DocumentWithProjection<T, O>>;
+
+	updateValueById(
+		_id: string,
+		value: (ISetting['value'] extends undefined ? never : ISetting['value']) | null,
+		options?: UpdateOptions,
+	): Promise<UpdateResult>;
+
+	resetValueById(
+		_id: string,
+		value?: (ISetting['value'] extends undefined ? never : ISetting['value']) | null,
+	): Promise<Document | UpdateResult | undefined>;
+
+	incrementValueById(_id: ISetting['_id'], value?: ISetting['value'], options?: FindOneAndUpdateOptions): Promise<null | WithId<ISetting>>;
+
+	updateOptionsById<T extends ISetting = ISetting>(
+		_id: ISetting['_id'],
+		options: UpdateFilter<T>['$set'],
+	): Promise<Document | UpdateResult>;
+
+	updateValueNotHiddenById<T extends ISetting['value'] = ISetting['value']>(
+		_id: ISetting['_id'],
+		value: T,
+	): Promise<Document | UpdateResult>;
+
+	updateValueAndEditorById<T extends ISetting['value'] = ISetting['value']>(
+		_id: ISetting['_id'],
+		value: T,
+		editor: ISettingColor['editor'],
+	): Promise<Document | UpdateResult>;
+
+	findNotHiddenPublic<T extends ISetting = ISetting>(
+		ids?: ISetting['_id'][],
+	): FindCursor<
+		T extends ISettingColor
+			? Pick<T, '_id' | 'value' | 'editor' | 'enterprise' | 'invalidValue' | 'modules' | 'requiredOnWizard'>
+			: Pick<T, '_id' | 'value' | 'enterprise' | 'invalidValue' | 'modules' | 'requiredOnWizard'>
+	>;
+
+	findSetupWizardSettings(): FindCursor<ISetting>;
+
+	findEnterpriseSettings(): FindCursor<ISetting>;
+
+	addOptionValueById(_id: ISetting['_id'], option: ISettingSelectOption): Promise<Document | UpdateResult>;
+
+	findNotHiddenPublicUpdatedAfter(updatedAt: Date): FindCursor<ISetting>;
+}