sst 3.0.0 → 3.0.1-1

package/constructs/Topic.js

@@ -1,273 +0,0 @@
-import { Topic as AWSTopic, } from "aws-cdk-lib/aws-sns";
-import { LambdaSubscription, SqsSubscription, } from "aws-cdk-lib/aws-sns-subscriptions";
-import { Construct } from "constructs";
-import { getFunctionRef, isCDKConstruct, isCDKConstructOf, } from "./Construct.js";
-import { Function as Fn, } from "./Function.js";
-import { Queue } from "./Queue.js";
-/////////////////////
-// Construct
-/////////////////////
-/**
- * The `Topic` construct is a higher level CDK construct that makes it easy to create an SNS Topic and configure a list of subscriber functions.
- *
- * @example
- *
- * ```js
- * import { Topic } from "sst/constructs";
- *
- * new Topic(stack, "Topic", {
- *   subscribers: {
- *     subscriber1: "src/function1.handler",
- *     subscriber2: "src/function2.handler"
- *   },
- * });
- * ```
- */
-export class Topic extends Construct {
-    id;
-    cdk;
-    subscribers = {};
-    bindingForAllSubscribers = [];
-    permissionsAttachedForAllSubscribers = [];
-    props;
-    constructor(scope, id, props) {
-        super(scope, props?.cdk?.id || id);
-        this.id = id;
-        this.props = props || {};
-        this.cdk = {};
-        this.createTopic();
-        this.addSubscribers(this, props?.subscribers || {});
-    }
-    /**
-     * The ARN of the internally created SNS Topic.
-     */
-    get topicArn() {
-        return this.cdk.topic.topicArn;
-    }
-    /**
-     * The name of the internally created SNS Topic.
-     */
-    get topicName() {
-        return this.cdk.topic.topicName;
-    }
-    /**
-     * Get a list of subscriptions for this topic
-     */
-    get subscriptions() {
-        return Object.values(this.subscribers).map((sub) => {
-            let children;
-            // look for sns.Subscription inside Queue.sqsQueue
-            if (sub instanceof Queue) {
-                children = sub.cdk.queue.node.children;
-            }
-            // look for sns.Subscription inside Function
-            else {
-                children = sub.node.children;
-            }
-            const child = children.find((child) => {
-                return isCDKConstructOf(child, "aws-cdk-lib.aws_sns.Subscription");
-            });
-            return child;
-        });
-    }
-    /**
-     * A list of the internally created function instances for the subscribers.
-     */
-    get subscriberFunctions() {
-        return Object.values(this.subscribers).filter((subscriber) => subscriber instanceof Fn);
-    }
-    /**
-     * Add subscribers to the topic.
-     *
-     * @example
-     * ```js
-     * const topic = new Topic(stack, "Topic", {
-     *   subscribers: {
-     *     subscriber1: "src/function1.handler",
-     *     subscriber2: "src/function2.handler"
-     *   },
-     * });
-     * topic.addSubscribers(stack, {
-     *   subscriber3: "src/function3.handler"
-     * });
-     * ```
-     */
-    addSubscribers(scope, subscribers) {
-        Object.entries(subscribers).forEach(([subscriberName, subscriber]) => {
-            this.addSubscriber(scope, subscriberName, subscriber);
-        });
-    }
-    /**
-     * Binds the given list of resources to all the subscriber functions.
-     *
-     * @example
-     *
-     * ```js
-     * const topic = new Topic(stack, "Topic", {
-     *   subscribers: {
-     *     subscriber1: "src/function1.handler",
-     *     subscriber2: "src/function2.handler"
-     *   },
-     * });
-     * topic.bind([STRIPE_KEY, bucket]);
-     * ```
-     */
-    bind(constructs) {
-        Object.values(this.subscribers)
-            .filter((subscriber) => subscriber instanceof Fn)
-            .forEach((subscriber) => subscriber.bind(constructs));
-        this.bindingForAllSubscribers.push(...constructs);
-    }
-    /**
-     * Binds the given list of resources to a specific subscriber.
-     * @example
-     * ```js {8}
-     * const topic = new Topic(stack, "Topic", {
-     *   subscribers: {
-     *     subscriber1: "src/function1.handler",
-     *     subscriber2: "src/function2.handler"
-     *   },
-     * });
-     *
-     * topic.bindToSubscriber("subscriber1", [STRIPE_KEY, bucket]);
-     * ```
-     */
-    bindToSubscriber(subscriberName, constructs) {
-        const subscriber = this.subscribers[subscriberName];
-        if (!(subscriber instanceof Fn)) {
-            throw new Error(`Cannot bind to the "${this.node.id}" Topic subscriber because it's not a Lambda function`);
-        }
-        subscriber.bind(constructs);
-    }
-    /**
-     * Attaches the given list of permissions to all the subscriber functions. This allows the subscribers to access other AWS resources.
-     *
-     * @example
-     *
-     * ```js
-     * const topic = new Topic(stack, "Topic", {
-     *   subscribers: {
-     *     subscriber1: "src/function1.handler",
-     *     subscriber2: "src/function2.handler"
-     *   },
-     * });
-     * topic.attachPermissions(["s3"]);
-     * ```
-     */
-    attachPermissions(permissions) {
-        Object.values(this.subscribers)
-            .filter((subscriber) => subscriber instanceof Fn)
-            .forEach((subscriber) => subscriber.attachPermissions(permissions));
-        this.permissionsAttachedForAllSubscribers.push(permissions);
-    }
-    /**
-     * Attaches the list of permissions to a specific subscriber.
-     * @example
-     * ```js {8}
-     * const topic = new Topic(stack, "Topic", {
-     *   subscribers: {
-     *     subscriber1: "src/function1.handler",
-     *     subscriber2: "src/function2.handler"
-     *   },
-     * });
-     *
-     * topic.attachPermissionsToSubscriber("subscriber1", ["s3"]);
-     * ```
-     */
-    attachPermissionsToSubscriber(subscriberName, permissions) {
-        const subscriber = this.subscribers[subscriberName];
-        if (!(subscriber instanceof Fn)) {
-            throw new Error(`Cannot attach permissions to the "${this.node.id}" Topic subscriber because it's not a Lambda function`);
-        }
-        subscriber.attachPermissions(permissions);
-    }
-    getConstructMetadata() {
-        return {
-            type: "Topic",
-            data: {
-                topicArn: this.cdk.topic.topicArn,
-                // TODO: Deprecate eventually and mirror KinesisStream
-                subscribers: Object.values(this.subscribers).map(getFunctionRef),
-                subscriberNames: Object.keys(this.subscribers),
-            },
-        };
-    }
-    /** @internal */
-    getFunctionBinding() {
-        return {
-            clientPackage: "topic",
-            variables: {
-                topicArn: {
-                    type: "plain",
-                    value: this.topicArn,
-                },
-            },
-            permissions: {
-                "sns:*": [this.topicArn],
-            },
-        };
-    }
-    createTopic() {
-        const app = this.node.root;
-        const { cdk } = this.props;
-        if (isCDKConstruct(cdk?.topic)) {
-            this.cdk.topic = cdk?.topic;
-        }
-        else {
-            const snsTopicProps = (cdk?.topic || {});
-            this.cdk.topic = new AWSTopic(this, "Topic", {
-                topicName: app.logicalPrefixedName(this.node.id),
-                ...snsTopicProps,
-            });
-        }
-    }
-    addSubscriber(scope, subscriberName, subscriber) {
-        if (subscriber instanceof Queue ||
-            subscriber.queue) {
-            subscriber = subscriber;
-            this.addQueueSubscriber(scope, subscriberName, subscriber);
-        }
-        else {
-            subscriber = subscriber;
-            this.addFunctionSubscriber(scope, subscriberName, subscriber);
-        }
-    }
-    addQueueSubscriber(_scope, subscriberName, subscriber) {
-        // Parse subscriber props
-        let subscriptionProps;
-        let queue;
-        if (subscriber instanceof Queue) {
-            subscriber = subscriber;
-            queue = subscriber;
-        }
-        else {
-            subscriber = subscriber;
-            subscriptionProps = subscriber.cdk?.subscription;
-            queue = subscriber.queue;
-        }
-        this.subscribers[subscriberName] = queue;
-        // Create Subscription
-        this.cdk.topic.addSubscription(new SqsSubscription(queue.cdk.queue, subscriptionProps));
-    }
-    addFunctionSubscriber(scope, subscriberName, subscriber) {
-        // Parse subscriber props
-        let subscriptionProps;
-        let functionDefinition;
-        if (typeof subscriber !== "string" && "function" in subscriber) {
-            subscriptionProps = subscriber.cdk?.subscription;
-            functionDefinition = subscriber.function;
-        }
-        else {
-            subscriber = subscriber;
-            functionDefinition = subscriber;
-        }
-        // Create function
-        const fn = Fn.fromDefinition(scope, `Subscriber_${this.node.id}_${subscriberName}`, functionDefinition, this.props.defaults?.function, `The "defaults.function" cannot be applied if an instance of a Function construct is passed in. Make sure to define all the subscribers using FunctionProps, so the Topic construct can apply the "defaults.function" to them.`);
-        this.subscribers[subscriberName] = fn;
-        // Create Subscription
-        this.cdk.topic.addSubscription(new LambdaSubscription(fn, subscriptionProps));
-        // Attach existing permissions
-        this.permissionsAttachedForAllSubscribers.forEach((permissions) => fn.attachPermissions(permissions));
-        fn.bind(this.bindingForAllSubscribers);
-    }
-}

package/constructs/WebSocketApi.d.ts

@@ -1,355 +0,0 @@
-import { Construct } from "constructs";
-import * as logs from "aws-cdk-lib/aws-logs";
-import * as acm from "aws-cdk-lib/aws-certificatemanager";
-import * as apig from "@aws-cdk/aws-apigatewayv2-alpha";
-import * as apigAuthorizers from "@aws-cdk/aws-apigatewayv2-authorizers-alpha";
-import { SSTConstruct } from "./Construct.js";
-import { Function as Fn, FunctionProps, FunctionInlineDefinition, FunctionDefinition } from "./Function.js";
-import { FunctionBindingProps } from "./util/functionBinding.js";
-import { Permissions } from "./util/permission.js";
-import * as apigV2Domain from "./util/apiGatewayV2Domain.js";
-import * as apigV2AccessLog from "./util/apiGatewayV2AccessLog.js";
-export interface WebSocketApiDomainProps extends apigV2Domain.CustomDomainProps {
-}
-export interface WebSocketApiAccessLogProps extends apigV2AccessLog.AccessLogProps {
-}
-export interface WebSocketApiProps {
-    /**
-     * The routes for the WebSocket API
-     *
-     * @example
-     * ```js
-     * new WebSocketApi(stack, "Api", {
-     *   routes: {
-     *     $connect    : "src/connect.main",
-     *     $default    : "src/default.main",
-     *     $disconnect : "src/disconnect.main",
-     *     sendMessage : "src/sendMessage.main",
-     *   }
-     * })
-     * ```
-     */
-    routes?: Record<string, FunctionInlineDefinition | WebSocketApiFunctionRouteProps>;
-    /**
-     * Enable CloudWatch access logs for this API
-     *
-     * @example
-     * ```js
-     * new WebSocketApi(stack, "Api", {
-     *   accessLog: true
-     * });
-     * ```
-     *
-     * @example
-     * ```js
-     * new WebSocketApi(stack, "Api", {
-     *   accessLog: {
-     *     retention: "one_week",
-     *   },
-     * });
-     * ```
-     */
-    accessLog?: boolean | string | WebSocketApiAccessLogProps;
-    /**
-     * Specify a custom domain to use in addition to the automatically generated one. SST currently supports domains that are configured using [Route 53](https://aws.amazon.com/route53/)
-     *
-     * @example
-     * ```js
-     * new WebSocketApi(stack, "Api", {
-     *   customDomain: "api.example.com"
-     * })
-     * ```
-     *
-     * @example
-     * ```js
-     * new WebSocketApi(stack, "Api", {
-     *   customDomain: {
-     *     domainName: "api.example.com",
-     *     hostedZone: "domain.com",
-     *     path: "v1"
-     *   }
-     * })
-     * ```
-     */
-    customDomain?: string | WebSocketApiDomainProps;
-    /**
-     * The default authorizer for the API.
-     *
-     * @example
-     * ```js
-     * new WebSocketApi(stack, "Api", {
-     *   authorizer: "iam",
-     * });
-     * ```
-     *
-     * @example
-     * ```js
-     * new WebSocketApi(stack, "Api", {
-     *   authorizer: {
-     *     type: "lambda",
-     *     function: new Function(stack, "Authorizer", {
-     *       handler: "test/lambda.handler",
-     *     }),
-     *   },
-     * });
-     * ```
-     */
-    authorizer?: "none" | "iam" | WebSocketApiLambdaAuthorizer;
-    defaults?: {
-        /**
-         * The default function props to be applied to all the Lambda functions in the API. The `environment`, `permissions` and `layers` properties will be merged with per route definitions if they are defined.
-         *
-         * @example
-         * ```js
-         * new WebSocketApi(stack, "Api", {
-         *   defaults: {
-         *     function: {
-         *       timeout: 20,
-         *       environment: { tableName: table.tableName },
-         *       permissions: [table],
-         *     }
-         *   },
-         * });
-         * ```
-         */
-        function?: FunctionProps;
-    };
-    cdk?: {
-        /**
-         * Allows you to override default id for this construct.
-         */
-        id?: string;
-        /**
-         * Override the internally created WebSocket API
-         *
-         * @example
-         * ```js
-         * new WebSocketApi(stack, "WebSocketApi", {
-         *   cdk: {
-         *     webSocketApi: {
-         *       apiName: "my-websocket-api"
-         *     }
-         *   }
-         * })
-         * ```
-         */
-        webSocketApi?: apig.IWebSocketApi | apig.WebSocketApiProps;
-        /**
-         * Override the internally created WebSocket Stage
-         *
-         * @example
-         * ```js
-         * new WebSocketApi(stack, "WebSocketApi", {
-         *   cdk: {
-         *     webSocketStage: {
-         *       autoDeploy: false
-         *     }
-         *   }
-         * })
-         * ```
-         */
-        webSocketStage?: apig.IWebSocketStage | WebSocketApiCdkStageProps;
-    };
-}
-/**
- * Specify a function route handler and configure additional options
- *
- * @example
- * ```js
- * api.addRoutes(stack, {
- *   sendMessage : {
- *     function: "src/sendMessage.main",
- *   }
- * });
- * ```
- */
-export interface WebSocketApiFunctionRouteProps {
-    type?: "function";
-    /**
-     *The function definition used to create the function for this route.
-     */
-    function: FunctionDefinition;
-}
-/**
- * Specify a Lambda authorizer and configure additional options.
- *
- * @example
- * ```js
- * new WebSocketApi(stack, "Api", {
- *   authorizer: {
- *     type: "lambda",
- *     function: new Function(stack, "Authorizer", {
- *       handler: "test/lambda.handler",
- *     }),
- *   },
- * });
- * ```
- */
-export interface WebSocketApiLambdaAuthorizer {
-    type: "lambda";
-    name?: string;
-    identitySource?: string[];
-    function?: Fn;
-    cdk?: {
-        authorizer: apigAuthorizers.WebSocketLambdaAuthorizer;
-    };
-}
-export interface WebSocketApiCdkStageProps extends Omit<apig.WebSocketStageProps, "webSocketApi" | "stageName"> {
-    stageName?: string;
-}
-/**
- * The `WebSocketApi` construct is a higher level CDK construct that makes it easy to create a WebSocket API.
- *
- * @example
- * ```js
- * import { WebSocketApi } from "sst/constructs";
- *
- * new WebSocketApi(stack, "Api", {
- *   routes: {
- *     $connect: "src/connect.main",
- *     $default: "src/default.main",
- *     $disconnect: "src/disconnect.main",
- *     sendMessage: "src/sendMessage.main",
- *   },
- * });
- * ```
- */
-export declare class WebSocketApi extends Construct implements SSTConstruct {
-    readonly id: string;
-    readonly cdk: {
-        /**
-         * The internally created websocket api
-         */
-        webSocketApi: apig.WebSocketApi;
-        /**
-         * The internally created websocket stage
-         */
-        webSocketStage: apig.WebSocketStage;
-        /**
-         * The internally created log group
-         */
-        accessLogGroup?: logs.LogGroup;
-        /**
-         * The internally created domain name
-         */
-        domainName?: apig.DomainName;
-        /**
-         * The internally created certificate
-         */
-        certificate?: acm.Certificate;
-    };
-    private _customDomainUrl?;
-    private functions;
-    private apigRoutes;
-    private bindingForAllRoutes;
-    private permissionsAttachedForAllRoutes;
-    private authorizer?;
-    private props;
-    constructor(scope: Construct, id: string, props?: WebSocketApiProps);
-    /**
-     * Url of the WebSocket API
-     */
-    get url(): string;
-    /**
-     * Custom domain url if it's configured
-     */
-    get customDomainUrl(): string | undefined;
-    /**
-     * List of routes of the websocket api
-     */
-    get routes(): string[];
-    get _connectionsArn(): string;
-    /**
-     * Add routes to an already created WebSocket API
-     *
-     * @example
-     * ```js
-     * api.addRoutes(stack, {
-     *   "$connect": "src/connect.main",
-     * })
-     * ```
-     */
-    addRoutes(scope: Construct, routes: Record<string, FunctionInlineDefinition | WebSocketApiFunctionRouteProps>): void;
-    /**
-     * Get the instance of the internally created Function, for a given route key where the `routeKey` is the key used to define a route. For example, `$connect`.
-     *
-     * @example
-     * ```js
-     * const fn = api.getFunction("$connect");
-     * ```
-     */
-    getFunction(routeKey: string): Fn | undefined;
-    /**
-     * Get the instance of the internally created Route, for a given route key where the `routeKey` is the key used to define a route. For example, `$connect`.
-     *
-     * @example
-     * ```js
-     * const route = api.getRoute("$connect");
-     * ```
-     */
-    getRoute(routeKey: string): apig.WebSocketRoute | undefined;
-    /**
-     * Binds the given list of resources to all the routes.
-     *
-     * @example
-     *
-     * ```js
-     * api.bind([STRIPE_KEY, bucket]);
-     * ```
-     */
-    bind(constructs: SSTConstruct[]): void;
-    /**
-     * Binds the given list of resources to a specific route.
-     *
-     * @example
-     * ```js
-     * api.bindToRoute("$connect", [STRIPE_KEY, bucket]);
-     * ```
-     *
-     */
-    bindToRoute(routeKey: string, constructs: SSTConstruct[]): void;
-    /**
-     * Attaches the given list of permissions to all the routes. This allows the functions to access other AWS resources.
-     *
-     * @example
-     *
-     * ```js
-     * api.attachPermissions(["s3"]);
-     * ```
-     */
-    attachPermissions(permissions: Permissions): void;
-    /**
-     * Attaches the given list of permissions to a specific route. This allows that function to access other AWS resources.
-     *
-     * @example
-     * ```js
-     * api.attachPermissionsToRoute("$connect", ["s3"]);
-     * ```
-     *
-     */
-    attachPermissionsToRoute(routeKey: string, permissions: Permissions): void;
-    getConstructMetadata(): {
-        type: "WebSocketApi";
-        data: {
-            url: string;
-            httpApiId: string;
-            customDomainUrl: string | undefined;
-            routes: {
-                route: string;
-                fn: {
-                    node: string;
-                    stack: string;
-                } | undefined;
-            }[];
-        };
-    };
-    /** @internal */
-    getFunctionBinding(): FunctionBindingProps;
-    private createWebSocketApi;
-    private createWebSocketStage;
-    private createCloudWatchRole;
-    private addAuthorizer;
-    private addRoute;
-    private buildRouteAuth;
-    private normalizeRouteKey;
-}