f0-content-parser 1.0.3-dev

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2021
+
+Permission is hereby granted, free
+of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice
+(including the next paragraph) shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# f0-content-parser
+
+F0 content parser
+
+## Features
+
+- ES6 syntax, managed with Prettier
+
+## Install
+
+```sh
+yarn add f0-content-parser
+// or 
+npm i f0-content-parser
+```
+
+### Requirements
+
+- keymirror
+
+
+### Usage
+
+```js
+import { parseContent } from 'f0-content-parser';
+
+
+console.log(parseContent(`YOUR_CONTENT_HERE`));
+```

package/dist/hasDynamicData.js

@@ -0,0 +1,34 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+exports.hasDynamicData = hasDynamicData;
+/**
+ * Test whether a content string references dynamic data
+ * @param  {String}  content - The content to check for dynamic data
+ *
+ * @return {Boolean} - Returns true if the content contains dynamic data
+ */
+function hasDynamicData(content) {
+    var escapedCharacter = false;
+    var character = void 0;
+
+    if (typeof content !== 'string') {
+        return false;
+    }
+
+    for (var index = 0; index < content.length; index++) {
+        character = content[index];
+
+        if (escapedCharacter) {
+            escapedCharacter = false;
+        } else if (character === '{') {
+            return true;
+        } else if (character === '\\') {
+            escapedCharacter = true;
+        }
+    }
+
+    return false;
+};

package/dist/index.js

@@ -0,0 +1,29 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _parseContent = require('./parseContent');
+
+Object.keys(_parseContent).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _parseContent[key];
+    }
+  });
+});
+
+var _hasDynamicData = require('./hasDynamicData');
+
+Object.keys(_hasDynamicData).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _hasDynamicData[key];
+    }
+  });
+});

package/dist/parseContent.js

@@ -0,0 +1,98 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+exports.parseContent = parseContent;
+
+var _lodash = require('lodash.get');
+
+var _lodash2 = _interopRequireDefault(_lodash);
+
+var _keymirror = require('keymirror');
+
+var _keymirror2 = _interopRequireDefault(_keymirror);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+// Create an object of states with values equal to its keys
+var STATES = (0, _keymirror2.default)({
+    default: true,
+    escaped_character: true,
+    parsing_object: true,
+    nested_brackets: true
+});
+
+/**
+ * Given a content string, replace occurences of dynamic data referenced within `{...}`
+ * @param  {String} content - The string to parse
+ * @param  {Object} data - An object containing data that can be referenced from the string
+ * @return {String} - The string with variables replaced with their values
+ */
+function parseContent(content, data) {
+    var _stateHandlers;
+
+    var state = STATES.default,
+        objectPaths = ['', ''],
+        bracketsCount = 0,
+        parsedContent = '',
+        index = void 0,
+        character = void 0;
+
+    // State handlers for each state the parser can be in
+    var stateHandlers = (_stateHandlers = {}, _defineProperty(_stateHandlers, STATES.default, function () {
+        if (character === '{') {
+            bracketsCount++;
+            state = STATES.parsing_object;
+        } else if (character === '}') {
+            throw new Error('"' + content + '" has an unmatched curly brace at index ' + index);
+        } else if (character === '\\') {
+            state = STATES.escaped_character;
+        } else {
+            parsedContent += character;
+        }
+    }), _defineProperty(_stateHandlers, STATES.escaped_character, function () {
+        parsedContent += character;
+        state = STATES.default;
+    }), _defineProperty(_stateHandlers, STATES.parsing_object, function () {
+        if (character === '{') {
+            // if during the PARSING state we find another `{`, that means
+            // that there are nested dynamic content
+            bracketsCount++;
+            objectPaths[bracketsCount] = objectPaths[bracketsCount] || '';
+            state = STATES.nested_brackets;
+        } else if (character === '}') {
+            parsedContent += (0, _lodash2.default)(data, objectPaths[bracketsCount], '');
+            state = STATES.default;
+            objectPaths[bracketsCount] = '';
+            bracketsCount--;
+        } else {
+            objectPaths[bracketsCount] += character;
+        }
+    }), _defineProperty(_stateHandlers, STATES.nested_brackets, function () {
+        if (character === '{') {
+            bracketsCount++;
+            objectPaths[bracketsCount] = objectPaths[bracketsCount] || '';
+        } else if (character === '}') {
+            objectPaths[bracketsCount - 1] += (0, _lodash2.default)(data, objectPaths[bracketsCount], '');
+            objectPaths[bracketsCount] = '';
+            bracketsCount--;
+            // only break out of the nested state if we're back down to a count of 1
+            // aka the original/first bracket
+            if (bracketsCount <= 1) {
+                state = STATES.parsing_object;
+            }
+        } else {
+            objectPaths[bracketsCount] += character;
+        }
+    }), _stateHandlers);
+
+    for (index = 0; index < content.length; index++) {
+        character = content[index];
+        stateHandlers[state]();
+    }
+
+    return parsedContent;
+};

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "f0-content-parser",
+  "version": "1.0.3-dev",
+  "private": false,
+  "description": "F0 content parser",
+  "license": "MIT",
+  "author": "hppcont",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "vite",
+    "test": "exit 0"
+  },
+  "repository": "https://www.gitlab.com/hppcont/f0-content-parser",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "lodash.get": "^4.4.2",
+    "keymirror": "^0.1.1"
+  },
+  "devDependencies": {
+    "vite": "^4.0.4",
+    "vitest": "^0.27.1"
+  }
+}