@cocreate/sitemap 1.0.0

package/README.md

@@ -0,0 +1,91 @@
+# CoCreate-sitemap
+
+A simple sitemap component in vanilla javascript. Easily configured using HTML5 data-attributes and/or JavaScript API. Take it for a spin in our [playground!](https://cocreate.app/docs/sitemap)
+
+![min file size in bytes](https://img.badgesize.io/https://cdn.cocreate.app/sitemap/latest/CoCreate-sitemap.min.js?style=flat-square&label=minified&color=orange)
+![gzip file size in bytes](https://img.badgesize.io/https://cdn.cocreate.app/sitemap/latest/CoCreate-sitemap.min.js?compression=gzip&style=flat-square&label=gzip&color=yellow)
+![brotlifile size in bytes](https://img.badgesize.io/https://cdn.cocreate.app/sitemap/latest/CoCreate-sitemap.min.js?compression=brotli&style=flat-square&label=brotli)
+![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-sitemap?style=flat-square)
+![GitHub](https://img.shields.io/github/license/CoCreate-app/CoCreate-sitemap?style=flat-square)
+![GitHub](https://img.shields.io/static/v1?style=flat-square&label=&message=Hiring&color=blueviolet)
+
+![CoCreate-sitemap](https://cdn.cocreate.app/docs/CoCreate-sitemap.gif)
+
+## [Docs & Demo](https://cocreate.app/docs/sitemap)
+
+For a complete guide and working demo refer to the [doumentation](https://cocreate.app/docs/sitemap)
+
+## CDN
+
+```html
+<script src="https://cdn.cocreate.app/sitemap/latest/CoCreate-sitemap.min.js"></script>
+```
+
+```html
+<script src="https://cdn.cocreate.app/sitemap/latest/CoCreate-sitemap.min.css"></script>
+```
+
+## NPM
+
+```shell
+$ npm i @cocreate/sitemap
+```
+
+## yarn
+
+```shell
+$ yarn install @cocreate/sitemap
+```
+
+# Table of Contents
+
+-   [Table of Contents](#table-of-contents)
+-   [Announcements](#announcements)
+-   [Roadmap](#roadmap)
+-   [How to Contribute](#how-to-contribute)
+-   [About](#about)
+-   [License](#license)
+
+<a name="announcements"></a>
+
+# Announcements
+
+All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-sitemap/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-sitemap/releases). You may also subscribe to email for releases and breaking changes.
+
+<a name="roadmap"></a>
+
+# Roadmap
+
+If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/CoCreate-app/CoCreate-sitemap/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-sitemap/pulls). We would love to hear your feedback.
+
+<a name="about"></a>
+
+# About
+
+CoCreate-sitemap is guided and supported by the CoCreate Developer Experience Team.
+
+Please Email the Developer Experience Team [here](mailto:develop@cocreate.app) in case of any queries.
+
+CoCreate-sitemap is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
+
+<a name="contribute"></a>
+
+# How to Contribute
+
+We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreate-app/CoCreate-sitemap/blob/master/CONTRIBUTING.md) guide for details.
+
+We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/CoCreate-sitemap/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-sitemap/pulls) or merely upvote or comment on existing issues or pull requests.
+
+We appreciate your continued support, thank you!
+
+<a name="license"></a>
+
+# License
+
+This software is dual-licensed under the GNU Affero General Public License version 3 (AGPLv3) and a commercial license.
+
+-   **Open Source Use**: For open-source projects and non-commercial use, this software is available under the AGPLv3. The AGPLv3 allows you to freely use, modify, and distribute this software, provided that all modifications and derivative works are also licensed under the AGPLv3. For the full license text, see the [LICENSE file](https://github.com/CoCreate-app/CoCreate-sitemap/blob/master/LICENSE).
+
+-   **Commercial Use**: For-profit companies and individuals intending to use this software for commercial purposes must obtain a commercial license. The commercial license is available when you sign up for an API key on our [website](https://cocreate.app). This license permits proprietary use and modification of the software without the copyleft requirements of the AGPLv3. It is ideal for integrating this software into proprietary commercial products and applications.
+
+If you have not purchased a commercial license and intend to use this software for commercial purposes, you are required to sign up for an API key on our website.

package/demo/index.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8" />
+        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <link
+            rel="icon"
+            type="image/png"
+            sizes="32x32"
+            href="../assets/favicon.ico" />
+        <title>sitemap | CoCreateJS</title>
+    </head>
+
+    <body>
+        <script src="https://CoCreate.app/dist/CoCreate.js"></script>
+    </body>
+</html>

package/docs/index.html

@@ -0,0 +1,228 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8" />
+        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <title>CoCreate-sitemap Documentation | CoCreateJS</title>
+        <link
+            rel="icon"
+            type="image/png"
+            sizes="32x32"
+            href="https://cocreate.app/images/favicon.ico" />
+        <meta
+            name="description"
+            content="A simple HTML5 and pure javascript component. Easy configuration using data-attributes and highly styleable." />
+        <meta
+            name="keywords"
+            content="helper classes, utility classes, css framework, css library, inline style classes" />
+        <meta name="robots" content="index,follow" />
+
+        <!-- CoCreate CSS CDN -->
+    </head>
+
+    <body>
+        <div array="" object="" key="" id="cocreate-sitemap">
+            <div
+                class="display:flex flex-wrap:wrap justify-content:space-between margin:10px">
+                <div class="display:flex align-items:center">
+                    <h2>CoCreate-sitemap</h2>
+                </div>
+                <div
+                    class="display:flex align-items:center font-size:20px"
+                    share-height="600"
+                    share-width="500"
+                    share-media="https://via.placeholder.com/300/09f/fff.png">
+                    <a
+                        href="https://github.com/CoCreate-app/CoCreate-sitemap"
+                        target="_blank"
+                        class="margin-right:15px"
+                        ><i class="fab fa-github"></i
+                    ></a>
+                    <a
+                        class="margin-right:15px share"
+                        share-network="twitter"
+                        title="Share on twitter"
+                        ><i class="fab fa-twitter"></i
+                    ></a>
+                    <a
+                        class="margin-right:15px share"
+                        share-network="facebook"
+                        title="Share on Facebook"
+                        ><i class="fab fa-facebook"></i
+                    ></a>
+                    <a
+                        class="margin-right:15px share"
+                        share-network="instagram"
+                        title="Share on instagram"
+                        ><i class="fab fa-instagram"></i
+                    ></a>
+                    <a
+                        class="margin-right:15px share"
+                        share-network="share"
+                        title="Share on share"
+                        ><i class="fas fa-share-alt"></i
+                    ></a>
+                </div>
+            </div>
+            <h1 class="max-width:500px margin:20px_10px">
+                A simple HTML5, CSS and pure javascript component. Easy
+                configuration using data-attributes and highly styleable.
+            </h1>
+            <div id="sitemap-section" class="display:flex flex-wrap:wrap">
+                <div class="flex-grow:1 width:300px padding:20px_10px">
+                    <h2
+                        class="border-bottom:1px_solid_lightgrey padding:5px_0px">
+                        Install
+                    </h2>
+                    <pre
+                        class="margin-top:15px"><code class="language-javascript">npm install cocreate-sitemap</code></pre>
+                    <p class="padding:10px_0px">Or you can use cdn link:</p>
+                    <pre><code class="language-javascript">https://cdn.cocreate.app/js/CoCreate-sitemap.min.js</code></pre>
+
+                    <h2
+                        class="border-bottom:1px_solid_lightgrey margin-top:20px padding:5px_0px">
+                        Usage
+                    </h2>
+                    <p class="padding:10px_0px">sitemap usage content</p>
+                    <pre><code class="language-html">&lt;div&gt;&lt;/div&gt;</code></pre>
+
+                    <h2
+                        class="border-bottom:1px_solid_lightgrey margin-top:20px padding:5px_0px">
+                        Reference
+                    </h2>
+                    <p class="padding:10px_0px">
+                        This is sitemap reference content
+                    </p>
+                    <pre><code class="language-javascript">&lt;div&gt;&lt;/div&gt;</code></pre>
+                    <p class="padding:10px_0px">
+                        This is sitemap reference content
+                    </p>
+
+                    <h2
+                        class="border-bottom:1px_solid_lightgrey margin-top:20px padding:5px_0px">
+                        Attributes
+                    </h2>
+                    <ul class="list-style-type:none">
+                        <li
+                            class="padding:15px_0px border-bottom:1px_solid_lightgrey">
+                            <h4>
+                                <span>sitemap</span>
+                                <span class="cocreate-badge success"
+                                    >string</span
+                                >
+                                <span class="cocreate-badge warning"
+                                    >optional</span
+                                >
+                            </h4>
+                            <p>sitemap-attribute</p>
+                        </li>
+                        <li
+                            class="padding:15px_0px border-bottom:1px_solid_lightgrey">
+                            <h4>
+                                <span>sitemap</span>
+                                <span class="cocreate-badge success"
+                                    >string</span
+                                >
+                                <span class="cocreate-badge warning"
+                                    >optional</span
+                                >
+                            </h4>
+                            <p>sitemap-attribute</p>
+                        </li>
+                    </ul>
+                </div>
+
+                <div
+                    class="flex-grow:1 width:300px padding:0px_10px margin:20px_0px border-bottom:1px_solid_lightgrey">
+                    <!-- SandBox -->
+                    <h2
+                        class="border-bottom:1px_solid_lightgrey padding:5px_0px">
+                        Demo
+                    </h2>
+                    <div
+                        class="position:sticky top:0 padding:10px_0px height:100vh">
+                        <!-- SandBox -->
+                        <div
+                            class="display:flex flex-direction:column position:relative overflow:hidden card border-radius:2px width:auto height:600px margin-top:20px"
+                            id="playground">
+                            <div
+                                id="demo-code"
+                                resizable
+                                class="position:relative height:50%">
+                                <textarea
+                                    type="code"
+                                    lang="html"
+                                    array="demos"
+                                    object=""
+                                    key="demo"
+                                    save="false"
+                                    id="demo"
+                                    class="height:100% width:100% outline:none border:none resize:none padding:5px"></textarea>
+                                <div
+                                    resize="bottom"
+                                    class="background:lightgrey"></div>
+                            </div>
+
+                            <div
+                                id="demo-preview"
+                                class="position:relative overflow:auto background-color:white">
+                                <div
+                                    get-value="#demo"
+                                    class="padding:20px"></div>
+                            </div>
+
+                            <div
+                                class="font-size:20px position:absolute top:10px right:10px opacity:0.6">
+                                <a
+                                    class="margin-right:10px"
+                                    id="eye"
+                                    show="#eye-slash"
+                                    hide="#eye, #demo-preview"
+                                    toggle="code-height"
+                                    toggle-selector="#demo-code"
+                                    ><i class="far fa-eye"></i
+                                ></a>
+                                <a
+                                    class="margin-right:10px"
+                                    hidden
+                                    id="eye-slash"
+                                    show="#eye, #demo-preview"
+                                    hide="#eye-slash"
+                                    toggle="code-height"
+                                    toggle-selector="#demo-code"
+                                    ><i class="fas fa-eye-slash"></i
+                                ></a>
+                                <a
+                                    class="margin-right:10px"
+                                    id="code"
+                                    show="#code-slash"
+                                    hide="#code, #demo-code"
+                                    ><i class="fa fa-code"></i
+                                ></a>
+                                <a
+                                    class="margin-right:10px"
+                                    hidden
+                                    id="code-slash"
+                                    show="#code, #demo-code"
+                                    hide="#code-slash"
+                                    ><i class="fas fa-code"></i
+                                ></a>
+                                <a
+                                    class="margin-right:5px"
+                                    fullscreen
+                                    target="#playground"
+                                    ><i class="fas fa-expand"></i
+                                ></a>
+                            </div>
+                        </div>
+                        <!-- End SandBox -->
+                    </div>
+                </div>
+            </div>
+        </div>
+
+        <!--CoCreateJS-->
+        <script src="https://CoCreate.app/dist/CoCreate.js"></script>
+    </body>
+</html>

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@cocreate/sitemap",
+  "version": "1.0.0",
+  "description": "A simple sitemap component in vanilla javascript. Easily configured using HTML5 data-attributes and/or JavaScript API.",
+  "keywords": [
+    "sitemap",
+    "cocreate",
+    "low-code-framework",
+    "no-code-framework",
+    "cocreatejs",
+    "cocreatejs-component",
+    "cocreate-framework",
+    "no-code",
+    "low-code",
+    "collaborative-framework",
+    "realtime",
+    "realtime-framework",
+    "collaboration",
+    "shared-editing",
+    "html5-framework",
+    "javascript-framework"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "start": "npx webpack --config webpack.config.js",
+    "build": "npx webpack --mode=production --config webpack.config.js",
+    "dev": "npx webpack --config webpack.config.js --watch",
+    "postinstall": "node -e \"const { execSync } = require('child_process'); try { execSync('coc --version', { stdio: 'ignore' }); } catch (error) { try { execSync('npm install -g @cocreate/cli', { stdio: 'inherit' }); console.log('Installed \"@cocreate/cli\" globally.'); } catch (error) { console.error('Failed to install \"@cocreate/cli\" globally:', error); } }\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CoCreate-app/CoCreate-sitemap.git"
+  },
+  "author": "CoCreate LLC",
+  "license": "AGPL-3.0",
+  "bugs": {
+    "url": "https://github.com/CoCreate-app/CoCreate-sitemap/issues"
+  },
+  "homepage": "https://cocreate.app/docs/sitemap",
+  "funding": {
+    "type": "GitHub Sponsors ❤",
+    "url": "https://github.com/sponsors/CoCreate-app"
+  },
+  "main": "./src/index.js"
+}

package/release.config.js

@@ -0,0 +1,22 @@
+module.exports = {
+  dryRun: false,
+  branches: ["master"],
+  plugins: [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/changelog",
+      {
+        changelogFile: "CHANGELOG.md",
+      },
+    ],
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    [
+      "@semantic-release/git",
+      {
+        assets: ["CHANGELOG.md", "package.json"],
+      },
+    ],
+  ],
+};

package/src/index.js

@@ -0,0 +1,72 @@
+/********************************************************************************
+ * Copyright (C) 2023 CoCreate and Contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ ********************************************************************************/
+
+// Commercial Licensing Information:
+// For commercial use of this software without the copyleft provisions of the AGPLv3,
+// you must obtain a commercial license from CoCreate LLC.
+// For details, visit <https://cocreate.app/licenses/> or contact us at sales@cocreate.app.
+
+const fs = require('fs');
+
+class CoCreateSitemap {
+    constructor(render) {
+        this.render = render;
+    }
+
+    async updateUrlInSitemap(urlToFind) {
+        try {
+            // Path to your sitemap file
+            const sitemapPath = '/path/to/your/sitemap.xml';
+
+            // Read and parse the sitemap XML
+            let sitemapXml = fs.readFileSync(sitemapPath, 'utf8');
+
+            // Regex pattern to find the entire <url>...</url> block containing the URL
+            const regexPattern = `<url>\\s*<loc>${urlToFind}</loc>[\\s\\S]*?</url>`;
+
+            // Perform regex search
+            const match = sitemapXml.match(regexPattern);
+
+            if (match) {
+                const position = match.index; // Start position of the <url> block
+                const endPosition = match.index + match[0].length; // End position of the <url> block
+                console.log(`URL ${urlToFind} found in sitemap at position ${position}-${endPosition}.`);
+
+                // Replace the matched <url> block with a modified version (example)
+                const modifiedUrlBlock = `<url>
+          <loc>${urlToFind}</loc>
+          <lastmod>${new Date().toISOString()}</lastmod>
+          <priority>1.0</priority>
+        </url>`;
+
+                // Replace the original <url> block with the modified one
+                sitemapXml = sitemapXml.slice(0, position) + modifiedUrlBlock + sitemapXml.slice(endPosition);
+
+                // Write back the modified sitemap XML to the file (optional)
+                fs.writeFileSync(sitemapPath, sitemapXml);
+
+                console.log('Sitemap updated successfully.');
+            } else {
+                console.log(`URL ${urlToFind} not found in sitemap.`);
+            }
+        } catch (err) {
+            console.error('Error updating sitemap:', err);
+        }
+    }
+}
+
+module.exports = CoCreateSitemap;