@mindful-web/embedded-media 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Parameter1 LLC
+
+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 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/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@mindful-web/embedded-media",
+  "version": "1.0.0",
+  "description": "Mindful Web embedded media parsing.",
+  "main": "src/index.js",
+  "author": "Jacob Bare <jacob@parameter1.com>",
+  "repository": "https://github.com/parameter1/mindful-web/tree/main/packages/embedded-media",
+  "license": "MIT",
+  "scripts": {
+    "lint:fix": "yarn lint --fix",
+    "lint": "eslint --ext .js --max-warnings 5 ./",
+    "test": "yarn lint"
+  },
+  "dependencies": {
+    "@mindful-web/html": "^1.0.0",
+    "@mindful-web/image": "^1.0.0",
+    "@mindful-web/inflector": "^1.0.0",
+    "cheerio": "^1.0.0-rc.12",
+    "escape-string-regexp": "^1.0.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "0b77cab713eb5841202bb86c7119949866bc68b5"
+}

package/src/constants.js

@@ -0,0 +1,25 @@
+const TAG_ATTR_PREFIX = 'data-embed';
+
+module.exports = {
+  /**
+   * The ending database tag.
+   */
+  DB_TAG_END: ']}%',
+
+  /**
+   * The starting database tag.
+   */
+  DB_TAG_START: '%{[',
+
+  TAG_ATTR_PREFIX,
+
+  /**
+   * The attribute name that siginfies the tag id.
+   */
+  TAG_ID_ATTR_NAME: `${TAG_ATTR_PREFIX}-id`,
+
+  /**
+   * The attribute name that siginfies the tag type.
+   */
+  TAG_TYPE_ATTR_NAME: `${TAG_ATTR_PREFIX}-type`,
+};

package/src/extract.js

@@ -0,0 +1,11 @@
+const getTagMatches = require('./utils/get-tag-matches');
+const Tag = require('./tag');
+
+/**
+ * @param {string} html The HTML/text to extract embedded items from.
+ * @returns {Tag[]} An array of Tag instances.
+ */
+module.exports = (html) => {
+  if (!html) return [];
+  return getTagMatches(html).map((match) => new Tag(match));
+};

package/src/index.js

@@ -0,0 +1,5 @@
+const extract = require('./extract');
+
+module.exports = {
+  extractEmbeddedTags: extract,
+};

package/src/tag.js

@@ -0,0 +1,62 @@
+const escapeRegex = require('escape-string-regexp');
+const extractAttributes = require('./utils/extract-attributes');
+const createAttribute = require('./utils/create-attribute');
+const {
+  DB_TAG_END,
+  DB_TAG_START,
+} = require('./constants');
+
+class Tag {
+  constructor(value) {
+    const attrs = extractAttributes(value);
+    this.attrs = attrs;
+    this.value = value;
+  }
+
+  get id() {
+    return this.attrs.id;
+  }
+
+  get type() {
+    return this.attrs.type;
+  }
+
+  isValid() {
+    if (this.valid === false) return false;
+    if (this.id && this.type) return true;
+    return false;
+  }
+
+  set(key, value) {
+    this.attrs[key] = value;
+    return this;
+  }
+
+  get(key, def = undefined) {
+    return this.attrs[key] || def;
+  }
+
+  setValid(bit = true) {
+    this.valid = Boolean(bit);
+  }
+
+  build() {
+    const contents = Object.entries(this.attrs).reduce((arr, [key, value]) => {
+      const attr = createAttribute(key, value);
+      if (!attr) return arr;
+      arr.push(attr);
+      return arr;
+    }, []).join(' ');
+    return `${DB_TAG_START} ${contents} ${DB_TAG_END}`;
+  }
+
+  getRegExp(flags = 'g') {
+    return new RegExp(escapeRegex(this.value), flags);
+  }
+
+  toString() {
+    return this.build();
+  }
+}
+
+module.exports = Tag;

package/src/utils/create-attribute.js

@@ -0,0 +1,12 @@
+const { dasherize } = require('@mindful-web/inflector');
+const { htmlEntities } = require('@mindful-web/html');
+const {
+  TAG_ATTR_PREFIX,
+} = require('../constants');
+
+module.exports = (key, value) => {
+  if (!key || value == null) return null; // ignore null and undefined
+  const k = `${TAG_ATTR_PREFIX}-${dasherize(key)}`;
+  const v = htmlEntities.encode(value);
+  return `${k}="${v}"`;
+};

package/src/utils/extract-attributes.js

@@ -0,0 +1,20 @@
+const cheerio = require('cheerio');
+const { htmlEntities } = require('@mindful-web/html');
+const { camelize } = require('@mindful-web/inflector');
+const {
+  DB_TAG_END,
+  DB_TAG_START,
+} = require('../constants');
+
+/**
+ * @param {string} match The database tag match, e.g. `%{[ ... ]}%`.
+ */
+module.exports = (match) => {
+  const html = match.replace(DB_TAG_START, '<span').replace(DB_TAG_END, '></span>');
+  const $ = cheerio.load(html, { decodeEntities: false });
+  const obj = $('span').data() || {};
+  return Object.keys(obj).reduce((o, k) => {
+    const key = camelize(k.replace('embed', ''));
+    return ({ ...o, [key]: htmlEntities.decode(String(obj[k])) });
+  }, {});
+};

package/src/utils/get-tag-matches.js

@@ -0,0 +1,15 @@
+const pattern = require('./tag-match-pattern');
+
+/**
+ * @param {string} html The HTML to extract embedded tags from.
+ * @returns {string[]} An array of matched embedded tag strings.
+ */
+module.exports = (html) => {
+  const matches = [];
+  let match;
+  do {
+    match = pattern.exec(html);
+    if (match && match[0]) matches.push(match[0]);
+  } while (match);
+  return matches;
+};

package/src/utils/tag-match-pattern.js

@@ -0,0 +1,11 @@
+const escapeRegex = require('escape-string-regexp');
+const {
+  DB_TAG_END,
+  DB_TAG_START,
+  TAG_TYPE_ATTR_NAME,
+} = require('../constants');
+
+const start = escapeRegex(DB_TAG_START);
+const end = escapeRegex(DB_TAG_END);
+const type = escapeRegex(TAG_TYPE_ATTR_NAME);
+module.exports = new RegExp(`${start}(?=\\s${type}=).+?(?<=\\s)${end}`, 'gi');