@adobe/spacecat-shared-utils 1.14.0 → 1.14.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-utils-v1.14.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.14.0...@adobe/spacecat-shared-utils-v1.14.1) (2024-03-19)
+
+
+### Bug Fixes
+
+* jsdoc for generateCSVFile and release ([#187](https://github.com/adobe/spacecat-shared/issues/187)) ([e8e30ed](https://github.com/adobe/spacecat-shared/commit/e8e30eddb0609370898e022d1f986cbc5db83e36))
+
 # [@adobe/spacecat-shared-utils-v1.14.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.13.2...@adobe/spacecat-shared-utils-v1.14.0) (2024-03-18)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.14.0",
+  "version": "1.14.1",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "main": "src/index.js",

package/src/helpers.js

@@ -58,10 +58,15 @@ export function isAuditsDisabled(site, organization, auditType) {
 }
 
 /**
- * Generates a CSV file from the provided json data.
- * @param {Array} data - Array of JSON objects to be converted to CSV.
- * @returns {Buffer} - The CSV formatted data as a buffer.
- */
+* Generates a CSV file from the provided JSON data.
+*
+* Each key-value pair in the JSON objects
+* corresponds to a column and its value in the CSV. The output is a UTF-8
+* encoded Buffer that represents the CSV file content.
+*
+* @param {Object[]} data - An array of JSON objects to be converted into CSV format.
+* @returns {Buffer} A Buffer containing the CSV formatted data, encoded in UTF-8.
+*/
 export function generateCSVFile(data) {
   const json2csvParser = new Parser();
   return Buffer.from(json2csvParser.parse(data), 'utf-8');

package/src/index.d.ts

@@ -108,3 +108,15 @@ declare function composeAuditURL(url: string): Promise<string>;
  * @returns {boolean} - True if the audit(s) are disabled, otherwise false.
  */
 declare function isAuditsDisabled(site: object, organization: object, auditType?: string): boolean
+
+/**
+ * Generates a CSV file from the provided JSON data.
+ *
+ * Each key-value pair in the JSON objects
+ * corresponds to a column and its value in the CSV. The output is a UTF-8
+ * encoded Buffer that represents the CSV file content.
+ *
+ * @param {Object[]} data - An array of JSON objects to be converted into CSV format.
+ * @returns {Buffer} A Buffer containing the CSV formatted data, encoded in UTF-8.
+ */
+declare function generateCSVFile(data: object[]): Buffer;

package/src/index.js

@@ -30,6 +30,7 @@ export {
 export {
   isAuditsDisabled,
   resolveSecretsName,
+  generateCSVFile,
 } from './helpers.js';
 
 export { sqsWrapper } from './sqs.js';