opentwig 1.0.7 → 1.1.0

package/API.md

@@ -0,0 +1,582 @@
+# Utility Functions API Reference
+
+This document provides detailed API documentation for all utility functions in OpenTwig.
+
+## Table of Contents
+
+- [Build Pipeline](#build-pipeline)
+- [Configuration](#configuration)
+- [Theme Management](#theme-management)
+- [Content Generation](#content-generation)
+- [File Operations](#file-operations)
+- [Utilities](#utilities)
+- [CLI Utilities](#cli-utilities)
+
+---
+
+## Build Pipeline
+
+### buildPage()
+
+**Location:** `src/utils/buildPage.js`
+
+Orchestrates the entire page building process by calling all generation functions.
+
+```javascript
+const buildPage = async (config) => { ... }
+```
+
+**Parameters:**
+- `config` (Object) - The configuration object
+
+**Returns:** `Promise<Object>` - Object containing:
+- `html` (String) - Generated HTML
+- `css` (String) - Processed CSS (or null if not found)
+- `ogImage` (Buffer) - Open Graph image buffer (JPG)
+- `qrImage` (String) - QR code SVG string
+- `theme` (Function) - Theme template function
+
+**Throws:** `Error` - If any step in the build process fails
+
+**Example:**
+```javascript
+const config = loadConfig();
+const { html, css, ogImage, qrImage, theme } = await buildPage(config);
+```
+
+---
+
+## Configuration
+
+### loadConfig()
+
+**Location:** `src/utils/loadConfig.js`
+
+Loads the configuration file from the current working directory and applies default values.
+
+```javascript
+const loadConfig = () => { ... }
+```
+
+**Parameters:** None
+
+**Returns:** `Object` - Configuration object with defaults applied
+
+**Exits:** Process exits with code 1 if `config.json` is not found
+
+**Example:**
+```javascript
+const config = loadConfig();
+console.log(config.theme); // 'default'
+console.log(config.name);  // 'Your Name'
+```
+
+### applyDefaults()
+
+**Location:** `src/utils/configDefaults.js`
+
+Applies default values to a configuration object. Avatar has special handling with no defaults.
+
+```javascript
+const applyDefaults = (config) => { ... }
+```
+
+**Parameters:**
+- `config` (Object) - The configuration object to apply defaults to
+
+**Returns:** `Object` - Configuration with defaults applied
+
+**Example:**
+```javascript
+const partialConfig = { theme: 'dark', name: 'John Doe' };
+const fullConfig = applyDefaults(partialConfig);
+// fullConfig now includes all default values for missing fields
+```
+
+### DEFAULT_CONFIG
+
+**Location:** `src/utils/configDefaults.js`
+
+Object containing all default configuration values.
+
+```javascript
+const DEFAULT_CONFIG = {
+    theme: 'default',
+    title: 'OpenTwig 🌿',
+    minify: true,
+    name: 'Your Name',
+    content: 'Hello World! Here is my bio.',
+    url: 'https://links.yourwebsite.com',
+    links: [],
+    footerLinks: [],
+    share: {
+        title: 'Your Name - opentwig 🌿',
+        url: 'https://links.yourwebsite.com',
+        text: 'Share'
+    }
+};
+```
+
+### SAMPLE_CONFIG
+
+**Location:** `src/utils/configDefaults.js`
+
+Complete sample configuration used by the `--init` command.
+
+```javascript
+const SAMPLE_CONFIG = {
+    theme: 'default',
+    url: 'https://links.yourwebsite.com',
+    title: 'Your Name - opentwig 🌿',
+    name: 'Your Name',
+    content: 'Hello World! Here is my bio.',
+    minify: true,
+    avatar: {
+        path: 'avatar.png'
+    },
+    links: [...],
+    footerLinks: [...],
+    share: { ... }
+};
+```
+
+---
+
+## Theme Management
+
+### loadTheme()
+
+**Location:** `src/utils/loadTheme.js`
+
+Loads the theme template function from the theme directory. Handles both NPX package and local development paths.
+
+```javascript
+const loadTheme = (config) => { ... }
+```
+
+**Parameters:**
+- `config` (Object) - Configuration object containing `theme` property
+
+**Returns:** `Function` - Theme template function that accepts `config` and returns HTML string
+
+**Exits:** Process exits with code 1 if theme is not found
+
+**Example:**
+```javascript
+const theme = loadTheme({ theme: 'dark' });
+const html = theme(config);
+```
+
+---
+
+## Content Generation
+
+### generateHTML()
+
+**Location:** `src/utils/generateHTML.js`
+
+Generates HTML by calling the theme template function and optionally minifies the output.
+
+```javascript
+const generateHTML = async (config, theme) => { ... }
+```
+
+**Parameters:**
+- `config` (Object) - Configuration object
+- `theme` (Function) - Theme template function
+
+**Returns:** `Promise<String>` - Generated HTML string
+
+**Example:**
+```javascript
+const html = await generateHTML(config, theme);
+console.log(html); // '<!DOCTYPE html>...'
+```
+
+### generateOGImage()
+
+**Location:** `src/utils/generateOGImage.js`
+
+Generates an Open Graph preview image (1200x630 JPG) with avatar and text content.
+
+```javascript
+const generateOGImage = async ({ name, content, avatar }) => { ... }
+```
+
+**Parameters:**
+- `name` (String) - Display name
+- `content` (String) - Bio/description text
+- `avatar` (Object, optional) - Avatar configuration with `path` property
+
+**Returns:** `Promise<Buffer>` - JPG image buffer
+
+**Example:**
+```javascript
+const ogImage = await generateOGImage({
+    name: 'John Doe',
+    content: 'Developer & Creator',
+    avatar: { path: './avatar.jpg' }
+});
+```
+
+**Notes:**
+- Supports SVG and raster avatar images (PNG, JPG, JPEG, WebP)
+- Automatically resizes and positions avatar in a circular clip
+- Uses dark gray background (#2d2d2d) with light text
+- Quality set to 90% for JPG compression
+
+### generateQR()
+
+**Location:** `src/utils/generateQR.js`
+
+Generates a QR code SVG for the given URL. Removes white background for transparency.
+
+```javascript
+const generateQR = async (url) => { ... }
+```
+
+**Parameters:**
+- `url` (String) - URL to encode in QR code
+
+**Returns:** `Promise<String>` - QR code SVG string
+
+**Example:**
+```javascript
+const qrCode = await generateQR('https://example.com');
+console.log(qrCode); // '<svg>...</svg>'
+```
+
+### processCSS()
+
+**Location:** `src/utils/processCSS.js`
+
+Processes theme CSS with PostCSS, autoprefixer, and optional minification.
+
+```javascript
+const processCSS = async (config) => { ... }
+```
+
+**Parameters:**
+- `config` (Object) - Configuration object containing `theme` and `minify` properties
+
+**Returns:** `Promise<String|null>` - Processed CSS string, or null if CSS file not found
+
+**Example:**
+```javascript
+const css = await processCSS({ theme: 'dark', minify: true });
+console.log(css); // 'body{background:#1a1a1a;color:#fff}...'
+```
+
+**Notes:**
+- Checks both NPX package path and local development path
+- Uses autoprefixer to add vendor prefixes
+- Minifies CSS if `config.minify` is true
+- Returns null silently if CSS file doesn't exist
+
+---
+
+## File Operations
+
+### saveFiles()
+
+**Location:** `src/utils/saveFiles.js`
+
+Saves all generated files to the `dist/` directory.
+
+```javascript
+const saveFiles = (html, css, avatar, ogImage, qrImage) => { ... }
+```
+
+**Parameters:**
+- `html` (String) - Generated HTML content
+- `css` (String, optional) - Processed CSS content
+- `avatar` (Object, optional) - Avatar configuration with `path` property
+- `ogImage` (Buffer) - Open Graph image buffer
+- `qrImage` (String) - QR code SVG string
+
+**Returns:** `undefined`
+
+**Creates:**
+- `dist/` directory if it doesn't exist
+- `dist/index.html` - Main HTML page
+- `dist/style.css` - Processed CSS (if provided)
+- `dist/avatar.{ext}` - Avatar image with original extension (if configured and file exists)
+- `dist/og-image.jpg` - Open Graph image
+- `dist/qr.svg` - QR code
+
+**Example:**
+```javascript
+saveFiles(
+    html,           // Generated HTML
+    css,            // Processed CSS
+    config.avatar,  // Avatar config
+    ogImage,        // OG image buffer
+    qrImage         // QR code SVG
+);
+```
+
+### readImageAsBase64()
+
+**Location:** `src/utils/readImageAsBase64.js`
+
+Reads an image file and returns it as base64-encoded string (for raster images) or raw SVG markup (for SVG files).
+
+```javascript
+const readImageAsBase64 = (imagePath) => { ... }
+```
+
+**Parameters:**
+- `imagePath` (String) - Path to image file
+
+**Returns:** `Object` - Object with properties:
+- `isSvg` (Boolean) - True if file is SVG, false otherwise
+- `content` (String) - Base64 data URI (raster) or raw SVG markup (SVG)
+
+**Throws:** `Error` - If file doesn't exist, isn't readable, or has unsupported format
+
+**Example:**
+```javascript
+const avatarInfo = readImageAsBase64('./avatar.jpg');
+console.log(avatarInfo.isSvg);    // false
+console.log(avatarInfo.content);  // 'data:image/jpeg;base64,/9j/4AAQSkZJRg...'
+
+const svgInfo = readImageAsBase64('./logo.svg');
+console.log(svgInfo.isSvg);       // true
+console.log(svgInfo.content);    // '<svg xmlns="http://www.w3.org/2000/svg">...'
+```
+
+**Supported formats:** PNG, JPG, JPEG, GIF, WebP, SVG
+
+---
+
+## Utilities
+
+### escapeHTML()
+
+**Location:** `src/utils/escapeHTML.js`
+
+Escapes HTML special characters to prevent XSS attacks.
+
+```javascript
+const escapeHTML = (str) => { ... }
+```
+
+**Parameters:**
+- `str` (String) - String to escape
+
+**Returns:** `String` - Escaped string
+
+**Example:**
+```javascript
+const safe = escapeHTML('<script>alert("xss")</script>');
+console.log(safe); // '&lt;script&gt;alert(&quot;xss&quot;)&lt;/script&gt;'
+```
+
+**Escaped characters:**
+- `&` → `&amp;`
+- `<` → `&lt;`
+- `>` → `&gt;`
+- `"` → `&quot;`
+- `'` → `&#39;`
+
+---
+
+## CLI Utilities
+
+### parseArgs()
+
+**Location:** `src/utils/parseArgs.js`
+
+Parses command-line arguments and returns the action to perform.
+
+```javascript
+const parseArgs = () => { ... }
+```
+
+**Parameters:** None (uses `process.argv`)
+
+**Returns:** `Object` - Object with properties:
+- `action` (String) - One of `'help'`, `'init'`, `'validate-config'`, or `'build'`
+
+**Example:**
+```javascript
+const args = parseArgs();
+if (args.action === 'help') {
+    showHelp();
+}
+```
+
+**Supported arguments:**
+- `--help` or `-h`: Show help
+- `--init` or `-i`: Create sample config
+- `--validate-config` or `-v`: Validate configuration
+- No arguments: Build page
+
+### showHelp()
+
+**Location:** `src/utils/showHelp.js`
+
+Displays help information about OpenTwig usage.
+
+```javascript
+const showHelp = () => { ... }
+```
+
+**Parameters:** None
+
+**Returns:** `undefined`
+
+**Example:**
+```javascript
+showHelp();
+```
+
+**Output:**
+```
+OpenTwig 🌿 - Open Source Link Page Generator
+
+Usage:
+  npx opentwig              Generate page from config.json
+  npx opentwig --init       Create sample config.json
+  npx opentwig --help       Show this help message
+  npx opentwig --validate-config  Validate config.json
+
+For more information, visit: https://github.com/tufantunc/opentwig
+```
+
+### createSampleConfig()
+
+**Location:** `src/utils/createSampleConfig.js`
+
+Creates a sample `config.json` file in the current directory.
+
+```javascript
+const createSampleConfig = () => { ... }
+```
+
+**Parameters:** None
+
+**Returns:** `undefined`
+
+**Side effects:**
+- Creates `config.json` file in current working directory
+- Logs success message
+- Exits process with code 0
+
+**Example:**
+```javascript
+createSampleConfig();
+```
+
+---
+
+## Constants
+
+**Location:** `src/constants.js`
+
+Centralized constants used throughout the application.
+
+```javascript
+const CONSTANTS = {
+    CONFIG_FILE: 'config.json',
+    OUTPUT_DIR: 'dist',
+    OUTPUT_FILES: {
+        HTML: 'index.html',
+        CSS: 'style.css',
+        OG_IMAGE: 'og-image.jpg',
+        QR_IMAGE: 'qr.svg'
+    },
+    SUPPORTED_THEMES: ['default', 'dark', 'minimal', 'colorful'],
+    MESSAGES: {
+        ERROR_PREFIX: 'ERROR: ',
+        SUCCESS_PREFIX: '✅ ',
+        CONFIG_NOT_FOUND: 'Configuration file not found',
+        BUILD_SUCCESS: 'Page built successfully!',
+        BUILD_FAILED: 'Failed to build page'
+    }
+};
+```
+
+---
+
+## Error Handling
+
+Most functions follow these error handling patterns:
+
+### Async Functions
+```javascript
+try {
+    const result = await someAsyncFunction();
+    return result;
+} catch (error) {
+    throw new Error(`Context: ${error.message}`);
+}
+```
+
+### Sync Functions with Exit
+```javascript
+if (!fs.existsSync(path)) {
+    console.error(`${CONSTANTS.MESSAGES.ERROR_PREFIX}File not found: ${path}`);
+    process.exit(1);
+}
+```
+
+### Errors that Should Be Handled
+- Missing `config.json` file
+- Invalid theme name
+- Avatar file not found
+- Invalid image format
+- CSS file not found (handled silently, returns null)
+
+---
+
+## Usage Examples
+
+### Complete Build Workflow
+```javascript
+const loadConfig = require('./src/utils/loadConfig');
+const buildPage = require('./src/utils/buildPage');
+const saveFiles = require('./src/utils/saveFiles');
+
+async function build() {
+    try {
+        const config = loadConfig();
+        const { html, css, ogImage, qrImage } = await buildPage(config);
+        saveFiles(html, css, config.avatar, ogImage, qrImage);
+        console.log('✅ Page built successfully!');
+    } catch (error) {
+        console.error(`❌ Error: ${error.message}`);
+        process.exit(1);
+    }
+}
+
+build();
+```
+
+### Custom Build with Specific Components
+```javascript
+const generateHTML = require('./src/utils/generateHTML');
+const generateOGImage = require('./src/utils/generateOGImage');
+const generateQR = require('./src/utils/generateQR');
+
+async function customBuild(config, theme) {
+    const html = await generateHTML(config, theme);
+    const ogImage = await generateOGImage({
+        name: config.name,
+        content: config.content,
+        avatar: config.avatar
+    });
+    const qrImage = await generateQR(config.url);
+
+    return { html, ogImage, qrImage };
+}
+```
+
+---
+
+## See Also
+
+- [Theme Development Guide](THEME_DEVELOPMENT.md) - How to create custom themes
+- [Contributing Guide](CONTRIBUTING.md) - Contribution guidelines
+- [README](README.md) - Main project documentation
+- [AGENTS.md](AGENTS.md) - Agent coding guidelines

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,91 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body block_size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting in which this project is developed
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement by contacting [the maintainer(s)] via e-mail at tufan@tufantunc.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+
+[homepage]: https://www.contributor-covenant.org
+[Mozilla CoC]: https://github.com/mozilla/diversity
+
+This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/deed.en_US).
+
+## Contact Information
+
+If you have any questions or concerns about this Code of Conduct, please contact the maintainers:
+
+- Tufan Tunç - tufan@tufantunc.com
+
+You can also reach out through:
+- GitHub Issues
+- GitHub Discussions