@wshcmx/types 10.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+🤝 Как сделать вклад?
+
+1. Клонируй репозиторий
+2. Делай правку
+3. Создавай PR

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ivan Duplenskikh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,77 @@
+<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>
+
+## Зачем?
+
+У вас могут возникнуть вопросы:
+- **_А для чего вообще создан этот репозиторий?_**
+- **_Что это за типы такие?_**
+- **_Зачем мне это все нужно?_**
+
+Для того, чтобы писать чистый код с меньшим количеством ошибок был создан этот репозиторий с типами для объектов WebSoftHCM.
+
+Этот **npm** пакет позволяет добавить проверку типов и **IntelliSense** подсказки в ваши проект (см. [пример](#%EF%B8%8F-Пример-использования)).
+
+## 📦 Установка
+
+> **_Важно:_** типы работают только с **typescript<=4.4.4** в связи с тем, что при конкатенации строк **+** теперь превращается в **.concat** https://github.com/microsoft/TypeScript/pull/45304
+
+Установка типов сводится к установке самой зависимости в ваш проект и **typescript**:
+
+### 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
+```
+
+## 🔨 Настройка
+
+Типы можно использовать как в проектах, написанных с использованием **typescript**, так и в проектах, написанных на **javascript**.
+
+Генерируем конфиг, либо просто создаем вручную файл **tsconfig.json**
+
+```bash
+npx tsc -init
+```
+
+Далее обновляем конфиг:
+
+```json
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "es6",
+    "esModuleInterop": true,
+    "strict": false,
+    "noImplicitAny": true,
+    "allowJs": true,
+    "isolatedModules": true,
+    "moduleResolution": "node",
+    "baseUrl": "src",
+    "noLib": true,
+    "typeRoots": [
+      "node_modules/@umbrik/webtutor-types/lib",
+      "node_modules/@umbrik/webtutor-types/lib/xml"
+    ]
+  }
+}
+```
+
+## ⌨️ Пример использования
+
+Примеры использования можно найти в [examples](/examples/)
+
+![image](https://github.com/HCM-guru/webtutor-types/assets/693254/aefa6c12-4479-4cab-a7e8-c29d880358b7)

package/lib/.eslintrc.json

@@ -0,0 +1,54 @@
+{
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "@umbrik/eslint-config-hcm-wt"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "project": "./tsconfig.json",
+    "tsconfigRootDir": "lib"
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "jsdoc"
+  ],
+  "rules": {
+    "max-len": "off",
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/no-empty-interface": "off",
+    "jsdoc/check-alignment": "error",
+    "jsdoc/check-indentation": "error",
+    "jsdoc/check-param-names": "error",
+    "jsdoc/check-property-names": "error",
+    "jsdoc/check-types": "error",
+    "jsdoc/no-blank-block-descriptions": "error",
+    "jsdoc/no-multi-asterisks": "error",
+    "jsdoc/require-asterisk-prefix": "error",
+    "jsdoc/require-description": "error",
+    "jsdoc/require-hyphen-before-param-description": "error",
+    "jsdoc/require-jsdoc": "error",
+    "jsdoc/require-param": "error",
+    "jsdoc/require-param-description": "error",
+    "jsdoc/require-param-name": "error",
+    "jsdoc/require-param-type": "error",
+    "jsdoc/check-access": "error",
+    "jsdoc/check-values": "error",
+    "jsdoc/empty-tags": "error",
+    "jsdoc/implements-on-classes": "error",
+    "jsdoc/multiline-blocks": "error",
+    "jsdoc/require-property": "error",
+    "jsdoc/require-property-description": "error",
+    "jsdoc/require-property-name": "error",
+    "jsdoc/require-property-type": "error",
+    "jsdoc/require-returns": "error",
+    "jsdoc/require-returns-check": "error",
+    "jsdoc/require-returns-description": "error",
+    "jsdoc/require-returns-type": "error",
+    "jsdoc/require-yields": "error",
+    "jsdoc/require-yields-check": "error",
+    "jsdoc/tag-lines": "error"
+  }
+}

package/lib/_/index.d.ts

@@ -0,0 +1 @@
+type WebtutorCharsets = "windows-1251" | "windows-1252" | "utf-8" | "utf-16" | "koi8-r" | "cp-866";

package/lib/activexobject/index.d.ts

@@ -0,0 +1,15 @@
+type ActiveXObjectType = {
+  "ADODB.Command": ADODB.Command;
+  "ADODB.Connection": ADODB.Connection;
+  "ADODB.Parameter": ADODB.Parameter;
+  "ADODB.Record": ADODB.Record;
+  "ADODB.Recordset": ADODB.Recordset;
+  "ADODB.Stream": ADODB.Stream;
+};
+
+interface ActiveXObjectConstructor {
+  new<T extends keyof ActiveXObjectType>(name: T): ActiveXObjectType[T];
+  <T extends keyof ActiveXObjectType>(name: T): ActiveXObjectType[T];
+}
+
+declare const ActiveXObject: ActiveXObjectConstructor;