fix: correct checking for runtime version installed in the project and provide example API endpoint in code snippets (#230)

* fix: adjust getAngularRuntimeVersion to not find auto-installed version in .netlify/plugins

* docs: fix wrong code snippet in README

* fix: add commented out example API to code snippets shown on incompatible server.ts error

* fix: use :internal: trick

* fix: add missing ending qoute

Author: pieh

README.md

@@ -123,7 +123,7 @@ export async function netlifyCommonEngineHandler(request: Request, context: any)
   // Example API endpoints can be defined here.
   // Uncomment and define endpoints as necessary.
   // const pathname = new URL(request.url).pathname;
-  // if (pathname = '/api/hello') {
+  // if (pathname === '/api/hello') {
   //   return Response.json({ message: 'Hello from the API' });
   // }
 
@@ -145,7 +145,7 @@ export async function netlifyAppEngineHandler(request: Request): Promise<Respons
   // Example API endpoints can be defined here.
   // Uncomment and define endpoints as necessary.
   // const pathname = new URL(request.url).pathname;
-  // if (pathname = '/api/hello') {
+  // if (pathname === '/api/hello') {
   //   return Response.json({ message: 'Hello from the API' });
   // }
 

src/helpers/getPackageVersion.js

@@ -1,3 +1,6 @@
+const { createRequire } = require('node:module')
+const { join } = require('node:path/posix')
+
 const { readJSON } = require('fs-extra')
 
 /**
@@ -29,8 +32,8 @@ module.exports.getAngularVersion = getAngularVersion
 const getAngularRuntimeVersion = async function (root) {
   let packagePath
   try {
-    // eslint-disable-next-line n/no-missing-require
-    packagePath = require.resolve('@netlify/angular-runtime/package.json', { paths: [root] })
+    const siteRequire = createRequire(join(root, ':internal:'))
+    packagePath = siteRequire.resolve('@netlify/angular-runtime/package.json')
   } catch {
     // module not found
     return

src/helpers/serverModuleHelpers.js

@@ -16,6 +16,13 @@ import { render } from '@netlify/angular-runtime/common-engine'
 const commonEngine = new CommonEngine()
 
 export async function netlifyCommonEngineHandler(request: Request, context: any): Promise<Response> {
+  // Example API endpoints can be defined here.
+  // Uncomment and define endpoints as necessary.
+  // const pathname = new URL(request.url).pathname;
+  // if (pathname === '/api/hello') {
+  //   return Response.json({ message: 'Hello from the API' });
+  // }
+
   return await render(commonEngine)
 }
 `
@@ -29,6 +36,13 @@ const angularAppEngine = new AngularAppEngine()
 export async function netlifyAppEngineHandler(request: Request): Promise<Response> {
   const context = getContext()
 
+  // Example API endpoints can be defined here.
+  // Uncomment and define endpoints as necessary.
+  // const pathname = new URL(request.url).pathname;
+  // if (pathname === '/api/hello') {
+  //   return Response.json({ message: 'Hello from the API' });
+  // }
+
   const result = await angularAppEngine.handle(request, context)
   return result || new Response('Not found', { status: 404 })
 }
@@ -113,7 +127,7 @@ const fixServerTs = async function ({ angularVersion, siteRoot, failPlugin, fail
     )
   } else if (!satisfies(angularRuntimeVersionInstalledByUser, '>=2.2.0', { includePrerelease: true })) {
     failBuild(
-      `Angular@19 SSR on Netlify requires '@netlify/angular-runtime' version 2.2.0 or later to be installed. Found version "${angularRuntimeVersionInstalledByUser}. Please update it to version 2.2.0 or later and try again.`,
+      `Angular@19 SSR on Netlify requires '@netlify/angular-runtime' version 2.2.0 or later to be installed. Found version "${angularRuntimeVersionInstalledByUser}". Please update it to version 2.2.0 or later and try again.`,
     )
   }