sst 2.30.4 → 2.32.0

package/constructs/SsrSite.d.ts

@@ -8,7 +8,7 @@ import { SSTConstruct } from "./Construct.js";
 import { NodeJSProps, FunctionProps } from "./Function.js";
 import { SsrFunction, SsrFunctionProps } from "./SsrFunction.js";
 import { EdgeFunction, EdgeFunctionProps } from "./EdgeFunction.js";
-import { BaseSiteFileOptions, BaseSiteFileOptionsFilter, BaseSiteFileOptionsDeprecated, BaseSiteReplaceProps, BaseSiteCdkDistributionProps } from "./BaseSite.js";
+import { BaseSiteFileOptions, BaseSiteReplaceProps, BaseSiteCdkDistributionProps } from "./BaseSite.js";
 import { Size } from "./util/size.js";
 import { Duration } from "./util/duration.js";
 import { Permissions } from "./util/permission.js";
@@ -52,12 +52,7 @@ export interface SsrSiteNodeJSProps extends NodeJSProps {
 }
 export interface SsrDomainProps extends DistributionDomainProps {
 }
-export interface SsrSiteFileOptionsFilter extends BaseSiteFileOptionsFilter {
-}
 export interface SsrSiteFileOptions extends BaseSiteFileOptions {
-    filters: SsrSiteFileOptionsFilter[];
-}
-export interface SsrSiteFileOptionsDeprecated extends BaseSiteFileOptionsDeprecated {
 }
 export interface SsrSiteReplaceProps extends BaseSiteReplaceProps {
 }
@@ -207,40 +202,25 @@ export interface SsrSiteProps {
          */
         url?: string;
     };
-    cache?: {
+    assets?: {
         /**
-         * Character encoding for text based assets stored in the S3 cache (ex: html, css, js, etc.). If "none" is specified, no charset will be returned in header.
+         * Character encoding for text based assets uploaded to S3 (ex: html, css, js, etc.). If "none" is specified, no charset will be returned in header.
          * @default utf-8
          * @example
          * ```js
-         * cache: {
-         *  textEncoding: "iso-8859-1"
-         * }
-         * ```
-         */
-        textEncoding?: "UTF-8" | "ISO-8859-1" | "Windows-1252" | "ASCII" | "none";
-        /**
-         * The strategy to use for invalidating the CDN cache. By default, the CDN cache will invalidate on changes any cached file, but this could become slow on very large projects.
-         * - "never" - No invalidation will be performed.
-         * - "all" - All files will be invalidated when any file changes. (Default, requires checking file content which will increase deployment time)
-         * - "versioned" - Only versioned files will be invalidated when versioned files change.
-         * - "always" - All files are invalidated on every deployment.
-         * @default all
-         * @example
-         * ```js
-         * cache: {
-         *   cdnInvalidationStrategy: "versioned"
+         * assets: {
+         *   textEncoding: "iso-8859-1"
          * }
          * ```
          */
-        cdnInvalidationStrategy?: "never" | "all" | "versioned" | "always";
+        textEncoding?: "utf-8" | "iso-8859-1" | "windows-1252" | "ascii" | "none";
         /**
          * The TTL for versioned files (ex: `main-1234.css`) in the CDN and browser cache. Ignored when `versionedFilesCacheHeader` is specified.
          * @default 1 year
          * @example
          * ```js
-         * cache: {
-         *  versionedFilesTTL: "30 days"
+         * assets: {
+         *   versionedFilesTTL: "30 days"
          * }
          * ```
          */
@@ -250,7 +230,7 @@ export interface SsrSiteProps {
          * @default public,max-age=31536000,immutable
          * @example
          * ```js
-         * cache: {
+         * assets: {
          *   versionedFilesCacheHeader: "public,max-age=31536000,immutable"
          * }
          * ```
@@ -261,8 +241,8 @@ export interface SsrSiteProps {
          * @default 1 day
          * @example
          * ```js
-         * cache: {
-         *  nonVersionedFilesTTL: "4 hours"
+         * assets: {
+         *   nonVersionedFilesTTL: "4 hours"
          * }
          * ```
          */
@@ -272,7 +252,7 @@ export interface SsrSiteProps {
          * @default public,max-age=0,s-maxage=86400,stale-while-revalidate=8640
          * @example
          * ```js
-         * cache: {
+         * assets: {
          *   nonVersionedFilesCacheHeader: "public,max-age=0,no-cache"
          * }
          * ```
@@ -282,10 +262,10 @@ export interface SsrSiteProps {
          * List of file options to specify cache control and content type for cached files. These file options are appended to the default file options so it's possible to override the default file options by specifying an overlapping file pattern.
          * @example
          * ```js
-         * cache: {
+         * assets: {
          *   fileOptions: [
          *     {
-         *       filters: [ { exclude: "*" }, { include: "*.zip" } ],
+         *       files: "**\/*.zip",
          *       cacheControl: "private,no-cache,no-store,must-revalidate",
          *       contentType: "application/zip",
          *     },
@@ -294,10 +274,50 @@ export interface SsrSiteProps {
          * ```
          */
         fileOptions?: SsrSiteFileOptions[];
+        /**
+         * @internal
+         */
+        _uploadConcurrency?: number;
+    };
+    invalidation?: {
+        /**
+         * While deploying, SST waits for the CloudFront cache invalidation process to finish. This ensures that the new content will be served once the deploy command finishes. However, this process can sometimes take more than 5 mins. For non-prod environments it might make sense to pass in `false`. That'll skip waiting for the cache to invalidate and speed up the deploy process.
+         * @default false
+         * @example
+         * ```js
+         * invalidation: {
+         *   wait: true,
+         * }
+         * ```
+         */
+        wait?: boolean;
+        /**
+         * The paths to invalidate. There are three built-in options:
+         * - "none" - No invalidation will be performed.
+         * - "all" - All files will be invalidated when any file changes.
+         * - "versioned" - Only versioned files will be invalidated when versioned files change.
+         * Alternatively you can pass in an array of paths to invalidate.
+         * @default "all"
+         * @example
+         * Disable invalidation:
+         * ```js
+         * invalidation: {
+         *   paths: "none",
+         * }
+         * ```
+         * Invalidate "index.html" and all files under the "products" route:
+         * ```js
+         * invalidation: {
+         *   paths: ["/index.html", "/products/*"],
+         * }
+         * ```
+         */
+        paths?: "none" | "all" | "versioned" | string[];
     };
     /**
      * While deploying, SST waits for the CloudFront cache invalidation process to finish. This ensures that the new content will be served once the deploy command finishes. However, this process can sometimes take more than 5 mins. For non-prod environments it might make sense to pass in `false`. That'll skip waiting for the cache to invalidate and speed up the deploy process.
      * @default false
+     * @deprecated Use `invalidation.wait` instead.
      */
     waitForInvalidation?: boolean;
     cdk?: {
@@ -343,67 +363,17 @@ export interface SsrSiteProps {
         responseHeadersPolicy?: IResponseHeadersPolicy;
         server?: Pick<CdkFunctionProps, "layers" | "vpc" | "vpcSubnets" | "securityGroups" | "allowAllOutbound" | "allowPublicSubnet" | "architecture" | "logRetention"> & Pick<FunctionProps, "copyFiles">;
     };
-    /**
-     * Pass in a list of file options to customize cache control and content type specific files. Specifying file options will bypass all default file options and only use the ones specified. Most configurations within the `cache` prop will be ignored.
-     * @deprecated Use `cache.fileOptions` instead. Note that the `cache.fileOptions` are appended to default file options, not a replacement as this prop was.
-     * @default
-     * Versioned files cached for 1 year at the CDN and browser level.
-     * Nonversioned files cached for 1 day at the CDN level, but not at the browser level.
-     * ```js
-     * fileOptions: [
-     *   {
-     *     exclude: "*",
-     *     include: "{versioned_directory}/*",
-     *     cacheControl: "public,max-age=31536000,immutable",
-     *   },
-     *   {
-     *     exclude: "*",
-     *     include: "[{non_versioned_file1}, {non_versioned_file2}, ...]",
-     *     cacheControl: "public,max-age=0,s-maxage=31536000,must-revalidate",
-     *   },
-     *   {
-     *     exclude: "*",
-     *     include: "[{non_versioned_dir_1}/*, {non_versioned_dir_2}/*, ...]",
-     *     cacheControl: "public,max-age=0,s-maxage=31536000,must-revalidate",
-     *   },
-     * ]
-     * ```
-     *
-     * @example
-     * ```js
-     * fileOptions: [
-     *   {
-     *     exclude: "*",
-     *     include: "{versioned_directory}/*.css",
-     *     cacheControl: "public,max-age=31536000,immutable",
-     *     contentType: "text/css; charset=UTF-8",
-     *   },
-     *   {
-     *     exclude: "*",
-     *     include: "{versioned_directory}/*.js",
-     *     cacheControl: "public,max-age=31536000,immutable",
-     *   },
-     *   {
-     *     exclude: "*",
-     *     include: "[{non_versioned_file1}, {non_versioned_file2}, ...]",
-     *     cacheControl: "public,max-age=0,s-maxage=31536000,must-revalidate",
-     *   },
-     *   {
-     *     exclude: "*",
-     *     include: "[{non_versioned_dir_1}/*, {non_versioned_dir_2}/*, ...]",
-     *     cacheControl: "public,max-age=0,s-maxage=31536000,must-revalidate",
-     *   },
-     * ]
-     */
-    fileOptions?: SsrSiteFileOptionsDeprecated[];
 }
+type SsrSiteInvalidationNormalizedProps = Exclude<SsrSiteProps["invalidation"], undefined>;
 export type SsrSiteNormalizedProps = SsrSiteProps & {
     path: Exclude<SsrSiteProps["path"], undefined>;
     typesPath: Exclude<SsrSiteProps["typesPath"], undefined>;
     runtime: Exclude<SsrSiteProps["runtime"], undefined>;
     timeout: Exclude<SsrSiteProps["timeout"], undefined>;
     memorySize: Exclude<SsrSiteProps["memorySize"], undefined>;
-    waitForInvalidation: Exclude<SsrSiteProps["waitForInvalidation"], undefined>;
+    invalidation: Exclude<SsrSiteProps["invalidation"], undefined> & {
+        paths: Exclude<SsrSiteInvalidationNormalizedProps["paths"], undefined>;
+    };
 };
 /**
  * The `SsrSite` construct is a higher level CDK construct that makes it easy to create modern web apps with Server Side Rendering capabilities.