coralite-plugin-aggregation 0.1.0 → 0.2.0

package/README.md

@@ -58,7 +58,7 @@ Create a file like `coralite-posts.html` to define your aggregation logic and re
 </template>
 
 <script type="module">
-import { defineComponent, aggregation } from 'coralite'
+import { defineComponent, aggregation } from 'coralite/plugins'
 
 export default defineComponent({
   tokens: {
@@ -133,7 +133,7 @@ Define a `<template>` element for rendering individual items:
 </template>
 
 <script type="module">
-import { defineComponent } from 'coralite'
+import { defineComponent } from 'coralite/plugins'
 
 export default defineComponent({
   tokens: {

package/changelog.md

@@ -1,10 +1,42 @@
 # 🎁 Complete Release History
 
-## Initial Release: `v0.1.0`
+## Release: `v0.1.2`
+
+### Changes from `v0.1.0` to `v0.1.2`
+
+- cb7205a (HEAD -> main, tag: v0.1.2) chore: version bump - ([Thomas David](https://codeberg.org/tjdavid))
+- 042b730 (origin/main) fix: rename meta to values in sort function - ([Thomas David](https://codeberg.org/tjdavid))
+- b4dc56a refactor: remove unused parsePagination function - ([Thomas David](https://codeberg.org/tjdavid))
+- c61a727 (tag: v0.1.1) 0.1.1 - ([Thomas David](https://codeberg.org/tjdavid))
+- 3e0dcec feat: changelog script - ([Thomas David](https://codeberg.org/tjdavid))
+
+### Metadata
+```
+This version -------- v0.1.2
+Previous version ---- v0.1.0
+Total commits ------- 5
+```
+
+## Release: `v0.1.0`
+
+### Changes from `v0.1.1` to `v0.1.0`
+
+
+### Metadata
+```
+This version -------- v0.1.0
+Previous version ---- v0.1.1
+Total commits ------- 0
+```
+
+## Initial Release: `v0.1.1`
 
 ### Initial Commits
 
-- 2b0f1dc (HEAD -> main, tag: v0.1.0, origin/main) feat: Implement dynamic pagination with visible items and ellipsis - ([Thomas David](https://codeberg.org/tjdavid))
+- c61a727 (tag: v0.1.1) 0.1.1 - ([Thomas David](https://codeberg.org/tjdavid))
+- 3e0dcec feat: changelog script - ([Thomas David](https://codeberg.org/tjdavid))
+- edcda41 chore: add changelog - ([Thomas David](https://codeberg.org/tjdavid))
+- 2b0f1dc (tag: v0.1.0) feat: Implement dynamic pagination with visible items and ellipsis - ([Thomas David](https://codeberg.org/tjdavid))
 - 6b4d75f test: add fixtures to cover visibility feature - ([Thomas David](https://codeberg.org/tjdavid))
 - 70f5a4b add npm ignore list - ([Thomas David](https://codeberg.org/tjdavid))
 - 48cf1e0 docs: Add custom pager template user guide - ([Thomas David](https://codeberg.org/tjdavid))
@@ -19,7 +51,7 @@
 - 74ba4a0 fix: simplify page limit handling by removing array check and using offset correctly - ([Thomas David](https://codeberg.org/tjdavid))
 - 2cf82e6 refactor: Use tokens instead of values in component definitions - ([Thomas David](https://codeberg.org/tjdavid))
 - b5fde9d fix: fix previous navigation link generation in pagination - ([Thomas David](https://codeberg.org/tjdavid))
-    Correctly adjust the "Previous" link href based on current index to ensure proper
+    Correctly adjust the “Previous” link href based on current index to ensure proper
     navigation when on pages beyond the second one. The fix updates the logic to
     reference the correct page number for the previous item, resolving invalid
     navigation links in multi-page scenarios.
@@ -31,7 +63,7 @@
 - 4879d44 refactor: rename values to tokens in pagination_list - ([Thomas David](https://codeberg.org/tjdavid))
 - 3b06c3c chore: upgrade coralite to 0.11.1 - ([Thomas David](https://codeberg.org/tjdavid))
 - cfa07cb chore: update coralite to 0.10.0 - ([Thomas David](https://codeberg.org/tjdavid))
-- 320f665 chore: add "type": "module" to package.json - ([Thomas David](https://codeberg.org/tjdavid))
+- 320f665 chore: add “type”: “module” to package.json - ([Thomas David](https://codeberg.org/tjdavid))
 - 0ad0f60 chore: update repository and issues URLs in package.json - ([Thomas David](https://codeberg.org/tjdavid))
 - 679b3cf fix: use import.meta.dirname for template path - ([Thomas David](https://codeberg.org/tjdavid))
 - 093b1ea fix: ensure context scope for new components - ([Thomas David](https://codeberg.org/tjdavid))
@@ -77,12 +109,12 @@
 
 ### Metadata
 ```
-First version ------- v0.1.0
-Total commits ------- 47
+First version ------- v0.1.1
+Total commits ------- 50
 ```
 
 ## Summary
 ```
-Total releases ------ 1
-Total commits ------- 47
+Total releases ------ 3
+Total commits ------- 55
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coralite-plugin-aggregation",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Build database free coralite websites",
   "scripts": {
     "build": "coralite -t tests/fixtures/templates -p tests/fixtures/pages -o dist",
@@ -33,12 +33,12 @@
     }
   },
   "license": "AGPL-3.0-only",
-  "packageManager": "pnpm@10.12.1",
+  "packageManager": "pnpm@10.13.1",
   "devDependencies": {
     "@playwright/test": "^1.52.0",
     "@stylistic/eslint-plugin-js": "^4.2.0",
     "@stylistic/eslint-plugin-plus": "^4.2.0",
-    "coralite": "^0.11.1",
+    "coralite": "^0.12.0",
     "sirv-cli": "^3.0.1"
   },
   "dependencies": {
@@ -46,6 +46,6 @@
     "htmlparser2": "^10.0.0"
   },
   "peerDependencies": {
-    "coralite": "^0.11.2"
+    "coralite": "^0.12.0"
   }
 }

package/src/index.js

@@ -1,12 +1,6 @@
 import { join } from 'node:path'
 import { existsSync } from 'node:fs'
-import { Parser } from 'htmlparser2'
-import {
-  getHtmlFiles,
-  createElement,
-  createTextNode,
-  createPlugin,
-} from 'coralite/utils'
+import { getHtmlFiles, createPlugin, } from 'coralite/utils'
 
 /**
  * @import {CoraliteAnyNode, CoraliteCollectionItem, CoraliteContentNode, CoraliteDocumentRoot} from 'coralite/types'
@@ -79,11 +73,11 @@ export default createPlugin({
     let endIndex = pages.length
     let paginationOffset = context.values.pagination_offset
 
-    // Sort results based on custom sort function
+    // sort results based on custom sort function
     if (typeof options.sort === 'function') {
       pages.sort((a, b) => {
-        const metaA = a.result.meta
-        const metaB = b.result.meta
+        const metaA = a.result.values
+        const metaB = b.result.values
 
         return options.sort(metaA, metaB)
       })
@@ -97,7 +91,7 @@ export default createPlugin({
         const metadata = page.result.values
         let keepItem = false
 
-        // Process metadata and populate token values for rendering
+        // process metadata and populate token values for rendering
         for (const key in metadata) {
           if (Object.prototype.hasOwnProperty.call(metadata, key)) {
             const data = metadata[key]
@@ -110,7 +104,7 @@ export default createPlugin({
                 }
               }
             } else {
-              // Handle single metadata item
+              // handle single metadata item
               if (!keepItem) {
                 keepItem = options.filter({
                   name: key,
@@ -130,7 +124,7 @@ export default createPlugin({
       endIndex = pages.length
     }
 
-    // Apply page offset
+    // apply page offset
     if (Object.prototype.hasOwnProperty.call(options, 'offset') || paginationOffset != null) {
       let offset = paginationOffset || options.offset
 
@@ -192,6 +186,7 @@ export default createPlugin({
       }
     }
 
+    // process pagination
     if (options.pagination) {
       const pagination = options.pagination
       const paginationPath = context.values.pagination_path || pagination.path || 'page'
@@ -239,7 +234,7 @@ export default createPlugin({
             }
 
             // add pagination page to render queue
-            this.addRenderQueue({
+            await this.addRenderQueue({
               values: {
                 pagination_pager_dirname: path.dirname,
                 pagination_pager_index: pageIndex,
@@ -280,94 +275,84 @@ export default createPlugin({
         values = context.values
         this.values[contextId] = values
       }
-
+      
       const templateId = pagination.template || 'coralite-pagination'
 
-      const component = await this.createComponent({
-        id: templateId,
-        values,
-        document: context.document,
-        contextId: contextId + templateId
-      })
+      if (typeof templateId === 'string') {
+        const component = await this.createComponent({
+          id: templateId,
+          values,
+          document: context.document,
+          contextId: contextId + templateId
+        })
 
-      if (typeof component === 'object') {
-        result = result.concat(component.children)
+        if (typeof component === 'object') {
+          result = result.concat(component.children)
+        }
       }
     }
 
     return result
   },
-  templates: [join(import.meta.dirname, 'templates/coralite-pagination.html')]
-})
+  async onPageCreate ({ elements, values, data }) {
+    // loop through all children of the root element to process metadata in <head> tags.
+    for (let i = 0; i < elements.root.children.length; i++) {
+      const rootNode = elements.root.children[i]
+      
+      // traverse html children to find the head element
+      if (rootNode.type === 'tag' && rootNode.name === 'html') {
+        for (let i = 0; i < rootNode.children.length; i++) {
+          const node = rootNode.children[i];
+          
+          // check if the current node is a <head> tag where metadata is typically found.
+          if (node.type === 'tag' && node.name === 'head') {
+            // iterate over the children of the head element to locate meta tags or component slots.
+            for (let i = 0; i < node.children.length; i++) {
+              const element = node.children[i]
+              
+              // if the element is a tag named "meta" with both name and content attributes, store its metadata.
+              if (element.type === 'tag') {
+                if (element.name === 'meta'
+                  && element.attribs.name
+                  && element.attribs.content
+                ) {
+                  values['$' + element.attribs.name] = element.attribs.content
+                } else if (element.slots) {
+                  // process component slots by creating a component dynamically.
+                  const component = await this.createComponent({
+                    id: element.name,
+                    values,
+                    element,
+                    document: data.result,
+                    contextId: data.path.pathname + i + element.name
+                  })
+                  
+                  // if the created component returns valid children, iterate over them to extract meta information.
+                  if (component) {
+                    for (let i = 0; i < component.children.length; i++) {
+                      const element = component.children[i];
+                      
+                      // for each child element in the component's returned HTML,
+                      // check if it is a meta tag and store its metadata with a '$' prefix.
+                      if (element.type === 'tag'
+                        && element.name === 'meta' 
+                        && element.attribs.name
+                        && element.attribs.content
+                      ) {
+                        values['$' + element.attribs.name] = element.attribs.content
+                      }
+                    }
+                  }
+                }
+              }
+            }
 
-/**
- * Parse HTML content and return a CoraliteDocument object representing the parsed document structure
- *
- * @param {string} string - The HTML content to parse. This should be a valid HTML string input.
- * @param {Object} pagination - Configuration object for pagination templates
- * @param {string} pagination.template - The template tag name used to identify pagination elements
- * @param {Object.<string, string>} pagination.attributes - Additional attributes to merge into the template element
- * @example parsePagination('<pagination-element></pagination-element>', {
- *   template: 'pagination-element',
- *   attributes: { class: 'custom-pagination' }
- * })
- */
-export function parsePagination (string, meta) {
-  // root element reference
-  /** @type {CoraliteDocumentRoot} */
-  const root = {
-    type: 'root',
-    children: []
-  }
-
-  // stack to keep track of current element hierarchy
-  /** @type {CoraliteContentNode[]} */
-  const stack = [root]
-  const parser = new Parser({
-    onprocessinginstruction (name, data) {
-      root.children.push({
-        type: 'directive',
-        name,
-        data
-      })
-    },
-    onopentag (originalName, attributes) {
-      const parent = stack[stack.length - 1]
-      const element = createElement({
-        name: originalName,
-        attributes,
-        parent
-      })
-      // push element to stack as it may have children
-      stack.push(element)
-    },
-    ontext (text) {
-      const parent = stack[stack.length - 1]
-
-      createTextNode(text, parent)
-    },
-    onclosetag () {
-      const parent = stack[stack.length - 1]
-
-      if (parent.type === 'tag' && parent.name === 'head') {
-       
+            // once the <head> tag is processed, return to exit the loop.
+            return
+          }
+        }  
       }
-      // remove current element from stack as we're done with its children
-      stack.pop()
-    },
-    oncomment (data) {
-      const parent = stack[stack.length - 1]
-
-      parent.children.push({
-        type: 'comment',
-        data,
-        parent
-      })
     }
-  })
-
-  parser.write(string)
-  parser.end()
-
-  return root
-}
+  },
+  templates: [join(import.meta.dirname, 'templates/coralite-pagination.html')]
+})

package/src/templates/coralite-pagination.html

@@ -3,7 +3,8 @@
 </template>
 
 <script type="module">
-  import { defineComponent, document } from 'coralite'
+  import { document } from 'coralite'
+  import { defineComponent } from 'coralite/plugins'
 
   export default defineComponent({
     tokens: {