@bifravst/aws-cdk-lambda-helpers 3.0.0 → 3.0.1

package/dist/src/IoTActionRole.d.ts

@@ -0,0 +1,10 @@
+import { aws_iam as IAM } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+/**
+ * Base role for IoT Actions that allows to publish to the 'errors' topic
+ */
+export declare class IoTActionRole extends Construct {
+    readonly role: IAM.IRole;
+    readonly roleArn: string;
+    constructor(parent: Construct);
+}

package/dist/src/LambdaLogGroup.d.ts

@@ -0,0 +1,6 @@
+import { aws_logs as Logs } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+export declare class LambdaLogGroup extends Construct {
+    readonly logGroup: Logs.LogGroup;
+    constructor(parent: Construct, id: string, retention?: Logs.RetentionDays);
+}

package/dist/src/LambdaSource.d.ts

@@ -0,0 +1,7 @@
+import { aws_lambda as Lambda } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+import type { PackedLambda } from './packLambda.ts';
+export declare class LambdaSource extends Construct {
+    readonly code: Lambda.S3Code;
+    constructor(parent: Construct, packedLambda: Pick<PackedLambda, 'zipFilePath' | 'id' | 'hash'>);
+}

package/dist/src/PackedLambdaFn.d.ts

@@ -0,0 +1,24 @@
+import { aws_lambda as Lambda, type aws_logs as Logs } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+import type { PackedLambda } from './packLambda.ts';
+/**
+ * Creates a Lambda function with useful defaults:
+ *
+ * - Code from a PackedLambda
+ * - Architecture: ARM64
+ * - Runtime: Node.js 20
+ * - timeout: 5 seconds
+ * - memorySize: 1792 MB
+ * - environment
+ *   VERSION: set from the 'version' context
+ *   NODE_NO_WARNINGS: disabled to get rid of Node.js warnings in the logs
+ *   STACK_NAME: the current stack name
+ *   DISABLE_METRICS: set to '1' of 'isTest'===true in the context
+ * - a LambdaLogGroup (if not provided)
+ * - policies that allow to access all SSM parameters below the current stack name
+ */
+export declare class PackedLambdaFn extends Construct {
+    readonly fn: Lambda.Function;
+    readonly logGroup: Logs.ILogGroup;
+    constructor(parent: Construct, id: string, source: PackedLambda, props: Partial<Omit<Lambda.FunctionProps, 'code' | 'handler'>>);
+}

package/dist/src/cdk.d.ts

@@ -0,0 +1,4 @@
+export * from './IoTActionRole.ts';
+export * from './LambdaLogGroup.ts';
+export * from './LambdaSource.ts';
+export * from './PackedLambdaFn.ts';

package/dist/src/checkSumOfFiles.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/checksumOfFiles.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Computes the combined checksum of the given files
+ */
+export declare const checkSumOfFiles: (files: string[]) => Promise<string>;
+export declare const checkSumOfStrings: (strings: string[]) => string;

package/dist/src/commonParent.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns the common ancestor directory from a list of files
+ */
+export declare const commonParent: (files: string[]) => string;

package/dist/src/commonParent.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/findDependencies.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Resolve project-level dependencies for the given file using TypeScript compiler API
+ */
+export declare const findDependencies: (args: {
+    sourceFilePath: string;
+    imports?: string[];
+    visited?: string[];
+    packages?: Set<string>;
+    tsConfigFilePath?: string;
+    importsSubpathPatterns?: Record<string, string>;
+}) => {
+    dependencies: string[];
+    /**
+     * A map of import subpath patterns to their resolved paths
+     * @see https://nodejs.org/api/packages.html#subpath-patterns
+     */
+    importsSubpathPatterns: Record<string, string>;
+    /**
+     * The external packages that the source file depends on
+     */
+    packages: Set<string>;
+};

package/dist/src/findDependencies.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/isTest.d.ts

@@ -0,0 +1,2 @@
+import type { Construct } from 'constructs';
+export declare const isTest: (construct: Construct) => boolean;

package/dist/src/isTest.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/lambda.d.ts

@@ -0,0 +1,2 @@
+export * from './packLambda.ts';
+export * from './packLambdaFromPath.ts';

package/dist/src/layer.d.ts

@@ -0,0 +1 @@
+export * from './packLayer.ts';

package/dist/src/module-folder-named-like-handler-bug.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/packLambda.d.ts

@@ -0,0 +1,29 @@
+export type PackedLambda = {
+    id: string;
+    zipFilePath: string;
+    handler: string;
+    hash: string;
+};
+/**
+ * In the bundle we only include code that's not in the layer.
+ */
+export declare const packLambda: ({ sourceFilePath, zipFilePath, tsConfigFilePath, debug, progress, }: {
+    sourceFilePath: string;
+    zipFilePath: string;
+    /**
+     * Pass the path to the tsconfig.json file if you want to use paths from the tsconfig.json file.
+     */
+    tsConfigFilePath?: string;
+    debug?: (label: string, info: string) => void;
+    progress?: (label: string, info: string) => void;
+}) => Promise<{
+    handler: string;
+    hash: string;
+}>;
+/**
+ * @see https://github.com/aws/aws-lambda-nodejs-runtime-interface-client/issues/93#issuecomment-2042201321
+ */
+export declare class ImportFromFolderNameError extends Error {
+    readonly folderName: string;
+    constructor(folderName: string);
+}

package/dist/src/packLambda.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/packLambdaFromPath.d.ts

@@ -0,0 +1,20 @@
+import { type PackedLambda } from './packLambda.ts';
+export declare const packLambdaFromPath: ({ id, sourceFilePath, handlerFunction: handlerFunctionArg, baseDir: baseDirArg, distDir: distDirArg, tsConfigFilePath, debug, progress, }: {
+    id: string;
+    sourceFilePath: string;
+    handlerFunction?: string;
+    /**
+     * @default process.cwd()
+     */
+    baseDir?: string;
+    /**
+     * @default ${baseDir}/dist/lambdas
+     */
+    distDir?: string;
+    /**
+     * Pass the path to the tsconfig.json file if you want to use paths from the tsconfig.json file.
+     */
+    tsConfigFilePath?: string;
+    debug?: (label: string, info: string) => void;
+    progress?: (label: string, info: string) => void;
+}) => Promise<PackedLambda>;

package/dist/src/packLayer.d.ts

@@ -0,0 +1,23 @@
+export type PackedLayer = {
+    layerZipFilePath: string;
+    hash: string;
+};
+export declare const packLayer: ({ id, dependencies, baseDir, distDir, installCommand, }: {
+    id: string;
+    dependencies: string[];
+    /**
+     * @default process.cwd()
+     */
+    baseDir?: string;
+    /**
+     * @default ${baseDir}/dist/layers
+     */
+    distDir?: string;
+    /**
+     * Returns the command to run, the first element is the command (e.g. `npm`) and the rest are its arguments.
+     */
+    installCommand?: (args: {
+        packageFilePath: string;
+        packageLockFilePath: string;
+    }) => [string, ...Array<string>];
+}) => Promise<PackedLayer>;

package/dist/src/test/getFileFromZip.d.ts

@@ -0,0 +1 @@
+export declare const getFileFromZip: (zipFilePath: string, filename: string) => Promise<string>;

package/dist/src/updateImports.d.ts

@@ -0,0 +1 @@
+export declare const updateImports: (source: string) => string;

package/dist/src/updateImports.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/util.d.ts

@@ -0,0 +1,4 @@
+export * from './checksumOfFiles.ts';
+export * from './commonParent.ts';
+export * from './findDependencies.ts';
+export * from './isTest.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bifravst/aws-cdk-lambda-helpers",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Helper functions which simplify working with TypeScript lambdas for AWS CDK.",
   "exports": {
     ".": {
@@ -33,7 +33,7 @@
     "test": "node --experimental-strip-types --no-warnings --test ./src/*.spec.ts",
     "test:e2e": "node --experimental-strip-types --test e2e.spec.ts",
     "prepare": "husky",
-    "prepublishOnly": "node --experimental-strip-types npm-compile.ts"
+    "prepublishOnly": "node --experimental-strip-types npm-compile.ts && npx tsc -P tsconfig.npm.json --outDir ./dist/src"
   },
   "repository": {
     "type": "git",