node-pptx-templater 1.1.7 → 1.1.8

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "node-pptx-templater",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "High-performance, low-level PowerPoint (PPTX) OpenXML template engine for Node.js. Dynamically replace text, insert images, update charts (with Excel workbook data caching), and merge table cells without PowerPoint corruption or Repair Mode prompts.",
   "main": "./src/index.js",
+  "module": "./src/index.mjs",
+  "types": "./src/index.d.ts",
   "type": "commonjs",
+  "sideEffects": false,
   "exports": {
     ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.mjs",
       "require": "./src/index.js"
     }
   },
@@ -172,23 +177,36 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "fast-xml-parser": "^4.3.6",
-    "jszip": "^3.10.1",
-    "fs-extra": "^11.2.0",
-    "commander": "^12.0.0",
     "chalk": "^4.1.2",
+    "commander": "^12.0.0",
+    "fast-xml-parser": "^5.9.3",
+    "fs-extra": "^11.2.0",
+    "jszip": "^3.10.1",
     "ora": "^5.4.1"
   },
   "devDependencies": {
-    "vitest": "^1.6.0",
-    "@vitest/coverage-v8": "^1.6.0",
+    "@vitest/coverage-v8": "^4.1.9",
     "eslint": "^8.57.0",
-    "prettier": "^3.2.5"
+    "prettier": "^3.2.5",
+    "vitest": "^4.1.9"
   },
   "files": [
     "src/",
     "README.md",
     "LICENSE",
     "CHANGELOG.md"
-  ]
+  ],
+  "browser": {
+    "fs": false,
+    "path": false,
+    "os": false,
+    "stream": false,
+    "fs-extra": false,
+    "ora": false,
+    "chalk": false,
+    "commander": false
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/src/index.d.ts

@@ -0,0 +1,138 @@
+export class PPTXTemplater {
+  static load(source: string | Buffer, options?: any): Promise<PPTXTemplater>;
+  static setLogLevel(level: string): void;
+  static preload(source: string | Buffer): Promise<any>;
+  static cache(source: string | Buffer): Promise<any>;
+  static fromCache(source: string | Buffer): Promise<PPTXTemplater>;
+  static clearCache(): void;
+  static fromPresentationXml(options: any): Promise<PPTXTemplater>;
+  static create(): Promise<PPTXTemplater>;
+  static extractPptx(pptxPath: string, outputPath: string, options?: any): Promise<void>;
+  static buildPptx(folderPath: string, pptxPath: string): Promise<void>;
+
+  slideCount: number;
+  useSlide(slideNumber: number): this;
+  replaceText(replacements: Record<string, string | number>): this;
+  updateChart(chartName: string, data: any): this;
+  updateChartTitle(chartName: string, title: string): this;
+  applyZOrder(slideNumber: number, zOrderConfig: any[]): this;
+  removeSlide(slideNumber: number): this;
+  addHyperlink(options: any): this;
+  addSlideLink(options: any): this;
+  getTableRows(tableName: string): Promise<any[]>;
+  updateTable(tableName: string, rows: any[][]): this;
+  addTableRow(tableName: string, row: any[]): this;
+  removeTableRow(tableName: string, rowIndex: number): this;
+  mergeCells(tableName: string, startRow: number, startCol: number, endRow: number, endCol: number): this;
+  saveToFile(filePath: string, options?: any): Promise<void>;
+  save(filePath: string, options?: any): Promise<void>;
+  saveXml(folderPath: string): Promise<void>;
+  saveToFolder(folderPath: string): Promise<void>;
+  toBuffer(options?: any): Promise<Buffer>;
+  toStream(options?: any): Promise<any>;
+  saveToStream(writableOrOptions: any, options?: any): Promise<void>;
+  exportSlides(...slideNumbers: number[]): Promise<any>;
+  importSlideFrom(sourceEngine: PPTXTemplater, slideRef: any): Promise<any>;
+  repair(): Promise<this>;
+  inspectXML(xmlPath: string): Promise<any>;
+  validateCharts(): Promise<any>;
+  repairCharts(): Promise<any>;
+  inspectChartXML(chartFileName: string): Promise<any>;
+  getDataLabels(chartId: string, options?: any): Promise<any>;
+  validateDataLabels(chartId: string, options?: any): Promise<any>;
+  validateChartLabels(chartId: string, options?: any): Promise<any>;
+  validateSeriesNameLabels(chartId: string, options?: any): Promise<any>;
+  getChartLabelPositions(chartId: string): Promise<any>;
+  getChartBarPositions(chartId: string): Promise<any>;
+  addShape(typeOrOptions: any, options?: any): Promise<any>;
+  updateShape(shapeId: string, options: any): Promise<any>;
+  removeShape(shapeId: string): Promise<any>;
+  addCellShape(tableId: string, rowIndex: number, colIndex: number, options: any): Promise<any>;
+  updateCellShape(tableId: string, rowIndex: number, colIndex: number, shapeIndex: number, options: any): Promise<any>;
+  removeCellShape(tableId: string, rowIndex: number, colIndex: number, shapeIndex: number): Promise<any>;
+  replaceImage(imageIdOrName: string, sourcePathOrBuffer: string | Buffer): Promise<any>;
+  addImage(sourcePathOrBuffer: string | Buffer, options?: any): Promise<any>;
+  validatePresentation(): Promise<any>;
+  validatePresentationXml(): Promise<any>;
+  validateSlide(slideIndex: number): Promise<any>;
+  validateTable(tableId: string): Promise<any>;
+  validateArchive(): Promise<any>;
+}
+
+export const PPTXTemplate: typeof PPTXTemplater;
+
+export class ZipManager {
+  [key: string]: any;
+}
+
+export class XMLParser {
+  [key: string]: any;
+}
+
+export const Z_ORDER_SYMBOL: unique symbol;
+
+export class SlideManager {
+  [key: string]: any;
+}
+
+export class ChartManager {
+  [key: string]: any;
+}
+
+export class TableManager {
+  [key: string]: any;
+}
+
+export class ShapeManager {
+  [key: string]: any;
+}
+
+export class ImageManager {
+  [key: string]: any;
+}
+
+export class TextManager {
+  [key: string]: any;
+}
+
+export class HyperlinkManager {
+  [key: string]: any;
+}
+
+export class MediaManager {
+  [key: string]: any;
+}
+
+export class RelationshipManager {
+  [key: string]: any;
+}
+
+export class OutputWriter {
+  [key: string]: any;
+}
+
+export class TemplateEngine {
+  [key: string]: any;
+}
+
+export class ValidationEngine {
+  [key: string]: any;
+}
+
+export function generateRelationshipId(slideId: any): string;
+export function parseRelationshipId(relId: string): any;
+export function validateXml(xmlStr: string): any;
+export function validateXML(xmlStr: string): any;
+export function safeParseXml(xmlStr: string): any;
+export function repairXML(xmlStr: string): string;
+export function scanForEntities(xmlStr: string): any;
+export function analyzeXmlFile(xmlStr: string): any;
+export function reportXmlComplexity(xmlStr: string): any;
+export function createLogger(name: string): any;
+export function setGlobalLogLevel(level: string): void;
+export function resetLogLevel(): void;
+
+export class PPTXError extends Error {}
+export class SlideNotFoundError extends PPTXError {}
+export class ChartNotFoundError extends PPTXError {}
+export class TableNotFoundError extends PPTXError {}

package/src/index.mjs

@@ -0,0 +1,39 @@
+import pkg from './index.js'
+
+export const {
+  PPTXTemplater,
+  PPTXTemplate,
+  ZipManager,
+  XMLParser,
+  Z_ORDER_SYMBOL,
+  SlideManager,
+  ChartManager,
+  TableManager,
+  ShapeManager,
+  ImageManager,
+  TextManager,
+  HyperlinkManager,
+  MediaManager,
+  RelationshipManager,
+  OutputWriter,
+  TemplateEngine,
+  ValidationEngine,
+  generateRelationshipId,
+  parseRelationshipId,
+  validateXml,
+  validateXML,
+  safeParseXml,
+  repairXML,
+  scanForEntities,
+  analyzeXmlFile,
+  reportXmlComplexity,
+  createLogger,
+  setGlobalLogLevel,
+  resetLogLevel,
+  PPTXError,
+  SlideNotFoundError,
+  ChartNotFoundError,
+  TableNotFoundError,
+} = pkg
+
+export default pkg