@js-ak/excel-toolbox 1.3.1 → 1.4.0

package/build/types/lib/template/utils/apply-replacements.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Replaces placeholders in the given content string with values from the replacements map.
+ *
+ * The function searches for placeholders in the format `${key}` within the content
+ * string, where `key` corresponds to a path in the replacements object.
+ * If a value is found for the key, it replaces the placeholder with the value.
+ * If no value is found, the original placeholder remains unchanged.
+ *
+ * @param content - The string containing placeholders to be replaced.
+ * @param replacements - An object where keys represent placeholder paths and values are the replacements.
+ * @returns A new string with placeholders replaced by corresponding values from the replacements object.
+ */
+export declare const applyReplacements: (content: string, replacements: Record<string, unknown>) => string;

package/build/types/lib/template/utils/check-row.d.ts

@@ -1,14 +1,9 @@
 /**
- * Validates that each key in the given row object is a valid cell reference.
+ * Validates an object representing a single row of data to ensure that its keys
+ * are valid Excel column references. Throws an error if any of the keys are
+ * invalid.
  *
- * This function checks that all keys in the provided row object are composed
- * only of column letters (A-Z, case insensitive). If a key is found that does
- * not match this pattern, an error is thrown with a message indicating the
- * invalid cell reference.
- *
- * @param row - An object representing a row of data, where keys are cell
- *              references and values are strings.
- *
- * @throws {Error} If any key in the row is not a valid column letter.
+ * @param row An object with string keys that represent the cell references and
+ * string values that represent the values of those cells.
  */
 export declare function checkRow(row: Record<string, string>): void;

package/build/types/lib/template/utils/column-index-to-letter.d.ts

@@ -1,7 +1,15 @@
 /**
- * Converts a 0-based column index to an Excel-style letter (A, B, ..., Z, AA, AB, ...).
+ * Converts a zero-based column index to its corresponding Excel column letter.
  *
- * @param index - The 0-based column index.
- * @returns The Excel-style letter for the given column index.
+ * @throws Will throw an error if the input is not a positive integer.
+ * @param {number} index - The zero-based index of the column to convert.
+ * @returns {string} The corresponding Excel column letter.
+ *
+ * @example
+ * columnIndexToLetter(0); // returns "A"
+ * columnIndexToLetter(25); // returns "Z"
+ * columnIndexToLetter(26); // returns "AA"
+ * columnIndexToLetter(51); // returns "AZ"
+ * columnIndexToLetter(52); // returns "BA"
  */
 export declare function columnIndexToLetter(index: number): string;

package/build/types/lib/template/utils/extract-xml-declaration.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Extracts the XML declaration from a given XML string.
+ *
+ * The XML declaration is a string that looks like `<?xml ...?>` and is usually
+ * present at the beginning of an XML file. It contains information about the
+ * XML version, encoding, and standalone status.
+ *
+ * This function returns `null` if the input string does not have a valid XML
+ * declaration.
+ *
+ * @param xmlString - The XML string to extract the declaration from.
+ * @returns The extracted XML declaration string, or `null`.
+ */
+export declare function extractXmlDeclaration(xmlString: string): string | null;

package/build/types/lib/template/utils/get-by-path.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Gets a value from an object by a given path.
+ *
+ * @param obj - The object to search.
+ * @param path - The path to the value, separated by dots.
+ * @returns The value at the given path, or undefined if not found.
+ */
+export declare function getByPath(obj: unknown, path: string): unknown;

package/build/types/lib/template/utils/index.d.ts

@@ -1,11 +1,16 @@
+export * from "./apply-replacements.js";
 export * from "./check-row.js";
 export * from "./check-rows.js";
 export * from "./check-start-row.js";
 export * from "./column-index-to-letter.js";
 export * from "./escape-xml.js";
+export * from "./extract-xml-declaration.js";
+export * from "./get-by-path.js";
 export * from "./get-max-row-number.js";
 export * from "./get-rows-above.js";
 export * from "./get-rows-below.js";
 export * from "./parse-rows.js";
 export * from "./to-excel-column-object.js";
+export * from "./update-dimension.js";
+export * from "./validate-worksheet-xml.js";
 export * from "./write-rows-to-stream.js";

package/build/types/lib/template/utils/update-dimension.d.ts

@@ -0,0 +1 @@
+export declare function updateDimension(xml: string): string;

package/build/types/lib/template/utils/validate-worksheet-xml.d.ts

@@ -0,0 +1,9 @@
+interface ValidationResult {
+    isValid: boolean;
+    error?: {
+        message: string;
+        details?: string;
+    };
+}
+export declare function validateWorksheetXml(xml: string): ValidationResult;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@js-ak/excel-toolbox",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "excel-toolbox",
   "publishConfig": {
     "access": "public",
@@ -38,13 +38,14 @@
     "package.json"
   ],
   "scripts": {
-    "build": "npm run build:cjs && npm run build:esm && npm run postbuild:esm && npm run postbuild:cjs",
+    "build": "npm run build:cjs && npm run build:esm && npm run postbuild:cjs && npm run postbuild:esm",
     "build:esm": "tsc -p tsconfig.esm.json",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "lint": "eslint . --ext .ts",
     "postbuild:esm": "node scripts/write-esm-package.js",
     "postbuild:cjs": "node scripts/write-cjs-package.js",
-    "test": "npm run build && node ./build/esm/test/index.js"
+    "test": "vitest run",
+    "test:watch": "vitest"
   },
   "repository": {
     "type": "git",
@@ -75,7 +76,8 @@
     "globals": "16.0.0",
     "semantic-release": "24.0.0",
     "typescript": "5.8.3",
-    "typescript-eslint": "8.29.0"
+    "typescript-eslint": "8.29.0",
+    "vitest": "3.1.1"
   },
   "dependencies": {
     "pako": "2.1.0"