dynamic-docx-generator 1.0.0

package/dist/utils/xml.d.ts

@@ -0,0 +1,48 @@
+/**
+ * XML manipulation utilities for DOCX processing
+ */
+/**
+ * Find and replace content in XML string
+ */
+export declare const replaceXmlContent: (xml: string, search: string, replacement: string) => string;
+/**
+ * Insert content before a specific XML tag
+ */
+export declare const insertBeforeTag: (xml: string, tag: string, content: string) => string;
+/**
+ * Insert content after a specific XML tag
+ */
+export declare const insertAfterTag: (xml: string, tag: string, content: string) => string;
+/**
+ * Replace content between two tags
+ */
+export declare const replaceBetweenTags: (xml: string, startTag: string, endTag: string, replacement: string) => string;
+/**
+ * Add relationship to document.xml.rels
+ */
+export declare const addRelationship: (relsContent: string, relationshipXml: string) => string;
+/**
+ * Extract relationship IDs from rels XML
+ */
+export declare const extractRelationshipIds: (relsContent: string) => string[];
+/**
+ * Generate unique relationship ID not present in existing rels
+ */
+export declare const generateUniqueRelId: (existingIds: string[]) => string;
+/**
+ * Parse content types from [Content_Types].xml
+ */
+export declare const addContentType: (contentTypesXml: string, extension: string, contentType: string) => string;
+/**
+ * Common content types for images
+ */
+export declare const IMAGE_CONTENT_TYPES: Record<string, string>;
+/**
+ * Get content type for image extension
+ */
+export declare const getImageContentType: (extension: string) => string;
+/**
+ * Validate XML structure (basic check)
+ */
+export declare const isValidXml: (xml: string) => boolean;
+//# sourceMappingURL=xml.d.ts.map

package/dist/utils/xml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xml.d.ts","sourceRoot":"","sources":["../../src/utils/xml.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAC1B,KAAK,MAAM,EACX,QAAQ,MAAM,EACd,aAAa,MAAM,KACpB,MAIF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,GACxB,KAAK,MAAM,EACX,KAAK,MAAM,EACX,SAAS,MAAM,KAChB,MAKF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,GACvB,KAAK,MAAM,EACX,KAAK,MAAM,EACX,SAAS,MAAM,KAChB,MAMF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAC3B,KAAK,MAAM,EACX,UAAU,MAAM,EAChB,QAAQ,MAAM,EACd,aAAa,MAAM,KACpB,MAWF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,GACxB,aAAa,MAAM,EACnB,iBAAiB,MAAM,KACxB,MAGF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,GAAI,aAAa,MAAM,KAAG,MAAM,EAKlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,aAAa,MAAM,EAAE,KAAG,MAM3D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,GACvB,iBAAiB,MAAM,EACvB,WAAW,MAAM,EACjB,aAAa,MAAM,KACpB,MASF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAOtD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,WAAW,MAAM,KAAG,MAGvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,OAYxC,CAAC"}

package/dist/utils/xml.js

@@ -0,0 +1,129 @@
+"use strict";
+/**
+ * XML manipulation utilities for DOCX processing
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidXml = exports.getImageContentType = exports.IMAGE_CONTENT_TYPES = exports.addContentType = exports.generateUniqueRelId = exports.extractRelationshipIds = exports.addRelationship = exports.replaceBetweenTags = exports.insertAfterTag = exports.insertBeforeTag = exports.replaceXmlContent = void 0;
+const string_1 = require("./string");
+/**
+ * Find and replace content in XML string
+ */
+const replaceXmlContent = (xml, search, replacement) => {
+    let result = (0, string_1.replaceAll)(xml, search, replacement);
+    result = (0, string_1.fixDoubleEscaping)(result);
+    return result;
+};
+exports.replaceXmlContent = replaceXmlContent;
+/**
+ * Insert content before a specific XML tag
+ */
+const insertBeforeTag = (xml, tag, content) => {
+    const index = xml.indexOf(tag);
+    if (index === -1)
+        return xml;
+    return xml.slice(0, index) + content + xml.slice(index);
+};
+exports.insertBeforeTag = insertBeforeTag;
+/**
+ * Insert content after a specific XML tag
+ */
+const insertAfterTag = (xml, tag, content) => {
+    const index = xml.indexOf(tag);
+    if (index === -1)
+        return xml;
+    const endIndex = index + tag.length;
+    return xml.slice(0, endIndex) + content + xml.slice(endIndex);
+};
+exports.insertAfterTag = insertAfterTag;
+/**
+ * Replace content between two tags
+ */
+const replaceBetweenTags = (xml, startTag, endTag, replacement) => {
+    const startIndex = xml.indexOf(startTag);
+    const endIndex = xml.indexOf(endTag, startIndex);
+    if (startIndex === -1 || endIndex === -1)
+        return xml;
+    return (xml.slice(0, startIndex + startTag.length) +
+        replacement +
+        xml.slice(endIndex));
+};
+exports.replaceBetweenTags = replaceBetweenTags;
+/**
+ * Add relationship to document.xml.rels
+ */
+const addRelationship = (relsContent, relationshipXml) => {
+    const closingTag = '</Relationships>';
+    return (0, string_1.replaceAll)(relsContent, closingTag, relationshipXml + '\n' + closingTag);
+};
+exports.addRelationship = addRelationship;
+/**
+ * Extract relationship IDs from rels XML
+ */
+const extractRelationshipIds = (relsContent) => {
+    const matches = relsContent.match(/Id="([^"]+)"/g);
+    if (!matches)
+        return [];
+    return matches.map(m => m.replace('Id="', '').replace('"', ''));
+};
+exports.extractRelationshipIds = extractRelationshipIds;
+/**
+ * Generate unique relationship ID not present in existing rels
+ */
+const generateUniqueRelId = (existingIds) => {
+    let id = 1;
+    while (existingIds.includes(`rId${id}`)) {
+        id++;
+    }
+    return `rId${id}`;
+};
+exports.generateUniqueRelId = generateUniqueRelId;
+/**
+ * Parse content types from [Content_Types].xml
+ */
+const addContentType = (contentTypesXml, extension, contentType) => {
+    const existing = `Extension="${extension}"`;
+    if (contentTypesXml.includes(existing)) {
+        return contentTypesXml;
+    }
+    const newType = `<Default Extension="${extension}" ContentType="${contentType}" />`;
+    const closingTag = '</Types>';
+    return (0, string_1.replaceAll)(contentTypesXml, closingTag, newType + '\n' + closingTag);
+};
+exports.addContentType = addContentType;
+/**
+ * Common content types for images
+ */
+exports.IMAGE_CONTENT_TYPES = {
+    png: 'image/png',
+    jpg: 'image/jpeg',
+    jpeg: 'image/jpeg',
+    gif: 'image/gif',
+    bmp: 'image/bmp',
+    webp: 'image/webp'
+};
+/**
+ * Get content type for image extension
+ */
+const getImageContentType = (extension) => {
+    const ext = extension.toLowerCase().replace('.', '');
+    return exports.IMAGE_CONTENT_TYPES[ext] || 'image/png';
+};
+exports.getImageContentType = getImageContentType;
+/**
+ * Validate XML structure (basic check)
+ */
+const isValidXml = (xml) => {
+    try {
+        // Basic check: matching opening/closing tags
+        const openTags = (xml.match(/<[^/][^>]*[^/]>/g) || []).length;
+        const closeTags = (xml.match(/<\/[^>]+>/g) || []).length;
+        const selfClose = (xml.match(/<[^>]+\/>/g) || []).length;
+        // This is a rough approximation
+        return Math.abs(openTags - closeTags - selfClose) < 5;
+    }
+    catch {
+        return false;
+    }
+};
+exports.isValidXml = isValidXml;
+//# sourceMappingURL=xml.js.map

package/dist/utils/xml.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xml.js","sourceRoot":"","sources":["../../src/utils/xml.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,qCAAyD;AAEzD;;GAEG;AACI,MAAM,iBAAiB,GAAG,CAC7B,GAAW,EACX,MAAc,EACd,WAAmB,EACb,EAAE;IACR,IAAI,MAAM,GAAG,IAAA,mBAAU,EAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClD,MAAM,GAAG,IAAA,0BAAiB,EAAC,MAAM,CAAC,CAAC;IACnC,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AARW,QAAA,iBAAiB,qBAQ5B;AAEF;;GAEG;AACI,MAAM,eAAe,GAAG,CAC3B,GAAW,EACX,GAAW,EACX,OAAe,EACT,EAAE;IACR,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,KAAK,KAAK,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC;IAE7B,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC5D,CAAC,CAAC;AATW,QAAA,eAAe,mBAS1B;AAEF;;GAEG;AACI,MAAM,cAAc,GAAG,CAC1B,GAAW,EACX,GAAW,EACX,OAAe,EACT,EAAE;IACR,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,KAAK,KAAK,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC;IAE7B,MAAM,QAAQ,GAAG,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC;IACpC,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AAClE,CAAC,CAAC;AAVW,QAAA,cAAc,kBAUzB;AAEF;;GAEG;AACI,MAAM,kBAAkB,GAAG,CAC9B,GAAW,EACX,QAAgB,EAChB,MAAc,EACd,WAAmB,EACb,EAAE;IACR,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAEjD,IAAI,UAAU,KAAK,CAAC,CAAC,IAAI,QAAQ,KAAK,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC;IAErD,OAAO,CACH,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC1C,WAAW;QACX,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CACtB,CAAC;AACN,CAAC,CAAC;AAhBW,QAAA,kBAAkB,sBAgB7B;AAEF;;GAEG;AACI,MAAM,eAAe,GAAG,CAC3B,WAAmB,EACnB,eAAuB,EACjB,EAAE;IACR,MAAM,UAAU,GAAG,kBAAkB,CAAC;IACtC,OAAO,IAAA,mBAAU,EAAC,WAAW,EAAE,UAAU,EAAE,eAAe,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC;AACpF,CAAC,CAAC;AANW,QAAA,eAAe,mBAM1B;AAEF;;GAEG;AACI,MAAM,sBAAsB,GAAG,CAAC,WAAmB,EAAY,EAAE;IACpE,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IACnD,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IAExB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;AACpE,CAAC,CAAC;AALW,QAAA,sBAAsB,0BAKjC;AAEF;;GAEG;AACI,MAAM,mBAAmB,GAAG,CAAC,WAAqB,EAAU,EAAE;IACjE,IAAI,EAAE,GAAG,CAAC,CAAC;IACX,OAAO,WAAW,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACtC,EAAE,EAAE,CAAC;IACT,CAAC;IACD,OAAO,MAAM,EAAE,EAAE,CAAC;AACtB,CAAC,CAAC;AANW,QAAA,mBAAmB,uBAM9B;AAEF;;GAEG;AACI,MAAM,cAAc,GAAG,CAC1B,eAAuB,EACvB,SAAiB,EACjB,WAAmB,EACb,EAAE;IACR,MAAM,QAAQ,GAAG,cAAc,SAAS,GAAG,CAAC;IAC5C,IAAI,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrC,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED,MAAM,OAAO,GAAG,uBAAuB,SAAS,kBAAkB,WAAW,MAAM,CAAC;IACpF,MAAM,UAAU,GAAG,UAAU,CAAC;IAC9B,OAAO,IAAA,mBAAU,EAAC,eAAe,EAAE,UAAU,EAAE,OAAO,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC;AAChF,CAAC,CAAC;AAbW,QAAA,cAAc,kBAazB;AAEF;;GAEG;AACU,QAAA,mBAAmB,GAA2B;IACvD,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,YAAY;IACjB,IAAI,EAAE,YAAY;IAClB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,WAAW;IAChB,IAAI,EAAE,YAAY;CACrB,CAAC;AAEF;;GAEG;AACI,MAAM,mBAAmB,GAAG,CAAC,SAAiB,EAAU,EAAE;IAC7D,MAAM,GAAG,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACrD,OAAO,2BAAmB,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC;AACnD,CAAC,CAAC;AAHW,QAAA,mBAAmB,uBAG9B;AAEF;;GAEG;AACI,MAAM,UAAU,GAAG,CAAC,GAAW,EAAW,EAAE;IAC/C,IAAI,CAAC;QACD,6CAA6C;QAC7C,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QAC9D,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACzD,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QAEzD,gCAAgC;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAC1D,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AAZW,QAAA,UAAU,cAYrB"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "dynamic-docx-generator",
+  "version": "1.0.0",
+  "description": "Generate dynamic DOCX documents from templates with placeholder replacement, tables, and images",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "prepublishOnly": "npm run build && npm test",
+    "lint": "eslint src/**/*.ts",
+    "example": "node examples/basic-usage.js"
+  },
+  "keywords": [
+    "docx",
+    "word",
+    "document",
+    "template",
+    "generator",
+    "office",
+    "openxml",
+    "placeholder",
+    "dynamic",
+    "report"
+  ],
+  "author": "Your Name",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/your-username/dynamic-docx-generator.git"
+  },
+  "homepage": "https://github.com/your-username/dynamic-docx-generator#readme",
+  "bugs": {
+    "url": "https://github.com/your-username/dynamic-docx-generator/issues"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {
+    "adm-zip": "^0.5.16",
+    "axios": "^1.7.9"
+  },
+  "devDependencies": {
+    "@types/adm-zip": "^0.5.7",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.5",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.3"
+  }
+}