@cntwg/xml-lib-js 0.0.36-b → 0.0.37-b

package/CHANGELOG.md

@@ -2,7 +2,10 @@
 
 Pre-release version.
 
+> - update `xmldoc-lib.md`;
 > - update dependency on `@ygracs/xml-js6` module to v0.0.6-b;
+> - update dependency on `@cntwg/file-helper` module to v0.0.3;
+> - update dependency on `@ygracs/bsfoc-lib-js` module to v0.3.3;
 
 #### *v0.0.35*
 

package/doc/xmldoc-lib.md

@@ -1,6 +1,6 @@
->|***rev.*:**|0.1.41|
+>|***rev.*:**|0.1.43|
 >|:---|---:|
->|date:|2025-08-23|
+>|date:|2026-01-18|
 
 ## Introduction
 
@@ -20,9 +20,9 @@ This descriptor is an `object` that describes a status for an operation with som
 | `isERR` | `boolean` | no | a flag which indicates whether an error was happen |
 | `errCode` | `number` | yes | an error code |
 | `errEvent` | `string` | no | an error event identifier |
-| `errMsg` | `string` | no | an error message |
-| `source` | `string` | no | path to a file |
-| `content` | `any` | no | content |
+| `errMsg` | `string` | yes | an error message |
+| `source` | `string` | yes | path to a file |
+| `content` | `any` | yes | content |
 
 ## Module constants
 
@@ -702,7 +702,7 @@ If `object` parameter is not a type of `object` or not given a `TypeError` throw
 
 #### class methods (*special*)
 
-##### **init()** => `boolean`
+##### **init()** => `void`
 
 This method initializes an element with a default values.
 

package/index.d.ts

@@ -1,37 +1,40 @@
-import xObj = require("@ygracs/xobj-lib-js");
-import xmlHelper = require("./lib/xml-helper");
-import xmldoc = require("./lib/xmldoc-lib");
-
-import {
-  readAsTagName,
-  readAsAttrName,
-  readAsAttrValue,
-  valueToElementID,
-} from "./lib/xml-base";
-
-import {
-  XML_DEF_PARSE_OPTIONS,
-  XML_DEF_ROOT_ETAG_NAME, XML_LANG_ATTR_TNAME,
-  TXmlContentParseOptions,
-  TXmlAttributesMapper,
-  TXmlElementController, TXmlElementsListController,
-  TXmlContentDeclaration,
-  TXmlContentRootElement,
-  TXmlContentContainer,
-} from "./lib/xmldoc-lib";
-
-export {
-  xObj, xmlHelper, xmldoc as xmlDoc,
-  readAsTagName,
-  readAsAttrName,
-  readAsAttrValue,
-  valueToElementID,
-  XML_DEF_PARSE_OPTIONS,
-  XML_DEF_ROOT_ETAG_NAME, XML_LANG_ATTR_TNAME,
-  TXmlContentParseOptions,
-  TXmlAttributesMapper,
-  TXmlElementController, TXmlElementsListController,
-  TXmlContentDeclaration,
-  TXmlContentRootElement,
-  TXmlContentContainer,
-};
+import xObj = require("@ygracs/xobj-lib-js");
+import xmlHelper = require("./lib/xml-helper");
+import xmldoc = require("./lib/xmldoc-lib");
+
+import {
+  readAsTagName,
+  readAsAttrName,
+  readAsAttrValue,
+  valueToElementID,
+} from "./lib/xml-base";
+
+import {
+  XML_DEF_PARSE_OPTIONS,
+  XML_DEF_ROOT_ETAG_NAME, XML_LANG_ATTR_TNAME,
+  TXmlContentParseOptions,
+  TXmlAttributesMapper,
+  TXmlElementController, TXmlElementsListController,
+  TXmlContentDeclaration,
+  TXmlContentRootElement,
+  TXmlContentContainer,
+} from "./lib/xmldoc-lib";
+
+export {
+  xObj, xmlHelper, xmldoc as xmlDoc,
+  readAsTagName,
+  readAsAttrName,
+  readAsAttrValue,
+  valueToElementID,
+  XML_DEF_PARSE_OPTIONS,
+  XML_DEF_ROOT_ETAG_NAME, XML_LANG_ATTR_TNAME,
+  TXmlContentParseOptions,
+  TXmlAttributesMapper,
+  TXmlElementController, TXmlElementsListController,
+  TXmlContentDeclaration,
+  TXmlContentRootElement,
+  TXmlContentContainer,
+};
+
+import type { fsoDescr } from '@cntwg/file-helper';
+export type { fsoDescr };

package/index.js

@@ -7,6 +7,11 @@ const xmldoc = require('./lib/xmldoc-lib');
 const xmlHelper = require('./lib/xml-helper');
 const xmlBase = require('./lib/xml-base');
 
+const {
+  // * import types definitions *
+  fsoDescr,
+} = require('@cntwg/file-helper');
+
 // === module inner block ===
 
 // === module main block ===
@@ -34,3 +39,7 @@ module.exports.TXmlElementsListController = xmldoc.TXmlElementsListController;
 module.exports.TXmlContentDeclaration = xmldoc.TXmlContentDeclaration;
 module.exports.TXmlContentRootElement = xmldoc.TXmlContentRootElement;
 module.exports.TXmlContentContainer = xmldoc.TXmlContentContainer;
+
+// * export types definitions *
+// @ts-ignore
+module.exports.fsoDescr = fsoDescr;

package/lib/xml-base.d.ts

@@ -1,22 +1,22 @@
-/**
- * Tries to convert a given value to a valid tag name of an XML-element.
- * @since v0.0.28
- */
-export function readAsTagName(value: any): string;
-/**
- * Tries to convert a given value to a valid name of an XML-attribute.
- * @since v0.0.28
- */
-export function readAsAttrName(value: any): string;
-/**
- * Tries to convert a given value to a valid "attribute value".
- * @since v0.0.35
- */
-export function readAsAttrValue(value: any): string | null;
-/**
- * Tries to convert a given value to a valid identifier
- * suitable as a value for an "ID-attribute" of an XML-element.
- * @since v0.0.28
- * @see valueToIDString
- */
-export function valueToElementID(value: any): string;
+/**
+ * Tries to convert a given value to a valid tag name of an XML-element.
+ * @since v0.0.28
+ */
+export function readAsTagName(value: any): string;
+/**
+ * Tries to convert a given value to a valid name of an XML-attribute.
+ * @since v0.0.28
+ */
+export function readAsAttrName(value: any): string;
+/**
+ * Tries to convert a given value to a valid "attribute value".
+ * @since v0.0.35
+ */
+export function readAsAttrValue(value: any): string | null;
+/**
+ * Tries to convert a given value to a valid identifier
+ * suitable as a value for an "ID-attribute" of an XML-element.
+ * @since v0.0.28
+ * @see valueToIDString
+ */
+export function valueToElementID(value: any): string;

package/lib/xml-helper.d.ts

@@ -1,18 +1,18 @@
-/**
- * Tries to get a child element.
- */
-export function getChildByPath(obj: TXmlElementController, chain: string[]): TXmlElementController | null;
-/**
- * Tries to get a child element.
- */
-export function addChildByPath(obj: TXmlElementController, chain: string[]): TXmlElementController | null;
-/**
- * Reads a text values from a given XML-element.
- */
-export function extractTextValues(obj: TXmlElementController | TXmlElementsListController): string[];
-/**
- * Reads a text values with a `lang` attribute from a given XML-element.
- */
-export function extractTextValuesLn(obj: TXmlElementController | TXmlElementsListController): any[];
-import { TXmlElementController } from "./xmldoc-lib";
-import { TXmlElementsListController } from "./xmldoc-lib";
+/**
+ * Tries to get a child element.
+ */
+export function getChildByPath(obj: TXmlElementController, chain: string[]): TXmlElementController | null;
+/**
+ * Tries to get a child element.
+ */
+export function addChildByPath(obj: TXmlElementController, chain: string[]): TXmlElementController | null;
+/**
+ * Reads a text values from a given XML-element.
+ */
+export function extractTextValues(obj: TXmlElementController | TXmlElementsListController): string[];
+/**
+ * Reads a text values with a `lang` attribute from a given XML-element.
+ */
+export function extractTextValuesLn(obj: TXmlElementController | TXmlElementsListController): any[];
+import { TXmlElementController } from "./xmldoc-lib";
+import { TXmlElementsListController } from "./xmldoc-lib";