s3db.js 13.6.0 → 14.0.2

package/src/plugins/api/concerns/failban-manager.js

@@ -32,9 +32,25 @@
  */
 
 import { requirePluginDependency } from '../../concerns/plugin-dependencies.js';
+import tryFn from '../../../concerns/try-fn.js';
+import { resolveResourceNames } from '../../concerns/resource-names.js';
 
 export class FailbanManager {
   constructor(options = {}) {
+    this.namespace = options.namespace || null;
+    const resourceOverrides = options.resourceNames || options.resources || {};
+    this._resourceDescriptors = {
+      bans: {
+        defaultName: 'plg_api_failban_bans',
+        override: resourceOverrides.bans
+      },
+      violations: {
+        defaultName: 'plg_api_failban_violations',
+        override: resourceOverrides.violations
+      }
+    };
+    this.resourceNames = this._resolveResourceNames();
+
     this.options = {
       enabled: options.enabled !== false,
       database: options.database,
@@ -52,7 +68,8 @@ export class FailbanManager {
         blockedCountries: options.geo?.blockedCountries || [],
         blockUnknown: options.geo?.blockUnknown || false,
         cacheResults: options.geo?.cacheResults !== false
-      }
+      },
+      resources: this.resourceNames
     };
 
     this.database = options.database;
@@ -64,6 +81,18 @@ export class FailbanManager {
     this.cleanupTimer = null;
   }
 
+  _resolveResourceNames() {
+    return resolveResourceNames('api_failban', this._resourceDescriptors, {
+      namespace: this.namespace
+    });
+  }
+
+  setNamespace(namespace) {
+    this.namespace = namespace;
+    this.resourceNames = this._resolveResourceNames();
+    this.options.resources = this.resourceNames;
+  }
+
   /**
    * Initialize failban manager
    */
@@ -119,52 +148,61 @@ export class FailbanManager {
    * @private
    */
   async _createBansResource() {
-    const resourceName = '_api_failban_bans';
-
+    const resourceName = this.resourceNames.bans;
     try {
       return await this.database.getResource(resourceName);
     } catch (err) {
-      const resource = await this.database.createResource({
-        name: resourceName,
-        attributes: {
-          ip: 'string|required',
-          reason: 'string',
-          violations: 'number',
-          bannedAt: 'string',
-          expiresAt: 'string|required',
-          metadata: {
-            userAgent: 'string',
-            path: 'string',
-            lastViolation: 'string'
-          }
-        },
-        behavior: 'body-overflow',
-        timestamps: true,
-        partitions: {
-          byExpiry: {
-            fields: { expiresAtCohort: 'string' }
-          }
+      // fall through
+    }
+
+    const [created, createErr, resource] = await tryFn(() => this.database.createResource({
+      name: resourceName,
+      attributes: {
+        ip: 'string|required',
+        reason: 'string',
+        violations: 'number',
+        bannedAt: 'string',
+        expiresAt: 'string|required',
+        metadata: {
+          userAgent: 'string',
+          path: 'string',
+          lastViolation: 'string'
         }
-      });
-
-      // Apply TTL plugin to this resource
-      const ttlPlugin = this.database.plugins?.ttl || this.database.plugins?.TTLPlugin;
-      if (ttlPlugin) {
-        ttlPlugin.options.resources = ttlPlugin.options.resources || {};
-        ttlPlugin.options.resources[resourceName] = {
-          enabled: true,
-          field: 'expiresAt'
-        };
-
-        if (this.options.verbose) {
-          console.log('[Failban] TTL configured for bans resource');
+      },
+      behavior: 'body-overflow',
+      timestamps: true,
+      partitions: {
+        byExpiry: {
+          fields: { expiresAtCohort: 'string' }
         }
-      } else {
-        console.warn('[Failban] TTLPlugin not found - bans will not auto-expire from DB');
       }
+    }));
 
-      return resource;
+    if (!created) {
+      const existing = this.database.resources?.[resourceName];
+      if (existing) {
+        return existing;
+      }
+      throw createErr;
     }
+
+    // Apply TTL plugin to this resource
+    const ttlPlugin = this.database.plugins?.ttl || this.database.plugins?.TTLPlugin;
+    if (ttlPlugin) {
+      ttlPlugin.options.resources = ttlPlugin.options.resources || {};
+      ttlPlugin.options.resources[resourceName] = {
+        enabled: true,
+        field: 'expiresAt'
+      };
+
+      if (this.options.verbose) {
+        console.log(`[Failban] TTL configured for bans resource (${resourceName})`);
+      }
+    } else {
+      console.warn('[Failban] TTLPlugin not found - bans will not auto-expire from DB');
+    }
+
+    return resource;
   }
 
   /**
@@ -172,29 +210,40 @@ export class FailbanManager {
    * @private
    */
   async _createViolationsResource() {
-    const resourceName = '_api_failban_violations';
-
+    const resourceName = this.resourceNames.violations;
     try {
       return await this.database.getResource(resourceName);
     } catch (err) {
-      return await this.database.createResource({
-        name: resourceName,
-        attributes: {
-          ip: 'string|required',
-          timestamp: 'string|required',
-          type: 'string',
-          path: 'string',
-          userAgent: 'string'
-        },
-        behavior: 'body-overflow',
-        timestamps: true,
-        partitions: {
-          byIp: {
-            fields: { ip: 'string' }
-          }
+      // fall through
+    }
+
+    const [created, createErr, resource] = await tryFn(() => this.database.createResource({
+      name: resourceName,
+      attributes: {
+        ip: 'string|required',
+        timestamp: 'string|required',
+        type: 'string',
+        path: 'string',
+        userAgent: 'string'
+      },
+      behavior: 'body-overflow',
+      timestamps: true,
+      partitions: {
+        byIp: {
+          fields: { ip: 'string' }
         }
-      });
+      }
+    }));
+
+    if (!created) {
+      const existing = this.database.resources?.[resourceName];
+      if (existing) {
+        return existing;
+      }
+      throw createErr;
     }
+
+    return resource;
   }
 
   /**

package/src/plugins/api/concerns/opengraph-helper.js

@@ -0,0 +1,116 @@
+/**
+ * OpenGraph Helper
+ *
+ * Generates OpenGraph and Twitter Card meta tags for social media previews.
+ *
+ * @example
+ * const og = new OpenGraphHelper({
+ *   siteName: 'My Site',
+ *   locale: 'en_US',
+ *   twitterSite: '@mysite'
+ * });
+ *
+ * const tags = og.generateTags({
+ *   title: 'Page Title',
+ *   description: 'Page description',
+ *   image: '/og-image.jpg',
+ *   url: 'https://example.com/page'
+ * });
+ */
+export class OpenGraphHelper {
+  constructor(defaults = {}) {
+    this.defaults = {
+      siteName: defaults.siteName || 'My Site',
+      locale: defaults.locale || 'en_US',
+      type: defaults.type || 'website',
+      twitterCard: defaults.twitterCard || 'summary_large_image',
+      twitterSite: defaults.twitterSite || null,
+      defaultImage: defaults.defaultImage || null
+    };
+  }
+
+  /**
+   * Generate OpenGraph meta tags
+   *
+   * @param {Object} data - OpenGraph data
+   * @param {string} data.title - Page title
+   * @param {string} data.description - Page description
+   * @param {string} data.image - Image URL (absolute or relative)
+   * @param {string} data.url - Canonical URL
+   * @param {string} data.type - Content type (default: 'website')
+   * @param {string} data.locale - Locale (default: from defaults)
+   * @param {string} data.siteName - Site name (default: from defaults)
+   * @param {string} data.imageAlt - Image alt text
+   * @param {number} data.imageWidth - Image width in pixels
+   * @param {number} data.imageHeight - Image height in pixels
+   * @param {string} data.twitterCard - Twitter card type (default: from defaults)
+   * @param {string} data.twitterSite - Twitter @username (default: from defaults)
+   * @param {string} data.twitterCreator - Twitter creator @username
+   * @returns {string} HTML meta tags
+   */
+  generateTags(data = {}) {
+    const og = { ...this.defaults, ...data };
+
+    // Use default image if none provided
+    const image = og.image || og.defaultImage;
+
+    const tags = [
+      // Basic OpenGraph
+      og.title && `<meta property="og:title" content="${this._escape(og.title)}">`,
+      og.description && `<meta property="og:description" content="${this._escape(og.description)}">`,
+      image && `<meta property="og:image" content="${this._escape(image)}">`,
+      og.url && `<meta property="og:url" content="${this._escape(og.url)}">`,
+      `<meta property="og:type" content="${this._escape(og.type)}">`,
+      `<meta property="og:site_name" content="${this._escape(og.siteName)}">`,
+      `<meta property="og:locale" content="${this._escape(og.locale)}">`,
+
+      // Image metadata
+      og.imageAlt && `<meta property="og:image:alt" content="${this._escape(og.imageAlt)}">`,
+      og.imageWidth && `<meta property="og:image:width" content="${og.imageWidth}">`,
+      og.imageHeight && `<meta property="og:image:height" content="${og.imageHeight}">`,
+
+      // Twitter Cards
+      `<meta name="twitter:card" content="${this._escape(og.twitterCard)}">`,
+      og.twitterSite && `<meta name="twitter:site" content="${this._escape(og.twitterSite)}">`,
+      og.twitterCreator && `<meta name="twitter:creator" content="${this._escape(og.twitterCreator)}">`,
+      og.title && `<meta name="twitter:title" content="${this._escape(og.title)}">`,
+      og.description && `<meta name="twitter:description" content="${this._escape(og.description)}">`,
+      image && `<meta name="twitter:image" content="${this._escape(image)}">`,
+    ];
+
+    return tags.filter(Boolean).join('\n    ');
+  }
+
+  /**
+   * Create Hono middleware that injects OG helper into context
+   *
+   * @example
+   * app.use('*', ogHelper.middleware());
+   *
+   * // In route handler:
+   * const ogTags = c.get('og')({ title: 'My Page', ... });
+   */
+  middleware() {
+    return async (c, next) => {
+      c.set('og', (data) => this.generateTags(data));
+      await next();
+    };
+  }
+
+  /**
+   * Escape HTML entities to prevent XSS
+   * @private
+   */
+  _escape(str) {
+    if (str === null || str === undefined) return '';
+
+    return String(str)
+      .replace(/&/g, '&amp;')
+      .replace(/</g, '&lt;')
+      .replace(/>/g, '&gt;')
+      .replace(/"/g, '&quot;')
+      .replace(/'/g, '&#039;');
+  }
+}
+
+export default OpenGraphHelper;