tuijs-meta 0.1.2 → 0.1.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 TechTB
-
-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.
+MIT License
+
+Copyright (c) 2024 TechTB
+
+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/README.md

@@ -1,130 +1,130 @@
-# TUIJS-Meta
-*** THIS README IS OUT OF DATE AND WILL BE UPDATED SOON ***
-## A simple and easy utility that updates a web application's meta tags based on a provided set of site data.
-***TUIJS-Meta is built on modules. A bundler is recommended.***
-
-***Last Updated 08/05/2024***
-
-
-## Getting Started
-1. Ensure that you have a set of site data (We will refer to this as 'siteData') created. This can be a JSON file, data in a database, or an Object directly in your JS code. As long as the resulting data is an Object following the format below. For this example we will use a JSON file.
-    - The 'siteData' will always consist of a parent Object.
-    - The Objects contained within the 'siteData' parent Object should each represent a route path, except for the site wide data which should always be '\*'. The '\*' Object will represent data that is intended to be site wide, and can be empty or non-existent if desired. ***The Object names do not currently matter as long as they are referenced correctly when the 'tuiMeta' function is called. However, once tuijs-meta is integrated into TUI-Router, the naming standard for site data and route data will become important.***
-    - Inside the value of each site or route Object, there will be two important keys, 'title' and 'meta'. The 'title' key value will be a string representing the title of the site or page. The 'meta' key value will be an Array of Objects containing meta tag attributes. Each Object can contain as many or as few attributes as needed, but each Object will only ever represent one meta tag.
-
-```json
-{
-    "*": {
-        "title": "Site Title",
-        "meta": [
-            {
-                "property": "og:title",
-                "content": "Title"
-            },
-            {
-                "property": "og:description",
-                "content": "description"
-            },
-            {
-                "property": "og:image",
-                "content": "image/path"
-            },
-            {
-                "property": "og:url",
-                "content": "https://site/path"
-            },
-            {
-                "property": "og:type",
-                "content": "website"
-            }
-        ]
-    },
-    "/": {
-        "title": "Home Title",
-        "meta": [
-            {
-                "name": "description",
-                "content": "Home description"
-            },
-            {
-                "name": "keywords",
-                "content": "Home keywords"
-            }
-        ]
-    },
-    "/about": {
-        "title": "About Title",
-        "meta": [
-            {
-                "name": "description",
-                "content": "About description"
-            },
-            {
-                "name": "keywords",
-                "content": "About keywords"
-            }
-        ]
-    },
-    "/contact": {
-        "title": "Contact Title",
-        "meta": [
-            {
-                "name": "description",
-                "content": "Contact description"
-            },
-            {
-                "name": "keywords",
-                "content": "Contact keywords"
-            }
-        ]
-    },
-}
-```
-
-2. Import the primary function 'tuiMeta' from 'tuijs-meta'.
-    - If you are working with a multi-page app, this should be in the JS file for each page.
-    - If you you are working with a single-page app, this should be done where ever you route logic is.
-    - ***The 'tuiMeta' function is exported as default.***
-
-```js
-import tuiMeta from 'tuijs-meta';
-```
-
-3. Execute the 'tuiMeta function' using the desired site or route data from the siteData source. ***It is important to note that you must use one of the seconds Objects as the parameter and NOT the full site data Object.***
-    - In the following example, the site data is directly in the JS code and is provided as a parameter in the 'tuiMeta' function. In this case, the page head will populate with the HTML tags listed below.
-
-```js
-const siteData = {
-    '*': {
-        title: 'Site Title',
-        meta: [
-            {
-                name: 'description',
-                content: 'Site description'
-            },
-            {
-                name: 'keywords',
-                content: 'Site keywords'
-            }
-        ]
-    },
-}
-tuiMeta(siteData['*']);
-```
-```html
-<title>Site Title</title>
-<meta name="description" content="Site description">
-<meta name="keywords" content="Site keywords">
-```
-
-4. When the 'tuiMeta' function is called it will check the head for other existing meta tags that have key/value pairs that match exactly. If it finds any, they will be deleted allowing the new site or route meta data to be added. ***It should be noted that 'content' attributes are completely ignored during this check. So if a content key/value pair match, nothing will be deleted.***
-
-## How It Works
-1. When the 'tuiMeta' function is called, the site data provided is first checked to ensure that it is an Object.
-2. The function then validates that the 'title' key exists.
-    - If the 'title' key exists, the function attempts to update the document title with the 'title' key value.
-    - If the 'title' key DOES NOT exists, no error is generated and the function just moves on.
-2. The function then validates that the 'meta' key exists.
-    - If the 'meta' key exists, the function then validates that the value of the 'meta' key is an Array, throwing an error if it is not.
-    -If the 'meta' key value is an Array, then the function attempts to update the document meta tags with the 'meta' key Array data. As as reminder this Array consists of Objects, each representing a single meta tag. Within each Object, there is a set as many or as few key/value pairs as needed, each representing a single meta tag attribute and its value.
-    - If the 'meta' key DOES NOT exists, no error is generated and the function just moves on.
+# TUIJS-Meta
+*** THIS README IS OUT OF DATE AND WILL BE UPDATED SOON ***
+## A simple and easy utility that updates a web application's meta tags based on a provided set of site data.
+***TUIJS-Meta is built on modules. A bundler is recommended.***
+
+***Last Updated 08/05/2024***
+
+
+## Getting Started
+1. Ensure that you have a set of site data (We will refer to this as 'siteData') created. This can be a JSON file, data in a database, or an Object directly in your JS code. As long as the resulting data is an Object following the format below. For this example we will use a JSON file.
+    - The 'siteData' will always consist of a parent Object.
+    - The Objects contained within the 'siteData' parent Object should each represent a route path, except for the site wide data which should always be '\*'. The '\*' Object will represent data that is intended to be site wide, and can be empty or non-existent if desired. ***The Object names do not currently matter as long as they are referenced correctly when the 'tuiMeta' function is called. However, once tuijs-meta is integrated into TUI-Router, the naming standard for site data and route data will become important.***
+    - Inside the value of each site or route Object, there will be two important keys, 'title' and 'meta'. The 'title' key value will be a string representing the title of the site or page. The 'meta' key value will be an Array of Objects containing meta tag attributes. Each Object can contain as many or as few attributes as needed, but each Object will only ever represent one meta tag.
+
+```json
+{
+    "*": {
+        "title": "Site Title",
+        "meta": [
+            {
+                "property": "og:title",
+                "content": "Title"
+            },
+            {
+                "property": "og:description",
+                "content": "description"
+            },
+            {
+                "property": "og:image",
+                "content": "image/path"
+            },
+            {
+                "property": "og:url",
+                "content": "https://site/path"
+            },
+            {
+                "property": "og:type",
+                "content": "website"
+            }
+        ]
+    },
+    "/": {
+        "title": "Home Title",
+        "meta": [
+            {
+                "name": "description",
+                "content": "Home description"
+            },
+            {
+                "name": "keywords",
+                "content": "Home keywords"
+            }
+        ]
+    },
+    "/about": {
+        "title": "About Title",
+        "meta": [
+            {
+                "name": "description",
+                "content": "About description"
+            },
+            {
+                "name": "keywords",
+                "content": "About keywords"
+            }
+        ]
+    },
+    "/contact": {
+        "title": "Contact Title",
+        "meta": [
+            {
+                "name": "description",
+                "content": "Contact description"
+            },
+            {
+                "name": "keywords",
+                "content": "Contact keywords"
+            }
+        ]
+    },
+}
+```
+
+2. Import the primary function 'tuiMeta' from 'tuijs-meta'.
+    - If you are working with a multi-page app, this should be in the JS file for each page.
+    - If you you are working with a single-page app, this should be done where ever you route logic is.
+    - ***The 'tuiMeta' function is exported as default.***
+
+```js
+import tuiMeta from 'tuijs-meta';
+```
+
+3. Execute the 'tuiMeta function' using the desired site or route data from the siteData source. ***It is important to note that you must use one of the seconds Objects as the parameter and NOT the full site data Object.***
+    - In the following example, the site data is directly in the JS code and is provided as a parameter in the 'tuiMeta' function. In this case, the page head will populate with the HTML tags listed below.
+
+```js
+const siteData = {
+    '*': {
+        title: 'Site Title',
+        meta: [
+            {
+                name: 'description',
+                content: 'Site description'
+            },
+            {
+                name: 'keywords',
+                content: 'Site keywords'
+            }
+        ]
+    },
+}
+tuiMeta(siteData['*']);
+```
+```html
+<title>Site Title</title>
+<meta name="description" content="Site description">
+<meta name="keywords" content="Site keywords">
+```
+
+4. When the 'tuiMeta' function is called it will check the head for other existing meta tags that have key/value pairs that match exactly. If it finds any, they will be deleted allowing the new site or route meta data to be added. ***It should be noted that 'content' attributes are completely ignored during this check. So if a content key/value pair match, nothing will be deleted.***
+
+## How It Works
+1. When the 'tuiMeta' function is called, the site data provided is first checked to ensure that it is an Object.
+2. The function then validates that the 'title' key exists.
+    - If the 'title' key exists, the function attempts to update the document title with the 'title' key value.
+    - If the 'title' key DOES NOT exists, no error is generated and the function just moves on.
+2. The function then validates that the 'meta' key exists.
+    - If the 'meta' key exists, the function then validates that the value of the 'meta' key is an Array, throwing an error if it is not.
+    -If the 'meta' key value is an Array, then the function attempts to update the document meta tags with the 'meta' key Array data. As as reminder this Array consists of Objects, each representing a single meta tag. Within each Object, there is a set as many or as few key/value pairs as needed, each representing a single meta tag attribute and its value.
+    - If the 'meta' key DOES NOT exists, no error is generated and the function just moves on.

package/bin/index.js

@@ -1,40 +1,40 @@
-#! /usr/bin/env node
-import { checkUrl } from 'tuijs-util';
-import { consoleLog } from './lib/_logging.js';
-import createSiteMap from './lib/siteMap.js';
-
-(async () => {
-    try {
-        consoleLog({ type: 'info', message: `\n\n--------------------------\n` });
-        consoleLog({ type: 'info', message: `Attempting to generate site map...\n` });
-        const arg = process.argv.slice(2);
-        const data = {
-            configFile: '',
-            inputFile: '',
-            outputFile: 'sitemap.xml'
-        }
-
-        if (!arg[0]) {
-            throw new Error(`No arguments provided.`);
-        }
-        if (!arg[0].toLowerCase().endsWith('.json')) {
-            throw new Error(`The first argument must be a valid config JSON file.`);
-        }
-        data.configFile = arg[0];
-
-        if (!arg[1]) {
-            throw new Error(`No site data input file provided.`);
-        }
-        data.inputFile = arg[1];
-
-        if (!arg[2]) {
-            consoleLog({ type: 'warning', message: `No output file provided. Using the default 'sitemap.xml'.` });
-        }
-        data.outputFile = arg[2] || data.outputFile;
-        await createSiteMap(data.configFile, data.inputFile, data.outputFile);
-        return;
-    } catch (er) {
-        consoleLog({ type: 'error', message: `Error generating site map.` })
-        consoleLog({ type: 'error', message: er.toString() });
-    }
-})();
+#! /usr/bin/env node
+import { checkUrl } from 'tuijs-util';
+import { consoleLog } from './lib/_logging.js';
+import createSiteMap from './lib/siteMap.js';
+
+(async () => {
+    try {
+        consoleLog({ type: 'info', message: `\n\n--------------------------\n` });
+        consoleLog({ type: 'info', message: `Attempting to generate site map...\n` });
+        const arg = process.argv.slice(2);
+        const data = {
+            configFile: '',
+            inputFile: '',
+            outputFile: 'sitemap.xml'
+        }
+
+        if (!arg[0]) {
+            throw new Error(`No arguments provided.`);
+        }
+        if (!arg[0].toLowerCase().endsWith('.json')) {
+            throw new Error(`The first argument must be a valid config JSON file.`);
+        }
+        data.configFile = arg[0];
+
+        if (!arg[1]) {
+            throw new Error(`No site data input file provided.`);
+        }
+        data.inputFile = arg[1];
+
+        if (!arg[2]) {
+            consoleLog({ type: 'warning', message: `No output file provided. Using the default 'sitemap.xml'.` });
+        }
+        data.outputFile = arg[2] || data.outputFile;
+        await createSiteMap(data.configFile, data.inputFile, data.outputFile);
+        return;
+    } catch (er) {
+        consoleLog({ type: 'error', message: `Error generating site map.` })
+        consoleLog({ type: 'error', message: er.toString() });
+    }
+})();

package/bin/lib/_logging.js

@@ -1,8 +1,8 @@
-import { createSmartLogInstance } from 'smart-log-node';
-
-const logger = createSmartLogInstance();
-const { consoleLog } = logger;
-
-export default {
-    consoleLog
-}
+import { createSmartLogInstance } from 'smart-log-node';
+
+const logger = createSmartLogInstance();
+const { consoleLog } = logger;
+
+export default {
+    consoleLog
+}

package/bin/lib/_service.js

@@ -1,123 +1,123 @@
-import fs from 'fs';
-import path from 'path';
-import { pathToFileURL } from 'url';
-
-import { JSDOM } from 'jsdom';
-import { checkIsArray, checkIsObject } from 'tuijs-util';
-
-import { consoleLog } from './_logging.js';
-
-async function createSiteMap(configFile, inputFile, outputFile) {
-    try {
-        const data = fs.readFileSync(inputFile, 'utf-8');
-        let routeDataArray = [];
-
-        switch (inputFile.toLowerCase().split('.').pop()) {
-            case 'json':
-                routeDataArray = JSON.parse(data);
-                break;
-            case 'js':
-                const fileURL = pathToFileURL(path.resolve(inputFile));
-                const module = await import(fileURL);
-                routeDataArray = module.default || module;
-                break;
-            default:
-                throw new Error(`The provided inputFile is not a .json or .js file.`);
-        }
-        if (!checkIsArray(routeDataArray)) {
-            throw new Error(`The provided site data is not a valid JavaScript Array.`);
-        }
-
-        const dom = new JSDOM(elmSite(), { contentType: "text/xml" });
-        const document = dom.window.document;
-
-        for (let i = 0; i < routeDataArray.length; i++) {
-            const routeObject = routeDataArray[i];
-            if (!checkIsObject(routeObject)) {
-                consoleLog({ type: 'warning', message: `The provided site data array contains a non-object entry at index ${i}. Skipping this entry.` });
-                continue;
-            }
-
-            const routeObjectMapData = routeObject['map'];
-            if (!routeObjectMapData) {
-                consoleLog({ type: 'warning', message: `The provided site data object at index ${i} is missing the required 'map' property.` });
-                continue;
-            }
-
-            const routeObjectRoute = routeObject['route'];
-            if (!routeObjectRoute) {
-                consoleLog({ type: 'warning', message: `The provided site data object at index ${i} is missing the required 'route' property.` });
-                continue;
-            }
-            if (routeObjectRoute === '*') {
-                continue;
-            }
-
-            const routeElement = addRouteToMap(rootUrl, routeObjectRoute, routeObjectMapData, document);
-            document.querySelector("urlset").appendChild(routeElement);
-        }
-
-        const siteMapSerialized = new dom.window.XMLSerializer().serializeToString(document);
-        const xmlDeclaration = '<?xml version="1.0" encoding="UTF-8"?>\n';
-        const siteMapFinal = xmlDeclaration + siteMapSerialized;
-        createFile(outputFile, siteMapFinal);
-    } catch (er) {
-        throw new Error(er);
-    }
-}
-
-function elmSite() {
-    return `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"></urlset>`;
-}
-
-function addRouteToMap(root, route, data, document) {
-    try {
-        const elmUrl = document.createElementNS(null, 'url');
-        if (!elmUrl) {
-            throw new Error(`Could not create 'url' element.`);
-        }
-
-        const elmLoc = document.createElementNS(null, 'loc');
-        if (elmLoc) {
-            elmLoc.textContent = `${root}${route.startsWith('/') ? '' : '/'}${route}`;
-            elmUrl.appendChild(elmLoc);
-        }
-
-        for (const [key, value] of Object.entries(data)) {
-            const elmUrlChild = document.createElementNS(null, `${key}`);
-            if (elmUrlChild) {
-                elmUrlChild.textContent = value;
-                elmUrl.appendChild(elmUrlChild);
-            }
-        }
-
-        const elmLastMod = elmUrl.querySelector('lastmod');
-        if (elmLastMod) {
-            const date = new Date(elmLastMod.textContent || '');
-            elmLastMod.textContent = date.toISOString().split('T')[0];
-        }
-        elmUrl.appendChild(elmLastMod);
-
-        if (elmUrl.hasAttribute('xmlns')) {
-            elmUrl.removeAttribute('xmlns');
-        }
-
-        return elmUrl;
-    } catch (er) {
-        throw new Error(er);
-    }
-}
-
-function createFile(filePath, fileTemplate) {
-    try {
-        fs.writeFileSync(filePath, fileTemplate);
-        consoleLog({ type: 'info', message: `File '${filePath}' created.` });
-        return;
-    } catch (er) {
-        throw new Error(er);
-    }
-}
-
-export default {
-    createSiteMap
-}
+import fs from 'fs';
+import path from 'path';
+import { pathToFileURL } from 'url';
+
+import { JSDOM } from 'jsdom';
+import { checkIsArray, checkIsObject } from 'tuijs-util';
+
+import { consoleLog } from './_logging.js';
+
+async function createSiteMap(configFile, inputFile, outputFile) {
+    try {
+        const data = fs.readFileSync(inputFile, 'utf-8');
+        let routeDataArray = [];
+
+        switch (inputFile.toLowerCase().split('.').pop()) {
+            case 'json':
+                routeDataArray = JSON.parse(data);
+                break;
+            case 'js':
+                const fileURL = pathToFileURL(path.resolve(inputFile));
+                const module = await import(fileURL);
+                routeDataArray = module.default || module;
+                break;
+            default:
+                throw new Error(`The provided inputFile is not a .json or .js file.`);
+        }
+        if (!checkIsArray(routeDataArray)) {
+            throw new Error(`The provided site data is not a valid JavaScript Array.`);
+        }
+
+        const dom = new JSDOM(elmSite(), { contentType: "text/xml" });
+        const document = dom.window.document;
+
+        for (let i = 0; i < routeDataArray.length; i++) {
+            const routeObject = routeDataArray[i];
+            if (!checkIsObject(routeObject)) {
+                consoleLog({ type: 'warning', message: `The provided site data array contains a non-object entry at index ${i}. Skipping this entry.` });
+                continue;
+            }
+
+            const routeObjectMapData = routeObject['map'];
+            if (!routeObjectMapData) {
+                consoleLog({ type: 'warning', message: `The provided site data object at index ${i} is missing the required 'map' property.` });
+                continue;
+            }
+
+            const routeObjectRoute = routeObject['route'];
+            if (!routeObjectRoute) {
+                consoleLog({ type: 'warning', message: `The provided site data object at index ${i} is missing the required 'route' property.` });
+                continue;
+            }
+            if (routeObjectRoute === '*') {
+                continue;
+            }
+
+            const routeElement = addRouteToMap(rootUrl, routeObjectRoute, routeObjectMapData, document);
+            document.querySelector("urlset").appendChild(routeElement);
+        }
+
+        const siteMapSerialized = new dom.window.XMLSerializer().serializeToString(document);
+        const xmlDeclaration = '<?xml version="1.0" encoding="UTF-8"?>\n';
+        const siteMapFinal = xmlDeclaration + siteMapSerialized;
+        createFile(outputFile, siteMapFinal);
+    } catch (er) {
+        throw new Error(er);
+    }
+}
+
+function elmSite() {
+    return `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"></urlset>`;
+}
+
+function addRouteToMap(root, route, data, document) {
+    try {
+        const elmUrl = document.createElementNS(null, 'url');
+        if (!elmUrl) {
+            throw new Error(`Could not create 'url' element.`);
+        }
+
+        const elmLoc = document.createElementNS(null, 'loc');
+        if (elmLoc) {
+            elmLoc.textContent = `${root}${route.startsWith('/') ? '' : '/'}${route}`;
+            elmUrl.appendChild(elmLoc);
+        }
+
+        for (const [key, value] of Object.entries(data)) {
+            const elmUrlChild = document.createElementNS(null, `${key}`);
+            if (elmUrlChild) {
+                elmUrlChild.textContent = value;
+                elmUrl.appendChild(elmUrlChild);
+            }
+        }
+
+        const elmLastMod = elmUrl.querySelector('lastmod');
+        if (elmLastMod) {
+            const date = new Date(elmLastMod.textContent || '');
+            elmLastMod.textContent = date.toISOString().split('T')[0];
+        }
+        elmUrl.appendChild(elmLastMod);
+
+        if (elmUrl.hasAttribute('xmlns')) {
+            elmUrl.removeAttribute('xmlns');
+        }
+
+        return elmUrl;
+    } catch (er) {
+        throw new Error(er);
+    }
+}
+
+function createFile(filePath, fileTemplate) {
+    try {
+        fs.writeFileSync(filePath, fileTemplate);
+        consoleLog({ type: 'info', message: `File '${filePath}' created.` });
+        return;
+    } catch (er) {
+        throw new Error(er);
+    }
+}
+
+export default {
+    createSiteMap
+}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
-export { createMetaInstance, createMetaInstance as tuijsMeta } from "./lib/service.js";
+export { createMetaInstance } from './lib/service.js';
+export { createMetaInstance as tuiMeta } from "./lib/service.js";
 export type { MetaRoute, MetaTag, MetaTypeKey } from "./lib/models.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,IAAI,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvF,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,kBAAkB,IAAI,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACjE,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -1,3 +1,4 @@
-export { createMetaInstance, createMetaInstance as tuijsMeta } from "./lib/service.js";
+export { createMetaInstance } from './lib/service.js';
+export { createMetaInstance as tuiMeta } from "./lib/service.js";
 // TO DO - Update readme
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,IAAI,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAGvF,wBAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,kBAAkB,IAAI,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAGjE,wBAAwB"}

package/package.json

@@ -1,30 +1,30 @@
-{
-  "name": "tuijs-meta",
-  "version": "0.1.2",
-  "description": "A JavaScript utility that manipulates meta data tags based on provided data.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.js"
-    }
-  },
-  "author": "TechTB",
-  "license": "MIT",
-  "repository": "github:TechTB-OpenSource/tuijs-meta",
-  "type": "module",
-  "scripts": {
-    "clean": "rimraf dist",
-    "build": "npm run clean && tsc",
-    "sitemap": "node ./bin/index.js"
-  },
-  "dependencies": {
-    "tuijs-util": "^1.5.1"
-  },
-  "devDependencies": {
-    "rimraf": "^6.0.1",
-    "typescript": "^5.9.3"
-  }
-}
+{
+  "name": "tuijs-meta",
+  "version": "0.1.3",
+  "description": "A JavaScript utility that manipulates meta data tags based on provided data.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "author": "TechTB",
+  "license": "MIT",
+  "repository": "github:TechTB-OpenSource/tuijs-meta",
+  "type": "module",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && tsc",
+    "sitemap": "node ./bin/index.js"
+  },
+  "dependencies": {
+    "tuijs-util": "^1.5.1"
+  },
+  "devDependencies": {
+    "rimraf": "^6.1.3",
+    "typescript": "^5.9.3"
+  }
+}

package/src/index.ts

@@ -1,4 +1,5 @@
-export { createMetaInstance, createMetaInstance as tuijsMeta } from "./lib/service.js";
-export type { MetaRoute, MetaTag, MetaTypeKey } from "./lib/models.js";
-
-// TO DO - Update readme
+export { createMetaInstance } from './lib/service.js';
+export { createMetaInstance as tuiMeta } from "./lib/service.js";
+export type { MetaRoute, MetaTag, MetaTypeKey } from "./lib/models.js";
+
+// TO DO - Update readme

package/src/lib/models.ts

@@ -1,21 +1,21 @@
-export type MetaTypeKey = 'name' | 'property' | 'itemprop';
-
-export type MetaTag = {
-    [K in MetaTypeKey]?: string;
-} & {
-    content: string;
-};
-
-export interface MetaRoute {
-    route: string;
-    title?: string;
-    meta?: Array<MetaTag>;
-    map?: Map;
-}
-
-export interface Map {
-    loc: string;
-    lastmod?: string;
-    changefreq?: 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
-    priority?: number;
-}
+export type MetaTypeKey = 'name' | 'property' | 'itemprop';
+
+export type MetaTag = {
+    [K in MetaTypeKey]?: string;
+} & {
+    content: string;
+};
+
+export interface MetaRoute {
+    route: string;
+    title?: string;
+    meta?: Array<MetaTag>;
+    map?: Map;
+}
+
+export interface Map {
+    loc: string;
+    lastmod?: string;
+    changefreq?: 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
+    priority?: number;
+}

package/src/lib/service.ts

@@ -1,83 +1,83 @@
-import type { MetaRoute, MetaTag } from './models.js';
-
-export function createMetaInstance() {
-    const metaData: MetaRoute[] = [];
-
-    function setMetaData(metaRoutes: MetaRoute[]) {
-        metaData.length = 0;
-        metaData.push(...metaRoutes);
-    }
-
-    function metaUpdate(metaData: MetaTag[]) {
-        for (let i = 0; i < metaData.length; i++) {
-            metaUpdateTag(metaData[i]);
-        }
-    }
-
-    function metaRouteUpdate(route: string) {
-        let globalRouteMeta, specifiedRouteMeta: MetaRoute | undefined;
-        for (let i = 0; i < metaData.length; i++) {
-            const item = metaData[i];
-            if (item.route === '*') globalRouteMeta = item;
-            if (item.route === route) specifiedRouteMeta = item;
-            if (globalRouteMeta && specifiedRouteMeta) break;
-        }
-        if (!globalRouteMeta && !specifiedRouteMeta) {
-            console.error(`tuijs-meta: No meta data found for route "${route}", and no global meta route defined.`);
-            return;
-        }
-        if (globalRouteMeta) {
-            if (globalRouteMeta.meta) {
-                const globalMeta: MetaTag[] = globalRouteMeta.meta;
-                for (let i = 0; i < globalMeta.length; i++) {
-                    metaUpdateTag(globalMeta[i]);
-                }
-            }
-        }
-        if (!specifiedRouteMeta) {
-            document.title = globalRouteMeta?.title || 'Unknown Page';
-            console.warn(`tuijs-meta: No specific meta data found for route "${route}".`);
-            return;
-        }
-        if (specifiedRouteMeta.title) {
-            document.title = specifiedRouteMeta.title;
-        } else {
-            document.title = globalRouteMeta?.title || 'Unknown Page';
-        }
-        if (specifiedRouteMeta.meta) {
-            const dataMeta: MetaTag[] = specifiedRouteMeta.meta;
-            for (let i = 0; i < dataMeta.length; i++) {
-                metaUpdateTag(dataMeta[i]);
-            }
-        }
-        return;
-    }
-
-    function metaUpdateTag(newMetaTag: MetaTag) {
-        const existingMetaTagList = Array.from(document.getElementsByTagName('meta'));
-        
-        // Find the meta type key and value dynamically
-        const metaEntries = Object.entries(newMetaTag).filter(([key]) => key !== 'content');
-        const [typeKey, typeValue] = metaEntries[0];
-
-        // Remove existing meta tags that match the typeKey and typeValue
-        existingMetaTagList.forEach(existingMetaTag => {
-            if (existingMetaTag.getAttribute(typeKey) === typeValue) {
-                existingMetaTag.remove();
-            }
-        });
-
-        // Create and append the new meta tag
-        const elmMeta = document.createElement('meta');
-        elmMeta.setAttribute(typeKey, typeValue);
-        elmMeta.setAttribute('content', newMetaTag.content);
-        document.head.appendChild(elmMeta);
-        return true;
-    }
-
-    return {
-        setMetaData,
-        metaUpdate,
-        metaRouteUpdate
-    }
-}
+import type { MetaRoute, MetaTag } from './models.js';
+
+export function createMetaInstance() {
+    const metaData: MetaRoute[] = [];
+
+    function setMetaData(metaRoutes: MetaRoute[]) {
+        metaData.length = 0;
+        metaData.push(...metaRoutes);
+    }
+
+    function metaUpdate(metaData: MetaTag[]) {
+        for (let i = 0; i < metaData.length; i++) {
+            metaUpdateTag(metaData[i]);
+        }
+    }
+
+    function metaRouteUpdate(route: string) {
+        let globalRouteMeta, specifiedRouteMeta: MetaRoute | undefined;
+        for (let i = 0; i < metaData.length; i++) {
+            const item = metaData[i];
+            if (item.route === '*') globalRouteMeta = item;
+            if (item.route === route) specifiedRouteMeta = item;
+            if (globalRouteMeta && specifiedRouteMeta) break;
+        }
+        if (!globalRouteMeta && !specifiedRouteMeta) {
+            console.error(`tuijs-meta: No meta data found for route "${route}", and no global meta route defined.`);
+            return;
+        }
+        if (globalRouteMeta) {
+            if (globalRouteMeta.meta) {
+                const globalMeta: MetaTag[] = globalRouteMeta.meta;
+                for (let i = 0; i < globalMeta.length; i++) {
+                    metaUpdateTag(globalMeta[i]);
+                }
+            }
+        }
+        if (!specifiedRouteMeta) {
+            document.title = globalRouteMeta?.title || 'Unknown Page';
+            console.warn(`tuijs-meta: No specific meta data found for route "${route}".`);
+            return;
+        }
+        if (specifiedRouteMeta.title) {
+            document.title = specifiedRouteMeta.title;
+        } else {
+            document.title = globalRouteMeta?.title || 'Unknown Page';
+        }
+        if (specifiedRouteMeta.meta) {
+            const dataMeta: MetaTag[] = specifiedRouteMeta.meta;
+            for (let i = 0; i < dataMeta.length; i++) {
+                metaUpdateTag(dataMeta[i]);
+            }
+        }
+        return;
+    }
+
+    function metaUpdateTag(newMetaTag: MetaTag) {
+        const existingMetaTagList = Array.from(document.getElementsByTagName('meta'));
+        
+        // Find the meta type key and value dynamically
+        const metaEntries = Object.entries(newMetaTag).filter(([key]) => key !== 'content');
+        const [typeKey, typeValue] = metaEntries[0];
+
+        // Remove existing meta tags that match the typeKey and typeValue
+        existingMetaTagList.forEach(existingMetaTag => {
+            if (existingMetaTag.getAttribute(typeKey) === typeValue) {
+                existingMetaTag.remove();
+            }
+        });
+
+        // Create and append the new meta tag
+        const elmMeta = document.createElement('meta');
+        elmMeta.setAttribute(typeKey, typeValue);
+        elmMeta.setAttribute('content', newMetaTag.content);
+        document.head.appendChild(elmMeta);
+        return true;
+    }
+
+    return {
+        setMetaData,
+        metaUpdate,
+        metaRouteUpdate
+    }
+}

package/tsconfig.json

@@ -1,20 +1,20 @@
-{
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "./dist",
-    "module": "ES2022",
-    "target": "ES2020",
-    "lib": ["ES2020", "DOM"],
-    "moduleResolution": "node",
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "strict": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "forceConsistentCasingInFileNames": true,
-    "skipLibCheck": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "module": "ES2022",
+    "target": "ES2020",
+    "lib": ["ES2020", "DOM"],
+    "moduleResolution": "node",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}