mock-aws-s3-v3 5.0.1

package/README.md

@@ -0,0 +1,46 @@
+[![npm version](https://badge.fury.io/js/mock-aws-s3-v3.svg)](https://badge.fury.io/js/mock-aws-s3-v3)
+
+# Mock AWS S3 SDK v3
+
+Local file-based mock for AWS S3 for unit and local testing for AWS JavaScript SDK v3+.
+
+Based on [mock-aws-s3](https://www.npmjs.com/package/mock-aws-s3) and [aws-sdk-mock](https://www.npmjs.com/package/aws-sdk-mock).
+
+## Usage
+
+```typescript
+import { createS3Client } from 'mock-aws-s3-v3';
+import { GetObjectCommand } from '@aws-sdk/client-s3';
+
+const client = createS3Client('./local-folder'); // of type S3Client
+
+client.send(new PutObjectCommand({
+  Bucket: 'test-bucket',
+  Key: 'test-key',
+  Body: 'hello',
+});
+```
+
+This will create:
+
+- Folder `./local-folder/test-bucket`
+- File `./local-folder/test-key` with content 'hello'
+
+## Supported Operations
+
+The following operations are currently supported in this mock:
+
+- CreateBucketCommand
+- DeleteBucketCommand
+- ListObjectsCommand
+- ListObjectsV2Command
+- DeleteObjectsCommand
+- DeleteObjectCommand
+- GetObjectCommand
+- HeadObjectCommand
+- PutObjectCommand
+- CopyObjectCommand
+- GetObjectTaggingCommand
+- PutObjectTaggingCommand
+
+Same as [mock-aws-s3](https://www.npmjs.com/package/mock-aws-s3) minus `getSignedUrl`. For an example of how `getSignedUrl` could be mocked, see [templateS3Bucket.ts](https://github.com/goldstack/goldstack/blob/5842322ed4f5165da56fc2ab899f11bd9e1821e3/workspaces/templates-lib/packages/template-s3/src/templateS3Bucket.ts#L64).

package/dist/src/mockS3.d.ts

@@ -0,0 +1,3 @@
+import { S3Client } from '@aws-sdk/client-s3';
+export declare function createS3Client(localDirectory: string, s3Client?: S3Client): S3Client;
+//# sourceMappingURL=mockS3.d.ts.map

package/dist/src/mockS3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockS3.d.ts","sourceRoot":"","sources":["../../src/mockS3.ts"],"names":[],"mappings":"AAAA,OAAO,EAeL,QAAQ,EACT,MAAM,oBAAoB,CAAC;AAO5B,wBAAgB,cAAc,CAC5B,cAAc,EAAE,MAAM,EACtB,QAAQ,CAAC,EAAE,QAAQ,GAClB,QAAQ,CAwDV"}

package/dist/src/mockS3.js

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createS3Client = void 0;
+const client_s3_1 = require("@aws-sdk/client-s3");
+const aws_sdk_client_mock_1 = require("aws-sdk-client-mock");
+const mock_aws_s3_1 = __importDefault(require("mock-aws-s3"));
+function createS3Client(localDirectory, s3Client) {
+    if (!s3Client) {
+        s3Client = new client_s3_1.S3Client();
+    }
+    const client = (0, aws_sdk_client_mock_1.mockClient)(client_s3_1.S3Client);
+    mock_aws_s3_1.default.config.basePath = localDirectory;
+    const mockS3 = new mock_aws_s3_1.default.S3({
+        params: {},
+    });
+    client.on(client_s3_1.PutObjectCommand).callsFake(async (input) => {
+        return await mockS3.putObject(input).promise();
+    });
+    client.on(client_s3_1.GetObjectCommand).callsFake(async (input) => {
+        const resOperation = mockS3.getObject(input);
+        try {
+            const res = await resOperation.promise();
+            const output = { ...res };
+            const body = {
+                toString: () => { var _a; return (_a = res.Body) === null || _a === void 0 ? void 0 : _a.toString(); },
+                transformToString: async () => { var _a; return ((_a = res.Body) === null || _a === void 0 ? void 0 : _a.toString()) || ''; },
+                pipe: (destination, options) => {
+                    return resOperation.createReadStream().pipe(destination, options);
+                },
+            };
+            output.Body = body;
+            return output;
+        }
+        catch (e) {
+            const awsError = e;
+            if (awsError.code === 'NoSuchKey') {
+                throw new client_s3_1.NoSuchKey({
+                    message: e.message,
+                    $metadata: {},
+                });
+            }
+            throw e;
+        }
+    });
+    wrappedAsIs(client, mockS3, client_s3_1.CreateBucketCommand, 'createBucket');
+    wrappedAsIs(client, mockS3, client_s3_1.DeleteBucketCommand, 'deleteBucket');
+    wrappedAsIs(client, mockS3, client_s3_1.ListObjectsCommand, 'listObjects');
+    wrappedAsIs(client, mockS3, client_s3_1.DeleteObjectsCommand, 'deleteObjects');
+    wrappedAsIs(client, mockS3, client_s3_1.DeleteObjectCommand, 'deleteObject');
+    wrappedAsIs(client, mockS3, client_s3_1.HeadObjectCommand, 'headObject');
+    wrappedAsIs(client, mockS3, client_s3_1.CopyObjectCommand, 'copyObject');
+    wrappedAsIs(client, mockS3, client_s3_1.GetObjectTaggingCommand, 'getObjectTagging');
+    wrappedAsIs(client, mockS3, client_s3_1.PutObjectTaggingCommand, 'putObjectTagging');
+    notSupported(client, client_s3_1.ListBucketsCommand);
+    return s3Client;
+}
+exports.createS3Client = createS3Client;
+function wrappedAsIs(client, mockS3, command, methodName) {
+    client.on(command).callsFake(async (input) => {
+        return await mockS3[methodName](input).promise();
+    });
+}
+function notSupported(client, command) {
+    client.on(command).rejects('Method ' + command.name + ' not implemented.');
+}
+//# sourceMappingURL=mockS3.js.map

package/dist/src/mockS3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockS3.js","sourceRoot":"","sources":["../../src/mockS3.ts"],"names":[],"mappings":";;;;;;AAAA,kDAgB4B;AAC5B,6DAAiD;AACjD,8DAA+C;AAK/C,SAAgB,cAAc,CAC5B,cAAsB,EACtB,QAAmB;IAEnB,IAAI,CAAC,QAAQ,EAAE;QACb,QAAQ,GAAG,IAAI,oBAAQ,EAAE,CAAC;KAC3B;IACD,MAAM,MAAM,GAAG,IAAA,gCAAU,EAAC,oBAAQ,CAAC,CAAC;IAEpC,qBAAM,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC;IACxC,MAAM,MAAM,GAAG,IAAI,qBAAM,CAAC,EAAE,CAAC;QAC3B,MAAM,EAAE,EAAE;KACX,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,CAAC,4BAAgB,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,EAAgB,EAAE;QAClE,OAAO,MAAM,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,CAAC,4BAAgB,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,EAAgB,EAAE;QAClE,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAE7C,IAAI;YACF,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,CAAC;YAEzC,MAAM,MAAM,GAAoB,EAAE,GAAI,GAAW,EAAE,CAAC;YAEpD,MAAM,IAAI,GAAoC;gBAC5C,QAAQ,EAAE,GAAG,EAAE,WAAC,OAAA,MAAA,GAAG,CAAC,IAAI,0CAAE,QAAQ,EAAE,CAAA,EAAA;gBACpC,iBAAiB,EAAE,KAAK,IAAI,EAAE,WAAC,OAAA,CAAA,MAAA,GAAG,CAAC,IAAI,0CAAE,QAAQ,EAAE,KAAI,EAAE,CAAA,EAAA;gBACzD,IAAI,EAAE,CAAC,WAAwB,EAAE,OAAQ,EAAE,EAAE;oBAC3C,OAAO,YAAY,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;gBACpE,CAAC;aACK,CAAC;YACT,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;YACnB,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,QAAQ,GAAG,CAAa,CAAC;YAC/B,IAAI,QAAQ,CAAC,IAAI,KAAK,WAAW,EAAE;gBACjC,MAAM,IAAI,qBAAS,CAAC;oBAClB,OAAO,EAAE,CAAC,CAAC,OAAO;oBAClB,SAAS,EAAE,EAAE;iBACd,CAAC,CAAC;aACJ;YACD,MAAM,CAAC,CAAC;SACT;IACH,CAAC,CAAC,CAAC;IAEH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,+BAAmB,EAAE,cAAc,CAAC,CAAC;IACjE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,+BAAmB,EAAE,cAAc,CAAC,CAAC;IACjE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,8BAAkB,EAAE,aAAa,CAAC,CAAC;IAC/D,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,gCAAoB,EAAE,eAAe,CAAC,CAAC;IACnE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,+BAAmB,EAAE,cAAc,CAAC,CAAC;IACjE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,6BAAiB,EAAE,YAAY,CAAC,CAAC;IAC7D,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,6BAAiB,EAAE,YAAY,CAAC,CAAC;IAC7D,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,mCAAuB,EAAE,kBAAkB,CAAC,CAAC;IACzE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,mCAAuB,EAAE,kBAAkB,CAAC,CAAC;IAEzE,YAAY,CAAC,MAAM,EAAE,8BAAkB,CAAC,CAAC;IACzC,OAAO,QAAQ,CAAC;AAClB,CAAC;AA3DD,wCA2DC;AAED,SAAS,WAAW,CAClB,MAAW,EACX,MAAW,EACX,OAAY,EACZ,UAAkB;IAElB,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,KAAU,EAAgB,EAAE;QAC9D,OAAO,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;IACnD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,YAAY,CAAC,MAAW,EAAE,OAAY;IAC7C,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,IAAI,GAAG,mBAAmB,CAAC,CAAC;AAC7E,CAAC"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "mock-aws-s3-v3",
+  "version": "5.0.1",
+  "description": "Local in-memory Mock for AWS S3 for unit and local testing for AWS JavaScript SDK v3+.",
+  "keywords": [
+    "node",
+    "javascript",
+    "s3",
+    "jest"
+  ],
+  "homepage": "https://github.com/goldstack/goldstack/tree/master/workspaces/utils/packages/mock-aws-s3-v3#readme",
+  "bugs": {
+    "url": "https://github.com/goldstack/goldstack/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/goldstack/goldstack.git"
+  },
+  "license": "MIT",
+  "author": "Max Rohde",
+  "sideEffects": false,
+  "main": "dist/src/mockS3.js",
+  "scripts": {
+    "build": "yarn clean && yarn compile",
+    "build:watch": "yarn clean && yarn compile-watch",
+    "clean": "rimraf ./dist",
+    "compile": "tsc -p tsconfig.json",
+    "compile-watch": "tsc -p tsconfig.json --watch",
+    "compile-watch:light": "nodemon --watch ./src/ -e '*' --exec 'yarn compile'",
+    "coverage": "jest --collect-coverage --passWithNoTests --config=./jest.config.js --runInBand",
+    "prepublishOnly": "yarn run build",
+    "publish": "utils-git changed --exec \"yarn npm publish $@\"",
+    "test-ci": "jest --passWithNoTests --config=./jest.config.js --runInBand",
+    "version:apply": "utils-git changed --exec \"yarn version $@ && yarn version apply\""
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "3.485.0",
+    "@smithy/types": "^2.8.0",
+    "aws-sdk-client-mock": "^3.0.1",
+    "mock-aws-s3": "^4.0.2"
+  },
+  "devDependencies": {
+    "@goldstack/utils-git": "0.2.9",
+    "@swc/core": "^1.3.74",
+    "@swc/jest": "^0.2.27",
+    "@types/jest": "^29.0.1",
+    "@types/mock-aws-s3": "^2.6.3",
+    "@types/node": "^18.7.13",
+    "jest": "^29.3.1",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.8.4"
+  },
+  "publishConfig": {
+    "main": "dist/src/mockS3.js"
+  }
+}