@ezs/basics 1.17.1 → 1.18.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.18.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.17.1...@ezs/basics@1.18.0) (2022-06-21)
+
+
+### Features
+
+* 🎸 add [FILESave] ([2e7dfd7](https://github.com/Inist-CNRS/ezs/commit/2e7dfd76f769418a56f7b9b6cb23d156f37b6789))
+
+
+
+
+
 ## [1.17.1](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.17.0...@ezs/basics@1.17.1) (2022-04-01)
 
 

package/README.md

@@ -18,6 +18,7 @@ npm install @ezs/basics
 -   [CSVObject](#csvobject)
 -   [CSVParse](#csvparse)
 -   [CSVString](#csvstring)
+-   [FILESave](#filesave)
 -   [INIString](#inistring)
 -   [JSONParse](#jsonparse)
 -   [JSONString](#jsonstring)
@@ -189,6 +190,43 @@ a;b;c
 
 Returns **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
+### FILESave
+
+Take data, convert it to buffer and append it to file
+
+##### Example
+
+Input:
+
+```json
+[
+  {"a": "a"},
+  {"a": "b"},
+  {"a": "c" }
+]
+```
+
+Script:
+
+```ini
+[FILESave]
+location = /tmp
+identifier = toto
+```
+
+Output:
+
+```json
+["/tmp/truc.json"]
+```
+
+#### Parameters
+
+-   `location` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Directory location (optional, default `TMPDIR`)
+-   `identifier` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** File name
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
 ### INIString
 
 Take `Object` and generate INI

package/lib/file-save.js

@@ -0,0 +1,81 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = FILESave;
+
+var _fs = require("fs");
+
+var _path = _interopRequireDefault(require("path"));
+
+var _os = require("os");
+
+var _pathExists = _interopRequireDefault(require("path-exists"));
+
+var _makeDir = _interopRequireDefault(require("make-dir"));
+
+var _streamWrite = _interopRequireDefault(require("stream-write"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Take data, convert it to buffer and append it to file
+ *
+ * #### Example
+ *
+ * Input:
+ *
+ * ```json
+ * [
+ *   {"a": "a"},
+ *   {"a": "b"},
+ *   {"a": "c" }
+ * ]
+ * ```
+ *
+ * Script:
+ *
+ * ```ini
+ * [FILESave]
+ * location = /tmp
+ * identifier = toto
+ * ```
+ *
+ * Output:
+ *
+ * ```json
+ * ["/tmp/truc.json"]
+ * ```
+ *
+ * @name FILESave
+ * @param {String} [location=TMPDIR] Directory location
+ * @param {Number} [identifier] File name
+ * @returns {Object}
+ */
+async function FILESave(data, feed) {
+  if (!this.handle) {
+    const identifier = String(this.getParam('identifier'));
+    const location = this.getParam('location', (0, _os.tmpdir)());
+
+    if (!_pathExists.default.sync(location)) {
+      _makeDir.default.sync(location);
+    }
+
+    this.filename = _path.default.resolve(location, identifier);
+    this.handle = (0, _fs.createWriteStream)(this.filename);
+  }
+
+  if (this.isLast()) {
+    this.handle.close();
+    return (0, _fs.lstat)(this.filename, (err, stat) => {
+      feed.write({
+        filename: this.filename,
+        ...stat
+      });
+      return feed.close();
+    });
+  }
+
+  (0, _streamWrite.default)(this.handle, Buffer.from(String(data)), () => feed.end());
+}

package/lib/index.js

@@ -53,6 +53,8 @@ var _zipExtract = _interopRequireDefault(require("./zip-extract"));
 
 var _iniString = _interopRequireDefault(require("./ini-string"));
 
+var _fileSave = _interopRequireDefault(require("./file-save"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const funcs = {
@@ -80,6 +82,7 @@ const funcs = {
   TXTZip: _txtZip.default,
   ZIPExtract: _zipExtract.default,
   INIString: _iniString.default,
+  FILESave: _fileSave.default,
   // aliases
   bufferify: _bufObject.default.BUFObject,
   concat: _txtConcat.default.TXTConcat,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ezs/basics",
   "description": "Basics statements for EZS",
-  "version": "1.17.1",
+  "version": "1.18.0",
   "author": "Nicolas Thouvenin <nthouvenin@gmail.com>",
   "bugs": "https://github.com/Inist-CNRS/ezs/issues",
   "dependencies": {
@@ -18,9 +18,11 @@
     "lodash.mapvalues": "4.6.0",
     "lodash.set": "4.3.2",
     "lodash.zipobject": "4.1.3",
+    "make-dir": "3.1.0",
     "micromatch": "4.0.4",
     "node-abort-controller": "1.1.0",
     "parse-headers": "2.0.4",
+    "path-exists": "4.0.0",
     "stream-write": "1.0.1",
     "tmp-filepath": "2.0.0",
     "unzipper": "0.10.11",
@@ -34,7 +36,7 @@
   "directories": {
     "test": "test"
   },
-  "gitHead": "0ccde3c9e03a451c95a20372ff41437c9ec214e7",
+  "gitHead": "346fbfb891990dda7dd2d445e1f32ab2276c7020",
   "homepage": "https://github.com/Inist-CNRS/ezs/tree/master/packages/basics#readme",
   "keywords": [
     "ezs"