Move interfaces to their own file and inforce type imports

.eslintrc

@@ -72,7 +72,8 @@
                 "@typescript-eslint/prefer-string-starts-ends-with": "error",
                 "@typescript-eslint/switch-exhaustiveness-check": "error",
                 // We intentionally use this so that constructs can declare their command handlers
-                "@typescript-eslint/unbound-method": "off"
+                "@typescript-eslint/unbound-method": "off",
+                "@typescript-eslint/consistent-type-imports": "error"
             }
         }
     ]

src/CloudFormation.ts

@@ -1,6 +1,7 @@
-import { DescribeStacksInput, DescribeStacksOutput } from "aws-sdk/clients/cloudformation";
-import { CfnOutput, Stack } from "@aws-cdk/core";
-import { AwsProvider } from "@lift/providers";
+import type { DescribeStacksInput, DescribeStacksOutput } from "aws-sdk/clients/cloudformation";
+import type { CfnOutput } from "@aws-cdk/core";
+import { Stack } from "@aws-cdk/core";
+import type { AwsProvider } from "@lift/providers";
 import { debug } from "./utils/logger";
 
 export async function getStackOutput(aws: AwsProvider, output: CfnOutput): Promise<string | undefined> {

src/classes/aws.ts

@@ -1,4 +1,4 @@
-import { Provider as LegacyAwsProvider } from "../types/serverless";
+import type { Provider as LegacyAwsProvider } from "../types/serverless";
 
 // This is defined as a separate function to allow mocking in tests
 export async function awsRequest<Input, Output>(

src/constructs/ConstructInterface.ts

@@ -0,0 +1,31 @@
+import type { PolicyStatement } from "../CloudFormation";
+
+/**
+ * Defines which methods a Lift construct must expose.
+ */
+export interface ConstructInterface {
+    /**
+     * Values shown in the CLI output.
+     */
+    outputs?(): Record<string, () => Promise<string | undefined>>;
+
+    /**
+     * serverless.yml variables
+     */
+    variables?(): Record<string, unknown>;
+
+    /**
+     * Post-CloudFormation deployment
+     */
+    postDeploy?(): Promise<void>;
+
+    /**
+     * Pre-CloudFormation deletion
+     */
+    preRemove?(): Promise<void>;
+
+    /**
+     * IAM permissions to add to Lambda functions of the stack
+     */
+    permissions?(): PolicyStatement[];
+}

src/constructs/StaticConstructInterface.ts

@@ -0,0 +1,30 @@
+import type { ConstructInterface } from "@lift/constructs";
+import type { ProviderInterface } from "@lift/providers";
+import type { CliOptions } from "../types/serverless";
+
+/**
+ * Defines which static properties and methods a Lift construct must expose.
+ */
+export interface StaticConstructInterface {
+    type: string;
+    schema: {
+        type: "object";
+        [k: string]: unknown;
+    };
+    commands?: ConstructCommands;
+    create(provider: ProviderInterface, id: string, configuration: Record<string, unknown>): ConstructInterface;
+}
+
+export type ConstructCommands = Record<string, ConstructCommandDefinition>;
+type ConstructCommandDefinition = {
+    usage: string;
+    handler: (options: CliOptions) => void | Promise<void>;
+    options?: {
+        [name: string]: {
+            usage: string;
+            type: string;
+            required?: boolean;
+            shortcut?: string;
+        };
+    };
+};

src/constructs/abstracts/AwsConstruct.ts

@@ -1,6 +1,6 @@
 import { Construct as CdkConstruct } from "@aws-cdk/core";
-import { AwsProvider } from "@lift/providers";
-import { ConstructInterface } from "@lift/constructs";
+import type { AwsProvider } from "@lift/providers";
+import type { ConstructInterface } from "@lift/constructs";
 
 export abstract class AwsConstruct extends CdkConstruct implements ConstructInterface {
     static create<C extends AwsConstruct = AwsConstruct>(

src/constructs/aws/DatabaseDynamoDBSingleTable.ts

@@ -1,7 +1,8 @@
-import { Construct as CdkConstruct, CfnOutput, Fn, Stack } from "@aws-cdk/core";
+import type { Construct as CdkConstruct } from "@aws-cdk/core";
+import { CfnOutput, Fn, Stack } from "@aws-cdk/core";
 import { AttributeType, BillingMode, StreamViewType, Table } from "@aws-cdk/aws-dynamodb";
-import { FromSchema } from "json-schema-to-ts";
-import { AwsProvider } from "@lift/providers";
+import type { FromSchema } from "json-schema-to-ts";
+import type { AwsProvider } from "@lift/providers";
 import { AwsConstruct } from "@lift/constructs/abstracts";
 import { PolicyStatement } from "../../CloudFormation";
 

src/constructs/aws/Queue.ts

@@ -1,21 +1,22 @@
 import { Queue as CdkQueue } from "@aws-cdk/aws-sqs";
-import { FromSchema } from "json-schema-to-ts";
+import type { FromSchema } from "json-schema-to-ts";
 import { Alarm, ComparisonOperator, Metric } from "@aws-cdk/aws-cloudwatch";
 import { Subscription, SubscriptionProtocol, Topic } from "@aws-cdk/aws-sns";
-import { AlarmActionConfig } from "@aws-cdk/aws-cloudwatch/lib/alarm-action";
-import { Construct as CdkConstruct, CfnOutput, Duration } from "@aws-cdk/core";
+import type { AlarmActionConfig } from "@aws-cdk/aws-cloudwatch/lib/alarm-action";
+import type { Construct as CdkConstruct } from "@aws-cdk/core";
+import { CfnOutput, Duration } from "@aws-cdk/core";
 import chalk from "chalk";
-import { PurgeQueueRequest, SendMessageRequest } from "aws-sdk/clients/sqs";
+import type { PurgeQueueRequest, SendMessageRequest } from "aws-sdk/clients/sqs";
 import ora from "ora";
 import { spawnSync } from "child_process";
 import * as inquirer from "inquirer";
-import { AwsProvider } from "@lift/providers";
+import type { AwsProvider } from "@lift/providers";
 import { AwsConstruct } from "@lift/constructs/abstracts";
-import { ConstructCommands } from "@lift/constructs";
+import type { ConstructCommands } from "@lift/constructs";
 import { pollMessages, retryMessages } from "./queue/sqs";
 import { sleep } from "../../utils/sleep";
 import { PolicyStatement } from "../../CloudFormation";
-import { CliOptions } from "../../types/serverless";
+import type { CliOptions } from "../../types/serverless";
 
 const QUEUE_DEFINITION = {
     type: "object",

src/constructs/aws/StaticWebsite.ts

@@ -9,23 +9,24 @@ import {
     ViewerProtocolPolicy,
 } from "@aws-cdk/aws-cloudfront";
 import * as cloudfront from "@aws-cdk/aws-cloudfront";
-import { Construct as CdkConstruct, CfnOutput, Duration, RemovalPolicy } from "@aws-cdk/core";
-import { FromSchema } from "json-schema-to-ts";
-import {
+import type { Construct as CdkConstruct } from "@aws-cdk/core";
+import { CfnOutput, Duration, RemovalPolicy } from "@aws-cdk/core";
+import type { FromSchema } from "json-schema-to-ts";
+import type {
     DeleteObjectsOutput,
     DeleteObjectsRequest,
     ListObjectsV2Output,
     ListObjectsV2Request,
 } from "aws-sdk/clients/s3";
 import chalk from "chalk";
-import { CreateInvalidationRequest, CreateInvalidationResult } from "aws-sdk/clients/cloudfront";
+import type { CreateInvalidationRequest, CreateInvalidationResult } from "aws-sdk/clients/cloudfront";
 import { S3Origin } from "@aws-cdk/aws-cloudfront-origins";
 import * as acm from "@aws-cdk/aws-certificatemanager";
 import { flatten } from "lodash";
-import { ErrorResponse } from "@aws-cdk/aws-cloudfront/lib/distribution";
-import { AwsProvider } from "@lift/providers";
+import type { ErrorResponse } from "@aws-cdk/aws-cloudfront/lib/distribution";
+import type { AwsProvider } from "@lift/providers";
 import { AwsConstruct } from "@lift/constructs/abstracts";
-import { ConstructCommands } from "@lift/constructs";
+import type { ConstructCommands } from "@lift/constructs";
 import { log } from "../../utils/logger";
 import { s3Sync } from "../../utils/s3-sync";
 import ServerlessError from "../../utils/error";

src/constructs/aws/Storage.ts

@@ -1,7 +1,8 @@
 import { BlockPublicAccess, Bucket, BucketEncryption, StorageClass } from "@aws-cdk/aws-s3";
-import { Construct as CdkConstruct, CfnOutput, Duration, Fn, Stack } from "@aws-cdk/core";
-import { FromSchema } from "json-schema-to-ts";
-import { AwsProvider } from "@lift/providers";
+import type { Construct as CdkConstruct } from "@aws-cdk/core";
+import { CfnOutput, Duration, Fn, Stack } from "@aws-cdk/core";
+import type { FromSchema } from "json-schema-to-ts";
+import type { AwsProvider } from "@lift/providers";
 import { AwsConstruct } from "@lift/constructs/abstracts";
 import { PolicyStatement } from "../../CloudFormation";
 

src/constructs/aws/Vpc.ts

@@ -1,8 +1,8 @@
 import { Vpc as CdkVpc, Peer, Port, SecurityGroup } from "@aws-cdk/aws-ec2";
-import { Construct as CdkConstruct } from "@aws-cdk/core";
-import { FromSchema } from "json-schema-to-ts";
-import { AwsProvider } from "@lift/providers";
-import { ConstructInterface } from "@lift/constructs";
+import type { Construct as CdkConstruct } from "@aws-cdk/core";
+import type { FromSchema } from "json-schema-to-ts";
+import type { AwsProvider } from "@lift/providers";
+import type { ConstructInterface } from "@lift/constructs";
 
 const VPC_DEFINITION = {
     type: "object",

src/constructs/aws/Webhook.ts

@@ -1,10 +1,11 @@
-import { Construct as CdkConstruct, CfnOutput, Fn } from "@aws-cdk/core";
+import type { Construct as CdkConstruct } from "@aws-cdk/core";
+import { CfnOutput, Fn } from "@aws-cdk/core";
 import { CfnAuthorizer, CfnIntegration, CfnRoute, HttpApi } from "@aws-cdk/aws-apigatewayv2";
 import { Function } from "@aws-cdk/aws-lambda";
 import { EventBus } from "@aws-cdk/aws-events";
-import { FromSchema } from "json-schema-to-ts";
+import type { FromSchema } from "json-schema-to-ts";
 import { PolicyDocument, PolicyStatement, Role, ServicePrincipal } from "@aws-cdk/aws-iam";
-import { AwsProvider } from "@lift/providers";
+import type { AwsProvider } from "@lift/providers";
 import { AwsConstruct } from "@lift/constructs/abstracts";
 import ServerlessError from "../../utils/error";
 

src/constructs/aws/queue/sqs.ts

@@ -1,4 +1,4 @@
-import {
+import type {
     DeleteMessageBatchRequest,
     DeleteMessageBatchResult,
     Message,
@@ -7,7 +7,7 @@ import {
     SendMessageBatchRequest,
     SendMessageBatchResult,
 } from "aws-sdk/clients/sqs";
-import { AwsProvider } from "@lift/providers";
+import type { AwsProvider } from "@lift/providers";
 import { log } from "../../../utils/logger";
 import { sleep } from "../../../utils/sleep";
 

src/constructs/index.ts

@@ -1,60 +1,2 @@
-import { ProviderInterface } from "@lift/providers";
-import { PolicyStatement } from "../CloudFormation";
-import { CliOptions } from "../types/serverless";
-
-/**
- * Defines which methods a Lift construct must expose.
- */
-export interface ConstructInterface {
-    /**
-     * Values shown in the CLI output.
-     */
-    outputs?(): Record<string, () => Promise<string | undefined>>;
-
-    /**
-     * serverless.yml variables
-     */
-    variables?(): Record<string, unknown>;
-
-    /**
-     * Post-CloudFormation deployment
-     */
-    postDeploy?(): Promise<void>;
-
-    /**
-     * Pre-CloudFormation deletion
-     */
-    preRemove?(): Promise<void>;
-
-    /**
-     * IAM permissions to add to Lambda functions of the stack
-     */
-    permissions?(): PolicyStatement[];
-}
-
-/**
- * Defines which static properties and methods a Lift construct must expose.
- */
-export interface StaticConstructInterface {
-    type: string;
-    schema: {
-        type: "object";
-        [k: string]: unknown;
-    };
-    commands?: ConstructCommands;
-    create(provider: ProviderInterface, id: string, configuration: Record<string, unknown>): ConstructInterface;
-}
-
-export type ConstructCommands = Record<string, ConstructCommandDefinition>;
-type ConstructCommandDefinition = {
-    usage: string;
-    handler: (options: CliOptions) => void | Promise<void>;
-    options?: {
-        [name: string]: {
-            usage: string;
-            type: string;
-            required?: boolean;
-            shortcut?: string;
-        };
-    };
-};
+export type { ConstructInterface } from "./ConstructInterface";
+export type { StaticConstructInterface, ConstructCommands } from "./StaticConstructInterface";

src/plugin.ts

@@ -1,13 +1,14 @@
 import { flatten, get, has, merge } from "lodash";
 import chalk from "chalk";
-import { AwsIamPolicyStatements } from "@serverless/typescript";
+import type { AwsIamPolicyStatements } from "@serverless/typescript";
 import * as path from "path";
 import { readFileSync } from "fs";
 import { dump } from "js-yaml";
 import { DefaultTokenResolver, Lazy, StringConcat, Tokenization } from "@aws-cdk/core";
-import { FromSchema } from "json-schema-to-ts";
-import { AwsProvider, ProviderInterface, StaticProviderInterface, StripeProvider } from "@lift/providers";
-import { ConstructInterface, StaticConstructInterface } from "@lift/constructs";
+import type { FromSchema } from "json-schema-to-ts";
+import type { ProviderInterface, StaticProviderInterface } from "@lift/providers";
+import { AwsProvider, StripeProvider } from "@lift/providers";
+import type { ConstructInterface, StaticConstructInterface } from "@lift/constructs";
 import type {
     CommandsDefinition,
     DeprecatedVariableResolver,

src/providers/AwsProvider.ts

@@ -1,11 +1,12 @@
-import { App, CfnOutput, Stack } from "@aws-cdk/core";
+import type { CfnOutput } from "@aws-cdk/core";
+import { App, Stack } from "@aws-cdk/core";
 import { get, merge } from "lodash";
-import { AwsCfInstruction, AwsLambdaVpcConfig } from "@serverless/typescript";
-import { ProviderInterface } from "@lift/providers";
-import { ConstructInterface, StaticConstructInterface } from "@lift/constructs";
+import type { AwsCfInstruction, AwsLambdaVpcConfig } from "@serverless/typescript";
+import type { ProviderInterface } from "@lift/providers";
+import type { ConstructInterface, StaticConstructInterface } from "@lift/constructs";
 import { DatabaseDynamoDBSingleTable, Queue, StaticWebsite, Storage, Vpc, Webhook } from "@lift/constructs/aws";
 import { getStackOutput } from "../CloudFormation";
-import { CloudformationTemplate, Provider as LegacyAwsProvider, Serverless } from "../types/serverless";
+import type { CloudformationTemplate, Provider as LegacyAwsProvider, Serverless } from "../types/serverless";
 import { awsRequest } from "../classes/aws";
 import ServerlessError from "../utils/error";
 

src/providers/ProviderInterface.ts

@@ -0,0 +1,5 @@
+import type { ConstructInterface } from "@lift/constructs";
+
+export interface ProviderInterface {
+    create(type: string, id: string): ConstructInterface;
+}

src/providers/StaticProviderInterface.ts

@@ -0,0 +1,6 @@
+import type { StaticConstructInterface } from "@lift/constructs";
+
+export interface StaticProviderInterface {
+    getConstructClass(type: string): StaticConstructInterface | undefined;
+    getAllConstructClasses(): StaticConstructInterface[];
+}

src/providers/StripeProvider.ts

@@ -4,9 +4,9 @@ import { resolve } from "path";
 import { parse as tomlParse } from "toml";
 import { get } from "lodash";
 import { Stripe } from "stripe";
-import { ConstructInterface, StaticConstructInterface } from "@lift/constructs";
-import { ProviderInterface } from "@lift/providers";
-import { Serverless } from "../types/serverless";
+import type { ConstructInterface, StaticConstructInterface } from "@lift/constructs";
+import type { ProviderInterface } from "@lift/providers";
+import type { Serverless } from "../types/serverless";
 import ServerlessError from "../utils/error";
 
 type StripeConfiguration = {

src/providers/index.ts

@@ -1,13 +1,5 @@
-import { ConstructInterface, StaticConstructInterface } from "@lift/constructs";
+export type { ProviderInterface } from "./ProviderInterface";
+export type { StaticProviderInterface } from "./StaticProviderInterface";
 
 export { AwsProvider } from "./AwsProvider";
 export { StripeProvider } from "./StripeProvider";
-
-export interface ProviderInterface {
-    create(type: string, id: string): ConstructInterface;
-}
-
-export interface StaticProviderInterface {
-    getConstructClass(type: string): StaticConstructInterface | undefined;
-    getAllConstructClasses(): StaticConstructInterface[];
-}

src/utils/s3-sync.ts

@@ -1,4 +1,4 @@
-import {
+import type {
     DeleteObjectsOutput,
     DeleteObjectsRequest,
     ListObjectsV2Output,
@@ -14,7 +14,7 @@ import * as crypto from "crypto";
 import { lookup } from "mime-types";
 import { chunk, flatten } from "lodash";
 import chalk from "chalk";
-import { AwsProvider } from "@lift/providers";
+import type { AwsProvider } from "@lift/providers";
 
 const readdir = util.promisify(fs.readdir);
 const stat = util.promisify(fs.stat);

test/unit/queues.test.ts

@@ -1,6 +1,6 @@
 import { merge } from "lodash";
 import * as sinon from "sinon";
-import { DeleteMessageBatchResult, ReceiveMessageResult, SendMessageBatchResult } from "aws-sdk/clients/sqs";
+import type { DeleteMessageBatchResult, ReceiveMessageResult, SendMessageBatchResult } from "aws-sdk/clients/sqs";
 import * as CloudFormationHelpers from "../../src/CloudFormation";
 import { pluginConfigExt, runServerless } from "../utils/runServerless";
 import { mockAws } from "../utils/mockAws";

test/unit/vpc.test.ts

@@ -1,5 +1,5 @@
 import { cloneDeep, get, merge } from "lodash";
-import { AwsCfInstruction } from "@serverless/typescript";
+import type { AwsCfInstruction } from "@serverless/typescript";
 import { baseConfig, pluginConfigExt, runServerless } from "../utils/runServerless";
 import ServerlessError from "../../src/utils/error";