@wshcmx/types 10.0.0 → 11.0.0-rc.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Ivan Duplenskikh
+Copyright (c) 2024 umbrik
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,45 +1,31 @@
 <h1 align="center">WT Types</h1>
 <div align="center">
   Typescript типы для WebSoft HCM.
-  
-  [![main](https://github.com/umbrik/webtutor-types/actions/workflows/main.check.yml/badge.svg)](https://github.com/umbrik/webtutor-types/actions/workflows/main.check.yml)
-  ![npm](https://img.shields.io/npm/dw/@umbrik/webtutor-types)
-</div>
 
-## Зачем?
+  [![main](https://github.com/wshcmx/types/actions/workflows/main.check.yml/badge.svg)](https://github.com/wshcmx/types/actions/workflows/main.check.yml)
+  ![npm](https://img.shields.io/npm/dw/@wshcmx/types)
+</div>
 
-У вас могут возникнуть вопросы:
-- **_А для чего вообще создан этот репозиторий?_**
-- **_Что это за типы такие?_**
-- **_Зачем мне это все нужно?_**
+## Назначение
 
-Для того, чтобы писать чистый код с меньшим количеством ошибок был создан этот репозиторий с типами для объектов WebSoftHCM.
+Этот репозиторий создан для обеспечения чистого кода с меньшим количеством ошибок.
 
-Этот **npm** пакет позволяет добавить проверку типов и **IntelliSense** подсказки в ваши проект (см. [пример](#%EF%B8%8F-Пример-использования)).
+Он содержит типы для объектов WebSoftHCM, позволяя использовать проверку типов и IntelliSense-подсказки [в вашем проекте](#%EF%B8%8F-Пример-использования).
 
 ## 📦 Установка
 
-> **_Важно:_** типы работают только с **typescript<=4.4.4** в связи с тем, что при конкатенации строк **+** теперь превращается в **.concat** https://github.com/microsoft/TypeScript/pull/45304
-
-Установка типов сводится к установке самой зависимости в ваш проект и **typescript**:
+> [!CAUTION]
+> Для использования работы на проекте с typescript советуем использовать [cli](https://github.com/wshcmx/cli), который решает проблемы связанные с транспиляцией кода под платформу WebSoftHCM.
 
 ### npm
 
 ```bash
-npm i typescript@4.4.4 -D
-npm i @umbrik/webtutor-types -D
-```
-
-### or yarn
-
-```bash
-yarn add typescript@4.4.4 -D
-yarn add @umbrik/webtutor-types -D
+npm i @wshcmx/types -D
 ```
 
 ## 🔨 Настройка
 
-Типы можно использовать как в проектах, написанных с использованием **typescript**, так и в проектах, написанных на **javascript**.
+Типы можно использовать как в проектах, написанных с использованием ts, так и в проектах, написанных на js.
 
 Генерируем конфиг, либо просто создаем вручную файл **tsconfig.json**
 
@@ -52,19 +38,21 @@ npx tsc -init
 ```json
 {
   "compilerOptions": {
-    "target": "es5",
-    "module": "es6",
+    "target": "ES5",
+    "module": "Preserve",
     "esModuleInterop": true,
-    "strict": false,
+    "strict": true,
     "noImplicitAny": true,
     "allowJs": true,
-    "isolatedModules": true,
-    "moduleResolution": "node",
-    "baseUrl": "src",
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
     "noLib": true,
     "typeRoots": [
-      "node_modules/@umbrik/webtutor-types/lib",
-      "node_modules/@umbrik/webtutor-types/lib/xml"
+      "node_modules/@wshcmx/types/lib",
+      "node_modules/@wshcmx/types/lib/xml"
     ]
   }
 }
@@ -72,6 +60,6 @@ npx tsc -init
 
 ## ⌨️ Пример использования
 
-Примеры использования можно найти в [examples](/examples/)
+Примеры использования для js и ts можно найти в [examples](/examples/)
 
 ![image](https://github.com/HCM-guru/webtutor-types/assets/693254/aefa6c12-4479-4cab-a7e8-c29d880358b7)

package/lib/Lock/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Объект Lock предназначен для безопасного одновременного доступа к общим данным из нескольких потоков,
+ * если общие данные не являются thread-safe.
+ * Как правило, на каждую группу общих данных создается один объект Lock.
+ * Создание объекта обычно происходи один раз на старте приложения или библиотеки и хранится в глобальной переменной.
+ * Объект Lock используется в функциях:
+ * * {@link GetObjectPropertyWithLock}(),
+ * * {@link SetObjectPropertyWithLock}(),
+ * * {@link CallObjectMethodWithLock}()
+ */
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+interface Lock {
+
+}
+
+interface LockConstructor {
+  new(): unknown;
+  (): unknown;
+}
+
+ 
+declare const Lock: LockConstructor;

package/lib/SmtpClient/index.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Объект для работы по протоколу SMTP.
+ */
+interface SmtpClient {
+    /**
+     * Свойство UseTLS можно установить в true, чтобы SmtpClient автоматически переключался на защищенное соединение через команду "STARTTLS".
+     */
+    UseTLS: boolean;
+
+    /**
+     * Свойство UseTLSPort можно установить в true, чтобы SmtpClient подключался к серверу через защищенное соединение (TLS).
+     */
+    UseTLSPort: boolean;
+
+    /**
+     * Проходит процедуру авторизации.
+     * @param {string} login - Логин.
+     * @param {string} password - Пароль.
+     */
+    Authenticate(login: string, password: string ): unknown;
+
+    /**
+     * Закрывает SMTP-сессию и соединение.
+     */
+    CloseSession(): unknown;
+
+    /**
+     * Устанавливает соединение по протоколу SMTP с выполнением необходимых инициализационных команд.
+     * @param {string} server - Адрес сервера и порт.\
+     * @example smtpClient.OpenSession("server:465");
+     */
+    OpenSession(server: string): unknown;
+
+    /**
+     * Отправляет сообщение, переданное в виде объекта MailMessage.
+     * @param {string} message - Сообщение для передачи.
+     * @example
+     * ```
+     * message = new MailMessage();
+     * message.recipients.AddChild( email ).address = email;
+     * message.subject = 'Test';
+     * message.body = 'Test';
+     *
+     * smtpClient.SendMessage( message );
+     * ```
+     */
+    SendMessage(message: string): unknown;
+
+    /**
+     * Отправляет сообщение, переданное в формате MIME.
+     */
+    SendMimeMessage(): unknown;
+}
+
+interface SmtpClientConstructor {
+    new(): SmtpClient;
+    (): SmtpClient;
+}
+
+ 
+declare const SmtpClient: SmtpClientConstructor;

package/lib/arguments/index.d.ts

@@ -1,2 +1,2 @@
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 interface IArguments { }

package/lib/array/index.d.ts

@@ -25,8 +25,7 @@ interface Array<T> {
   /**
    * Добавляет элементы в конец массива.
    * Добавляет элементы, начиная с текущей длинны length и возвращает новую, увеличенную длунну массива.
-   * @param {any} element - Аргумент который следует добавить в массив. Обязательный.
-   * @param {...args} аргументы - Которые следует добавить в массив. Необязательный.
+   * @param {unknown[]} args - Аргументы, которые следует добавить в массив.
    * @returns {number}
    */
   push(...args: T[]): number;
@@ -44,5 +43,5 @@ interface ArrayConstructor {
   (...arg: unknown[]): unknown[];
 }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
+
 declare const Array: ArrayConstructor;

package/lib/binary/index.d.ts

@@ -32,7 +32,7 @@ interface Binary {
 
   /**
    * Добавляет в текущий бинарный объект данные из заданной строки.
-   * @param {string} str - Строка.
+   * @param {string} string - Строка.
    */
   AppendStr(string: string): undefined;
 
@@ -55,7 +55,7 @@ interface Binary {
 
   /**
    * Загружает в текущий бинарный объект данные из определенного url.
-   * @param url - (String).
+   * @param url - Url.
    */
   LoadFromUrl(url: string): undefined;
 
@@ -83,5 +83,5 @@ interface BinaryConstructor {
   (...arg: unknown[]): Binary;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
+
 declare const Binary: BinaryConstructor;

package/lib/boolean/index.d.ts

@@ -1,2 +1,2 @@
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 interface Boolean { }

package/lib/bufstream/index.d.ts

@@ -1,4 +1,5 @@
-/* eslint-disable @typescript-eslint/no-empty-interface */
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+ 
 
 /**
  * Конструктор объекта BufStream, позволяющего записывать данные в буфер в памяти как в поток.
@@ -9,5 +10,5 @@ interface BufStreamConstructor {
   new(): BufStream;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
+ 
 declare let BufStream: BufStreamConstructor;