sst 2.5.4 → 2.5.5

package/cli/commands/bind.js

@@ -1,12 +1,7 @@
 import path from "path";
 import { VisibleError } from "../../error.js";
-const SSR_SITE_CONFIG = {
-    NextjsSite: "next.config",
-    AstroSite: "astro.config",
-    RemixSite: "remix.config",
-    SolidStartSite: "vite.config",
-    SlsNextjsSite: "next.config",
-};
+class OutdatedMetadataError extends Error {
+}
 export const bind = (program) => program
     .command(["bind <command..>", "env <command..>"], "Bind your app's resources to a command", (yargs) => yargs
     .array("command")
@@ -25,54 +20,80 @@ export const bind = (program) => program
     const bus = useBus();
     const project = useProject();
     const command = args.command?.join(" ");
-    const isSsrSite = await isRunningInSsrSite();
+    const isSite = await isRunningInSite();
     let p;
     let timer;
     let siteConfigCache;
     // Handle missing command
     if (!command) {
-        throw new VisibleError(`Command is required, e.g. sst bind ${isSsrSite ? "next dev" : "env"}`);
+        throw new VisibleError(`Command is required, e.g. sst bind ${isSite ? "next dev" : "vitest run"}`);
     }
     // Bind script
-    const initialMetadata = await getSiteMetadata();
-    if (!initialMetadata && !isSsrSite) {
+    if (!isSite) {
         Logger.debug("Running in script mode.");
         return await bindScript();
     }
     // Bind site
-    await bindSite("init");
+    try {
+        await bindSite("init");
+    }
+    catch (e) {
+        // Bind script (fallback)
+        if (e instanceof OutdatedMetadataError) {
+            Colors.line(Colors.warning("Warning: This was deployed with an old version of SST. Run `sst dev` or `sst deploy` to update."));
+            return await bindScript();
+        }
+        throw e;
+    }
     bus.subscribe("stacks.metadata.updated", () => bindSite("metadata_updated"));
     bus.subscribe("stacks.metadata.deleted", () => bindSite("metadata_updated"));
     bus.subscribe("config.secret.updated", (payload) => {
         const secretName = payload.properties.name;
-        if (siteConfigCache?.secrets === undefined)
-            return;
-        if (!siteConfigCache.secrets.includes(secretName))
+        if (!(siteConfigCache?.secrets || []).includes(secretName))
             return;
         Colors.line(`\n`, `SST secrets have been updated. Restarting \`${command}\`...`);
         bindSite("secrets_updated");
     });
-    async function isRunningInSsrSite() {
+    async function isRunningInSite() {
         const { existsAsync } = await import("../../util/fs.js");
         const { readFile } = await import("fs/promises");
-        const results = await Promise.all(Object.values(SSR_SITE_CONFIG)
-            .map((config) => [".js", ".cjs", ".mjs", ".ts"].map(async (ext) => {
-            const exists = await existsAsync(`${config}${ext}`);
-            if (exists && config === "vite.config") {
-                const content = await readFile(`${config}${ext}`);
-                return content.includes("solid-start");
-            }
-            return exists;
-        }))
-            .flat());
+        const SITE_CONFIGS = [
+            { file: "next.config", multiExtension: true },
+            { file: "astro.config", multiExtension: true },
+            { file: "remix.config", multiExtension: true },
+            { file: "svelte.config", multiExtension: true },
+            { file: "gatsby-config", multiExtension: true },
+            { file: "angular.json" },
+            { file: "ember-cli-build.js" },
+            {
+                file: "vite.config",
+                multiExtension: true,
+                match: /solid-start|plugin-vue|plugin-react|@preact\/preset-vite/,
+            },
+            { file: "package.json", match: /react-scripts/ },
+            { file: "index.html" }, // plain HTML
+        ];
+        const results = await Promise.all(SITE_CONFIGS.map((site) => {
+            const files = site.multiExtension
+                ? [".js", ".cjs", ".mjs", ".ts"].map((ext) => `${site.file}${ext}`)
+                : [site.file];
+            return files.map(async (file) => {
+                const exists = await existsAsync(file);
+                if (!exists)
+                    return false;
+                if (site.match) {
+                    const content = await readFile(file);
+                    return content.toString().match(site.match);
+                }
+                return true;
+            });
+        }).flat());
         return results.some(Boolean);
     }
     async function bindSite(reason) {
         // Get metadata
-        const siteMetadata = (reason === "init"
-            ? initialMetadata
-            : await getSiteMetadataUntilAvailable());
-        const siteConfig = await parseSiteConfig(siteMetadata);
+        const siteMetadata = await getSiteMetadataUntilAvailable();
+        const siteConfig = await parseSiteMetadata(siteMetadata);
         // Handle rebind due to metadata updated
         if (reason === "metadata_updated") {
             if (areEnvsSame(siteConfig.envs, siteConfigCache?.envs || {}))
@@ -113,25 +134,6 @@ export const bind = (program) => program
             ...(await localIamCredentials()),
         });
     }
-    async function parseSiteConfig(metadata) {
-        const { LambdaClient, GetFunctionCommand } = await import("@aws-sdk/client-lambda");
-        const { useAWSClient } = await import("../../credentials.js");
-        const isBindSupported = metadata.type !== "StaticSite" && metadata.type !== "SlsNextjsSite";
-        // Handle StaticSite
-        if (!isBindSupported) {
-            return { envs: metadata.data.environment };
-        }
-        // Get function details
-        const lambda = useAWSClient(LambdaClient);
-        const { Configuration: functionConfig } = await lambda.send(new GetFunctionCommand({
-            FunctionName: metadata.data.server,
-        }));
-        return {
-            role: functionConfig?.Role,
-            envs: functionConfig?.Environment?.Variables || {},
-            secrets: metadata.data.secrets,
-        };
-    }
     async function getSiteMetadataUntilAvailable() {
         const { createSpinner } = await import("../spinner.js");
         const spinner = createSpinner({});
@@ -139,18 +141,7 @@ export const bind = (program) => program
             const data = await getSiteMetadata();
             // Handle site metadata not found
             if (!data) {
-                spinner.start(
-                //"Waiting for SST to start for the first time. Run `sst dev`..."
-                //"Run `sst dev` for the first time. Waiting..."
-                "Make sure `sst dev` is running...");
-                await new Promise((resolve) => setTimeout(resolve, 1000));
-                continue;
-            }
-            // Handle site metadata is old
-            const isBindSupported = data.type !== "StaticSite" && data.type !== "SlsNextjsSite";
-            if ((isBindSupported && !data.data.server) ||
-                (!isBindSupported && !data.data.environment)) {
-                spinner.start("This was deployed with an old version of SST. Make sure to restart `sst dev`...");
+                spinner.start("Make sure `sst dev` is running...");
                 await new Promise((resolve) => setTimeout(resolve, 1000));
                 continue;
             }
@@ -163,9 +154,43 @@ export const bind = (program) => program
         const metadataData = await metadata();
         return Object.values(metadataData)
             .flat()
-            .filter((c) => Boolean(c))
-            .filter((c) => c.type === "StaticSite" || Boolean(SSR_SITE_CONFIG[c.type]))
-            .find((c) => path.resolve(project.paths.root, c.data.path) === process.cwd());
+            .filter((c) => [
+            "StaticSite",
+            "NextjsSite",
+            "AstroSite",
+            "RemixSite",
+            "SolidStartSite",
+            "SlsNextjsSite",
+        ].includes(c.type))
+            .find((c) => {
+            // Handle metadata prior to SST v2.3.0 doesn't have path
+            const isSsr = c.type !== "StaticSite" && c.type !== "SlsNextjsSite";
+            if (!c.data.path ||
+                (isSsr && !c.data.server) ||
+                (!isSsr && !c.data.environment)) {
+                throw new OutdatedMetadataError();
+            }
+            return (path.resolve(project.paths.root, c.data.path) === process.cwd());
+        });
+    }
+    async function parseSiteMetadata(metadata) {
+        const { LambdaClient, GetFunctionCommand } = await import("@aws-sdk/client-lambda");
+        const { useAWSClient } = await import("../../credentials.js");
+        const isBindSupported = metadata.type !== "StaticSite" && metadata.type !== "SlsNextjsSite";
+        // Handle StaticSite
+        if (!isBindSupported) {
+            return { envs: metadata.data.environment };
+        }
+        // Get function details
+        const lambda = useAWSClient(LambdaClient);
+        const { Configuration: functionConfig } = await lambda.send(new GetFunctionCommand({
+            FunctionName: metadata.data.server,
+        }));
+        return {
+            role: functionConfig?.Role,
+            envs: functionConfig?.Environment?.Variables || {},
+            secrets: metadata.data.secrets,
+        };
     }
     async function assumeSsrRole(roleArn) {
         const { STSClient, AssumeRoleCommand } = await import("@aws-sdk/client-sts");

package/cli/commands/version.js

@@ -4,4 +4,5 @@ export const version = (program) => program.command("version", "Print SST and CD
     const project = useProject();
     Colors.line(Colors.bold(`SST:`), `v${project.version}`);
     Colors.line(Colors.bold(`CDK:`), `v${project.cdkVersion}`);
+    Colors.line(Colors.bold(`Constructs:`), `v${project.constructsVersion}`);
 });

package/constructs/Api.d.ts

@@ -594,7 +594,7 @@ export interface ApiGraphQLRouteProps<AuthorizerKeys> extends ApiBaseRouteProps<
  * @example
  *
  * ```ts
- * import { Api } from "@serverless-stack/resources";
+ * import { Api } from "sst/constructs";
  *
  * new Api(stack, "Api", {
  *   routes: {

package/constructs/Api.js

@@ -22,7 +22,7 @@ const PayloadFormatVersions = ["1.0", "2.0"];
  * @example
  *
  * ```ts
- * import { Api } from "@serverless-stack/resources";
+ * import { Api } from "sst/constructs";
  *
  * new Api(stack, "Api", {
  *   routes: {

package/constructs/ApiGatewayV1Api.d.ts

@@ -461,7 +461,7 @@ export interface ApiGatewayV1ApiCustomDomainProps {
  * @example
  *
  * ```js
- * import { ApiGatewayV1Api } from "@serverless-stack/resources";
+ * import { ApiGatewayV1Api } from "sst/constructs";
  *
  * new ApiGatewayV1Api(stack, "Api", {
  *   routes: {

package/constructs/ApiGatewayV1Api.js

@@ -31,7 +31,7 @@ const allowedMethods = [
  * @example
  *
  * ```js
- * import { ApiGatewayV1Api } from "@serverless-stack/resources";
+ * import { ApiGatewayV1Api } from "sst/constructs";
  *
  * new ApiGatewayV1Api(stack, "Api", {
  *   routes: {

package/constructs/AppSyncApi.d.ts

@@ -372,7 +372,7 @@ export interface AppSyncApiCdkGraphqlProps extends Omit<GraphqlApiProps, "name"
  * @example
  *
  * ```js
- * import { AppSyncApi } from "@serverless-stack/resources";
+ * import { AppSyncApi } from "sst/constructs";
  *
  * new AppSyncApi(stack, "GraphqlApi", {
  *   schema: "graphql/schema.graphql",

package/constructs/AppSyncApi.js

@@ -26,7 +26,7 @@ import { GraphqlApi, MappingTemplate as CDKMappingTemplate, SchemaFile, } from "
  * @example
  *
  * ```js
- * import { AppSyncApi } from "@serverless-stack/resources";
+ * import { AppSyncApi } from "sst/constructs";
  *
  * new AppSyncApi(stack, "GraphqlApi", {
  *   schema: "graphql/schema.graphql",

package/constructs/Auth.d.ts

@@ -54,7 +54,7 @@ export interface ApiAttachmentProps {
  * SST Auth is a lightweight authentication solution for your applications. With a simple set of configuration you can deploy a function attached to your API that can handle various authentication flows.  *
  * @example
  * ```
- * import { Auth } from "@serverless-stack/resources"
+ * import { Auth } from "sst/constructs"
  *
  * new Auth(stack, "auth", {
  *   authenticator: "functions/authenticator.handler"

package/constructs/Auth.js

@@ -11,7 +11,7 @@ const PREFIX_PROP = "prefix";
  * SST Auth is a lightweight authentication solution for your applications. With a simple set of configuration you can deploy a function attached to your API that can handle various authentication flows.  *
  * @example
  * ```
- * import { Auth } from "@serverless-stack/resources"
+ * import { Auth } from "sst/constructs"
  *
  * new Auth(stack, "auth", {
  *   authenticator: "functions/authenticator.handler"

package/constructs/Bucket.d.ts

@@ -228,7 +228,7 @@ export interface BucketProps {
  * @example
  *
  * ```js
- * import { Bucket } from "@serverless-stack/resources";
+ * import { Bucket } from "sst/constructs";
  *
  * new Bucket(stack, "Bucket");
  * ```

package/constructs/Bucket.js

@@ -15,7 +15,7 @@ import { LambdaDestination, SnsDestination, SqsDestination, } from "aws-cdk-lib/
  * @example
  *
  * ```js
- * import { Bucket } from "@serverless-stack/resources";
+ * import { Bucket } from "sst/constructs";
  *
  * new Bucket(stack, "Bucket");
  * ```

package/constructs/Cognito.d.ts

@@ -125,7 +125,7 @@ export interface CognitoProps {
  * @example
  *
  * ```js
- * import { Cognito } from "@serverless-stack/resources";
+ * import { Cognito } from "sst/constructs";
  *
  * new Cognito(stack, "Cognito");
  * ```

package/constructs/Cognito.js

@@ -28,7 +28,7 @@ const CognitoUserPoolTriggerOperationMapping = {
  * @example
  *
  * ```js
- * import { Cognito } from "@serverless-stack/resources";
+ * import { Cognito } from "sst/constructs";
  *
  * new Cognito(stack, "Cognito");
  * ```

package/constructs/Cron.d.ts

@@ -102,7 +102,7 @@ export interface CronProps {
  * @example
  *
  * ```js
- * import { Cron } from "@serverless-stack/resources";
+ * import { Cron } from "sst/constructs";
  *
  * new Cron(stack, "Cron", {
  *   schedule: "rate(1 minute)",

package/constructs/Cron.js

@@ -12,7 +12,7 @@ import { Function as Func, } from "./Function.js";
  * @example
  *
  * ```js
- * import { Cron } from "@serverless-stack/resources";
+ * import { Cron } from "sst/constructs";
  *
  * new Cron(stack, "Cron", {
  *   schedule: "rate(1 minute)",

package/constructs/EventBus.d.ts

@@ -258,7 +258,7 @@ export interface EventBusProps {
  * @example
  *
  * ```js
- * import { EventBus } from "@serverless-stack/resources";
+ * import { EventBus } from "sst/constructs";
  *
  * new EventBus(stack, "Bus", {
  *   rules: {

package/constructs/EventBus.js

@@ -13,7 +13,7 @@ import { Function as Fn, } from "./Function.js";
  * @example
  *
  * ```js
- * import { EventBus } from "@serverless-stack/resources";
+ * import { EventBus } from "sst/constructs";
  *
  * new EventBus(stack, "Bus", {
  *   rules: {

package/constructs/Function.d.ts

@@ -527,7 +527,7 @@ export interface FunctionCopyFilesProps {
  * @example
  *
  * ```js
- * import { Function } from "@serverless-stack/resources";
+ * import { Function } from "sst/constructs";
  *
  * new Function(stack, "MySnsLambda", {
  *   handler: "src/sns/index.main",

package/constructs/Function.js

@@ -54,7 +54,7 @@ const supportedRuntimes = {
  * @example
  *
  * ```js
- * import { Function } from "@serverless-stack/resources";
+ * import { Function } from "sst/constructs";
  *
  * new Function(stack, "MySnsLambda", {
  *   handler: "src/sns/index.main",

package/constructs/Job.d.ts

@@ -5,7 +5,7 @@ import { Function, NodeJSProps } from "./Function.js";
 import { Duration } from "./util/duration.js";
 import { Permissions } from "./util/permission.js";
 import { FunctionBindingProps } from "./util/functionBinding.js";
-import { IVpc } from "aws-cdk-lib/aws-ec2";
+import { ISecurityGroup, IVpc, SubnetSelection } from "aws-cdk-lib/aws-ec2";
 export type JobMemorySize = "3 GB" | "7 GB" | "15 GB" | "145 GB";
 export interface JobNodeJSProps extends NodeJSProps {
 }
@@ -139,6 +139,42 @@ export interface JobProps {
          * ```
          */
         vpc?: IVpc;
+        /**
+         * Where to place the network interfaces within the VPC.
+         * @default All private subnets.
+         * @example
+         * ```js
+         * import { SubnetType } from "aws-cdk-lib/aws-ec2";
+         *
+         * new Job(stack, "MyJob", {
+         *   handler: "src/job.handler",
+         *   cdk: {
+         *     vpc,
+         *     vpcSubnets: { subnetType: SubnetType.PRIVATE_WITH_EGRESS }
+         *   }
+         * })
+         * ```
+         */
+        vpcSubnets?: SubnetSelection;
+        /**
+         * The list of security groups to associate with the Job's network interfaces.
+         * @default A new security group is created.
+         * @example
+         * ```js
+         * import { SecurityGroup } from "aws-cdk-lib/aws-ec2";
+         *
+         * new Job(stack, "MyJob", {
+         *   handler: "src/job.handler",
+         *   cdk: {
+         *     vpc,
+         *     securityGroups: [
+         *       new SecurityGroup(stack, "MyJobSG", { vpc })
+         *     ]
+         *   }
+         * })
+         * ```
+         */
+        securityGroups?: ISecurityGroup[];
     };
 }
 /**
@@ -147,7 +183,7 @@ export interface JobProps {
  * @example
  *
  * ```js
- * import { Cron } from "@serverless-stack/resources";
+ * import { Cron } from "sst/constructs";
  *
  * new Cron(stack, "Cron", {
  *   schedule: "rate(1 minute)",

package/constructs/Job.js

@@ -24,7 +24,7 @@ const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
  * @example
  *
  * ```js
- * import { Cron } from "@serverless-stack/resources";
+ * import { Cron } from "sst/constructs";
  *
  * new Cron(stack, "Cron", {
  *   schedule: "rate(1 minute)",
@@ -135,7 +135,6 @@ export class Job extends Construct {
         const { cdk, memorySize, timeout } = this.props;
         const app = this.node.root;
         return new Project(this, "JobProject", {
-            vpc: cdk?.vpc,
             projectName: app.logicalPrefixedName(this.node.id),
             environment: {
                 // CodeBuild offers different build images. The newer ones have much quicker
@@ -163,6 +162,9 @@ export class Job extends Construct {
                     },
                 },
             }),
+            vpc: cdk?.vpc,
+            securityGroups: cdk?.securityGroups,
+            subnetSelection: cdk?.vpcSubnets,
         });
     }
     createLogRetention() {

package/constructs/KinesisStream.d.ts

@@ -114,7 +114,7 @@ export interface KinesisStreamProps {
  * @example
  *
  * ```js
- * import { KinesisStream } from "@serverless-stack/resources";
+ * import { KinesisStream } from "sst/constructs";
  *
  * new KinesisStream(stack, "Stream", {
  *   consumers: {

package/constructs/KinesisStream.js

@@ -13,7 +13,7 @@ import { Function as Fn, } from "./Function.js";
  * @example
  *
  * ```js
- * import { KinesisStream } from "@serverless-stack/resources";
+ * import { KinesisStream } from "sst/constructs";
  *
  * new KinesisStream(stack, "Stream", {
  *   consumers: {

package/constructs/Parameter.d.ts

@@ -14,7 +14,7 @@ export interface ParameterProps {
  * ### Using the minimal config
  *
  * ```js
- * import { Config } from "@serverless-stack/resources";
+ * import { Config } from "sst/constructs";
  *
  * new Config.Parameter(stack, "TABLE_NAME", table.tableName);
  * ```

package/constructs/Parameter.js

@@ -6,7 +6,7 @@ import { Construct } from "constructs";
  * ### Using the minimal config
  *
  * ```js
- * import { Config } from "@serverless-stack/resources";
+ * import { Config } from "sst/constructs";
  *
  * new Config.Parameter(stack, "TABLE_NAME", table.tableName);
  * ```

package/constructs/Queue.d.ts

@@ -106,7 +106,7 @@ export interface QueueProps {
  * @example
  *
  * ```js
- * import { Queue } from "@serverless-stack/resources";
+ * import { Queue } from "sst/constructs";
  *
  * new Queue(stack, "Queue", {
  *   consumer: "src/queueConsumer.main",

package/constructs/Queue.js

@@ -13,7 +13,7 @@ import { toCdkDuration } from "./util/duration.js";
  * @example
  *
  * ```js
- * import { Queue } from "@serverless-stack/resources";
+ * import { Queue } from "sst/constructs";
  *
  * new Queue(stack, "Queue", {
  *   consumer: "src/queueConsumer.main",

package/constructs/RDS.d.ts

@@ -53,7 +53,7 @@ export interface RDSProps {
         maxCapacity?: keyof typeof rds.AuroraCapacityUnit;
     };
     /**
-     * Path to the directory that contains the migration scripts. The `RDS` construct uses [Kysely](https://koskimas.github.io/kysely/) to run and manage schema migrations. The `migrations` prop should point to the folder where your migration files are.
+     * Path to the directory that contains the migration scripts. The `RDS` construct uses [Kysely](https://kysely-org.github.io/kysely/) to run and manage schema migrations. The `migrations` prop should point to the folder where your migration files are.
      *
      * @example
      *
@@ -145,7 +145,7 @@ export interface RDSCdkServerlessClusterProps extends Omit<rds.ServerlessCluster
  * @example
  *
  * ```js
- * import { RDS } from "@serverless-stack/resources";
+ * import { RDS } from "sst/constructs";
  *
  * new RDS(stack, "Database", {
  *   engine: "postgresql11.13",

package/constructs/RDS.js

@@ -20,7 +20,7 @@ const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
  * @example
  *
  * ```js
- * import { RDS } from "@serverless-stack/resources";
+ * import { RDS } from "sst/constructs";
  *
  * new RDS(stack, "Database", {
  *   engine: "postgresql11.13",

package/constructs/Script.d.ts

@@ -8,7 +8,7 @@ export interface ScriptProps {
      *
      * @example
      * ```js
-     * import { Script } from "@serverless-stack/resources";
+     * import { Script } from "sst/constructs";
      *
      * new Script(stack, "Script", {
      *   onCreate: "src/script.create",
@@ -76,7 +76,7 @@ export interface ScriptProps {
  * @example
  *
  * ```js
- * import { Script } from "@serverless-stack/resources";
+ * import { Script } from "sst/constructs";
  *
  * new Script(stack, "Script", {
  *   onCreate: "src/function.create",

package/constructs/Script.js

@@ -14,7 +14,7 @@ const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
  * @example
  *
  * ```js
- * import { Script } from "@serverless-stack/resources";
+ * import { Script } from "sst/constructs";
  *
  * new Script(stack, "Script", {
  *   onCreate: "src/function.create",

package/constructs/Secret.d.ts

@@ -8,7 +8,7 @@ import { FunctionBindingProps } from "./util/functionBinding.js";
  * ### Using the minimal config
  *
  * ```js
- * import { Config } from "@serverless-stack/resources";
+ * import { Config } from "sst/constructs";
  *
  * new Config.Secret(stack, "STRIPE_KEY");
  * ```

package/constructs/Secret.js

@@ -8,7 +8,7 @@ import { getParameterPath, getParameterFallbackPath, } from "./util/functionBind
  * ### Using the minimal config
  *
  * ```js
- * import { Config } from "@serverless-stack/resources";
+ * import { Config } from "sst/constructs";
  *
  * new Config.Secret(stack, "STRIPE_KEY");
  * ```

package/constructs/Stack.d.ts

@@ -11,7 +11,7 @@ export type StackProps = cdk.StackProps;
  * @example
  *
  * ```js
- * import { StackContext } from "@serverless-stack/resources";
+ * import { StackContext } from "sst/constructs";
  *
  * export function MyStack({ stack }: StackContext) {
  *   // Define your stack

package/constructs/Stack.js

@@ -13,7 +13,7 @@ const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
  * @example
  *
  * ```js
- * import { StackContext } from "@serverless-stack/resources";
+ * import { StackContext } from "sst/constructs";
  *
  * export function MyStack({ stack }: StackContext) {
  *   // Define your stack