@sst-community/sst 4.21.1 → 5.0.0-alpha.2

package/platform/types/components/aws/nuxt.d.ts

@@ -0,0 +1,480 @@
+import { ComponentResourceOptions, Output } from "@pulumi/pulumi";
+import { Plan, SsrSite, SsrSiteArgs } from "./ssr-site.js";
+export interface NuxtArgs extends SsrSiteArgs {
+    /**
+     * Configure how this component works in `sst dev`.
+     *
+     * :::note
+     * In `sst dev` your Nuxt app is run in dev mode; it's not deployed.
+     * :::
+     *
+     * Instead of deploying your Nuxt app, this starts it in dev mode. It's run
+     * as a separate process in the `sst dev` multiplexer. Read more about
+     * [`sst dev`](/docs/reference/cli/#dev).
+     *
+     * To disable dev mode, pass in `false`.
+     */
+    dev?: SsrSiteArgs["dev"];
+    /**
+     * Permissions and the resources that the [server function](#nodes-server) in your Nuxt app needs to access. These permissions are used to create the function's IAM role.
+     *
+     * :::tip
+     * If you `link` the function to a resource, the permissions to access it are
+     * automatically added.
+     * :::
+     *
+     * @example
+     * Allow reading and writing to an S3 bucket called `my-bucket`.
+     * ```js
+     * {
+     *   permissions: [
+     *     {
+     *       actions: ["s3:GetObject", "s3:PutObject"],
+     *       resources: ["arn:aws:s3:::my-bucket/*"]
+     *     },
+     *   ]
+     * }
+     * ```
+     *
+     * Perform all actions on an S3 bucket called `my-bucket`.
+     *
+     * ```js
+     * {
+     *   permissions: [
+     *     {
+     *       actions: ["s3:*"],
+     *       resources: ["arn:aws:s3:::my-bucket/*"]
+     *     },
+     *   ]
+     * }
+     * ```
+     *
+     * Grant permissions to access all resources.
+     *
+     * ```js
+     * {
+     *   permissions: [
+     *     {
+     *       actions: ["*"],
+     *       resources: ["*"]
+     *     },
+     *   ]
+     * }
+     * ```
+     */
+    permissions?: SsrSiteArgs["permissions"];
+    /**
+     * Path to the directory where your Nuxt app is located.  This path is relative to your `sst.config.ts`.
+     *
+     * By default it assumes your Nuxt app is in the root of your SST app.
+     * @default `"."`
+     *
+     * @example
+     *
+     * If your Nuxt app is in a package in your monorepo.
+     *
+     * ```js
+     * {
+     *   path: "packages/web"
+     * }
+     * ```
+     */
+    path?: SsrSiteArgs["path"];
+    /**
+     * [Link resources](/docs/linking/) to your Nuxt app. This will:
+     *
+     * 1. Grant the permissions needed to access the resources.
+     * 2. Allow you to access it in your site using the [SDK](/docs/reference/sdk/).
+     *
+     * @example
+     *
+     * Takes a list of resources to link to the function.
+     *
+     * ```js
+     * {
+     *   link: [bucket, stripeKey]
+     * }
+     * ```
+     */
+    link?: SsrSiteArgs["link"];
+    /**
+     * Configure how the CloudFront cache invalidations are handled. This is run after your Nuxt app has been deployed.
+     * :::tip
+     * You get 1000 free invalidations per month. After that you pay $0.005 per invalidation path. [Read more here](https://aws.amazon.com/cloudfront/pricing/).
+     * :::
+     * @default `{paths: "all", wait: false}`
+     * @example
+     * Wait for all paths to be invalidated.
+     * ```js
+     * {
+     *   invalidation: {
+     *     paths: "all",
+     *     wait: true
+     *   }
+     * }
+     * ```
+     */
+    invalidation?: SsrSiteArgs["invalidation"];
+    /**
+     * Set [environment variables](https://cli.vuejs.org/guide/mode-and-env.html) in your Nuxt
+     * app. These are made available:
+     *
+     * 1. In `nuxt build`, they are loaded into `process.env`.
+     * 2. Locally while running through `sst dev`.
+     *
+     * :::tip
+     * You can also `link` resources to your Nuxt app and access them in a type-safe way with the [SDK](/docs/reference/sdk/). We recommend linking since it's more secure.
+     * :::
+     *
+     * Recall that in Vue, you need to prefix your environment variables with `VUE_APP_` to access these in the browser. [Read more here](https://cli.vuejs.org/guide/mode-and-env.html#using-env-variables-in-client-side-code).
+     *
+     * @example
+     * ```js
+     * {
+     *   environment: {
+     *     API_URL: api.url,
+     *     // Accessible in the browser
+     *     VUE_APP_STRIPE_PUBLISHABLE_KEY: "pk_test_123"
+     *   }
+     * }
+     * ```
+     */
+    environment?: SsrSiteArgs["environment"];
+    /**
+     * Set a custom domain for your Nuxt app.
+     *
+     * Automatically manages domains hosted on AWS Route 53, Cloudflare, and Vercel. For other
+     * providers, you'll need to pass in a `cert` that validates domain ownership and add the
+     * DNS records.
+     *
+     * :::tip
+     * Built-in support for AWS Route 53, Cloudflare, and Vercel. And manual setup for other
+     * providers.
+     * :::
+     *
+     * @example
+     *
+     * By default this assumes the domain is hosted on Route 53.
+     *
+     * ```js
+     * {
+     *   domain: "example.com"
+     * }
+     * ```
+     *
+     * For domains hosted on Cloudflare.
+     *
+     * ```js
+     * {
+     *   domain: {
+     *     name: "example.com",
+     *     dns: sst.cloudflare.dns()
+     *   }
+     * }
+     * ```
+     *
+     * Specify a `www.` version of the custom domain.
+     *
+     * ```js
+     * {
+     *   domain: {
+     *     name: "domain.com",
+     *     redirects: ["www.domain.com"]
+     *   }
+     * }
+     * ```
+     */
+    domain?: SsrSiteArgs["domain"];
+    /**
+     * Serve your Nuxt app through a `Router` component instead of a standalone CloudFront
+     * distribution.
+     *
+     * Let's say you have a Router component.
+     *
+     * ```ts title="sst.config.ts"
+     * const router = new sst.aws.Router("Router", {
+     *   domain: "*.example.com",
+     * });
+     * ```
+     *
+     * You can then match a pattern and route to your app based on:
+     *
+     * - A path like `/docs`
+     * - A domain pattern like `docs.example.com`
+     * - A combined pattern like `dev.example.com/docs`
+     *
+     * For example, to match a path.
+     *
+     * ```ts title="sst.config.ts"
+     * {
+     *   router: {
+     *     instance: router,
+     *     path: "/docs",
+     *   },
+     * }
+     * ```
+     *
+     * Or match a domain.
+     *
+     * ```ts title="sst.config.ts"
+     * {
+     *   router: {
+     *     instance: router,
+     *     domain: "docs.example.com",
+     *   },
+     * }
+     * ```
+     *
+     * Route by both domain and path:
+     *
+     * ```ts title="sst.config.ts"
+     * {
+     *   router: {
+     *     instance: router,
+     *     domain: "dev.example.com",
+     *     path: "/docs",
+     *   },
+     * }
+     * ```
+     *
+     * If you are routing to a path like `/docs`, you must configure the
+     * base path in your Nuxt app. The base path must match the path in your
+     * route prop.
+     *
+     * :::caution
+     * If routing to a path, you need to configure that as the base path in your
+     * Nuxt app as well.
+     * :::
+     *
+     * For example, if you are routing `/docs` to a Nuxt app, you need to set
+     * [`baseURL`](https://nuxt.com/docs/api/nuxt-config#baseurl)
+     * to `/docs` in your `nuxt.config.ts` without a trailing slash.
+     *
+     * ```js title="nuxt.config.ts" {3}
+     * export default defineNuxtConfig({
+     *   app: {
+     *     baseURL: '/docs'
+     *   }
+     * });
+     * ```
+     */
+    /**
+     * Serve your Nuxt app through a `Router` instead of a standalone CloudFront
+     * distribution.
+     *
+     * By default, this component creates a new CloudFront distribution. But you might
+     * want to serve it through the distribution of your `Router` as a:
+     *
+     * - A path like `/docs`
+     * - A subdomain like `docs.example.com`
+     * - Or a combined pattern like `dev.example.com/docs`
+     *
+     * @example
+     *
+     * To serve your Nuxt app **from a path**, you'll need to configure the root domain
+     * in your `Router` component.
+     *
+     * ```ts title="sst.config.ts" {2}
+     * const router = new sst.aws.Router("Router", {
+     *   domain: "example.com"
+     * });
+     * ```
+     *
+     * Now set the `router` and the `path`.
+     *
+     * ```ts {3,4}
+     * {
+     *   router: {
+     *     instance: router,
+     *     path: "/docs"
+     *   }
+     * }
+     * ```
+     *
+     * You also need to set the
+     * [`baseURL`](https://nuxt.com/docs/api/nuxt-config#baseurl) in your
+     * `nuxt.config.ts`.
+     *
+     * :::caution
+     * If routing to a path, you need to set that as the base path in your Nuxt
+     * app as well.
+     * :::
+     *
+     * ```js title="nuxt.config.ts" {3}
+     * export default defineNuxtConfig({
+     *   app: {
+     *     baseURL: "/docs"
+     *   }
+     * });
+     * ```
+     *
+     * To serve your Nuxt app **from a subdomain**, you'll need to configure the
+     * domain in your `Router` component to match both the root and the subdomain.
+     *
+     * ```ts title="sst.config.ts" {3,4}
+     * const router = new sst.aws.Router("Router", {
+     *   domain: {
+     *     name: "example.com",
+     *     aliases: ["*.example.com"]
+     *   }
+     * });
+     * ```
+     *
+     * Now set the `domain` in the `router` prop.
+     *
+     * ```ts {4}
+     * {
+     *   router: {
+     *     instance: router,
+     *     domain: "docs.example.com"
+     *   }
+     * }
+     * ```
+     *
+     * Finally, to serve your Nuxt app **from a combined pattern** like
+     * `dev.example.com/docs`, you'll need to configure the domain in your `Router` to
+     * match the subdomain.
+     *
+     * ```ts title="sst.config.ts" {3,4}
+     * const router = new sst.aws.Router("Router", {
+     *   domain: {
+     *     name: "example.com",
+     *     aliases: ["*.example.com"]
+     *   }
+     * });
+     * ```
+     *
+     * And set the `domain` and the `path`.
+     *
+     * ```ts {4,5}
+     * {
+     *   router: {
+     *     instance: router,
+     *     domain: "dev.example.com",
+     *     path: "/docs"
+     *   }
+     * }
+     * ```
+     *
+     * Also, make sure to set this as the `basePath` in your `nuxt.config.ts`, like
+     * above.
+     */
+    router?: SsrSiteArgs["router"];
+    /**
+     * The command used internally to build your Nuxt app.
+     *
+     * @default `"npm run build"`
+     *
+     * @example
+     *
+     * If you want to use a different build command.
+     * ```js
+     * {
+     *   buildCommand: "yarn build"
+     * }
+     * ```
+     */
+    buildCommand?: SsrSiteArgs["buildCommand"];
+    /**
+     * Configure the Nuxt app to use an existing CloudFront cache policy.
+     *
+     * :::note
+     * CloudFront has a limit of 20 cache policies per account, though you can request a limit
+     * increase.
+     * :::
+     *
+     * By default, a new cache policy is created for it. This allows you to reuse an existing
+     * policy instead of creating a new one.
+     *
+     * @default A new cache policy is created
+     *
+     * @example
+     * ```js
+     * {
+     *   cachePolicy: "658327ea-f89d-4fab-a63d-7e88639e58f6"
+     * }
+     * ```
+     */
+    cachePolicy?: SsrSiteArgs["cachePolicy"];
+}
+/**
+ * The `Nuxt` component lets you deploy a [Nuxt](https://nuxt.com) app to AWS.
+ *
+ * @example
+ *
+ * #### Minimal example
+ *
+ * Deploy a Nuxt app that's in the project root.
+ *
+ * ```js title="sst.config.ts"
+ * new sst.aws.Nuxt("MyWeb");
+ * ```
+ *
+ * #### Change the path
+ *
+ * Deploys the Nuxt app in the `my-nuxt-app/` directory.
+ *
+ * ```js {2} title="sst.config.ts"
+ * new sst.aws.Nuxt("MyWeb", {
+ *   path: "my-nuxt-app/"
+ * });
+ * ```
+ *
+ * #### Add a custom domain
+ *
+ * Set a custom domain for your Nuxt app.
+ *
+ * ```js {2} title="sst.config.ts"
+ * new sst.aws.Nuxt("MyWeb", {
+ *   domain: "my-app.com"
+ * });
+ * ```
+ *
+ * #### Redirect www to apex domain
+ *
+ * Redirect `www.my-app.com` to `my-app.com`.
+ *
+ * ```js {4} title="sst.config.ts"
+ * new sst.aws.Nuxt("MyWeb", {
+ *   domain: {
+ *     name: "my-app.com",
+ *     redirects: ["www.my-app.com"]
+ *   }
+ * });
+ * ```
+ *
+ * #### Link resources
+ *
+ * [Link resources](/docs/linking/) to your Nuxt app. This will grant permissions
+ * to the resources and allow you to access it in your app.
+ *
+ * ```ts {4} title="sst.config.ts"
+ * const bucket = new sst.aws.Bucket("MyBucket");
+ *
+ * new sst.aws.Nuxt("MyWeb", {
+ *   link: [bucket]
+ * });
+ * ```
+ *
+ * You can use the [SDK](/docs/reference/sdk/) to access the linked resources
+ * in your Nuxt app.
+ *
+ * ```ts title="server/api/index.ts"
+ * import { Resource } from "sst";
+ *
+ * console.log(Resource.MyBucket.name);
+ * ```
+ */
+export declare class Nuxt extends SsrSite {
+    constructor(name: string, args?: NuxtArgs, opts?: ComponentResourceOptions);
+    protected normalizeBuildCommand(): void;
+    protected buildPlan(outputPath: Output<string>): Output<Plan>;
+    /**
+     * The URL of the Nuxt app.
+     *
+     * If the `domain` is set, this is the URL with the custom domain.
+     * Otherwise, it's the auto-generated CloudFront URL.
+     */
+    get url(): Output<string>;
+}
+//# sourceMappingURL=nuxt.d.ts.map

package/platform/types/components/aws/nuxt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nuxt.d.ts","sourceRoot":"","sources":["../../../../src/components/aws/nuxt.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE3D,MAAM,WAAW,QAAS,SAAQ,WAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;IACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IACzC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC3B;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC3B;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IAC3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC/B;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IAC3C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CAC1C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,qBAAa,IAAK,SAAQ,OAAO;gBAE7B,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,QAAa,EACnB,IAAI,GAAE,wBAA6B;IAKrC,SAAS,CAAC,qBAAqB;IAE/B,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;IA+B7D;;;;;OAKG;IACH,IAAW,GAAG,mBAEb;CACF"}