Connectors

1/* istanbul ignore file */
2const { join } = require('path')
3const { DeploymentBuilder } = require('@edgio/core/deploy')
4
5/**
6 * Called when the user runs edgio init.
7 */
8export default async function init() {
9  new DeploymentBuilder(process.cwd())
10    // Copy files from the default-app directory within the connector package.
11    // These typically include the routes.js file and edgio.config.js. Typescript alternatives are often provided.
12    .addDefaultAppResources(join(__dirname, 'default-app'))
13
14    // Adds edgio:* scripts to package.json
15    .addDefaultEdgioScripts()
16}

1/(connector-root)
2  /default-app
3    /all              # resources to be added to both JavaScript and TypeScript projects
4      edgio.config.js   # a default edgio.config.js file
5    /js               # resources to be added to projects that do not use TypeScript
6      routes.js       # a JavaScript implementation of the default routes file
7    /ts               # resouces to be added to projects that use TypeScript
8      routes.ts       # a TypeScript implementation of the default routes file

1const { createDevServer } = require('@edgio/core/dev')
2
3module.exports = function() {
4  return createDevServer({
5    // All console output from your app will be prefixed with this label
6    label: 'Sapper',
7
8    // The command to start your app in dev mode
9    command: () => 'npx sapper dev',
10
11    // Once your app's console output has matched all of the following patterns, the "Edgio ready on ..." message will be displayed
12    ready: [/listening on/i],
13
14    // A function that is called with every line of output from your app. Return true to show that line to the user, false to hide it.
15    // Many connectors use this to hide lines like "Next.js ready on http://localhost:3001", which might confuse the user as to
16    // which URL to use when testing their app behind Edgio.
17    filterOutput: line => !line.match(/some pattern/),
18  })
19}

1const { DeploymentBuilder } = require('@edgio/core/deploy')
2const FrameworkBuildError = require('@edgio/core/errors/FrameworkBuildError')
3
4export default async function build({ skipFramework }) {
5  const builder = new DeploymentBuilder(appDir)
6  builder.clearPreviousBuildOutput()
7
8  if (!skipFramework) {
9    // run the sapper build
10    try {
11      await builder.exec('npx sapper build')
12    } catch (e) {
13      // this lets the user know that the build error was within their application code, not their Edgio router or configuration.
14      throw new FrameworkBuildError('Sapper')
15    }
16  }
17
18  builder
19    // optionally add some file required by the app at runtime.  This is equivalent to setting the includeFiles config in edgio.config.js
20    .addJSAsset('path/to/file/in/project')
21
22  // build the Edgio deployment bundle in the .edgio directory
23  await builder.build()
24}

1module.exports = async function prod(port) {
2  process.env.PORT = port.toString()
3
4  // Most frameworks export some kind of express server or other http listener. Your prod script
5  // just needs to start it and bind it to the provided port.  In the case of Sapper, the way to do
6  // this is to set the PORT environment variable and run the provided server script
7  require('./__sapper__/build/server/server')
8}

1// webpack.config.js
2module.exports = {
3  target: 'node',
4  entry: {
5    prod: './src/prod.js',
6  },
7  mode: 'production',
8  resolve: {
9    extensions: ['.js'],
10  },
11  output: {
12    filename: '[name].js',
13    path: './dist',
14    libraryTarget: 'umd',
15  },
16}

1|—— my-project
2    | myconnector # reference this directory in the connector property in edgio.config.js
3    | dev.js
4    | prod.js
5    | build.js
6    | edgio.config.js
7    ... other source files and directories ...

1module.exports = {
2  connector: './myconnector', // use the local connector located in the myconnector directory
3}