coralite 0.6.3 → 0.6.5

package/change-logs.md

@@ -1,3 +1,37 @@
+# 🎁 Release notes (`v0.6.5`)
+
+## Changes
+- 4610baa (HEAD -> main, tag: v0.6.5, origin/main) chore: version bump - (*Thomas David*)
+- be2511d ci: remove windows due to unavailability - (*Thomas David*)
+- 821f212 test: cover aggregate filter option - (*Thomas David*)
+- 48eaa76 docs: add CoraliteAggregate to aggregate param - (*Thomas David*)
+- 39ab5ba docs: add CoraliteAggregate typedef - (*Thomas David*)
+- 148dee9 feat: add filter to aggregate function - (*Thomas David*)
+- 15cf0fd docs: add CoraliteAggregate typedef - (*Thomas David*)
+- dbb5b8f feat: remove unused  parseHTMLMeta ignoreByAttribute param - (*Thomas David*)
+
+## Metadata
+```
+This version -------- v0.6.5
+Previous version ---- v0.6.4
+Total commits ------- 8
+```
+# 🎁 Release notes (`v0.6.4`)
+
+## Changes
+- 41771d5 (HEAD -> main, tag: v0.6.4, origin/main) chore: version bump - (*Thomas David*)
+- ea2ef46 test: cover values param - (*Thomas David*)
+- 60e70d3 feat: add props argument to tokens and slots functions - (*Thomas David*)
+- 1ed074a chore: version bump - (*Thomas David*)
+- 9d710c0 ci: fix publish needs ref - (*Thomas David*)
+
+## Metadata
+```
+This version -------- v0.6.4
+Previous version ---- v0.6.3
+Total commits ------- 5
+```
+
 # 🎁 Release notes (`v0.6.3`)
 
 ## Changes

package/lib/coralite.js

@@ -5,10 +5,10 @@ import render from 'dom-serializer'
  * @import {
  *  CoraliteElement,
  *  CoraliteTextNode,
- *  CoraliteAggregateTemplate,
  *  CoraliteAnyNode,
  *  CoraliteModule,
- *  CoraliteResult
+ *  CoraliteResult,
+ *  CoraliteAggregate
  * } from '#types'
  */
 
@@ -19,7 +19,13 @@ import render from 'dom-serializer'
 
 /**
  * @callback DefineComponentSlot
- * @param {CoraliteAnyNode[]} nodes
+ * @param {CoraliteAnyNode[]} nodes - The nodes to be rendered in the component's slots
+ * @param {Object.<string, string>} values - Attribute values
+ */
+
+/**
+ * @callback DefineComponentToken
+ * @param {Object.<string, string>} values - Attribute values
  */
 
 /**
@@ -32,7 +38,7 @@ export const tokens = {}
  *
  * @param {Object} options
  * @param {string} [options.id] - Optional component id, if not defined, the id will be extracted from the first top level element with the id attribute
- * @param {Object.<string, (string | Function)>} [options.tokens] - Token names and values are either strings or functions representing the corresponding tokens' content or behavior.
+ * @param {Object.<string, (string | DefineComponentToken)>} [options.tokens] - Token names and values are either strings or functions representing the corresponding tokens' content or behavior.
  * @param {Object.<string, DefineComponentSlot>} [options.slots] - Middleware for slot content
  * @returns {Promise<Object.<string, string>>}
  */
@@ -44,9 +50,7 @@ export async function defineComponent (options) {
 /**
  * Aggregates HTML content from specified paths into a single collection of components.
  *
- * @param {Object} options - Configuration object for the aggregation process
- * @param {CoraliteAggregateTemplate | string} options.template - Templates used to display the result
- * @param {string} options.path - The path to aggregate, relative to pages directory
+ * @param {CoraliteAggregate} options - Configuration object for the aggregation process
  * @returns {Promise<(CoraliteElement | CoraliteTextNode)[]>}
  */
 export async function aggregate (options) {

package/lib/html-module.js

@@ -4,17 +4,13 @@ import { createComponent, parseHTMLMeta } from './parse.js'
 import { existsSync } from 'node:fs'
 
 /**
- * @import { CoraliteTokenOptions, CoraliteModule, CoraliteDocument, CoraliteModuleValues, CoraliteAggregateTemplate } from '#types'
+ * @import { CoraliteTokenOptions, CoraliteModule, CoraliteDocument, CoraliteModuleValues, CoraliteAggregateTemplate, CoraliteAggregate } from '#types'
  */
 
 /**
  * Aggregates HTML content from specified paths into a single collection of components.
  *
- * @param {Object} options - Configuration object for the aggregation process
- * @param {string} options.path - The path to aggregate, relative to pages directory
- * @param {CoraliteAggregateTemplate | string} options.template - Templates used to display the result
- * @param {boolean} [options.recursive] - Whether to recursively search subdirectories
- * @param {CoraliteTokenOptions} [options.tokens] - Token configuration options
+ * @param {CoraliteAggregate} options - Configuration object for the aggregation process
  * @param {CoraliteModuleValues} values - Default token values
  * @param {Object.<string, CoraliteModule>} components - Available components library
  * @param {CoraliteDocument} document - Current document being processed
@@ -66,8 +62,10 @@ export async function aggregate (options, values, components, document) {
 
   for (let i = 0; i < pages.length; i++) {
     const page = pages[i]
-    const meta = parseHTMLMeta(page.content, document.ignoreByAttribute)
+    const meta = parseHTMLMeta(page.content)
     const pageValues = Object.assign({}, values)
+    let isFilter = !!options.filter
+    let ignorePage = false
 
     for (const key in meta) {
       if (Object.prototype.hasOwnProperty.call(meta, key)) {
@@ -77,6 +75,10 @@ export async function aggregate (options, values, components, document) {
           const item = data[i]
           let suffix = ''
 
+          if (isFilter && !ignorePage) {
+            ignorePage = options.filter(item)
+          }
+
           if (i > 0) {
             suffix = '_' + i
           }
@@ -86,6 +88,11 @@ export async function aggregate (options, values, components, document) {
       }
     }
 
+    // break if page is filtered
+    if (isFilter && !ignorePage) {
+      break
+    }
+
     const component = await createComponent({
       id: componentId,
       values: pageValues,

package/lib/parse.js

@@ -19,8 +19,8 @@ import { invalidCustomTags, validTags } from './tags.js'
  *  CoraliteDocumentRoot,
  *  CoraliteContentNode,
  *  CoraliteModuleValues,
- *  CoraliteAggregateTemplate,
- *  IgnoreByAttribute
+ *  IgnoreByAttribute,
+ CoraliteAggregate
  * } from '#types'
  */
 
@@ -153,7 +153,6 @@ export function parseHTMLDocument (html, path, ignoreByAttribute) {
  * Parses HTML string containing meta tags and extracts associated metadata.
  *
  * @param {string} string - HTML content containing meta tags
- * @param {IgnoreByAttribute} ignoreByAttribute - IgnoreByAttribute option (optional) - If provided and true then the HTML tags will be ignored by this attribute name(s)
  * @returns {Object.<string, CoraliteToken[]>}
  *
  * @example
@@ -168,7 +167,7 @@ export function parseHTMLDocument (html, path, ignoreByAttribute) {
  * //}
  * ```
  */
-export function parseHTMLMeta (string, ignoreByAttribute) {
+export function parseHTMLMeta (string) {
   // stack to keep track of current element hierarchy
   const stack = []
   /** @type {Object.<string, CoraliteToken[]>} */
@@ -179,15 +178,6 @@ export function parseHTMLMeta (string, ignoreByAttribute) {
     onopentag (name, attributes) {
       if (name === 'meta') {
         if (attributes.content) {
-          if (ignoreByAttribute) {
-            // ignore meta tags by attribute name
-            const ignore = findAttributesToIgnore(ignoreByAttribute, attributes)
-
-            if (ignore) {
-              return
-            }
-          }
-
           if (attributes.property) {
             addMetadata(meta, attributes.property, attributes.content)
           }
@@ -697,7 +687,7 @@ export async function parseScript ({
        */
       async defineComponent (options) {
         /** @type {Object.<string, string>} */
-        const values = {}
+        const tokens = {}
 
         if (options.tokens) {
           for (const key in options.tokens) {
@@ -705,7 +695,7 @@ export async function parseScript ({
               const token = options.tokens[key]
 
               if (typeof token === 'function') {
-                values[key] = await token()
+                tokens[key] = await token(values)
               }
             }
           }
@@ -733,7 +723,7 @@ export async function parseScript ({
               }
 
               // compute slot nodes
-              const result = computedSlot(slotContent) || slotContent
+              const result = computedSlot(slotContent, values) || slotContent
 
               // append new slot nodes
               for (let index = 0; index < result.length; index++) {
@@ -751,7 +741,7 @@ export async function parseScript ({
           }
         }
 
-        return values
+        return tokens
       },
       /**
        * @overload
@@ -761,9 +751,7 @@ export async function parseScript ({
        */
 
       /**
-       * @param {Object} options
-       * @param {CoraliteAggregateTemplate} options.template - Templates used to display the result
-       * @param {string} options.path
+       * @param {CoraliteAggregate} options
        */
       async aggregate (options) {
         /** @type {string} */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coralite",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "HTML modules static site generator",
   "main": "./lib/coralite.js",
   "type": "module",

package/types/index.js

@@ -141,3 +141,12 @@
 /**
  * @typedef {Array<Array<string, string>>} IgnoreByAttribute - An array of attribute names and values to ignore by element type.
  */
+
+/**
+ * @typedef {Object} CoraliteAggregate – Configuration object for the aggregation process
+ * @property {string} path - The path to aggregate, relative to pages directory
+ * @property {CoraliteAggregateTemplate | string} template - Templates used to display the result
+ * @property {Function} [filter] - A function to filter out unwanted elements from the aggregated content.
+ * @property {boolean} [recursive] - Whether to recursively search subdirectories
+ * @property {CoraliteTokenOptions} [tokens] - Token configuration options
+ */