@turbodocx/html-to-docx 1.12.0 → 1.13.0

package/index.d.ts

@@ -0,0 +1,82 @@
+/// <reference types="node" />
+
+declare namespace HTMLtoDOCX {
+    interface Margins {
+        top?: number;
+        right?: number;
+        bottom?: number;
+        left?: number;
+        header?: number;
+        footer?: number;
+        gutter?: number;
+    }
+
+    interface PageSize {
+        width?: number;
+        height?: number;
+    }
+
+    interface Row {
+        cantSplit?: boolean;
+    }
+
+    interface Table {
+        row?: Row;
+        borderOptions?: {
+            size?: number;
+            stroke?: string;
+            color?: string;
+        };
+        addSpacingAfter?: boolean;
+    }
+
+    interface LineNumberOptions {
+        start: number;
+        countBy: number;
+        restart: "continuous" | "newPage" | "newSection";
+    }
+
+    interface DocumentOptions {
+        orientation?: "portrait" | "landscape";
+        pageSize?: PageSize;
+        margins?: Margins;
+        title?: string;
+        subject?: string;
+        creator?: string;
+        keywords?: string[];
+        description?: string;
+        lastModifiedBy?: string;
+        revision?: number;
+        createdAt?: Date;
+        modifiedAt?: Date;
+        headerType?: "default" | "first" | "even";
+        header?: boolean;
+        footerType?: "default" | "first" | "even";
+        footer?: boolean;
+        font?: string;
+        fontSize?: number;
+        complexScriptFontSize?: number;
+        table?: Table;
+        pageNumber?: boolean;
+        skipFirstHeaderFooter?: boolean;
+        lineNumber?: boolean;
+        lineNumberOptions?: LineNumberOptions;
+        numbering?: {
+            defaultOrderedListStyleType?: string;
+        };
+        decodeUnicode?: boolean;
+        lang?: string;
+        preprocessing?: {
+            skipHTMLMinify?: boolean;
+        };
+    }
+}
+
+declare function HTMLtoDOCX(
+    htmlString: string,
+    headerHTMLstring?: string | null,
+    documentOptions?: HTMLtoDOCX.DocumentOptions,
+    footerHtmlString?: string | null,
+): Promise<ArrayBuffer | Blob | Buffer>;
+
+export = HTMLtoDOCX;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbodocx/html-to-docx",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "HTML to DOCX converter",
   "keywords": [
     "html-to-docx",
@@ -34,10 +34,19 @@
     "document generation software",
     "automated document creation",
     "batch document generation",
-    "document templating"
+    "document templating",
+    "typescript",
+    "ts"
   ],
   "main": "dist/html-to-docx.umd.js",
   "module": "dist/html-to-docx.esm.js",
+  "types": "index.d.ts",
+  "files": [
+    "dist",
+    "index.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
     "test": "npm run build && node example/example-node.js",
     "prerelease": "rollup -c",
@@ -46,7 +55,8 @@
     "prettier:check": "prettier --check '**/*.{js}'",
     "validate": "run-s lint prettier:check",
     "build": "rollup -c",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "test:ts-example": "npm run build && cross-env TS_NODE_PROJECT=example/typescript/tsconfig.json ts-node -r tsconfig-paths/register example/typescript/typescript-example.ts"
   },
   "repository": {
     "type": "git",
@@ -89,6 +99,7 @@
     "@rollup/plugin-commonjs": "^12.0.0",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.1.1",
+    "cross-env": "^7.0.3",
     "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-config-prettier": "^8.3.0",
@@ -101,11 +112,12 @@
     "rollup-plugin-cleaner": "^1.0.0",
     "rollup-plugin-node-builtins": "^2.1.2",
     "rollup-plugin-terser": "^7.0.2",
-    "standard-version": "^9.3.1"
+    "standard-version": "^9.3.1",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.8.3"
   },
   "dependencies": {
-    "@oozcitak/dom": "1.15.6",
-    "@oozcitak/util": "8.3.4",
     "color-name": "^1.1.4",
     "html-entities": "^2.3.3",
     "html-minifier-terser": "^7.2.0",
@@ -124,13 +136,5 @@
       "prettier --write",
       "eslint --fix"
     ]
-  },
-  "resolutions": {
-    "@oozcitak/util": "8.3.4",
-    "@oozcitak/dom": "1.15.6"
-  },
-  "overrides": {
-    "@oozcitak/util": "8.3.4",
-    "@oozcitak/dom": "1.15.6"
   }
 }