sst 3.0.0 → 3.0.1-1

package/constructs/Parameter.d.ts

@@ -1,37 +0,0 @@
-import { Construct } from "constructs";
-import { SSTConstruct } from "./Construct.js";
-import { FunctionBindingProps } from "./util/functionBinding.js";
-export interface ParameterProps {
-    /**
-     * Value of the parameter
-     */
-    value: string;
-}
-/**
- * The `Parameter` construct is a higher level CDK construct that makes it easy to manage app environment variables.
- *
- * @example
- * ### Using the minimal config
- *
- * ```js
- * import { Config } from "sst/constructs";
- *
- * new Config.Parameter(stack, "TABLE_NAME", table.tableName);
- * ```
- */
-export declare class Parameter extends Construct implements SSTConstruct {
-    readonly id: string;
-    readonly name: string;
-    readonly value: string;
-    constructor(scope: Construct, id: string, props: ParameterProps);
-    /** @internal */
-    getConstructMetadata(): {
-        type: "Parameter";
-        data: {
-            name: string;
-        };
-    };
-    /** @internal */
-    getFunctionBinding(): FunctionBindingProps;
-    static create<T extends Record<string, any>>(scope: Construct, parameters: T): { [key in keyof T]: Parameter; };
-}

package/constructs/Parameter.js

@@ -1,53 +0,0 @@
-import { Construct } from "constructs";
-/**
- * The `Parameter` construct is a higher level CDK construct that makes it easy to manage app environment variables.
- *
- * @example
- * ### Using the minimal config
- *
- * ```js
- * import { Config } from "sst/constructs";
- *
- * new Config.Parameter(stack, "TABLE_NAME", table.tableName);
- * ```
- */
-export class Parameter extends Construct {
-    id;
-    name;
-    value;
-    constructor(scope, id, props) {
-        super(scope, id);
-        this.id = id;
-        this.name = id;
-        this.value = props.value;
-    }
-    /** @internal */
-    getConstructMetadata() {
-        return {
-            type: "Parameter",
-            data: {
-                name: this.name,
-            },
-        };
-    }
-    /** @internal */
-    getFunctionBinding() {
-        return {
-            clientPackage: "config",
-            variables: {
-                value: {
-                    type: "plain",
-                    value: this.value,
-                },
-            },
-            permissions: {},
-        };
-    }
-    static create(scope, parameters) {
-        const result = {};
-        for (const [name, value] of Object.entries(parameters)) {
-            result[name] = new Parameter(scope, name, { value });
-        }
-        return result;
-    }
-}

package/constructs/Queue.d.ts

@@ -1,194 +0,0 @@
-import { Construct } from "constructs";
-import * as sqs from "aws-cdk-lib/aws-sqs";
-import * as lambda from "aws-cdk-lib/aws-lambda";
-import * as lambdaEventSources from "aws-cdk-lib/aws-lambda-event-sources";
-import { SSTConstruct } from "./Construct.js";
-import { Function as Fn, FunctionInlineDefinition, FunctionDefinition } from "./Function.js";
-import { FunctionBindingProps } from "./util/functionBinding.js";
-import { Permissions } from "./util/permission.js";
-/**
- * Used to define the consumer for the queue and invocation details
- */
-export interface QueueConsumerProps {
-    /**
-     * Used to create the consumer function for the queue.
-     *
-     * @example
-     * ```js
-     * new Queue(stack, "Queue", {
-     *   consumer: {
-     *     function: {
-     *       handler: "src/function.handler",
-     *       timeout: 10,
-     *     },
-     *   },
-     * });
-     * ```
-     */
-    function?: FunctionDefinition;
-    cdk?: {
-        /**
-         * This allows you to use an existing or imported Lambda function.
-         *
-         * @example
-         * ```js
-         * new Queue(stack, "Queue", {
-         *   consumer: {
-         *     cdk: {
-         *       function: lambda.Function.fromFunctionAttributes(stack, "ImportedFn", {
-         *         functionArn: "arn:aws:lambda:us-east-1:123456789:function:my-function",
-         *         role: iam.Role.fromRoleArn(stack, "IRole", "arn:aws:iam::123456789:role/my-role"),
-         *       }),
-         *     },
-         *   },
-         * });
-         * ```
-         */
-        function?: lambda.IFunction;
-        /**
-         * This allows you to override the default settings this construct uses internally to create the consumer.
-         *
-         * @example
-         * ```js
-         * new Queue(stack, "Queue", {
-         *   consumer: {
-         *     function: "test/lambda.handler",
-         *     cdk: {
-         *       eventSource: {
-         *         batchSize: 5,
-         *       },
-         *     },
-         *   },
-         * });
-         * ```
-         */
-        eventSource?: lambdaEventSources.SqsEventSourceProps;
-    };
-}
-export interface QueueProps {
-    /**
-     * Used to create the consumer for the queue.
-     *
-     * @example
-     * ```js
-     * new Queue(stack, "Queue", {
-     *   consumer: "src/function.handler",
-     * })
-     * ```
-     */
-    consumer?: FunctionInlineDefinition | QueueConsumerProps;
-    cdk?: {
-        /**
-         * Allows you to override default id for this construct.
-         */
-        id?: string;
-        /**
-         * Override the default settings this construct uses internally to create the queue.
-         *
-         * @example
-         * ```js
-         * new Queue(stack, "Queue", {
-         *   consumer: "src/function.handler",
-         *   cdk: {
-         *     queue: {
-         *       fifo: true,
-         *     },
-         *   }
-         * });
-         * ```
-         */
-        queue?: sqs.IQueue | sqs.QueueProps;
-    };
-}
-/**
- * The `Queue` construct is a higher level CDK construct that makes it easy to create an SQS Queue and configure a consumer function.
- *
- * @example
- *
- * ```js
- * import { Queue } from "sst/constructs";
- *
- * new Queue(stack, "Queue", {
- *   consumer: "src/queueConsumer.main",
- * });
- * ```
- */
-export declare class Queue extends Construct implements SSTConstruct {
-    readonly id: string;
-    readonly cdk: {
-        /**
-         * The internally created CDK `Queue` instance.
-         */
-        queue: sqs.IQueue;
-    };
-    /**
-     * The internally created consumer `Function` instance.
-     */
-    consumerFunction?: Fn | lambda.IFunction;
-    private bindingForAllConsumers;
-    private permissionsAttachedForAllConsumers;
-    private props;
-    constructor(scope: Construct, id: string, props?: QueueProps);
-    /**
-     * The ARN of the SQS Queue
-     */
-    get queueArn(): string;
-    /**
-     * The URL of the SQS Queue
-     */
-    get queueUrl(): string;
-    /**
-     * The name of the SQS Queue
-     */
-    get queueName(): string;
-    /**
-     * Adds a consumer after creating the queue. Note only one consumer can be added to a queue
-     *
-     * @example
-     * ```js {3}
-     * const queue = new Queue(stack, "Queue");
-     * queue.addConsumer(props.stack, "src/function.handler");
-     * ```
-     */
-    addConsumer(scope: Construct, consumer: FunctionInlineDefinition | QueueConsumerProps): void;
-    private addCdkFunctionConsumer;
-    private addFunctionConsumer;
-    /**
-     * Binds the given list of resources to the consumer function
-     *
-     * @example
-     * ```js
-     * const queue = new Queue(stack, "Queue", {
-     *   consumer: "src/function.handler",
-     * });
-     * queue.bind([STRIPE_KEY, bucket]);
-     * ```
-     */
-    bind(constructs: SSTConstruct[]): void;
-    /**
-     * Attaches additional permissions to the consumer function
-     *
-     * @example
-     * ```js
-     * const queue = new Queue(stack, "Queue", {
-     *   consumer: "src/function.handler",
-     * });
-     * queue.attachPermissions(["s3"]);
-     * ```
-     */
-    attachPermissions(permissions: Permissions): void;
-    getConstructMetadata(): {
-        type: "Queue";
-        data: {
-            name: string;
-            url: string;
-            consumer: {
-                node: string;
-                stack: string;
-            } | undefined;
-        };
-    };
-    /** @internal */
-    getFunctionBinding(): FunctionBindingProps;
-    private createQueue;
-}

package/constructs/Queue.js

@@ -1,204 +0,0 @@
-import { Construct } from "constructs";
-import * as sqs from "aws-cdk-lib/aws-sqs";
-import * as lambdaEventSources from "aws-cdk-lib/aws-lambda-event-sources";
-import { getFunctionRef, isCDKConstruct } from "./Construct.js";
-import { Function as Fn, } from "./Function.js";
-import { toCdkDuration } from "./util/duration.js";
-/////////////////////
-// Construct
-/////////////////////
-/**
- * The `Queue` construct is a higher level CDK construct that makes it easy to create an SQS Queue and configure a consumer function.
- *
- * @example
- *
- * ```js
- * import { Queue } from "sst/constructs";
- *
- * new Queue(stack, "Queue", {
- *   consumer: "src/queueConsumer.main",
- * });
- * ```
- */
-export class Queue extends Construct {
-    id;
-    cdk;
-    /**
-     * The internally created consumer `Function` instance.
-     */
-    consumerFunction;
-    bindingForAllConsumers = [];
-    permissionsAttachedForAllConsumers = [];
-    props;
-    constructor(scope, id, props) {
-        super(scope, props?.cdk?.id || id);
-        this.id = id;
-        this.props = props || {};
-        this.cdk = {};
-        this.createQueue();
-        if (props?.consumer) {
-            this.addConsumer(this, props.consumer);
-        }
-    }
-    /**
-     * The ARN of the SQS Queue
-     */
-    get queueArn() {
-        return this.cdk.queue.queueArn;
-    }
-    /**
-     * The URL of the SQS Queue
-     */
-    get queueUrl() {
-        return this.cdk.queue.queueUrl;
-    }
-    /**
-     * The name of the SQS Queue
-     */
-    get queueName() {
-        return this.cdk.queue.queueName;
-    }
-    /**
-     * Adds a consumer after creating the queue. Note only one consumer can be added to a queue
-     *
-     * @example
-     * ```js {3}
-     * const queue = new Queue(stack, "Queue");
-     * queue.addConsumer(props.stack, "src/function.handler");
-     * ```
-     */
-    addConsumer(scope, consumer) {
-        if (this.consumerFunction) {
-            throw new Error("Cannot configure more than 1 consumer for a Queue");
-        }
-        if (consumer.cdk?.function) {
-            consumer = consumer;
-            this.addCdkFunctionConsumer(scope, consumer);
-        }
-        else {
-            consumer = consumer;
-            this.addFunctionConsumer(scope, consumer);
-        }
-    }
-    addCdkFunctionConsumer(scope, consumer) {
-        // Parse target props
-        const eventSourceProps = consumer.cdk?.eventSource;
-        const fn = consumer.cdk.function;
-        // Create target
-        fn.addEventSource(new lambdaEventSources.SqsEventSource(this.cdk.queue, eventSourceProps));
-        this.consumerFunction = fn;
-    }
-    addFunctionConsumer(scope, consumer) {
-        // Parse consumer props
-        let eventSourceProps;
-        let functionDefinition;
-        if (consumer.function) {
-            consumer = consumer;
-            eventSourceProps = consumer.cdk?.eventSource;
-            functionDefinition = consumer.function;
-        }
-        else {
-            consumer = consumer;
-            functionDefinition = consumer;
-        }
-        // Create function
-        const fn = Fn.fromDefinition(scope, `Consumer_${this.node.id}`, functionDefinition);
-        fn.addEventSource(new lambdaEventSources.SqsEventSource(this.cdk.queue, eventSourceProps));
-        // Attach permissions
-        this.permissionsAttachedForAllConsumers.forEach((permissions) => {
-            fn.attachPermissions(permissions);
-        });
-        fn.bind(this.bindingForAllConsumers);
-        this.consumerFunction = fn;
-    }
-    /**
-     * Binds the given list of resources to the consumer function
-     *
-     * @example
-     * ```js
-     * const queue = new Queue(stack, "Queue", {
-     *   consumer: "src/function.handler",
-     * });
-     * queue.bind([STRIPE_KEY, bucket]);
-     * ```
-     */
-    bind(constructs) {
-        if (this.consumerFunction instanceof Fn) {
-            this.consumerFunction.bind(constructs);
-        }
-        this.bindingForAllConsumers.push(...constructs);
-    }
-    /**
-     * Attaches additional permissions to the consumer function
-     *
-     * @example
-     * ```js
-     * const queue = new Queue(stack, "Queue", {
-     *   consumer: "src/function.handler",
-     * });
-     * queue.attachPermissions(["s3"]);
-     * ```
-     */
-    attachPermissions(permissions) {
-        if (this.consumerFunction instanceof Fn) {
-            this.consumerFunction.attachPermissions(permissions);
-        }
-        this.permissionsAttachedForAllConsumers.push(permissions);
-    }
-    getConstructMetadata() {
-        return {
-            type: "Queue",
-            data: {
-                name: this.cdk.queue.queueName,
-                url: this.cdk.queue.queueUrl,
-                consumer: getFunctionRef(this.consumerFunction),
-            },
-        };
-    }
-    /** @internal */
-    getFunctionBinding() {
-        return {
-            clientPackage: "queue",
-            variables: {
-                queueUrl: {
-                    type: "plain",
-                    value: this.queueUrl,
-                },
-            },
-            permissions: {
-                "sqs:*": [this.queueArn],
-            },
-        };
-    }
-    createQueue() {
-        const { cdk } = this.props;
-        const root = this.node.root;
-        const id = this.node.id;
-        if (isCDKConstruct(cdk?.queue)) {
-            this.cdk.queue = cdk?.queue;
-        }
-        else {
-            const sqsQueueProps = cdk?.queue || {};
-            // If debugIncreaseTimeout is enabled (ie. sst start):
-            // - Set visibilityTimeout to > 900s. This is because Lambda timeout is
-            //   set to 900s, and visibilityTimeout has to be greater or equal to it.
-            //   This will give people more time to debug the function without timing
-            //   out the request.
-            let debugOverrideProps;
-            if (root.debugIncreaseTimeout) {
-                if (!sqsQueueProps.visibilityTimeout ||
-                    sqsQueueProps.visibilityTimeout.toSeconds() < 900) {
-                    debugOverrideProps = {
-                        visibilityTimeout: toCdkDuration("900 seconds"),
-                    };
-                }
-            }
-            const name = root.logicalPrefixedName(id) + (sqsQueueProps.fifo ? ".fifo" : "");
-            this.cdk.queue = new sqs.Queue(this, "Queue", {
-                queueName: name,
-                ...sqsQueueProps,
-                ...debugOverrideProps,
-            });
-        }
-    }
-}

package/constructs/RDS.d.ts

@@ -1,221 +0,0 @@
-import { Construct } from "constructs";
-import { IVpc } from "aws-cdk-lib/aws-ec2";
-import { AuroraCapacityUnit, Endpoint, IServerlessCluster, ServerlessCluster, ServerlessClusterProps } from "aws-cdk-lib/aws-rds";
-import { ISecret } from "aws-cdk-lib/aws-secretsmanager";
-import { SSTConstruct } from "./Construct.js";
-import { Function as Fn } from "./Function.js";
-import { FunctionBindingProps } from "./util/functionBinding.js";
-export interface RDSTypes {
-    path: string;
-    camelCase?: boolean;
-}
-export interface RDSProps {
-    /**
-     * Database engine of the cluster. Cannot be changed once set.
-     */
-    engine: "mysql5.6" | "mysql5.7" | "postgresql11.13" | "postgresql11.16" | "postgresql13.9";
-    /**
-     * Name of a database which is automatically created inside the cluster.
-     */
-    defaultDatabaseName: string;
-    scaling?: {
-        /**
-         * The time before the cluster is paused.
-         *
-         * Pass in true to pause after 5 minutes of inactive. And pass in false to
-         * disable pausing.
-         *
-         * Or pass in the number of minutes to wait before the cluster is paused.
-         *
-         * @default true
-         *
-         * @example
-         * ```js
-         * new RDS(stack, "Database", {
-         *   scaling: {
-         *     autoPause: props.app.stage !== "prod"
-         *   }
-         * })
-         * ```
-         */
-        autoPause?: boolean | number;
-        /**
-         * The minimum capacity for the cluster.
-         *
-         * @default "ACU_2"
-         */
-        minCapacity?: keyof typeof AuroraCapacityUnit;
-        /**
-         * The maximum capacity for the cluster.
-         *
-         * @default "ACU_16"
-         */
-        maxCapacity?: keyof typeof AuroraCapacityUnit;
-    };
-    /**
-     * 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
-     *
-     * ```js
-     * new RDS(stack, "Database", {
-     *   engine: "postgresql11.13",
-     *   defaultDatabaseName: "acme",
-     *   migrations: "path/to/migration/scripts",
-     * });
-     * ```
-     */
-    migrations?: string;
-    /**
-     * Path to place generated typescript types after running migrations
-     *
-     * @example
-     *
-     * ```js
-     * new RDS(stack, "Database", {
-     *   engine: "postgresql11.13",
-     *   defaultDatabaseName: "acme",
-     *   migrations: "path/to/migration/scripts",
-     *   types: "backend/core/sql/types.ts",
-     * });
-     * ```
-     * @example
-     * ```js
-     * new RDS(stack, "Database", {
-     *   engine: "postgresql11.13",
-     *   defaultDatabaseName: "acme",
-     *   migrations: "path/to/migration/scripts",
-     *   types: {
-     *     path: "backend/core/sql/types.ts",
-     *     camelCase: true
-     *   }
-     * });
-     * ```
-     */
-    types?: string | RDSTypes;
-    cdk?: {
-        /**
-         * Allows you to override default id for this construct.
-         */
-        id?: string;
-        /**
-         * Configure the internallly created RDS cluster.
-         *
-         * @example
-         * ```js
-         * new RDS(stack, "Database", {
-         *   cdk: {
-         *     cluster: {
-         *       clusterIdentifier: "my-cluster",
-         *     }
-         *   },
-         * });
-         * ```
-         *
-         * Alternatively, you can import an existing RDS Serverless v1 Cluster in your AWS account.
-         *
-         * @example
-         * ```js
-         * new RDS(stack, "Database", {
-         *   cdk: {
-         *     cluster: rds.ServerlessCluster.fromServerlessClusterAttributes(stack, "ICluster", {
-         *       clusterIdentifier: "my-cluster",
-         *     }),
-         *     secret: secretsManager.Secret.fromSecretAttributes(stack, "ISecret", {
-         *       secretPartialArn: "arn:aws:secretsmanager:us-east-1:123456789012:secret:my-secret",
-         *     }),
-         *   },
-         * });
-         * ```
-         */
-        cluster?: IServerlessCluster | RDSCdkServerlessClusterProps;
-        /**
-         * Required when importing existing RDS Serverless v1 Cluster.
-         */
-        secret?: ISecret;
-    };
-}
-export type RDSEngineType = RDSProps["engine"];
-export interface RDSCdkServerlessClusterProps extends Omit<ServerlessClusterProps, "vpc" | "engine" | "defaultDatabaseName" | "scaling"> {
-    vpc?: IVpc;
-}
-/**
- * The `RDS` construct is a higher level CDK construct that makes it easy to create an [RDS Serverless Cluster](https://aws.amazon.com/rds/).
- *
- * @example
- *
- * ```js
- * import { RDS } from "sst/constructs";
- *
- * new RDS(stack, "Database", {
- *   engine: "postgresql11.13",
- *   defaultDatabaseName: "my_database",
- * });
- * ```
- */
-export declare class RDS extends Construct implements SSTConstruct {
-    readonly id: string;
-    readonly cdk: {
-        /**
-         * The ARN of the internally created CDK ServerlessCluster instance.
-         */
-        cluster: ServerlessCluster;
-    };
-    /**
-     * The ARN of the internally created CDK ServerlessCluster instance.
-     */
-    migratorFunction?: Fn;
-    private props;
-    private secret;
-    constructor(scope: Construct, id: string, props: RDSProps);
-    /**
-     * The ARN of the internally created RDS Serverless Cluster.
-     */
-    get clusterArn(): string;
-    /**
-     * The ARN of the internally created RDS Serverless Cluster.
-     */
-    get clusterIdentifier(): string;
-    /**
-     * The ARN of the internally created RDS Serverless Cluster.
-     */
-    get clusterEndpoint(): Endpoint;
-    /**
-     * The default database name of the RDS Serverless Cluster.
-     */
-    get defaultDatabaseName(): string;
-    /**
-     * The ARN of the internally created Secrets Manager Secret.
-     */
-    get secretArn(): string;
-    getConstructMetadata(): {
-        type: "RDS";
-        data: {
-            engine: "mysql5.6" | "mysql5.7" | "postgresql11.13" | "postgresql11.16" | "postgresql13.9";
-            secretArn: string;
-            types: RDSTypes | undefined;
-            clusterArn: string;
-            clusterIdentifier: string;
-            defaultDatabaseName: string;
-            migrator: {
-                node: string;
-                stack: string;
-            } | undefined;
-        };
-    };
-    /** @internal */
-    getFunctionBinding(): FunctionBindingProps;
-    private validateRequiredProps;
-    private validateCDKPropWhenIsConstruct;
-    private validateCDKPropWhenIsClusterProps;
-    private validateMigrationsFileExists;
-    private getEngine;
-    private getScaling;
-    private getVpc;
-    private getVpcSubnets;
-    private createCluster;
-    private importCluster;
-    private createMigrationsFunction;
-    private createMigrationCustomResource;
-    private generateMigrationsHash;
-}