coralite 0.0.0-development

package/lib/coralite.js

@@ -0,0 +1,38 @@
+/**
+ * @import { CoraliteElement, CoraliteTextNode } from '#types'
+ */
+
+/**
+ * These exports are placeholder for types
+ * The HTML module code is run in the `parseScript` function in parse.js
+ */
+
+/**
+ * @type {Object.<string, string>}
+ */
+export const tokens = {}
+
+/**
+ * Defines a Coralite component
+ *
+ * @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 - A map where keys are token names and values are either strings or functions representing the corresponding tokens' content or behavior.
+ * @returns {Promise<Object.<string, string>>}
+ */
+export async function defineComponent (options) {
+  /** @type {Object.<string, string>} */
+  return {}
+}
+
+/**
+ * Aggregates HTML content from specified paths into a single collection of components.
+ *
+ * @param {Object} options - Configuration object for the aggregation process
+ * @param {string} options.componentId - Unique identifier for the component used for each document
+ * @param {string} options.path - The path to aggregate, relative to pages directory
+ * @returns {Promise<(CoraliteElement | CoraliteTextNode)[]>}
+ */
+export async function aggregate (options) {
+  return []
+}

package/lib/get-html.js

@@ -0,0 +1,64 @@
+import { extname, join } from 'node:path'
+import { readdir, readFile } from 'node:fs/promises'
+
+/**
+ * @import { HTMLData } from '#types'
+ */
+
+/**
+ * Get HTML
+ * @param {Object} options - Options for searching HTML files
+ * @param {string} options.path - Path to the directory containing HTML files
+ * @param {boolean} [options.recursive=false] - Whether to search recursively in subdirectories
+ * @param {string[]} [options.exclude=[]] - Files or directories to exclude from search
+ * @returns {Promise<HTMLData[]>} Array of HTML file data including parent path, name, and content
+ *
+ * @example
+ * // Example usage:
+ * const htmlFiles = await getHTML({
+ *  path: 'src',
+ *  recursive: true,
+ *  exclude: ['index.html', 'subdir/file2.html']
+ * })
+ */
+export default function getHTML ({ path, recursive = false, exclude = [] }) {
+  return new Promise((resolve, reject) => {
+    const html = []
+
+    readdir(path, {
+      recursive,
+      withFileTypes: true
+    })
+      .then(files => {
+        const promises = []
+        for (let i = 0; i < files.length; i++) {
+          const file = files[i]
+
+          if (file.isFile()
+            && extname(file.name).toLowerCase() === '.html'
+            && !exclude.includes(file.name)
+          ) {
+            const parentPath = file.parentPath || file.path
+
+            html.push({
+              parentPath,
+              name: file.name
+            })
+
+            promises.push(readFile(join(parentPath, file.name), { encoding: 'utf8' }))
+          }
+        }
+
+        Promise.all(promises)
+          .then(results => {
+            for (let i = 0; i < results.length; i++) {
+              html[i].content = results[i]
+            }
+
+            resolve(html)
+          })
+          .catch(error => reject(error))
+      })
+      .catch(error => reject(error))
+  })
+}

package/lib/html-module.js

@@ -0,0 +1,75 @@
+import { join } from 'node:path'
+import getHTML from './get-html.js'
+import { createComponent, parseHTMLMeta } from './parse.js'
+
+/**
+ * @import { CoraliteTokenOptions, CoraliteModule, CoraliteDocument } 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 {string} options.componentId - Unique identifier for the component
+ * @param {boolean} [options.recursive] - Whether to recursively search subdirectories
+ * @param {CoraliteTokenOptions} [options.tokens] - Token configuration options
+ * @param {Object.<string, string>} values - Default token values
+ * @param {Object.<string, CoraliteModule>} components - Available components library
+ * @param {CoraliteDocument} document - Current document being processed
+ *
+ * @example
+ * ```javascript
+ * // Aggregating content from pages under 'components' directory into a component with id 'my-component'
+ * aggregate({
+ *   path: 'button',
+ *   recursive: true,
+ *   componentId: 'my-component'
+ * }, {
+ *   className: 'btn'
+ * }, components, document);
+ * ```
+ */
+export async function aggregate (options, values, components, document) {
+  const pages = await getHTML({
+    path: join(document.path.pages, options.path),
+    recursive: options.recursive,
+    exclude: [document.name]
+  })
+
+  let result = []
+
+  for (let i = 0; i < pages.length; i++) {
+    const page = pages[i]
+    const meta = parseHTMLMeta(page.content)
+    const pageValues = Object.assign({}, values)
+
+    for (const key in meta) {
+      if (Object.prototype.hasOwnProperty.call(meta, key)) {
+        const data = meta[key]
+
+        for (let i = 0; i < data.length; i++) {
+          const item = data[i]
+          let suffix = ''
+
+          if (i > 0) {
+            suffix = '_' + i
+          }
+
+          pageValues[item.name + suffix] = item.content
+        }
+      }
+    }
+
+    const component = await createComponent({
+      id: options.componentId,
+      values: pageValues,
+      components,
+      document
+    })
+
+    result = result.concat(component.children)
+  }
+
+  return result
+}

package/lib/index.js

@@ -0,0 +1,8 @@
+import getHTML from './get-html.js'
+
+export * from './parse.js'
+export * from './path-utils.js'
+
+export {
+  getHTML
+}