@byaga/cdk-patterns 0.9.3 → 0.10.0

package/.fleet/run.json

@@ -0,0 +1,11 @@
+{
+    "configurations": [
+        {
+            "type": "npm",
+            "name": "cdk-patterns build",
+            "command": "run",
+            "scripts": "build",
+        },
+
+    ]
+}

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 VeryFineHat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# @byaga/cdk-patterns
+
+This package provides a set of reusable patterns for the AWS Cloud Development Kit (CDK).
+
+NOTE: This package is highly opinionated and is intended to be used by the author. Use at your own risk/joy.
+
+## Installation
+
+To install the package, use the following command:
+
+```bash
+npm install @byaga/cdk-patterns
+```
+
+## Usage
+
+Import the package in your TypeScript or JavaScript file:
+
+```typescript
+import { Pattern } from '@byaga/cdk-patterns';
+```
+
+Then, you can use the patterns provided by the package in your CDK stacks.
+
+## Patterns
+
+The package includes the following patterns:
+
+- [NodeJsLambda](./src/NodeJsLambda.md)
+
+## Contributing
+
+Contributions are welcome! Please read our contributing guidelines for details.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

package/lib/DeployStack.d.ts

@@ -2,11 +2,7 @@ import { Stack } from 'aws-cdk-lib';
 import IStackArguments from './IStackArguments';
 import { IConstruct } from "constructs";
 export declare class DeployStack extends Stack {
-    registry: {
-        [t: string]: {
-            [n: string]: any;
-        };
-    };
+    registry: Record<string, Record<string, unknown>>;
     stage: string;
     name: string;
     project: string;
@@ -17,7 +13,7 @@ export declare class DeployStack extends Stack {
     static genStackResourceName(stackName: string, resource: string, stage?: string): string;
     static genStackResourceId(stackName: string, resource: string, stage?: string): string;
     constructor(scope: IConstruct, props: IStackArguments);
-    get(type: string, name: string): any;
-    set(type: string, name: string, instance: any): any;
+    get(type: string, name: string): {} | null;
+    set(type: string, name: string, instance: unknown): unknown;
 }
 export default DeployStack;

package/lib/DeployStack.js

@@ -35,14 +35,13 @@ class DeployStack extends aws_cdk_lib_1.Stack {
             ...props,
             stackName: props.stackName + '-' + stage
         });
-        const stack = this;
-        stack.name = props.stackName || '';
-        stack.stage = stage;
-        stack.project = props.project;
-        stack.tags.setTag('stage', stage);
-        stack.tags.setTag('stack', this.genName('ui-stack'));
-        stack.tags.setTag('project', props.project);
-        stack.tags.setTag('owner', props.owner);
+        this.name = props.stackName || '';
+        this.stage = stage;
+        this.project = props.project;
+        this.tags.setTag('stage', stage);
+        this.tags.setTag('stack', this.genName('ui-stack'));
+        this.tags.setTag('project', props.project);
+        this.tags.setTag('owner', props.owner);
     }
     get(type, name) {
         const items = this.registry[type];

package/lib/NodeJsLambda.d.ts

@@ -2,12 +2,34 @@ import { FunctionOptions } from "aws-cdk-lib/aws-lambda";
 import { DeployStack } from "./DeployStack";
 import { FunctionIntegration } from "./FunctionIntegration";
 import { Duration } from "aws-cdk-lib";
+/**
+ * Interface for the properties of a Node.js function.
+ */
 interface NodeFunctionProps {
+    /**
+     * The properties of the function.
+     */
     funcProps?: FunctionOptions;
+    /**
+     * The timeout duration for the function.
+     */
     timeout?: Duration;
+    /**
+     * The memory size for the function.
+     */
     memory?: number;
 }
+/**
+ * Class representing a Node.js Lambda function.
+ * @extends FunctionIntegration
+ */
 export declare class NodeJsLambda extends FunctionIntegration {
+    /**
+     * Creates a new Node.js Lambda function.
+     * @param {DeployStack} stack - The deployment stack.
+     * @param {string} id - The ID of the function.
+     * @param {NodeFunctionProps} options - The properties of the function.
+     */
     constructor(stack: DeployStack, id: string, options?: NodeFunctionProps);
 }
 export {};

package/lib/NodeJsLambda.js

@@ -8,19 +8,35 @@ const aws_lambda_1 = require("aws-cdk-lib/aws-lambda");
 const FunctionIntegration_1 = require("./FunctionIntegration");
 const build_node_source_1 = require("./methods/build-node-source");
 const duration_1 = __importDefault(require("./methods/duration"));
+/**
+ * Class representing a Node.js Lambda function.
+ * @extends FunctionIntegration
+ */
 class NodeJsLambda extends FunctionIntegration_1.FunctionIntegration {
+    /**
+     * Creates a new Node.js Lambda function.
+     * @param {DeployStack} stack - The deployment stack.
+     * @param {string} id - The ID of the function.
+     * @param {NodeFunctionProps} options - The properties of the function.
+     */
     constructor(stack, id, options) {
         console.log('Defining Node Lambda', id);
+        // Measure the duration of the build process
         const done = (0, duration_1.default)();
-        const { buildDir } = (0, build_node_source_1.buildNodeSource)('lambda', id);
+        // Build the Node.js source code
+        const buildDir = (0, build_node_source_1.buildNodeSource)('lambda', id);
         console.log('Total Build Duration (ms)', done());
+        // Call the parent constructor with the function properties
         super(stack, id, {
             ...options,
             funcProps: {
                 ...options?.funcProps,
+                // The source code of the function
                 code: aws_lambda_1.Code.fromAsset(buildDir),
+                // The handler of the function
                 handler: `${id}.handler`,
-                runtime: aws_lambda_1.Runtime.NODEJS_18_X
+                // The runtime of the function
+                runtime: aws_lambda_1.Runtime.NODEJS_20_X
             }
         });
     }

package/lib/NodeJsLambdaLayer.d.ts

@@ -2,11 +2,24 @@ import { LayerVersion, Runtime } from "aws-cdk-lib/aws-lambda";
 import { DeployStack } from "./DeployStack";
 import { LayerVersionOptions } from "aws-cdk-lib/aws-lambda/lib/layers";
 import { Architecture } from "aws-cdk-lib/aws-lambda/lib/architecture";
+/**
+ * Interface for the properties of the NodeJsLambdaLayer class.
+ */
 interface NodeJsLambdaLayerProps extends LayerVersionOptions {
     readonly compatibleRuntimes?: Runtime[];
     readonly compatibleArchitectures?: Architecture[];
 }
+/**
+ * Class representing a Node.js AWS Lambda layer.
+ * Extends the LayerVersion class from the AWS CDK library.
+ */
 export declare class NodeJsLambdaLayer extends LayerVersion {
+    /**
+     * Constructs a new NodeJsLambdaLayer instance.
+     * @param {DeployStack} stack - The deployment stack.
+     * @param {string} id - The ID of the layer.
+     * @param {NodeJsLambdaLayerProps} props - The properties of the layer.
+     */
     constructor(stack: DeployStack, id: string, props?: NodeJsLambdaLayerProps);
 }
 export {};

package/lib/NodeJsLambdaLayer.js

@@ -7,16 +7,27 @@ exports.NodeJsLambdaLayer = void 0;
 const aws_lambda_1 = require("aws-cdk-lib/aws-lambda");
 const build_node_source_1 = require("./methods/build-node-source");
 const duration_1 = __importDefault(require("./methods/duration"));
+/**
+ * Class representing a Node.js AWS Lambda layer.
+ * Extends the LayerVersion class from the AWS CDK library.
+ */
 class NodeJsLambdaLayer extends aws_lambda_1.LayerVersion {
+    /**
+     * Constructs a new NodeJsLambdaLayer instance.
+     * @param {DeployStack} stack - The deployment stack.
+     * @param {string} id - The ID of the layer.
+     * @param {NodeJsLambdaLayerProps} props - The properties of the layer.
+     */
     constructor(stack, id, props = {}) {
         console.log("Building Lambda Layer", id);
         const done = (0, duration_1.default)();
-        const { buildDir } = (0, build_node_source_1.buildNodeSource)('lambda-layer', id, { dir: 'nodejs' });
+        const buildDir = (0, build_node_source_1.buildNodeSource)('lambda-layer', id, { subdirectory: 'nodejs' });
         console.log('Build Duration (ms)', done());
         super(stack, stack.genId(id), {
+            compatibleRuntimes: [aws_lambda_1.Runtime.NODEJS_20_X],
             ...props,
             layerVersionName: stack.genName(id),
-            code: aws_lambda_1.Code.fromAsset(buildDir)
+            code: aws_lambda_1.Code.fromAsset(buildDir),
         });
         stack.set('lambda-layer', id, this);
     }

package/lib/StaticWebSite.d.ts

@@ -2,16 +2,32 @@
 import { DeployStack } from "./DeployStack";
 import { SourceConfiguration } from "aws-cdk-lib/aws-cloudfront";
 import IDomainConfig from "./IDomainConfig";
-import { IIgnoreOptions } from "./methods/walk-directory";
-interface StaticWebSiteConfig {
+/**
+ * Configuration interface for the StaticWebSite class.
+ */
+export interface StaticWebSiteConfig {
     srcDir?: string;
     domain: IDomainConfig;
     env: NodeJS.ProcessEnv;
-    ignore?: IIgnoreOptions;
     proxy?: SourceConfiguration[];
 }
+/**
+ * Logic which will setup a static web site in AWS with an S3 Bucket, CloudFront Distribution, and Route53 A-Name Record.
+ */
 export declare class StaticWebSite {
+    /**
+     * Constructs a new StaticWebSite instance.
+     * @param {DeployStack} stack - The deployment stack.
+     * @param {string} id - The ID of the website.
+     * @param {StaticWebSiteConfig} props - The configuration properties of the website.
+     */
     constructor(stack: DeployStack, id: string, props: StaticWebSiteConfig);
+    /**
+     * Defines a proxy for the static website.
+     * @param {DeployStack} stack - The deployment stack.
+     * @param {string} domainName - The domain name.
+     * @param {string} pathPattern - The path pattern.
+     * @returns {SourceConfiguration} The source configuration for the proxy.
+     */
     static defineProxy(stack: DeployStack, domainName: string, pathPattern: string): SourceConfiguration;
 }
-export {};

package/lib/StaticWebSite.js

@@ -16,26 +16,26 @@ const aws_route53_1 = require("aws-cdk-lib/aws-route53");
 const aws_route53_targets_1 = require("aws-cdk-lib/aws-route53-targets");
 const duration_1 = __importDefault(require("./methods/duration"));
 const build_node_source_1 = require("./methods/build-node-source");
-const walk_directory_1 = require("./methods/walk-directory");
 const aws_cdk_lib_1 = require("aws-cdk-lib");
+/**
+ * Logic which will setup a static web site in AWS with an S3 Bucket, CloudFront Distribution, and Route53 A-Name Record.
+ */
 class StaticWebSite {
+    /**
+     * Constructs a new StaticWebSite instance.
+     * @param {DeployStack} stack - The deployment stack.
+     * @param {string} id - The ID of the website.
+     * @param {StaticWebSiteConfig} props - The configuration properties of the website.
+     */
     constructor(stack, id, props) {
         console.log('Deploying Static Web Site', id);
         const done = (0, duration_1.default)();
-        const childrenExcluded = props.ignore?.childrenExcluded || walk_directory_1.no;
-        const { buildDir, moduleChanged } = (0, build_node_source_1.buildNodeSource)('web', id, {
-            ignore: {
-                ...props.ignore,
-                childrenExcluded: stat => stat.name === 'out' || childrenExcluded(stat)
-            }
+        const buildDir = (0, build_node_source_1.buildNodeSource)('web', id);
+        console.log('Building UI Source', id);
+        (0, child_process_1.execSync)('npm run export', {
+            cwd: buildDir,
+            env: props.env
         });
-        if (moduleChanged) {
-            console.log('Building UI Source', id);
-            (0, child_process_1.execSync)('npm run export', {
-                cwd: buildDir,
-                env: props.env
-            });
-        }
         console.log('Total Build Duration (ms)', done());
         const exportDir = buildDir + '/out';
         console.log('Creating HTTPS Certificate', id + '-certificate');
@@ -46,7 +46,14 @@ class StaticWebSite {
             websiteIndexDocument: "index.html",
             websiteErrorDocument: "error.html",
             removalPolicy: core_1.RemovalPolicy.DESTROY,
-            autoDeleteObjects: true
+            autoDeleteObjects: true,
+            publicReadAccess: false,
+            blockPublicAccess: {
+                blockPublicAcls: true,
+                blockPublicPolicy: true,
+                ignorePublicAcls: true,
+                restrictPublicBuckets: true
+            }
         });
         new Output_1.Output(stack, `${id}-content-bucket`, s3BucketSource.bucketName);
         const cloudFrontPolicy = new aws_iam_1.PolicyStatement({
@@ -86,6 +93,13 @@ class StaticWebSite {
             target: aws_route53_1.RecordTarget.fromAlias(new aws_route53_targets_1.CloudFrontTarget(distro))
         });
     }
+    /**
+     * Defines a proxy for the static website.
+     * @param {DeployStack} stack - The deployment stack.
+     * @param {string} domainName - The domain name.
+     * @param {string} pathPattern - The path pattern.
+     * @returns {SourceConfiguration} The source configuration for the proxy.
+     */
     static defineProxy(stack, domainName, pathPattern) {
         return {
             customOriginSource: {

package/lib/methods/BuildOptions.d.ts

@@ -0,0 +1,3 @@
+export interface BuildOptions {
+    subdirectory?: string;
+}

package/lib/methods/BuildOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/methods/build-ecmascript.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Builds ECMAScript files.
+ * Copies the files from the source directory to the build directory and installs the necessary node modules.
+ * @function buildEcmascript
+ * @param {string[]} files - The files to build.
+ * @param {string} srcDir - The source directory.
+ * @param {string} buildDir - The build directory.
+ */
+export declare function buildEcmascript(files: string[], srcDir: string, buildDir: string): void;

package/lib/methods/build-ecmascript.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildEcmascript = void 0;
+const copy_files_1 = require("./copy-files");
+const install_node_modules_1 = require("./install-node-modules");
+/**
+ * Builds ECMAScript files.
+ * Copies the files from the source directory to the build directory and installs the necessary node modules.
+ * @function buildEcmascript
+ * @param {string[]} files - The files to build.
+ * @param {string} srcDir - The source directory.
+ * @param {string} buildDir - The build directory.
+ */
+function buildEcmascript(files, srcDir, buildDir) {
+    // Copies the files from the source directory to the build directory
+    (0, copy_files_1.copyFiles)(files, srcDir, buildDir);
+    // Installs the necessary node modules
+    (0, install_node_modules_1.installNodeModules)(buildDir, ['dev', 'optional', 'peer']);
+}
+exports.buildEcmascript = buildEcmascript;

package/lib/methods/build-node-source.d.ts

@@ -1,13 +1,10 @@
-import { IIgnoreOptions } from "./walk-directory";
-export declare const defaultIgnore: IIgnoreOptions;
-interface IBuildOptions {
-    dir?: string;
-    ignore?: IIgnoreOptions;
-}
-export declare function buildNodeSource(type: string, id: string, options?: IBuildOptions): {
-    buildDir: string;
-    moduleChanged: boolean;
-    packageChanged: boolean;
-    sourceChanged: boolean;
-};
-export {};
+import { BuildOptions } from "./BuildOptions";
+/**
+ * Builds the source code for a Node.js project.
+ * @function buildNodeSource
+ * @param {string} type - The type of the source code.
+ * @param {string} id - The ID of the source code.
+ * @param {BuildOptions} [options] - Options for building the source code.
+ * @returns - The build directory containing the resulting source code
+ */
+export declare function buildNodeSource(type: string, id: string, options?: BuildOptions): string;

package/lib/methods/build-node-source.js

@@ -1,105 +1,39 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildNodeSource = exports.defaultIgnore = void 0;
-const path = __importStar(require("path"));
-const fse = __importStar(require("fs-extra"));
-const fs = __importStar(require("fs"));
-const child_process_1 = require("child_process");
-const generate_hash_1 = require("./generate-hash");
+exports.buildNodeSource = void 0;
+const fs_extra_1 = require("fs-extra");
 const get_source_directory_1 = require("./get-source-directory");
+const get_files_1 = require("./get-files");
+const generate_hash_1 = require("./generate-hash");
 const duration_1 = __importDefault(require("./duration"));
-const empty_directory_1 = __importDefault(require("./empty-directory"));
-const distributionRoot = path.resolve(process.cwd(), "../dist");
-const hashRoot = path.join(distributionRoot, "hash");
-fse.ensureDirSync(hashRoot);
-exports.defaultIgnore = {
-    included: (p) => {
-        return !p.name.startsWith(".") &&
-            !p.name.endsWith(".md") &&
-            !p.name.includes(".test.") &&
-            p.name !== 'package-lock.json';
-    },
-    childrenIncluded: (p) => {
-        return p.name !== "node_modules";
-    }
-};
-function buildNodeSource(type, id, options = {}) {
-    const { dir = '' } = options;
-    const ignore = {
-        ...exports.defaultIgnore, ...options.ignore
-    };
-    const srcDir = (0, get_source_directory_1.getSourceDirectory)(type, id);
-    const buildDir = (0, get_source_directory_1.getBuildDirectory)(type, id);
-    const hashFilePath = path.join(hashRoot, `${type}-${id}-hash.txt`);
-    const folderExists = fs.existsSync(buildDir);
-    const hashFileExists = folderExists && fse.existsSync(hashFilePath);
-    const prevHash = (hashFileExists ? fse.readJsonSync(hashFilePath) : {});
-    const hash = (0, generate_hash_1.generateHash)(srcDir, { ignore });
-    const nextHash = JSON.parse((0, generate_hash_1.generateHash)(srcDir, { ignore }));
-    const moduleChanged = JSON.stringify(prevHash, null, '\t') !== hash;
-    let packageChanged = false, sourceChanged = false;
-    if (moduleChanged) {
-        const prevPackageHash = findPackageHash(prevHash);
-        const packageHash = findPackageHash(nextHash);
-        packageChanged = prevPackageHash !== packageHash;
-        sourceChanged = sourceWasUpdated(prevHash, nextHash);
-        if (sourceChanged) {
-            const rmComplete = (0, duration_1.default)();
-            if (folderExists)
-                (0, empty_directory_1.default)(buildDir, { childrenExcluded: folder => folder.name === 'node_modules' });
-            console.log('Cleanup Duration (ms)', rmComplete());
-            const copyComplete = (0, duration_1.default)();
-            fse.copySync(srcDir, buildDir, {
-                filter: src => !~src.indexOf("node_modules") && !src.endsWith('.test.js')
-            });
-            console.log('Copy Duration (ms)', copyComplete());
-        }
-        if (packageChanged) {
-            const installComplete = (0, duration_1.default)();
-            (0, child_process_1.execSync)("npm i --omit=dev --omit=optional --omit=peer --quite", {
-                cwd: dir ? path.resolve(buildDir, dir) : buildDir
-            });
-            console.log('NPM Install Duration (ms)', installComplete());
-        }
-        fs.writeFileSync(hashFilePath, hash);
-    }
-    return { buildDir, packageChanged, sourceChanged, moduleChanged };
+const build_ecmascript_1 = require("./build-ecmascript");
+const build_typescript_1 = require("./build-typescript");
+const hash_file_1 = require("./hash-file");
+/**
+ * Builds the source code for a Node.js project.
+ * @function buildNodeSource
+ * @param {string} type - The type of the source code.
+ * @param {string} id - The ID of the source code.
+ * @param {BuildOptions} [options] - Options for building the source code.
+ * @returns - The build directory containing the resulting source code
+ */
+function buildNodeSource(type, id, options) {
+    const srcDir = (0, get_source_directory_1.getSourceDirectory)(type, id, options?.subdirectory);
+    const buildDir = (0, get_source_directory_1.getBuildDirectory)(type, id, options?.subdirectory);
+    const files = (0, get_files_1.getFiles)(srcDir);
+    const hash = (0, generate_hash_1.generateHash)(files);
+    if ((0, hash_file_1.getStoredHash)(type, id) === hash)
+        return buildDir;
+    const rmComplete = (0, duration_1.default)();
+    if ((0, fs_extra_1.existsSync)(buildDir))
+        (0, fs_extra_1.emptyDirSync)(buildDir);
+    console.log('Cleanup Duration (ms)', rmComplete());
+    const isTypeScript = !!files.find(file => file.endsWith('tsconfig.json'));
+    isTypeScript ? (0, build_typescript_1.buildTypescript)(srcDir, buildDir) : (0, build_ecmascript_1.buildEcmascript)(files, srcDir, buildDir);
+    (0, hash_file_1.storeHash)(type, id, hash);
+    return buildDir;
 }
 exports.buildNodeSource = buildNodeSource;
-function findPackageHash(hash) {
-    return hash?.children?.find(file => file.name === 'package.json')?.hash;
-}
-function sourceWasUpdated(prevHash, nextHash) {
-    const fileCountChanged = prevHash.children?.length != nextHash.children?.length;
-    const updatedItem = prevHash.children?.find(prevFile => {
-        const nextFile = nextHash.children?.find(f => f.name = prevFile.name);
-        return prevFile.name !== 'package.json' && (!nextFile || nextFile.hash !== prevFile.hash);
-    });
-    return fileCountChanged || !!updatedItem;
-}

package/lib/methods/build-typescript.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Builds TypeScript source code.
+ * Ensures the build directory exists, installs necessary node modules, and compiles the TypeScript code.
+ * @function buildTypescript
+ * @param {string} srcDir - The source directory containing the TypeScript code.
+ * @param {string} buildDir - The output directory for the compiled JavaScript code.
+ */
+export declare function buildTypescript(srcDir: string, buildDir: string): void;

package/lib/methods/build-typescript.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildTypescript = void 0;
+const child_process_1 = require("child_process");
+const duration_1 = __importDefault(require("./duration"));
+const fs_extra_1 = require("fs-extra");
+const install_node_modules_1 = require("./install-node-modules");
+/**
+ * Builds TypeScript source code.
+ * Ensures the build directory exists, installs necessary node modules, and compiles the TypeScript code.
+ * @function buildTypescript
+ * @param {string} srcDir - The source directory containing the TypeScript code.
+ * @param {string} buildDir - The output directory for the compiled JavaScript code.
+ */
+function buildTypescript(srcDir, buildDir) {
+    // Ensure the build directory exists
+    (0, fs_extra_1.ensureDirSync)(buildDir);
+    // Install necessary node modules
+    (0, install_node_modules_1.installNodeModules)(srcDir);
+    // Measure the duration of the build process
+    const done = (0, duration_1.default)();
+    // Compile the TypeScript code
+    (0, child_process_1.execSync)(`npm run build -- --outDir ${buildDir}`, {
+        cwd: srcDir,
+        stdio: 'inherit'
+    });
+    // Log the duration of the build process
+    console.log('NPM Install Duration (ms)', done());
+}
+exports.buildTypescript = buildTypescript;

package/lib/methods/copy-files.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copies files from the source directory to the build directory.
+ * @function copyFiles
+ * @param {string[]} files - The files to copy.
+ * @param {string} srcDir - The source directory.
+ * @param {string} buildDir - The build directory.
+ */
+export declare function copyFiles(files: string[], srcDir: string, buildDir: string): void;