@ezs/basics 1.22.6 → 1.23.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.23.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.22.7...@ezs/basics@1.23.0) (2023-01-20)
+
+
+### Features
+
+* 🎸 add new parameter to FILESave ([8fae7b8](https://github.com/Inist-CNRS/ezs/commit/8fae7b8009824d8e73c98e8277e15ffacd87d572))
+
+
+
+
+
+## [1.22.7](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.22.6...@ezs/basics@1.22.7) (2023-01-13)
+
+
+### Bug Fixes
+
+* 🐛 backpresure control ([70c4a07](https://github.com/Inist-CNRS/ezs/commit/70c4a07010c0b1927bb57c95b3c5113e8aaa7552))
+
+
+
+
+
 ## [1.22.6](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.22.5...@ezs/basics@1.22.6) (2023-01-05)
 
 **Note:** Version bump only for package @ezs/basics

package/README.md

@@ -262,6 +262,8 @@ Output:
 
 -   `location` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Directory location (optional, default `TMPDIR`)
 -   `identifier` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** File name
+-   `content` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Content to save instead of using input object
+-   `jsonl` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Save as json line (optional, default `false`)
 -   `compress` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Enable gzip compression (optional, default `false`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

package/lib/file-save.js

@@ -23,6 +23,9 @@ var _debug = _interopRequireDefault(require("debug"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+const eol = '\n';
+
+const toJSONL = line => JSON.stringify(line).concat(eol);
 /**
  * Take data, convert it to buffer and append it to file
  *
@@ -55,12 +58,14 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @name FILESave
  * @param {String} [location=TMPDIR] Directory location
  * @param {String} [identifier] File name
+ * @param {String} [content] Content to save instead of using input object
+ * @param {Boolean} [jsonl=false] Save as json line
  * @param {Boolean} [compress=false] Enable gzip compression
  * @returns {Object}
  */
-function FILESave(data, feed) {
-  const buf = Buffer.from(String(data));
 
+
+function FILESave(data, feed) {
   if (this.isFirst()) {
     const identifier = String(this.getParam('identifier'));
     const location = this.getParam('location', (0, _os.tmpdir)());
@@ -102,5 +107,9 @@ function FILESave(data, feed) {
     return this.whenFinish.then(stats => feed.write(stats)).catch(err => feed.stop(err)).finally(() => feed.close());
   }
 
+  const jsonl = Boolean(this.getParam('jsonl', false));
+  const bufContent = this.getParam('content', data);
+  const bufFunc = jsonl ? toJSONL : String;
+  const buf = Buffer.from(bufFunc(bufContent));
   (0, _streamWrite.default)(this.input, buf, () => feed.end());
 }

package/lib/obj-standardize.js

@@ -13,6 +13,37 @@ var _streamWrite = _interopRequireDefault(require("stream-write"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+function normalize(data, feed) {
+  if (this.isLast()) {
+    return feed.close();
+  }
+
+  const struct = this.getEnv();
+  const vv = {};
+  struct.forEach(k => {
+    if (!data[k]) {
+      vv[k] = '';
+    } else {
+      vv[k] = data[k];
+    }
+  });
+  return feed.send(vv);
+}
+
+function cleanup(data, feed) {
+  if (this.isLast()) {
+    const filename = this.getParam('filename');
+
+    if (filename) {
+      return _fs.default.unlink(filename, () => feed.close());
+    }
+
+    return feed.close();
+  }
+
+  return feed.send(data);
+}
+
 function OBJStandardize(data, feed) {
   const self = this;
   const {
@@ -29,31 +60,17 @@ function OBJStandardize(data, feed) {
 
   if (self.isLast()) {
     self.tmpInput.end();
-    self.tmpHandle.then(() => {
-      _fs.default.createReadStream(self.tmpFile).pipe(ezs.uncompress()).pipe(ezs('unpack')).on('error', e => {
-        throw e;
-      }).on('data', d => {
-        const vv = {};
-        self.struct.forEach(k => {
-          if (!d[k]) {
-            vv[k] = '';
-          } else {
-            vv[k] = d[k];
-          }
-        });
-        feed.write(vv);
-      }).on('end', () => {
-        _fs.default.unlink(self.tmpFile, () => feed.close());
-      });
-    });
-  } else {
-    Object.keys(data).forEach(k => {
-      if (self.struct.indexOf(k) === -1) {
-        self.struct.push(k);
-      }
-    });
-    (0, _streamWrite.default)(self.tmpInput, data, () => feed.end());
+    return self.tmpHandle.then(() => feed.flow(_fs.default.createReadStream(self.tmpFile).pipe(ezs.uncompress()).pipe(ezs('unpack')).pipe(ezs(normalize, {}, self.struct)).pipe(ezs(cleanup, {
+      filename: self.tmpFile
+    })))).catch(e => feed.stop(e));
   }
+
+  Object.keys(data).forEach(k => {
+    if (self.struct.indexOf(k) === -1) {
+      self.struct.push(k);
+    }
+  });
+  (0, _streamWrite.default)(self.tmpInput, data, () => feed.end());
 }
 /**
  * Standardize `Object`s so that each object have the same keys.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ezs/basics",
   "description": "Basics statements for EZS",
-  "version": "1.22.6",
+  "version": "1.23.0",
   "author": "Nicolas Thouvenin <nthouvenin@gmail.com>",
   "bugs": "https://github.com/Inist-CNRS/ezs/issues",
   "dependencies": {
@@ -37,7 +37,7 @@
   "directories": {
     "test": "test"
   },
-  "gitHead": "7211cce7c849f770c10ba6f32c526194e9366501",
+  "gitHead": "20ec5a02e63dfff4859d64e96cd5e2bb05e48504",
   "homepage": "https://github.com/Inist-CNRS/ezs/tree/master/packages/basics#readme",
   "keywords": [
     "ezs"