@hkdigital/lib-core 0.5.12 → 0.5.13

package/dist/meta/robots/index.d.ts

@@ -0,0 +1,37 @@
+/** @typedef {import('./typedef.js').RobotsConfig} RobotsConfig */
+/**
+ * Check if hostname matches allowed hosts pattern
+ *
+ * @param {string} hostname - Hostname to check (e.g., test.mysite.com)
+ * @param {string[] | '*' | undefined} allowedHosts - Allowed host patterns
+ *
+ * @returns {boolean} True if host is allowed
+ */
+export function isHostAllowed(hostname: string, allowedHosts: string[] | "*" | undefined): boolean;
+/**
+ * Generate robots.txt with sitemap reference
+ *
+ * NOTE: If deployed behind a reverse proxy (nginx, Cloudflare, etc.),
+ * ensure your adapter is configured to trust proxy headers for correct
+ * origin detection:
+ *
+ * // svelte.config.js
+ * export default {
+ *   kit: {
+ *     adapter: adapter({
+ *       // Trust X-Forwarded-* headers from proxy
+ *       trustProxy: true
+ *     })
+ *   }
+ * };
+ *
+ * Without this, url.origin may be http://localhost instead of your
+ * actual domain, and the sitemap directive will be omitted.
+ *
+ * @param {URL} url - Request URL object
+ * @param {RobotsConfig} [config] - Robots configuration object
+ *
+ * @returns {string} robots.txt content
+ */
+export function generateRobotsTxt(url: URL, config?: RobotsConfig): string;
+export type RobotsConfig = import("./typedef.js").RobotsConfig;

package/dist/meta/robots/index.js

@@ -0,0 +1,83 @@
+/** @typedef {import('./typedef.js').RobotsConfig} RobotsConfig */
+
+/**
+ * Check if hostname matches allowed hosts pattern
+ *
+ * @param {string} hostname - Hostname to check (e.g., test.mysite.com)
+ * @param {string[] | '*' | undefined} allowedHosts - Allowed host patterns
+ *
+ * @returns {boolean} True if host is allowed
+ */
+export function isHostAllowed(hostname, allowedHosts) {
+  // If not configured or set to '*', allow all hosts
+  if (!allowedHosts || allowedHosts === '*') {
+    return true;
+  }
+
+  if (typeof allowedHosts === 'string') {
+    allowedHosts = [allowedHosts];
+  }
+
+  // Check if hostname matches any allowed pattern
+  return allowedHosts.some((pattern) => {
+    // Convert wildcard pattern to regex
+    // Example: *.mysite.com -> ^.*\.mysite\.com$
+    const regexPattern = pattern
+      .replace(/\./g, '\\.') // Escape dots
+      .replace(/\*/g, '.*'); // * becomes .*
+
+    const regex = new RegExp(`^${regexPattern}$`, 'i');
+    return regex.test(hostname);
+  });
+}
+
+/**
+ * Generate robots.txt with sitemap reference
+ *
+ * NOTE: If deployed behind a reverse proxy (nginx, Cloudflare, etc.),
+ * ensure your adapter is configured to trust proxy headers for correct
+ * origin detection:
+ *
+ * // svelte.config.js
+ * export default {
+ *   kit: {
+ *     adapter: adapter({
+ *       // Trust X-Forwarded-* headers from proxy
+ *       trustProxy: true
+ *     })
+ *   }
+ * };
+ *
+ * Without this, url.origin may be http://localhost instead of your
+ * actual domain, and the sitemap directive will be omitted.
+ *
+ * @param {URL} url - Request URL object
+ * @param {RobotsConfig} [config] - Robots configuration object
+ *
+ * @returns {string} robots.txt content
+ */
+export function generateRobotsTxt(url, config = {}) {
+  const hostAllowed = isHostAllowed(url.hostname, config.allowedHosts);
+
+  // Block entire site if host is not allowed
+  if (!hostAllowed) {
+    return 'User-agent: *\nDisallow: /';
+  }
+
+  // Allow site, but add specific path blocks
+  let content = 'User-agent: *\nAllow: /';
+
+  // Add disallowed paths
+  if (config.disallowedPaths && config.disallowedPaths.length > 0) {
+    config.disallowedPaths.forEach((path) => {
+      content += `\nDisallow: ${path}`;
+    });
+  }
+
+  // Add sitemap reference if enabled and origin is available
+  if (url.origin && config.includeSitemap !== false) {
+    content += `\nSitemap: ${url.origin}/sitemap.xml`;
+  }
+
+  return content;
+}

package/dist/meta/robots/typedef.d.ts

@@ -0,0 +1,17 @@
+declare const _default: {};
+export default _default;
+export type RobotsConfig = {
+    /**
+     * Allowed host patterns. Use '*' or omit to allow all hosts.
+     * Supports wildcards (e.g., '*.example.com')
+     */
+    allowedHosts?: string[] | "*" | undefined;
+    /**
+     * Paths to block from indexing (e.g., '/admin', '/api/*')
+     */
+    disallowedPaths?: string[] | undefined;
+    /**
+     * Include sitemap reference in robots.txt (default: true)
+     */
+    includeSitemap?: boolean | undefined;
+};

package/dist/meta/robots/typedef.js

@@ -0,0 +1,12 @@
+/**
+ * @typedef {Object} RobotsConfig
+ * @property {string[] | '*'} [allowedHosts]
+ *   Allowed host patterns. Use '*' or omit to allow all hosts.
+ *   Supports wildcards (e.g., '*.example.com')
+ * @property {string[]} [disallowedPaths]
+ *   Paths to block from indexing (e.g., '/admin', '/api/*')
+ * @property {boolean} [includeSitemap]
+ *   Include sitemap reference in robots.txt (default: true)
+ */
+
+export default {};

package/dist/meta/robots.d.ts

@@ -0,0 +1 @@
+export { generateRobotsTxt, isHostAllowed } from "./robots/index.js";

package/dist/meta/robots.js

@@ -0,0 +1,5 @@
+/**
+ * Public exports for robots.txt utilities
+ */
+
+export { generateRobotsTxt, isHostAllowed } from './robots/index.js';

package/dist/meta/sitemap/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generate sitemap XML
+ *
+ * @param {string} origin - Base URL (e.g., https://example.com)
+ * @param {SitemapRoute[]} [routes=[]] - Array of routes
+ *
+ * @returns {string} XML sitemap
+ */
+export function generateSitemap(origin: string, routes?: SitemapRoute[]): string;
+export type SitemapRoute = import("./typedef.js").SitemapRoute;
+export type SitemapRouteObject = import("./typedef.js").SitemapRouteObject;

package/dist/meta/sitemap/index.js

@@ -0,0 +1,63 @@
+// @see https://www.sitemaps.org/protocol.html
+
+/** @typedef {import('./typedef.js').SitemapRoute} SitemapRoute */
+/** @typedef {import('./typedef.js').SitemapRouteObject} SitemapRouteObject */
+
+/**
+ * Normalize route to full route object with defaults
+ *
+ * @param {import('./typedef.js').SitemapRoute} route - Route path string or route object
+ *
+ * @returns {SitemapRouteObject} Normalized route object
+ */
+function normalizeRoute(route) {
+  // Handle simple string format
+  if (typeof route === 'string') {
+    return {
+      path: route,
+      priority: route === '/' ? 1.0 : 0.8,
+      changefreq: route === '/' ? 'daily' : 'weekly'
+    };
+  }
+
+  // Handle object format with defaults
+  return {
+    priority: 0.8,
+    changefreq: 'weekly',
+    ...route
+  };
+}
+
+/**
+ * Generate sitemap XML
+ *
+ * @param {string} origin - Base URL (e.g., https://example.com)
+ * @param {SitemapRoute[]} [routes=[]] - Array of routes
+ *
+ * @returns {string} XML sitemap
+ */
+export function generateSitemap(origin, routes = []) {
+  // Ensure root path is always included (failsafe)
+  const hasRoot = routes.some((route) => {
+    const path = typeof route === 'string' ? route : route.path;
+    return path === '/';
+  });
+
+  const normalizedRoutes = hasRoot ? routes : ['/', ...routes];
+
+  const urls = normalizedRoutes
+    .map(normalizeRoute)
+    .map(
+      (route) => `
+  <url>
+    <loc>${origin}${route.path}</loc>
+    <changefreq>${route.changefreq}</changefreq>
+    <priority>${route.priority}</priority>
+  </url>`
+    )
+    .join('');
+
+  return `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">${urls}
+</urlset>`;
+}

package/dist/meta/sitemap/typedef.d.ts

@@ -0,0 +1,20 @@
+declare const _default: {};
+export default _default;
+export type SitemapRouteObject = {
+    /**
+     * - Route path (e.g., '/about')
+     */
+    path: string;
+    /**
+     * - Priority (0.0 to 1.0)
+     */
+    priority?: number | undefined;
+    /**
+     * - Change frequency
+     */
+    changefreq?: "hourly" | "daily" | "weekly" | "always" | "monthly" | "yearly" | "never" | undefined;
+};
+/**
+ * Route can be a simple string path or an object with details
+ */
+export type SitemapRoute = string | SitemapRouteObject;

package/dist/meta/sitemap/typedef.js

@@ -0,0 +1,14 @@
+/**
+ * @typedef {Object} SitemapRouteObject
+ * @property {string} path - Route path (e.g., '/about')
+ * @property {number} [priority] - Priority (0.0 to 1.0)
+ * @property {'always'|'hourly'|'daily'|'weekly'|'monthly'|'yearly'|'never'}
+ *   [changefreq] - Change frequency
+ */
+
+/**
+ * @typedef {string | SitemapRouteObject} SitemapRoute
+ *   Route can be a simple string path or an object with details
+ */
+
+export default {};

package/dist/meta/sitemap.d.ts

@@ -0,0 +1 @@
+export { generateSitemap } from "./sitemap/index.js";

package/dist/meta/sitemap.js

@@ -0,0 +1,5 @@
+/**
+ * Public exports for sitemap utilities
+ */
+
+export { generateSitemap } from './sitemap/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hkdigital/lib-core",
-	"version": "0.5.12",
+	"version": "0.5.13",
 	"author": {
 		"name": "HKdigital",
 		"url": "https://hkdigital.nl"