{"id":22218577,"url":"https://github.com/megahertz/s3u","last_synced_at":"2025-03-23T03:43:15.521Z","repository":{"id":66074182,"uuid":"447964955","full_name":"megahertz/s3u","owner":"megahertz","description":"S3 URL manipulation helper","archived":false,"fork":false,"pushed_at":"2025-03-11T03:06:22.000Z","size":98,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-16T19:55:25.565Z","etag":null,"topics":["amazon","aws","digitalocean","digitalocean-spaces","link","parse","presigned","s3","sign","spaces","stackpath","storage","url"],"latest_commit_sha":null,"homepage":"","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/megahertz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-14T12:46:32.000Z","updated_at":"2025-03-11T03:06:24.000Z","dependencies_parsed_at":"2024-07-18T09:39:11.079Z","dependency_job_id":null,"html_url":"https://github.com/megahertz/s3u","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megahertz%2Fs3u","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megahertz%2Fs3u/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megahertz%2Fs3u/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megahertz%2Fs3u/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/megahertz","download_url":"https://codeload.github.com/megahertz/s3u/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245052649,"owners_count":20553162,"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":["amazon","aws","digitalocean","digitalocean-spaces","link","parse","presigned","s3","sign","spaces","stackpath","storage","url"],"created_at":"2024-12-02T22:27:10.968Z","updated_at":"2025-03-23T03:43:15.514Z","avatar_url":"https://github.com/megahertz.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# s3u\n[![Tests](https://github.com/megahertz/s3u/actions/workflows/tests.yml/badge.svg)](https://github.com/megahertz/s3u/actions/workflows/tests.yml)\n[![npm version](https://badge.fury.io/js/s3u.svg)](https://badge.fury.io/js/s3u)\n\n## Description\n\nS3 URL manipulation helper similar to standard URL class\n\n### Key features\n\n - Support different S3 providers\n - Support both Node.js and browser environment\n - Simple and lightweight\n - No dependencies\n - TypeScript support\n - Built-in presigned URL generation (sync and promised versions)\n\n## Installation\n\nInstall with [npm](https://npmjs.org/package/s3u):\n\n    npm install --save s3u\n\n## Usage\n\n```js\nconst { S3Url } = require('s3u');\n\nconst s3Url = new S3Url('https://mybucket.s3.amazonaws.com/');\n\n// Changing attributes\ns3Url.key = 'My file.txt';\ns3Url.region = 'eu-west-2'\n\nconsole.log(url.href);\n// https://mybucket.s3.eu-west-2.amazonaws.com/My+file.txt\n\nconsole.log(s3Url);\n/*\nS3Url {\n  bucket: 'mybucket',\n  bucketPosition: 'hostname',\n  cdn: false,\n  domain: 'amazonaws.com',\n  error: null,\n  hash: '',\n  key: 'My file.txt',\n  password: '',\n  port: '',\n  protocol: 'https:',\n  provider: AmazonAwsProvider {\n    domain: 'amazonaws.com',\n    endpoint: 'https://s3.{region}.amazonaws.com',\n    id: 'amazonaws.com',\n    title: 'Amazon S3'\n  },\n  region: 'eu-west-2',\n  search: '',\n  sourceUrl: 'https://mybucket.s3.amazonaws.com/',\n  username: ''\n}\n */\n\n// Making a http copy\nconst httpUrl = s3Url.clone({ protocol: 'http:' }).href;\n\n// Generaing presigned URL\n// env vars can be used instead of passing arguments\nconst presignedUrl = await s3Url.sign({ accessKeyId, secretAccessKey });\n```\n\n## Providers\n\nCurrently, the library is tested with the following providers:\n\n - Amazon S3\n - Cloudflare R2\n - DigitalOcean Spaces\n - Stackpath Storage\n - Generic provider (Supports URL schema like bucket.region.example.com)\n\n### Adding a custom provider based on existed implementation:\n\n```js\nconst { s3Parser, S3Provider } = require('s3u');\n\ns3Parser.addProvider(new S3Provider({\n  domain: 'storage.example.com',\n  title: 'Example provider',\n}))\n```\n\n### Adding a custom provider implementation\n\nTo add a parser for a custom provider, you need to extend S3Provider class.\nYou can use [AmazonAwsProvider.js](src/providers/AmazonAwsProvider.js) as \nan example.\n\n```js\nconst { s3Parser, S3Provider } = require('s3u');\n\nclass NewProvider extends S3Provider {\n  buildHostName({ s3Url }) {\n    return [\n      s3Url.bucketPosition === 'hostname' \u0026\u0026 s3Url.bucket,\n      'files',\n      s3Url.domain || this.domain,\n    ]\n    .filter(Boolean)\n    .join('.');\n  }\n}\n\ns3Parser.addProvider(new NewProvider({\n  domain: 'example.com',\n  title: 'Example provider',\n}))\n```\n\n## License\n\nLicensed under MIT.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmegahertz%2Fs3u","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmegahertz%2Fs3u","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmegahertz%2Fs3u/lists"}