aws-service-stack 0.18.325 → 0.18.326

package/README.md

@@ -49,7 +49,7 @@ npm install aws-service-stack
 This package requires the following AWS SDK v3 packages as peer dependencies:
 
 ```bash
-npm install 
+npm install
 @aws-sdk/client-dynamodb
 @aws-sdk/client-cognito-identity-provider
 @aws-sdk/client-secrets-manager
@@ -84,7 +84,6 @@ export class ProductControllerApi extends ControllerApi<Product, ProductService>
     }
   }
 }
-
 ```
 
 ### 2. Entity Configuration
@@ -138,7 +137,6 @@ export class ProductConfig extends EntityConfigImpl {
 
 // Export default Product configuration
 export const CONFIG_PRODUCT = new ProductConfig();
-
 ```
 
 ### 3. Repository Definition - DynamoDB
@@ -151,8 +149,7 @@ import { ProductRepoDB } from "./product-repo-db.interface";
 import "./product-repo-db";
 
 @Service("ProductRepoDB")
-export class ProductRepoDBImpl extends BaseRepoDBImpl<Product> implements ProductRepoDB {
-}
+export class ProductRepoDBImpl extends BaseRepoDBImpl<Product> implements ProductRepoDB {}
 
 /** additional custom repo methode for dynamodb integration**/
 //...
@@ -168,8 +165,7 @@ import { ProductRepoES } from "./product-repo-es.interface";
 import "./product-repo-es";
 
 @Service("ProductRepoES")
-export class ProductRepoESImpl extends BaseRepoESImpl<Product> implements ProductRepoES {
-}
+export class ProductRepoESImpl extends BaseRepoESImpl<Product> implements ProductRepoES {}
 
 /** additional custom repo methode for openSearch integration**/
 //...
@@ -189,14 +185,16 @@ import { CrudServiceImpl } from "@chinggis/core";
 import { Product } from "../model-shared/example.model";
 
 @Service("ProfileService")
-export class ProductServiceImpl extends CrudServiceImpl<Product, ProductRepoDB, ProductRepoES> implements ProductService {
+export class ProductServiceImpl
+  extends CrudServiceImpl<Product, ProductRepoDB, ProductRepoES>
+  implements ProductService
+{
   constructor() {
     super(Container.get("ProductRepoDB"), Container.get("ProductRepoES"));
   }
 
   /** Custom service methode **/
   //...
-
 }
 ```
 
@@ -211,6 +209,7 @@ POST    /products               # Insert new product (create)
 GET     /products/{id}          # Get single product by ID
 GET     /products               # List products via DynamoDB Query (by categoryId, ProductId, status, …)
 GET     /products/search        # Search products via OpenSearch (full-text, sort, pagination)
+GET     /products/search/query  # Search Query products via OpenSearch (aggregations, multi-filters, full-text, sort, pagination)
 GET     /products/scan          # Scan all products (Admin only, expensive in DynamoDB)
 PUT     /products/{id}          # Update full product (replace all fields)
 PATCH   /products/{id}          # Update partial product (only specific fields)
@@ -233,10 +232,50 @@ dynamoDB:   .../products/?category=Toys&color=red&age_from=5&age_to=8&size=50&la
 - **[customFieldName]**=[matchValue]
 - **size**=20
 - **page**=3 or **lastKey**=...
-- **[dateOrNumberFieldName]_from**=[Value]
-- **[dateOrNumberFieldName]_to**=[Value]
-- **begin_[dateOrNumberFieldName]**=[Value]
-- **end_[dateOrNumberFieldName]**=[Value]
+- **[dateOrNumberFieldName]\_from**=[Value]
+- **[dateOrNumberFieldName]\_to**=[Value]
+- **begin\_[dateOrNumberFieldName]**=[Value]
+- **end\_[dateOrNumberFieldName]**=[Value]
+
+### **OpenSearch V2 List Operation - URL Filter**
+
+multi-filter, aggregations, search keyword, multi-sort
+
+```
+openSearch v2: .../products/search/query?category__eq=Toys&color__in=red,yellow&age__gte=5&age__lte=8&page=5&size=50&agg__terms=status&agg__terms__sub=customerId
+```
+
+- **field\_\_in**=red,yellow
+- **field\_\_eq**=Toys
+- **field\_\_gte**=5
+- **field\_\_lte**=8
+- **field\_\_ne**=Book
+- **field\_\_exists**=true
+- **field\_\_exists**=false
+- **field\_\_regex**=^Foo.\*
+
+- **agg\_\_terms**=status
+- **agg\_\_terms\_\_sub**=customerId
+- **agg\_\_sum**=price
+- **agg\_\_avg**=price
+- **agg\_\_min**=price
+- **agg\_\_max**=price
+
+- **search**=marvel
+- **searchFields**=name,manufacture,description
+- **searchOperator**=or
+- **searchOperator**=and
+
+- **sort**=desc,asc
+- **sortField**=price,category
+
+- **color\_\_in**=red,yellow
+- **category\_\_eq**=Toys
+- **status\_\_exists**=true
+- **age\_\_gte**=5
+- **age\_\_lte**=8
+- **size**=20
+- **page**=3
 
 ### **Advanced Features**
 
@@ -372,12 +411,12 @@ functions:
 ### AWS CDK
 
 ```typescript
-import { Function, Runtime } from 'aws-cdk-lib/aws-lambda';
+import { Function, Runtime } from "aws-cdk-lib/aws-lambda";
 
-new Function(this, 'MyFunction', {
+new Function(this, "MyFunction", {
   runtime: Runtime.NODEJS_18_X,
-  handler: 'dist/handler.handler',
-  code: Code.fromAsset('dist')
+  handler: "dist/handler.handler",
+  code: Code.fromAsset("dist"),
 });
 ```
 
@@ -422,4 +461,4 @@ Built by [Chinggis Systems](https://chinggis.systems) - Enterprise software solu
 
 ---
 
-**Made with ❤️ for the AWS community**
+**Made with ❤️ for the AWS community**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aws-service-stack",
-  "version": "0.18.325",
+  "version": "0.18.326",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "chinggis.systems",