├── .github ├── access-preview.png ├── banner.png ├── demo.png ├── logo.png └── workflows │ └── build.yml ├── .gitignore ├── .npmignore ├── .prettierrc ├── CODE_OF_CONDUCT.md ├── LICENSE_APACHE ├── LICENSE_MIT ├── README.md ├── package-lock.json ├── package.json ├── src ├── index.ts ├── router.ts ├── template.ts └── types.ts └── tsconfig.json /.github/access-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kristianfreeman/lilredirector/3149432f9ec7fc66471e80b893d4c4f4b440c93a/.github/access-preview.png -------------------------------------------------------------------------------- /.github/banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kristianfreeman/lilredirector/3149432f9ec7fc66471e80b893d4c4f4b440c93a/.github/banner.png -------------------------------------------------------------------------------- /.github/demo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kristianfreeman/lilredirector/3149432f9ec7fc66471e80b893d4c4f4b440c93a/.github/demo.png -------------------------------------------------------------------------------- /.github/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kristianfreeman/lilredirector/3149432f9ec7fc66471e80b893d4c4f4b440c93a/.github/logo.png -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: 'Build' 2 | on: [push] 3 | 4 | jobs: 5 | build: 6 | name: Build 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v1 10 | - run: npm install 11 | - run: npm run build 12 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /dist 3 | **/*.rs.bk 4 | Cargo.lock 5 | bin/ 6 | pkg/ 7 | wasm-pack.log 8 | worker/ 9 | node_modules/ 10 | .cargo-ok 11 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | .github 2 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "singleQuote": true, 3 | "semi": false, 4 | "trailingComma": "all", 5 | "tabWidth": 2, 6 | "printWidth": 80 7 | } 8 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | - Using welcoming and inclusive language 18 | - Being respectful of differing viewpoints and experiences 19 | - Gracefully accepting constructive criticism 20 | - Focusing on what is best for the community 21 | - Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | - The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | - Trolling, insulting/derogatory comments, and personal or political attacks 28 | - Public or private harassment 29 | - Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | - Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at ag_dubs@cloudflare.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /LICENSE_APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | -------------------------------------------------------------------------------- /LICENSE_MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2018 Ashley Williams 2 | 3 | Permission is hereby granted, free of charge, to any 4 | person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the 6 | Software without restriction, including without 7 | limitation the rights to use, copy, modify, merge, 8 | publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software 10 | is furnished to do so, subject to the following 11 | conditions: 12 | 13 | The above copyright notice and this permission notice 14 | shall be included in all copies or substantial portions 15 | of the Software. 16 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 24 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 25 | DEALINGS IN THE SOFTWARE. 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![banner](./.github/banner.png) 2 | 3 | A simple (but powerful!) redirect tool built with Cloudflare Workers. Deploy and manage redirects at the edge without needing to config your origin application. [See this blog post for more info on how it works, as well as a demo video.](https://7.dev/redirect-anything-with-lilredirector/) 4 | 5 | ![demo](./.github/demo.png) 6 | 7 | ## Installation 8 | 9 | This project requires the usage of Cloudflare Workers on your custom domain/zone. Check out my Egghead video on [deploying to a custom domain](https://next.egghead.io/lessons/cloudflare-deploy-to-a-custom-domain-with-cloudflare-wrangler-environments) if you need to set that up. 10 | 11 | With a configured Workers project, using Wrangler: 12 | 13 | 1. Install the package 14 | 15 | ```bash 16 | $ npm install lilredirector 17 | ``` 18 | 19 | 2. Create a `redirects.js` file in your source code: 20 | 21 | ```javascript 22 | export default [ 23 | { 24 | path: "/twitter", 25 | redirect: "https://twitter.com/signalnerve", 26 | }, 27 | { 28 | path: "/yt", 29 | redirect: "https://www.youtube.com/c/bytesizedxyz", 30 | }, 31 | ] 32 | ``` 33 | 34 | ## Usage 35 | 36 | ```javascript 37 | import redirector from 'lilredirector' 38 | import redirects from './redirects' 39 | 40 | addEventListener('fetch', event => event.respondWith(handler(event))) 41 | 42 | // Note the `event` function argument. 43 | // Unlike many Workers scripts, which pass in `event.request`, 44 | // lilredirector needs the full `event` object 45 | async function handler(event) { 46 | const { response, error } = await redirector(event, redirects) 47 | if (response) return response 48 | 49 | // Optionally, return an error response 50 | if (error) return error 51 | 52 | // Other workers code 53 | } 54 | ``` 55 | 56 | ### Path parameters 57 | 58 | Lilredirector includes support for more complex redirect scenarios using _path parameters_. This allows you to capture parameters in the URL and use it to route to new URLs. In `redirects.js`: 59 | 60 | ```javascript 61 | export default [ 62 | { 63 | path: "/post/:id", 64 | redirect: "/posts/:id" 65 | }, 66 | { 67 | path: "/users/:id/posts/:post_id", 68 | redirect: "/u/:id/p/:post_id" 69 | }, 70 | ] 71 | ``` 72 | 73 | ## Configuration 74 | 75 | ```javascript 76 | import redirector from 'lilredirector' 77 | 78 | addEventListener('fetch', event => event.respondWith(handler(event))) 79 | 80 | async function handler(event) { 81 | const { response, error } = await redirector(event, redirects, { 82 | // Configuration options can be passed as an optional object. 83 | // See the below documentation for examples of each: 84 | // 85 | // baseUrl 86 | // basicAuthentication 87 | // removeTrailingSlashes 88 | }) 89 | // ... 90 | } 91 | ``` 92 | 93 | ### Changing the base URL 94 | 95 | By default, lilredirector serves a read-only UI from `/_redirects`. This can be customized by providing `baseUrl` in lilredirector's configuration: 96 | 97 | ```javascript 98 | async function handler(event) { 99 | const { response, error } = await redirector(event, redirects,{ 100 | baseUrl: `/mylilredirector`, 101 | }) 102 | if (response) return response 103 | } 104 | ``` 105 | 106 | ### Removing trailing slashes 107 | 108 | By default, lilredirector will match and redirect URLs _without_ trailing slashes. For instance, if you have a redirect set up for `/about`, visiting `/about/` will match a redirect for `/about`, and redirect accordingly. This feature can be disabled by passing the `removeTrailingSlashes` boolean in the configuration object into the `redirector` function: 109 | 110 | ```javascript 111 | async function handler(event) { 112 | const { response, error } = await redirector(event, redirects, { 113 | removeTrailingSlashes: false, 114 | }) 115 | if (response) return response 116 | } 117 | ``` 118 | 119 | ## How it works 120 | 121 | #### Handlers 122 | 123 | Lilredirector embeds itself under the `/_redirects` path, unless specified otherwise by the `baseUrl` configuration param as defined in the previous section. 124 | 125 | ## Authentication 126 | 127 | You can put the read-only UI behind authentication using a few methods. 128 | 129 | ### Basic authentication 130 | 131 | Using the configuration object, you can enable basic auth for lilredirector and any subpaths (creating/deleting redirects): 132 | 133 | ```js 134 | async function handler(event) { 135 | const { response, error } = await redirector(event, redirects, { 136 | basicAuthentication: { 137 | username: USERNAME, 138 | password: PASSWORD, 139 | }, 140 | }) 141 | if (response) return response 142 | } 143 | ``` 144 | 145 | It's strongly recommended that you use `wrangler secret` to define and store your basic auth credentials, as seen above: 146 | 147 | ```bash 148 | $ wrangler secret put USERNAME 149 | $ wrangler secret put PASSWORD 150 | ``` 151 | 152 | ### Cloudflare Access 153 | 154 | You can add complex role-based auth using [cloudflare access](https://teams.cloudflare.com/access/). see the below screenshot for an example config: 155 | 156 | ![access setup](./.github/access-preview.png) 157 | -------------------------------------------------------------------------------- /package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "lilredirector", 3 | "version": "0.9.9", 4 | "lockfileVersion": 2, 5 | "requires": true, 6 | "packages": { 7 | "": { 8 | "version": "0.9.9", 9 | "license": "MIT", 10 | "dependencies": { 11 | "@cloudflare/workers-types": "^2.0.0", 12 | "@types/basic-auth": "^1.1.3", 13 | "basic-auth": "^2.0.1", 14 | "tiny-request-router": "^1.2.2" 15 | }, 16 | "devDependencies": { 17 | "prettier": "^1.19.1", 18 | "typescript": "^4.0.2" 19 | } 20 | }, 21 | "node_modules/@cloudflare/workers-types": { 22 | "version": "2.0.0", 23 | "resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-2.0.0.tgz", 24 | "integrity": "sha512-SFUPQzR5aV2TBLP4Re+xNX5KfAGArcRGA44OLulBDnfblEf3J+6kFvdJAQwFhFpqru3wImwT1cX0wahk6EeWTw==" 25 | }, 26 | "node_modules/@types/basic-auth": { 27 | "version": "1.1.3", 28 | "resolved": "https://registry.npmjs.org/@types/basic-auth/-/basic-auth-1.1.3.tgz", 29 | "integrity": "sha512-W3rv6J0IGlxqgE2eQ2pTb0gBjaGtejQpJ6uaCjz3UQ65+TFTPC5/lAE+POfx1YLdjtxvejJzsIAfd3MxWiVmfg==", 30 | "dependencies": { 31 | "@types/node": "*" 32 | } 33 | }, 34 | "node_modules/@types/node": { 35 | "version": "14.6.0", 36 | "resolved": "https://registry.npmjs.org/@types/node/-/node-14.6.0.tgz", 37 | "integrity": "sha512-mikldZQitV94akrc4sCcSjtJfsTKt4p+e/s0AGscVA6XArQ9kFclP+ZiYUMnq987rc6QlYxXv/EivqlfSLxpKA==" 38 | }, 39 | "node_modules/basic-auth": { 40 | "version": "2.0.1", 41 | "resolved": "https://registry.npmjs.org/basic-auth/-/basic-auth-2.0.1.tgz", 42 | "integrity": "sha512-NF+epuEdnUYVlGuhaxbbq+dvJttwLnGY+YixlXlME5KpQ5W3CnXA5cVTneY3SPbPDRkcjMbifrwmFYcClgOZeg==", 43 | "dependencies": { 44 | "safe-buffer": "5.1.2" 45 | }, 46 | "engines": { 47 | "node": ">= 0.8" 48 | } 49 | }, 50 | "node_modules/path-to-regexp": { 51 | "version": "6.2.0", 52 | "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.2.0.tgz", 53 | "integrity": "sha512-f66KywYG6+43afgE/8j/GoiNyygk/bnoCbps++3ErRKsIYkGGupyv07R2Ok5m9i67Iqc+T2g1eAUGUPzWhYTyg==" 54 | }, 55 | "node_modules/prettier": { 56 | "version": "1.19.1", 57 | "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.19.1.tgz", 58 | "integrity": "sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew==", 59 | "dev": true, 60 | "bin": { 61 | "prettier": "bin-prettier.js" 62 | }, 63 | "engines": { 64 | "node": ">=4" 65 | } 66 | }, 67 | "node_modules/safe-buffer": { 68 | "version": "5.1.2", 69 | "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", 70 | "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==" 71 | }, 72 | "node_modules/tiny-request-router": { 73 | "version": "1.2.2", 74 | "resolved": "https://registry.npmjs.org/tiny-request-router/-/tiny-request-router-1.2.2.tgz", 75 | "integrity": "sha512-6ZMFU7AP9so+hkqmMM9fJ11V44EAcYuHCmNdsyM8k94oVnNDPQwUAAPoBHqchHSpKG6yZbCasgVeRxaY5v2BCg==", 76 | "dependencies": { 77 | "path-to-regexp": "^6.1.0" 78 | } 79 | }, 80 | "node_modules/typescript": { 81 | "version": "4.0.2", 82 | "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.0.2.tgz", 83 | "integrity": "sha512-e4ERvRV2wb+rRZ/IQeb3jm2VxBsirQLpQhdxplZ2MEzGvDkkMmPglecnNDfSUBivMjP93vRbngYYDQqQ/78bcQ==", 84 | "dev": true, 85 | "bin": { 86 | "tsc": "bin/tsc", 87 | "tsserver": "bin/tsserver" 88 | }, 89 | "engines": { 90 | "node": ">=4.2.0" 91 | } 92 | } 93 | }, 94 | "dependencies": { 95 | "@cloudflare/workers-types": { 96 | "version": "2.0.0", 97 | "resolved": "https://registry.npmjs.org/@cloudflare/workers-types/-/workers-types-2.0.0.tgz", 98 | "integrity": "sha512-SFUPQzR5aV2TBLP4Re+xNX5KfAGArcRGA44OLulBDnfblEf3J+6kFvdJAQwFhFpqru3wImwT1cX0wahk6EeWTw==" 99 | }, 100 | "@types/basic-auth": { 101 | "version": "1.1.3", 102 | "resolved": "https://registry.npmjs.org/@types/basic-auth/-/basic-auth-1.1.3.tgz", 103 | "integrity": "sha512-W3rv6J0IGlxqgE2eQ2pTb0gBjaGtejQpJ6uaCjz3UQ65+TFTPC5/lAE+POfx1YLdjtxvejJzsIAfd3MxWiVmfg==", 104 | "requires": { 105 | "@types/node": "*" 106 | } 107 | }, 108 | "@types/node": { 109 | "version": "14.6.0", 110 | "resolved": "https://registry.npmjs.org/@types/node/-/node-14.6.0.tgz", 111 | "integrity": "sha512-mikldZQitV94akrc4sCcSjtJfsTKt4p+e/s0AGscVA6XArQ9kFclP+ZiYUMnq987rc6QlYxXv/EivqlfSLxpKA==" 112 | }, 113 | "basic-auth": { 114 | "version": "2.0.1", 115 | "resolved": "https://registry.npmjs.org/basic-auth/-/basic-auth-2.0.1.tgz", 116 | "integrity": "sha512-NF+epuEdnUYVlGuhaxbbq+dvJttwLnGY+YixlXlME5KpQ5W3CnXA5cVTneY3SPbPDRkcjMbifrwmFYcClgOZeg==", 117 | "requires": { 118 | "safe-buffer": "5.1.2" 119 | } 120 | }, 121 | "path-to-regexp": { 122 | "version": "6.2.0", 123 | "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-6.2.0.tgz", 124 | "integrity": "sha512-f66KywYG6+43afgE/8j/GoiNyygk/bnoCbps++3ErRKsIYkGGupyv07R2Ok5m9i67Iqc+T2g1eAUGUPzWhYTyg==" 125 | }, 126 | "prettier": { 127 | "version": "1.19.1", 128 | "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.19.1.tgz", 129 | "integrity": "sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew==", 130 | "dev": true 131 | }, 132 | "safe-buffer": { 133 | "version": "5.1.2", 134 | "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", 135 | "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==" 136 | }, 137 | "tiny-request-router": { 138 | "version": "1.2.2", 139 | "resolved": "https://registry.npmjs.org/tiny-request-router/-/tiny-request-router-1.2.2.tgz", 140 | "integrity": "sha512-6ZMFU7AP9so+hkqmMM9fJ11V44EAcYuHCmNdsyM8k94oVnNDPQwUAAPoBHqchHSpKG6yZbCasgVeRxaY5v2BCg==", 141 | "requires": { 142 | "path-to-regexp": "^6.1.0" 143 | } 144 | }, 145 | "typescript": { 146 | "version": "4.0.2", 147 | "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.0.2.tgz", 148 | "integrity": "sha512-e4ERvRV2wb+rRZ/IQeb3jm2VxBsirQLpQhdxplZ2MEzGvDkkMmPglecnNDfSUBivMjP93vRbngYYDQqQ/78bcQ==", 149 | "dev": true 150 | } 151 | } 152 | } 153 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "lilredirector", 3 | "version": "1.0.1", 4 | "description": "redirector engine for cloudflare workers", 5 | "main": "dist/index.js", 6 | "scripts": { 7 | "build": "tsc", 8 | "prepublish": "npm run build", 9 | "test": "echo \"Error: no test specified\" && exit 1", 10 | "format": "prettier --write '**/*.{js,css,json,md}'" 11 | }, 12 | "author": "Kristian Freeman ", 13 | "license": "MIT", 14 | "devDependencies": { 15 | "prettier": "^1.19.1", 16 | "typescript": "^4.0.2" 17 | }, 18 | "dependencies": { 19 | "@cloudflare/workers-types": "^2.0.0", 20 | "@types/basic-auth": "^1.1.3", 21 | "basic-auth": "^2.0.1", 22 | "tiny-request-router": "^1.2.2" 23 | } 24 | } -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import auth from 'basic-auth' 2 | import Router from './router' 3 | import template from './template' 4 | 5 | import type { Redirect } from './types' 6 | 7 | const renderHtml = (page: () => string) => 8 | new Response(page(), { 9 | headers: { 'Content-type': 'text/html' }, 10 | }) 11 | 12 | const removeTrailingSlashesFromUrl = (url: URL) => { 13 | if (url.pathname.endsWith('/')) url.pathname = url.pathname.slice(0, -1) 14 | } 15 | 16 | const defaults = { 17 | basicAuthentication: { 18 | username: null, 19 | password: null, 20 | }, 21 | baseUrl: '/_redirects', 22 | removeTrailingSlashes: true, 23 | } 24 | 25 | export default async (event: FetchEvent, redirects: Array, options = {}) => { 26 | const { request } = event 27 | const config = Object.assign(defaults, options) 28 | const { basicAuthentication, baseUrl } = config 29 | let error, response 30 | let url = new URL(event.request.url) 31 | 32 | const router = Router(redirects) 33 | 34 | if (url.pathname.startsWith(config.baseUrl)) { 35 | if (basicAuthentication.username && basicAuthentication.password) { 36 | const authHeader = request.headers.get('Authorization') 37 | if (!authHeader) { 38 | return { 39 | error: new Response('Unauthorized', { 40 | status: 401, 41 | headers: { 42 | 'WWW-Authenticate': 'Basic realm="lilredirector"', 43 | }, 44 | }), 45 | } 46 | } 47 | 48 | const user = auth.parse(authHeader) 49 | if (!user) return { error: new Response('Unauthorized', { status: 403 }) } 50 | if ( 51 | user.name !== basicAuthentication.username || 52 | user.pass !== basicAuthentication.password 53 | ) { 54 | return { error: new Response('Unauthorized', { status: 403 }) } 55 | } 56 | } 57 | } 58 | 59 | try { 60 | switch (url.pathname) { 61 | case `${baseUrl}`: 62 | response = renderHtml(template({ baseUrl, redirects })) 63 | break 64 | default: 65 | if (config.removeTrailingSlashes) removeTrailingSlashesFromUrl(url) 66 | const match = router.match('GET', url.pathname) 67 | if (match) response = match.handler(match.params) 68 | break 69 | } 70 | } catch (err) { 71 | error = new Response(err.toString()) 72 | } 73 | 74 | return { error, response } 75 | } 76 | -------------------------------------------------------------------------------- /src/router.ts: -------------------------------------------------------------------------------- 1 | import { Router } from 'tiny-request-router' 2 | import type { Params } from 'tiny-request-router' 3 | import type { Redirect } from './types' 4 | 5 | type Handler = (params: Params) => Promise 6 | 7 | const Routes = (redirects: Array): Router => { 8 | const router = new Router() 9 | redirects.forEach(redirect => { 10 | router.get(redirect.path, async (params: Params) => { 11 | let redirectPath = redirect.redirect 12 | Object.keys(params).forEach(key => 13 | redirectPath = redirectPath.replace(`:${key}`, params[key]) 14 | ) 15 | return Response.redirect(redirectPath) 16 | }) 17 | }) 18 | return router 19 | } 20 | 21 | export default Routes -------------------------------------------------------------------------------- /src/template.ts: -------------------------------------------------------------------------------- 1 | import type { Redirect } from './types' 2 | 3 | export default ({ 4 | baseUrl, 5 | redirects, 6 | }: { 7 | baseUrl: string 8 | redirects: Redirect[] 9 | }) => () => ` 10 | 11 | 12 | 13 | Lil Redirector 14 | 15 | 21 | 22 | 23 |
    24 |
    25 | 26 |

    Lil Redirector

    27 |
    28 | v1.0.1 29 |
30 | 31 |
32 |
33 |
34 |
35 |
36 |

37 | Redirects (${redirects.length}) 38 |

39 |
40 |
41 |
42 |
43 | 44 |
45 |
46 |
47 | ${redirects.length 48 | ? ` 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | ${redirects 58 | .filter((redirect: Redirect) => !!redirect.path) 59 | .map( 60 | (redirect: Redirect) => ` 61 | 62 | 63 | 64 | 65 | `, 66 | ) 67 | .join('\n')} 68 | 69 |
PathRedirect
${redirect.path}${redirect.redirect}
70 | ` 71 | : `

No redirects created yet!

` 72 | } 73 |
74 |
75 |
76 |
77 | 78 | 79 | ` 80 | -------------------------------------------------------------------------------- /src/types.ts: -------------------------------------------------------------------------------- 1 | export interface Redirect { 2 | path: string 3 | redirect: string 4 | } 5 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es2020" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */, 4 | "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */, 5 | "lib": [ 6 | "es2020", 7 | "webworker" 8 | ] /* Specify library files to be included in the compilation. */, 9 | "types": ["@cloudflare/workers-types"], 10 | "declaration": true /* Generates corresponding '.d.ts' file. */, 11 | "outDir": "./dist" /* Redirect output structure to the directory. */, 12 | "strict": true /* Enable all strict type-checking options. */, 13 | "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */, 14 | "skipLibCheck": true /* Skip type checking of declaration files. */, 15 | "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */ 16 | }, 17 | "include": ["src"], 18 | "exclude": ["node_modules"] 19 | } 20 | --------------------------------------------------------------------------------