{"id":13755187,"url":"https://github.com/onebeyond/systemic-aws-s3","last_synced_at":"2025-04-12T01:15:01.075Z","repository":{"id":44738431,"uuid":"347121187","full_name":"onebeyond/systemic-aws-s3","owner":"onebeyond","description":"A Systemic component for the AWS S3 SDK v3","archived":false,"fork":false,"pushed_at":"2024-04-24T08:28:24.000Z","size":388,"stargazers_count":2,"open_issues_count":17,"forks_count":3,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-12T01:14:55.749Z","etag":null,"topics":["aws","hacktoberfest","systemic"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@guidesmiths/systemic-aws-s3","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/onebeyond.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-12T16:01:07.000Z","updated_at":"2024-04-24T08:28:28.000Z","dependencies_parsed_at":"2024-08-03T10:02:12.251Z","dependency_job_id":"08a60a01-2bb0-4d0a-921f-a5d40404e416","html_url":"https://github.com/onebeyond/systemic-aws-s3","commit_stats":null,"previous_names":["guidesmiths/systemic-aws-s3"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onebeyond%2Fsystemic-aws-s3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onebeyond%2Fsystemic-aws-s3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onebeyond%2Fsystemic-aws-s3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onebeyond%2Fsystemic-aws-s3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onebeyond","download_url":"https://codeload.github.com/onebeyond/systemic-aws-s3/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501861,"owners_count":21114684,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","hacktoberfest","systemic"],"created_at":"2024-08-03T10:00:48.418Z","updated_at":"2025-04-12T01:15:01.049Z","avatar_url":"https://github.com/onebeyond.png","language":"JavaScript","funding_links":[],"categories":["Modules"],"sub_categories":[],"readme":"[![Maintainability](https://api.codeclimate.com/v1/badges/fb29150fdbf11ffb3b83/maintainability)](https://codeclimate.com/github/onebeyond/systemic-aws-s3/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/fb29150fdbf11ffb3b83/test_coverage)](https://codeclimate.com/github/onebeyond/systemic-aws-s3/test_coverage)\n\n# Systemic AWS S3\n\nA [Systemic](https://guidesmiths.github.io/systemic/#/) component for the [AWS S3 SDK v3](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n\n## How to use it\n\n### Configuration\n\nA typical, simple configuration looks like this:\n\n```json\n{\n  \"region\": \"us-east-1\",\n  \"credentials\": {\n    \"secretAccessKey\": \"test\",\n    \"accessKeyId\": \"test\"\n  }\n}\n```\n\n[Here](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html) you can finde the complete configuration interface of S3Client class constructor that set the region, credentials and other options.\n\n### Initialize the component\n\nAs with any other [Systemic component](https://guidesmiths.github.io/systemic/#/?id=components), you can run it with the `start` method:\n\n```js\nconst initAWSS3 = require('systemic-aws-s3');\nconst { start } = initAWSS3();\n\nconst api = await start({ config }); // configuration similar to the one above\n```\n\n### Call the API commands\n\nAs the AWS API has dozens of commands, intead of having one wrapper for each of them, the component exposes one single command `commandExecutor` that can be used to call any of the commands exposed by the api:\n\nFor example, to list all the objects in a specific bucket:\n\n```js\nconst listObjectConfig = {\n  commandParams: { Bucket: bucketName },\n  commandName: 'listObjects'\n}\nconst res = await api.commandExecutor(listObjectConfig);\n```\n\nYou can check all the available commands [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/classes/s3.html).\n\n### Custom commands\n\nIn the future, this component will also expose some custom commands not supported by the official API.\n\n## Guide for developers\n\n### How to test it\n\nYou can test the whole test suite running one of these commands:\n\n```bash\n# all tests will be executed once\nnpm run test\n\n# tests will be executed every time code changes (useful when coding)\nnpm run test:watch\n```\n\nIn case that you want to just execute a certain test case, you can also use these scripts to up / tear down the infra.\n\n```bash\nnpm run infra:up\nnpm run infra:down\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonebeyond%2Fsystemic-aws-s3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonebeyond%2Fsystemic-aws-s3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonebeyond%2Fsystemic-aws-s3/lists"}