Elm-Pages Adapter

The idea of adapters is that they are responsible for turning the output of the elm-pages build into the right setup for a specific hosting provider. (i.e. adapting the output) docs

If you have server-rendered routes, then you'll need an adapter script to copy files to the appropriate places. It will have to execute some NodeJS code to give you the rendered HTML for each page on-demand since the routes aren't pre-built in that case.

The adapter script in the realworld app does this setup to put files in the appropriate places to run as Netlify serverless functions: adapter.mjs

Let Dillon Kearns know if you have questions on how the adapter script works slack , he hasn't written docs for it yet so the example is the only documentation at the moment.

This is a JavaScript source code that exports a function named run. The run function accepts an object that contains several parameters. When this function is called, it will copy a file, write files, and write content to a file. Additionally, it throws an error when certain conditions are met. The run function creates two directories named functions/render and functions/server-render using the ensureDirSync function. Then, the function copies the file specified by the renderFunctionFilePath parameter to two new locations: ./functions/render/elm-pages-cli.cjs and ./functions/server-render/elm-pages-cli.cjs. Next, the function writes content to two files: ./functions/render/index.mjs and ./functions/server-render/index.mjs. The content of these files is generated by calling the rendererCode function with true and false arguments, respectively. Afterward, the function filters the apiRoutePatterns array to include only elements whose kind property is "prerender-with-fallback" or "serverless". It then ensures that each pathPattern property in the filtered array does not contain an element whose kind property is "hybrid". If the filtered array contains an invalid element, the function throws an error. The function then maps over the filtered array and returns a string for each element. The string contains a redirect path based on the kind property of the element. The function also filters the routePatterns array to include only elements whose kind property is "prerender-with-fallback" or "serverless". It then maps over the filtered array and returns a string for each element. The string contains a redirect path based on the kind property of the element. Additionally, the string contains another redirect path that includes the path content.dat. Finally, the function joins the array of strings returned from the map method with newline characters and appends the resulting string to the string generated by the apiRouteRedirects method call. The resulting string is written to a file named dist/_redirects. The ensureValidRoutePatternsForNetlify function filters an array of objects and throws an error if any element's pathPattern property contains an object whose kind property is "hybrid". The isServerSide function returns true if an object's kind property is "prerender-with-fallback" or "serverless", and false otherwise. The rendererCode function generates a string that contains JavaScript code. The generated code exports a function named handler. The handler function accepts two arguments: an event object and a context object. When the handler function is called, it calls the renderer.render function with various arguments. The renderer.render function is imported from the elm-pages/generator/src/render.js module. The renderResult returned from the renderer.render function is then used to construct an HTTP response that is returned from the handler function.

Community Experiments for v3 Adapters #378 page