All files / integrations/src/nextjs coherent-nextjs.js

42.64% Statements 29/68
47.82% Branches 11/23
52.94% Functions 9/17
42.64% Lines 29/68

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262                                                                    4x 4x 2x 2x           4x                         3x 1x   1x             1x 1x                                       3x 1x   1x             1x                                                         3x   3x   3x 3x   3x       3x           3x         3x       3x                                           1x   1x   1x 1x   1x                                                                 1x                                                                                              
/**
 * Next.js integration for Coherent.js
 * Provides utilities for using Coherent.js with Next.js
 */
 
import {
  render,
  performanceMonitor,
  renderComponentFactory
} from '@coherent.js/core';
 
function missingPeer(packageName, integrationName, cause) {
  const error = new Error(
    `${integrationName} requires the '${packageName}' package to be installed.\n` +
    `Please install it with: npm install ${packageName} (or pnpm add / yarn add)`
  );
  error.cause = cause;
  return error;
}
 
/**
 * The React module to build elements with.
 *
 * An injected `options.React` wins. Otherwise React is imported from *this*
 * package: it declares `react` as an optional peer, so package managers link
 * the app's copy next to it. (core's `importPeerDependency` imports relative
 * to @coherent.js/core instead, which cannot see the app's `react` under
 * pnpm's isolated layout.) The literal specifier keeps it bundler-friendly.
 *
 * @param {Object} [injected] - A React module or namespace supplied by the app
 * @param {string} integrationName - Used in the error message
 * @returns {Promise<Object>} Object exposing createElement / useState / useEffect
 */
async function loadReact(injected, integrationName) {
  let mod = injected;
  if (!mod) {
    try {
      mod = await import('react');
    } catch (_error) {
      throw missingPeer('react', integrationName, _error);
    }
  }
  // Namespace imports of CommonJS React carry the API on `default`.
  return typeof mod.createElement === 'function' ? mod : mod.default;
}
 
/**
 * Create a Next.js API route handler for Coherent.js components
 *
 * @param {Function} componentFactory - Function that returns a Coherent.js component
 * @param {Object} options - Handler options
 * @param {boolean} options.enablePerformanceMonitoring - Enable performance monitoring
 * @param {string} options.template - HTML template with {{content}} placeholder
 * @returns {Function} Next.js API route handler
 */
export function createCoherentNextHandler(componentFactory, options = {}) {
  return async (req, res) => {
    try {
      // Use shared rendering utility
      const finalHtml = await renderComponentFactory(
        componentFactory,
        [req, res],
        options
      );
 
      // Send HTML response
      res.setHeader('Content-Type', 'text/html; charset=utf-8');
      res.status(200).send(finalHtml);
    } catch (_error) {
      console.error('Coherent.js Next.js handler error:', _error);
      res.status(500).json({ error: _error.message });
    }
  };
}
 
/**
 * Create a Next.js App Router route handler for Coherent.js components
 *
 * The factory receives the same `(request, context)` pair Next.js passes to
 * route handlers, so dynamic segments are available as `context.params`
 * (a Promise since Next.js 15).
 *
 * @param {Function} componentFactory - `(request, context) => component`
 * @param {Object} options - Handler options
 * @returns {Function} Next.js App Router route handler
 */
export function createCoherentAppRouterHandler(componentFactory, options = {}) {
  return async function handler(request, context) {
    try {
      // Use shared rendering utility
      const finalHtml = await renderComponentFactory(
        componentFactory,
        [request, context],
        options
      );
 
      // Send HTML response
      return new Response(finalHtml, {
        status: 200,
        headers: { 'Content-Type': 'text/html; charset=utf-8' }
      });
    } catch (_error) {
      console.error('Coherent.js Next.js App Router handler error:', _error);
      return new Response(
        JSON.stringify({ error: _error.message }),
        {
          status: 500,
          headers: { 'Content-Type': 'application/json' }
        }
      );
    }
  }
}
 
/**
 * Create a Next.js Server Component for Coherent.js
 *
 * @param {Function} componentFactory - Function that returns a Coherent.js component
 * @param {Object} options - Component options
 * @param {boolean} [options.enablePerformanceMonitoring=false] - Enable performance monitoring
 * @param {Object} [options.React] - React module to use instead of importing `react`
 * @returns {Promise<Function>} Next.js Server Component
 */
export async function createCoherentServerComponent(componentFactory, options = {}) {
  const {
    enablePerformanceMonitoring = false
  } = options;
 
  const React = await loadReact(options.React, 'Next.js Server Component integration');
 
  return async function CoherentServerComponent(props) {
    try {
      // Create component with props
      const component = await Promise.resolve(
        componentFactory(props)
      );
 
      Iif (!component) {
        return React.createElement('div', null, 'Error: Component factory returned null/undefined');
      }
 
      // Render component
      let html;
      Iif (enablePerformanceMonitoring) {
        const renderId = performanceMonitor.startRender();
        html = render(component);
        performanceMonitor.endRender(renderId);
      } else {
        html = render(component);
      }
 
      // Return dangerouslySetInnerHTML to render HTML
      return React.createElement('div', {
        dangerouslySetInnerHTML: { __html: html }
      });
    } catch (_error) {
      console.error('Coherent.js Next.js Server Component error:', _error);
      return React.createElement('div', null, `Error: ${_error.message}`);
    }
  };
}
 
/**
 * Create a Next.js Client Component for Coherent.js with hydration support
 *
 * @param {Function} componentFactory - Function that returns a Coherent.js component
 * @param {Object} options - Component options
 * @param {boolean} [options.enablePerformanceMonitoring=false] - Enable performance monitoring
 * @param {Object} [options.React] - React module to use instead of importing `react`
 * @returns {Promise<Function>} Next.js Client Component
 */
export async function createCoherentClientComponent(componentFactory, options = {}) {
  const {
    enablePerformanceMonitoring = false
  } = options;
 
  const React = await loadReact(options.React, 'Next.js Client Component integration');
 
  return function CoherentClientComponent(props) {
    const [html, setHtml] = React.useState('');
 
    React.useEffect(() => {
      async function renderComponent() {
        try {
          // Create component with props
          const component = await Promise.resolve(
            componentFactory(props)
          );
 
          if (!component) {
            setHtml('Error: Component factory returned null/undefined');
            return;
          }
 
          // Render component
          let renderedHtml;
          if (enablePerformanceMonitoring) {
            const renderId = performanceMonitor.startRender();
            renderedHtml = render(component);
            performanceMonitor.endRender(renderId);
          } else {
            renderedHtml = render(component);
          }
 
          setHtml(renderedHtml);
        } catch (_error) {
          console.error('Coherent.js Next.js Client Component error:', _error);
          setHtml(`Error: ${_error.message}`);
        }
      }
 
      renderComponent();
    }, [props]);
 
    return React.createElement('div', {
      dangerouslySetInnerHTML: { __html: html }
    });
  };
}
 
/**
 * Create Next.js integration with dependency checking
 * This function ensures Next.js and React are available before setting up the integration
 *
 * @param {Object} options - Setup options
 * @returns {Promise<Object>} - Object with Next.js integration utilities
 */
export async function createNextIntegration(options = {}) {
  try {
    // Verify Next.js and React are available, resolved from this package
    // (see loadReact for why not core's importPeerDependency)
    try {
      await import('next');
    } catch (_error) {
      throw missingPeer('next', 'Next.js integration', _error);
    }
    await loadReact(options.React, 'Next.js integration');
 
    return {
      createCoherentNextHandler: (componentFactory, handlerOptions = {}) =>
        createCoherentNextHandler(componentFactory, { ...options, ...handlerOptions }),
      createCoherentAppRouterHandler: (componentFactory, handlerOptions = {}) =>
        createCoherentAppRouterHandler(componentFactory, { ...options, ...handlerOptions }),
      createCoherentServerComponent: (componentFactory, componentOptions = {}) =>
        createCoherentServerComponent(componentFactory, { ...options, ...componentOptions }),
      createCoherentClientComponent: (componentFactory, componentOptions = {}) =>
        createCoherentClientComponent(componentFactory, { ...options, ...componentOptions })
    };
  } catch (_error) {
    throw _error;
  }
}
 
// Export all utilities
export default {
  createCoherentNextHandler,
  createCoherentAppRouterHandler,
  createCoherentServerComponent,
  createCoherentClientComponent,
  createNextIntegration
};