@aws-lite/lambda-types 0.0.0

package/index.d.ts

@@ -0,0 +1,45 @@
+import {
+  /* ! Do not remove IMPORTS_START / IMPORTS_END ! */
+  // $IMPORTS_START
+  CreateFunctionCommandOutput as CreateFunctionResponse,
+  GetFunctionConfigurationCommandOutput as GetFunctionConfigurationResponse,
+  InvokeCommandOutput as InvokeResponse,
+  UpdateFunctionConfigurationCommandOutput as UpdateFunctionConfigurationResponse,
+  // $IMPORTS_END
+} from "@aws-sdk/client-lambda";
+
+declare interface AwsLiteLambda {
+  /* ! Do not remove METHODS_START / METHODS_END ! */
+  // $METHODS_START
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html Lambda: CreateFunction}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/lambda/readme.md#CreateFunction Lambda: CreateFunction}
+   */
+  CreateFunction: (input: { Code: Record<string, any>, FunctionName: string, Role: string, Architectures?: any[], CodeSigningConfigArn?: string, DeadLetterConfig?: Record<string, any>, Description?: string, Environment?: Record<string, any>, EphemeralStorage?: Record<string, any>, FileSystemConfigs?: any[], Handler?: string, ImageConfig?: Record<string, any>, KMSKeyArn?: string, Layers?: any[], MemorySize?: number, PackageType?: string, Publish?: boolean, Runtime?: string, SnapStart?: Record<string, any>, Tags?: any[], Timeout?: number, TracingConfig?: Record<string, any>, VpcConfig?: Record<string, any> }) => Promise<CreateFunctionResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html Lambda: GetFunctionConfiguration}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/lambda/readme.md#GetFunctionConfiguration Lambda: GetFunctionConfiguration}
+   */
+  GetFunctionConfiguration: (input: { FunctionName: string, Qualifier?: string }) => Promise<GetFunctionConfigurationResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html Lambda: Invoke}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/lambda/readme.md#Invoke Lambda: Invoke}
+   */
+  Invoke: (input: { FunctionName: string, InvocationType?: string, Payload: array,object, LogType?: string, ClientContext?: string, Qualifier?: string }) => Promise<InvokeResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/lambda/latest/dg/API_UpdateFunctionConfiguration.html Lambda: UpdateFunctionConfiguration}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/lambda/readme.md#UpdateFunctionConfiguration Lambda: UpdateFunctionConfiguration}
+   */
+  UpdateFunctionConfiguration: (input: { FunctionName: string, DeadLetterConfig?: Record<string, any>, Description?: string, Environment?: Record<string, any>, EphemeralStorage?: Record<string, any>, FileSystemConfigs?: any[], Handler?: string, ImageConfig?: Record<string, any>, KMSKeyArn?: string, Layers?: any[], MemorySize?: number, RevisionId?: string, Role?: string, Runtime?: string, SnapStart?: Record<string, any>, Timeout?: number, TracingConfig?: Record<string, any>, VpcConfig?: Record<string, any> }) => Promise<UpdateFunctionConfigurationResponse>
+  // $METHODS_END
+}
+
+declare module "@aws-lite/client" {
+  interface AwsLiteClient {
+    Lambda: AwsLiteLambda;
+  }
+}

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@aws-lite/lambda-types",
+  "description": "Type definitions for the @aws-lite/lambda plugin",
+  "version": "0.0.0",
+  "main": "",
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts"
+  ],
+  "dependencies": {
+    "@aws-sdk/client-lambda": "3"
+  }
+}

package/readme.md

@@ -0,0 +1,46 @@
+## Install
+
+Add to `devDependencies` in `package.json`:
+
+```
+npm i -D @aws-lite/lambda-types
+```
+
+<small>Be sure you also have `@aws-lite/lambda` installed.</small>
+
+## Usage and Config
+
+### Javascript VSCode Intellisense
+
+In a Javascript project, the ambient types will be automatically loaded.
+
+### TypeScript `tsconfig`
+
+#### Add this package to `compilerOptions.types`
+
+Example:
+
+```json
+{
+  "extends": "@tsconfig/node-lts/tsconfig.json",
+  "compilerOptions": {
+    "types": [
+      "@aws-lite/lambda-types"
+    ]
+  }
+}
+```
+
+#### Or use reference types
+
+Either in individual files or in an `index.d.ts` file.
+
+```ts
+/// <reference types="@aws-lite/lambda-types" />
+```
+
+ymmv
+
+```ts
+/// <reference path="./node_modules/@aws-lite/lambda-types/index.d.ts" />
+```