@webiny/api-opensearch-aws 0.0.0-unstable.0156a4c312

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+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,11 @@
+# @webiny/api-opensearch-aws
+
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
+
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
+
+---
+
+_This README file is automatically generated during the publish process._

package/createAwsOpenSearchClient.d.ts

@@ -0,0 +1,2 @@
+import { type OpenSearchClientOptions, type Client } from "@webiny/api-opensearch";
+export declare const createAwsOpenSearchClient: (options: OpenSearchClientOptions) => Client;

package/createAwsOpenSearchClient.js

@@ -0,0 +1,29 @@
+import { AwsSigv4Signer } from "@opensearch-project/opensearch/aws";
+import { createOpenSearchClient } from "@webiny/api-opensearch";
+import error from "@webiny/error";
+const createAwsOpenSearchClient = (options)=>{
+    if (options.auth) return createOpenSearchClient(options);
+    const region = process.env.AWS_REGION;
+    if (!region) throw new error("Missing AWS_REGION environment variable.", "MISSING_AWS_REGION");
+    return createOpenSearchClient({
+        ...options,
+        ...AwsSigv4Signer({
+            region,
+            service: "es",
+            getCredentials: ()=>{
+                const accessKeyId = process.env.AWS_ACCESS_KEY_ID;
+                const secretAccessKey = process.env.AWS_SECRET_ACCESS_KEY;
+                const sessionToken = process.env.AWS_SESSION_TOKEN;
+                if (!accessKeyId || !secretAccessKey) throw new error("Missing AWS credentials (AWS_ACCESS_KEY_ID or AWS_SECRET_ACCESS_KEY).", "MISSING_AWS_CREDENTIALS");
+                return Promise.resolve({
+                    accessKeyId,
+                    secretAccessKey,
+                    sessionToken
+                });
+            }
+        })
+    });
+};
+export { createAwsOpenSearchClient };
+
+//# sourceMappingURL=createAwsOpenSearchClient.js.map

package/createAwsOpenSearchClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createAwsOpenSearchClient.js","sources":["../src/createAwsOpenSearchClient.ts"],"sourcesContent":["import { AwsSigv4Signer } from \"@opensearch-project/opensearch/aws\";\nimport {\n    createOpenSearchClient,\n    type OpenSearchClientOptions,\n    type Client\n} from \"@webiny/api-opensearch\";\nimport WebinyError from \"@webiny/error\";\n\nexport const createAwsOpenSearchClient = (options: OpenSearchClientOptions): Client => {\n    if (options.auth) {\n        return createOpenSearchClient(options);\n    }\n\n    const region = process.env.AWS_REGION;\n    if (!region) {\n        throw new WebinyError(\"Missing AWS_REGION environment variable.\", \"MISSING_AWS_REGION\");\n    }\n\n    return createOpenSearchClient({\n        ...options,\n        ...AwsSigv4Signer({\n            region,\n            service: \"es\",\n            getCredentials: () => {\n                const accessKeyId = process.env.AWS_ACCESS_KEY_ID;\n                const secretAccessKey = process.env.AWS_SECRET_ACCESS_KEY;\n                const sessionToken = process.env.AWS_SESSION_TOKEN;\n\n                if (!accessKeyId || !secretAccessKey) {\n                    throw new WebinyError(\n                        \"Missing AWS credentials (AWS_ACCESS_KEY_ID or AWS_SECRET_ACCESS_KEY).\",\n                        \"MISSING_AWS_CREDENTIALS\"\n                    );\n                }\n\n                return Promise.resolve({ accessKeyId, secretAccessKey, sessionToken });\n            }\n        })\n    });\n};\n"],"names":["createAwsOpenSearchClient","options","createOpenSearchClient","region","process","WebinyError","AwsSigv4Signer","accessKeyId","secretAccessKey","sessionToken","Promise"],"mappings":";;;AAQO,MAAMA,4BAA4B,CAACC;IACtC,IAAIA,QAAQ,IAAI,EACZ,OAAOC,uBAAuBD;IAGlC,MAAME,SAASC,QAAQ,GAAG,CAAC,UAAU;IACrC,IAAI,CAACD,QACD,MAAM,IAAIE,MAAY,4CAA4C;IAGtE,OAAOH,uBAAuB;QAC1B,GAAGD,OAAO;QACV,GAAGK,eAAe;YACdH;YACA,SAAS;YACT,gBAAgB;gBACZ,MAAMI,cAAcH,QAAQ,GAAG,CAAC,iBAAiB;gBACjD,MAAMI,kBAAkBJ,QAAQ,GAAG,CAAC,qBAAqB;gBACzD,MAAMK,eAAeL,QAAQ,GAAG,CAAC,iBAAiB;gBAElD,IAAI,CAACG,eAAe,CAACC,iBACjB,MAAM,IAAIH,MACN,yEACA;gBAIR,OAAOK,QAAQ,OAAO,CAAC;oBAAEH;oBAAaC;oBAAiBC;gBAAa;YACxE;QACJ,EAAE;IACN;AACJ"}

package/db/entity.d.ts

@@ -0,0 +1,7 @@
+import { type ITable } from "@webiny/db-dynamodb";
+import type { IOpenSearchEntity } from "../db/types.js";
+export interface ICreateOpenSearchEntityParams {
+    table: ITable;
+    entityName: string;
+}
+export declare const createOpenSearchEntity: (params: ICreateOpenSearchEntityParams) => IOpenSearchEntity;

package/db/entity.js

@@ -0,0 +1,18 @@
+import { createEntity, standardEntityAttributes } from "@webiny/db-dynamodb";
+const createOpenSearchEntity = (params)=>{
+    const { table, entityName } = params;
+    return createEntity({
+        name: entityName,
+        table: table.table,
+        attributes: {
+            ...standardEntityAttributes,
+            index: {
+                type: "string",
+                required: true
+            }
+        }
+    });
+};
+export { createOpenSearchEntity };
+
+//# sourceMappingURL=entity.js.map

package/db/entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"db/entity.js","sources":["../../src/db/entity.ts"],"sourcesContent":["import { createEntity, type ITable, standardEntityAttributes } from \"@webiny/db-dynamodb\";\nimport type { IOpenSearchEntity, IOpenSearchEntityAttributes } from \"~/db/types.js\";\n\nexport interface ICreateOpenSearchEntityParams {\n    table: ITable;\n    entityName: string;\n}\n\nexport const createOpenSearchEntity = (\n    params: ICreateOpenSearchEntityParams\n): IOpenSearchEntity => {\n    const { table, entityName } = params;\n    return createEntity<IOpenSearchEntityAttributes>({\n        name: entityName,\n        table: table.table,\n        attributes: {\n            ...standardEntityAttributes,\n            index: {\n                type: \"string\",\n                required: true\n            }\n        }\n    });\n};\n"],"names":["createOpenSearchEntity","params","table","entityName","createEntity","standardEntityAttributes"],"mappings":";AAQO,MAAMA,yBAAyB,CAClCC;IAEA,MAAM,EAAEC,KAAK,EAAEC,UAAU,EAAE,GAAGF;IAC9B,OAAOG,aAA0C;QAC7C,MAAMD;QACN,OAAOD,MAAM,KAAK;QAClB,YAAY;YACR,GAAGG,wBAAwB;YAC3B,OAAO;gBACH,MAAM;gBACN,UAAU;YACd;QACJ;IACJ;AACJ"}

package/db/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./table.js";
+export * from "./entity.js";
+export * from "./types.js";

package/db/index.js

@@ -0,0 +1,3 @@
+export * from "./table.js";
+export * from "./entity.js";
+export * from "./types.js";

package/db/table.d.ts

@@ -0,0 +1,7 @@
+import type { DynamoDBDocument } from "@webiny/aws-sdk/client-dynamodb/index.js";
+import { type ITable } from "@webiny/db-dynamodb";
+export interface ICreateOpenSearchTableParams {
+    name?: string;
+    documentClient: DynamoDBDocument;
+}
+export declare const createOpenSearchTable: ({ name, documentClient }: ICreateOpenSearchTableParams) => ITable;

package/db/table.js

@@ -0,0 +1,13 @@
+import { createTable } from "@webiny/db-dynamodb";
+const createOpenSearchTable = ({ name, documentClient })=>createTable({
+        name: name || process.env.DB_TABLE_OPENSEARCH,
+        indexes: {
+            GSI_TENANT: {
+                partitionKey: "GSI_TENANT"
+            }
+        },
+        documentClient
+    });
+export { createOpenSearchTable };
+
+//# sourceMappingURL=table.js.map

package/db/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"db/table.js","sources":["../../src/db/table.ts"],"sourcesContent":["import type { DynamoDBDocument } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\nimport { createTable, type ITable } from \"@webiny/db-dynamodb\";\n\nexport interface ICreateOpenSearchTableParams {\n    name?: string;\n    documentClient: DynamoDBDocument;\n}\n\nexport const createOpenSearchTable = ({\n    name,\n    documentClient\n}: ICreateOpenSearchTableParams): ITable => {\n    return createTable({\n        name: name || (process.env.DB_TABLE_OPENSEARCH as string),\n        indexes: {\n            GSI_TENANT: {\n                partitionKey: \"GSI_TENANT\"\n            }\n        },\n        documentClient\n    });\n};\n"],"names":["createOpenSearchTable","name","documentClient","createTable","process"],"mappings":";AAQO,MAAMA,wBAAwB,CAAC,EAClCC,IAAI,EACJC,cAAc,EACa,GACpBC,YAAY;QACf,MAAMF,QAASG,QAAQ,GAAG,CAAC,mBAAmB;QAC9C,SAAS;YACL,YAAY;gBACR,cAAc;YAClB;QACJ;QACAF;IACJ"}

package/db/types.d.ts

@@ -0,0 +1,6 @@
+import type { IEntity, IStandardEntityAttributes } from "@webiny/db-dynamodb";
+import type { GenericRecord } from "@webiny/api/types.js";
+export interface IOpenSearchEntityAttributes extends IStandardEntityAttributes<GenericRecord> {
+    index: string;
+}
+export type IOpenSearchEntity = IEntity<IOpenSearchEntityAttributes>;

package/features/AwsOpenSearchClientFactory/AwsOpenSearchClientFactory.d.ts

@@ -0,0 +1,9 @@
+import { OpenSearchClientFactory as OpenSearchClientFactoryAbstraction } from "@webiny/api-opensearch/features/OpenSearchClientFactory/abstraction.js";
+import type { Client, OpenSearchClientOptions } from "@webiny/api-opensearch";
+declare class AwsOpenSearchClientFactoryImpl implements OpenSearchClientFactoryAbstraction.Interface {
+    getClient(params: OpenSearchClientOptions): Client;
+}
+export declare const AwsOpenSearchClientFactory: typeof AwsOpenSearchClientFactoryImpl & {
+    __abstraction: import("@webiny/di").Abstraction<import("@webiny/api-opensearch/features/OpenSearchClientFactory/abstraction.js").IOpenSearchClientFactory>;
+};
+export {};

package/features/AwsOpenSearchClientFactory/AwsOpenSearchClientFactory.js

@@ -0,0 +1,15 @@
+import { OpenSearchClientFactory } from "@webiny/api-opensearch/features/OpenSearchClientFactory/abstraction.js";
+import { createAwsOpenSearchClient } from "../../createAwsOpenSearchClient.js";
+class AwsOpenSearchClientFactoryImpl {
+    getClient(params) {
+        if (!params.endpoint && !params.node && !params.nodes) throw new Error("OpenSearch client requires an endpoint, nodes or node to be specified.");
+        return createAwsOpenSearchClient(params);
+    }
+}
+const AwsOpenSearchClientFactory = OpenSearchClientFactory.createImplementation({
+    implementation: AwsOpenSearchClientFactoryImpl,
+    dependencies: []
+});
+export { AwsOpenSearchClientFactory };
+
+//# sourceMappingURL=AwsOpenSearchClientFactory.js.map

package/features/AwsOpenSearchClientFactory/AwsOpenSearchClientFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features/AwsOpenSearchClientFactory/AwsOpenSearchClientFactory.js","sources":["../../../src/features/AwsOpenSearchClientFactory/AwsOpenSearchClientFactory.ts"],"sourcesContent":["import { OpenSearchClientFactory as OpenSearchClientFactoryAbstraction } from \"@webiny/api-opensearch/features/OpenSearchClientFactory/abstraction.js\";\nimport type { Client, OpenSearchClientOptions } from \"@webiny/api-opensearch\";\nimport { createAwsOpenSearchClient } from \"~/createAwsOpenSearchClient.js\";\n\nclass AwsOpenSearchClientFactoryImpl implements OpenSearchClientFactoryAbstraction.Interface {\n    public getClient(params: OpenSearchClientOptions): Client {\n        if (!params.endpoint && !params.node && !params.nodes) {\n            throw new Error(\n                \"OpenSearch client requires an endpoint, nodes or node to be specified.\"\n            );\n        }\n        return createAwsOpenSearchClient(params);\n    }\n}\n\nexport const AwsOpenSearchClientFactory = OpenSearchClientFactoryAbstraction.createImplementation({\n    implementation: AwsOpenSearchClientFactoryImpl,\n    dependencies: []\n});\n"],"names":["AwsOpenSearchClientFactoryImpl","params","Error","createAwsOpenSearchClient","AwsOpenSearchClientFactory","OpenSearchClientFactoryAbstraction"],"mappings":";;AAIA,MAAMA;IACK,UAAUC,MAA+B,EAAU;QACtD,IAAI,CAACA,OAAO,QAAQ,IAAI,CAACA,OAAO,IAAI,IAAI,CAACA,OAAO,KAAK,EACjD,MAAM,IAAIC,MACN;QAGR,OAAOC,0BAA0BF;IACrC;AACJ;AAEO,MAAMG,6BAA6BC,wBAAAA,oBAAuD,CAAC;IAC9F,gBAAgBL;IAChB,cAAc,EAAE;AACpB"}

package/features/AwsOpenSearchClientFactory/feature.d.ts

@@ -0,0 +1,4 @@
+export declare const AwsOpenSearchClientFactoryFeature: {
+    name: string;
+    register(container: import("@webiny/di").Container): void;
+};

package/features/AwsOpenSearchClientFactory/feature.js

@@ -0,0 +1,11 @@
+import { createFeature } from "@webiny/feature/api/index.js";
+import { AwsOpenSearchClientFactory } from "./AwsOpenSearchClientFactory.js";
+const AwsOpenSearchClientFactoryFeature = createFeature({
+    name: "opensearch.aws.clientFactory",
+    register (container) {
+        container.register(AwsOpenSearchClientFactory).inSingletonScope();
+    }
+});
+export { AwsOpenSearchClientFactoryFeature };
+
+//# sourceMappingURL=feature.js.map

package/features/AwsOpenSearchClientFactory/feature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features/AwsOpenSearchClientFactory/feature.js","sources":["../../../src/features/AwsOpenSearchClientFactory/feature.ts"],"sourcesContent":["import { createFeature } from \"@webiny/feature/api/index.js\";\nimport { AwsOpenSearchClientFactory } from \"./AwsOpenSearchClientFactory.js\";\n\nexport const AwsOpenSearchClientFactoryFeature = createFeature({\n    name: \"opensearch.aws.clientFactory\",\n    register(container) {\n        container.register(AwsOpenSearchClientFactory).inSingletonScope();\n    }\n});\n"],"names":["AwsOpenSearchClientFactoryFeature","createFeature","container","AwsOpenSearchClientFactory"],"mappings":";;AAGO,MAAMA,oCAAoCC,cAAc;IAC3D,MAAM;IACN,UAASC,SAAS;QACdA,UAAU,QAAQ,CAACC,4BAA4B,gBAAgB;IACnE;AACJ"}

package/index.d.ts

@@ -0,0 +1,4 @@
+export { AwsOpenSearchClientFactoryFeature } from "./features/AwsOpenSearchClientFactory/feature.js";
+export { createAwsOpenSearchClient } from "./createAwsOpenSearchClient.js";
+export { createOpenSearchEntity, createOpenSearchTable } from "./db/index.js";
+export type { ICreateOpenSearchEntityParams, ICreateOpenSearchTableParams, IOpenSearchEntity, IOpenSearchEntityAttributes } from "./db/index.js";

package/index.js

@@ -0,0 +1,3 @@
+export { AwsOpenSearchClientFactoryFeature } from "./features/AwsOpenSearchClientFactory/feature.js";
+export { createAwsOpenSearchClient } from "./createAwsOpenSearchClient.js";
+export { createOpenSearchEntity, createOpenSearchTable } from "./db/index.js";

package/package.json

@@ -0,0 +1,37 @@
+{
+	"name": "@webiny/api-opensearch-aws",
+	"version": "0.0.0-unstable.0156a4c312",
+	"type": "module",
+	"exports": {
+		".": "./index.js",
+		"./*": "./*"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git",
+		"directory": "packages/api-opensearch-aws"
+	},
+	"description": "AWS-specific OpenSearch client factory for Webiny.",
+	"license": "MIT",
+	"dependencies": {
+		"@opensearch-project/opensearch": "3.9.0",
+		"@webiny/api": "0.0.0-unstable.0156a4c312",
+		"@webiny/api-opensearch": "0.0.0-unstable.0156a4c312",
+		"@webiny/aws-sdk": "0.0.0-unstable.0156a4c312",
+		"@webiny/db-dynamodb": "0.0.0-unstable.0156a4c312",
+		"@webiny/error": "0.0.0-unstable.0156a4c312",
+		"@webiny/feature": "0.0.0-unstable.0156a4c312"
+	},
+	"devDependencies": {
+		"@webiny/build-tools": "0.0.0-unstable.0156a4c312",
+		"rimraf": "6.1.3",
+		"typescript": "7.0.2",
+		"vitest": "5.0.5"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"webiny": {
+		"publishFrom": "dist"
+	}
+}

package/testing/index.d.ts

@@ -0,0 +1,2 @@
+export { simulateStream } from "./simulateStream.js";
+export { createDynamoStreamEvent, createDynamoStreamRecord } from "./processing.js";

package/testing/index.js

@@ -0,0 +1,2 @@
+export { simulateStream } from "./simulateStream.js";
+export { createDynamoStreamEvent, createDynamoStreamRecord } from "./processing.js";

package/testing/processing.d.ts

@@ -0,0 +1,29 @@
+import type { DynamoDBDocument } from "@webiny/aws-sdk/client-dynamodb/index.js";
+export declare const createDynamoStreamEvent: (...records: Record<string, unknown>[]) => {
+    Records: Record<string, unknown>[];
+};
+export declare const createDynamoStreamRecord: (eventName: string, data?: {
+    Keys?: Record<string, unknown>;
+    NewImage?: Record<string, unknown>;
+    OldImage?: Record<string, unknown>;
+}) => {
+    eventID: string;
+    eventName: string;
+    eventVersion: string;
+    eventSource: string;
+    awsRegion: string;
+    dynamodb: {
+        ApproximateCreationDateTime: number;
+        Keys: Record<string, import("@aws-sdk/client-dynamodb").AttributeValue>;
+        NewImage: Record<string, import("@aws-sdk/client-dynamodb").AttributeValue> | undefined;
+        OldImage: Record<string, import("@aws-sdk/client-dynamodb").AttributeValue> | undefined;
+        SequenceNumber: string;
+        SizeBytes: number;
+        StreamViewType: string;
+    };
+    eventSourceARN: string;
+};
+type StreamHandler = (event: Record<string, unknown>) => Promise<void>;
+export declare const processing: Record<string, (documentClient: DynamoDBDocument, handler: StreamHandler, params: Record<string, any>) => Promise<void>>;
+export declare const getCommandName: (command: unknown) => string | null;
+export {};

package/testing/processing.js

@@ -0,0 +1,114 @@
+import { BatchWriteCommand, DeleteCommand, PutCommand, UpdateCommand, marshall } from "@webiny/aws-sdk/client-dynamodb/index.js";
+const streamTableName = process.env.DB_TABLE_OPENSEARCH;
+const isOpenSearchStreamTable = (table)=>table === streamTableName;
+const createMarshalledObject = (target)=>{
+    if (!target) return;
+    return marshall(target, {
+        convertEmptyValues: true,
+        removeUndefinedValues: true
+    });
+};
+const createDynamoStreamEvent = (...records)=>({
+        Records: records
+    });
+const createDynamoStreamRecord = (eventName, data = {})=>{
+    const { Keys = {}, NewImage = {}, OldImage = {} } = data;
+    return {
+        eventID: "2cb5ad3ffabca3639e4f7858e3bdd138",
+        eventName,
+        eventVersion: "1.1",
+        eventSource: "aws:dynamodb",
+        awsRegion: "eu-central-1",
+        dynamodb: {
+            ApproximateCreationDateTime: 1613939165,
+            Keys: marshall(Keys),
+            NewImage: createMarshalledObject(NewImage),
+            OldImage: createMarshalledObject(OldImage),
+            SequenceNumber: "300000000029551639656",
+            SizeBytes: 14,
+            StreamViewType: "NEW_AND_OLD_IMAGES"
+        },
+        eventSourceARN: "arn:aws:dynamodb:eu-central-1:111111111111:table/streams-11111111/stream/2021-02-21T20:12:44.976"
+    };
+};
+const processDelete = async (documentClient, handler, params)=>{
+    if (false === isOpenSearchStreamTable(params.input?.TableName)) return;
+    const { Key, TableName } = params.input;
+    const { Item } = await documentClient.get({
+        Key,
+        TableName
+    });
+    if (!Item || !Item.index) return;
+    const record = createDynamoStreamRecord("REMOVE", {
+        Keys: Key,
+        OldImage: Item
+    });
+    const event = createDynamoStreamEvent(record);
+    await handler(event);
+};
+const processPut = async (documentClient, handler, params)=>{
+    const tableName = params.input?.TableName;
+    if (false === isOpenSearchStreamTable(tableName)) return;
+    const item = params.input.Item;
+    if (!item) return;
+    const { PK, SK } = item;
+    const record = createDynamoStreamRecord("INSERT", {
+        Keys: {
+            PK,
+            SK
+        },
+        NewImage: item
+    });
+    const event = createDynamoStreamEvent(record);
+    await handler(event);
+};
+const processBatchWrite = async (documentClient, handler, params)=>{
+    const operations = params?.input?.RequestItems?.[streamTableName];
+    if (!Array.isArray(operations)) return;
+    const records = [];
+    for (const operation of operations){
+        const { PutRequest, DeleteRequest } = operation;
+        if (DeleteRequest) {
+            const { Item } = await documentClient.get({
+                Key: DeleteRequest.Key,
+                TableName: process.env.DB_TABLE_OPENSEARCH
+            });
+            if (!Item || !Item.index) continue;
+            const record = createDynamoStreamRecord("REMOVE", {
+                Keys: DeleteRequest.Key,
+                OldImage: Item
+            });
+            records.push(record);
+        }
+        if (PutRequest) {
+            const { Item } = PutRequest;
+            const record = createDynamoStreamRecord("INSERT", {
+                Keys: {
+                    PK: Item.PK,
+                    SK: Item.SK
+                },
+                NewImage: Item
+            });
+            records.push(record);
+        }
+    }
+    if (0 === records.length) return;
+    await handler(createDynamoStreamEvent(...records));
+};
+const processing = {
+    put: processPut,
+    update: processPut,
+    delete: processDelete,
+    batchWrite: processBatchWrite
+};
+const getCommandName = (command)=>{
+    if (!command) return null;
+    if (command instanceof PutCommand) return "put";
+    else if (command instanceof UpdateCommand) return "update";
+    else if (command instanceof DeleteCommand) return "delete";
+    else if (command instanceof BatchWriteCommand) return "batchWrite";
+    return null;
+};
+export { createDynamoStreamEvent, createDynamoStreamRecord, getCommandName, processing };
+
+//# sourceMappingURL=processing.js.map

package/testing/processing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing/processing.js","sources":["../../src/testing/processing.ts"],"sourcesContent":["import { marshall } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\nimport { PutCommand } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\nimport { UpdateCommand } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\nimport { DeleteCommand } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\nimport { BatchWriteCommand } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\nimport type { DynamoDBDocument } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\n\nconst streamTableName = process.env.DB_TABLE_OPENSEARCH;\n\nconst isOpenSearchStreamTable = (table: string) => {\n    return table === streamTableName;\n};\n\nconst createMarshalledObject = (target: Record<string, unknown> | undefined) => {\n    if (!target) {\n        return undefined;\n    }\n    return marshall(target, {\n        convertEmptyValues: true,\n        removeUndefinedValues: true\n    });\n};\n\nexport const createDynamoStreamEvent = (...records: Record<string, unknown>[]) => {\n    return { Records: records };\n};\n\nexport const createDynamoStreamRecord = (\n    eventName: string,\n    data: {\n        Keys?: Record<string, unknown>;\n        NewImage?: Record<string, unknown>;\n        OldImage?: Record<string, unknown>;\n    } = {}\n) => {\n    const { Keys = {}, NewImage = {}, OldImage = {} } = data;\n    return {\n        eventID: \"2cb5ad3ffabca3639e4f7858e3bdd138\",\n        eventName,\n        eventVersion: \"1.1\",\n        eventSource: \"aws:dynamodb\",\n        awsRegion: \"eu-central-1\",\n        dynamodb: {\n            ApproximateCreationDateTime: 1613939165,\n            Keys: marshall(Keys),\n            NewImage: createMarshalledObject(NewImage),\n            OldImage: createMarshalledObject(OldImage),\n            SequenceNumber: \"300000000029551639656\",\n            SizeBytes: 14,\n            StreamViewType: \"NEW_AND_OLD_IMAGES\"\n        },\n        eventSourceARN:\n            \"arn:aws:dynamodb:eu-central-1:111111111111:table/streams-11111111/stream/2021-02-21T20:12:44.976\"\n    };\n};\n\ntype StreamHandler = (event: Record<string, unknown>) => Promise<void>;\n\nconst processDelete = async (\n    documentClient: DynamoDBDocument,\n    handler: StreamHandler,\n    params: Record<string, any>\n) => {\n    if (isOpenSearchStreamTable(params.input?.TableName) === false) {\n        return;\n    }\n    const { Key, TableName } = params.input;\n    const { Item } = await documentClient.get({ Key, TableName });\n\n    if (!Item || !Item.index) {\n        return;\n    }\n    const record = createDynamoStreamRecord(\"REMOVE\", { Keys: Key, OldImage: Item });\n    const event = createDynamoStreamEvent(record);\n\n    await handler(event);\n};\n\nconst processPut = async (\n    documentClient: DynamoDBDocument,\n    handler: StreamHandler,\n    params: Record<string, any>\n) => {\n    const tableName = params.input?.TableName;\n    if (isOpenSearchStreamTable(tableName) === false) {\n        return;\n    }\n\n    const item = params.input.Item;\n    if (!item) {\n        return;\n    }\n    const { PK, SK } = item;\n\n    const record = createDynamoStreamRecord(\"INSERT\", { Keys: { PK, SK }, NewImage: item });\n    const event = createDynamoStreamEvent(record);\n\n    await handler(event);\n};\n\nconst processBatchWrite = async (\n    documentClient: DynamoDBDocument,\n    handler: StreamHandler,\n    params: Record<string, any>\n) => {\n    const operations = params?.input?.RequestItems?.[streamTableName!];\n    if (!Array.isArray(operations)) {\n        return;\n    }\n\n    const records = [];\n    for (const operation of operations) {\n        const { PutRequest, DeleteRequest } = operation;\n        if (DeleteRequest) {\n            const { Item } = await documentClient.get({\n                Key: DeleteRequest.Key,\n                TableName: process.env.DB_TABLE_OPENSEARCH\n            });\n\n            // A missing record (or one without an index) emits no REMOVE record, like DynamoDB\n            // streams for a delete of a missing item and like `processDelete`.\n            if (!Item || !Item.index) {\n                continue;\n            }\n            const record = createDynamoStreamRecord(\"REMOVE\", {\n                Keys: DeleteRequest.Key,\n                OldImage: Item\n            });\n            records.push(record);\n        }\n\n        if (PutRequest) {\n            const { Item } = PutRequest;\n            const record = createDynamoStreamRecord(\"INSERT\", {\n                Keys: { PK: Item.PK, SK: Item.SK },\n                NewImage: Item\n            });\n            records.push(record);\n        }\n    }\n    if (records.length === 0) {\n        return;\n    }\n    await handler(createDynamoStreamEvent(...records));\n};\n\nexport const processing: Record<\n    string,\n    (\n        documentClient: DynamoDBDocument,\n        handler: StreamHandler,\n        params: Record<string, any>\n    ) => Promise<void>\n> = {\n    put: processPut,\n    update: processPut,\n    delete: processDelete,\n    batchWrite: processBatchWrite\n};\n\nexport const getCommandName = (command: unknown): string | null => {\n    if (!command) {\n        return null;\n    }\n    if (command instanceof PutCommand) {\n        return \"put\";\n    } else if (command instanceof UpdateCommand) {\n        return \"update\";\n    } else if (command instanceof DeleteCommand) {\n        return \"delete\";\n    } else if (command instanceof BatchWriteCommand) {\n        return \"batchWrite\";\n    }\n    return null;\n};\n"],"names":["streamTableName","process","isOpenSearchStreamTable","table","createMarshalledObject","target","marshall","createDynamoStreamEvent","records","createDynamoStreamRecord","eventName","data","Keys","NewImage","OldImage","processDelete","documentClient","handler","params","Key","TableName","Item","record","event","processPut","tableName","item","PK","SK","processBatchWrite","operations","Array","operation","PutRequest","DeleteRequest","processing","getCommandName","command","PutCommand","UpdateCommand","DeleteCommand","BatchWriteCommand"],"mappings":";AAOA,MAAMA,kBAAkBC,QAAQ,GAAG,CAAC,mBAAmB;AAEvD,MAAMC,0BAA0B,CAACC,QACtBA,UAAUH;AAGrB,MAAMI,yBAAyB,CAACC;IAC5B,IAAI,CAACA,QACD;IAEJ,OAAOC,SAASD,QAAQ;QACpB,oBAAoB;QACpB,uBAAuB;IAC3B;AACJ;AAEO,MAAME,0BAA0B,CAAC,GAAGC,UAChC;QAAE,SAASA;IAAQ;AAGvB,MAAMC,2BAA2B,CACpCC,WACAC,OAII,CAAC,CAAC;IAEN,MAAM,EAAEC,OAAO,CAAC,CAAC,EAAEC,WAAW,CAAC,CAAC,EAAEC,WAAW,CAAC,CAAC,EAAE,GAAGH;IACpD,OAAO;QACH,SAAS;QACTD;QACA,cAAc;QACd,aAAa;QACb,WAAW;QACX,UAAU;YACN,6BAA6B;YAC7B,MAAMJ,SAASM;YACf,UAAUR,uBAAuBS;YACjC,UAAUT,uBAAuBU;YACjC,gBAAgB;YAChB,WAAW;YACX,gBAAgB;QACpB;QACA,gBACI;IACR;AACJ;AAIA,MAAMC,gBAAgB,OAClBC,gBACAC,SACAC;IAEA,IAAIhB,AAAqD,UAArDA,wBAAwBgB,OAAO,KAAK,EAAE,YACtC;IAEJ,MAAM,EAAEC,GAAG,EAAEC,SAAS,EAAE,GAAGF,OAAO,KAAK;IACvC,MAAM,EAAEG,IAAI,EAAE,GAAG,MAAML,eAAe,GAAG,CAAC;QAAEG;QAAKC;IAAU;IAE3D,IAAI,CAACC,QAAQ,CAACA,KAAK,KAAK,EACpB;IAEJ,MAAMC,SAASb,yBAAyB,UAAU;QAAE,MAAMU;QAAK,UAAUE;IAAK;IAC9E,MAAME,QAAQhB,wBAAwBe;IAEtC,MAAML,QAAQM;AAClB;AAEA,MAAMC,aAAa,OACfR,gBACAC,SACAC;IAEA,MAAMO,YAAYP,OAAO,KAAK,EAAE;IAChC,IAAIhB,AAAuC,UAAvCA,wBAAwBuB,YACxB;IAGJ,MAAMC,OAAOR,OAAO,KAAK,CAAC,IAAI;IAC9B,IAAI,CAACQ,MACD;IAEJ,MAAM,EAAEC,EAAE,EAAEC,EAAE,EAAE,GAAGF;IAEnB,MAAMJ,SAASb,yBAAyB,UAAU;QAAE,MAAM;YAAEkB;YAAIC;QAAG;QAAG,UAAUF;IAAK;IACrF,MAAMH,QAAQhB,wBAAwBe;IAEtC,MAAML,QAAQM;AAClB;AAEA,MAAMM,oBAAoB,OACtBb,gBACAC,SACAC;IAEA,MAAMY,aAAaZ,QAAQ,OAAO,cAAc,CAAClB,gBAAiB;IAClE,IAAI,CAAC+B,MAAM,OAAO,CAACD,aACf;IAGJ,MAAMtB,UAAU,EAAE;IAClB,KAAK,MAAMwB,aAAaF,WAAY;QAChC,MAAM,EAAEG,UAAU,EAAEC,aAAa,EAAE,GAAGF;QACtC,IAAIE,eAAe;YACf,MAAM,EAAEb,IAAI,EAAE,GAAG,MAAML,eAAe,GAAG,CAAC;gBACtC,KAAKkB,cAAc,GAAG;gBACtB,WAAWjC,QAAQ,GAAG,CAAC,mBAAmB;YAC9C;YAIA,IAAI,CAACoB,QAAQ,CAACA,KAAK,KAAK,EACpB;YAEJ,MAAMC,SAASb,yBAAyB,UAAU;gBAC9C,MAAMyB,cAAc,GAAG;gBACvB,UAAUb;YACd;YACAb,QAAQ,IAAI,CAACc;QACjB;QAEA,IAAIW,YAAY;YACZ,MAAM,EAAEZ,IAAI,EAAE,GAAGY;YACjB,MAAMX,SAASb,yBAAyB,UAAU;gBAC9C,MAAM;oBAAE,IAAIY,KAAK,EAAE;oBAAE,IAAIA,KAAK,EAAE;gBAAC;gBACjC,UAAUA;YACd;YACAb,QAAQ,IAAI,CAACc;QACjB;IACJ;IACA,IAAId,AAAmB,MAAnBA,QAAQ,MAAM,EACd;IAEJ,MAAMS,QAAQV,2BAA2BC;AAC7C;AAEO,MAAM2B,aAOT;IACA,KAAKX;IACL,QAAQA;IACR,QAAQT;IACR,YAAYc;AAChB;AAEO,MAAMO,iBAAiB,CAACC;IAC3B,IAAI,CAACA,SACD,OAAO;IAEX,IAAIA,mBAAmBC,YACnB,OAAO;SACJ,IAAID,mBAAmBE,eAC1B,OAAO;SACJ,IAAIF,mBAAmBG,eAC1B,OAAO;SACJ,IAAIH,mBAAmBI,mBAC1B,OAAO;IAEX,OAAO;AACX"}

package/testing/simulateStream.d.ts

@@ -0,0 +1,4 @@
+import type { DynamoDBDocument } from "@webiny/aws-sdk/client-dynamodb/index.js";
+export { createDynamoStreamEvent, createDynamoStreamRecord } from "./processing.js";
+type StreamHandler = (event: Record<string, unknown>) => Promise<void>;
+export declare const simulateStream: (documentClient: DynamoDBDocument, handler: StreamHandler) => void;

package/testing/simulateStream.js

@@ -0,0 +1,21 @@
+import { createDynamoStreamEvent, createDynamoStreamRecord, getCommandName, processing } from "./processing.js";
+const simulateStream = (documentClient, handler)=>{
+    const originalSend = documentClient["send"];
+    documentClient.send = async (...params)=>{
+        const [command] = params;
+        const name = getCommandName(command);
+        if (name) {
+            if (!processing[name]) throw new Error(`Missing handler for "${name}" command.`);
+            try {
+                await processing[name](documentClient, handler, command);
+            } catch (ex) {
+                console.log(JSON.stringify(command));
+                throw new Error(`Error processing "${name}" command: ${ex.message}`, ex);
+            }
+        }
+        return await originalSend.apply(documentClient, params);
+    };
+};
+export { createDynamoStreamEvent, createDynamoStreamRecord, simulateStream };
+
+//# sourceMappingURL=simulateStream.js.map

package/testing/simulateStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing/simulateStream.js","sources":["../../src/testing/simulateStream.ts"],"sourcesContent":["import type { DynamoDBDocument } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\nimport { processing, getCommandName } from \"./processing.js\";\nexport { createDynamoStreamEvent, createDynamoStreamRecord } from \"./processing.js\";\n\ntype StreamHandler = (event: Record<string, unknown>) => Promise<void>;\n\nexport const simulateStream = (documentClient: DynamoDBDocument, handler: StreamHandler) => {\n    const originalSend = documentClient[\"send\"];\n    documentClient.send = async (...params: any[]) => {\n        const [command] = params;\n\n        const name = getCommandName(command);\n        if (name) {\n            if (!processing[name]) {\n                throw new Error(`Missing handler for \"${name}\" command.`);\n            }\n            try {\n                await processing[name](documentClient, handler, command);\n            } catch (ex: any) {\n                console.log(JSON.stringify(command));\n                throw new Error(`Error processing \"${name}\" command: ${ex.message}`, ex);\n            }\n        }\n\n        return await originalSend.apply(documentClient, params as any);\n    };\n};\n"],"names":["simulateStream","documentClient","handler","originalSend","params","command","name","getCommandName","processing","Error","ex","console","JSON"],"mappings":";AAMO,MAAMA,iBAAiB,CAACC,gBAAkCC;IAC7D,MAAMC,eAAeF,cAAc,CAAC,OAAO;IAC3CA,eAAe,IAAI,GAAG,OAAO,GAAGG;QAC5B,MAAM,CAACC,QAAQ,GAAGD;QAElB,MAAME,OAAOC,eAAeF;QAC5B,IAAIC,MAAM;YACN,IAAI,CAACE,UAAU,CAACF,KAAK,EACjB,MAAM,IAAIG,MAAM,CAAC,qBAAqB,EAAEH,KAAK,UAAU,CAAC;YAE5D,IAAI;gBACA,MAAME,UAAU,CAACF,KAAK,CAACL,gBAAgBC,SAASG;YACpD,EAAE,OAAOK,IAAS;gBACdC,QAAQ,GAAG,CAACC,KAAK,SAAS,CAACP;gBAC3B,MAAM,IAAII,MAAM,CAAC,kBAAkB,EAAEH,KAAK,WAAW,EAAEI,GAAG,OAAO,EAAE,EAAEA;YACzE;QACJ;QAEA,OAAO,MAAMP,aAAa,KAAK,CAACF,gBAAgBG;IACpD;AACJ"}