{"_id":"@20minutes/serverless-s3-local","_rev":"4-5c08b6956537d33565b8fe71ce2a75fb","name":"@20minutes/serverless-s3-local","dist-tags":{"latest":"1.0.0"},"versions":{"0.7.3":{"name":"@20minutes/serverless-s3-local","version":"0.7.3","keywords":["serverless","S3","AWS"],"author":{"name":"Masahiro Wada"},"license":"MIT","_id":"@20minutes/serverless-s3-local@0.7.3","maintainers":[{"name":"webtech20minutes","email":"web-tech+npm@20minutes.fr"},{"name":"j0k3r","email":"jeremy.benoist@gmail.com"}],"homepage":"https://github.com/20minutes/serverless-s3-local#readme","bugs":{"url":"https://github.com/20minutes/serverless-s3-local/issues"},"dist":{"shasum":"093a460f08971e8448b5667541ccae426d96eb8e","tarball":"https://registry.npmjs.org/@20minutes/serverless-s3-local/-/serverless-s3-local-0.7.3.tgz","fileCount":4,"integrity":"sha512-ZyFHgu0SSrE8IGj84F7st3Ifxld6WPlu31vkdTnoEOr5Hy2ubV5cU0uaeGomnNAqRxcniy8QUtm/mH/DimOerg==","signatures":[{"sig":"MEUCIQDcXyGa7CzvZeG4LdYYrUH92TN2NH+cXqpiI8euymtmuAIgR2x364ZaUGIOIC583HLH9cg7umc+0XT0PZ57/2MxkYQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":20990},"main":"index.js","scripts":{"lint":"eslint index.js","test":"echo \"Error: no test specified\" && exit 1","lint:fix":"eslint --fix index.js","prepublish":"in-publish && cp ../README.md ./"},"_npmUser":{"name":"webtech20minutes","email":"web-tech+npm@20minutes.fr"},"repository":{"url":"git+https://github.com/20minutes/serverless-s3-local.git","type":"git"},"directories":{},"dependencies":{"rxjs":"^6.6.7","s3rver":"20minutes/s3rver#main","shelljs":"^0.8.5","fs-extra":"^11.0.0","rxjs-compat":"^6.6.7","@aws-sdk/client-s3":"^3.53.1","serverless-offline":"^12.0.0"},"_hasShrinkwrap":false,"devDependencies":{"in-publish":"2.0.1"},"_npmOperationalInternal":{"tmp":"tmp/serverless-s3-local_0.7.3_1688725865292_0.6977221972025065","host":"s3://npm-registry-packages"}},"0.8.0":{"name":"@20minutes/serverless-s3-local","version":"0.8.0","keywords":["serverless","S3","AWS"],"author":{"name":"Masahiro Wada"},"license":"MIT","_id":"@20minutes/serverless-s3-local@0.8.0","maintainers":[{"name":"webtech20minutes","email":"web-tech+npm@20minutes.fr"},{"name":"j0k3r","email":"jeremy.benoist@gmail.com"}],"homepage":"https://github.com/20minutes/serverless-s3-local#readme","bugs":{"url":"https://github.com/20minutes/serverless-s3-local/issues"},"dist":{"shasum":"6386d76c67e655362fb791c946f50711a3481c36","tarball":"https://registry.npmjs.org/@20minutes/serverless-s3-local/-/serverless-s3-local-0.8.0.tgz","fileCount":4,"integrity":"sha512-62u2umgVScbYJ1P9QREH0G5AXOlEnqIpcHioQXcPi4J2SQIDe9ORhtY+yJxqRS/RyoL/344wszdf8r8u7vpewg==","signatures":[{"sig":"MEQCIH7kGE4qKh2EeWFnDuUbvZS/sCTHI4Syedq/Zdp+8vgVAiBb+YYc0ZIpGvoCjB7LY7H8Xlfhncspd6blNxRSBiQV5Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":20991},"main":"index.js","scripts":{"lint":"eslint index.js","test":"echo \"Error: no test specified\" && exit 1","lint:fix":"eslint --fix index.js","prepublish":"in-publish && cp ../README.md ./"},"_npmUser":{"name":"webtech20minutes","email":"web-tech+npm@20minutes.fr"},"repository":{"url":"git+https://github.com/20minutes/serverless-s3-local.git","type":"git"},"directories":{},"dependencies":{"rxjs":"^6.6.7","s3rver":"20minutes/s3rver#main","shelljs":"^0.8.5","fs-extra":"^11.0.0","rxjs-compat":"^6.6.7","@aws-sdk/client-s3":"^3.417.0","serverless-offline":"^13.0.0"},"_hasShrinkwrap":false,"devDependencies":{"in-publish":"2.0.1"},"_npmOperationalInternal":{"tmp":"tmp/serverless-s3-local_0.8.0_1695371860717_0.6737503714534283","host":"s3://npm-registry-packages"}},"0.8.1":{"name":"@20minutes/serverless-s3-local","version":"0.8.1","keywords":["serverless","S3","AWS"],"author":{"name":"Masahiro Wada"},"license":"MIT","_id":"@20minutes/serverless-s3-local@0.8.1","maintainers":[{"name":"webtech20minutes","email":"web-tech+npm@20minutes.fr"},{"name":"j0k3r","email":"jeremy.benoist@gmail.com"}],"homepage":"https://github.com/20minutes/serverless-s3-local#readme","bugs":{"url":"https://github.com/20minutes/serverless-s3-local/issues"},"dist":{"shasum":"9c32928f3dd512b4f546390ddb7e81cae9aa50c9","tarball":"https://registry.npmjs.org/@20minutes/serverless-s3-local/-/serverless-s3-local-0.8.1.tgz","fileCount":4,"integrity":"sha512-sjv5W1rfRuS8GNrZKJSaASLe5mX+TCjstcucAl4sHJ6wFamxLoworqUqdlcLhFeqEzQyjpLmPsZdeBhXQdeCbA==","signatures":[{"sig":"MEUCIQD1rItm3H+ux92XnHPHBb4rR9d40cZnKFlgX5D5ev36jQIgcRM9/NMIBLf4/Dn3PK3nJhvdNmhndt/4LjugQh7SM1w=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":20998},"main":"index.js","scripts":{"lint":"eslint index.js","test":"echo \"Error: no test specified\" && exit 1","lint:fix":"eslint --fix index.js","prepublish":"in-publish && cp ../README.md ./"},"_npmUser":{"name":"webtech20minutes","email":"web-tech+npm@20minutes.fr"},"repository":{"url":"git+https://github.com/20minutes/serverless-s3-local.git","type":"git"},"directories":{},"dependencies":{"rxjs":"^6.6.7","shelljs":"^0.8.5","fs-extra":"^11.0.0","rxjs-compat":"^6.6.7","@20minutes/s3rver":"^4.0.0","@aws-sdk/client-s3":"^3.417.0","serverless-offline":"^13.0.0"},"_hasShrinkwrap":false,"devDependencies":{"in-publish":"2.0.1"},"_npmOperationalInternal":{"tmp":"tmp/serverless-s3-local_0.8.1_1695929845076_0.9179901281121885","host":"s3://npm-registry-packages"}},"1.0.0":{"name":"@20minutes/serverless-s3-local","version":"1.0.0","author":{"name":"Masahiro Wada"},"main":"src/index.js","license":"MIT","keywords":["serverless","S3","AWS"],"bugs":{"url":"https://github.com/20minutes/serverless-s3-local/issues"},"homepage":"https://github.com/20minutes/serverless-s3-local#readme","repository":{"type":"git","url":"git+https://github.com/20minutes/serverless-s3-local.git"},"scripts":{"test":"vitest run","lint":"biome check --max-diagnostics=none","lint:fix":"biome check --write --unsafe --max-diagnostics=none","lint:staged":"biome check --error-on-warnings --no-errors-on-unmatched --staged --max-diagnostics=none","lint:ci":"biome ci --max-diagnostics=none --error-on-warnings","prepare":"husky"},"dependencies":{"@20minutes/s3rver":"^5.0.0","@aws-sdk/client-s3":"^3.1081.0","serverless-offline":"^13.0.0"},"devDependencies":{"@20minutes/eslint-config":"^3.0.4","husky":"^9.1.7","serverless":"npm:osls@^3.76.1","vite":"^8.1.3","vitest":"^4.1.10"},"engines":{"node":">=24"},"description":"[![CI](https://github.com/20minutes/serverless-s3-local/actions/workflows/ci.yml/badge.svg)](https://github.com/20minutes/serverless-s3-local/actions/workflows/ci.yml) [![npm version](https://badge.fury.io/js/@20minutes%2Fserverless-s3-local.svg)](https:/","licenseText":"MIT License\n\nCopyright (c) 2016 Masahiro Wada\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","_id":"@20minutes/serverless-s3-local@1.0.0","dist":{"shasum":"15428f637cf300352e4f7cd35260b7b58d6f4854","integrity":"sha512-Dc7c4fttDvUgUnPBb0cZzdlJR4/n+YYFSoznn8W42Sfr/DJ41NXu25aQsUi6mDG6RwM+f816BdXRDzBmvswjxw==","tarball":"https://registry.npmjs.org/@20minutes/serverless-s3-local/-/serverless-s3-local-1.0.0.tgz","fileCount":6,"unpackedSize":25509,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCPlRGor+XDW27UJSP7lCDuMGBm3F7OUPiSUcK92B3wIAIhAKy+17sTKO5+dMPSTPErzUlaEZi4UwX381990eG71DzF"}]},"_npmUser":{"name":"webtech20minutes","email":"web-tech+npm@20minutes.fr"},"directories":{},"maintainers":[{"name":"webtech20minutes","email":"web-tech+npm@20minutes.fr"},{"name":"j0k3r","email":"jeremy.benoist@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/serverless-s3-local_1.0.0_1783537160048_0.5336513317779452"},"_hasShrinkwrap":false}},"time":{"created":"2023-07-07T10:31:05.149Z","modified":"2026-07-08T18:59:20.357Z","0.7.3":"2023-07-07T10:31:05.437Z","0.8.0":"2023-09-22T08:37:40.880Z","0.8.1":"2023-09-28T19:37:25.237Z","1.0.0":"2026-07-08T18:59:20.209Z"},"bugs":{"url":"https://github.com/20minutes/serverless-s3-local/issues"},"author":{"name":"Masahiro Wada"},"license":"MIT","homepage":"https://github.com/20minutes/serverless-s3-local#readme","keywords":["serverless","S3","AWS"],"repository":{"type":"git","url":"git+https://github.com/20minutes/serverless-s3-local.git"},"maintainers":[{"name":"webtech20minutes","email":"web-tech+npm@20minutes.fr"},{"name":"j0k3r","email":"jeremy.benoist@gmail.com"}],"readme":"# @20minutes/serverless-s3-local\n\n[![CI](https://github.com/20minutes/serverless-s3-local/actions/workflows/ci.yml/badge.svg)](https://github.com/20minutes/serverless-s3-local/actions/workflows/ci.yml)\n[![npm version](https://badge.fury.io/js/@20minutes%2Fserverless-s3-local.svg)](https://badge.fury.io/js/@20minutes%2Fserverless-s3-local)\n[![npm downloads](https://img.shields.io/npm/dt/@20minutes%2Fserverless-s3-local.svg?style=flat)](https://www.npmjs.com/package/@20minutes%2Fserverless-s3-local)\n[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/amplify-education/serverless-domain-manager/master/LICENSE)\n\nForked version to use our own fork of s3rver (and removed Docker).\n\nFor the official readme, [check the official project](https://github.com/ar90n/serverless-s3-local).\n\n## Requirements\n\n- Node.js >= 24\n- Serverless Framework v3 or osls v3\n- `serverless-offline` when using S3 events with offline lambdas\n\n## Installation\n\n```bash\nyarn add -D @20minutes/serverless-s3-local serverless-offline\n```\n\n## Configuration\n\n```yaml\nservice: my-service\n\nprovider:\n  name: aws\n  runtime: nodejs24.x\n\nplugins:\n  - '@20minutes/serverless-s3-local'\n  - serverless-offline\n\ncustom:\n  s3:\n    host: localhost\n    port: 8000\n    directory: ./.s3-local\n\nresources:\n  Resources:\n    LocalBucket:\n      Type: AWS::S3::Bucket\n      Properties:\n        BucketName: local-bucket\n\nfunctions:\n  onUpload:\n    handler: handler.onUpload\n    events:\n      - s3:\n          bucket: local-bucket\n          event: s3:ObjectCreated:Put\n          rules:\n            - prefix: incoming/\n            - suffix: .txt\n```\n\n## Commands\n\n```bash\nserverless s3 start\nserverless s3 create\nserverless s3 remove\nserverless offline start\n```\n\n## Options\n\nCommon `custom.s3` options:\n\n| Option | Description | Default |\n| --- | --- | --- |\n| `host` | S3 endpoint host used by SDK clients | `localhost` |\n| `address` | Bind address used by S3rver | `localhost` |\n| `port` | S3 endpoint port | `4569` |\n| `directory` | Local object storage directory | `./buckets` |\n| `buckets` | Extra buckets to create | none |\n| `noStart` | Create/remove buckets against already running local S3 | `false` |\n| `accessKeyId` | Local credentials access key | `S3RVER` |\n| `secretAccessKey` | Local credentials secret key | `S3RVER` |\n| `region` | SDK region | `us-east-1` |\n| `cors` | Path to CORS XML config | none |\n| `website` | Path to website XML config | none |\n| `allowMismatchedSignatures` | Pass-through S3rver option | `false` |\n| `serviceEndpoint` | Pass-through S3rver option | none |\n| `httpsProtocol` | Directory containing `cert.pem` and `key.pem` | none |\n| `vhostBuckets` | Pass-through S3rver option | `true` |\n\n## SDK Client\n\n```js\nconst { S3Client } = require('@aws-sdk/client-s3')\n\nconst s3 = new S3Client({\n  forcePathStyle: true,\n  endpoint: 'http://localhost:8000',\n  region: 'us-east-1',\n  credentials: {\n    accessKeyId: 'S3RVER',\n    secretAccessKey: 'S3RVER',\n  },\n})\n```\n\n## Development\n\n```bash\nyarn install\nyarn lint\nyarn test\n```\n\n## Examples\n\nTwo examples are kept as runnable documentation:\n\n- `examples/simple-put`\n- `examples/s3-event-prefix-suffix`\n","readmeFilename":"README.md","description":"[![CI](https://github.com/20minutes/serverless-s3-local/actions/workflows/ci.yml/badge.svg)](https://github.com/20minutes/serverless-s3-local/actions/workflows/ci.yml) [![npm version](https://badge.fury.io/js/@20minutes%2Fserverless-s3-local.svg)](https:/"}