@ezs/basics 2.2.0 → 2.4.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.
 
+# [2.4.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@2.3.0...@ezs/basics@2.4.0) (2023-07-17)
+
+
+### Features
+
+* 🎸 add [TARDump] ([d3ff2a9](https://github.com/Inist-CNRS/ezs/commit/d3ff2a99650fc7c9eacd2c1ad015d9907addeebb))
+
+
+
+
+
+# [2.3.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@2.2.0...@ezs/basics@2.3.0) (2023-06-23)
+
+
+### Features
+
+* **strings:** Add inflection and sentences statements ([67ba36c](https://github.com/Inist-CNRS/ezs/commit/67ba36c8ba68c1798f5430a087172fed45d2b3c0))
+
+
+
+
+
 # [2.2.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@2.1.3...@ezs/basics@2.2.0) (2023-06-22)
 
 

package/README.md

@@ -27,6 +27,7 @@ npm install @ezs/basics
 -   [OBJFlatten](#objflatten)
 -   [OBJNamespaces](#objnamespaces)
 -   [OBJStandardize](#objstandardize)
+-   [TARDump](#tardump)
 -   [TARExtract](#tarextract)
 -   [TXTConcat](#txtconcat)
 -   [TXTInflection](#txtinflection)
@@ -537,6 +538,22 @@ Output:
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
+### TARDump
+
+Take all recevied objects and build a tar file
+
+```json
+{
+}
+```
+
+#### Parameters
+
+-   `manifest` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Location path to store files in the tarball
+-   `location` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Location path to store files in the tarball (optional, default `data`)
+-   `json` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Parse as JSON the content of each file (optional, default `true`)
+-   `compress` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Enable gzip compression (optional, default `false`)
+
 ### TARExtract
 
 Take the content of a tar file, extract some files.
@@ -582,9 +599,6 @@ Returns **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### TXTInflection
 
--   **See: <https://www.npmjs.com/package/inflection>
-    **
-
 Take a `String` and inflect it with or more transformers from this list
  pluralize, singularize, camelize, underscore, humanize, capitalize,
  dasherize, titleize, demodulize, tableize, classify, foreign_key, ordinalize
@@ -617,6 +631,12 @@ Output:
 
 Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
 
+**Meta**
+
+-   **deprecated**: see <https://inist-cnrs.github.io/ezs/#/plugin-strings?id=inflection>
+    see <https://www.npmjs.com/package/inflection>
+
+
 ### TXTObject
 
 Take an array of values and generate an array containing objects with the
@@ -684,6 +704,11 @@ Output:
 
 Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
 
+**Meta**
+
+-   **deprecated**: see <https://inist-cnrs.github.io/ezs/#/plugin-strings?id=sentences>
+
+
 ### TXTZip
 
 Take a `String` and zip it.

package/lib/index.js

@@ -61,6 +61,8 @@ var _zipExtract = _interopRequireDefault(require("./zip-extract"));
 
 var _tarExtract = _interopRequireDefault(require("./tar-extract"));
 
+var _tarDump = _interopRequireDefault(require("./tar-dump"));
+
 var _iniString = _interopRequireDefault(require("./ini-string"));
 
 var _fileSave = _interopRequireDefault(require("./file-save"));
@@ -98,6 +100,7 @@ const funcs = {
   TXTZip: _txtZip.default,
   ZIPExtract: _zipExtract.default,
   TARExtract: _tarExtract.default,
+  TARDump: _tarDump.default,
   INIString: _iniString.default,
   FILESave: _fileSave.default,
   FILELoad: _fileLoad.default,

package/lib/tar-dump.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = TARDump;
+
+var _tarStream = _interopRequireDefault(require("tar-stream"));
+
+var _zlib = require("zlib");
+
+var _lodash = _interopRequireDefault(require("lodash.merge"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const eol = '\n';
+/**
+ * Take all recevied objects and build a tar file
+ *
+ * ```json
+ * {
+ * }
+ * ```
+ *
+ * @name TARDump
+ * @param {String} [manifest] Location path to store files in the tarball
+ * @param {String} [location=data] Location path to store files in the tarball
+ * @param {String} [json=true] Parse as JSON the content of each file
+ * @param {Boolean} [compress=false] Enable gzip compression
+ */
+
+function TARDump(data, feed) {
+  if (!this.pack) {
+    this.pack = _tarStream.default.pack();
+    const compress = this.getParam('compress', false);
+    const d = new Date();
+    const manifest = (0, _lodash.default)({
+      created: d.toUTCString()
+    }, [].concat(this.getParam('manifest', [])).filter(Boolean));
+    this.pack.entry({
+      name: 'manifest.json'
+    }, JSON.stringify(manifest, null, '  '));
+    const stream = compress ? this.pack.pipe((0, _zlib.createGzip)()) : this.pack;
+    feed.flow(stream).finally(() => feed.close());
+  }
+
+  if (this.isLast()) {
+    this.pack.finalize();
+    return;
+  }
+
+  const id = this.getIndex().toString().padStart(10, '0');
+  const value = JSON.stringify(data).concat(eol);
+  const location = this.getParam('location', 'data');
+  this.pack.entry({
+    name: `${location}/f${id}.json`
+  }, value);
+  feed.end();
+}

package/lib/txt-inflection.js

@@ -56,7 +56,9 @@ const TXTInflection = (data, feed, ctx) => {
  * @param {String} [path="value"] path of the field to segment
  * @param {String} [transform] name of a transformer
  * @returns {String[]}
- * @see https://www.npmjs.com/package/inflection
+ * @deprecated
+ * see https://inist-cnrs.github.io/ezs/#/plugin-strings?id=inflection
+ * see https://www.npmjs.com/package/inflection
  */
 
 

package/lib/txt-sentences.js

@@ -81,6 +81,8 @@ const TXTSentences = (data, feed, ctx) => {
  * @name TXTSentences
  * @param {String} [path="value"] path of the field to segment
  * @returns {String[]}
+ * @deprecated
+ * see https://inist-cnrs.github.io/ezs/#/plugin-strings?id=sentences
  */
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ezs/basics",
   "description": "Basics statements for EZS",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "author": "Nicolas Thouvenin <nthouvenin@gmail.com>",
   "bugs": "https://github.com/Inist-CNRS/ezs/issues",
   "dependencies": {
@@ -20,15 +20,16 @@
     "lodash.get": "4.4.2",
     "lodash.mapkeys": "4.6.0",
     "lodash.mapvalues": "4.6.0",
+    "lodash.merge": "4.6.2",
     "lodash.set": "4.3.2",
     "lodash.zipobject": "4.1.3",
-    "make-dir": "3.1.0",
+    "make-dir": "4.0.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",
-    "tar-stream": "3.1.4",
+    "tar-stream": "3.1.6",
     "tmp-filepath": "2.0.0",
     "unzipper": "0.10.11",
     "xml-mapping": "1.7.2",
@@ -41,7 +42,7 @@
   "directories": {
     "test": "test"
   },
-  "gitHead": "6868634896b6171224fe54c59360a3668d71bd5f",
+  "gitHead": "313d6ef24c4b958533685a198a090b7ecd2b33b9",
   "homepage": "https://github.com/Inist-CNRS/ezs/tree/master/packages/basics#readme",
   "keywords": [
     "ezs"