sst 2.0.0-rc.8 → 2.0.0

package/util/process.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="node" resolution-mode="require"/>
 import { exec } from "child_process";
 export declare const execAsync: typeof exec.__promisify__;

package/watcher.js

@@ -2,7 +2,7 @@ import { Context } from "./context/context.js";
 import chokidar from "chokidar";
 import { useBus } from "./bus.js";
 import path from "path";
-import { useProject } from "./app.js";
+import { useProject } from "./project.js";
 export const useWatcher = Context.memo(() => {
     const project = useProject();
     const bus = useBus();

package/app.d.ts

@@ -1,36 +0,0 @@
-export interface Project {
-    name: string;
-    region: string;
-    stage?: string;
-    profile?: string;
-    main?: string;
-    ssmPrefix?: string;
-}
-declare const DEFAULTS: {
-    readonly main: "stacks/index.ts";
-    readonly stage: undefined;
-    readonly ssmPrefix: undefined;
-};
-declare type ProjectWithDefaults = Project & Required<{
-    [key in keyof typeof DEFAULTS]: Exclude<Project[key], undefined>;
-}> & {
-    version: string;
-    paths: {
-        root: string;
-        out: string;
-        artifacts: string;
-    };
-};
-export declare const ProjectContext: {
-    use(): ProjectWithDefaults;
-    provide(value: ProjectWithDefaults): void;
-};
-export declare function useProject(): ProjectWithDefaults;
-interface GlobalOptions {
-    profile?: string;
-    stage?: string;
-    root?: string;
-    region?: string;
-}
-export declare function initProject(globals: GlobalOptions): Promise<void>;
-export {};

package/constructs/DebugApp.d.ts

@@ -1,49 +0,0 @@
-import { App, StageSynthesisOptions } from "aws-cdk-lib";
-import { CloudAssembly } from "aws-cdk-lib/cx-api";
-/**
- * Deploy props for apps.
- */
-export interface DebugAppDeployProps {
-    /**
-     * The app name, used to prefix stacks.
-     */
-    name: string;
-    /**
-     * The stage to deploy this app to.
-     */
-    stage: string;
-    /**
-     * The region to deploy this app to.
-     */
-    region: string;
-}
-/**
- * The DebugApp construct is used internally by SST to create the resources needed to power Live Lambda Development.
- */
-export declare class DebugApp extends App {
-    /**
-     * The name of the app. This comes from the `name` in your `sst.json`.
-     */
-    readonly name: string;
-    /**
-     * The stage the app is being deployed to. If this is not specified as the [`--stage`](/packages/sst.md#--stage) option, it'll default to the stage configured during the initial run of the SST CLI.
-     */
-    readonly stage: string;
-    /**
-     * The region the app is being deployed to. If this is not specified as the [`--region`](/packages/sst.md#--region) option in the SST CLI, it'll default to the `region` in your `sst.json`.
-     */
-    readonly region: string;
-    /**
-     * The AWS account the app is being deployed to. This comes from the IAM credentials being used to run the SST CLI.
-     */
-    readonly account: string;
-    /**
-     * @internal
-     */
-    constructor(deployProps: DebugAppDeployProps);
-    synth(options?: StageSynthesisOptions): CloudAssembly;
-    /**
-     * Use this method to prefix resource names in your stacks to make sure they don't thrash when deployed to different stages in the same AWS account. This method will prefix a given resource name with the stage and app name. Using the format `${stage}-${name}-${logicalName}`.
-     */
-    logicalPrefixedName(logicalName: string): string;
-}

package/constructs/DebugApp.js

@@ -1,63 +0,0 @@
-import { App } from "aws-cdk-lib";
-import { isStackConstruct, isSSTDebugStack } from "./Construct.js";
-/**
- * The DebugApp construct is used internally by SST to create the resources needed to power Live Lambda Development.
- */
-export class DebugApp extends App {
-    /**
-     * The name of the app. This comes from the `name` in your `sst.json`.
-     */
-    name;
-    /**
-     * The stage the app is being deployed to. If this is not specified as the [`--stage`](/packages/sst.md#--stage) option, it'll default to the stage configured during the initial run of the SST CLI.
-     */
-    stage;
-    /**
-     * The region the app is being deployed to. If this is not specified as the [`--region`](/packages/sst.md#--region) option in the SST CLI, it'll default to the `region` in your `sst.json`.
-     */
-    region;
-    /**
-     * The AWS account the app is being deployed to. This comes from the IAM credentials being used to run the SST CLI.
-     */
-    account;
-    /**
-     * @internal
-     */
-    constructor(deployProps) {
-        super();
-        this.name = deployProps.name;
-        this.stage = deployProps.stage;
-        this.region = deployProps.region;
-        this.account = process.env.CDK_DEFAULT_ACCOUNT || "my-account";
-    }
-    synth(options = {}) {
-        // Check app has stack
-        const stacks = this.node.children.filter((child) => isSSTDebugStack(child));
-        if (stacks.length > 1) {
-            console.error(`Error: You can only create 1 DebugStack inside the "debugApp()" callback.\n`);
-            process.exit(1);
-        }
-        if (stacks.length === 0) {
-            console.error(`Error: The "debugApp()" callback is not creating a DebugStack.\n`);
-            process.exit(1);
-        }
-        for (const child of this.node.children) {
-            if (isStackConstruct(child)) {
-                // Stack names need to be parameterized with the stage name
-                if (!child.stackName.startsWith(`${this.stage}-`) &&
-                    !child.stackName.endsWith(`-${this.stage}`) &&
-                    child.stackName.indexOf(`-${this.stage}-`) === -1) {
-                    console.error(`Error: Stack "${child.stackName}" is not parameterized with the stage name. The stack name needs to either start with "$stage-", end in "-$stage", or contain the stage name "-$stage-".\n`);
-                    process.exit(1);
-                }
-            }
-        }
-        return super.synth(options);
-    }
-    /**
-     * Use this method to prefix resource names in your stacks to make sure they don't thrash when deployed to different stages in the same AWS account. This method will prefix a given resource name with the stage and app name. Using the format `${stage}-${name}-${logicalName}`.
-     */
-    logicalPrefixedName(logicalName) {
-        return `${this.stage}-${this.name}-${logicalName}`;
-    }
-}

package/constructs/DebugStack.d.ts

@@ -1,34 +0,0 @@
-import { Construct } from "constructs";
-import * as cdk from "aws-cdk-lib";
-import * as dynamodb from "aws-cdk-lib/aws-dynamodb";
-/**
- * Stack properties for the DebugStack.
- */
-export interface DebugStackProps extends cdk.StackProps {
-    /**
-     * S3 bucket to store large websocket payloads.
-     */
-    payloadBucketArn?: string;
-    /**
-     * Lambda function props for WebSocket request handlers.
-     */
-    websocketHandlerRoleArn?: string;
-    cdk?: {
-        /**
-         * Override the settings of the internally created DynamoDB table
-         */
-        table?: Omit<dynamodb.TableProps, "partitionKey" | "sortKey">;
-    };
-}
-/**
- * The `DebugStack` construct is used internally to create the resources needed to power Live Lambda Development. Note that, the `DebugStack` construct should only be created inside the [`DebugApp`](DebugApp).
- */
-export declare class DebugStack extends cdk.Stack {
-    readonly stage: string;
-    private readonly api;
-    private readonly table;
-    private readonly bucket;
-    constructor(scope: Construct, id: string, props?: DebugStackProps);
-    private addApiRoute;
-    private static checkForEnvInProps;
-}

package/constructs/DebugStack.js

@@ -1,132 +0,0 @@
-import * as path from "path";
-import url from "url";
-import * as cdk from "aws-cdk-lib";
-import * as s3 from "aws-cdk-lib/aws-s3";
-import * as iam from "aws-cdk-lib/aws-iam";
-import * as logs from "aws-cdk-lib/aws-logs";
-import * as lambda from "aws-cdk-lib/aws-lambda";
-import * as apig from "aws-cdk-lib/aws-apigatewayv2";
-import * as dynamodb from "aws-cdk-lib/aws-dynamodb";
-const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
-/**
- * The `DebugStack` construct is used internally to create the resources needed to power Live Lambda Development. Note that, the `DebugStack` construct should only be created inside the [`DebugApp`](DebugApp).
- */
-export class DebugStack extends cdk.Stack {
-    stage;
-    api;
-    table;
-    bucket;
-    constructor(scope, id, props) {
-        const app = scope.node.root;
-        const stackId = app.logicalPrefixedName(id);
-        DebugStack.checkForEnvInProps(id, props);
-        super(scope, stackId, {
-            ...props,
-            env: {
-                account: app.account,
-                region: app.region,
-            },
-        });
-        this.stage = app.stage;
-        // Create connection table
-        this.table = new dynamodb.Table(this, "Table", {
-            partitionKey: { name: "pk", type: dynamodb.AttributeType.STRING },
-            billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,
-            removalPolicy: cdk.RemovalPolicy.DESTROY,
-            ...props?.cdk?.table,
-        });
-        // Create S3 bucket for storing large payloads
-        this.bucket = props?.payloadBucketArn
-            ? s3.Bucket.fromBucketArn(this, "Bucket", props.payloadBucketArn)
-            : new s3.Bucket(this, "Bucket", {
-                lifecycleRules: [
-                    {
-                        expiration: cdk.Duration.days(1),
-                        prefix: "payloads/",
-                    },
-                ],
-                encryption: s3.BucketEncryption.S3_MANAGED,
-                removalPolicy: cdk.RemovalPolicy.DESTROY,
-                autoDeleteObjects: true,
-                blockPublicAccess: s3.BlockPublicAccess.BLOCK_ALL,
-            });
-        // Create API
-        this.api = new apig.CfnApi(this, "Api", {
-            name: `${this.stackName}-api`,
-            protocolType: "WEBSOCKET",
-            routeSelectionExpression: "$request.body.action",
-        });
-        new apig.CfnStage(this, "ApiStage", {
-            apiId: this.api.ref,
-            autoDeploy: true,
-            stageName: this.stage,
-        });
-        // Create API routes
-        const role = props?.websocketHandlerRoleArn
-            ? iam.Role.fromRoleArn(this, "HandlerRole", props.websocketHandlerRoleArn)
-            : undefined;
-        this.addApiRoute("Connect", "$connect", "wsConnect.main", role);
-        this.addApiRoute("Disconnect", "$disconnect", "wsDisconnect.main", role);
-        this.addApiRoute("Default", "$default", "wsDefault.main", role);
-        // Stack Output
-        new cdk.CfnOutput(this, "Endpoint", {
-            value: `${this.api.attrApiEndpoint}/${this.stage}`,
-        });
-        new cdk.CfnOutput(this, "BucketArn", {
-            value: this.bucket.bucketArn,
-        });
-        new cdk.CfnOutput(this, "BucketName", {
-            value: this.bucket.bucketName,
-        });
-    }
-    addApiRoute(id, routeKey, handler, role) {
-        // Create execution policy
-        const policyStatement = new iam.PolicyStatement();
-        policyStatement.addAllResources();
-        policyStatement.addActions("apigateway:*", "dynamodb:*", "execute-api:ManageConnections");
-        // Create Lambda
-        const lambdaFunc = new lambda.Function(this, id, {
-            code: lambda.Code.fromAsset(path.join(__dirname, "../assets/DebugStack")),
-            handler,
-            runtime: lambda.Runtime.NODEJS_16_X,
-            timeout: cdk.Duration.seconds(10),
-            memorySize: 256,
-            logRetention: logs.RetentionDays.ONE_WEEK,
-            logRetentionRole: role,
-            environment: {
-                TABLE_NAME: this.table.tableName,
-            },
-            role,
-            initialPolicy: [policyStatement],
-        });
-        lambdaFunc.addPermission(`${id}Permission`, {
-            principal: new iam.ServicePrincipal("apigateway.amazonaws.com"),
-        });
-        // Create API integrations
-        const integration = new apig.CfnIntegration(this, `${id}Integration`, {
-            apiId: this.api.ref,
-            integrationType: "AWS_PROXY",
-            integrationUri: `arn:${this.partition}:apigateway:${this.region}:lambda:path/2015-03-31/functions/${lambdaFunc.functionArn}/invocations`,
-        });
-        // Create API routes
-        new apig.CfnRoute(this, `${id}Route`, {
-            apiId: this.api.ref,
-            routeKey,
-            authorizationType: "NONE",
-            target: `integrations/${integration.ref}`,
-        });
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    static checkForEnvInProps(id, props) {
-        if (props && props.env) {
-            let envS = "";
-            try {
-                envS = " (" + JSON.stringify(props.env) + ")";
-            }
-            catch (e) {
-                // Ignore
-            }
-            throw new Error(`Do not set the "env" prop while initializing "${id}" stack${envS}. Use the "AWS_PROFILE" environment variable and "--region" CLI option instead.`);
-        }
-    }
-}

package/constructs/GraphQLApi.d.ts

@@ -1,98 +0,0 @@
-import { HttpRouteIntegration } from "@aws-cdk/aws-apigatewayv2-alpha";
-import { Construct } from "constructs";
-import { Api, ApiFunctionRouteProps, ApiProps } from "./Api.js";
-import { Function as Fn, FunctionDefinition } from "./Function.js";
-export interface GraphQLApiProps extends Omit<ApiProps, "routes"> {
-    /**
-     * Path to graphql-codegen configuration file
-     *
-     * @example
-     * ```js
-     * new GraphQLApi(stack, "api", {
-     *   codegen: "./graphql/codegen.yml"
-     * })
-     * ```
-     */
-    codegen?: string;
-    /**
-     * Path to function that will be invoked to resolve GraphQL queries.
-     *
-     * @example
-     * ```js
-     * new GraphQLApi(stack, "api", {
-     *   codegen: "./graphql/codegen.yml"
-     * })
-     * ```
-     */
-    server: FunctionDefinition;
-    rootPath?: string;
-}
-/**
- * The `GraphQLApi` construct is a higher level CDK construct that makes it easy to create GraphQL servers with AWS Lambda.
- *
- * @example
- *
- * ```js
- * import { GraphQLApi } from "@serverless-stack/resources";
- *
- * new GraphQLApi(stack, "Api", {
- *   server: "src/graphql.handler",
- * });
- * ```
- */
-export declare class GraphQLApi extends Api {
-    private readonly codegen?;
-    private lambdaIntegration?;
-    private rootPath?;
-    constructor(scope: Construct, id: string, props: GraphQLApiProps);
-    get serverFunction(): Fn;
-    protected createFunctionIntegration(scope: Construct, routeKey: string, routeProps: ApiFunctionRouteProps<string>, postfixName: string): HttpRouteIntegration;
-    getConstructMetadata(): {
-        data: {
-            graphql: true;
-            codegen: string | undefined;
-            url: string | undefined;
-            httpApiId: string;
-            customDomainUrl: string | undefined;
-            routes: ({
-                type: "function";
-                route: string;
-                fn: {
-                    node: string;
-                    stack: string;
-                } | undefined;
-                schema?: undefined;
-                output?: undefined;
-                commands?: undefined;
-            } | {
-                type: "pothos";
-                route: string;
-                fn: {
-                    node: string;
-                    stack: string;
-                } | undefined;
-                schema: string | undefined;
-                output: string | undefined;
-                commands: string[] | undefined;
-            } | {
-                type: "graphql";
-                route: string;
-                fn: {
-                    node: string;
-                    stack: string;
-                } | undefined;
-                schema: string | undefined;
-                output: string | undefined;
-                commands: string[] | undefined;
-            } | {
-                type: "lambda_function" | "url" | "alb";
-                route: string;
-                fn?: undefined;
-                schema?: undefined;
-                output?: undefined;
-                commands?: undefined;
-            })[];
-        };
-        type: "Api";
-    };
-}

package/constructs/GraphQLApi.js

@@ -1,80 +0,0 @@
-import { App } from "./App.js";
-import spawn from "cross-spawn";
-import { Api } from "./Api.js";
-/**
- * The `GraphQLApi` construct is a higher level CDK construct that makes it easy to create GraphQL servers with AWS Lambda.
- *
- * @example
- *
- * ```js
- * import { GraphQLApi } from "@serverless-stack/resources";
- *
- * new GraphQLApi(stack, "Api", {
- *   server: "src/graphql.handler",
- * });
- * ```
- */
-export class GraphQLApi extends Api {
-    codegen;
-    lambdaIntegration;
-    rootPath;
-    constructor(scope, id, props) {
-        if ("routes" in props || !props.server) {
-            throw new Error(`Please use the "server" option instead of the "routes" to configure the handler for the "${id}" GraphQLApi`);
-        }
-        if (props.codegen) {
-            const app = App.of(scope);
-            if (!app.local) {
-                const result = spawn.sync("npx", ["graphql-codegen", "-c", props.codegen], {
-                    stdio: "inherit",
-                });
-                if (result.status !== 0) {
-                    throw new Error(`Failed to generate the schema for the "${id}" GraphQLApi`);
-                }
-            }
-        }
-        const rootPath = props.rootPath || "/";
-        super(scope, id, {
-            ...props,
-            routes: {
-                [`GET ${rootPath}`]: { function: props.server },
-                [`POST ${rootPath}`]: { function: props.server },
-            },
-        });
-        this.rootPath = rootPath;
-        this.codegen = props.codegen;
-    }
-    get serverFunction() {
-        const serverFn = this.getFunction(`GET ${this.rootPath}`);
-        // This should never happen
-        if (!serverFn) {
-            throw new Error(`Failed to get "serverFunction" in the "${this.node.id}" GraphQLApi`);
-        }
-        return serverFn;
-    }
-    // Note: We want to create 1 Lambda handling both the GET and POST request.
-    //       This design is based on this discussion on GitHub
-    //       https://github.com/serverless-stack/sst/issues/601
-    // Also Note: We cannot use the "ANY /" route because if authorization
-    //            were provided, the OPTIONS route will be protected. This
-    //            causes CORS to fail.
-    // Solution: We will override the createFunctionIntegration() function, and
-    //           it will re-use the same Route Integration for all routes.
-    createFunctionIntegration(scope, routeKey, routeProps, postfixName) {
-        if (!this.lambdaIntegration) {
-            this.lambdaIntegration = super.createFunctionIntegration(scope, routeKey, routeProps, postfixName);
-        }
-        return this.lambdaIntegration;
-    }
-    getConstructMetadata() {
-        const parent = super.getConstructMetadata();
-        return {
-            ...parent,
-            data: {
-                ...parent.data,
-                graphql: true,
-                codegen: this.codegen,
-            },
-        };
-    }
-}

package/constructs/ReactStaticSite.d.ts

@@ -1,20 +0,0 @@
-import { Construct } from "constructs";
-import { StaticSite, StaticSiteProps } from "./StaticSite.js";
-import { SSTConstruct } from "./Construct.js";
-export declare type ReactStaticSiteProps = StaticSiteProps;
-/**
- * The `ReactStaticSite` construct is a higher level CDK construct that makes it easy to create a React single page app.
- *
- * @example
- *
- * Deploys a Create React App in the `path/to/src` directory.
- *
- * ```js
- * new ReactStaticSite(stack, "ReactSite", {
- *   path: "path/to/src",
- * });
- * ```
- */
-export declare class ReactStaticSite extends StaticSite implements SSTConstruct {
-    constructor(scope: Construct, id: string, props: ReactStaticSiteProps);
-}

package/constructs/ReactStaticSite.js

@@ -1,54 +0,0 @@
-import * as path from "path";
-import fs from "fs";
-import { StaticSite } from "./StaticSite.js";
-/////////////////////
-// Construct
-/////////////////////
-/**
- * The `ReactStaticSite` construct is a higher level CDK construct that makes it easy to create a React single page app.
- *
- * @example
- *
- * Deploys a Create React App in the `path/to/src` directory.
- *
- * ```js
- * new ReactStaticSite(stack, "ReactSite", {
- *   path: "path/to/src",
- * });
- * ```
- */
-export class ReactStaticSite extends StaticSite {
-    constructor(scope, id, props) {
-        const { path: sitePath, environment } = props || {};
-        // Validate environment
-        Object.keys(environment || {}).forEach((key) => {
-            if (!key.startsWith("REACT_APP_")) {
-                throw new Error(`Environment variables in the "${id}" ReactStaticSite must start with "REACT_APP_".`);
-            }
-        });
-        // generate buildCommand
-        let defaultBuildCommand = "npm run build";
-        if (fs.existsSync(path.join(sitePath, "yarn.lock"))) {
-            defaultBuildCommand = "yarn build";
-        }
-        super(scope, id, {
-            indexPage: "index.html",
-            errorPage: "redirect_to_index_page",
-            buildCommand: defaultBuildCommand,
-            buildOutput: "build",
-            fileOptions: [
-                {
-                    exclude: "*",
-                    include: "*.html",
-                    cacheControl: "max-age=0,no-cache,no-store,must-revalidate",
-                },
-                {
-                    exclude: "*",
-                    include: ["*.js", "*.css"],
-                    cacheControl: "max-age=31536000,public,immutable",
-                },
-            ],
-            ...props,
-        });
-    }
-}

package/constructs/Script/cfn-response.d.ts

@@ -1,19 +0,0 @@
-export declare const CREATE_FAILED_PHYSICAL_ID_MARKER = "AWSCDK::CustomResourceProviderFramework::CREATE_FAILED";
-export declare const MISSING_PHYSICAL_ID_MARKER = "AWSCDK::CustomResourceProviderFramework::MISSING_PHYSICAL_ID";
-export interface CloudFormationResponseOptions {
-    readonly reason?: string;
-    readonly noEcho?: boolean;
-}
-export interface CloudFormationEventContext {
-    StackId: string;
-    RequestId: string;
-    PhysicalResourceId?: string;
-    LogicalResourceId: string;
-    ResponseURL: string;
-    Data?: any;
-}
-export declare function submitResponse(status: "SUCCESS" | "FAILED", event: CloudFormationEventContext, options?: CloudFormationResponseOptions): Promise<void>;
-export declare const includeStackTraces = true;
-export declare function safeHandler(block: (event: any) => Promise<void>): (event: any) => Promise<void>;
-export declare class Retry extends Error {
-}