@ezs/basics 1.24.0 → 2.0.0

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.0.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.24.0...@ezs/basics@2.0.0) (2023-03-29)
+
+
+### Features
+
+* **basics:** Make TXTSentences pass some tests ([95bd41f](https://github.com/Inist-CNRS/ezs/commit/95bd41f836e5ee2f71c8413142df9ac4dd9ec84b))
+* **basics:** Make TXTSentences work with arrays too ([24c3f76](https://github.com/Inist-CNRS/ezs/commit/24c3f76be73a518791e59b7e78c4d1151af8edd6))
+
+
+### BREAKING CHANGES
+
+* **basics:** TXTSentences xxpected structure is now an object, with a value key.
+
+
+
+
+
 # [1.24.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.23.5...@ezs/basics@1.24.0) (2023-03-28)
 
 

package/README.md

@@ -609,16 +609,20 @@ Take a `String` and split it into an array of sentences.
 Input:
 
 ```json
-"First sentence? Second sentence. My name is Bond, J. Bond."
+{ "id": 1, "value": "First sentence? Second sentence. My name is Bond, J. Bond." }
 ```
 
 Output:
 
 ```json
-["First sentence?", "Second sentence.", "My name is Bond, J. Bond."]
+{ "id": 1, "value": ["First sentence?", "Second sentence.", "My name is Bond, J. Bond."] }
 ```
 
-Returns **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+#### Parameters
+
+-   `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path of the field to segment (optional, default `"value"`)
+
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
 
 ### TXTZip
 

package/lib/txt-sentences.js

@@ -5,7 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _string_decoder = require("string_decoder");
+var _lodash = _interopRequireDefault(require("lodash.get"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const UPPER_LETTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
 const SENTENCE_INIT = '  ';
@@ -17,7 +19,7 @@ const SENTENCE_ENDING = '.?!';
  */
 
 const segmentSentences = str => {
-  const characters = str.split('');
+  const characters = Array.from(str);
   const sentences = characters.reduce(
   /*
    * @param {string[]} prevSentences
@@ -43,34 +45,21 @@ const segmentSentences = str => {
     }
 
     return [...prevSentences.slice(0, -1), currentSentence + character];
-  }, [SENTENCE_INIT]).map(sentence => sentence.trimStart());
+  }, [SENTENCE_INIT]).filter(sentence => sentence !== SENTENCE_INIT).map(sentence => sentence.trimStart());
   return sentences;
 };
 
 const TXTSentences = (data, feed, ctx) => {
-  if (!ctx.decoder) {
-    ctx.decoder = new _string_decoder.StringDecoder('utf8');
-  }
-
   if (ctx.isLast()) {
-    ctx.decoder.end();
-    return feed.end();
-  }
-
-  ctx.remainder = ctx.remainder ?? '';
-  let str;
-
-  if (Buffer.isBuffer(data)) {
-    str = ctx.decoder.write(data);
-  } else if (typeof data === 'string') {
-    str = data;
+    return feed.close();
   }
 
-  const lines = str ? segmentSentences(str) : [];
-  lines.unshift(ctx.remainder + lines.shift());
-  ctx.remainder = lines.pop();
-  lines.forEach(line => {
-    feed.write(line);
+  const path = ctx.getParam('path', 'value');
+  const value = (0, _lodash.default)(data, path);
+  const str = Array.isArray(value) ? value.map(item => typeof item === 'string' ? item : '').join(' ') : value;
+  const sentences = str ? segmentSentences(str) : [];
+  feed.write({ ...data,
+    [path]: sentences
   });
   return feed.end();
 };
@@ -80,17 +69,18 @@ const TXTSentences = (data, feed, ctx) => {
  * Input:
  *
  * ```json
- * "First sentence? Second sentence. My name is Bond, J. Bond."
+ * { "id": 1, "value": "First sentence? Second sentence. My name is Bond, J. Bond." }
  * ```
  *
  * Output:
  *
  * ```json
- * ["First sentence?", "Second sentence.", "My name is Bond, J. Bond."]
+ * { "id": 1, "value": ["First sentence?", "Second sentence.", "My name is Bond, J. Bond."] }
  * ```
  *
  * @name TXTSentences
- * @returns {String}
+ * @param {String} [path="value"] path of the field to segment
+ * @returns {String[]}
  */
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ezs/basics",
   "description": "Basics statements for EZS",
-  "version": "1.24.0",
+  "version": "2.0.0",
   "author": "Nicolas Thouvenin <nthouvenin@gmail.com>",
   "bugs": "https://github.com/Inist-CNRS/ezs/issues",
   "dependencies": {
@@ -39,7 +39,7 @@
   "directories": {
     "test": "test"
   },
-  "gitHead": "0f52795f9c5d1a452adbad48ab567298bb8a6bea",
+  "gitHead": "314a26ebcbf109ffdb6936ee4b8564e19dd17cbc",
   "homepage": "https://github.com/Inist-CNRS/ezs/tree/master/packages/basics#readme",
   "keywords": [
     "ezs"