Promise.<SiteProps>Prepare SvelteKit SSR server files for deployment to AWS services
Promise.<string>Prepare options handler for deployment to AWS services
Promise.<string>Prepare lambda@edge origin router for deployment to AWS services
Promise.<SiteProps>](#SiteProps)\n\nPrepare SvelteKit SSR server files for deployment to AWS services.
\nTo determine the URL request origin the server uses the following hierarchy:
\nThe origin value is important to prevent CORS errors.
\n\n**Kind**: global function\n\n| Param | Type | Default | Description |\n| -------------- | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------ |\n| builder |any | | The SvelteKit provided [Builder](https://kit.svelte.dev/docs/types#public-types-builder) object
|\n| artifactPath |string | "build" | The path where to place to SvelteKit files
|\n| esbuildOptions |any | | Options to pass to esbuild
|\n| streaming |boolean | false | Use Lambda response streaming
|\n\n\n\n### buildOptions(builder, artifactPath) ⇒Promise.<string>\n\nPrepare options handler for deployment to AWS services
\n\n**Kind**: global function \n**Returns**:Promise.<string> - Location of files for the options handler\n\n| Param | Type | Default | Description |\n| ------------ | ------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------ |\n| builder | any | | The SvelteKit provided [Builder](https://kit.svelte.dev/docs/types#public-types-builder) object
|\n| artifactPath |string | "build" | The path where to place to SvelteKit files
|\n\n\n\n### buildRouter(builder, static_directory, prerendered_directory, serverURL, optionsURL, artifactPath) ⇒Promise.<string>\n\nPrepare lambda@edge origin router for deployment to AWS services
\nNote that this function will forward the original Host header as\n'X-Forwarded-Host' to the lambda URLs.
\n\n**Kind**: global function \n**Returns**:Promise.<string> - Location of files for the origin router\n\n| Param | Type | Default | Description |\n| --------------------- | ------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------ |\n| builder | any | | The SvelteKit provided [Builder](https://kit.svelte.dev/docs/types#public-types-builder) object
|\n| static_directory |string | | location of static page files
|\n| prerendered_directory |string | | location of prerendered page files
|\n| serverURL |string | | function URL for the server lambda
|\n| optionsURL |string | | function URL for the options handler lambda
|\n| artifactPath |string | "build" | The path where to place to SvelteKit files
|\n\n\n\n### SiteProps :Object\n\n**Kind**: global typedef \n**Properties**\n\n| Name | Type | Description |\n| --------------------- | ------------------- | ------------------------------------------- |\n| server_directory | string | location of files for the SSR server
|\n| static_directory |string | location of static page files
|\n| prerendered_directory |string | location of prerendered page files
|\n\nThe functions above should be used within a [SvelteKit adapter\nfunction](https://kit.svelte.dev/docs/writing-adapters); for example:\n\n```ts\nimport {\n buildServer,\n buildOptions,\n buildRouter,\n} from 'sveltekit-adapter-aws-base'\n\nexport default function ({\n artifactPath = 'build',\n esbuildOptions = {},\n // More options\n} = {}) {\n /** @type {import('@sveltejs/kit').Adapter} */\n const adapter = {\n name: 'adapter-aws-myiacprovider',\n async adapt(builder) {\n const { serverDirectory, staticDirectory, prerenderedDirectory } =\n await buildServer(builder, artifactPath, esbuildOptions)\n const optionsDirectory = await buildOptions(builder, artifactPath)\n\n // Deploy server to lambda and get domain name of URL. These can use\n // AWS_IAM AuthType, as the router will sign requests.\n const serverDomain = getLambdaURLDomain(server_directory)\n const optionsDomain = getLambdaURLDomain(server_directory)\n\n const edgeDirectory = await buildRouter(\n builder,\n staticDirectory,\n prerenderedDirectory,\n serverDomain,\n optionsDomain,\n artifactPath\n )\n\n // Deploy router to lambda and get its arn\n const routerArn = getLambdaArn(edgeDirectory)\n\n // Upload static files to S3\n const myBucket = deployS3(staticDirectory, prerenderedDirectory)\n\n // Deploy a CloudFront CDN with the S3 bucket as the default origin\n // (with OAC for added security) and the lambda@edge function to handle\n // origin-requests.\n const CDN = deployCDN({\n defaultOriginBucket: myBucket,\n defaultCacheBehaviourOriginRequestHandler: routerArn,\n })\n },\n }\n\n return adapter\n}\n```\n\n\n\n## Example IAC providers\n\n- [Pulumi](https://github.com/Data-Only-Greater/sveltekit-adapter-aws-pulumi)\n\n## Credits\n\nThis package is derived from [Mike\nBild's](https://github.com/MikeBild/sveltekit-adapter-aws) adapter for CDK\nand [James Bray's](https://github.com/yarbsemaj/sveltekit-adapter-lambda)\nadapter for Serverless Framework.\n","readmeFilename":"README.md"}