@e-mc/document 0.8.17 → 0.8.18

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2024 An Pham
-
-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.
-
+Copyright 2024 An Pham
+
+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

@@ -1,99 +1,99 @@
-# @e-mc/document
-
-* NodeJS 14
-* ES2019
-
-## General Usage
-
-* [Read the Docs](https://e-mc.readthedocs.io)
-
-## Interface
-
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/index.d.ts
-
-```typescript
-import type { DataSource, ViewEngine } from "./squared";
-
-import type { IFileManager, IScopeOrigin } from "./index";
-import type { ExternalAsset, FileCommand, IFileThread, OutputFinalize } from "./asset";
-import type { HostInitConfig, IClient } from "./core";
-import type { AsSourceFileOptions, ConfigOrTransformer, CustomizeOptions, GenerateLintTableOptions, LintMessage, PluginConfig, SourceCode, SourceInput, SourceMap, SourceMapOptions, TransformAction, TransformCallback, TransformOutput, TransformResult, UpdateGradleOptions } from "./document";
-import type { PostFinalizeCallback } from "./filemanager";
-import type { LogComponent } from "./logger";
-import type { DocumentComponent, DocumentComponentOption, DocumentModule } from "./settings";
-import type { IFileGroup, WatchInitResult } from "./watch";
-
-interface IDocument extends IClient<IFileManager, DocumentModule, TransformCallback<IFileManager, ExternalAsset>> {
-    Db: IDb | null;
-    assets: ExternalAsset[];
-    config: Record<string, any>;
-    init(assets: ExternalAsset[], config?: HostInitConfig): this;
-    customize(options?: CustomizeOptions): void;
-    findConfig(data: object, name: string, type?: string): PluginConfig;
-    loadConfig(data: object, name: string): ConfigOrTransformer | null | undefined;
-    asSourceFile(value: string, options?: AsSourceFileOptions | boolean): unknown;
-    findVersion(name: string | string[], fallback?: string): string;
-    findSourceScope(uri: string, imports: Record<string, unknown>): Record<string, string | undefined>[];
-    findSourceRoot(uri: string, imports?: Record<string, string | undefined>): string | undefined;
-    resolveDir(name: string, ...paths: string[]): string | undefined;
-    locateSourceFiles(file: ExternalAsset, code?: string, bundleContent?: string[]): (imports?: Record<string, string | undefined>) => SourceInput | undefined;
-    resolveSourceFile(file: ExternalAsset): (code?: string, imports?: Record<string, string | undefined>) => SourceInput<string> | undefined;
-    tryParse(source: string, format: string, options?: Record<string | number | symbol, unknown>): unknown;
-    forDb(item: DataSource): boolean;
-    hasEval(name: string): boolean;
-    settingsOf(name: keyof DocumentComponent, option: keyof DocumentComponentOption): unknown;
-    parseTemplate(viewEngine: ViewEngine | string, template: string, data: unknown[]): Promise<string | null>;
-    transform(type: string, code: string, format: string | string[], options?: TransformOutput & TransformAction): Promise<TransformResult | void>;
-    abort(name?: keyof DocumentComponent | Error, reason?: unknown): void;
-    restart(): void;
-    using?(data: IFileThread): Promise<unknown>;
-    setLocalUri?(file: ExternalAsset, replace?: boolean): void;
-    resolveUri?(file: ExternalAsset, source: string): string;
-    resolveUri?(file: ExternalAsset, source: string, trailing: string): [string, string];
-    resolveImports?(file: ExternalAsset, code: string, baseFile?: string | ExternalAsset): string | undefined;
-    replaceContent?(source: string, statement: RegExpExecArray | string, mimeType?: string): string | undefined;
-    addCopy?(data: FileCommand<ExternalAsset>, saveAs: string, replace?: boolean): string | undefined;
-    writeImage?(output: OutputFinalize<ExternalAsset>): boolean;
-    cloudInit?(state: IScopeOrigin<IFileManager, ICloud>): void;
-    cloudObject?(state: IScopeOrigin<IFileManager, ICloud>, file: ExternalAsset): boolean;
-    cloudUpload?(state: IScopeOrigin<IFileManager, ICloud>, file: ExternalAsset, url: string, active: boolean): Promise<boolean>;
-    cloudFinalize?(state: IScopeOrigin<IFileManager, ICloud>): Promise<unknown[]>;
-    watchInit?(watch: IFileGroup<ExternalAsset>, assets: ExternalAsset[], sanitize?: boolean): WatchInitResult | undefined;
-    watchModified?(watch: IFileGroup<ExternalAsset>, assets?: ExternalAsset[]): PostFinalizeCallback;
-    set dataSource(value: DataSource[]);
-    get dataSource(): DataSource[];
-    set imports(value);
-    get imports(): Record<string, string | undefined>;
-    get watching(): boolean;
-}
-
-interface DocumentConstructor extends ModuleConstructor {
-    finalize(this: IFileManager, instance: IDocument): Promise<unknown>;
-    createSourceMap(code: string, remove: boolean): SourceMap;
-    createSourceMap(code: string, uri?: string, remove?: boolean): SourceMap;
-    writeSourceMap(uri: string, data: SourceCode, options?: SourceMapOptions): string | undefined;
-    updateGradle(source: string, namespaces: string[], value: string, options?: UpdateGradleOptions | boolean): string;
-    generateLintTable(messages: LintMessage[], options: GenerateLintTableOptions): LogComponent[];
-    /* @deprecated - IDocument.using */
-    using?(this: IFileManager, instance: IDocument, file: ExternalAsset): Promise<unknown>;
-    cleanup?(this: IFileManager, instance: IDocument): Promise<unknown>;
-    sanitizeAssets?(assets: ExternalAsset[], exclusions?: ExternalAsset[]): ExternalAsset[];
-    readonly prototype: IDocument;
-    new(module?: DocumentModule, ...args: unknown[]): IDocument;
-}
-```
-
-## References
-
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/squared.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/asset.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/document.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/filemanager.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/settings.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/watch.d.ts
-
-## LICENSE
-
+# @e-mc/document
+
+* NodeJS 14
+* ES2019
+
+## General Usage
+
+* [Read the Docs](https://e-mc.readthedocs.io)
+
+## Interface
+
+- https://www.unpkg.com/@e-mc/types@0.8.18/lib/index.d.ts
+
+```typescript
+import type { DataSource, ViewEngine } from "./squared";
+
+import type { IFileManager, IScopeOrigin } from "./index";
+import type { ExternalAsset, FileCommand, IFileThread, OutputFinalize } from "./asset";
+import type { HostInitConfig, IClient } from "./core";
+import type { AsSourceFileOptions, ConfigOrTransformer, CustomizeOptions, GenerateLintTableOptions, LintMessage, PluginConfig, SourceCode, SourceInput, SourceMap, SourceMapOptions, TransformAction, TransformCallback, TransformOutput, TransformResult, UpdateGradleOptions } from "./document";
+import type { PostFinalizeCallback } from "./filemanager";
+import type { LogComponent } from "./logger";
+import type { DocumentComponent, DocumentComponentOption, DocumentModule } from "./settings";
+import type { IFileGroup, WatchInitResult } from "./watch";
+
+interface IDocument extends IClient<IFileManager, DocumentModule, TransformCallback<IFileManager, ExternalAsset>> {
+    Db: IDb | null;
+    assets: ExternalAsset[];
+    config: Record<string, any>;
+    init(assets: ExternalAsset[], config?: HostInitConfig): this;
+    customize(options?: CustomizeOptions): void;
+    findConfig(data: object, name: string, type?: string): PluginConfig;
+    loadConfig(data: object, name: string): ConfigOrTransformer | null | undefined;
+    asSourceFile(value: string, options?: AsSourceFileOptions | boolean): unknown;
+    findVersion(name: string | string[], fallback?: string): string;
+    findSourceScope(uri: string, imports: Record<string, unknown>): Record<string, string | undefined>[];
+    findSourceRoot(uri: string, imports?: Record<string, string | undefined>): string | undefined;
+    resolveDir(name: string, ...paths: string[]): string | undefined;
+    locateSourceFiles(file: ExternalAsset, code?: string, bundleContent?: string[]): (imports?: Record<string, string | undefined>) => SourceInput | undefined;
+    resolveSourceFile(file: ExternalAsset): (code?: string, imports?: Record<string, string | undefined>) => SourceInput<string> | undefined;
+    tryParse(source: string, format: string, options?: Record<string | number | symbol, unknown>): unknown;
+    forDb(item: DataSource): boolean;
+    hasEval(name: string): boolean;
+    settingsOf(name: keyof DocumentComponent, option: keyof DocumentComponentOption): unknown;
+    parseTemplate(viewEngine: ViewEngine | string, template: string, data: unknown[]): Promise<string | null>;
+    transform(type: string, code: string, format: string | string[], options?: TransformOutput & TransformAction): Promise<TransformResult | void>;
+    abort(name?: keyof DocumentComponent | Error, reason?: unknown): void;
+    restart(): void;
+    using?(data: IFileThread): Promise<unknown>;
+    setLocalUri?(file: ExternalAsset, replace?: boolean): void;
+    resolveUri?(file: ExternalAsset, source: string): string;
+    resolveUri?(file: ExternalAsset, source: string, trailing: string): [string, string];
+    resolveImports?(file: ExternalAsset, code: string, baseFile?: string | ExternalAsset): string | undefined;
+    replaceContent?(source: string, statement: RegExpExecArray | string, mimeType?: string): string | undefined;
+    addCopy?(data: FileCommand<ExternalAsset>, saveAs: string, replace?: boolean): string | undefined;
+    writeImage?(output: OutputFinalize<ExternalAsset>): boolean;
+    cloudInit?(state: IScopeOrigin<IFileManager, ICloud>): void;
+    cloudObject?(state: IScopeOrigin<IFileManager, ICloud>, file: ExternalAsset): boolean;
+    cloudUpload?(state: IScopeOrigin<IFileManager, ICloud>, file: ExternalAsset, url: string, active: boolean): Promise<boolean>;
+    cloudFinalize?(state: IScopeOrigin<IFileManager, ICloud>): Promise<unknown[]>;
+    watchInit?(watch: IFileGroup<ExternalAsset>, assets: ExternalAsset[], sanitize?: boolean): WatchInitResult | undefined;
+    watchModified?(watch: IFileGroup<ExternalAsset>, assets?: ExternalAsset[]): PostFinalizeCallback;
+    set dataSource(value: DataSource[]);
+    get dataSource(): DataSource[];
+    set imports(value);
+    get imports(): Record<string, string | undefined>;
+    get watching(): boolean;
+}
+
+interface DocumentConstructor extends ModuleConstructor {
+    finalize(this: IFileManager, instance: IDocument): Promise<unknown>;
+    createSourceMap(code: string, remove: boolean): SourceMap;
+    createSourceMap(code: string, uri?: string, remove?: boolean): SourceMap;
+    writeSourceMap(uri: string, data: SourceCode, options?: SourceMapOptions): string | undefined;
+    updateGradle(source: string, namespaces: string[], value: string, options?: UpdateGradleOptions | boolean): string;
+    generateLintTable(messages: LintMessage[], options: GenerateLintTableOptions): LogComponent[];
+    /* @deprecated - IDocument.using */
+    using?(this: IFileManager, instance: IDocument, file: ExternalAsset): Promise<unknown>;
+    cleanup?(this: IFileManager, instance: IDocument): Promise<unknown>;
+    sanitizeAssets?(assets: ExternalAsset[], exclusions?: ExternalAsset[]): ExternalAsset[];
+    readonly prototype: IDocument;
+    new(module?: DocumentModule, ...args: unknown[]): IDocument;
+}
+```
+
+## References
+
+- https://www.unpkg.com/@e-mc/types@0.8.18/lib/squared.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.18/lib/asset.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.18/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.18/lib/document.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.18/lib/filemanager.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.18/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.18/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.18/lib/watch.d.ts
+
+## LICENSE
+
 MIT

package/asset.d.ts

@@ -1,8 +1,8 @@
-import type { ExternalAsset, InitialValue } from '../types/lib/asset';
-
-declare namespace asset {
-    function isEqual(item: ExternalAsset, other: ExternalAsset): boolean;
-    function setInitialValue(file: ExternalAsset, cacheable?: boolean): InitialValue;
-}
-
+import type { ExternalAsset, InitialValue } from '../types/lib/asset';
+
+declare namespace asset {
+    function isEqual(item: ExternalAsset, other: ExternalAsset): boolean;
+    function setInitialValue(file: ExternalAsset, cacheable?: boolean): InitialValue;
+}
+
 export = asset;

package/package.json

@@ -1,31 +1,31 @@
-{
-  "name": "@e-mc/document",
-  "version": "0.8.17",
-  "description": "Document constructor for E-mc.",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/anpham6/e-mc.git",
-    "directory": "src/document"
-  },
-  "keywords": [
-    "squared",
-    "squared-functions"
-  ],
-  "author": "An Pham <anpham6@gmail.com>",
-  "license": "MIT",
-  "homepage": "https://github.com/anpham6/e-mc#readme",
-  "dependencies": {
-    "@e-mc/core": "0.8.17",
-    "@e-mc/db": "0.8.17",
-    "@e-mc/types": "0.8.17",
-    "chalk": "4.1.2",
-    "htmlparser2": "^9.1.0",
-    "js-yaml": "^4.1.0",
-    "picomatch": "^3.0.1"
-  }
-}
+{
+  "name": "@e-mc/document",
+  "version": "0.8.18",
+  "description": "Document constructor for E-mc.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anpham6/e-mc.git",
+    "directory": "src/document"
+  },
+  "keywords": [
+    "squared",
+    "squared-functions"
+  ],
+  "author": "An Pham <anpham6@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/anpham6/e-mc#readme",
+  "dependencies": {
+    "@e-mc/core": "0.8.18",
+    "@e-mc/db": "0.8.18",
+    "@e-mc/types": "0.8.18",
+    "chalk": "4.1.2",
+    "htmlparser2": "^9.1.0",
+    "js-yaml": "^4.1.0",
+    "picomatch": "^3.0.1"
+  }
+}

package/parse/dom.d.ts

@@ -1,9 +1,9 @@
-import type { DomWriterConstructor, HtmlElementConstructor, IGNORE_FLAG } from './types';
-
-declare namespace dom {
-    const IGNORE_FLAG: IGNORE_FLAG;
-    const DomWriter: DomWriterConstructor;
-    const HtmlElement: HtmlElementConstructor;
-}
-
+import type { DomWriterConstructor, HtmlElementConstructor, IGNORE_FLAG } from './types';
+
+declare namespace dom {
+    const IGNORE_FLAG: IGNORE_FLAG;
+    const DomWriter: DomWriterConstructor;
+    const HtmlElement: HtmlElementConstructor;
+}
+
 export = dom;

package/parse/dom.js

@@ -10,7 +10,7 @@ const index_1 = require("@e-mc/document/parse");
 Object.defineProperty(exports, "IGNORE_FLAG", { enumerable: true, get: function () { return index_1.IGNORE_FLAG; } });
 const Parser = htmlparser2.Parser;
 const DomHandler = domhandler.DomHandler;
-const TAG_VOID = ['area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'param', 'source', 'track', 'wbr'];
+const TAG_VOID = ['area', 'base', 'basefont', 'br', 'col', 'command', 'embed', 'frame', 'isindex', 'keygen', 'hr', 'img', 'input', 'link', 'meta', 'param', 'source', 'track', 'wbr'];
 const REGEXP_VOID = TAG_VOID.map(tagName => new RegExp(`(\\s*)</${tagName}\\s*>` + index_1.XmlWriter.PATTERN_TRAILINGSPACE, 'gi'));
 const REGEXP_TAGNAME = new RegExp(`^${index_1.XmlWriter.PATTERN_TAGNAME}$`);
 const PARSER_OPTIONS = Object.freeze({ xmlMode: false, decodeEntities: false });

package/parse/index.d.ts

@@ -1,9 +1,9 @@
-import type { IGNORE_FLAG, XmlElementConstructor, XmlWriterConstructor } from './types';
-
-declare namespace parse {
-    const IGNORE_FLAG: IGNORE_FLAG;
-    const XmlWriter: XmlWriterConstructor;
-    const XmlElement: XmlElementConstructor;
-}
-
+import type { IGNORE_FLAG, XmlElementConstructor, XmlWriterConstructor } from './types';
+
+declare namespace parse {
+    const IGNORE_FLAG: IGNORE_FLAG;
+    const XmlWriter: XmlWriterConstructor;
+    const XmlElement: XmlElementConstructor;
+}
+
 export = parse;

package/parse/index.js

@@ -135,7 +135,7 @@ class XmlWriter {
         return leading + content + trailing;
     }
     static escapeXmlString(value, ampersand) {
-        return value.replace(ampersand ? /[<>"'&]/g : /[<>"']|&([^#A-Za-z]|$)/g, capture => {
+        return value.replace(ampersand ? /[<>"'&]/g : /[<>"']|&(?![a-z][a-z\d]+|#(?:\d+|x[a-f\d]+))/gi, capture => {
             switch (capture) {
                 case '<':
                     return '&lt;';
@@ -146,7 +146,7 @@ class XmlWriter {
                 case "'":
                     return '&apos;';
                 default:
-                    return '&amp;' + (capture[1] || '');
+                    return '&amp;';
             }
         });
     }

package/parse/types/index.d.ts

@@ -1,241 +1,241 @@
-import type { XmlTagNode as IXmlTagNode, TagAppend, TagData } from '../../../types/lib/squared';
-
-import type { ParserOptions } from 'htmlparser2';
-import type { AnyNode, Element } from 'domhandler';
-
-export interface IGNORE_FLAG {
-    NONE: 0;
-    INTERIOR: 1;
-    LOCATOR: 2;
-}
-
-export interface ParserAction {
-    parser?: ParserOptions;
-    outDom?: AnyNode[];
-}
-
-export interface SourceIndex {
-    startIndex: number;
-    endIndex: number;
-}
-
-export interface SourceContent extends SourceIndex {
-    outerXml: string;
-    type?: "node" | "comment" | "cdata" | "block";
-}
-
-export interface SourceTagNode extends SourceContent, TagData {
-    id?: string;
-    ignoreCase?: boolean;
-}
-
-export interface XmlTagNode extends IXmlTagNode, Partial<SourceIndex> {}
-
-export type AttributeMap = Map<string, unknown>;
-export type AttributeList = [string, unknown][];
-export type TagOffsetMap = ObjectMap<Undef<number>>;
-export type WriteResult = [string, string, Null<Error>?];
-export type SaveResult = [string, Null<Error>?];
-export type XmlWriterOptions = ParserAction;
-
-export interface ParserResult extends Partial<TagData>, ParserAction {
-    element: Null<Element>;
-    error: Null<Error>;
-}
-
-export interface ReplaceOptions extends SourceIndex {
-    append?: TagAppend;
-    remove?: boolean;
-}
-
-export interface FindElementOptions extends ParserAction {
-    document?: string;
-    id?: string;
-    locatorAttr?: string;
-    tagCount?: number;
-}
-
-export interface TagOffsetOptions extends ParserAction {
-    ignoreCase?: boolean;
-    ignoreTagName?: string;
-    ignoreTagGroup?: string[];
-}
-
-export interface TagNodeOptions {
-    tagVoid?: boolean;
-}
-
-export interface TagNodeByIdOptions extends TagNodeOptions {
-    tagName?: string;
-}
-
-export interface XmlElementOptions extends TagNodeOptions, ParserAction {}
-
-export interface DomWriterOptions extends ParserAction {
-    normalize?: boolean | string;
-    ignoreTagGroup?: string[];
-    escapeEntities?: boolean;
-    stripComments?: boolean | string;
-}
-
-export interface ReplaceMatchOptions {
-    pattern?: RegExp;
-    trimLeading?: boolean;
-    trimTrailing?: boolean;
-}
-
-export interface NormalizeOptions {
-    newline?: string;
-    ignoreChar?: string;
-    ignoreTagGroup?: string[];
-    escapeEntities?: boolean;
-}
-
-export class IXmlBase {
-    newline: string;
-    readonly documentName: string;
-    write(...args: unknown[]): unknown;
-    save(...args: unknown[]): unknown;
-    reset(): void;
-    get nameOfId(): string;
-    get modified(): boolean;
-}
-
-export class IXmlWriter extends IXmlBase {
-    modifyCount: number;
-    failCount: number;
-    elements: XmlTagNode[];
-    errors: Error[];
-    parser?: ParserOptions;
-    ignoreTagName?: string;
-    ignoreTagGroup?: string[];
-    readonly rootName?: string;
-    readonly ignoreCaseTagName?: boolean;
-    init(offsetMap?: TagOffsetMap): void;
-    getInvalidArea(): Undef<SourceContent[]>;
-    ignoreFlag(...values: number[]): void;
-    insertNodes(nodes?: XmlTagNode[]): void;
-    fromNode(node: XmlTagNode, append?: TagAppend): IXmlElement;
-    newElement(node: XmlTagNode): IXmlElement;
-    append(node: XmlTagNode): Null<IXmlElement>;
-    write(element: IXmlElement): boolean;
-    save(): string;
-    close(): string;
-    update(node: XmlTagNode, outerXml: string, append?: TagAppend, offsetMap?: Null<TagOffsetMap>): void;
-    increment(nodes: XmlTagNode[], offset?: number): void;
-    decrement(node: XmlTagNode, offset?: number, remove?: boolean): XmlTagNode[];
-    renameTag(node: XmlTagNode, tagName: string): void;
-    indexTag(tagName: string, append?: TagAppend, offset?: number): void;
-    resetTag(tagName: string): void;
-    ignoreTag(value: StringOfArray): void;
-    resetPosition(startIndex?: number): void;
-    getElementById(id: string, ignoreCase?: boolean, options?: TagNodeByIdOptions): Undef<SourceTagNode>;
-    getElementsByTagName(tagName: string, ignoreCase?: boolean, options?: TagNodeOptions): SourceTagNode[];
-    setRawString(targetXml: string, outerXml: string): string;
-    getRawString(index: SourceIndex): string;
-    spliceRawString(content: SourceContent, reset?: boolean): string;
-    getComments(): Null<SourceContent[]>;
-    hasErrors(): boolean;
-    get newId(): string;
-    get patternIgnore(): Null<RegExp>;
-    set source(value);
-    get source(): string;
-}
-
-export interface XmlWriterConstructor {
-    readonly PATTERN_ATTRNAME: string;
-    readonly PATTERN_ATTRVALUE: string;
-    readonly PATTERN_TAGNAME: string;
-    readonly PATTERN_TAGOPEN: string;
-    readonly PATTERN_QUOTEVALUE: string;
-    readonly PATTERN_COMMENT: string;
-    readonly PATTERN_TRAILINGSPACE: string;
-    replaceMatch(match: RegExpMatchArray, source: string, content: NumString, options: ReplaceMatchOptions): string;
-    replaceMatch(match: RegExpMatchArray, source: string, content?: NumString, pattern?: RegExp): string;
-    escapeXmlString(value: string, ampersand?: boolean): string;
-    escapeAttributes(source: string): string;
-    getNewlineString(leading: string, trailing: string, newline?: string): string;
-    findCloseTag(source: string, startIndex?: number): number;
-    findElement(source: string, node: XmlTagNode, options?: FindElementOptions): ParserResult;
-    getTagOffset(source: string, options?: TagOffsetOptions): TagOffsetMap;
-    getTagOffset(source: string, replacement?: string, options?: TagOffsetOptions): TagOffsetMap;
-    namesOfTagVoid(type: string, values: string[]): void;
-    isTagVoid(type: string, tagName: string): boolean;
-    getNodeId(node: XmlTagNode, document: string): string;
-    getNameOfId(document: string): string;
-    getPatternId(name: string): RegExp;
-    getCommentsAndCDATA(source: string, tagPattern: unknown, ignoreCase: boolean, stripXml: true): string;
-    getCommentsAndCDATA(source: string, tagPattern?: StringOfArray | [Undef<string>, Undef<string[]>], ignoreCase?: boolean, stripXml?: boolean): SourceContent[];
-    isEqual(node: XmlTagNode, other: XmlTagNode, ignoreCase: boolean): boolean;
-    isEqual(node: XmlTagNode, other: XmlTagNode, documentName?: string, ignoreCase?: boolean): boolean;
-    isIndex(value: Undef<number>): value is number;
-    isCount(value: Undef<number>): value is number;
-    isSpace(ch: string): boolean;
-    readonly prototype: IXmlWriter;
-    new(documentName: string, source: string, elements: XmlTagNode[], options?: XmlWriterOptions): IXmlWriter;
-}
-
-export class IXmlElement extends IXmlBase {
-    parser?: ParserOptions;
-    readonly node: XmlTagNode;
-    setAppend(value?: TagAppend): void;
-    parseOuterXml(value?: string, tagVoid?: boolean): [string, string, boolean];
-    getTagOffset(replacement?: string, options?: TagOffsetOptions): Undef<TagOffsetMap>;
-    setAttribute(name: string, value: string): void;
-    getAttribute(name: string): string;
-    removeAttribute(...names: string[]): void;
-    hasAttribute(name: string): boolean;
-    hasModifiedContent(): boolean;
-    write(source: string, invalid?: SourceIndex[]): WriteResult;
-    save(source: string, invalid?: SourceIndex[]): SaveResult;
-    replace(source: string, options: ReplaceOptions): WriteResult;
-    findIndexOf(source: string): Undef<SourceIndex>;
-    getOuterContent(): [string, AttributeList, string];
-    getInnerOffset(tagName: string): number;
-    hasPosition(): boolean;
-    set id(value: string);
-    get id(): string;
-    set tagName(value: string);
-    get tagName(): string;
-    get documentType(): string;
-    get tagVoid(): boolean;
-    set innerXml(value: string);
-    get innerXml(): string;
-    get outerXml(): string;
-    set remove(value);
-    get remove(): boolean;
-    get append(): Undef<TagAppend>;
-    set tagOffset(value: Undef<TagOffsetMap>);
-    get tagOffset(): Undef<TagOffsetMap>;
-    get ignoreCase(): boolean;
-}
-
-export interface XmlElementConstructor {
-    writeAttributes(attrs: AttributeMap | AttributeList, escapeEntities?: boolean): string;
-    readonly prototype: IXmlElement;
-    new(documentName: string, node: XmlTagNode, attributes?: PlainObject, options?: XmlElementOptions): IXmlElement;
-    new(documentName: string, node: XmlTagNode, attributes?: PlainObject, tagVoid?: boolean, parser?: ParserOptions): IXmlElement;
-}
-
-export class IDomWriter extends IXmlWriter {
-    documentElement: Null<XmlTagNode>;
-    readonly initOpts: DomWriterOptions;
-}
-
-export interface DomWriterConstructor extends XmlWriterConstructor {
-    hasInnerXml(tagName: string): boolean;
-    normalize(source: string, options: NormalizeOptions): string;
-    normalize(source: string, newline?: string, ignoreChar?: string, escapeEntities?: boolean): string;
-    getDocumentElement(source: string, parser?: ParserOptions): ParserResult;
-    getElementsByTagName(tagName: string | ((name: string) => boolean), nodes: ArrayOf<AnyNode>, recurse?: boolean, limit?: number): Element[];
-    readonly prototype: IDomWriter;
-    new(documentName: string, source: string, elements: XmlTagNode[], options?: DomWriterOptions): IDomWriter;
-    new(documentName: string, source: string, elements: XmlTagNode[], normalize?: boolean | string, escapeEntities?: boolean, parser?: ParserOptions): IDomWriter;
-}
-
-export class IHtmlElement extends IXmlElement {}
-
-export interface HtmlElementConstructor extends XmlElementConstructor {
-    readonly prototype: IHtmlElement;
-    new(documentName: string, node: XmlTagNode, attributes?: PlainObject, options?: ParserAction): IHtmlElement;
+import type { XmlTagNode as IXmlTagNode, TagAppend, TagData } from '../../../types/lib/squared';
+
+import type { ParserOptions } from 'htmlparser2';
+import type { AnyNode, Element } from 'domhandler';
+
+export interface IGNORE_FLAG {
+    NONE: 0;
+    INTERIOR: 1;
+    LOCATOR: 2;
+}
+
+export interface ParserAction {
+    parser?: ParserOptions;
+    outDom?: AnyNode[];
+}
+
+export interface SourceIndex {
+    startIndex: number;
+    endIndex: number;
+}
+
+export interface SourceContent extends SourceIndex {
+    outerXml: string;
+    type?: "node" | "comment" | "cdata" | "block";
+}
+
+export interface SourceTagNode extends SourceContent, TagData {
+    id?: string;
+    ignoreCase?: boolean;
+}
+
+export interface XmlTagNode extends IXmlTagNode, Partial<SourceIndex> {}
+
+export type AttributeMap = Map<string, unknown>;
+export type AttributeList = [string, unknown][];
+export type TagOffsetMap = ObjectMap<Undef<number>>;
+export type WriteResult = [string, string, Null<Error>?];
+export type SaveResult = [string, Null<Error>?];
+export type XmlWriterOptions = ParserAction;
+
+export interface ParserResult extends Partial<TagData>, ParserAction {
+    element: Null<Element>;
+    error: Null<Error>;
+}
+
+export interface ReplaceOptions extends SourceIndex {
+    append?: TagAppend;
+    remove?: boolean;
+}
+
+export interface FindElementOptions extends ParserAction {
+    document?: string;
+    id?: string;
+    locatorAttr?: string;
+    tagCount?: number;
+}
+
+export interface TagOffsetOptions extends ParserAction {
+    ignoreCase?: boolean;
+    ignoreTagName?: string;
+    ignoreTagGroup?: string[];
+}
+
+export interface TagNodeOptions {
+    tagVoid?: boolean;
+}
+
+export interface TagNodeByIdOptions extends TagNodeOptions {
+    tagName?: string;
+}
+
+export interface XmlElementOptions extends TagNodeOptions, ParserAction {}
+
+export interface DomWriterOptions extends ParserAction {
+    normalize?: boolean | string;
+    ignoreTagGroup?: string[];
+    escapeEntities?: boolean;
+    stripComments?: boolean | string;
+}
+
+export interface ReplaceMatchOptions {
+    pattern?: RegExp;
+    trimLeading?: boolean;
+    trimTrailing?: boolean;
+}
+
+export interface NormalizeOptions {
+    newline?: string;
+    ignoreChar?: string;
+    ignoreTagGroup?: string[];
+    escapeEntities?: boolean;
+}
+
+export class IXmlBase {
+    newline: string;
+    readonly documentName: string;
+    write(...args: unknown[]): unknown;
+    save(...args: unknown[]): unknown;
+    reset(): void;
+    get nameOfId(): string;
+    get modified(): boolean;
+}
+
+export class IXmlWriter extends IXmlBase {
+    modifyCount: number;
+    failCount: number;
+    elements: XmlTagNode[];
+    errors: Error[];
+    parser?: ParserOptions;
+    ignoreTagName?: string;
+    ignoreTagGroup?: string[];
+    readonly rootName?: string;
+    readonly ignoreCaseTagName?: boolean;
+    init(offsetMap?: TagOffsetMap): void;
+    getInvalidArea(): Undef<SourceContent[]>;
+    ignoreFlag(...values: number[]): void;
+    insertNodes(nodes?: XmlTagNode[]): void;
+    fromNode(node: XmlTagNode, append?: TagAppend): IXmlElement;
+    newElement(node: XmlTagNode): IXmlElement;
+    append(node: XmlTagNode): Null<IXmlElement>;
+    write(element: IXmlElement): boolean;
+    save(): string;
+    close(): string;
+    update(node: XmlTagNode, outerXml: string, append?: TagAppend, offsetMap?: Null<TagOffsetMap>): void;
+    increment(nodes: XmlTagNode[], offset?: number): void;
+    decrement(node: XmlTagNode, offset?: number, remove?: boolean): XmlTagNode[];
+    renameTag(node: XmlTagNode, tagName: string): void;
+    indexTag(tagName: string, append?: TagAppend, offset?: number): void;
+    resetTag(tagName: string): void;
+    ignoreTag(value: StringOfArray): void;
+    resetPosition(startIndex?: number): void;
+    getElementById(id: string, ignoreCase?: boolean, options?: TagNodeByIdOptions): Undef<SourceTagNode>;
+    getElementsByTagName(tagName: string, ignoreCase?: boolean, options?: TagNodeOptions): SourceTagNode[];
+    setRawString(targetXml: string, outerXml: string): string;
+    getRawString(index: SourceIndex): string;
+    spliceRawString(content: SourceContent, reset?: boolean): string;
+    getComments(): Null<SourceContent[]>;
+    hasErrors(): boolean;
+    get newId(): string;
+    get patternIgnore(): Null<RegExp>;
+    set source(value);
+    get source(): string;
+}
+
+export interface XmlWriterConstructor {
+    readonly PATTERN_ATTRNAME: string;
+    readonly PATTERN_ATTRVALUE: string;
+    readonly PATTERN_TAGNAME: string;
+    readonly PATTERN_TAGOPEN: string;
+    readonly PATTERN_QUOTEVALUE: string;
+    readonly PATTERN_COMMENT: string;
+    readonly PATTERN_TRAILINGSPACE: string;
+    replaceMatch(match: RegExpMatchArray, source: string, content: NumString, options: ReplaceMatchOptions): string;
+    replaceMatch(match: RegExpMatchArray, source: string, content?: NumString, pattern?: RegExp): string;
+    escapeXmlString(value: string, ampersand?: boolean): string;
+    escapeAttributes(source: string): string;
+    getNewlineString(leading: string, trailing: string, newline?: string): string;
+    findCloseTag(source: string, startIndex?: number): number;
+    findElement(source: string, node: XmlTagNode, options?: FindElementOptions): ParserResult;
+    getTagOffset(source: string, options?: TagOffsetOptions): TagOffsetMap;
+    getTagOffset(source: string, replacement?: string, options?: TagOffsetOptions): TagOffsetMap;
+    namesOfTagVoid(type: string, values: string[]): void;
+    isTagVoid(type: string, tagName: string): boolean;
+    getNodeId(node: XmlTagNode, document: string): string;
+    getNameOfId(document: string): string;
+    getPatternId(name: string): RegExp;
+    getCommentsAndCDATA(source: string, tagPattern: unknown, ignoreCase: boolean, stripXml: true): string;
+    getCommentsAndCDATA(source: string, tagPattern?: StringOfArray | [Undef<string>, Undef<string[]>], ignoreCase?: boolean, stripXml?: boolean): SourceContent[];
+    isEqual(node: XmlTagNode, other: XmlTagNode, ignoreCase: boolean): boolean;
+    isEqual(node: XmlTagNode, other: XmlTagNode, documentName?: string, ignoreCase?: boolean): boolean;
+    isIndex(value: Undef<number>): value is number;
+    isCount(value: Undef<number>): value is number;
+    isSpace(ch: string): boolean;
+    readonly prototype: IXmlWriter;
+    new(documentName: string, source: string, elements: XmlTagNode[], options?: XmlWriterOptions): IXmlWriter;
+}
+
+export class IXmlElement extends IXmlBase {
+    parser?: ParserOptions;
+    readonly node: XmlTagNode;
+    setAppend(value?: TagAppend): void;
+    parseOuterXml(value?: string, tagVoid?: boolean): [string, string, boolean];
+    getTagOffset(replacement?: string, options?: TagOffsetOptions): Undef<TagOffsetMap>;
+    setAttribute(name: string, value: string): void;
+    getAttribute(name: string): string;
+    removeAttribute(...names: string[]): void;
+    hasAttribute(name: string): boolean;
+    hasModifiedContent(): boolean;
+    write(source: string, invalid?: SourceIndex[]): WriteResult;
+    save(source: string, invalid?: SourceIndex[]): SaveResult;
+    replace(source: string, options: ReplaceOptions): WriteResult;
+    findIndexOf(source: string): Undef<SourceIndex>;
+    getOuterContent(): [string, AttributeList, string];
+    getInnerOffset(tagName: string): number;
+    hasPosition(): boolean;
+    set id(value: string);
+    get id(): string;
+    set tagName(value: string);
+    get tagName(): string;
+    get documentType(): string;
+    get tagVoid(): boolean;
+    set innerXml(value: string);
+    get innerXml(): string;
+    get outerXml(): string;
+    set remove(value);
+    get remove(): boolean;
+    get append(): Undef<TagAppend>;
+    set tagOffset(value: Undef<TagOffsetMap>);
+    get tagOffset(): Undef<TagOffsetMap>;
+    get ignoreCase(): boolean;
+}
+
+export interface XmlElementConstructor {
+    writeAttributes(attrs: AttributeMap | AttributeList, escapeEntities?: boolean): string;
+    readonly prototype: IXmlElement;
+    new(documentName: string, node: XmlTagNode, attributes?: PlainObject, options?: XmlElementOptions): IXmlElement;
+    new(documentName: string, node: XmlTagNode, attributes?: PlainObject, tagVoid?: boolean, parser?: ParserOptions): IXmlElement;
+}
+
+export class IDomWriter extends IXmlWriter {
+    documentElement: Null<XmlTagNode>;
+    readonly initOpts: DomWriterOptions;
+}
+
+export interface DomWriterConstructor extends XmlWriterConstructor {
+    hasInnerXml(tagName: string): boolean;
+    normalize(source: string, options: NormalizeOptions): string;
+    normalize(source: string, newline?: string, ignoreChar?: string, escapeEntities?: boolean): string;
+    getDocumentElement(source: string, parser?: ParserOptions): ParserResult;
+    getElementsByTagName(tagName: string | ((name: string) => boolean), nodes: ArrayOf<AnyNode>, recurse?: boolean, limit?: number): Element[];
+    readonly prototype: IDomWriter;
+    new(documentName: string, source: string, elements: XmlTagNode[], options?: DomWriterOptions): IDomWriter;
+    new(documentName: string, source: string, elements: XmlTagNode[], normalize?: boolean | string, escapeEntities?: boolean, parser?: ParserOptions): IDomWriter;
+}
+
+export class IHtmlElement extends IXmlElement {}
+
+export interface HtmlElementConstructor extends XmlElementConstructor {
+    readonly prototype: IHtmlElement;
+    new(documentName: string, node: XmlTagNode, attributes?: PlainObject, options?: ParserAction): IHtmlElement;
 }

package/util.d.ts

@@ -1,17 +1,17 @@
-declare namespace util {
-    const IMPORTS: Record<string, string | undefined>;
-    function loadPlugins<T = unknown>(name: string | unknown[], plugins?: unknown[]): T[];
-    function replaceAll(source: string, valueOf: (name: string) => string, opening?: string, closing?: string): string;
-    function concatString(values: string[] | string | undefined, newline?: string): string;
-    function splitEnclosing(value: string, pattern?: string | RegExp, options?: { trim?: boolean; start?: number; startWith?: number; count?: number } | boolean | number, opening?: string, closing?: string): string[];
-    function appendSuffix(filename: string, value: string, separator?: string): string;
-    function getIndent(value: string, spaces?: number): string;
-    function getNewline(value: string): string;
-    function getHashData(value: string): [string, number];
-    function hasValue(target: string | string[] | undefined, ...values: string[]): boolean;
-    function getModuleName(err: unknown): string | undefined;
-    function removeInternalProperties<T extends object>(value: T, retaining?: string[]): T;
-    function isObject<T = object>(value: unknown): value is T;
-}
-
+declare namespace util {
+    const IMPORTS: Record<string, string | undefined>;
+    function loadPlugins<T = unknown>(name: string | unknown[], plugins?: unknown[]): T[];
+    function replaceAll(source: string, valueOf: (name: string) => string, opening?: string, closing?: string): string;
+    function concatString(values: string[] | string | undefined, newline?: string): string;
+    function splitEnclosing(value: string, pattern?: string | RegExp, options?: { trim?: boolean; start?: number; startWith?: number; count?: number } | boolean | number, opening?: string, closing?: string): string[];
+    function appendSuffix(filename: string, value: string, separator?: string): string;
+    function getIndent(value: string, spaces?: number): string;
+    function getNewline(value: string): string;
+    function getHashData(value: string): [string, number];
+    function hasValue(target: string | string[] | undefined, ...values: string[]): boolean;
+    function getModuleName(err: unknown): string | undefined;
+    function removeInternalProperties<T extends object>(value: T, retaining?: string[]): T;
+    function isObject<T = object>(value: unknown): value is T;
+}
+
 export = util;