Class UsersData

Модель для работы с пользовательскими данными. Предоставляет единый интерфейс для работы с данными пользователей во всех поддерживаемых платформах.

UsersData

Example

Сохранение прогресса пользователя:

class GameController extends BotController {
  public async action(intentName: string): Promise<void> {
    // Загрузка данных пользователя
    const userData = new UsersData(this.appContext);
    userData.userId = this.userId;

    // Если есть сохраненные данные - загружаем их
    if (await userData.getOne()) {
      const progress = userData.data.progress || 0;
      this.text = `Ваш текущий прогресс: ${progress}%`;
    } else {
      // Создаем новые данные
      userData.data = { progress: 0 };
      userData.meta = { firstVisit: new Date() };
      await userData.save();
      this.text = 'Добро пожаловать в игру!';
    }
  }
}

Example

Работа с разными платформами:

const userData = new UsersData(appContext);

// Для Алисы
userData.platform = T_ALISA;

// Для Telegram
userData.platform = T_TELEGRAM;

Hierarchy (View Summary)

Model<IUserDataModelState>
- UsersData

Index

Constructors

constructor

new UsersData(appContext: AppContext): UsersData
Создает экземпляр модели пользовательских данных. Предоставляет унифицированный интерфейс для хранения данных пользователя.
Parameters
- appContext: AppContext
Returns UsersData
Example
```
const userData = new UsersData(appContext);
userData.userId = 'user123';
userData.type = UsersData.T_TELEGRAM;
```
Overrides Model.constructor
- Defined in src/models/UsersData.ts:105

Properties

`Protected`_appContext

_appContext: AppContext

Контекст приложения.

queryData

queryData: IQuery

Объект для хранения параметров запроса. Содержит условия поиска и данные для обновления

startIndex

startIndex: number = 0

Начальный индекс для итерации по данным. Используется при инициализации модели из массива

state

state: Partial<TState> = {}

Состояние модели. Содержит текущие значения всех атрибутов

Example

// Установка значений
this.state.username = 'John';
this.state.age = 25;

// Получение значений
console.log(this.state.username);

`Static` `Readonly`TABLE_NAME

TABLE_NAME: "UsersData" = 'UsersData'

Название таблицы для хранения данных пользователей.

Accessors

data

get data(): any
Основные данные пользователя. Содержит основное состояние пользователя, например:
- Прогресс в игре
- Сохраненные настройки
- История действий
- Другие пользовательские данные
Returns any
Remarks
При сохранении в БД автоматически преобразуется в JSON строку
- Defined in src/models/UsersData.ts:162
set data(data: any): void
Устанавливает основные данные пользователя.
Parameters
- data: any
Returns void
- Defined in src/models/UsersData.ts:170

platform

get platform(): string
Тип платформы пользователя. Определяет платформу, с которой работает пользователь.

Returns string
- Defined in src/models/UsersData.ts:186
set platform(platform: string): void
Тип платформы пользователя. Определяет платформу, с которой работает пользователь.
Parameters
- platform: string
Returns void
- Defined in src/models/UsersData.ts:178

userId

get userId(): string | number | null | undefined
Уникальный идентификатор пользователя. Может быть строкой или числом в зависимости от платформы.

Returns string | number | null | undefined
Example
```
"123456789" для Telegram, 123456789 для VK
```
- Defined in src/models/UsersData.ts:120
set userId(userId: string | number | null): void
Устанавливает уникальный идентификатор пользователя.
Parameters
- userId: string | number | null
Returns void
- Defined in src/models/UsersData.ts:128

Methods

add

add(): Promise<boolean>
Добавляет новую запись в базу данных

Returns Promise<boolean>
Promise с результатом операции
Example
```
model.state.name = 'John';
await model.add();
```
Inherited from Model.add
- Defined in src/models/db/Model.ts:398

attributeLabels

attributeLabels(): IUserDataModelState
Возвращает описания атрибутов модели. Используется для отображения понятных названий полей.

Returns IUserDataModelState
Описания атрибутов
Overrides Model.attributeLabels
- Defined in src/models/UsersData.ts:228

destroy

destroy(): void
Закрывает соединение с базой данных

Returns void
Example
```
model.destroy();
```
Inherited from Model.destroy
- Defined in src/models/db/Model.ts:513

escapeString

escapeString(text: string | number): string
Экранирует специальные символы в строке
Parameters
- text: string | number
  Текст для экранирования
Returns string
Экранированная строка
Example
```
const safe = model.escapeString("O'Connor");
```
Inherited from Model.escapeString
- Defined in src/models/db/Model.ts:211

`Protected`getId

getId(): TKey
Определяет имя первичного ключа таблицы. Ищет поле с меткой 'id' или 'ID'

Returns TKey
Имя первичного ключа или null
Inherited from Model.getId
- Defined in src/models/db/Model.ts:241

getOne

getOne(): Promise<boolean>

Ищет одну запись в хранилище по текущим параметрам.

Returns Promise<boolean>

true, если запись найдена

Example

const userData = new UsersData(appContext);
userData.userId = 'user123';
if (await userData.getOne()) {
  console.log('Пользователь найден:', userData.data);
} else {
  console.log('Пользователь не найден');
}

init

init(data: IDbResult<unknown> | IDbResult<unknown>[] | null): void
Инициализирует модель данными. Преобразует JSON строки meta и data в объекты при загрузке из БД.
Parameters
- data: IDbResult<unknown> | IDbResult<unknown>[] | null
  Данные для инициализации
Returns void
Remarks
- При парсинге data, ошибки игнорируются для обеспечения обратной совместимости
- Парсинг происходит только если включено сохранение в БД (appContext.isSaveDb === true)
Example
```
const userData = new UsersData(appContext);
userData.init({
  userId: 'user123',
  meta: '{"lastVisit":"2024-03-20T12:00:00Z"}',
  data: '{"progress":75}',
  platform: T_TELEGRAM
});
console.log(userData.meta.lastVisit); // Date object
console.log(userData.data.progress); // 75
```
Overrides Model.init
- Defined in src/models/UsersData.ts:318

isConnected

isConnected(): boolean | Promise<boolean>
Проверяет состояние подключения к базе данных

Returns boolean | Promise<boolean>
Promise - true если подключение активно
Example
```
const isConnected = await model.isConnected();
if (isConnected) {
  // Выполнение операций с базой данных
}
```
Inherited from Model.isConnected
- Defined in src/models/db/Model.ts:193

query

query(callback: TQueryCb): unknown
Выполняет произвольный запрос к базе данных
Parameters
- callback: TQueryCb
  Функция обратного вызова для выполнения запроса
Returns unknown
Результат выполнения запроса
Example
```
const result = await model.query(async (client, db) => {
  const collection = db.collection('users');
  return await collection.aggregate([
    { $match: { age: { $gt: 18 } } },
    { $group: { _id: '$city', count: { $sum: 1 } } }
  ]).toArray();
});
```
Inherited from Model.query
- Defined in src/models/db/Model.ts:498

remove

remove(): Promise<boolean>
Удаляет запись из базы данных

Returns Promise<boolean>
Promise - true если удаление успешно
Example
```
await model.remove();
```
Inherited from Model.remove
- Defined in src/models/db/Model.ts:422

rules

rules(): IModelRules[]
Определяет правила валидации полей модели.

Returns IModelRules[]
Массив правил валидации
Overrides Model.rules
- Defined in src/models/UsersData.ts:204

save

save(isNew?: boolean): Promise<boolean>
Сохраняет данные модели в базу данных Если запись существует - обновляет, иначе создает новую
Parameters
- isNew: boolean = false
  Флаг создания новой записи
Returns Promise<boolean>
Promise с результатом операции
Example
```
model.state.name = 'John';
await model.save(); // Обновление существующей записи
await model.save(true); // Создание новой записи
```
Inherited from Model.save
- Defined in src/models/db/Model.ts:360

selectOne

selectOne(): Promise<ISelectOneModelRes>
Выполняет поиск записи по первичному ключу

Returns Promise<ISelectOneModelRes>
Promise с результатом запроса
Example
```
const result = await model.selectOne();
if (result.status) {
  model.init(result.data);
}
```
Inherited from Model.selectOne
- Defined in src/models/db/Model.ts:303

tableName

tableName(): string
Возвращает название таблицы/файла для хранения данных.

Returns string
Название таблицы для хранения данных пользователей
Overrides Model.tableName
- Defined in src/models/UsersData.ts:195

update

update(): Promise<boolean>
Обновляет существующую запись в базе данных

Returns Promise<boolean>
Promise с результатом операции
Example
```
model.state.name = 'John';
await model.update();
```
Inherited from Model.update
- Defined in src/models/db/Model.ts:379

validate

validate(): void
Валидирует значения перед сохранением. Преобразует объекты meta и data в JSON при сохранении в БД.

Returns void
Throws
Если данные не прошли валидацию
Example
```
userData.meta = { lastVisit: new Date() };
userData.data = { progress: 75 };
userData.validate(); // meta и data будут преобразованы в JSON
```
Overrides Model.validate
- Defined in src/models/UsersData.ts:286

where

where(
where?: string | IQueryData,
isOne?: boolean,
): Promise<IModelRes<IDataValue>>
Выполняет произвольный запрос к базе данных
Parameters
- where: string | IQueryData = '1'
  Условия запроса
- isOne: boolean = false
  Флаг выборки одной записи
Returns Promise<IModelRes<IDataValue>>
Promise с результатом запроса
Inherited from Model.where
- Defined in src/models/db/Model.ts:444

whereOne

whereOne(where?: string | IQueryData): Promise<boolean>
Выполняет запрос с выборкой одной записи
Parameters
- where: string | IQueryData = '1'
  Условия запроса
Returns Promise<boolean>
Promise - true если запись найдена
Example
```
const found = await model.whereOne({ id: 1 });
if (found) {
  console.log('Record found');
}
```
Inherited from Model.whereOne
- Defined in src/models/db/Model.ts:472

Class UsersData

Example

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UsersData

Example

Properties

Protected_appContext

queryData

startIndex

state

Example

Static ReadonlyTABLE_NAME

Accessors

data

Returns any

Remarks

Parameters

Returns void

meta

Returns any

Remarks

Parameters

Returns void

platform

Returns string

Parameters

Returns void

userId

Returns string | number | null | undefined

Example

Parameters

Returns void

Methods

add

Returns Promise<boolean>

Example

attributeLabels

Returns IUserDataModelState

destroy

Returns void

Example

escapeString

Parameters

Returns string

Example

ProtectedgetId

Returns TKey

getOne

Returns Promise<boolean>

Example

init

Parameters

Returns void

Remarks

Example

isConnected

Returns boolean | Promise<boolean>

Example

query

Parameters

Returns unknown

Example

remove

Returns Promise<boolean>

Example

rules

Returns IModelRules[]

save

Parameters

Returns Promise<boolean>

Example

`Protected`_appContext

`Static` `Readonly`TABLE_NAME

`Protected`getId