@hdriel/aws-utils 1.3.4 → 1.3.6

package/README.md

@@ -1,3 +1,82 @@
+# AWS UTILS: S3, LAMBDA SNS, IAM
+
+## Quick Start
+
+First load this file somewhere on starting server
+```typescript 
+// aws-utils-config.ts
+import env from './dotenv.ts';
+import { AWSConfigSharingUtil } from '@hdriel/aws-utils';
+
+AWSConfigSharingUtil.setConfig({
+    accessKeyId: env?.AWS_ACCESS_KEY_ID,
+    secretAccessKey: env?.AWS_SECRET_ACCESS_KEY,
+    region: env?.AWS_REGION,
+    endpoint: env?.AWS_ENDPOINT,
+});
+
+// console.log('AWSConfigSharingUtil configuration');
+// console.table(AWSConfigSharingUtil.getConfig());
+
+```
+on your server files:
+```typescript
+import './aws-utils-config';
+...
+```
+
+then write your code...
+
+# Lambda Utility usage
+
+create your lambda by calling to LambdaUtil with generic type param and serviceFunctionName then usage any place your project
+
+```typescript
+export const lambdaUtilTelegram = new LambdaUtil<TELEGRAM_REQUEST_PARAMS>({
+    serviceFunctionName: 'serverless-telegram-dev-directInvokeSendTextNTF',
+    logger,
+});
+
+...
+
+
+await lambdaUtilTelegram
+    .triggerLambdaEvent({ 
+        chatId: userData.telegramId, 
+        body: `Just Like That! - Login code:\n${code}`
+    }).catch(console.error)
+
+```
+
+lambda functionality: 
+```typescript
+lambdaUtilInstance.runLambdaInDryRunMode(payload?: T): Promise<LambdaPayloadResponse>;
+lambdaUtilInstance.triggerLambdaEvent(payload?: T): Promise<LambdaPayloadResponse>;
+lambdaUtilInstance.runAndGetLambdaResponse(payload?: T): Promise<LambdaPayloadResponse>;
+```
+
+# SNS Utility usage
+
+create your SNS by calling to SnsUtil with generic type param and topicArn then usage any place your project
+
+```typescript
+export const snsUserCreatedTopic = new SnsUtil<REQUEST_PARAMS>({
+    topicArn: 'user-created',
+    logger,
+});
+
+...
+
+
+await snsUserCreatedTopic
+    .publishMessage({ 
+        userId: 'abc',
+        username: `Hadriel Benjo`
+    }).catch(console.error)
+
+```
+
+
 # S3 Utility Package
 
 A powerful, type-safe wrapper around AWS S3 SDK v3 that simplifies S3 operations with advanced features like streaming, file uploads, directory management, and LocalStack support.
@@ -18,7 +97,7 @@ A powerful, type-safe wrapper around AWS S3 SDK v3 that simplifies S3 operations
 
 # FULL DEMO PROJECT EXAMPLE:
 please see this project code before using: [aws-utils-demo github link!](https://github.com/hdriel/aws-utils-demo)
-![Main Screen - Preview](https://cdn.jsdelivr.net/gh/hdriel/aws-utils-demo/readme-assets/demo-bucket-image-preview.webp)
+[![Watch the video](https://cdn.jsdelivr.net/gh/hdriel/aws-utils-demo/readme-assets/demo-bucket-image-preview.webp)](https://youtu.be/5DRV6ACq9jU)
 
 
 ## Installation
@@ -27,31 +106,7 @@ please see this project code before using: [aws-utils-demo github link!](https:/
   npm install @hdriel/aws-utils
 ```
 
-## Quick Start
-
-First load this file somewhere on starting server
-```typescript 
-// aws-utils-config.ts
-import env from './dotenv.ts';
-import { AWSConfigSharingUtil } from '@hdriel/aws-utils';
-
-AWSConfigSharingUtil.setConfig({
-    accessKeyId: env?.AWS_ACCESS_KEY_ID,
-    secretAccessKey: env?.AWS_SECRET_ACCESS_KEY,
-    region: env?.AWS_REGION,
-    endpoint: env?.AWS_ENDPOINT,
-});
-
-// console.log('AWSConfigSharingUtil configuration');
-// console.table(AWSConfigSharingUtil.getConfig());
-```
-on your server files: 
-```typescript
-import './aws-utils-config';
-...
-```
 
-then write your code... 
 
 for example:
 
@@ -645,6 +700,13 @@ services:
     - app-network
 ```
 
+# FULL LOCALSTACK DEMO:
+please see this project code before using: [aws-utils-demo github link!](https://github.com/hdriel/aws-utils-demo)
+
+Click the image to watch localstack video
+[![Watch the video](https://cdn.jsdelivr.net/gh/hdriel/aws-utils-demo/readme-assets/localstack-login.webp)](https://youtu.be/5DRV6ACq9jU)
+
+
 ## 🔧 Advanced Usage
 
 ### Dynamic Bucket Switching
@@ -681,7 +743,7 @@ The utility includes optimized HTTP/HTTPS agents:
 ## 📋 Complete Express.js Example
 # FULL DEMO PROJECT EXAMPLE:
 please see this project code before using: [aws-utils-demo github link!](https://github.com/hdriel/aws-utils-demo)
-![Main Screen - Preview](https://cdn.jsdelivr.net/gh/hdriel/aws-utils-demo/readme-assets/demo-bucket-image-preview.webp)
+[![Watch the video](https://cdn.jsdelivr.net/gh/hdriel/aws-utils-demo/readme-assets/demo-bucket-image-preview.webp)](https://youtu.be/5DRV6ACq9jU)
 
 
 ## 📝 TypeScript Support

package/dist/index.d.cts

@@ -70,7 +70,7 @@ declare class LambdaEvents<T> extends LambdaBase {
         invocationType?: InvocationType;
     }): Promise<LambdaPayloadResponse>;
     runLambdaInDryRunMode(payload?: T): Promise<LambdaPayloadResponse>;
-    triggerLambdaEvent<T>(payload?: T): Promise<LambdaPayloadResponse>;
+    triggerLambdaEvent(payload?: T): Promise<LambdaPayloadResponse>;
     runAndGetLambdaResponse(payload?: T): Promise<LambdaPayloadResponse>;
 }
 

package/dist/index.d.ts

@@ -70,7 +70,7 @@ declare class LambdaEvents<T> extends LambdaBase {
         invocationType?: InvocationType;
     }): Promise<LambdaPayloadResponse>;
     runLambdaInDryRunMode(payload?: T): Promise<LambdaPayloadResponse>;
-    triggerLambdaEvent<T>(payload?: T): Promise<LambdaPayloadResponse>;
+    triggerLambdaEvent(payload?: T): Promise<LambdaPayloadResponse>;
     runAndGetLambdaResponse(payload?: T): Promise<LambdaPayloadResponse>;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hdriel/aws-utils",
-  "version": "1.3.4",
+  "version": "1.3.6",
   "description": "Simplified AWS SDK (v3) utilities for S3 (upload, download, streaming) with TypeScript support",
   "author": "Hadriel Benjo (https://github.com/hdriel)",
   "type": "module",