@wshcmx/types 10.0.0 → 11.0.0-rc.1

package/lib/xmlelem/index.d.ts

@@ -373,7 +373,7 @@ interface XmElem<T, ForeignElem = never> {
   /**
    * Добавляет уже созданный элемент в качестве в качестве дочернего по отношению к текущему элементу.
    * Аргументом может быть элемент, уже созданный каким-либо образом, например, через функцию {@link CrateElem}.
-   * @param {XmlElem<T>} elem - Созданный заранее элемент.
+   * @param {XmlElem<T>} element - Созданный заранее элемент.
    */
   AddChildElem(element: XmlElem<T>): void;
 
@@ -468,7 +468,7 @@ interface XmElem<T, ForeignElem = never> {
    * и возвращает вычисленное значение.
    * @param {string} name - Имя дочернего элемента, метода или атрибута.
    */
-  ChildValue(): T;
+  ChildValue(name: string): T;
 
   /**
    * Очищает значение данного элемента и его дочерних элементов.
@@ -597,10 +597,7 @@ interface XmElem<T, ForeignElem = never> {
    * Проверяет, существует ли в форме текущего элемента дочерний элемент с таким именем,
    * не являющийся методом.
    * @param {string} name - Имя дочернего элемента.
-   * @example
-   * ```
-   * elem.FormChildExists("xxx") ↔ elem.Form.ChildExists("xxx") && !elem.Form.Child("xxx").IsMethod
-   * ```
+   * @example elem.FormChildExists("xxx") ↔ elem.Form.ChildExists("xxx") && !elem.Form.Child("xxx").IsMethod
    */
   FormChildExists(name: string): boolean;
 
@@ -725,7 +722,7 @@ interface XmElem<T, ForeignElem = never> {
    * содержащей данные в формате XML.
    * Из строки подгружаются только те данные, которые присутствуют в исходном XML.
    * Если необходимо полностью синхронизировать элемент с данными из строки,
-   * перед вызовом данного метода необходимо вызывать метод {@link Clear}().
+   * перед вызовом данного метода необходимо вызывать метод {@link Clear}.
    * @param {string} data - Строка, содержащая данные в формате XML.
    */
   LoadData(data: string): void;
@@ -789,9 +786,9 @@ interface XmElem<T, ForeignElem = never> {
    * возвращает значенеи второго аргумента, если втрой аргумент
    * не указан - возвращает пустую строку.
    * @param {string} name - Имя атрибута.
-   * @param {string} defaultVal - Строка, возвращаемая при отсутствии заданного атрибута.
+   * @param {string} defaultValue - Строка, возвращаемая при отсутствии заданного атрибута.
    */
-  OptAttrValue(name: string, value?: string): string;
+  OptAttrValue(name: string, defaultValue?: string): string;
 
   /**
    * Возвращает дочерний элемент. Находит дочерний элемент по имени.
@@ -870,7 +867,7 @@ interface XmElem<T, ForeignElem = never> {
   /**
    * Очищает содержимое элемента и загружает новое из строки, содержащей XML.
    * Имя корневого элемента в XML должно совпадать с именем текущего элемента.
-   * {@link SetInnerXml}().
+   * {@link SetInnerXml}.
    * @param {string} xml - Xml строка.
    */
   SetXml(xml: string): void;
@@ -879,10 +876,9 @@ interface XmElem<T, ForeignElem = never> {
    * Сортирует дочерние элементы в заданном порядке.
    * Метод должен содержать четное число аргументов.
    * Каждая пара аргументов соответствует параметрам сортировки.
-   * @param {string} name - Выражение, относительно которого производится сортировка.
-   * @param {string} order - Направление сортировки: `+` или `-`.
+   * @param {string} argsAndOrders - Поочередно выражения, относительно которых производится сортировка, и направления сортировки: `+` или `-`.
    */
-  Sort(...args: string[]): void;
+  Sort(...argsAndOrders: string[]): void;
 
   /**
    * Вызывает принудительный пересчет всех подэлементов текущего элемента.

package/lib/xmlformelem/index.d.ts

@@ -222,7 +222,7 @@ interface XmlFormElem {
    * Проверяет, существует ли дочерний элемент с заданым именем.
    * @param {string} name - Имя элемента.
    */
-  ChildExists(): boolean;
+  ChildExists(name: string): boolean;
 
   /**
    * Создает клон текущего элемента формы и возвращает ссылку на него.
@@ -259,8 +259,8 @@ interface XmlFormElem {
   /**
    * Метод возвращает элемент формы вниз по иерархии с заданным путем относительно текущего элемента.
    * Если элемент не найден, возвращает undefined.
-   * Если в аргументе path передать имя элемента (без "." ), то метод будет работать также как {@link OptChild}.
-   * @param {string} path - Путь к элементу (через "." ).
+   * Если в аргументе path передать имя элемента (без "."), то метод будет работать также как {@link OptChild}.
+   * @param {string} path - Путь к элементу (через ".").
    */
   EvalOptPath(path: string): XmlFormElem | never;
 

package/package.json

@@ -1,43 +1,42 @@
 {
   "name": "@wshcmx/types",
-  "version": "10.0.0",
+  "version": "11.0.0-rc.1",
+  "type": "module",
   "directories": {
     "lib": "lib"
   },
   "scripts": {
-    "lint": "eslint -c ./lib/.eslintrc.json lib",
+    "check": "npm run lint:lib && npm run lint:tests && npm run tsc:lib && npm run tsc:tests",
+    "lint:lib": "eslint -c ./lib/eslint.config.js lib",
+    "lint:tests": "eslint -c ./tests/eslint.config.js tests",
     "tsc:lib": "tsc -p lib/tsconfig.json",
     "tsc:tests": "tsc -p tests/tsconfig.json",
-    "check": "npm run lint && npm run tsc:lib && npm run tsc:tests",
-    "version:check": "node ci/version-check.js"
+    "prepare": "husky"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/umbrik/webtutor-types.git"
+    "url": "git+https://github.com/wshcmx/types.git"
   },
   "keywords": [
     "types",
     "websoft",
     "webtutor",
     "webtutor-types",
+    "wxhcmx",
+    "wxhcmx-types",
     "wt"
   ],
-  "author": "",
-  "license": "ISC",
+  "author": "umbrik",
+  "license": "MIT",
   "bugs": {
-    "url": "https://github.com/umbrik/webtutor-types/issues"
+    "url": "https://github.com/wshcmx/types/issues"
   },
-  "homepage": "https://github.com/umbrik/webtutor-types#readme",
+  "homepage": "https://github.com/wshcmx/types#readme",
   "devDependencies": {
-    "@types/node": "^20.4.5",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^5.26.0",
-    "@umbrik/eslint-config-hcm-wt": "^1.5.0",
-    "eslint": "^8.17.0",
-    "eslint-plugin-jsdoc": "^46.4.5",
-    "eslint-plugin-no-for-of-loops": "^1.0.1",
-    "semver": "^7.6.2",
-    "typescript": "^5.6.3",
-    "typescript-eslint": "^7.13.0"
+    "eslint": "^9.22.0",
+    "eslint-plugin-jsdoc": "^50.6.6",
+    "husky": "^9.1.7",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.26.1"
   }
 }

package/scripts/check-version.sh

@@ -0,0 +1,3 @@
+localVersion=$(cat package.json | jq -r '.version')
+masterVersion=$(git show origin/main:package.json | jq -r '.version')
+[ "${localVersion}" = "`echo -e "${localVersion}\n${masterVersion}" | sort -V | head -n1`" ] && echo 'Package version should be upgraded' && exit 1 || exit 0

package/lib/.eslintrc.json

@@ -1,54 +0,0 @@
-{
-  "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/defaultdb/index.d.ts

@@ -1,27 +0,0 @@
-interface DefaultDb {
-  Name: string;
-  UseObjectTypes: boolean;
-  UseSqlStorage: boolean;
-  UseFtV2: boolean;
-  SqlConnection: never;
-  IsShared: boolean;
-  /** /WebsoftServer/wt_data. */
-  StorageDirectory: string;
-  ObjectForms: unknown[];
-  SharedDocs: Object;
-  // HostDir: T;
-  RegisterObjectType(urlScheme: string, object: Object): void;
-  RegisterCatalog(urlScheme: string): never | undefined;
-  OpenObjectDoc<T extends XmlDocument>(catalogName: string, id: number): T;
-  OpenNewObjectDoc<T extends XmlDocument>(objectName: string): T;
-  DeleteObjectDoc(objectName: string, objectId: number, bool?: boolean): void;
-  ChangeObjectFields(arg: object): object;
-  UpdateObjectSecondaryData(arg: object): object;
-  GetObjectForm<T>(name: string): T;
-  GetOptCatalog<T>(catalogName: string): T;
-  GetRecordPrimaryObjectUrl(object: object): string;
-  RunSql(cmd: string): unknown;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-declare const DefaultDb: DefaultDb;

package/lib/xml/closing_document_statu_catalog/index.d.ts

@@ -1,11 +0,0 @@
-type ClosingDocumentStatuCatalogDocumentTopElem = XmlTopElem &
-CustomElemsBase & {
-  id: XmlElem<number | null>;
-  code: XmlElem<string | null>;
-  name: XmlElem<string | null>;
-  /** Комментарий */
-  comment: XmlElem<string | null>;
-  /** Информация об объекте */
-  doc_info: XmlElem<DocInfoBase | null>;
-  DocDesc(): string;
-};

package/temp/package.json

@@ -1,43 +0,0 @@
-{
-  "name": "@umbrik/webtutor-types",
-  "version": "9.8.0",
-  "directories": {
-    "lib": "lib"
-  },
-  "scripts": {
-    "lint": "eslint -c ./lib/.eslintrc.json lib",
-    "tsc:lib": "tsc -p lib/tsconfig.json",
-    "tsc:tests": "tsc -p tests/tsconfig.json",
-    "check": "npm run lint && npm run tsc:lib && npm run tsc:tests",
-    "version:check": "node ci/version-check.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/umbrik/webtutor-types.git"
-  },
-  "keywords": [
-    "types",
-    "websoft",
-    "webtutor",
-    "webtutor-types",
-    "wt"
-  ],
-  "author": "",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/umbrik/webtutor-types/issues"
-  },
-  "homepage": "https://github.com/umbrik/webtutor-types#readme",
-  "devDependencies": {
-    "@types/node": "^20.4.5",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^5.26.0",
-    "@umbrik/eslint-config-hcm-wt": "^1.5.0",
-    "eslint": "^8.17.0",
-    "eslint-plugin-jsdoc": "^46.4.5",
-    "eslint-plugin-no-for-of-loops": "^1.0.1",
-    "semver": "^7.6.2",
-    "typescript": "4.4.4",
-    "typescript-eslint": "^7.13.0"
-  }
-}